Uri.parse doesnt render link correctly if the uri has a space in it

[ctf0]

Version: 1.53.0-insider
Commit: 4a875e23d20b64504a818834f3fa4c40adb8d480
Date: 2020-12-21T12:32:43.927Z
Electron: 11.1.0
Chrome: 87.0.4280.88
Node.js: 12.18.3
V8: 8.7.220.29-electron.0
OS: Darwin x64 19.6.0

Steps to Reproduce:

based on the docs
i have an ext that have the same setup but with a DoucmentLink instead of hover, which was working perfectly but now instead of getting a link i get the text

[remove "spatie/laravel-backup"](command:gotoPackage.removePackage?[{"cmnd":"composer remove spatie/laravel-backup","pkg":"spatie/laravel-backup"}] "Execute command gotoPackage.removePackage") (cmd + click)

and here is the console log

am not sure if the api has changed or is it a genuine bug 😢

Does this issue occur when all extensions are disabled?: No

[jrieken]

Please provide a simple repo case. I have tried with the provider below and everything is working fine

  vscode.languages.registerDocumentLinkProvider('*', new class implements vscode.DocumentLinkProvider {
        provideDocumentLinks(document: vscode.TextDocument): vscode.DocumentLink[] {
            return [
                new vscode.DocumentLink(new vscode.Range(0, 0, 1, 0), vscode.Uri.parse('command:extension.helloWorld'))
            ]
        }
    })

[ctf0]

u can try with the extension provided above, its basically a

• link provider
  https://github.com/ctf0/vscode-goto-package/blob/d8b48917abd97fef5e9f499feb24335697b563b7/src/linkProvider.ts#L29

• calling a function that create the document link
  https://github.com/ctf0/vscode-goto-package/blob/d8b48917abd97fef5e9f499feb24335697b563b7/src/utils.ts#L51-L57

• that calls a cmnd
  https://github.com/ctf0/vscode-goto-package/blob/e458dd0f45f053e29ee104284823e3f63c1a4b73/src/extension.ts#L23-L28

i've even tried with an old version of the extension and still give the same result, whats really strange is the other 2 normal links "open file, open url" works without any problems.

also plz note that am using the second example of the docs where we pass arguments to the cmnd, maybe thats the problem am not sure.

[jrieken]

u can try with the extension provided above, its basically a

Sorry, but asking you to distill a repo case from that

[ctf0]

sure np, i will ping you once done.

[ctf0]

https://github.com/ctf0/cnbd-uri-test, same ext downsized to bare min

steps

• yarn
• run debug
• open package.json
• hover a dependency

[ctf0]

finally found the issue.

if the uri have an empty space in it, it wont render correctly and will show the text instead.
this is related to the DocumentLink api, not Commands URIs api ex.

[resources/lang/en.json](vscode-insiders://ctf0.laravel-goto-lang/Users/xxx/test/resources/lang/en.json?hello world)

note hello world

[remove "spatie/laravel-backup"](command:gotoPackage.removePackage?[{"cmnd":"composer remove spatie/laravel-backup","pkg":"spatie/laravel-backup"}] "Execute command gotoPackage.removePackage")

note composer remove

---

removing the empty spaces will render the link as expected.

[jeanp413]

@jrieken I took a look at this and found that this is a regression from #112670
Not sure if it would be better to revert that commit or #85930 would be a better fix for this

[jrieken]

@ctf0 This is confusing. How does #113328 (comment) relate to the document link provider API? That comment talks about markdown link syntax which seems unrelated to that API

[ctf0]

@jrieken actually u can use the same logic with any api that use vscode.Uri.parse & u r correct, the docs only mention MarkdownString but in reality its applicable with lots of other apis like document link.

so to thumbs up, i believe the issue is more related to vscode.Uri.parse in general no matter where u use it & not document link or MarkdownString in specific.

[ctf0]

a temp solution for anyone having this issue is to use encodeURI which will escape the empty space & decodeURI inside the UriHandler.

[jrieken]

This get more confusing. The make zero sense to me, Uri.parse doesn't render anything. Can't you just provide simple steps like:

1. Doing xyz
2. expecting foo
3. seeing bar

[ctf0]

Can't you just provide simple steps like:

• try this

let args  = encodeURIComponent(JSON.stringify([{cmnd: 'hello world'}]))

new vscode.DocumentLink(new vscode.Range(0, 0, 1, 0), vscode.Uri.parse(`command:extension.helloWorld?${args}`))

• to fix the issue, wrap 'hello world' with encodeURI