[go: up one dir, main page]
Skip to content

Clearer error handling for failed workspaces

MR: Pending

Description

In the UI, workspaces that fail can get permanently stuck in a spinner state. The error banner message at top of page also has a vague error message that makes it hard to troubleshoot. The workspace page would benefit from more actionable error messages and having individual workspaces switch from the spinner to an error state.

Notes

  • This was from my local environment.
  • It's possible that individual workspaces can fail without the error message appearing at the top of the page until the page refreshes. I wasn't able to re-create the original state so it's also possible I just missed the error banner message the first time.

Example

Acceptance Criteria

  • Failed workspaces don't permanently stay in a spinner state
  • Failed workspaces have an error state
  • Users have a next step for understanding/resolving the error

Technical Requirements

TODO: Fill out or delete [If applicable, please list out any technical requirements for this feature/enhancement.]

Design Requirements

Proposal (concept only):

Workspace specific errors:

  • A workspace that's stuck in a spinner state will eventually time out and switch to an error state so users aren't left wondering if there's a problem.
  • A failed workspace has an error label so users can quickly see it's current state.
  • A failed workspace gives a quick link to logs (or whatever would be most useful for troubleshooting) so they have an actionable way to troubleshoot the problem.

Errors affecting all workspaces:

  • All workspaces display the error label so the UI is consistent. It can be confusing to show individual workspaces as being connected but have an error message at top saying the opposite.
  • The error banner at top of page gives a more descriptive reason (if possible) and provides a next step that's more actionable than contact your admin (e.g. View logs).

Impact Assessment

This will improve workspace UX by making it easier for users to understand when an error occurs on specific workspaces as well as how to troubleshoot the problem on their own.

User Story

As a workspace user I want to understand when and why a workspace has an error so that I can resolve the problem faster.