feat: implement more specific error pages for 'workspace stopped' err…

[dkwon17]

…or page

Signed-off-by: David Kwon [email protected]

What does this PR do?

Currently there is a generic error page that is displayed when trying to access a workspace url (a devworkspace's status.mainUrl) when the workspace is not running:

However, there can be multiple reasons why a workspace is not running. Some examples are:

• workspace is not running because it was shut down due to inactivity
• workspace is not running because it was shut down due to the run timeout
• workspace shut down because an error (ie case where for the devworkspace, status.phase == Failed)
• user forgot to start the workspace

This PR introduces a new class WorkspaceStoppedDetector to help detect the different cases.

Ad a result, different error page messages in each of these four scenarios are available:

Workspace inactivity

Workspace run timeout

Workspace error

Workspace was not started

What issues does this PR fix or reference?

Fixes eclipse-che/che#21516

Is it tested? How?

Testing the 'Workspace inactivity' error page

1. Set the workspace inactivity timeout to a smaller value by setting checluster.spec.devEnvironments.secondsOfInactivityBeforeIdling to, for example, 120.

2. Start a workspace. Once the editor opens, let it timeout by not interacting with it for about 120 seconds.

3. Once the workspace times out, refresh the page

Testing the 'Workspace run timeout' error page

1. Set the workspace run timeout to a value smaller than the inactivity timeout by setting checluster.spec.devEnvironments.secondsOfRunBeforeIdling to, for example, 80.

2. Start a workspace. After the workspace starts, the workspace should terminate in about 80 seconds.

3. Once the workspace times out, refresh the editor page

Testing the 'Workspace error' error page

1. To prevent other timeouts from shutting down the workspace, disable the timeouts by setting both secondsOfInactivityBeforeIdling and secondsOfRunBeforeIdling to -1 in the checluster CR.

2. Start a workspace with this github repository: https://github.com/dkwon17/failing-workspace/tree/fail-delayed

3. The editor should open, however after roughly 1 minute and 30 seconds, the workspace should terminate due to a failing container.

4. Refresh the editor page

Testing the 'Workspace was not started' error page

1. Start a workspace.

2. Once the workspace has started and the editor has loaded, stop the workspace.

3. Refresh the editor page

Release Notes

The warning page that appears when accessing the workspace url for a stopped workspace provides a more specific message depending on the reason why the workspace has stopped.

The cases are:

• Workspace has been stopped due to inactivity
• Workspace has been stopped because it reached the run timeout
• Workspace has stopped due to an error causing the workspace pod to shut down
• Workspace was not running in the first place

Docs PR

[che-bot]

Click here to review and test in web IDE:

[che-bot]

Click here to review and test in web IDE:

[che-bot]

Click here to review and test in web IDE:

[che-bot]

Click here to review and test in web IDE:

[github-actions]

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

[akurinnoy]

I tested locally on minikube, and everything works as expected.

[che-bot]

Click here to review and test in web IDE:

[che-bot]

Click here to review and test in web IDE:

[github-actions]

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

[dkwon17]

Thank you for the feedback everyone, I have removed the unused imports and added more unit tests:

[openshift-ci]

@dkwon17: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/v8-dashboard-happy-path	b705075	link	true	/test v8-dashboard-happy-path

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[openshift-ci]

[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