feat: extend workspace build reasons to track connection types #18827
+388
−36
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jul 14, 2025
deansheather
approved these changes
Jul 15, 2025
ethanndickson
approved these changes
Jul 15, 2025
Comment on lines
3
to
5
| ALTER TYPE build_reason ADD VALUE IF NOT EXISTS 'ssh_connection'; | ||
| ALTER TYPE build_reason ADD VALUE IF NOT EXISTS 'vscode_connection'; | ||
| ALTER TYPE build_reason ADD VALUE IF NOT EXISTS 'jetbrains_connection'; |
There was a problem hiding this comment.
The _connection part is implicit here - if you're using any of these, it was to connect to the workspace. I would personally drop the suffixes, but it's up to you.
BrunoQuaresma
approved these changes
Jul 15, 2025
site/src/utils/workspace.tsx
Outdated
| @@ -87,6 +92,26 @@ export const getDisplayWorkspaceBuildInitiatedBy = ( | |||
| return undefined; | |||
| }; | |||
|
|
|||
| export const getDisplayInitiatorBuildReason = ( | |||
There was a problem hiding this comment.
Nit: I think this is a nice case to use records.
const buildReasonLabels: Record<BuildReason, string> = {
initiator: "API",
dashboard: "Dashboard",
cli: "CLI",
// ...
}So you can use it directly in the component:
<span>{buildReasonLabels[log.build_reason]}</span>Wdyt?
There was a problem hiding this comment.
@BrunoQuaresma I’ve slightly modified the impl based on your suggestion. PTAL
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces new build reason values to identify what type of connection triggered a workspace build, helping to troubleshoot workspace-related issues.
Database Migration
Added migration 000349_extend_workspace_build_reason.up.sql that extends the build_reason enum with new values:
Implementation
The build reason is specified through the API when creating new workspace builds:
dashboardwhen users start workspaces via the web interfacestartcommand: Sets reason tocliwhen workspaces are started via the command linesshcommand: Sets reason to ssh_connection when workspaces are started due to SSH connectionsvscode_connectionby the VS Code extension through CLI hidden flag (feat: set 'vscode_connection' as build reason on workspace start vscode-coder#550)jetbrains_connectionby the Jetbrains Toolbox (feat: set 'jetbrains_connection' as build reason on workspace start coder-jetbrains-toolbox#150) and Jetbrains Gateway extension (feat: set 'jetbrains_connection' as build reason on workspace start jetbrains-coder#561)UI Changes: