- Notifications
You must be signed in to change notification settings - Fork1k
feat: add coder_workspace_ls MCP tool#19652
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
+316 −113
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
141 changes: 66 additions & 75 deletionsagent/ls.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -11,23 +11,39 @@ import ( | ||
| "strings" | ||
| "github.com/shirou/gopsutil/v4/disk" | ||
| "github.com/spf13/afero" | ||
| "golang.org/x/xerrors" | ||
| "github.com/coder/coder/v2/coderd/httpapi" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| "github.com/coder/coder/v2/codersdk/workspacesdk" | ||
| ) | ||
| var WindowsDriveRegex = regexp.MustCompile(`^[a-zA-Z]:\\$`) | ||
| func (a*agent) HandleLS(rw http.ResponseWriter, r *http.Request) { | ||
| ctx := r.Context() | ||
| // An absolute path may be optionally provided, otherwise a path split into an | ||
| // array must be provided in the body (which can be relative). | ||
| query := r.URL.Query() | ||
| parser := httpapi.NewQueryParamParser() | ||
| path := parser.String(query, "", "path") | ||
| parser.ErrorExcessParams(query) | ||
| if len(parser.Errors) > 0 { | ||
| httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{ | ||
| Message: "Query parameters have invalid values.", | ||
| Validations: parser.Errors, | ||
| }) | ||
| return | ||
| } | ||
| var req workspacesdk.LSRequest | ||
| if !httpapi.Read(ctx, rw, r, &req) { | ||
| return | ||
| } | ||
| resp, err := listFiles(a.filesystem, path, req) | ||
| if err != nil { | ||
| status := http.StatusInternalServerError | ||
| switch { | ||
| @@ -46,66 +62,74 @@ func (*agent) HandleLS(rw http.ResponseWriter, r *http.Request) { | ||
| httpapi.Write(ctx, rw, http.StatusOK, resp) | ||
| } | ||
| func listFiles(fs afero.Fs, path string, query workspacesdk.LSRequest) (workspacesdk.LSResponse, error) { | ||
| absolutePathString := path | ||
| if absolutePathString != "" { | ||
| if !filepath.IsAbs(path) { | ||
| return workspacesdk.LSResponse{}, xerrors.Errorf("path must be absolute: %q", path) | ||
| } | ||
| } else { | ||
| var fullPath []string | ||
| switch query.Relativity { | ||
| case workspacesdk.LSRelativityHome: | ||
| home, err := os.UserHomeDir() | ||
| if err != nil { | ||
| return workspacesdk.LSResponse{}, xerrors.Errorf("failed to get user home directory: %w", err) | ||
| } | ||
| fullPath = []string{home} | ||
| case workspacesdk.LSRelativityRoot: | ||
| if runtime.GOOS == "windows" { | ||
| if len(query.Path) == 0 { | ||
| return listDrives() | ||
| } | ||
| if !WindowsDriveRegex.MatchString(query.Path[0]) { | ||
| return workspacesdk.LSResponse{}, xerrors.Errorf("invalid drive letter %q", query.Path[0]) | ||
| } | ||
| } else { | ||
| fullPath = []string{"/"} | ||
| } | ||
| default: | ||
| return workspacesdk.LSResponse{}, xerrors.Errorf("unsupported relativity type %q", query.Relativity) | ||
| } | ||
| fullPath = append(fullPath, query.Path...) | ||
| fullPathRelative := filepath.Join(fullPath...) | ||
| var err error | ||
| absolutePathString, err = filepath.Abs(fullPathRelative) | ||
| if err != nil { | ||
| return workspacesdk.LSResponse{}, xerrors.Errorf("failed to get absolute path of %q: %w", fullPathRelative, err) | ||
| } | ||
| } | ||
| // codeql[go/path-injection] - The intent is to allow the user to navigate to any directory in their workspace. | ||
| f, err :=fs.Open(absolutePathString) | ||
| if err != nil { | ||
| returnworkspacesdk.LSResponse{}, xerrors.Errorf("failed to open directory %q: %w", absolutePathString, err) | ||
| } | ||
| defer f.Close() | ||
| stat, err := f.Stat() | ||
| if err != nil { | ||
| returnworkspacesdk.LSResponse{}, xerrors.Errorf("failed to stat directory %q: %w", absolutePathString, err) | ||
| } | ||
| if !stat.IsDir() { | ||
| returnworkspacesdk.LSResponse{}, xerrors.Errorf("path %q is not a directory", absolutePathString) | ||
| } | ||
| // `contents` may be partially populated even if the operation fails midway. | ||
| contents, _ := f.Readdir(-1) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. It's a shame Afero doesn't expose There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Too true 😢 | ||
| respContents := make([]workspacesdk.LSFile, 0, len(contents)) | ||
| for _, file := range contents { | ||
| respContents = append(respContents,workspacesdk.LSFile{ | ||
| Name: file.Name(), | ||
| AbsolutePathString: filepath.Join(absolutePathString, file.Name()), | ||
| IsDir: file.IsDir(), | ||
| }) | ||
| } | ||
| // Sort alphabetically: directories then files | ||
| slices.SortFunc(respContents, func(a, bworkspacesdk.LSFile) int { | ||
| if a.IsDir && !b.IsDir { | ||
| return -1 | ||
| } | ||
| @@ -117,35 +141,35 @@ func listFiles(query LSRequest) (LSResponse, error) { | ||
| absolutePath := pathToArray(absolutePathString) | ||
| returnworkspacesdk.LSResponse{ | ||
| AbsolutePath: absolutePath, | ||
| AbsolutePathString: absolutePathString, | ||
| Contents: respContents, | ||
| }, nil | ||
| } | ||
| func listDrives() (workspacesdk.LSResponse, error) { | ||
| // disk.Partitions() will return partitions even if there was a failure to | ||
| // get one. Any errored partitions will not be returned. | ||
| partitionStats, err := disk.Partitions(true) | ||
| if err != nil && len(partitionStats) == 0 { | ||
| // Only return the error if there were no partitions returned. | ||
| returnworkspacesdk.LSResponse{}, xerrors.Errorf("failed to get partitions: %w", err) | ||
| } | ||
| contents := make([]workspacesdk.LSFile, 0, len(partitionStats)) | ||
| for _, a := range partitionStats { | ||
| // Drive letters on Windows have a trailing separator as part of their name. | ||
| // i.e. `os.Open("C:")` does not work, but `os.Open("C:\\")` does. | ||
| name := a.Mountpoint + string(os.PathSeparator) | ||
| contents = append(contents,workspacesdk.LSFile{ | ||
| Name: name, | ||
| AbsolutePathString: name, | ||
| IsDir: true, | ||
| }) | ||
| } | ||
| returnworkspacesdk.LSResponse{ | ||
| AbsolutePath: []string{}, | ||
| AbsolutePathString: "", | ||
| Contents: contents, | ||
| @@ -163,36 +187,3 @@ func pathToArray(path string) []string { | ||
| } | ||
| return out | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.