-
Notifications
You must be signed in to change notification settings - Fork 291
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Agent: handle document URIs with exclamation marks (#2983)
Previously, the agent threw an error for `textDocument/*` notificattions when the URI included an exclamation mark. The error was thrown to preserve an important variant that we can always parse and render a URI back into the original string ```ts vscode.Uri.parse(uri).toString() === uri ``` This variant was getting violated when the JB plugin sent document URIs that included an exclamation mark in them, for example: ``` file:///Users/com.jetbrains/ideaIC-2022.1-sources.jar!/com/intellij/RequiresBackgroundThread.java ``` The `!` got encoded as `%21`. This PR "fixes" the problem by mutating the `uri: string` property to get the `Uri.toString()` formatted URI. t's not a super satisfying solution, it would be more desirable if we can get `vscode.Uri.parse(..).toString()` to be a safe roundtrip. However, this change gets the most important job done: we preserve the invariant. ## Test plan See updated tests. <!-- Required. See https://sourcegraph.com/docs/dev/background-information/testing_principles. -->
- Loading branch information
Showing
4 changed files
with
25 additions
and
8 deletions.
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
import { describe, expect, it } from 'vitest' | ||
import { ProtocolTextDocumentWithUri } from './TextDocumentWithUri' | ||
|
||
describe('TextDocumentWithUri', () => { | ||
it('handles URIs with exclamation marks', () => { | ||
const uri = | ||
'file:///Users/com.jetbrains/ideaIC-2022.1-sources.jar!/com/intellij/RequiresBackgroundThread.java' | ||
const textDocument = ProtocolTextDocumentWithUri.fromDocument({ uri }) | ||
expect(textDocument.uri.toString()).toStrictEqual(textDocument.underlying.uri) | ||
expect(textDocument.uri.toString()).toStrictEqual( | ||
'file:///Users/com.jetbrains/ideaIC-2022.1-sources.jar%21/com/intellij/RequiresBackgroundThread.java' | ||
) | ||
}) | ||
}) |
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