Remote queries: Open query file/text from webview

[shati-patel]

Adds some interaction to these buttons in the remote queries webview:

• The first one opens the query file that was run, if it exists (similar to what we do in the local results view).
• The second one opens the exact query text that was run (in a virtual "read-only" file).

Follow up

• Consolidate the remote-query and codeql text providers.
• Once Be nicer about where to open the results webview #1037 is merged, extract that behaviour so it is used wherever we are opening editors.

Checklist

N/A: Still an internal-only feature. No user-visible changes.

• CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
• Issues have been created for any UI or other user-facing changes made by this pull request.
• @github/docs-content-codeql has been cc'd in all issues for UI or other user-facing changes made by this pull request.

[shati-patel]

Latest commit adds a temporary file containing exact query text.

In the local version of showing query text, we create a "text provider" and write to a read-only document:

vscode-codeql/extensions/ql-vscode/src/query-history.ts

Lines 343 to 356 in 6195c65

	// displays query text in a read-only document
	vscode.workspace.registerTextDocumentContentProvider('codeql', {
	provideTextDocumentContent(
	uri: vscode.Uri
	): vscode.ProviderResult<string> {
	const params = new URLSearchParams(uri.query);
	return (
	(JSON.parse(params.get('isQuickEval') || '')
	? SHOW_QUERY_TEXT_QUICK_EVAL_MSG
	: SHOW_QUERY_TEXT_MSG) + params.get('queryText')
	);
	},
	});

I couldn't work out how to re-use that code, or just import the relevant parts (creating a read-only doc), so I've gone with a more lightweight approach of writing to a temporary file for now. Happy to adjust if anyone has suggestions! 🙇🏽‍♀️

[aeisenberg]

So, this creates the temp file before a user ever tries to open it (and the user may never try to do so). Also, this file may get cleaned up if the user restarts vscode. Can we ever get a situation where the file is removed before someone tries to open it (eg- after a restart)?

Maybe it's safer to generate this file only when requested.

[shati-patel]

Moved to a different approach (using a virtual file), so this temporary file no longer exists! ☁️

(There's still the general problem that remote query data doesn't persist across restarts, but that's beyond this PR 😅 We have a separate issue for that somewhere)

[charisk]

In the local version of showing query text, we create a "text provider" and write to a read-only document

Do you want to have a look at that together?

[shati-patel]

In the local version of showing query text, we create a "text provider" and write to a read-only document

Do you want to have a look at that together?

We worked through this using the existing query-history.ts example and the VS Code virtual doc sample as a guide 🐄 🎉

I've registered a new "remote-query" text provider to let us write to a readonly file. Ideally, I'd like to slightly refactor the QueryHistoryManager code, so that we use a single codeql text provider everywhere (instead of registering two separate ones). To avoid this PR getting too big, I'm happy to do that in a separate PR, unless there's a more urgent need to do it all together here!

[charisk]

Looks great! Only super minor things.

[charisk]

Lets make sure the styling is correct for the new buttons.

[aeisenberg]

Eventually, it would be nice to do something like #1037, but that can happen later. Once #1037 gets in, we can work on extracting the behaviour so it is used wherever we are opening editors.

[aeisenberg]

Is this read-only? It's possible to make happen, but I forget how.

[shati-patel]

Indeed, it's read-only! That's what the remote-query prefix and the corresponding provideTextDocumentContent function do 😃