feat: persist generated coder_app id (#18487)

dannykopping · web-flow · commit 66e8dbbe175c · 2025-06-23T08:46:18.000Z
diff --git a/coderd/agentapi/apps.go b/coderd/agentapi/apps.go
@@ -92,7 +92,7 @@ func (a *AppsAPI) BatchUpdateAppHealths(ctx context.Context, req *agentproto.Bat
 			Health: app.Health,
 		})
 		if err != nil {
-			return nil, xerrors.Errorf("update workspace app health for app %q (%q): %w", err, app.ID, app.Slug)
+			return nil, xerrors.Errorf("update workspace app health for app %q (%q): %w", app.ID, app.Slug, err)
 		}
 	}
 
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -2595,8 +2595,19 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 				openIn = database.WorkspaceAppOpenInSlimWindow
 			}
 
+			var appID string
+			if app.Id == "" || app.Id == uuid.Nil.String() {
+				appID = uuid.NewString()
+			} else {
+				appID = app.Id
+			}
+			id, err := uuid.Parse(appID)
+			if err != nil {
+				return xerrors.Errorf("parse app uuid: %w", err)
+			}
+
 			dbApp, err := db.InsertWorkspaceApp(ctx, database.InsertWorkspaceAppParams{
-				ID:          uuid.New(),
+				ID:          id,
 				CreatedAt:   dbtime.Now(),
 				AgentID:     dbAgent.ID,
 				Slug:        slug,
diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/awalterschulze/gographviz"
+	"github.com/google/uuid"
 	tfjson "github.com/hashicorp/terraform-json"
 	"github.com/mitchellh/mapstructure"
 	"golang.org/x/xerrors"
@@ -93,6 +94,7 @@ type agentDisplayAppsAttributes struct {
 
 // A mapping of attributes on the "coder_app" resource.
 type agentAppAttributes struct {
+	ID      string `mapstructure:"id"`
 	AgentID string `mapstructure:"agent_id"`
 	// Slug is required in terraform, but to avoid breaking existing users we
 	// will default to the resource name if it is not specified.
@@ -522,7 +524,17 @@ func ConvertState(ctx context.Context, modules []*tfjson.StateModule, rawGraph s
 						continue
 					}
 
+					id := attrs.ID
+					if id == "" {
+						// This should never happen since the "id" attribute is set on creation:
+						// https://github.com/coder/terraform-provider-coder/blob/cfa101df4635e405e66094fa7779f9a89d92f400/provider/app.go#L37
+						logger.Warn(ctx, "coder_app's id was unexpectedly empty", slog.F("name", attrs.Name))
+
+						id = uuid.NewString()
+					}
+
 					agent.Apps = append(agent.Apps, &proto.App{
+						Id:           id,
 						Slug:         attrs.Slug,
 						DisplayName:  attrs.DisplayName,
 						Command:      attrs.Command,
diff --git a/provisioner/terraform/resources_test.go b/provisioner/terraform/resources_test.go
@@ -967,6 +967,9 @@ func TestConvertResources(t *testing.T) {
 						if agent.GetInstanceId() != "" {
 							agent.Auth = &proto.Agent_InstanceId{}
 						}
+						for _, app := range agent.Apps {
+							app.Id = ""
+						}
 					}
 				}
 
@@ -1037,6 +1040,9 @@ func TestConvertResources(t *testing.T) {
 						if agent.GetInstanceId() != "" {
 							agent.Auth = &proto.Agent_InstanceId{}
 						}
+						for _, app := range agent.Apps {
+							app.Id = ""
+						}
 					}
 				}
 				// Convert expectedNoMetadata and resources into a
diff --git a/provisionerd/proto/version.go b/provisionerd/proto/version.go
@@ -37,6 +37,7 @@ import "github.com/coder/coder/v2/apiversion"
 //   - Add new field named `scheduling` to `Prebuild`, with fields for timezone
 //     and schedule rules to define cron-based scaling of prebuilt workspace
 //     instances based on time patterns.
+//   - Added new field named `id` to `App`, which transports the ID generated by the coder_app provider to be persisted.
 const (
 	CurrentMajor = 1
 	CurrentMinor = 7
diff --git a/provisionersdk/proto/provisioner.pb.go b/provisionersdk/proto/provisioner.pb.go
diff --git a/provisionersdk/proto/provisioner.proto b/provisionersdk/proto/provisioner.proto
@@ -266,6 +266,7 @@ message App {
   bool hidden = 11;
   AppOpenIn open_in = 12;
   string group = 13;
+  string id = 14; // If nil, new UUID will be generated.
 }
 
 // Healthcheck represents configuration for checking for app readiness.
diff --git a/site/e2e/provisionerGenerated.ts b/site/e2e/provisionerGenerated.ts
diff --git a/site/e2e/tests/app.spec.ts b/site/e2e/tests/app.spec.ts
@@ -42,6 +42,7 @@ test("app", async ({ context, page }) => {
 									token,
 									apps: [
 										{
+											id: randomUUID(),
 											url: `http://localhost:${addr.port}`,
 											displayName: appName,
 											order: 0,

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ func (a AppsAPI) BatchUpdateAppHealths(ctx context.Context, req agentproto.Bat`
`92`	`92`	`Health: app.Health,`
`93`	`93`	`})`
`94`	`94`	`if err != nil {`
`95`		`- return nil, xerrors.Errorf("update workspace app health for app %q (%q): %w", err, app.ID, app.Slug)`
	`95`	`+ return nil, xerrors.Errorf("update workspace app health for app %q (%q): %w", app.ID, app.Slug, err)`
`96`	`96`	`}`
`97`	`97`	`}`
`98`	`98`
Original file line number	Diff line number	Diff line change
`@@ -967,6 +967,9 @@ func TestConvertResources(t *testing.T) {`
`967`	`967`	`if agent.GetInstanceId() != "" {`
`968`	`968`	`agent.Auth = &proto.Agent_InstanceId{}`
`969`	`969`	`}`
	`970`	`+ for _, app := range agent.Apps {`
	`971`	`+ app.Id = ""`
	`972`	`+ }`
`970`	`973`	`}`
`971`	`974`	`}`
`972`	`975`
`@@ -1037,6 +1040,9 @@ func TestConvertResources(t *testing.T) {`
`1037`	`1040`	`if agent.GetInstanceId() != "" {`
`1038`	`1041`	`agent.Auth = &proto.Agent_InstanceId{}`
`1039`	`1042`	`}`
	`1043`	`+ for _, app := range agent.Apps {`
	`1044`	`+ app.Id = ""`
	`1045`	`+ }`
`1040`	`1046`	`}`
`1041`	`1047`	`}`
`1042`	`1048`	`// Convert expectedNoMetadata and resources into a`
Original file line number	Diff line number	Diff line change
`@@ -266,6 +266,7 @@ message App {`
`266`	`266`	`bool hidden = 11;`
`267`	`267`	`AppOpenIn open_in = 12;`
`268`	`268`	`string group = 13;`
	`269`	`+ string id = 14; // If nil, new UUID will be generated.`
`269`	`270`	`}`
`270`	`271`
`271`	`272`	`// Healthcheck represents configuration for checking for app readiness.`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ test("app", async ({ context, page }) => {`
`42`	`42`	`token,`
`43`	`43`	`apps: [`
`44`	`44`	`{`
	`45`	`+ id: randomUUID(),`
`45`	`46`	url: `http://localhost:${addr.port}`,
`46`	`47`	`displayName: appName,`
`47`	`48`	`order: 0,`