chore(coderd/provisionerdserver): avoid fk error on invalid ai_task_sidebar_app_id #19253
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
DanielleMaywood
approved these changes
Aug 8, 2025
mafredri
approved these changes
Aug 8, 2025
| Level: []database.LogLevel{database.LogLevelWarn}, | ||
| Stage: []string{"Cleaning Up"}, | ||
| Output: []string{ | ||
| fmt.Sprintf("Unknown ai_task_sidebar_app_id %q. This workspace will be unable to run AI tasks. This may be due to a template configuration issue, please check with the template author.", sidebarAppID.UUID.String()), |
There was a problem hiding this comment.
Linking to some docs could be beneficial if this is the template author viewing the message. I.e. how will the author know how to resolve this/why it happened?
There was a problem hiding this comment.
That's a good point. Which documentation should we link to?
There was a problem hiding this comment.
Ah, it looks like we don't really have any related docs yet. Perhaps we could give a hint as to what the most common cause of the error is, as well as link to https://registry.terraform.io/providers/coder/coder/latest/docs/resources/ai_task?
| if hasAITask { | ||
| task := jobType.WorkspaceBuild.AiTasks[0] | ||
| if task.SidebarApp == nil { | ||
| return xerrors.Errorf("update ai task: sidebar app is nil") | ||
| if task.SidebarApp == nil || len(task.SidebarApp.Id) == 0 { |
There was a problem hiding this comment.
Suggestion: Use getters for safer access (fixing all non-getter uses is out of scope though)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 is a workaround for #18776
We avoid the foreign key issue by checking the previously inserted workspace applications before calling UpdateWorkspaceAITask. Now, affected workspaces will show as "not running an AI task" on the single task view, which is technically correct.
We also insert a provisioner job log at WARN level to ensure that the user sees some information that they have run into this issue, as well as logging on the server side.
Longer term, we plan to modify how the workspace tasks view is presented. This is a stopgap measure until we solidify that plan.
NOTE: this does not address the fact that stopping a workspace with
has_ai_task: truewill result in the completed stop build no longer havinghas_ai_task: true, resulting in tasks "disappearing" on stop.