improve doc on container workspace folder, add todo

mafredri · mafredri · commit 7a3c8a3e64c0 · 2025-06-06T13:18:03.000Z
diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -1010,9 +1010,15 @@ func (api *API) injectSubAgentIntoContainerLocked(ctx context.Context, dc coders
 	// The preparation of the subagent is done, now we can create the
 	// subagent record in the database to receive the auth token.
 	createdAgent, err := api.subAgentClient.Create(ctx, SubAgent{
-		Name:            dc.Name,
-		Directory:       "/workspace", // TODO(mafredri): Use a more appropriate directory.
-		OperatingSystem: "linux",      // Assuming Linux for dev containers.
+		Name: dc.Name,
+		// The default workspaceFolder for devcontainers is /workspaces.
+		// However, it can be changed by setting {"workspaceFolder": "/src"}
+		// in the devcontainer.json. This information is not encoded into
+		// the container labels, so we must rely on the values parsed from
+		// the devcontainer.json file on disk.
+		// TODO(mafredri): Support custom workspace folders in the future.
+		Directory:       DevcontainerDefaultContainerWorkspaceFolder,
+		OperatingSystem: "linux", // Assuming Linux for dev containers.
 		Architecture:    arch,
 	})
 	if err != nil {
diff --git a/agent/agentcontainers/devcontainer.go b/agent/agentcontainers/devcontainer.go
@@ -18,6 +18,8 @@ const (
 	// DevcontainerConfigFileLabel is the label that contains the path to
 	// the devcontainer.json configuration file.
 	DevcontainerConfigFileLabel = "devcontainer.config_file"
+	// The default workspace folder inside the devcontainer.
+	DevcontainerDefaultContainerWorkspaceFolder = "/workspaces"
 )
 
 const devcontainerUpScriptTemplate = `

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@ const (`
`18`	`18`	`// DevcontainerConfigFileLabel is the label that contains the path to`
`19`	`19`	`// the devcontainer.json configuration file.`
`20`	`20`	`DevcontainerConfigFileLabel = "devcontainer.config_file"`
	`21`	`+ // The default workspace folder inside the devcontainer.`
	`22`	`+ DevcontainerDefaultContainerWorkspaceFolder = "/workspaces"`
`21`	`23`	`)`
`22`	`24`
`23`	`25`	const devcontainerUpScriptTemplate = `