Skip to content

Improve startup script notification in web terminal with troubleshooting link and status update #7766

Closed
@mafredri

Description

@mafredri

There are currently three issues with the startup script notification in the web terminal:

  1. It doesn't inform the user why, or how to inspect or fix the issue
  2. It doesn't update the status, so even when the startup script has completed, the message doesn't change, leading to confusion.
  3. Pressing reload session does not warn the user that whatever is in the terminal will disappear (this could behave similar to restart workspace => don't show this again)

This issue will not target 3, although mentioned.

Part of this proposal depends on #7760 (updated troubleshooting links).

Current message(s):

Title: Startup script is still running
Body: You can continue using this terminal, but something may be missing or not fully set up.

Title: Startup script failed
Body: You can continue using this terminal, but something may be missing or not fully set up.

New message(s):

Icon: Notice
Title: Startup script is still running
Body: You can continue using this terminal, but [your workspace may be incomplete](https://coder.com/docs/v2/latest/templates#your-workspace-may-be-incomplete).

# If terminal opened before completion, and notification has not been dismissed:
Icon: OK
Title: Startup script has completed successfully
Body: The workspace is ready but this [session was started before the startup script finished](https://coder.com/docs/v2/latest/templates#session-was-started-before-the-startup-script-finished). To ensure your shell environment is up-to-date, we recommend reloading this session.

Icon: Warning
Title: Startup script has exited with an error
Body: The workspace [startup script has exited with an error](https://coder.com/docs/v2/latest/templates#startup-script-exited-with-an-error), we recommend reloading this session and [debugging the startup script](https://coder.com/docs/v2/latest/templates#debugging-the-startup-script) because [your workspace may be incomplete](https://coder.com/docs/v2/latest/templates#your-workspace-may-be-incomplete).

These updated messages depend on updated docs with new sections linking to specific information: #7759. (Live.)

  • Update still running and error message texts/icons
  • Add completed (successfully) message
  • Add support for switching to completed/exited with an error message based on current workspace status (don't show if already dismissed)

Metadata

Metadata

Assignees

Labels

siteArea: frontend dashboard

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions