feat: support current mentions in @ mention menu for prompt templates #6793

bahrmichael · 2025-01-24T09:49:40Z

This PR introduces support for current @ mentions in the prompt template editor. This PR has to be followed up by a PR in the sg repository to make this feature visible to users. See demo from my local instance below:

Screen.Recording.2025-01-24.at.10.33.58.mov

The design changes have been reviewed here: https://sourcegraph.slack.com/archives/C07HRH4RJP8/p1737653234416939

Test plan

New unit tests + manual testing (see video)

ichim-david · 2025-02-02T17:52:33Z

@bahrmichael @vovakulikov a small observation regarding "Currently opened tabs"
https://github.com/sourcegraph/cody/pull/6793/files#diff-ca3af0ca5b8b798e9612b3b527378fde05aa2da471fb45cfee3d7babeb7fc3c7R205

As I was working on providing a fix for expanding current-tab when settings is opened
#6910
I noticed that the logic for this expansion filters the currently opened tabs to only those that
are part of the workspace.

As such this "Currently opened tabs" title could be a bit misleading if someone opens a file from outside
the workspace and then they wonder why that file is not present in the Cody chat.

It is probably highly unlikely for someone todo this, notice, and complain but there are still users that
read a text and take it "ad litteram" and could have a problem.

I don't propose anything, just want to bring this up in case this revelation changes anything or we are ok
with the way things will be presented as they are right now.

bahrmichael · 2025-02-05T13:50:05Z

@bahrmichael @vovakulikov a small observation regarding "Currently opened tabs" https://github.com/sourcegraph/cody/pull/6793/files#diff-ca3af0ca5b8b798e9612b3b527378fde05aa2da471fb45cfee3d7babeb7fc3c7R205

As I was working on providing a fix for expanding current-tab when settings is opened #6910 I noticed that the logic for this expansion filters the currently opened tabs to only those that are part of the workspace.

As such this "Currently opened tabs" title could be a bit misleading if someone opens a file from outside the workspace and then they wonder why that file is not present in the Cody chat.

It is probably highly unlikely for someone todo this, notice, and complain but there are still users that read a text and take it "ad litteram" and could have a problem.

I don't propose anything, just want to bring this up in case this revelation changes anything or we are ok with the way things will be presented as they are right now.

Thank you for pointing that out! If I understand correctly, workspaces is a VSCode concept. Since that's not present in JetBrains products, I'm having trouble coming up with a good term that would reflect workspaces. And I would advise against adding custom code for this.

fkling · 2025-02-05T14:42:37Z

lib/shared/src/codebase-context/messages.ts

+export interface ContextItemCurrentSelection extends ContextItemCommon {
+    type: 'current-selection'
+}
+
+export interface ContextItemCurrentFile extends ContextItemCommon {
+    type: 'current-file'
+}
+
+export interface ContextItemCurrentRepository extends ContextItemCommon {
+    type: 'current-repository'
+}
+
+export interface ContextItemCurrentDirectory extends ContextItemCommon {
+    type: 'current-directory'
+}
+
+export interface ContextItemCurrentOpenTabs extends ContextItemCommon {
+    type: 'current-open-tabs'
+}


I'm generally curious in which situations it's OK to do this vs creating an internal openctx provider.

Maybe @vovakulikov knows more, I'm not confident in this area of code :)

lib/shared/src/lexicalEditor/atMentionsSerializer.ts

fkling · 2025-02-05T14:48:47Z

lib/shared/src/lexicalEditor/atMentionsSerializer.ts

-            t += `${AT_MENTION_SERIALIZED_PREFIX}?data=${unicodeSafeBtoa(
-                JSON.stringify(n, undefined, 0)
-            )}${AT_MENTION_SERIALIZATION_END}`
+            throw Error('Unhandled node type in atMentionsSerializer.serialize: ' + n.type)


Is there ever a chance that this will be hit in production?

This should only appear during development. If someone adds a new type, I want this to light up so they can update the according code.

web/lib/components/CodyPromptTemplate.tsx

vovakulikov

I approve as we want to hit the path release with it but I think @fkling touched a very good point here, what if we don't resolve these generic mentions as we click prompt and render prompt message (with hydrated generic mention values) but instead we always render this blank generic mentions chips and resolve them only on message submit?

Then we could handle all generic mentions via special internal OpenCtx for generic mentions. (I guess we would have to extend openctx API a littlie bit to support some corner cases when we don't have context for Cody Web, but it should be fine)

I think this would be better since we won't be hitting weird cody://<mention-type> text in the editor where we don't have the environment context to hydrate these generic mentions (instead we will render something like a chip with a warning colour or throughline chip)

Anyway, @bahrmichael, can I ask you to write a prompt-mentions-doc.md here where you explain how the full flow of generic and direct mentions work in the prompt library, cody web and cody vs code. I still remember what we did here but this memory will go away pretty fast and with this state of the art in cody it won't be easy to unwrap it

Also, let's pair tomorrow to check some core cases manually in Cody Web with the pulled main in this branch. Thanks for your contributions in prompts library!

web/lib/components/CodyPromptTemplate.tsx

vovakulikov · 2025-02-06T01:26:29Z

@ichim-david, thanks for the catching workspace tabs thing; I agree with @bahrmichael, we, in theory, could have workspace capability settings and change the labels for this chip based on this setting. But I think it's not the blocker problem here and we can add it later when someone will reach out us about this (or when we finish prompts mentions and go to post-ga phase), appreciate your high agency 😉

bahrmichael · 2025-02-06T12:01:54Z

but instead we always render this blank generic mentions chips and resolve them only on message submit?

If I understand this correctly, I wouldn't be able to use "current file" or "current selection" multiple times anymore. This is a use case that I heavily enjoy, when I can go through a couple files and tell cody "look at X, Y, and Z".

bahrmichael · 2025-02-06T12:12:20Z

Todos for me:

✅ start discussion in wg-prompts about changing resolution behavior
create an issue to keep track of this
write down what i know about prompt library and hydration
✅ add issue for prompt template loading showing 100% height

bahrmichael · 2025-02-10T12:38:19Z

Screenshots from a final round of testing:

sourcegraph-release-bot · 2025-02-10T12:40:18Z

The backport to vscode-v1.64.x failed at https://github.com/sourcegraph/cody/actions/runs/13241070410:

The process '/usr/bin/git' failed with exit code 1

To backport this PR manually, you can either:

Via the sg tool

Use the sg backport command to backport your commit to the release branch.

sg backport -r vscode-v1.64.x -p 6793

Via your terminal

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-vscode-v1.64.x vscode-v1.64.x
# Navigate to the new working tree
cd .worktrees/backport-vscode-v1.64.x
# Create a new branch
git switch --create backport-6793-to-vscode-v1.64.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a59e31dddef0cb9017dbf70ad8a1512c97331995
# Push it to GitHub
git push --set-upstream origin backport-6793-to-vscode-v1.64.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-vscode-v1.64.x

If you encouter conflict, first resolve the conflict and stage all files, then run the commands below:

git cherry-pick --continue
# Push it to GitHub
git push --set-upstream origin backport-6793-to-vscode-v1.64.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-vscode-v1.64.x

Follow above instructions to backport the commit.
Create a pull request where the base branch is vscode-v1.64.x and the compare/head branch is backport-6793-to-vscode-v1.64.x., click here to create the pull request.

Once the pull request has been created, please ensure the following:

Make sure to tag @sourcegraph/release in the pull request description.
kindly remove the release-blocker from this pull request.

…ates (#6793) This PR introduces support for current @ mentions in the prompt template editor. This PR has to be followed up by a PR in the sg repository to make this feature visible to users. See demo from my local instance below: https://github.com/user-attachments/assets/268b3d9c-58a7-4ddc-9f1e-0feb398487af The design changes have been reviewed here: https://sourcegraph.slack.com/archives/C07HRH4RJP8/p1737653234416939 New unit tests + manual testing (see video)

ichim-david · 2025-02-10T20:28:06Z

@bahrmichael I think your changes have triggered a failure in my pull request https://github.com/sourcegraph/cody/actions/runs/13249643202/job/36984307007?pr=7037#step:8:1 as I have not worked with context items.
It seems that all of these new additions need to be reflected also on the jetbrains side.
Perhaps following this suggestion would fix it https://github.com/sourcegraph/cody/actions/runs/13249643202/job/36984307007?pr=7037#step:8:176

bahrmichael added 7 commits January 22, 2025 16:36

current mentions first draft

28779fe

Merge branch 'main' into bahrmichael/prompt-editor-current-mentions

353845d

wip

1c13ad7

merge from main

cdfc65f

bunch of changes

003fcf5

revert version change

4e98c93

fixes and tests for serialization edge cases

ad8bbe5

bahrmichael marked this pull request as ready for review January 24, 2025 10:24

bahrmichael requested a review from vovakulikov January 24, 2025 10:24

linting

f060ca8

bahrmichael added 3 commits February 5, 2025 14:33

merge from main

39efe95

lint

0067edd

fix and linting

ebdb427

fkling reviewed Feb 5, 2025

View reviewed changes

review updates

0e7df65

bahrmichael requested a review from fkling February 5, 2025 15:23

vovakulikov approved these changes Feb 6, 2025

View reviewed changes

web/lib/components/CodyPromptTemplate.tsx Outdated Show resolved Hide resolved

bahrmichael added 5 commits February 6, 2025 14:56

review updates

52cffaf

Merge branch 'main' into bahrmichael/prompt-editor-current-mentions

6abb2bd

review update

6a28bb1

fix issues with current repo chips from other changes

a775c8a

Merge branch 'main' into bahrmichael/prompt-editor-current-mentions

4df5074

bahrmichael merged commit a59e31d into main Feb 10, 2025
20 of 22 checks passed

bahrmichael deleted the bahrmichael/prompt-editor-current-mentions branch February 10, 2025 12:39

bahrmichael added backport jb-v7.12.x backport vscode-v1.64.x labels Feb 10, 2025

sourcegraph-release-bot added backports failed-backport-to-vscode-v1.64.x release-blocker labels Feb 10, 2025

bahrmichael mentioned this pull request Feb 10, 2025

feat: support for dynamic mentions in @ mention menu for prompt templ… #7034

Open

bahrmichael mentioned this pull request Feb 10, 2025

feat: support for dynamic mentions in @ mention menu for prompt templ… #7035

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support current mentions in @ mention menu for prompt templates #6793

feat: support current mentions in @ mention menu for prompt templates #6793

bahrmichael commented Jan 24, 2025 •

edited

Loading

ichim-david commented Feb 2, 2025

bahrmichael commented Feb 5, 2025

fkling Feb 5, 2025

bahrmichael Feb 5, 2025

fkling Feb 5, 2025

bahrmichael Feb 5, 2025

vovakulikov left a comment

vovakulikov commented Feb 6, 2025

bahrmichael commented Feb 6, 2025

bahrmichael commented Feb 6, 2025 •

edited

Loading

bahrmichael commented Feb 10, 2025

sourcegraph-release-bot commented Feb 10, 2025

ichim-david commented Feb 10, 2025

feat: support current mentions in @ mention menu for prompt templates #6793

feat: support current mentions in @ mention menu for prompt templates #6793

Conversation

bahrmichael commented Jan 24, 2025 • edited Loading

Test plan

ichim-david commented Feb 2, 2025

bahrmichael commented Feb 5, 2025

fkling Feb 5, 2025

Choose a reason for hiding this comment

bahrmichael Feb 5, 2025

Choose a reason for hiding this comment

fkling Feb 5, 2025

Choose a reason for hiding this comment

bahrmichael Feb 5, 2025

Choose a reason for hiding this comment

vovakulikov left a comment

Choose a reason for hiding this comment

vovakulikov commented Feb 6, 2025

bahrmichael commented Feb 6, 2025

bahrmichael commented Feb 6, 2025 • edited Loading

bahrmichael commented Feb 10, 2025

sourcegraph-release-bot commented Feb 10, 2025

ichim-david commented Feb 10, 2025

bahrmichael commented Jan 24, 2025 •

edited

Loading

bahrmichael commented Feb 6, 2025 •

edited

Loading