improve logger, fix config path realtive to workspace folder

mafredri · mafredri · commit 3e0c2a006534 · 2025-03-26T16:36:16.000Z
diff --git a/agent/agentcontainers/devcontainer.go b/agent/agentcontainers/devcontainer.go
@@ -3,6 +3,8 @@ package agentcontainers
 import (
 	"context"
 	"fmt"
+	"os"
+	"path/filepath"
 	"strings"
 
 	"cdr.dev/slog"
@@ -64,17 +66,33 @@ func devcontainerStartupScript(dc codersdk.WorkspaceAgentDevcontainer, script co
 }
 
 func expandDevcontainerPaths(logger slog.Logger, expandPath func(string) (string, error), dc codersdk.WorkspaceAgentDevcontainer) codersdk.WorkspaceAgentDevcontainer {
+	logger = logger.With(slog.F("workspace_folder", dc.WorkspaceFolder), slog.F("config_path", dc.ConfigPath))
+
 	if wf, err := expandPath(dc.WorkspaceFolder); err != nil {
 		logger.Warn(context.Background(), "expand devcontainer workspace folder failed", slog.Error(err))
 	} else {
 		dc.WorkspaceFolder = wf
 	}
 	if dc.ConfigPath != "" {
-		if cp, err := expandPath(dc.ConfigPath); err != nil {
-			logger.Warn(context.Background(), "expand devcontainer config path failed", slog.Error(err))
+		// Let expandPath handle home directory, otherwise assume relative to
+		// workspace folder or absoulte.
+		if dc.ConfigPath[0] == '~' {
+			if cp, err := expandPath(dc.ConfigPath); err != nil {
+				logger.Warn(context.Background(), "expand devcontainer config path failed", slog.Error(err))
+			} else {
+				dc.ConfigPath = cp
+			}
 		} else {
-			dc.ConfigPath = cp
+			dc.ConfigPath = relativePathToAbs(dc.WorkspaceFolder, dc.ConfigPath)
 		}
 	}
 	return dc
 }
+
+func relativePathToAbs(workdir, path string) string {
+	path = os.ExpandEnv(path)
+	if !filepath.IsAbs(path) {
+		path = filepath.Join(workdir, path)
+	}
+	return path
+}
diff --git a/agent/agentcontainers/devcontainer_test.go b/agent/agentcontainers/devcontainer_test.go
@@ -1,6 +1,7 @@
 package agentcontainers_test
 
 import (
+	"path/filepath"
 	"strings"
 	"testing"
 
@@ -133,12 +134,12 @@ func TestExtractAndInitializeDevcontainerScripts(t *testing.T) {
 			wantDevcontainerScripts: []codersdk.WorkspaceAgentScript{
 				{
 					ID:         devcontainerIDs[0],
-					Script:     "devcontainer up --workspace-folder \"workspace1\" --config \"config1\"",
+					Script:     "devcontainer up --workspace-folder \"workspace1\" --config \"workspace1/config1\"",
 					RunOnStart: false,
 				},
 				{
 					ID:         devcontainerIDs[1],
-					Script:     "devcontainer up --workspace-folder \"workspace2\" --config \"config2\"",
+					Script:     "devcontainer up --workspace-folder \"workspace2\" --config \"workspace2/config2\"",
 					RunOnStart: false,
 				},
 			},
@@ -147,7 +148,7 @@ func TestExtractAndInitializeDevcontainerScripts(t *testing.T) {
 			name: "scripts match devcontainers with expand path",
 			args: args{
 				expandPath: func(s string) (string, error) {
-					return "expanded/" + s, nil
+					return "/home/" + s, nil
 				},
 				devcontainers: []codersdk.WorkspaceAgentDevcontainer{
 					{
@@ -170,12 +171,53 @@ func TestExtractAndInitializeDevcontainerScripts(t *testing.T) {
 			wantDevcontainerScripts: []codersdk.WorkspaceAgentScript{
 				{
 					ID:         devcontainerIDs[0],
-					Script:     "devcontainer up --workspace-folder \"expanded/workspace1\" --config \"expanded/config1\"",
+					Script:     "devcontainer up --workspace-folder \"/home/workspace1\" --config \"/home/workspace1/config1\"",
 					RunOnStart: false,
 				},
 				{
 					ID:         devcontainerIDs[1],
-					Script:     "devcontainer up --workspace-folder \"expanded/workspace2\" --config \"expanded/config2\"",
+					Script:     "devcontainer up --workspace-folder \"/home/workspace2\" --config \"/home/workspace2/config2\"",
+					RunOnStart: false,
+				},
+			},
+		},
+		{
+			name: "expand config path when ~",
+			args: args{
+				expandPath: func(s string) (string, error) {
+					s = strings.Replace(s, "~/", "", 1)
+					if filepath.IsAbs(s) {
+						return s, nil
+					}
+					return "/home/" + s, nil
+				},
+				devcontainers: []codersdk.WorkspaceAgentDevcontainer{
+					{
+						ID:              devcontainerIDs[0],
+						WorkspaceFolder: "workspace1",
+						ConfigPath:      "~/config1",
+					},
+					{
+						ID:              devcontainerIDs[1],
+						WorkspaceFolder: "workspace2",
+						ConfigPath:      "/config2",
+					},
+				},
+				scripts: []codersdk.WorkspaceAgentScript{
+					{ID: devcontainerIDs[0], RunOnStart: true},
+					{ID: devcontainerIDs[1], RunOnStart: true},
+				},
+			},
+			wantFilteredScripts: []codersdk.WorkspaceAgentScript{},
+			wantDevcontainerScripts: []codersdk.WorkspaceAgentScript{
+				{
+					ID:         devcontainerIDs[0],
+					Script:     "devcontainer up --workspace-folder \"/home/workspace1\" --config \"/home/config1\"",
+					RunOnStart: false,
+				},
+				{
+					ID:         devcontainerIDs[1],
+					Script:     "devcontainer up --workspace-folder \"/home/workspace2\" --config \"/config2\"",
 					RunOnStart: false,
 				},
 			},
