Detect if dashboard has been accessed due to workspace idle redirect + workspace idle error #556

dkwon17 · 2022-06-09T19:50:03Z

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

What does this PR do?

eclipse-che/che-operator#1392 reroutes a workspace's mainUrl (ex. https://<che-host>/workspacee3dab47b6f6441c6/theia-ide/3100/#/)
to the dashboard.

This PR reads and stores the window.location.pathname from the dashboard frontend preload script to determine whether the dashboard is being accessed via workspace idle redirection. The window.location.pathname is stored in the browser's sessionStorage.

To check whether the workspace idle error page is displayed, the PR checks the sessionStorage for the initial window.location.pathname and checks if there is a devworkspace with the same mainUrl in the redux store. If yes, the error page is displayed.

Error page provided by this PR:

Here is a demo:

demo.mov

What issues does this PR fix or reference?

Part of eclipse-che/che#20599

Is it tested? How?

For testing, please see #556 (comment)

Release Notes

Docs PR

openshift-ci · 2022-06-09T19:50:07Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

che-bot · 2022-06-09T19:50:17Z

Click here to review and test in web IDE:

packages/dashboard-frontend/src/preload/index.ts

che-bot · 2022-06-09T19:58:50Z

Click here to review and test in web IDE:

codecov · 2022-06-09T20:01:13Z

Codecov Report

Merging #556 (fe00e0f) into main (3f21a14) will decrease coverage by 0.09%.
The diff coverage is 35.13%.

@@            Coverage Diff             @@
##             main     #556      +/-   ##
==========================================
- Coverage   56.22%   56.12%   -0.10%     
==========================================
  Files         217      217              
  Lines        7374     7410      +36     
  Branches     1264     1270       +6     
==========================================
+ Hits         4146     4159      +13     
- Misses       3049     3071      +22     
- Partials      179      180       +1

Flag	Coverage Δ
unittests	`56.12% <35.13%> (-0.10%)`	⬇️

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

Impacted Files	Coverage Δ
...dashboard-frontend/src/services/bootstrap/index.ts	`0.00% <0.00%> (ø)`
...-frontend/src/services/bootstrap/issuesReporter.ts	`28.57% <0.00%> (ø)`
...ard-frontend/src/services/session-storage/index.ts	`66.66% <25.00%> (-33.34%)`	⬇️
...-frontend/src/Layout/ErrorReporter/Issue/index.tsx	`79.31% <70.00%> (-4.91%)`	⬇️
packages/dashboard-frontend/src/preload/index.ts	`83.33% <100.00%> (+2.25%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3f21a14...fe00e0f. Read the comment docs.

github-actions · 2022-06-09T20:04:24Z

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

dkwon17 · 2022-06-09T20:11:54Z

This feature would need to be throughly tested. While trying to record the demo video, I ran into a situation where the 'workspace stopped' error page appears when it shouldn't. The bug can be seen at about 0:33s of this video:

workspace-idled-bugged.mov

There is a The workspace status changed unexpectedly to "Starting" error (I'm not sure what caused that error) when starting the workspace. At this point, we shouldn't be redirected to the 'workspace stopped' error page.

github-actions · 2022-06-09T20:16:42Z

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

packages/dashboard-frontend/src/services/bootstrap/index.ts

packages/dashboard-frontend/src/Layout/ErrorReporter/Issue/index.tsx

dkwon17 · 2022-06-14T13:27:24Z

With the latest commit, the links in the error page have been implemented

The first link directs the user to /ide/:namespace/:workspaceName which is used to restart the stopped workspace.
The second link directs the user to /workspace/:namespace/:workspaceName which is the workspace details page.

First link demo:
https://user-images.githubusercontent.com/83611742/173587485-4dfa5f0c-5b64-40b0-b463-f01bb7eb65c6.mov

Second link demo:
https://user-images.githubusercontent.com/83611742/173588244-d6ec9dcb-7e96-43dd-b1f5-987f3284bc50.mov

che-bot · 2022-06-14T13:28:37Z

Click here to review and test in web IDE:

che-bot · 2022-06-14T13:30:22Z

Click here to review and test in web IDE:

dkwon17 · 2022-06-14T13:35:29Z

packages/dashboard-frontend/src/services/bootstrap/issuesReporter.ts

  type: IssueType;
  error: Error;
+  data?: T;


Hello @olexii4 @akurinnoy , how does adding data here this look? I added this to pass extra links for when rendering the error page:

che-dashboard/packages/dashboard-frontend/src/Layout/ErrorReporter/Issue/index.tsx

Lines 35 to 39 in d685db2

case 'workspaceStopped':

return this.renderWorkspaceStoppedError(

issue.error,

(issue as Issue<WorkspaceRoutes>).data,

);

I don't think that we are going to extend this part very often
As for me, I prefer to use just WorkspaceRoutes until we will need something else. I don't think we will extend this part in the near future.

@akurinnoy WDYT?

As for me, I prefer to use just WorkspaceRoutes until we will need something else.

Do you mean add a private field for WorkspaceRoutes inside of IssuesReporterService?

che-dashboard/packages/dashboard-frontend/src/services/bootstrap/issuesReporter.ts

Line 25 in 4a4d43c

export class IssuesReporterService {

Thank you for the suggestion, in my latest push, I've changed:

data?: T;

to

data?: WorkspaceRoutes

github-actions · 2022-06-14T13:45:06Z

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

github-actions · 2022-06-14T13:47:19Z

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

che-bot · 2022-06-14T17:35:39Z

Click here to review and test in web IDE:

github-actions · 2022-06-14T17:49:49Z

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

github-actions · 2022-06-16T20:20:32Z

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

olexii4

Well done!
Tested. It works as expected.

che-bot · 2022-06-20T15:53:43Z

Click here to review and test in web IDE:

che-bot · 2022-06-20T16:01:04Z

Click here to review and test in web IDE:

github-actions · 2022-06-20T16:15:21Z

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

dkwon17 · 2022-06-20T19:49:21Z

/retest

olexii4 · 2022-06-21T13:00:06Z

https://youtu.be/wdTb64-r34Q

ibuziuk · 2022-06-21T13:23:57Z

...ashboard-frontend/src/Layout/ErrorReporter/Issue/__tests__/__snapshots__/index.spec.tsx.snap

+      here
+    </a>
+     to restart your workspace.
+  </p>
+  <p
+    className=""
+    data-pf-content={true}
+  >
+    Click 
+    <a
+      onClick={[Function]}
+    >
+      here


here is UX antipattern [1] that we should try to avoid, so let's probably have just restart and return links

[1] https://issues.redhat.com/browse/CRW-3024

Sounds good, my latest push updates the links:

packages/dashboard-frontend/src/Layout/ErrorReporter/Issue/index.tsx

ibuziuk

Great improvement 👍
@dkwon17 just please remove here links before merging

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

che-bot · 2022-06-21T15:48:17Z

Click here to review and test in web IDE:

openshift-ci · 2022-06-21T15:52:42Z

[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 · 2022-06-21T16:04:07Z

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

openshift-ci bot added the do-not-merge/work-in-progress label Jun 9, 2022

dkwon17 commented Jun 9, 2022

View reviewed changes

packages/dashboard-frontend/src/preload/index.ts Outdated Show resolved Hide resolved

dkwon17 force-pushed the workspace-idle-page branch from 60e6ef4 to 27d0aa5 Compare June 9, 2022 19:58

olexii4 reviewed Jun 10, 2022

View reviewed changes

packages/dashboard-frontend/src/services/bootstrap/index.ts Outdated Show resolved Hide resolved

olexii4 reviewed Jun 10, 2022

View reviewed changes

packages/dashboard-frontend/src/services/bootstrap/index.ts Outdated Show resolved Hide resolved

olexii4 reviewed Jun 10, 2022

View reviewed changes

packages/dashboard-frontend/src/services/bootstrap/index.ts Outdated Show resolved Hide resolved

olexii4 reviewed Jun 10, 2022

View reviewed changes

packages/dashboard-frontend/src/services/bootstrap/index.ts Outdated Show resolved Hide resolved

olexii4 reviewed Jun 10, 2022

View reviewed changes

packages/dashboard-frontend/src/Layout/ErrorReporter/Issue/index.tsx Outdated Show resolved Hide resolved

dkwon17 marked this pull request as ready for review June 14, 2022 13:27

dkwon17 force-pushed the workspace-idle-page branch from 27d0aa5 to e8973de Compare June 14, 2022 13:28

dkwon17 force-pushed the workspace-idle-page branch from e8973de to d685db2 Compare June 14, 2022 13:30

dkwon17 changed the title ~~WIP: Detect if dashboard has been accessed due to workspace idle redirect + workspace idle error~~ Detect if dashboard has been accessed due to workspace idle redirect + workspace idle error Jun 14, 2022

openshift-ci bot removed the do-not-merge/work-in-progress label Jun 14, 2022

dkwon17 commented Jun 14, 2022

View reviewed changes

dkwon17 force-pushed the workspace-idle-page branch from d685db2 to 84b1724 Compare June 14, 2022 17:35

dkwon17 force-pushed the workspace-idle-page branch from 84b1724 to 80734ce Compare June 14, 2022 21:08

olexii4 approved these changes Jun 17, 2022

View reviewed changes

openshift-ci bot added the lgtm label Jun 17, 2022

dkwon17 force-pushed the workspace-idle-page branch from 06cc24e to 249074a Compare June 20, 2022 15:53

openshift-ci bot removed the lgtm label Jun 20, 2022

dkwon17 force-pushed the workspace-idle-page branch from 249074a to 8c5d418 Compare June 20, 2022 16:00

olexii4 approved these changes Jun 21, 2022

View reviewed changes

openshift-ci bot added the lgtm label Jun 21, 2022

akurinnoy approved these changes Jun 21, 2022

View reviewed changes

openshift-ci bot assigned akurinnoy Jun 21, 2022

ibuziuk reviewed Jun 21, 2022

View reviewed changes

packages/dashboard-frontend/src/Layout/ErrorReporter/Issue/index.tsx Outdated Show resolved Hide resolved

ibuziuk reviewed Jun 21, 2022

View reviewed changes

feat: error page for idled workspace

fe00e0f

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

dkwon17 force-pushed the workspace-idle-page branch from 8c5d418 to fe00e0f Compare June 21, 2022 15:48

openshift-ci bot removed the lgtm label Jun 21, 2022

ibuziuk approved these changes Jun 21, 2022

View reviewed changes

openshift-ci bot assigned ibuziuk Jun 21, 2022

openshift-ci bot added the lgtm label Jun 21, 2022

ibuziuk merged commit f6562c6 into main Jun 22, 2022

ibuziuk deleted the workspace-idle-page branch June 22, 2022 12:10

che-bot added this to the 7.50 milestone Jun 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Detect if dashboard has been accessed due to workspace idle redirect + workspace idle error #556

Detect if dashboard has been accessed due to workspace idle redirect + workspace idle error #556

dkwon17 commented Jun 9, 2022 •

edited

Loading

openshift-ci bot commented Jun 9, 2022

che-bot commented Jun 9, 2022

che-bot commented Jun 9, 2022

codecov bot commented Jun 9, 2022 •

edited

Loading

github-actions bot commented Jun 9, 2022

dkwon17 commented Jun 9, 2022

github-actions bot commented Jun 9, 2022

dkwon17 commented Jun 14, 2022

che-bot commented Jun 14, 2022

che-bot commented Jun 14, 2022

dkwon17 Jun 14, 2022

olexii4 Jun 16, 2022

dkwon17 Jun 16, 2022

dkwon17 Jun 20, 2022

github-actions bot commented Jun 14, 2022

github-actions bot commented Jun 14, 2022

che-bot commented Jun 14, 2022

github-actions bot commented Jun 14, 2022

github-actions bot commented Jun 16, 2022

olexii4 left a comment

che-bot commented Jun 20, 2022

che-bot commented Jun 20, 2022

github-actions bot commented Jun 20, 2022

dkwon17 commented Jun 20, 2022

olexii4 commented Jun 21, 2022

ibuziuk Jun 21, 2022

dkwon17 Jun 21, 2022

ibuziuk left a comment

che-bot commented Jun 21, 2022

openshift-ci bot commented Jun 21, 2022

github-actions bot commented Jun 21, 2022

	case 'workspaceStopped':
	return this.renderWorkspaceStoppedError(
	issue.error,
	(issue as Issue<WorkspaceRoutes>).data,
	);

Detect if dashboard has been accessed due to workspace idle redirect + workspace idle error #556

Detect if dashboard has been accessed due to workspace idle redirect + workspace idle error #556

Conversation

dkwon17 commented Jun 9, 2022 • edited Loading

What does this PR do?

What issues does this PR fix or reference?

Is it tested? How?

Release Notes

Docs PR

openshift-ci bot commented Jun 9, 2022

che-bot commented Jun 9, 2022

che-bot commented Jun 9, 2022

codecov bot commented Jun 9, 2022 • edited Loading

Codecov Report

github-actions bot commented Jun 9, 2022

dkwon17 commented Jun 9, 2022

github-actions bot commented Jun 9, 2022

dkwon17 commented Jun 14, 2022

che-bot commented Jun 14, 2022

che-bot commented Jun 14, 2022

dkwon17 Jun 14, 2022

Choose a reason for hiding this comment

olexii4 Jun 16, 2022

Choose a reason for hiding this comment

dkwon17 Jun 16, 2022

Choose a reason for hiding this comment

dkwon17 Jun 20, 2022

Choose a reason for hiding this comment

github-actions bot commented Jun 14, 2022

github-actions bot commented Jun 14, 2022

che-bot commented Jun 14, 2022

github-actions bot commented Jun 14, 2022

github-actions bot commented Jun 16, 2022

olexii4 left a comment

Choose a reason for hiding this comment

che-bot commented Jun 20, 2022

che-bot commented Jun 20, 2022

github-actions bot commented Jun 20, 2022

dkwon17 commented Jun 20, 2022

olexii4 commented Jun 21, 2022

ibuziuk Jun 21, 2022

Choose a reason for hiding this comment

dkwon17 Jun 21, 2022

Choose a reason for hiding this comment

ibuziuk left a comment

Choose a reason for hiding this comment

che-bot commented Jun 21, 2022

openshift-ci bot commented Jun 21, 2022

github-actions bot commented Jun 21, 2022

dkwon17 commented Jun 9, 2022 •

edited

Loading

codecov bot commented Jun 9, 2022 •

edited

Loading