Add provision job metadata to identify prebuilds

dannykopping · dannykopping · commit a59a03d5f4d2 · 2025-02-14T12:17:06.000Z
Signed-off-by: Danny Kopping &lt;danny@coder.com&gt;
diff --git a/coderd/prebuilds/controller.go b/coderd/prebuilds/controller.go
@@ -323,7 +323,8 @@ func (c Controller) provision(ctx context.Context, db database.Store, prebuildID
 		Reason(database.BuildReasonInitiator).
 		Initiator(PrebuildOwnerUUID).
 		ActiveVersion().
-		VersionID(template.ActiveVersionID)
+		VersionID(template.ActiveVersionID).
+		MarkPrebuild()
 	// RichParameterValues(req.RichParameterValues) // TODO: fetch preset's params
 
 	_, provisionerJob, _, err := builder.Build(
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -621,6 +621,7 @@ func (s *server) acquireProtoJob(ctx context.Context, job database.ProvisionerJo
 					WorkspaceOwnerSshPrivateKey:   ownerSSHPrivateKey,
 					WorkspaceBuildId:              workspaceBuild.ID.String(),
 					WorkspaceOwnerLoginType:       string(owner.LoginType),
+					IsPrebuild:                    input.IsPrebuild,
 				},
 				LogLevel: input.LogLevel,
 			},
@@ -2345,6 +2346,7 @@ type TemplateVersionImportJob struct {
 type WorkspaceProvisionJob struct {
 	WorkspaceBuildID uuid.UUID `json:"workspace_build_id"`
 	DryRun           bool      `json:"dry_run"`
+	IsPrebuild       bool      `json:"is_prebuild,omitempty"`
 	LogLevel         string    `json:"log_level,omitempty"`
 }
 
diff --git a/coderd/wsbuilder/wsbuilder.go b/coderd/wsbuilder/wsbuilder.go
@@ -72,6 +72,7 @@ type Builder struct {
 	lastBuildJob                 *database.ProvisionerJob
 	parameterNames               *[]string
 	parameterValues              *[]string
+	prebuild                     bool
 
 	verifyNoLegacyParametersOnce bool
 }
@@ -168,6 +169,12 @@ func (b Builder) RichParameterValues(p []codersdk.WorkspaceBuildParameter) Build
 	return b
 }
 
+func (b Builder) MarkPrebuild() Builder {
+	// nolint: revive
+	b.prebuild = true
+	return b
+}
+
 // SetLastWorkspaceBuildInTx prepopulates the Builder's cache with the last workspace build.  This allows us
 // to avoid a repeated database query when the Builder's caller also needs the workspace build, e.g. auto-start &
 // auto-stop.
@@ -295,6 +302,7 @@ func (b *Builder) buildTx(authFunc func(action policy.Action, object rbac.Object
 	input, err := json.Marshal(provisionerdserver.WorkspaceProvisionJob{
 		WorkspaceBuildID: workspaceBuildID,
 		LogLevel:         b.logLevel,
+		IsPrebuild:       b.prebuild,
 	})
 	if err != nil {
 		return nil, nil, nil, BuildError{
diff --git a/provisioner/terraform/provision.go b/provisioner/terraform/provision.go
@@ -262,6 +262,9 @@ func provisionEnv(
 		"CODER_WORKSPACE_TEMPLATE_VERSION="+metadata.GetTemplateVersion(),
 		"CODER_WORKSPACE_BUILD_ID="+metadata.GetWorkspaceBuildId(),
 	)
+	if metadata.GetIsPrebuild() {
+		env = append(env, "CODER_WORKSPACE_IS_PREBUILD=true")
+	}
 	for key, value := range provisionersdk.AgentScriptEnv() {
 		env = append(env, key+"="+value)
 	}
@@ -278,6 +281,7 @@ func provisionEnv(
 		// The idea behind using TF_LOG=JSON instead of TF_LOG=debug is ensuring the proper log format.
 		env = append(env, "TF_LOG=JSON")
 	}
+
 	return env, nil
 }
 
diff --git a/provisionerd/provisionerd.go b/provisionerd/provisionerd.go
@@ -355,6 +355,7 @@ func (p *Server) acquireAndRunOne(client proto.DRPCProvisionerDaemonClient) {
 			slog.F("workspace_build_id", build.WorkspaceBuildId),
 			slog.F("workspace_id", build.Metadata.WorkspaceId),
 			slog.F("workspace_name", build.WorkspaceName),
+			slog.F("is_prebuild", build.Metadata.IsPrebuild),
 		)
 
 		span.SetAttributes(
@@ -364,6 +365,7 @@ func (p *Server) acquireAndRunOne(client proto.DRPCProvisionerDaemonClient) {
 			attribute.String("workspace_owner_id", build.Metadata.WorkspaceOwnerId),
 			attribute.String("workspace_owner", build.Metadata.WorkspaceOwner),
 			attribute.String("workspace_transition", build.Metadata.WorkspaceTransition.String()),
+			attribute.Bool("is_prebuild", build.Metadata.IsPrebuild),
 		)
 	}
 
diff --git a/provisionersdk/proto/provisioner.proto b/provisionersdk/proto/provisioner.proto
@@ -275,6 +275,7 @@ message Metadata {
     string workspace_owner_ssh_private_key = 16;
     string workspace_build_id = 17;
     string workspace_owner_login_type =  18;
+    bool   is_prebuild = 19;
 }
 
 // Config represents execution configuration shared by all subsequent requests in the Session
diff --git a/site/e2e/provisionerGenerated.ts b/site/e2e/provisionerGenerated.ts

Original file line number	Diff line number	Diff line change
`@@ -262,6 +262,9 @@ func provisionEnv(`
`262`	`262`	`"CODER_WORKSPACE_TEMPLATE_VERSION="+metadata.GetTemplateVersion(),`
`263`	`263`	`"CODER_WORKSPACE_BUILD_ID="+metadata.GetWorkspaceBuildId(),`
`264`	`264`	`)`
	`265`	`+ if metadata.GetIsPrebuild() {`
	`266`	`+ env = append(env, "CODER_WORKSPACE_IS_PREBUILD=true")`
	`267`	`+ }`
`265`	`268`	`for key, value := range provisionersdk.AgentScriptEnv() {`
`266`	`269`	`env = append(env, key+"="+value)`
`267`	`270`	`}`
`@@ -278,6 +281,7 @@ func provisionEnv(`
`278`	`281`	`// The idea behind using TF_LOG=JSON instead of TF_LOG=debug is ensuring the proper log format.`
`279`	`282`	`env = append(env, "TF_LOG=JSON")`
`280`	`283`	`}`
	`284`	`+`
`281`	`285`	`return env, nil`
`282`	`286`	`}`
`283`	`287`
Original file line number	Diff line number	Diff line change
`@@ -355,6 +355,7 @@ func (p *Server) acquireAndRunOne(client proto.DRPCProvisionerDaemonClient) {`
`355`	`355`	`slog.F("workspace_build_id", build.WorkspaceBuildId),`
`356`	`356`	`slog.F("workspace_id", build.Metadata.WorkspaceId),`
`357`	`357`	`slog.F("workspace_name", build.WorkspaceName),`
	`358`	`+ slog.F("is_prebuild", build.Metadata.IsPrebuild),`
`358`	`359`	`)`
`359`	`360`
`360`	`361`	`span.SetAttributes(`
`@@ -364,6 +365,7 @@ func (p *Server) acquireAndRunOne(client proto.DRPCProvisionerDaemonClient) {`
`364`	`365`	`attribute.String("workspace_owner_id", build.Metadata.WorkspaceOwnerId),`
`365`	`366`	`attribute.String("workspace_owner", build.Metadata.WorkspaceOwner),`
`366`	`367`	`attribute.String("workspace_transition", build.Metadata.WorkspaceTransition.String()),`
	`368`	`+ attribute.Bool("is_prebuild", build.Metadata.IsPrebuild),`
`367`	`369`	`)`
`368`	`370`	`}`
`369`	`371`
Original file line number	Diff line number	Diff line change
`@@ -275,6 +275,7 @@ message Metadata {`
`275`	`275`	`string workspace_owner_ssh_private_key = 16;`
`276`	`276`	`string workspace_build_id = 17;`
`277`	`277`	`string workspace_owner_login_type = 18;`
	`278`	`+ bool is_prebuild = 19;`
`278`	`279`	`}`
`279`	`280`
`280`	`281`	`// Config represents execution configuration shared by all subsequent requests in the Session`