windows multi-drive, add absolutepath

ethanndickson · ethanndickson · commit 69443ce39162 · 2025-02-28T05:46:21.000Z
diff --git a/agent/ls.go b/agent/ls.go
@@ -6,7 +6,9 @@ import (
 	"os"
 	"path/filepath"
 	"runtime"
+	"strings"
 
+	"github.com/shirou/gopsutil/v3/disk"
 	"golang.org/x/xerrors"
 
 	"github.com/coder/coder/v2/coderd/httpapi"
@@ -26,11 +28,11 @@ func (*agent) HandleLS(rw http.ResponseWriter, r *http.Request) {
 		switch {
 		case errors.Is(err, os.ErrNotExist):
 			httpapi.Write(ctx, rw, http.StatusNotFound, codersdk.Response{
-				Message: "Directory does not exist",
+				Message: err.Error(),
 			})
 		case errors.Is(err, os.ErrPermission):
 			httpapi.Write(ctx, rw, http.StatusForbidden, codersdk.Response{
-				Message: "Permission denied",
+				Message: err.Error(),
 			})
 		default:
 			httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
@@ -44,28 +46,27 @@ func (*agent) HandleLS(rw http.ResponseWriter, r *http.Request) {
 }
 
 func listFiles(query LSQuery) (LSResponse, error) {
-	var base string
+	var fullPath []string
 	switch query.Relativity {
 	case LSRelativityHome:
 		home, err := os.UserHomeDir()
 		if err != nil {
 			return LSResponse{}, xerrors.Errorf("failed to get user home directory: %w", err)
 		}
-		base = home
+		fullPath = []string{home}
 	case LSRelativityRoot:
 		if runtime.GOOS == "windows" {
-			// TODO: Eventually, we could have a empty path with a root base
-			// return all drives.
-			// C drive should be good enough for now.
-			base = "C:\\"
+			if len(query.Path) == 0 {
+				return listDrives()
+			}
 		} else {
-			base = "/"
+			fullPath = []string{"/"}
 		}
 	default:
 		return LSResponse{}, xerrors.Errorf("unsupported relativity type %q", query.Relativity)
 	}
 
-	fullPath := append([]string{base}, query.Path...)
+	fullPath = append(fullPath, query.Path...)
 	absolutePathString, err := filepath.Abs(filepath.Join(fullPath...))
 	if err != nil {
 		return LSResponse{}, xerrors.Errorf("failed to get absolute path: %w", err)
@@ -97,12 +98,48 @@ func listFiles(query LSQuery) (LSResponse, error) {
 		})
 	}
 
+	absolutePath := pathToArray(absolutePathString)
+
 	return LSResponse{
+		AbsolutePath:       absolutePath,
 		AbsolutePathString: absolutePathString,
 		Contents:           respContents,
 	}, nil
 }
 
+func listDrives() (LSResponse, error) {
+	aa, err := disk.Partitions(true)
+	if err != nil {
+		return LSResponse{}, xerrors.Errorf("failed to get partitions: %w", err)
+	}
+	contents := make([]LSFile, 0, len(aa))
+	for _, a := range aa {
+		name := a.Mountpoint + string(os.PathSeparator)
+		contents = append(contents, LSFile{
+			Name:               name,
+			AbsolutePathString: name,
+			IsDir:              true,
+		})
+	}
+
+	return LSResponse{
+		AbsolutePath:       []string{},
+		AbsolutePathString: "",
+		Contents:           contents,
+	}, nil
+}
+
+func pathToArray(path string) []string {
+	out := strings.FieldsFunc(path, func(r rune) bool {
+		return r == os.PathSeparator
+	})
+	// Drive letters on Windows should have a trailing separator.
+	if runtime.GOOS == "windows" && len(out) > 0 {
+		out[0] += string(os.PathSeparator)
+	}
+	return out
+}
+
 type LSQuery struct {
 	// e.g. [], ["repos", "coder"],
 	Path []string `json:"path"`
@@ -112,6 +149,7 @@ type LSQuery struct {
 }
 
 type LSResponse struct {
+	AbsolutePath []string `json:"absolute_path"`
 	// Returned so clients can display the full path to the user, and
 	// copy it to configure file sync
 	// e.g. Windows: "C:\\Users\\coder"
diff --git a/agent/ls_internal_test.go b/agent/ls_internal_test.go
@@ -4,7 +4,6 @@ import (
 	"os"
 	"path/filepath"
 	"runtime"
-	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -90,9 +89,9 @@ func TestListFilesSuccess(t *testing.T) {
 		},
 		{
 			name: "root",
-			baseFunc: func(t *testing.T) string {
+			baseFunc: func(*testing.T) string {
 				if runtime.GOOS == "windows" {
-					return "C:\\"
+					return ""
 				}
 				return "/"
 			},
@@ -116,12 +115,18 @@ func TestListFilesSuccess(t *testing.T) {
 			err = os.Mkdir(downloadsDir, 0o755)
 			require.NoError(t, err)
 
-			rel, err := filepath.Rel(base, tmpDir)
-			require.NoError(t, err)
-			relComponents := pathToArray(rel)
+			var queryComponents []string
+			// We can't get an absolute path relative to empty string on Windows.
+			if runtime.GOOS == "windows" && base == "" {
+				queryComponents = pathToArray(tmpDir)
+			} else {
+				rel, err := filepath.Rel(base, tmpDir)
+				require.NoError(t, err)
+				queryComponents = pathToArray(rel)
+			}
 
 			query := LSQuery{
-				Path:       relComponents,
+				Path:       queryComponents,
 				Relativity: tc.relativity,
 			}
 			resp, err := listFiles(query)
@@ -149,7 +154,7 @@ func TestListFilesSuccess(t *testing.T) {
 	}
 }
 
-func TestListFilesWindowsRoot(t *testing.T) {
+func TestListFilesListDrives(t *testing.T) {
 	t.Parallel()
 
 	if runtime.GOOS != "windows" {
@@ -162,11 +167,23 @@ func TestListFilesWindowsRoot(t *testing.T) {
 	}
 	resp, err := listFiles(query)
 	require.NoError(t, err)
-	require.Equal(t, "C:\\", resp.AbsolutePathString)
-}
-
-func pathToArray(path string) []string {
-	return strings.FieldsFunc(path, func(r rune) bool {
-		return r == os.PathSeparator
+	require.Contains(t, resp.Contents, LSFile{
+		Name:               "C:\\",
+		AbsolutePathString: "C:\\",
+		IsDir:              true,
 	})
+
+	query = LSQuery{
+		Path:       []string{"C:\\"},
+		Relativity: LSRelativityRoot,
+	}
+	resp, err = listFiles(query)
+	require.NoError(t, err)
+
+	query = LSQuery{
+		Path:       resp.AbsolutePath,
+		Relativity: LSRelativityRoot,
+	}
+	resp, err = listFiles(query)
+	require.NoError(t, err)
 }
diff --git a/go.mod b/go.mod
@@ -401,7 +401,7 @@ require (
 	github.com/ryanuber/go-glob v1.0.0 // indirect
 	github.com/satori/go.uuid v1.2.1-0.20181028125025-b2ce2384e17b // indirect
 	github.com/secure-systems-lab/go-securesystemslib v0.7.0 // indirect
-	github.com/shirou/gopsutil/v3 v3.24.4 // indirect
+	github.com/shirou/gopsutil/v3 v3.24.4
 	github.com/shoenig/go-m1cpu v0.1.6 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/spaolacci/murmur3 v1.1.0 // indirect
