Skip to content

fix: adjust workspace claims to be initiated by users #20179

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SasSwart merged 2 commits into from
Oct 8, 2025
Merged

fix: adjust workspace claims to be initiated by users #20179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc80541
fix: the action of claiming a workspace is initiated by a user, not b…
SasSwart Oct 6, 2025
7484738
Add test assertions to prebuild tests to ensure that the initiator is…
SasSwart Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion coderd/prebuilds/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,4 @@ type Claimer interface {
nextStartAt sql.NullTime,
ttl sql.NullInt64,
) (*uuid.UUID, error)
Initiator() uuid.UUID
}
4 changes: 0 additions & 4 deletions coderd/prebuilds/noop.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,4 @@ func (NoopClaimer) Claim(context.Context, time.Time, uuid.UUID, string, uuid.UUI
return nil, ErrAGPLDoesNotSupportPrebuiltWorkspaces
}

func (NoopClaimer) Initiator() uuid.UUID {
return uuid.Nil
}

var DefaultClaimer Claimer = NoopClaimer{}
1 change: 0 additions & 1 deletion coderd/workspaces.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,7 +719,6 @@ func createWorkspace(
} else {
// Prebuild found!
workspaceID = claimedWorkspace.ID
initiatorID = prebuildsClaimer.Initiator()
}

// We have to refetch the workspace for the joined in fields.
Expand Down
4 changes: 0 additions & 4 deletions enterprise/coderd/prebuilds/claim.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,4 @@ func (c EnterpriseClaimer) Claim(
return &result.ID, nil
}

func (EnterpriseClaimer) Initiator() uuid.UUID {
return database.PrebuildsSystemUserID
}

var _ prebuilds.Claimer = &EnterpriseClaimer{}
15 changes: 9 additions & 6 deletions enterprise/coderd/prebuilds/claim_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,6 @@ func (m *storeSpy) ClaimPrebuiltWorkspace(ctx context.Context, arg database.Clai
func TestClaimPrebuild(t *testing.T) {
t.Parallel()

if !dbtestutil.WillUsePostgres() {
t.Skip("This test requires postgres")
}

const (
desiredInstances = 1
presetCount = 2
Expand Down Expand Up @@ -260,13 +256,15 @@ func TestClaimPrebuild(t *testing.T) {
switch {
case tc.claimingErr != nil && (isNoPrebuiltWorkspaces || isUnsupported):
require.NoError(t, err)
build := coderdtest.AwaitWorkspaceBuildJobCompleted(t, userClient, userWorkspace.LatestBuild.ID)
_ = build
coderdtest.AwaitWorkspaceBuildJobCompleted(t, userClient, userWorkspace.LatestBuild.ID)

// Then: the number of running prebuilds hasn't changed because claiming prebuild is failed and we fallback to creating new workspace.
currentPrebuilds, err := spy.GetRunningPrebuiltWorkspaces(ctx)
require.NoError(t, err)
require.Equal(t, expectedPrebuildsCount, len(currentPrebuilds))
// If there are no prebuilt workspaces to claim, a new workspace is created from scratch
// and the initiator is set as usual.
require.Equal(t, user.ID, userWorkspace.LatestBuild.Job.InitiatorID)
return

case tc.claimingErr != nil && errors.Is(tc.claimingErr, unexpectedClaimingError):
Expand All @@ -278,13 +276,18 @@ func TestClaimPrebuild(t *testing.T) {
currentPrebuilds, err := spy.GetRunningPrebuiltWorkspaces(ctx)
require.NoError(t, err)
require.Equal(t, expectedPrebuildsCount, len(currentPrebuilds))
// If a prebuilt workspace claim fails for an unanticipated, erroneous reason,
// no workspace is created and therefore the initiator is not set.
require.Equal(t, uuid.Nil, userWorkspace.LatestBuild.Job.InitiatorID)
return

default:
// tc.claimingErr is nil scenario
require.NoError(t, err)
build := coderdtest.AwaitWorkspaceBuildJobCompleted(t, userClient, userWorkspace.LatestBuild.ID)
require.Equal(t, build.Job.Status, codersdk.ProvisionerJobSucceeded)
// Prebuild claims are initiated by the user who requested to create a workspace.
require.Equal(t, user.ID, userWorkspace.LatestBuild.Job.InitiatorID)
}

// at this point we know that tc.claimingErr is nil
Expand Down
Loading