- Notifications
You must be signed in to change notification settings - Fork1k
chore(coderd/provisionerdserver): avoid fk error on invalid ai_task_sidebar_app_id#19253
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
d92df3e
855e8b9
cfbc050
5df922b
691ac30
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1925,12 +1925,16 @@ func (s *server) completeWorkspaceBuildJob(ctx context.Context, job database.Pro | ||
return xerrors.Errorf("update workspace build deadline: %w", err) | ||
} | ||
appIDs := make([]string, 0) | ||
agentTimeouts := make(map[time.Duration]bool) // A set of agent timeouts. | ||
// This could be a bulk insert to improve performance. | ||
for _, protoResource := range jobType.WorkspaceBuild.Resources { | ||
for _, protoAgent := range protoResource.Agents { | ||
dur := time.Duration(protoAgent.GetConnectionTimeoutSeconds()) * time.Second | ||
agentTimeouts[dur] = true | ||
for _, app := range protoAgent.GetApps() { | ||
appIDs = append(appIDs, app.GetId()) | ||
} | ||
} | ||
err = InsertWorkspaceResource(ctx, db, job.ID, workspaceBuild.Transition, protoResource, telemetrySnapshot) | ||
@@ -1945,33 +1949,78 @@ func (s *server) completeWorkspaceBuildJob(ctx context.Context, job database.Pro | ||
} | ||
var sidebarAppID uuid.NullUUID | ||
var hasAITask bool | ||
var warnUnknownSidebarAppID bool | ||
if tasks := jobType.WorkspaceBuild.GetAiTasks(); len(tasks) > 0 { | ||
hasAITask = true | ||
task := tasks[0] | ||
if task == nil || task.GetSidebarApp() == nil || len(task.GetSidebarApp().GetId()) == 0 { | ||
return xerrors.Errorf("update ai task: sidebar app is nil or empty") | ||
} | ||
sidebarTaskID := task.GetSidebarApp().GetId() | ||
if !slices.Contains(appIDs, sidebarTaskID) { | ||
warnUnknownSidebarAppID = true | ||
} | ||
id, err := uuid.Parse(task.GetSidebarApp().GetId()) | ||
if err != nil { | ||
return xerrors.Errorf("parse sidebar app id: %w", err) | ||
} | ||
sidebarAppID = uuid.NullUUID{UUID: id, Valid: true} | ||
} | ||
if warnUnknownSidebarAppID { | ||
// Ref: https://github.com/coder/coder/issues/18776 | ||
// This can happen for a number of reasons: | ||
// 1. Misconfigured template | ||
// 2. Count=0 on the agent due to stop transition, meaning the associated coder_app was not inserted. | ||
// Failing the build at this point is not ideal, so log a warning instead. | ||
s.Logger.Warn(ctx, "unknown ai_task_sidebar_app_id", | ||
slog.F("ai_task_sidebar_app_id", sidebarAppID.UUID.String()), | ||
slog.F("job_id", job.ID.String()), | ||
slog.F("workspace_id", workspace.ID), | ||
slog.F("workspace_build_id", workspaceBuild.ID), | ||
slog.F("transition", string(workspaceBuild.Transition)), | ||
) | ||
// In order to surface this to the user, we will also insert a warning into the build logs. | ||
if _, err := db.InsertProvisionerJobLogs(ctx, database.InsertProvisionerJobLogsParams{ | ||
JobID: jobID, | ||
CreatedAt: []time.Time{now, now, now, now}, | ||
Source: []database.LogSource{database.LogSourceProvisionerDaemon, database.LogSourceProvisionerDaemon, database.LogSourceProvisionerDaemon, database.LogSourceProvisionerDaemon}, | ||
Level: []database.LogLevel{database.LogLevelWarn, database.LogLevelWarn, database.LogLevelWarn, database.LogLevelWarn}, | ||
Stage: []string{"Cleaning Up", "Cleaning Up", "Cleaning Up", "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()), | ||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. That's a good point. Which documentation should we link to? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 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 tohttps://registry.terraform.io/providers/coder/coder/latest/docs/resources/ai_task? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. ¡Muy caliente! | ||
"Template author: double-check the following:", | ||
" - You have associated the coder_ai_task with a valid coder_app in your template (ref: https://registry.terraform.io/providers/coder/coder/latest/docs/resources/ai_task).", | ||
" - You have associated the coder_agent with at least one other compute resource. Agents with no other associated resources are not inserted into the database.", | ||
}, | ||
}); err != nil { | ||
s.Logger.Error(ctx, "insert provisioner job log for ai task sidebar app id warning", | ||
slog.F("job_id", jobID), | ||
slog.F("workspace_id", workspace.ID), | ||
slog.F("workspace_build_id", workspaceBuild.ID), | ||
slog.F("transition", string(workspaceBuild.Transition)), | ||
) | ||
} | ||
// Important: reset hasAITask and sidebarAppID so that we don't run into a fk constraint violation. | ||
hasAITask = false | ||
sidebarAppID = uuid.NullUUID{} | ||
} | ||
// Regardless of whether there is an AI task or not, update the field to indicate one way or the other since it | ||
// always defaults to nil. ONLY if has_ai_task=true MUST ai_task_sidebar_app_id be set. | ||
iferr:= db.UpdateWorkspaceBuildAITaskByID(ctx, database.UpdateWorkspaceBuildAITaskByIDParams{ | ||
ID: workspaceBuild.ID, | ||
HasAITask: sql.NullBool{ | ||
Bool: hasAITask, | ||
Valid: true, | ||
}, | ||
SidebarAppID: sidebarAppID, | ||
UpdatedAt: now, | ||
}); err != nil { | ||
return xerrors.Errorf("update workspace build ai tasks flag: %w", err) | ||
} | ||
Uh oh!
There was an error while loading.Please reload this page.