feat: add agent devcontainers from provision

coder · mafredri · Mar 20, 2025 · Mar 19, 2025 · Mar 19, 2025 · Mar 19, 2025
commit 76bf36bceaeb79dc2edbe83723ca9e0ad973d980
diff --git a/coderd/database/migrations/000302_add_workspace_agent_devcontainers.down.sql b/coderd/database/migrations/000302_add_workspace_agent_devcontainers.down.sql
@@ -0,0 +1 @@
+DROP TABLE workspace_agent_devcontainers;
diff --git a/coderd/database/migrations/000302_add_workspace_agent_devcontainers.up.sql b/coderd/database/migrations/000302_add_workspace_agent_devcontainers.up.sql
@@ -0,0 +1,15 @@
+CREATE TABLE workspace_agent_devcontainers (
+	id UUID PRIMARY KEY,
+	workspace_agent_id UUID NOT NULL,
+	created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
+	workspace_folder TEXT NOT NULL,
+	config_path TEXT NOT NULL,
+	FOREIGN KEY (workspace_agent_id) REFERENCES workspace_agents(id) ON DELETE CASCADE
+);
+
+COMMENT ON TABLE workspace_agent_devcontainers IS 'Workspace agent devcontainer configuration';
+COMMENT ON COLUMN workspace_agent_devcontainers.id IS 'Unique identifier';
+COMMENT ON COLUMN workspace_agent_devcontainers.workspace_agent_id IS 'Workspace agent foreign key';
+COMMENT ON COLUMN workspace_agent_devcontainers.created_at IS 'Creation timestamp';
+COMMENT ON COLUMN workspace_agent_devcontainers.workspace_folder IS 'Workspace folder';
+COMMENT ON COLUMN workspace_agent_devcontainers.config_path IS 'Path to devcontainer.json.';
diff --git a/coderd/database/queries/workspaceagentdevcontainers.sql b/coderd/database/queries/workspaceagentdevcontainers.sql
@@ -0,0 +1,10 @@
+-- name: InsertWorkspaceAgentDevcontainers :many
+INSERT INTO
+	workspace_agent_devcontainers (workspace_agent_id, created_at, id, 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(@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
@@ -2096,6 +2096,30 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 			return xerrors.Errorf("insert agent scripts: %w", err)
 		}
 
+		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))
+			)
+			for _, dc := range devcontainers {
+				devContainerIDs = append(devContainerIDs, uuid.New())
+				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,
+			})
+			if err != nil {
+				return xerrors.Errorf("insert agent devcontainer: %w", err)
+			}
+		}
+
 		for _, app := range prAgent.Apps {
 			// Similar logic is duplicated in terraform/resources.go.
 			slug := app.Slug

diff --git a/codersdk/agentsdk/agentsdk.go b/codersdk/agentsdk/agentsdk.go
@@ -121,6 +121,7 @@ type Manifest struct {
 	DisableDirectConnections bool                                         `json:"disable_direct_connections"`
 	Metadata                 []codersdk.WorkspaceAgentMetadataDescription `json:"metadata"`
 	Scripts                  []codersdk.WorkspaceAgentScript              `json:"scripts"`
+	Devcontainers            []codersdk.WorkspaceAgentDevcontainer        `json:"devcontainers"`
 }
 
 type LogSource struct {

diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -392,6 +392,14 @@ func (c *Client) WorkspaceAgentListeningPorts(ctx context.Context, agentID uuid.
 	return listeningPorts, json.NewDecoder(res.Body).Decode(&listeningPorts)
 }
 
+// WorkspaceAgentDevcontainer defines the location of a devcontainer
+// configuration in a workspace that is visible to the workspace agent.
+type WorkspaceAgentDevcontainer struct {
+	ID              uuid.UUID `json:"id" format:"uuid"`
+	WorkspaceFolder string    `json:"workspace_folder"`
+	ConfigPath      string    `json:"config_path,omitempty"`
+}
+
 // WorkspaceAgentContainer describes a devcontainer of some sort
 // that is visible to the workspace agent. This struct is an abstraction
 // of potentially multiple implementations, and the fields will be

diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -57,6 +57,12 @@ type agentAttributes struct {
 	DisplayApps              []agentDisplayAppsAttributes `mapstructure:"display_apps"`
 	Order                    int64                        `mapstructure:"order"`
 	ResourcesMonitoring      []agentResourcesMonitoring   `mapstructure:"resources_monitoring"`
+	Devcontainers            []agentDevcontainer          `mapstructure:"devcontainers"`
+}
+
+type agentDevcontainer struct {
+	WorkspaceFolder string `mapstructure:"workspace_folder"`
+	ConfigPath      string `mapstructure:"config_path"`
 }
 
 type agentResourcesMonitoring struct {
@@ -347,6 +353,13 @@ func ConvertState(ctx context.Context, modules []*tfjson.StateModule, rawGraph s
 				agent.Auth = &proto.Agent_InstanceId{}
 			}
 
+			for _, devcontainer := range attrs.Devcontainers {
+				agent.Devcontainers = append(agent.Devcontainers, &proto.Devcontainer{
+					WorkspaceFolder: devcontainer.WorkspaceFolder,
+					ConfigPath:      devcontainer.ConfigPath,
+				})
+			}
+
 			// The label is used to find the graph node!
 			agentLabel := convertAddressToLabel(tfResource.Address)
 

@@ -141,6 +141,7 @@ message Agent {
 	repeated Env extra_envs = 22;
 	int64 order = 23;
 	ResourcesMonitoring resources_monitoring = 24;
+	repeated Devcontainer devcontainers = 25;
 }
 
 enum AppSharingLevel {
@@ -191,6 +192,11 @@ message Script {
 	string log_path = 9;
 }
 
+message Devcontainer {
+	string workspace_folder = 1;
+	string config_path = 2;
+}
+
 enum AppOpenIn {
     WINDOW = 0 [deprecated = true];
     SLIM_WINDOW = 1;