fix: VSCode desktop connection (#7120)

matifali · mafredri · web-flow · commit bb43713d38f3 · 2023-04-14T17:32:18.000+03:00
Co-authored-by: Mathias Fredriksson &lt;mafredri@gmail.com&gt;
diff --git a/agent/agent.go b/agent/agent.go
@@ -1407,5 +1407,14 @@ func expandDirectory(dir string) (string, error) {
 		}
 		dir = filepath.Join(home, dir[1:])
 	}
-	return os.ExpandEnv(dir), nil
+	dir = os.ExpandEnv(dir)
+
+	if !filepath.IsAbs(dir) {
+		home, err := userHomeDir()
+		if err != nil {
+			return "", err
+		}
+		dir = filepath.Join(home, dir)
+	}
+	return dir, nil
 }
diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -1391,6 +1391,22 @@ func TestAgent_Startup(t *testing.T) {
 		require.Equal(t, homeDir, client.getStartup().ExpandedDirectory)
 	})
 
+	t.Run("NotAbsoluteDirectory", func(t *testing.T) {
+		t.Parallel()
+
+		_, client, _, _, _ := setupAgent(t, agentsdk.Manifest{
+			StartupScript:        "true",
+			StartupScriptTimeout: 30 * time.Second,
+			Directory:            "coder/coder",
+		}, 0)
+		assert.Eventually(t, func() bool {
+			return client.getStartup().Version != ""
+		}, testutil.WaitShort, testutil.IntervalFast)
+		homeDir, err := os.UserHomeDir()
+		require.NoError(t, err)
+		require.Equal(t, filepath.Join(homeDir, "coder/coder"), client.getStartup().ExpandedDirectory)
+	})
+
 	t.Run("HomeEnvironmentVariable", func(t *testing.T) {
 		t.Parallel()
 
diff --git a/docs/templates/open-in-coder.md b/docs/templates/open-in-coder.md
@@ -38,6 +38,12 @@ To support any infrastructure and software stack, Coder provides a generic appro
      }
      ```
 
+     > Note: The `dir` attribute can be set in multiple ways, for example:
+     >
+     > - `~/coder`
+     > - `/home/coder/coder`
+     > - `coder` (relative to the home directory)
+
    - If you want the template to support any repository via [parameters](./parameters.md)
 
      ```hcl

Original file line number	Diff line number	Diff line change
`@@ -1407,5 +1407,14 @@ func expandDirectory(dir string) (string, error) {`
`1407`	`1407`	`}`
`1408`	`1408`	`dir = filepath.Join(home, dir[1:])`
`1409`	`1409`	`}`
`1410`		`- return os.ExpandEnv(dir), nil`
	`1410`	`+ dir = os.ExpandEnv(dir)`
	`1411`	`+`
	`1412`	`+ if !filepath.IsAbs(dir) {`
	`1413`	`+ home, err := userHomeDir()`
	`1414`	`+ if err != nil {`
	`1415`	`+ return "", err`
	`1416`	`+ }`
	`1417`	`+ dir = filepath.Join(home, dir)`
	`1418`	`+ }`
	`1419`	`+ return dir, nil`
`1411`	`1420`	`}`