coder · mafredri · Mar 25, 2025 · Mar 25, 2025 · Mar 25, 2025
@@ -102,6 +102,7 @@ message WorkspaceAgentDevcontainer {
 	bytes id = 1;
 	string workspace_folder = 2;
 	string config_path = 3;
+	string name = 4;
 }
 
 message GetManifestRequest {}

diff --git a/coderd/agentapi/manifest.go b/coderd/agentapi/manifest.go
@@ -244,6 +244,7 @@ func dbAgentDevcontainersToProto(devcontainers []database.WorkspaceAgentDevconta
 	for i, dc := range devcontainers {
 		ret[i] = &agentproto.WorkspaceAgentDevcontainer{
 			Id:              dc.ID[:],
+			Name:            dc.Name,
 			WorkspaceFolder: dc.WorkspaceFolder,
 			ConfigPath:      dc.ConfigPath,
 		}

diff --git a/coderd/agentapi/manifest_test.go b/coderd/agentapi/manifest_test.go
@@ -159,11 +159,13 @@ func TestGetManifest(t *testing.T) {
 		devcontainers = []database.WorkspaceAgentDevcontainer{
 			{
 				ID:               uuid.New(),
+				Name:             "cool",
 				WorkspaceAgentID: agent.ID,
 				WorkspaceFolder:  "/cool/folder",
 			},
 			{
 				ID:               uuid.New(),
+				Name:             "another",
 				WorkspaceAgentID: agent.ID,
 				WorkspaceFolder:  "/another/cool/folder",
 				ConfigPath:       "/another/cool/folder/.devcontainer/devcontainer.json",
@@ -283,10 +285,12 @@ func TestGetManifest(t *testing.T) {
 		protoDevcontainers = []*agentproto.WorkspaceAgentDevcontainer{
 			{
 				Id:              devcontainers[0].ID[:],
+				Name:            devcontainers[0].Name,
 				WorkspaceFolder: devcontainers[0].WorkspaceFolder,
 			},
 			{
 				Id:              devcontainers[1].ID[:],
+				Name:            devcontainers[1].Name,
 				WorkspaceFolder: devcontainers[1].WorkspaceFolder,
 				ConfigPath:      devcontainers[1].ConfigPath,
 			},

diff --git a/coderd/database/dbgen/dbgen.go b/coderd/database/dbgen/dbgen.go
@@ -260,6 +260,7 @@ func WorkspaceAgentDevcontainer(t testing.TB, db database.Store, orig database.W
 		WorkspaceAgentID: takeFirst(orig.WorkspaceAgentID, uuid.New()),
 		CreatedAt:        takeFirst(orig.CreatedAt, dbtime.Now()),
 		ID:               []uuid.UUID{takeFirst(orig.ID, uuid.New())},
+		Name:             []string{takeFirst(orig.Name, testutil.GetRandomName(t))},
 		WorkspaceFolder:  []string{takeFirst(orig.WorkspaceFolder, "/workspace")},
 		ConfigPath:       []string{takeFirst(orig.ConfigPath, "")},
 	})

diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -9171,6 +9171,7 @@ func (q *FakeQuerier) InsertWorkspaceAgentDevcontainers(_ context.Context, arg d
 					WorkspaceAgentID: arg.WorkspaceAgentID,
 					CreatedAt:        arg.CreatedAt,
 					ID:               id,
+					Name:             arg.Name[i],
 					WorkspaceFolder:  arg.WorkspaceFolder[i],
 					ConfigPath:       arg.ConfigPath[i],
 				})

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000309_add_devcontainer_name.down.sql b/coderd/database/migrations/000309_add_devcontainer_name.down.sql
@@ -0,0 +1 @@
+ALTER TABLE workspace_agent_devcontainers DROP COLUMN name;
diff --git a/coderd/database/migrations/000309_add_devcontainer_name.up.sql b/coderd/database/migrations/000309_add_devcontainer_name.up.sql
@@ -0,0 +1,4 @@
+ALTER TABLE workspace_agent_devcontainers ADD COLUMN name TEXT NOT NULL DEFAULT '';
+ALTER TABLE workspace_agent_devcontainers ALTER COLUMN name DROP DEFAULT;
+
+COMMENT ON COLUMN workspace_agent_devcontainers.name IS 'The name of the Dev Container.';
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/workspaceagentdevcontainers.sql b/coderd/database/queries/workspaceagentdevcontainers.sql
@@ -1,10 +1,11 @@
 -- name: InsertWorkspaceAgentDevcontainers :many
 INSERT INTO
-	workspace_agent_devcontainers (workspace_agent_id, created_at, id, workspace_folder, config_path)
+	workspace_agent_devcontainers (workspace_agent_id, created_at, id, name, workspace_folder, config_path)
 SELECT
 	@workspace_agent_id::uuid AS workspace_agent_id,
 	@created_at::timestamptz AS created_at,
 	unnest(@id::uuid[]) AS id,
+	unnest(@name::text[]) AS name,
 	unnest(@workspace_folder::text[]) AS workspace_folder,
 	unnest(@config_path::text[]) AS config_path
 RETURNING workspace_agent_devcontainers.*;

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -2110,22 +2110,25 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 
 		if devcontainers := prAgent.GetDevcontainers(); len(devcontainers) > 0 {
 			var (
-				devContainerIDs              = make([]uuid.UUID, 0, len(devcontainers))
-				devContainerWorkspaceFolders = make([]string, 0, len(devcontainers))
-				devContainerConfigPaths      = make([]string, 0, len(devcontainers))
+				devcontainerIDs              = make([]uuid.UUID, 0, len(devcontainers))
+				devcontainerNames            = make([]string, 0, len(devcontainers))
+				devcontainerWorkspaceFolders = make([]string, 0, len(devcontainers))
+				devcontainerConfigPaths      = make([]string, 0, len(devcontainers))
 			)
 			for _, dc := range devcontainers {
-				devContainerIDs = append(devContainerIDs, uuid.New())
-				devContainerWorkspaceFolders = append(devContainerWorkspaceFolders, dc.WorkspaceFolder)
-				devContainerConfigPaths = append(devContainerConfigPaths, dc.ConfigPath)
+				devcontainerIDs = append(devcontainerIDs, uuid.New())
+				devcontainerNames = append(devcontainerNames, dc.Name)
+				devcontainerWorkspaceFolders = append(devcontainerWorkspaceFolders, dc.WorkspaceFolder)
+				devcontainerConfigPaths = append(devcontainerConfigPaths, dc.ConfigPath)
 			}
 
 			_, err = db.InsertWorkspaceAgentDevcontainers(ctx, database.InsertWorkspaceAgentDevcontainersParams{
 				WorkspaceAgentID: agentID,
 				CreatedAt:        dbtime.Now(),
-				ID:               devContainerIDs,
-				WorkspaceFolder:  devContainerWorkspaceFolders,
-				ConfigPath:       devContainerConfigPaths,
+				ID:               devcontainerIDs,
+				Name:             devcontainerNames,
+				WorkspaceFolder:  devcontainerWorkspaceFolders,
+				ConfigPath:       devcontainerConfigPaths,
 			})
 			if err != nil {
 				return xerrors.Errorf("insert agent devcontainer: %w", err)

diff --git a/coderd/provisionerdserver/provisionerdserver_test.go b/coderd/provisionerdserver/provisionerdserver_test.go
@@ -2204,8 +2204,8 @@ func TestInsertWorkspaceResource(t *testing.T) {
 			Agents: []*sdkproto.Agent{{
 				Name: "dev",
 				Devcontainers: []*sdkproto.Devcontainer{
-					{WorkspaceFolder: "/workspace1"},
-					{WorkspaceFolder: "/workspace2", ConfigPath: "/workspace2/.devcontainer/devcontainer.json"},
+					{Name: "foo", WorkspaceFolder: "/workspace1"},
+					{Name: "bar", WorkspaceFolder: "/workspace2", ConfigPath: "/workspace2/.devcontainer/devcontainer.json"},
 				},
 			}},
 		})
@@ -2220,7 +2220,10 @@ func TestInsertWorkspaceResource(t *testing.T) {
 		devcontainers, err := db.GetWorkspaceAgentDevcontainersByAgentID(ctx, agent.ID)
 		require.NoError(t, err)
 		require.Len(t, devcontainers, 2)
+		require.Equal(t, "foo", devcontainers[0].Name)
 		require.Equal(t, "/workspace1", devcontainers[0].WorkspaceFolder)
+		require.Equal(t, "", devcontainers[0].ConfigPath)
+		require.Equal(t, "bar", devcontainers[1].Name)
 		require.Equal(t, "/workspace2", devcontainers[1].WorkspaceFolder)
 		require.Equal(t, "/workspace2/.devcontainer/devcontainer.json", devcontainers[1].ConfigPath)
 	})

diff --git a/codersdk/agentsdk/convert.go b/codersdk/agentsdk/convert.go
@@ -450,6 +450,7 @@ func DevcontainerFromProto(pdc *proto.WorkspaceAgentDevcontainer) (codersdk.Work
 	}
 	return codersdk.WorkspaceAgentDevcontainer{
 		ID:              id,
+		Name:            pdc.Name,
 		WorkspaceFolder: pdc.WorkspaceFolder,
 		ConfigPath:      pdc.ConfigPath,
 	}, nil
@@ -466,6 +467,7 @@ func ProtoFromDevcontainers(dcs []codersdk.WorkspaceAgentDevcontainer) []*proto.
 func ProtoFromDevcontainer(dc codersdk.WorkspaceAgentDevcontainer) *proto.WorkspaceAgentDevcontainer {
 	return &proto.WorkspaceAgentDevcontainer{
 		Id:              dc.ID[:],
+		Name:            dc.Name,
 		WorkspaceFolder: dc.WorkspaceFolder,
 		ConfigPath:      dc.ConfigPath,
 	}

diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -396,6 +396,7 @@ func (c *Client) WorkspaceAgentListeningPorts(ctx context.Context, agentID uuid.
 // configuration in a workspace that is visible to the workspace agent.
 type WorkspaceAgentDevcontainer struct {
 	ID              uuid.UUID `json:"id" format:"uuid"`
+	Name            string    `json:"name"`
 	WorkspaceFolder string    `json:"workspace_folder"`
 	ConfigPath      string    `json:"config_path,omitempty"`
 }

diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -614,6 +614,7 @@ func ConvertState(ctx context.Context, modules []*tfjson.StateModule, rawGraph s
 						continue
 					}
 					agent.Devcontainers = append(agent.Devcontainers, &proto.Devcontainer{
+						Name:            resource.Name,
 						WorkspaceFolder: attrs.WorkspaceFolder,
 						ConfigPath:      attrs.ConfigPath,
 					})

diff --git a/provisioner/terraform/resources_test.go b/provisioner/terraform/resources_test.go
@@ -845,9 +845,11 @@ func TestConvertResources(t *testing.T) {
 						ResourcesMonitoring:      &proto.ResourcesMonitoring{},
 						Devcontainers: []*proto.Devcontainer{
 							{
+								Name:            "dev1",
 								WorkspaceFolder: "/workspace1",
 							},
 							{
+								Name:            "dev2",
 								WorkspaceFolder: "/workspace2",
 								ConfigPath:      "/workspace2/.devcontainer/devcontainer.json",
 							},
@@ -1404,7 +1406,7 @@ func sortResources(resources []*proto.Resource) {
 				return agent.Scripts[i].DisplayName < agent.Scripts[j].DisplayName
 			})
 			sort.Slice(agent.Devcontainers, func(i, j int) bool {
-				return agent.Devcontainers[i].WorkspaceFolder < agent.Devcontainers[j].WorkspaceFolder
+				return agent.Devcontainers[i].Name < agent.Devcontainers[j].Name
 			})
 		}
 		sort.Slice(resource.Agents, func(i, j int) bool {
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE workspace_agent_devcontainers DROP COLUMN name;