feat(mention): allow selection of context from branches for remote files and directories #8156

ichim-david · 2025-07-07T19:21:07Z

Allow selecting of branches before choosing a file or a directory when using the remote file and directory option

Test plan

Test remote directories that are able to be referenced
Test that if you select a remote file or directory you can select a branch or search for a branch not found in that list (first 10) if there are many branches and then use the selected context from that branch

This commit enhances the mention menu to display the branch name associated with the context item, improving user clarity. - Adds a `getBranchHelpText` function to determine the appropriate help text based on available branch information. - The function checks if the branch is specified in the mention data or the query string. - Updates the MentionMenu component to use the `getBranchHelpText` function to display the branch name. - Adds unit tests for the `getBranchHelpText` function and `extractRepoAndBranch` function to ensure correct behavior. - Modifies `extractRepoAndBranch` to support parsing repo and branch from strings like "repo@branch", "repo", or "repo:directory@branch". - Updates the query to include the branch when searching for directories.

This commit introduces several enhancements to the remote directory search functionality, improving the accuracy and usability of directory context within the Cody extension. - Improves the parsing of repo and branch from the query string in `extractRepoAndBranch` function. - Adds tests for `github.com/mrdoob/three.js@dev` parsing. - Implements branch selection for root directory search. - Implements branch selection with directory path filtering. - Introduces `getDirectoryContents` query to fetch directory contents. - Updates `getDirectoryItem` to use `getDirectoryContents` and filter directory entries. - Adds DIRECTORY_CONTENTS_QUERY to GraphQL queries. - Adds `getDirectoryContents` method to `SourcegraphGraphQLAPIClient`.

peterguy · 2025-07-08T21:56:24Z

lib/shared/src/sourcegraph-api/graphql/queries.ts

+            path
+            byteSize
+            url
+            content


Examining the rest of the PR, it looks like you don't need content. content is pretty expensive, so you should use it only when you need the file contents immediately. If you think you may need the file contents, you can use rawURL instead of content and then use that URL to retrieve the content.

Additionally, examine whether you need the blob at all - it looks like this PR is using the directories, but not the files, so you may be able to ditch the file info (GitBlob) completely.

+1 to the blob comment

ichim-david · 2025-07-13T12:37:28Z

@peterguy I'm looking at addressing your feedback.
I noticed that when we perform the remote directories mention we use the CONTEXT_SEARCH_QUERY_WITH_RANGES query
https://github.com/sourcegraph/cody/blob/main/lib/shared/src/sourcegraph-api/graphql/queries.ts#L259
which just does a file chunk reply instead of using the entire file.
Ex:

If we do just a remote file then we use the entire file as context.

The new getDirectory with it's conditions would of returned only the files found in that folder and not it's children

and I think contents help here in order to use the entire file content but I could be wrong.

I know that if I manually add some context I would expect for the entire file to be read instead of just chunks, was trying this on Cursor and although the folder is local and not remote it was able to properly read the contents of all 4 files that were found in that directory.

If we want to keep this light chunk but more encompassing search that finds files also in children directories then I will just look at adding the information regarding the branch searching and selecting and keep the remote directory context with the file chunk as it is.

peterguy · 2025-07-16T18:26:17Z

@ichim-david in general, even if you’re using file contents, you should return rawURL and make a subsequent call to that URL, rather than adding the burden of the file contents to the GQL query.

…earch This commit enhances the retrieval of remote directory items by utilizing context search for improved accuracy and performance. It also introduces a fallback mechanism to `getDirectoryContents` if context search returns no results. - Implements context search for retrieving directory items using `graphqlClient.contextSearch`. - Adds a fallback mechanism to `getDirectoryContents` if context search returns no results. - Modifies `getDirectoryItem` to accept `repoID` instead of `query`. - Updates `getDirectoryItem` to use directory basename as search query since contextSearch requires non-empty query. - Adds revision support to context search. - Adds repoName and revision to context item mentions. - Reduces the number of entries fetched in `GetDirectoryContents` query to 15. - Updates file pattern regex for root directory search in `getDirectoryMentions` to ensure it matches from the start of the string. - Constructs URL with branch information in `getDirectoryMentions` if available. - Fixes parsing of repo and branch from query string in `extractRepoAndBranch` function by using `indexOf` instead of `lastIndexOf` to find the `@` symbol.

This commit addresses issues in the remote directory search tests and improves URL generation for directory mentions. - Updates test assertions to use the correct server endpoint from the mock configuration. - Mocks `contextSearch` to return an empty array to trigger fallback in tests. - Adds `repoID` to the data object in directory contents tests. - Corrects the URL generation in `getDirectoryMentions` to use `/tree/` instead of `/blob/` for directory paths. - Updates the file pattern regex in `searchFileMatches` to ensure it matches from the start of the string.

…d fuzzy matching This commit introduces several enhancements to the remote directory search functionality, including improved branch handling and fuzzy matching for branch names, enhancing the user experience when searching for directories within specific branches. - Implements branch suggestions when the user types `repo:` to show available branches. - Adds fuzzy matching for branch names when the user types `repo:@query` to filter branches. - Supports branch names with hyphens, slashes, and dots in `extractRepoAndBranch`. - Improves the display of branch information in the mention menu, including help text indicating the source branch. - Updates the mention menu to display the correct query label with branch information. - Fixes the search query to include the branch name when searching for directories. - Adds tests for branch name parsing and branch suggestions.

…rowsing This commit introduces branch suggestions and enhances remote file browsing within OpenCtx, allowing users to easily navigate and search for files within specific branches of a repository. - Adds `getBranchMentions` to fetch branch suggestions for a given repository. - Implements branch filtering based on user input. - Adds support for browsing files in a specific branch using the `repo@branch:path` format. - Updates `createRepositoryMention` to include `defaultBranch` and `branches` in the mention data. - Modifies `getFileMentions` to include an optional branch parameter in the search query. - Creates `createBranchMentionsFromData` to create mention objects for branches. - Introduces `parseRemoteQuery` to parse the query string and extract repository name, branch, and path components.

…ents This commit enhances the remote directory search functionality by utilizing the `getDirectoryContents` API to fetch directory contents directly, improving performance and reliability. - Replaces the previous implementation that relied on `contextSearch` and a fallback to `getDirectoryContents` with a direct call to `getDirectoryContents`. - Adds a new `fetchContentFromRawURL` method to fetch the content of files from their raw URLs. - Updates the `getDirectoryItem` function to use the `getDirectoryContents` API and `fetchContentFromRawURL` to retrieve file entries and their content. - Filters out directories and binary files from the results. - Exports `DirectoryContentsResponse` type. - Updates the `GetDirectoryContents` query to include `rawURL` and `binary` fields.

…ectories

Also sort directory listing by path name as it happens on online listing

julialeex · 2025-07-30T21:16:32Z

Can we fix the %40 and change it to @?

julialeex · 2025-07-30T21:07:27Z

lib/shared/src/sourcegraph-api/graphql/queries.ts

+            path
+            byteSize
+            url
+            content


+1 to the blob comment

vscode/src/context/openctx/common/branch-mentions.ts

julialeex · 2025-07-30T21:33:00Z

vscode/src/context/openctx/common/branch-mentions.ts

+            branchQuery,
+        })
+    } catch (error) {
+        // If the search fails, return empty array to fall back to client-side filtering


nit: Can add debug logs here

Removed the try catch, regarding logging, even in the previous remoteDirectorySearch we weren't logging but I guess we can add some

vscode/src/context/openctx/common/branch-mentions.ts

julialeex · 2025-07-30T21:41:03Z

vscode/src/context/openctx/remoteDirectorySearch.ts

+ * Extracts repo name and optional branch from a string.
+ * Supports formats: "repo@branch", "repo", or "repo:directory@branch"
+ */
+export function extractRepoAndBranch(input: string): [string, string | undefined] {


removeFileSearch.ts has a similar logic for extracting the branch. Can we reuse the code somehow?

julialeex · 2025-07-30T21:42:14Z

vscode/src/context/openctx/remoteDirectorySearch.ts


-            const url = `${serverEndpoint.replace(/\/$/, '')}${result.file.url}`
+            // Construct URL with branch information if available
+            const baseUrl = `${serverEndpoint.replace(/\/$/, '')}/${result.repository.name}`


${serverEndpoint.replace(/\/$/, '')} is also being used at multiple places.

julialeex · 2025-07-30T21:45:56Z

vscode/src/context/openctx/remoteDirectorySearch.ts

+
+        let content = ''
+        const rawContent = await graphqlClient.fetchContentFromRawURL(entry.rawURL)
+        if (!isError(rawContent)) {


It would be nice to add some error handling here (ex: a warning/debug log)

vscode/src/context/openctx/remoteFileSearch.ts

julialeex · 2025-07-30T21:52:29Z

vscode/src/context/openctx/remoteDirectorySearch.ts

+    } = await currentResolvedConfig()
+
+    const items: Item[] = []
+    for (const entry of entries) {


We can fetch all contents in parallel instead of sequentially here for better performance.

julialeex · 2025-07-30T21:53:31Z

This PR is pretty big. I'm adding @thenamankumar to get a third pair of eyes 🙏

Thank you @ichim-david for implementing this!

- not needed for this use case as mentioned in review

…ctory mentions

julialeex

Approve to unblock. Thanks David!

ichim-david · 2025-07-31T16:17:02Z

Latest video with feature in action https://www.loom.com/share/ee4c3a99cff846e09f764a399f6d689f?sid=45e1ce53-6065-4b52-9827-904dd289dfbe

ichim-david · 2025-07-31T16:32:32Z

@peterguy I did as you've asked, I've removed the content and I am using rawURL to fetch the contents.
@thenamankumar maybe you would like to take a look at this as well since you worked on the remote file and directory ... some things can probably be abstracted further and code duplication be removed some more but I think this is a good start and it might be worth having in the pre-release

peterguy

My major concerns about fetching blob contents about were addressed

ichim-david · 2025-07-31T18:51:48Z

@thenamankumar You're the only one left :) feel free to improve this code anyway you seem fit in order to get this merged, now that Julia and Peter have accepted the pr.
Do take a look at the video where I showcases how the flow is now of repo search -> branch select or search -> directory select or search

ichim-david added 2 commits July 7, 2025 22:19

peterguy reviewed Jul 8, 2025

View reviewed changes

ichim-david added 18 commits July 20, 2025 10:45

Fixed tests by using the exported functions and general cleanup

49af345

pnpm biome fix

0052d3f

fixed remote file filtering once we choose the branch

3473b19

Removed experimental flag from remote directoy mention menu

4ffcf86

WIP implementing repo -> branch -> directory selection for remote dir…

0f98b3a

…ectories

repository branch searching beyond the first 10 results

e198229

fix regex for starting directories mentions on searches branches

56730e2

skip . folders from initial folder listing

ca80b62

Also sort directory listing by path name as it happens on online listing

simplify branch mentions after proper branch searching

f32012f

simplify check for remote directories branch or directory listing

8fe7cec

allow remote file to search for branches

1841de6

test fixes

2b43819

fix mention menu tooltip height when branch name is long

9be17a4

ichim-david changed the title ~~feat(context): Display branch name in mention menu help text~~ feat(mention): allow selection of context from branches for remote files and directories Jul 30, 2025

ichim-david requested a review from julialeex July 30, 2025 20:30

julialeex requested a review from peterguy July 30, 2025 20:53

julialeex reviewed Jul 30, 2025

View reviewed changes

vscode/src/context/openctx/remoteFileSearch.ts Outdated Show resolved Hide resolved

julialeex reviewed Jul 30, 2025

View reviewed changes

julialeex requested a review from thenamankumar July 30, 2025 21:52

ichim-david added 7 commits July 31, 2025 09:00

removed getFileBranchMentions fallback to file search

57bffd7

- not needed for this use case as mentioned in review

simplify code by getting rid of need for extractBranchAndRepo

29ce80a

simplify and bring mentions in sync between remoteFile and remoteDire…

c927aaa

…ctory mentions

remove needless try catch and clarify why we have empty description

4d9016f

removed parsedRemoteQuery logic that ended up not being used

75ef576

parallel fetch of directory items

8d5a4cf

fix tooltips for dirname

996e08e

julialeex approved these changes Jul 31, 2025

View reviewed changes

peterguy approved these changes Jul 31, 2025

View reviewed changes

feat(mention): allow selection of context from branches for remote files and directories #8156

Are you sure you want to change the base?

feat(mention): allow selection of context from branches for remote files and directories #8156

Uh oh!

Conversation

ichim-david commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test plan

Uh oh!

peterguy Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

julialeex Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

ichim-david commented Jul 13, 2025

Uh oh!

peterguy commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

julialeex commented Jul 30, 2025

Uh oh!

julialeex Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

julialeex Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

ichim-david Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

julialeex Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

julialeex Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

julialeex Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

julialeex Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

julialeex commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

julialeex left a comment

Choose a reason for hiding this comment

Uh oh!

ichim-david commented Jul 31, 2025

Uh oh!

ichim-david commented Jul 31, 2025

Uh oh!

peterguy left a comment

Choose a reason for hiding this comment

Uh oh!

ichim-david commented Jul 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ichim-david commented Jul 7, 2025 •

edited

Loading

peterguy Jul 8, 2025 •

edited

Loading

peterguy commented Jul 16, 2025 •

edited

Loading

julialeex Jul 30, 2025 •

edited

Loading

julialeex commented Jul 30, 2025 •

edited

Loading