Consider unify the refresh action for test explorer

[jdneo]

API Proposal: #139737 (comment)

Currently since the test explorer does not have refresh action by default. Extensions might contribute their own implementation for refresh, and thus, cause some UX conflicts. For example:

If user installed both Java and Python extension, the user will see two refresh button in the test explorer:

• The one in the navigation bar is contributed by Python
• The one in the overflow button is contributed by Java

And if Python extension is not activated, click on the navigation bar refresh button will cause an error.

This issue can be resolved if VS Code can unify the refresh action from the platform level

See: microsoft/vscode-java-test#1348

[nickzhums]

@luabud for awareness, this seems to be affecting users who install both Java and Python extension

[connor4312]

Yep, agreed. I suggest an API such as this:

	export interface TestController {
		/**
		 * If this method is present, a refresh button will be present in the
		 * UI, and this method will be invoked when it's clicked. When called,
		 * the extension should scan the workspace for any new, changed, or
		 * removed tests.
		 *
		 * It's recommended that extensions try to update tests in realtime, using
		 * a {@link FileWatcher} for example, and use this method as a fallback.
		 *
		 * @returns A thenable that resolves when tests have been refreshed.
		 */
		refreshHandler: (() => Thenable<void> | void) | undefined;
	}

[luabud]

cc @karthiknadig

[connor4312]

The API is shipping in tomorrow's Insiders. Please give it a shot! It's a simple API and should be finalized next iteration.

Example of adopting it in the sample: microsoft/vscode-extension-samples@2f1d70f

[karthiknadig]

@connor4312 Can this API and the UI support cancellation? Currently we show beaker-stop codicon when refreshing. We hide the refresh icon and show beaker-stop when triggered it cancels the refresh.

[connor4312]

@karthiknadig added

[karthiknadig]

@connor4312 Should this API be updated to take in cancellation token as well?

vscode/src/vscode-dts/vscode.proposed.testRefresh.d.ts

Line 35 in fe0e9a9

export function createTestController(id: string, label: string, refreshHandler?: () => Thenable<void> | void): TestController;

the API implementation here seems to be taking it:

vscode/src/vs/workbench/api/common/extHost.api.impl.ts

Line 357 in fe0e9a9

createTestController(provider, label, refreshHandler?: (token: vscode.CancellationToken) => Thenable<void> | void) {

[connor4312]

Oops, added that too