Test: Allow vscode.env.asExternalUri to return valid results for workspace URIs

[joaomoreno]

Refs: #124263

• anyOS @rebornix
• anyOS @weinand

Complexity: 3

Create Issue

Create Issue

---

Up until now, the vscode.env.asExternalUri API has been limited to http:, https: and ${appScheme}: URIs. It would throw an error if you give it any other URI. With #124263, any other URI is assumed to be a workspace URI and VS Code should return a system-openable URI which opens that workspace. For example, give it file:///path/to/existing/folder and you get something which you can paste on a browser location bar and it should open that folder in VS Code.

This API just went stable, so please test you can successfully use it without having enableProposedApi: true.

Create a sample extension. Then invoke that API and:

• Test that using http:, https: and ${appScheme}: works just as before
• Test that it never throws for schemes which VS Code can open as a workspace, eg file:. A good sample is vscode.env.asExternalUri(vscode.workspace.workspaceFolders[0]!.uri), which should produce a system-wide URI which opens the current workspace.
• Test that it throws for schemes unknown to VS Code, eg asdf:

[weinand]

Minor doc issues in vscode.d.ts:

• "Resolves a uri to form that is accessible externally.":
  • "Resolves a uri to a form ..."
  • "externally": externally to what? outside of VS Code?
  • "accessible": is the sense of "reachable"?
• "Extensions should not make any assumptions about the resulting uri and should not alter it in anyway." -> "... any way."

[weinand]

@joaomoreno asExternalUri-generated links (e.g. vscode-insiders:workspace?file%3A%2F%2F%2FUsers%2Fweinand%2FDesktop%2Furitest) work fine in Chrome, Edge, and Firefox. But Safari just googles for them. Do you know why?

[joaomoreno]

Unsure... The right way to test on macOS might just be on the Terminal with open URL.

[weinand]

@joaomoreno good idea, thanks!