feat: pass flag to terraform provider when prebuilt workspace claimed

Signed-off-by: Danny Kopping <dannykopping@gmail.com>
coder · dannykopping · May 12, 2025 · May 9, 2025 · May 12, 2025 · May 12, 2025
commit 1e8385d840d3debf4dfebb3542fde05f25982fd7
diff --git a/cli/testdata/coder_provisioner_list_--output_json.golden b/cli/testdata/coder_provisioner_list_--output_json.golden
@@ -7,7 +7,7 @@
     "last_seen_at": "====[timestamp]=====",
     "name": "test",
     "version": "v0.0.0-devel",
-    "api_version": "1.4",
+    "api_version": "1.5",
     "provisioners": [
       "echo"
     ],

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -646,6 +646,7 @@ func (s *server) acquireProtoJob(ctx context.Context, job database.ProvisionerJo
 					WorkspaceOwnerLoginType:       string(owner.LoginType),
 					WorkspaceOwnerRbacRoles:       ownerRbacRoles,
 					IsPrebuild:                    input.IsPrebuild,
+					IsPrebuildClaim:               input.IsPrebuildClaim,
 				},
 				LogLevel: input.LogLevel,
 			},
@@ -2471,11 +2472,11 @@ type TemplateVersionImportJob struct {
 
 // WorkspaceProvisionJob is the payload for the "workspace_provision" job type.
 type WorkspaceProvisionJob struct {
-	WorkspaceBuildID      uuid.UUID `json:"workspace_build_id"`
-	DryRun                bool      `json:"dry_run"`
-	IsPrebuild            bool      `json:"is_prebuild,omitempty"`
-	PrebuildClaimedByUser uuid.UUID `json:"prebuild_claimed_by,omitempty"`
-	LogLevel              string    `json:"log_level,omitempty"`
+	WorkspaceBuildID uuid.UUID `json:"workspace_build_id"`
+	DryRun           bool      `json:"dry_run"`
+	IsPrebuild       bool      `json:"is_prebuild,omitempty"`
+	IsPrebuildClaim  bool      `json:"is_prebuild_claim,omitempty"`
+	LogLevel         string    `json:"log_level,omitempty"`
 }
 
 // TemplateVersionDryRunJob is the payload for the "template_version_dry_run" job type.

diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -713,7 +713,7 @@ func createWorkspace(
 			builder = builder.TemplateVersionPresetID(req.TemplateVersionPresetID)
 		}
 		if claimedWorkspace != nil {
-			builder = builder.MarkPrebuildClaimedBy(owner.ID)
+			builder = builder.MarkPrebuildClaim()
 		}
 
 		if req.EnableDynamicParameters && api.Experiments.Enabled(codersdk.ExperimentDynamicParameters) {

diff --git a/coderd/wsbuilder/wsbuilder.go b/coderd/wsbuilder/wsbuilder.go
@@ -76,8 +76,7 @@ type Builder struct {
 	parameterValues                      *[]string
 	templateVersionPresetParameterValues []database.TemplateVersionPresetParameter
 
-	prebuild          bool
-	prebuildClaimedBy uuid.UUID
+	prebuild, prebuildClaim bool
 
 	verifyNoLegacyParametersOnce bool
 }
@@ -174,15 +173,17 @@ func (b Builder) RichParameterValues(p []codersdk.WorkspaceBuildParameter) Build
 	return b
 }
 
+// MarkPrebuild indicates that a prebuilt workspace is being built.
 func (b Builder) MarkPrebuild() Builder {
 	// nolint: revive
 	b.prebuild = true
 	return b
 }
 
-func (b Builder) MarkPrebuildClaimedBy(userID uuid.UUID) Builder {
+// MarkPrebuildClaim indicates that a prebuilt workspace is being claimed.
+func (b Builder) MarkPrebuildClaim() Builder {
 	// nolint: revive
-	b.prebuildClaimedBy = userID
+	b.prebuildClaim = true
 	return b
 }
 
@@ -322,10 +323,10 @@ func (b *Builder) buildTx(authFunc func(action policy.Action, object rbac.Object
 
 	workspaceBuildID := uuid.New()
 	input, err := json.Marshal(provisionerdserver.WorkspaceProvisionJob{
-		WorkspaceBuildID:      workspaceBuildID,
-		LogLevel:              b.logLevel,
-		IsPrebuild:            b.prebuild,
-		PrebuildClaimedByUser: b.prebuildClaimedBy,
+		WorkspaceBuildID: workspaceBuildID,
+		LogLevel:         b.logLevel,
+		IsPrebuild:       b.prebuild,
+		IsPrebuildClaim:  b.prebuildClaim,
 	})
 	if err != nil {
 		return nil, nil, nil, BuildError{

diff --git a/provisioner/terraform/provision.go b/provisioner/terraform/provision.go
@@ -273,6 +273,9 @@ func provisionEnv(
 	if metadata.GetIsPrebuild() {
 		env = append(env, provider.IsPrebuildEnvironmentVariable()+"=true")
 	}
+	if metadata.GetIsPrebuildClaim() {
+		env = append(env, provider.IsPrebuildClaimEnvironmentVariable()+"=true")
+	}
 
 	for key, value := range provisionersdk.AgentScriptEnv() {
 		env = append(env, key+"="+value)

@@ -12,12 +12,17 @@ import "github.com/coder/coder/v2/apiversion"
 //
 // API v1.4:
 //   - Add new field named `devcontainers` in the Agent.
+//
+// API v1.5:
+//   - Add new field named `is_prebuild_claim` in the Metadata message.
 const (
 	CurrentMajor = 1
-	CurrentMinor = 4
+	CurrentMinor = 5
 )
 
 // CurrentVersion is the current provisionerd API version.
 // Breaking changes to the provisionerd API **MUST** increment
 // CurrentMajor above.
+// Non-breaking changes to the provisionerd API **MUST** increment
+// CurrentMinor above.
 var CurrentVersion = apiversion.New(CurrentMajor, CurrentMinor)
@@ -293,8 +293,9 @@ message Metadata {
     string workspace_build_id = 17;
     string workspace_owner_login_type =  18;
     repeated Role workspace_owner_rbac_roles = 19;
-    bool is_prebuild = 20;
-    string running_workspace_agent_token = 21;
+    bool is_prebuild = 20;                     // Indicates that a prebuilt workspace is being built.
+    string running_workspace_agent_token = 21; // Preserves the running agent token of a prebuilt workspace so it can reinitialize.
+    bool is_prebuild_claim = 22;               // Indicates that a prebuilt workspace is being claimed.
-    bool is_prebuild_claim = 22;               // Indicates that a prebuilt workspace is being claimed.
+    bool claims_prebuilt_workspace = 22;               // Indicates that a prebuilt workspace is being claimed.
-    bool is_prebuild_claim = 22;               // Indicates that a prebuilt workspace is being claimed.
+    bool claims_prebuilt_workspace = 22;               // Indicates that a prebuilt workspace is being claimed.
 }
 
 // Config represents execution configuration shared by all subsequent requests in the Session