refactor: use specific error for agpl and prebuilds

evgeniy-scherbina · evgeniy-scherbina · commit b0a025e9f8d5 · 2025-04-28T17:35:47.000Z
diff --git a/coderd/prebuilds/api.go b/coderd/prebuilds/api.go
@@ -9,7 +9,10 @@ import (
 	"github.com/coder/coder/v2/coderd/database"
 )
 
-var ErrNoClaimablePrebuiltWorkspaces = xerrors.New("no claimable prebuilt workspaces found")
+var (
+	ErrNoClaimablePrebuiltWorkspaces = xerrors.New("no claimable prebuilt workspaces found")
+	ErrAGPLDoesNotSupportPrebuilds   = xerrors.New("prebuild-related functionality is not supported under the AGPL license")
+)
 
 // ReconciliationOrchestrator manages the lifecycle of prebuild reconciliation.
 // It runs a continuous loop to check and reconcile prebuild states, and can be stopped gracefully.
diff --git a/coderd/prebuilds/noop.go b/coderd/prebuilds/noop.go
@@ -27,7 +27,7 @@ type NoopClaimer struct{}
 
 func (NoopClaimer) Claim(context.Context, uuid.UUID, string, uuid.UUID) (*uuid.UUID, error) {
 	// Not entitled to claim prebuilds in AGPL version.
-	return nil, ErrNoClaimablePrebuiltWorkspaces
+	return nil, ErrAGPLDoesNotSupportPrebuilds
 }
 
 func (NoopClaimer) Initiator() uuid.UUID {
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -650,8 +650,11 @@ func createWorkspace(
 		if req.TemplateVersionPresetID != uuid.Nil {
 			// Try and claim an eligible prebuild, if available.
 			claimedWorkspace, err = claimPrebuild(ctx, prebuildsClaimer, db, api.Logger, req, owner)
-			if err != nil && !errors.Is(err, prebuilds.ErrNoClaimablePrebuiltWorkspaces) {
-				return xerrors.Errorf("claim prebuild: %w", err)
+			if err != nil &&
+				!errors.Is(err, prebuilds.ErrNoClaimablePrebuiltWorkspaces) &&
+				!errors.Is(err, prebuilds.ErrAGPLDoesNotSupportPrebuilds) {
+
+				return xerrors.Errorf("failed to claim prebuilt workspace: %w", err)
 			}
 		}
 
diff --git a/enterprise/coderd/prebuilds/claim_test.go b/enterprise/coderd/prebuilds/claim_test.go
@@ -111,6 +111,11 @@ func TestClaimPrebuild(t *testing.T) {
 			markPrebuildsClaimable: true,
 			claimingErr:            agplprebuilds.ErrNoClaimablePrebuiltWorkspaces,
 		},
+		"AGPL does not support prebuilds error is returned": {
+			expectPrebuildClaimed:  false,
+			markPrebuildsClaimable: true,
+			claimingErr:            agplprebuilds.ErrAGPLDoesNotSupportPrebuilds,
+		},
 		"unexpected claiming error is returned": {
 			expectPrebuildClaimed:  false,
 			markPrebuildsClaimable: true,
@@ -224,8 +229,11 @@ func TestClaimPrebuild(t *testing.T) {
 				TemplateVersionPresetID: presets[0].ID,
 			})
 
+			isNoPrebuiltWorkspaces := errors.Is(tc.claimingErr, agplprebuilds.ErrNoClaimablePrebuiltWorkspaces)
+			isUnsupported := errors.Is(tc.claimingErr, agplprebuilds.ErrAGPLDoesNotSupportPrebuilds)
+
 			switch {
-			case tc.claimingErr != nil && errors.Is(tc.claimingErr, agplprebuilds.ErrNoClaimablePrebuiltWorkspaces):
+			case tc.claimingErr != nil && (isNoPrebuiltWorkspaces || isUnsupported):
 				require.NoError(t, err)
 				coderdtest.AwaitWorkspaceBuildJobCompleted(t, userClient, userWorkspace.LatestBuild.ID)
 

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ type NoopClaimer struct{}`
`27`	`27`
`28`	`28`	`func (NoopClaimer) Claim(context.Context, uuid.UUID, string, uuid.UUID) (*uuid.UUID, error) {`
`29`	`29`	`// Not entitled to claim prebuilds in AGPL version.`
`30`		`- return nil, ErrNoClaimablePrebuiltWorkspaces`
	`30`	`+ return nil, ErrAGPLDoesNotSupportPrebuilds`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`func (NoopClaimer) Initiator() uuid.UUID {`
Original file line number	Diff line number	Diff line change
`@@ -650,8 +650,11 @@ func createWorkspace(`
`650`	`650`	`if req.TemplateVersionPresetID != uuid.Nil {`
`651`	`651`	`// Try and claim an eligible prebuild, if available.`
`652`	`652`	`claimedWorkspace, err = claimPrebuild(ctx, prebuildsClaimer, db, api.Logger, req, owner)`
`653`		`- if err != nil && !errors.Is(err, prebuilds.ErrNoClaimablePrebuiltWorkspaces) {`
`654`		`- return xerrors.Errorf("claim prebuild: %w", err)`
	`653`	`+ if err != nil &&`
	`654`	`+ !errors.Is(err, prebuilds.ErrNoClaimablePrebuiltWorkspaces) &&`
	`655`	`+ !errors.Is(err, prebuilds.ErrAGPLDoesNotSupportPrebuilds) {`
	`656`	`+`
	`657`	`+ return xerrors.Errorf("failed to claim prebuilt workspace: %w", err)`
`655`	`658`	`}`
`656`	`659`	`}`
`657`	`660`