coder · DanielleMaywood · Sep 20, 2024 · Sep 20, 2024 · Sep 20, 2024 · Sep 20, 2024
@@ -53,6 +53,7 @@ message WorkspaceAgentScript {
 	bool run_on_stop = 6;
 	bool start_blocks_login = 7;
 	google.protobuf.Duration timeout = 8;
+	string display_name = 9;
 }
 
 message WorkspaceAgentMetadata {

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000256_add_display_name_to_workspace_agent_scripts.down.sql b/coderd/database/migrations/000256_add_display_name_to_workspace_agent_scripts.down.sql
@@ -0,0 +1 @@
+ALTER TABLE workspace_agent_scripts DROP COLUMN display_name;
diff --git a/coderd/database/migrations/000256_add_display_name_to_workspace_agent_scripts.up.sql b/coderd/database/migrations/000256_add_display_name_to_workspace_agent_scripts.up.sql
@@ -0,0 +1,8 @@
+ALTER TABLE workspace_agent_scripts ADD COLUMN display_name text;
+
+UPDATE workspace_agent_scripts
+	SET display_name = workspace_agent_log_sources.display_name
+FROM workspace_agent_log_sources
+	WHERE workspace_agent_scripts.log_source_id = workspace_agent_log_sources.id;
+
+ALTER TABLE workspace_agent_scripts ALTER COLUMN display_name SET NOT NULL;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspacescripts.sql b/coderd/database/queries/workspacescripts.sql
@@ -1,6 +1,6 @@
 -- name: InsertWorkspaceAgentScripts :many
 INSERT INTO
-	workspace_agent_scripts (workspace_agent_id, created_at, log_source_id, log_path, script, cron, start_blocks_login, run_on_start, run_on_stop, timeout_seconds)
+	workspace_agent_scripts (workspace_agent_id, created_at, log_source_id, log_path, script, cron, start_blocks_login, run_on_start, run_on_stop, timeout_seconds, display_name)
 SELECT
 	@workspace_agent_id :: uuid AS workspace_agent_id,
 	@created_at :: timestamptz AS created_at,
@@ -11,7 +11,8 @@ SELECT
 	unnest(@start_blocks_login :: boolean [ ]) AS start_blocks_login,
 	unnest(@run_on_start :: boolean [ ]) AS run_on_start,
 	unnest(@run_on_stop :: boolean [ ]) AS run_on_stop,
-	unnest(@timeout_seconds :: integer [ ]) AS timeout_seconds
+	unnest(@timeout_seconds :: integer [ ]) AS timeout_seconds,
+	unnest(@display_name :: text [ ]) AS display_name
 RETURNING workspace_agent_scripts.*;
 
 -- name: GetWorkspaceAgentScriptsByAgentIDs :many

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -1818,6 +1818,7 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 		logSourceIDs := make([]uuid.UUID, 0, len(prAgent.Scripts))
 		logSourceDisplayNames := make([]string, 0, len(prAgent.Scripts))
 		logSourceIcons := make([]string, 0, len(prAgent.Scripts))
+		scriptDisplayName := make([]string, 0, len(prAgent.Scripts))
 		scriptLogPaths := make([]string, 0, len(prAgent.Scripts))
 		scriptSources := make([]string, 0, len(prAgent.Scripts))
 		scriptCron := make([]string, 0, len(prAgent.Scripts))
@@ -1830,6 +1831,7 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 			logSourceIDs = append(logSourceIDs, uuid.New())
 			logSourceDisplayNames = append(logSourceDisplayNames, script.DisplayName)
 			logSourceIcons = append(logSourceIcons, script.Icon)
+			scriptDisplayName = append(scriptDisplayName, script.DisplayName)
 			scriptLogPaths = append(scriptLogPaths, script.LogPath)
 			scriptSources = append(scriptSources, script.Script)
 			scriptCron = append(scriptCron, script.Cron)
@@ -1861,6 +1863,7 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 			StartBlocksLogin: scriptStartBlocksLogin,
 			RunOnStart:       scriptRunOnStart,
 			RunOnStop:        scriptRunOnStop,
+			DisplayName:      scriptDisplayName,
 		})
 		if err != nil {
 			return xerrors.Errorf("insert agent scripts: %w", err)

diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -977,6 +977,7 @@ func convertScripts(dbScripts []database.WorkspaceAgentScript) []codersdk.Worksp
 			RunOnStop:        dbScript.RunOnStop,
 			StartBlocksLogin: dbScript.StartBlocksLogin,
 			Timeout:          time.Duration(dbScript.TimeoutSeconds) * time.Second,
+			DisplayName:      dbScript.DisplayName,
 		})
 	}
 	return scripts

diff --git a/codersdk/agentsdk/convert.go b/codersdk/agentsdk/convert.go
@@ -172,6 +172,7 @@ func AgentScriptFromProto(protoScript *proto.WorkspaceAgentScript) (codersdk.Wor
 		RunOnStop:        protoScript.RunOnStop,
 		StartBlocksLogin: protoScript.StartBlocksLogin,
 		Timeout:          protoScript.Timeout.AsDuration(),
+		DisplayName:      protoScript.DisplayName,
 	}, nil
 }
 
@@ -185,6 +186,7 @@ func ProtoFromScript(s codersdk.WorkspaceAgentScript) *proto.WorkspaceAgentScrip
 		RunOnStop:        s.RunOnStop,
 		StartBlocksLogin: s.StartBlocksLogin,
 		Timeout:          durationpb.New(s.Timeout),
+		DisplayName:      s.DisplayName,
 	}
 }
 

diff --git a/codersdk/agentsdk/convert_test.go b/codersdk/agentsdk/convert_test.go
@@ -114,6 +114,7 @@ func TestManifest(t *testing.T) {
 				RunOnStop:        true,
 				StartBlocksLogin: true,
 				Timeout:          time.Second,
+				DisplayName:      "foo",
 			},
 			{
 				LogSourceID:      uuid.New(),
@@ -124,6 +125,7 @@ func TestManifest(t *testing.T) {
 				RunOnStop:        true,
 				StartBlocksLogin: true,
 				Timeout:          time.Second * 4,
+				DisplayName:      "bar",
 			},
 		},
 	}

diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -193,6 +193,7 @@ type WorkspaceAgentScript struct {
 	RunOnStop        bool          `json:"run_on_stop"`
 	StartBlocksLogin bool          `json:"start_blocks_login"`
 	Timeout          time.Duration `json:"timeout"`
+	DisplayName      string        `json:"display_name"`
 }
 
 type WorkspaceAgentHealth struct {

diff --git a/docs/reference/api/agents.md b/docs/reference/api/agents.md
diff --git a/docs/reference/api/builds.md b/docs/reference/api/builds.md
diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE workspace_agent_scripts DROP COLUMN display_name;