[Testing]: Get selected default Run/Debug TestProfile(s)

[mxschmitt]

Is it possible to get the currently selected default run profile(s)? In this case the first and last.

We tried RunProfile.isDefault, but thats not getting the needed updates from the user when he selects/de-selects.

Thanks!

[connor4312]

I propose the following additional APIs:

	export namespace tests {
		/**
		 * The list of {@link TestRunProfile} the user has selected as their default
		 * profiles when running tests.
		 */
		// implementors's note: for a given extension, this shows only the
		// TestRunProfiles that extension has created
		export let activeTestRunProfiles: readonly TestRunProfile[];

		/**
		 * Fired when a user has changed their default test run profiles. The
		 * new value is also reflected in {@link activeTestRunProfiles}.
		 */
		export const onDidChangeActiveTestRunProfiles: Event<readonly TestRunProfile[]>;
	}

[jrieken]

Sync-Feedback

• have TestRunProfile.isSelected
• have TestRunProfile#onDidSelect

[connor4312]

Updated API, will be available to try out in the next Insiders:

declare module 'vscode' {
	export interface TestRunProfile {
		/**
		 * Whether this profile is currently selected as a default by the user
		 */
		readonly isSelected: boolean;

		/**
		 * Fired when a user has changed whether this is a selected profile. The
		 * event contains the new value of {@link isSelected}
		 */
		onDidChangeSelected: Event<boolean>;
	}
}

@mxschmitt please try it out and let us know if it works for you!

[mxschmitt]

I tried it out and it works for us!

(We just check then if isSelected is true rather than attaching to the event listener.)

[jrieken]

@connor4312 is this only about the default run profile or generally when selecting a profile w/o running it?

[connor4312]

This is about the profile the user has selected as their chosen profile to be used when clicking the "run" or "debug" buttons.

[connor4312]

Also, got in-person confirmation last week from @mxschmitt that this API is good for playwright :)

[jrieken]

So, I need to go through "Select Default", right? I am confident this API is working but I wonder if the name and/or commend should be refined to express that this is only about the default

[connor4312]

Yea, that's right. The confusing thing is that we already has an extension-definable isDefault property on the profile to control whether, if a user has not manually selected profiles before, that one is the default.

One kind of clever thing we could do, though it's questionably breaking, is to have isDefault start being a managed property, set it when the user selection updates, and update the selection when it's updated, rather than introducing a new property...

[jrieken]

I like that

[connor4312]

So in that case I would revise this proposal with only the additional property in the .d.ts, along with docs changes:

declare module 'vscode' {
	export interface TestRunProfile {
		/**
		 * Fired when a user has changed whether this is a default profile. The
		 * event contains the new value of {@link isDefault}
		 */
		onDidChangeDefault: Event<boolean>;
	}
}