- Notifications
You must be signed in to change notification settings - Fork1k
fix(coderd/provisionerdserver): workaround lack of coder_ai_task resource on stop transition#19560
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
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes from1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
31 changes: 31 additions & 0 deletionscoderd/provisionerdserver/provisionerdserver.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1995,6 +1995,37 @@ func (s *server) completeWorkspaceBuildJob(ctx context.Context, job database.Pro | ||
| sidebarAppID = uuid.NullUUID{UUID: id, Valid: true} | ||
| } | ||
| // This is a hacky workaround for the issue with tasks 'disappearing' on stop: | ||
| // reuse has_ai_task and sidebar_app_id from the previous build. | ||
| // It should be removed as soon as possible. | ||
johnstcn marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| if workspaceBuild.Transition == database.WorkspaceTransitionStop && workspaceBuild.BuildNumber > 1 { | ||
| if prevBuild, err := s.Database.GetWorkspaceBuildByWorkspaceIDAndBuildNumber(ctx, database.GetWorkspaceBuildByWorkspaceIDAndBuildNumberParams{ | ||
| WorkspaceID: workspaceBuild.WorkspaceID, | ||
| BuildNumber: workspaceBuild.BuildNumber - 1, | ||
| }); err == nil { | ||
| hasAITask = prevBuild.HasAITask.Bool | ||
| sidebarAppID = prevBuild.AITaskSidebarAppID | ||
| warnUnknownSidebarAppID = false | ||
| s.Logger.Warn(ctx, "hacky task workaround: reused has_ai_task and sidebar_app_id from previous build", | ||
johnstcn marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| slog.F("job_id", job.ID.String()), | ||
| slog.F("build_number", prevBuild.BuildNumber), | ||
| slog.F("workspace_id", workspace.ID), | ||
| slog.F("workspace_build_id", workspaceBuild.ID), | ||
| slog.F("transition", string(workspaceBuild.Transition)), | ||
| slog.F("sidebar_app_id", sidebarAppID.UUID), | ||
| slog.F("has_ai_task", hasAITask), | ||
| ) | ||
| } else { | ||
| s.Logger.Error(ctx, "hacky task workaround failed", | ||
johnstcn marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| slog.Error(err), | ||
| 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)), | ||
| ) | ||
| } | ||
| } | ||
| if warnUnknownSidebarAppID { | ||
| // Ref: https://github.com/coder/coder/issues/18776 | ||
| // This can happen for a number of reasons: | ||
79 changes: 78 additions & 1 deletioncoderd/provisionerdserver/provisionerdserver_test.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -2842,9 +2842,12 @@ func TestCompleteJob(t *testing.T) { | ||
| // has_ai_task has a default value of nil, but once the workspace build completes it will have a value; | ||
| // it is set to "true" if the related template has any coder_ai_task resources defined, and its sidebar app ID | ||
| // will be set as well in that case. | ||
| // HACK: we also set it to "true" if any _previous_ workspace builds ever had it set to "true". | ||
johnstcn marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // This is to avoid tasks "disappearing" when you stop them. | ||
| t.Run("WorkspaceBuild", func(t *testing.T) { | ||
| type testcase struct { | ||
| name string | ||
| seedFunc func(context.Context, database.Store) error // If you need to insert other resources | ||
| transition database.WorkspaceTransition | ||
| input *proto.CompletedJob_WorkspaceBuild | ||
| expectHasAiTask bool | ||
| @@ -2944,6 +2947,72 @@ func TestCompleteJob(t *testing.T) { | ||
| expectHasAiTask: true, | ||
| expectUsageEvent: false, | ||
| }, | ||
| { | ||
| name: "current build does not have ai task but previous build did", | ||
| seedFunc: func(ctx context.Context, db database.Store) error { | ||
| // ws, err := db.GetWorkspaces(ctx, database.GetWorkspacesParams{}) | ||
johnstcn marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| tpls, err := db.GetTemplates(ctx) | ||
| if err != nil { | ||
| return xerrors.Errorf("seedFunc: get template: %w", err) | ||
johnstcn marked this conversation as resolved. OutdatedShow resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| if len(tpls) != 1 { | ||
| return xerrors.Errorf("seed: expected exactly one template, got %d", len(tpls)) | ||
| } | ||
| ws, err := db.GetWorkspacesByTemplateID(ctx, tpls[0].ID) | ||
| if err != nil { | ||
| return xerrors.Errorf("seedFunc: get workspaces: %w", err) | ||
| } | ||
| if len(ws) != 1 { | ||
| return xerrors.Errorf("seed: expected exactly one workspace, got %d", len(ws)) | ||
| } | ||
| w := ws[0] | ||
| prevJob := dbgen.ProvisionerJob(t, db, nil, database.ProvisionerJob{ | ||
| OrganizationID: w.OrganizationID, | ||
| InitiatorID: w.OwnerID, | ||
| Type: database.ProvisionerJobTypeWorkspaceBuild, | ||
| }) | ||
| tvs, err := db.GetTemplateVersionsByTemplateID(ctx, database.GetTemplateVersionsByTemplateIDParams{ | ||
| TemplateID: tpls[0].ID, | ||
| }) | ||
| if err != nil { | ||
| return xerrors.Errorf("seedFunc: get template version: %w", err) | ||
| } | ||
| if len(tvs) != 1 { | ||
| return xerrors.Errorf("seed: expected exactly one template version, got %d", len(tvs)) | ||
| } | ||
| if tpls[0].ActiveVersionID == uuid.Nil { | ||
| return xerrors.Errorf("seed: active version id is nil") | ||
| } | ||
| res := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{ | ||
| JobID: prevJob.ID, | ||
| }) | ||
| agt := dbgen.WorkspaceAgent(t, db, database.WorkspaceAgent{ | ||
| ResourceID: res.ID, | ||
| }) | ||
| wa := dbgen.WorkspaceApp(t, db, database.WorkspaceApp{ | ||
| AgentID: agt.ID, | ||
| }) | ||
| _ = dbgen.WorkspaceBuild(t, db, database.WorkspaceBuild{ | ||
| BuildNumber: 1, | ||
| HasAITask: sql.NullBool{Valid: true, Bool: true}, | ||
| AITaskSidebarAppID: uuid.NullUUID{Valid: true, UUID: wa.ID}, | ||
| ID: w.ID, | ||
| InitiatorID: w.OwnerID, | ||
| JobID: prevJob.ID, | ||
| TemplateVersionID: tvs[0].ID, | ||
| Transition: database.WorkspaceTransitionStart, | ||
| WorkspaceID: w.ID, | ||
| }) | ||
| return nil | ||
| }, | ||
| transition: database.WorkspaceTransitionStop, | ||
| input: &proto.CompletedJob_WorkspaceBuild{ | ||
| AiTasks: []*sdkproto.AITask{}, | ||
| Resources: []*sdkproto.Resource{}, | ||
| }, | ||
| expectHasAiTask: true, | ||
| expectUsageEvent: false, | ||
| }, | ||
| } { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| @@ -2980,6 +3049,9 @@ func TestCompleteJob(t *testing.T) { | ||
| }) | ||
| ctx := testutil.Context(t, testutil.WaitShort) | ||
| if tc.seedFunc != nil { | ||
| require.NoError(t, tc.seedFunc(ctx, db)) | ||
| } | ||
| buildJobID := uuid.New() | ||
| wsBuildID := uuid.New() | ||
| @@ -2999,8 +3071,13 @@ func TestCompleteJob(t *testing.T) { | ||
| Tags: pd.Tags, | ||
| }) | ||
| require.NoError(t, err) | ||
| var buildNum int32 | ||
| if latestBuild, err := db.GetLatestWorkspaceBuildByWorkspaceID(ctx, workspaceTable.ID); err == nil { | ||
| buildNum = latestBuild.BuildNumber | ||
| } | ||
| build := dbgen.WorkspaceBuild(t, db, database.WorkspaceBuild{ | ||
| ID: wsBuildID, | ||
| BuildNumber: buildNum + 1, | ||
| JobID: buildJobID, | ||
| WorkspaceID: workspaceTable.ID, | ||
| TemplateVersionID: version.ID, | ||
| @@ -3038,7 +3115,7 @@ func TestCompleteJob(t *testing.T) { | ||
| require.True(t, build.HasAITask.Valid) // We ALWAYS expect a value to be set, therefore not nil, i.e. valid = true. | ||
| require.Equal(t, tc.expectHasAiTask, build.HasAITask.Bool) | ||
| if tc.expectHasAiTask&& build.Transition != database.WorkspaceTransitionStop{ | ||
| require.Equal(t, sidebarAppID, build.AITaskSidebarAppID.UUID.String()) | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.