fix: remotes url parameter in factory url #938

dkwon17 · 2023-09-29T19:58:13Z

What does this PR do?

Fixes eclipse-che/che#22530 by allowing redirect to workspace creation page when window.location.hash contains the following characters: {, }, and ,.

See:

che-dashboard/packages/dashboard-frontend/src/preload/main.ts

Lines 30 to 35 in 333d6cf

    
           const hash = window.location.hash.replace(/(\/?)#(\/?)/, ''); 
        
           if (FactoryLocationAdapter.isHttpLocation(hash) || FactoryLocationAdapter.isSshLocation(hash)) { 
        
             // project url found, redirect to the workspaces creation page 
        
             window.location.href = window.location.origin + '/dashboard' + buildFactoryLoaderPath(hash); 
        
             return; 
        
           }

What issues does this PR fix or reference?

eclipse-che/che#22530

Is it tested? How?

Deploy Eclipse Che, and set the following in the Che CR to test out this PR:

spec:
  components:
    dashboard:
      deployment:
        containers:
          - image: quay.io/dkwon17/che-dashboard:fixRemotesUrlParam

Access the following url to start a new workspace:

{che-host}/#https://github.com/dkwon17/quarkus-api-example?remotes={https://github.com/che-incubator/quarkus-api-example}

and verify that the resulting dev workspace has the following:

    projects:
      - git:
          checkoutFrom:
            remote: origin
          remotes:
            origin: 'https://github.com/che-incubator/quarkus-api-example'
        name: quarkus-api-example

Access the following url to start a new workspace:

{che-host}/#https://github.com/eclipse-che/che-plugin-registry?remotes={{origin,https://github.com/dkwon17/che-plugin-registry},{upstream,https://github.com/eclipse-che/che-plugin-registry}}

and verify that the resulting dev workspace has the following:

    projects:
      - git:
          checkoutFrom:
            remote: origin
          remotes:
            origin: 'https://github.com/dkwon17/che-plugin-registry'
            upstream: 'https://github.com/eclipse-che/che-plugin-registry'
        name: che-plugin-registry

Release Notes

Docs PR

Signed-off-by: David Kwon <dakwon@redhat.com>

che-bot · 2023-09-29T19:58:25Z

Click here to review and test in web IDE:

packages/dashboard-frontend/src/services/factory-location-adapter/index.ts

github-actions · 2023-09-29T20:25:20Z

Docker image build succeeded: quay.io/eclipse/che-dashboard:pr-938

codecov · 2023-10-02T18:01:17Z

Codecov Report

Merging #938 (e49d3b3) into main (333d6cf) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #938   +/-   ##
=======================================
  Coverage   82.59%   82.59%           
=======================================
  Files         365      365           
  Lines       37941    37941           
  Branches     2414     2414           
=======================================
  Hits        31338    31338           
  Misses       6579     6579           
  Partials       24       24

Flag	Coverage Δ
unittests	`82.59% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...end/src/services/factory-location-adapter/index.ts	`100.00% <100.00%> (ø)`

Signed-off-by: David Kwon <dakwon@redhat.com>

akurinnoy

LGTM

ibuziuk · 2023-10-03T13:01:58Z

/retest

openshift-ci · 2023-10-03T13:02:25Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: akurinnoy, dkwon17, ibuziuk, olexii4

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

github-actions · 2023-10-03T14:10:40Z

Docker image build succeeded: quay.io/eclipse/che-dashboard:pr-938

ScrewTSW · 2023-10-04T14:06:34Z

Successfully verified against che:next

devstudio-release · 2023-10-04T14:24:40Z

Build 3.10 :: dashboard_3.x/356: Console, Changes, Git Data

devstudio-release · 2023-10-04T14:26:29Z

Build 3.10 :: sync-to-downstream_3.x/4883: Console, Changes, Git Data

devstudio-release · 2023-10-04T14:27:08Z

Build 3.10 :: get-sources-rhpkg-container-build_3.x/4703: Console, Changes, Git Data

devstudio-release · 2023-10-04T14:52:40Z

Build 3.10 :: push-latest-container-to-quay_3.x/3448: Console, Changes, Git Data

devstudio-release · 2023-10-04T14:53:26Z

Build 3.10 :: get-sources-rhpkg-container-build_3.x/4703:

dashboard : 3.x :: Build 55955258 : quay.io/devspaces/dashboard-rhel8:3.10-31
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.x/3448 triggered

devstudio-release · 2023-10-04T14:53:27Z

Build 3.10 :: update-digests_3.x/4523: Console, Changes, Git Data

devstudio-release · 2023-10-04T14:53:30Z

Build 3.10 :: dashboard_3.x/356:

Upstream sync done; /DS_CI/sync-to-downstream_3.x/4883 triggered

devstudio-release · 2023-10-04T14:55:20Z

Build 3.10 :: operator-bundle_3.x/2129: Console, Changes, Git Data

devstudio-release · 2023-10-04T14:59:24Z

Build 3.10 :: sync-to-downstream_3.x/4884: Console, Changes, Git Data

devstudio-release · 2023-10-04T15:00:04Z

Build 3.10 :: get-sources-rhpkg-container-build_3.x/4704: Console, Changes, Git Data

devstudio-release · 2023-10-04T15:05:09Z

Build 3.10 :: push-latest-container-to-quay_3.x/3449: Console, Changes, Git Data

devstudio-release · 2023-10-04T15:07:10Z

Build 3.10 :: copyIIBsToQuay/1975: Console, Changes, Git Data

devstudio-release · 2023-10-04T15:09:01Z

Build 3.10 :: get-sources-rhpkg-container-build_3.x/4704:

devspaces-operator-bundle : 3.x :: Build 55956042 : quay.io/devspaces/devspaces-operator-bundle:3.10-106
SUCCESS; copied to quay; /DS_CI/push-latest-container-to-quay_3.x/3449 triggered;
Bundle CSV related images:
- quay.io/devspaces/code-rhel8:3.10-76
- quay.io/devspaces/configbump-rhel8:3.10-12
- quay.io/devspaces/dashboard-rhel8:3.10-31
- quay.io/devspaces/devfileregistry-rhel8:3.10-58
- quay.io/devspaces/devspaces-rhel8-operator:3.10-12
- quay.io/devspaces/idea-rhel8:3.10-4
- quay.io/devspaces/pluginregistry-rhel8:3.10-13
- quay.io/devspaces/server-rhel8:3.10-15
- quay.io/devspaces/traefik-rhel8:3.10-6
- quay.io/devspaces/udi-rhel8:3.10-12
= registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.12.0-202309181625.p0.g94f3fde.assembly.stream
= registry.redhat.io/openshift4/ose-oauth-proxy:v4.12.0-202309181625.p0.g03e5b13.assembly.stream
= registry.redhat.io/rhscl/mongodb-36-rhel7:1-50
= registry.redhat.io/ubi8/ubi-minimal:8.8-1072

devstudio-release · 2023-10-04T15:09:05Z

Build 3.10 :: sync-to-downstream_3.x/4884:

Build container: devspaces-operator-bundle synced; /DS_CI/get-sources-rhpkg-container-build_3.x/4704 triggered; /job/DS_CI/job/dsc_3.x triggered;

devstudio-release · 2023-10-04T15:09:07Z

Build 3.10 :: operator-bundle_3.x/2129:

Upstream sync done; /DS_CI/sync-to-downstream_3.x/4884 triggered

devstudio-release · 2023-10-04T15:10:31Z

Build 3.10 :: dsc_3.x/1447: Console, Changes, Git Data

devstudio-release · 2023-10-04T15:13:42Z

Build 3.10 :: update-digests_3.x/4523:

Detected new images: rebuild operator-bundle
* dashboard; /DS_CI/operator-bundle_3.x/2129 triggered

devstudio-release · 2023-10-04T15:17:55Z

Build 3.10 :: dsc_3.x/1447:

3.10.0-CI

devstudio-release · 2023-10-04T16:12:33Z

Build 3.10 :: copyIIBsToQuay/1975:

3.10
arches = x86_64, s390x, ppc64le;
  * LATEST DS OPERATOR BUNDLE = <a href=https://quay.io/repository/devspaces/devspaces-operator-bundle?tab=tags>registry-proxy.engineering.redhat.com/rh-osbs/devspaces-operator-bundle:3.10-106
  * LATEST DWO OPERATOR BUNDLE = <a href=https://quay.io/repository/devworkspace/devworkspace-operator-bundle?tab=tags>registry-proxy.engineering.redhat.com/rh-osbs/devworkspace-operator-bundle:0.21-7
+ s390x-rhel8 IIB(s) copied:
  + quay.io/devspaces/iib:3.10-v4.14-589196-533291-s390x
  + quay.io/devspaces/iib:3.10-v4.14-s390x
  + quay.io/devspaces/iib:next-v4.14-s390x
  + quay.io/devspaces/iib:3.10-v4.13-589193-533286-s390x
  + quay.io/devspaces/iib:3.10-v4.13-s390x
  + quay.io/devspaces/iib:next-v4.13-s390x
  + quay.io/devspaces/iib:3.10-v4.12-589303-533281-s390x
  + quay.io/devspaces/iib:3.10-v4.12-s390x
  + quay.io/devspaces/iib:next-v4.12-s390x
  + quay.io/devspaces/iib:3.10-v4.11-589300-533277-s390x
  + quay.io/devspaces/iib:3.10-v4.11-s390x
  + quay.io/devspaces/iib:next-v4.11-s390x
+ ppc64le-rhel8 IIB(s) copied:
  + quay.io/devspaces/iib:3.10-v4.14-589196-533291-ppc64le
  + quay.io/devspaces/iib:3.10-v4.14-ppc64le
  + quay.io/devspaces/iib:next-v4.14-ppc64le
  + quay.io/devspaces/iib:3.10-v4.13-589193-533286-ppc64le
  + quay.io/devspaces/iib:3.10-v4.13-ppc64le
  + quay.io/devspaces/iib:next-v4.13-ppc64le
  + quay.io/devspaces/iib:3.10-v4.12-589303-533281-ppc64le
  + quay.io/devspaces/iib:3.10-v4.12-ppc64le
  + quay.io/devspaces/iib:next-v4.12-ppc64le
  + quay.io/devspaces/iib:3.10-v4.11-589300-533277-ppc64le
  + quay.io/devspaces/iib:3.10-v4.11-ppc64le
  + quay.io/devspaces/iib:next-v4.11-ppc64le
+ x86_64-rhel8 IIB(s) copied:
  + quay.io/devspaces/iib:3.10-v4.14-589196-533291-x86_64
  + quay.io/devspaces/iib:3.10-v4.14-x86_64
  + quay.io/devspaces/iib:next-v4.14-x86_64
  + quay.io/devspaces/iib:3.10-v4.13-589307-533286-x86_64
  + quay.io/devspaces/iib:3.10-v4.13-x86_64
  + quay.io/devspaces/iib:next-v4.13-x86_64
  + quay.io/devspaces/iib:3.10-v4.12-589303-533281-x86_64
  + quay.io/devspaces/iib:3.10-v4.12-x86_64
  + quay.io/devspaces/iib:next-v4.12-x86_64
  + quay.io/devspaces/iib:3.10-v4.11-589300-533277-x86_64
  + quay.io/devspaces/iib:3.10-v4.11-x86_64
  + quay.io/devspaces/iib:next-v4.11-x86_64

fix: remotes url parameter in factory url

83cdfa6

Signed-off-by: David Kwon <dakwon@redhat.com>

dkwon17 requested review from akurinnoy, olexii4 and ibuziuk as code owners September 29, 2023 19:58

dkwon17 commented Sep 29, 2023

View reviewed changes

packages/dashboard-frontend/src/services/factory-location-adapter/index.ts Show resolved Hide resolved

Add tests specifically for FactoryLocationAdapter.isHttpLocation

e49d3b3

Signed-off-by: David Kwon <dakwon@redhat.com>

dkwon17 force-pushed the fixRemotesUrlParam branch from 55b6e1b to e49d3b3 Compare October 2, 2023 18:38

akurinnoy approved these changes Oct 3, 2023

View reviewed changes

openshift-ci bot assigned akurinnoy Oct 3, 2023

openshift-ci bot added the lgtm label Oct 3, 2023

olexii4 approved these changes Oct 3, 2023

View reviewed changes

openshift-ci bot assigned olexii4 Oct 3, 2023

ibuziuk approved these changes Oct 3, 2023

View reviewed changes

openshift-ci bot assigned ibuziuk Oct 3, 2023

ibuziuk requested a review from ScrewTSW October 3, 2023 13:36

ibuziuk merged commit 1002797 into main Oct 4, 2023
13 checks passed

ibuziuk deleted the fixRemotesUrlParam branch October 4, 2023 14:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: remotes url parameter in factory url #938

fix: remotes url parameter in factory url #938

dkwon17 commented Sep 29, 2023

che-bot commented Sep 29, 2023

github-actions bot commented Sep 29, 2023

codecov bot commented Oct 2, 2023 •

edited

Loading

akurinnoy left a comment

ibuziuk commented Oct 3, 2023

openshift-ci bot commented Oct 3, 2023

github-actions bot commented Oct 3, 2023

ScrewTSW commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

	const hash = window.location.hash.replace(/(\/?)#(\/?)/, '');
	if (FactoryLocationAdapter.isHttpLocation(hash) \|\| FactoryLocationAdapter.isSshLocation(hash)) {
	// project url found, redirect to the workspaces creation page
	window.location.href = window.location.origin + '/dashboard' + buildFactoryLoaderPath(hash);
	return;
	}

fix: remotes url parameter in factory url #938

fix: remotes url parameter in factory url #938

Conversation

dkwon17 commented Sep 29, 2023

What does this PR do?

What issues does this PR fix or reference?

Is it tested? How?

Release Notes

Docs PR

che-bot commented Sep 29, 2023

github-actions bot commented Sep 29, 2023

codecov bot commented Oct 2, 2023 • edited Loading

Codecov Report

akurinnoy left a comment

Choose a reason for hiding this comment

ibuziuk commented Oct 3, 2023

openshift-ci bot commented Oct 3, 2023

github-actions bot commented Oct 3, 2023

ScrewTSW commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

devstudio-release commented Oct 4, 2023

codecov bot commented Oct 2, 2023 •

edited

Loading