Agent: make AgentWorkspaceDocuments more robust #4279
Merged
Conversation
This file contains 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
olafurpg
commented
May 23, 2024
The PR #4277 was a lesson that we have very brittle code around dealing with document synchronization. This PR is an attempt to improve code health by - Adding tests! - Being more rigorous with null handling - Making the code a bit easier to follow (hopefully)
olafurpg
force-pushed
the
olafurpg/nullish
branch
from
5bb34f0
to
f20881b
Compare
abeatrix
approved these changes
May 23, 2024
olafurpg
commented
May 23, 2024
There was a problem hiding this comment.
I'm planning to fix CODY-1829 : Handle null values in the protocol separately, where we add | null to the most important protocol properties.
olafurpg
commented
May 23, 2024
agent/src/AgentWorkspaceDocuments.ts
Outdated
| @@ -44,33 +44,53 @@ export class AgentWorkspaceDocuments implements vscode_shim.WorkspaceDocuments { | |||
| } { | |||
| const fromCache = this.agentDocuments.get(document.underlying.uri) | |||
| if (!fromCache) { | |||
| return { document: new AgentTextDocument(document), contentChanges: [] } | |||
| const result = new AgentTextDocument(document) | |||
| this.agentDocuments.set(document.underlying.uri, result) | |||
There was a problem hiding this comment.
The old flow was very weird, we populated the map at call site every single time, instead of doing it only once here.
|
The integration tests caught a very critical regression (nice!). While fixing this, I saw that our implementation of |
|
I will do a second round of review tomorrow since the additional diff ended up being quite large after your approval @abeatrix . |
|
Just to be 100% sure, I ran VS Code with the local diff --- a/vscode/src/main.ts
+++ b/vscode/src/main.ts
@@ -753,6 +753,11 @@ const register = async (
platform.extensionClient.provide({ enterpriseContextFactory }),
])
disposables.push(extensionClientDispose)
+ for (const editor of vscode.window.visibleTextEditors) {
+ setInterval(() => {
+ console.log({ uri: editor.document.uri.toString(), text: editor.document.getText() })
+ }, 1000)
+ }and confirmed that the text contents reflect the latest version as I make changes to the document even if I reuse the |
While writing more tests, I discovered a surprising behavior that I wasn't able to reuse instances of `vscode.TextEditor`. This commit fixes this behavior.
olafurpg
force-pushed
the
olafurpg/nullish
branch
from
fa9db3d
to
fe020e8
Compare
olafurpg
commented
May 24, 2024
| } | ||
| viewColumn = vscode.ViewColumn.Active | ||
|
|
||
| // IMPORTANT(olafurpg): `edit` must be defined as a fat arrow. The tests |
There was a problem hiding this comment.
This issue took me almost an hr to debug. Makes me wonder what other latent bugs we have caused by usage of class methods over property fat arrows.
olafurpg
added a commit
to sourcegraph/jetbrains
that referenced
this pull request
May 24, 2024
This bumps Cody to a commit that includes this PR here sourcegraph/cody#4279 This PR fixes a tricky issue related to how `vscode.TextEditor.selection` works. Previously, the text editor selection was a constant, it never updated to reflect the latest selection of the document. This could have caused buggy behavior in scenarios like this: ```ts for (const editor of vscode.window.visibleTextEditors) { // editor.selection is correct await parseDocument(editor.document) // editor.selection is outdated because we received a // `textDocument/didChange` in the meantime } ```
olafurpg
added a commit
to sourcegraph/jetbrains
that referenced
this pull request
May 24, 2024
This bumps Cody to a commit that includes this PR here sourcegraph/cody#4279 This PR fixes a tricky issue related to how `vscode.TextEditor.selection` works. Previously, the text editor selection was a constant, it never updated to reflect the latest selection of the document. This could have caused buggy behavior in scenarios like this: ```ts for (const editor of vscode.window.visibleTextEditors) { // editor.selection is correct await parseDocument(editor.document) // editor.selection is outdated because we received a // `textDocument/didChange` in the meantime } ``` ## Test plan n/a <!-- All pull requests REQUIRE a test plan: https://sourcegraph.com/docs/dev/background-information/testing_principles Why does it matter? These test plans are there to demonstrate that are following industry standards which are important or critical for our customers. They might be read by customers or an auditor. There are meant be simple and easy to read. Simply explain what you did to ensure your changes are correct! Here are a non exhaustive list of test plan examples to help you: - Making changes on a given feature or component: - "Covered by existing tests" or "CI" for the shortest possible plan if there is zero ambiguity - "Added new tests" - "Manually tested" (if non trivial, share some output, logs, or screenshot) - Updating docs: - "previewed locally" - share a screenshot if you want to be thorough - Updating deps, that would typically fail immediately in CI if incorrect - "CI" - "locally tested" -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The PR #4277 was a lesson that we have very brittle code around dealing with document synchronization. This PR is an attempt to improve code health by
Test plan
See new test suite.