Introduce DebugSession#workspaceFolder

[jfaltermeier]

What it does

Fixes #10023

• Adds the missing workspaceFolderUri to the DebugSession API
• Adjust code to create the session including workspaceFolderUri
• The existing DebugSessionManager was already honoring the workspace folder as far as I could see (-> e.g. when executing pre launch tasks:

  theia/packages/debug/src/browser/debug-session-manager.ts

  Line 211 in 7f5047f

  const taskRun = await this.runTask(options.workspaceFolderUri, resolved.configuration.preLaunchTask, true);

  ) so only the session object creation itself was adjusted
• Adds the workspacefolder to the DebugSession's UI label, in case we have a multi-root workspace (and multiple running debug sessions, as otherwise the ui node is hidden)

VS-Code UI (esm-i was the set workspace-folder. This is not shown in the Top, because this is a launch without a set ws folder):

Theia UI (workspace folder was called java):

Contributed on behalf of STMicroelectronics

Signed-off-by: Johannes Faltermeier [email protected]

How to test

I've created a small VSCode extension that tracks the creation of debug sessions and logs the workspace folder of a session:
https://github.com/jfaltermeier/vscode-debug-playground
https://github.com/jfaltermeier/vscode-debug-playground/blob/main/src/extension.ts
You may get this test extension from https://github.com/jfaltermeier/vscode-debug-playground/releases/tag/0.0.1

• start Theia Browser Example with above extension
• debug any application (I was testing with a java application)

This should create a log message similar to this one:

root INFO [hosted-plugin: 67589] ES : DebugAdapterTracker: DebugSession created with workspaceFolder: file:///home/johannes/git/java-sample

Without the changes, the worspaceFolder was undefined all the time

root INFO [hosted-plugin: 70803] ES : DebugAdapterTracker: DebugSession created with workspaceFolder: undef

• For testing the UI label, create a multi root workspace and start multiple debug sessions that stop at a breakpoint.
• The session label will show the wsfolder in brackets

Review checklist

• As an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

• As a reviewer, I agree to behave in accordance with the review guidelines

[colin-grant-work]

It does not appear that the implementation of the createDebugSession method on the DebugServiceImpl has been updated to handle the workspaceFolderUri. Is that intentional?

[jfaltermeier]

Thank you. No, this was an oversight, since this value is not needed there.
In the plain Theia API the ws folder is taken from the DebugSessionOptions and we only need it for vs code compatibility.
I've added the parameter as _workspaceFolderUri?

[colin-grant-work]

My fault, but in my suggested snippet, I omitted a space between this.configuration.name and (${suffixes.join(' - ')}). Apart from that minor UI issue, this looks good to me, so if you fix that, I'll approve.

[colin-grant-work]

Suggested change

	const showWSFolderInLabel = this.workspaceService.isMultiRootWorkspaceOpened && this.options.workspaceFolderUri;
	if (showWSFolderInLabel) {
	const wsFolder = this.labelProvider.getName(new URI(this.options.workspaceFolderUri));
	if (InternalDebugSessionOptions.is(this.options) && this.options.id) {
	return this.configuration.name + ' (' + (this.options.id + 1) + ' - ' + wsFolder + ')';
	}
	return this.configuration.name + ' (' + wsFolder + ')';
	} else {
	if (InternalDebugSessionOptions.is(this.options) && this.options.id) {
	return this.configuration.name + ' (' + (this.options.id + 1) + ')';
	}
	return this.configuration.name;
	const suffixes = [];
	if (InternalDebugSessionOptions.is(this.options) && this.options.id !== undefined) {
	suffixes.push(String(this.options.id + 1));
	}
	if (this.workspaceService.isMultiRootWorkspaceOpened && this.options.workspaceFolderUri) {
	suffixes.push(this.labelProvider.getName(new URI(this.options.workspaceFolderUri)));
	}
	return suffixes.length === 0 ? this.configuration.name : this.configuration.name + `(${suffixes.join(' - ')})`;

The WorkspaceService fields about multi-root workspaces are a bit counterintuitive. The code above will show the workspace root if the workspace is defined in a file, even if there is only a single root. I think that's fine behavior, but if we want to display the root only when there are actually multiple roots in the workspace, then this.workspaceService.tryGetRoots().length > 1 is the most informative check.

[jfaltermeier]

I've added the space between configuration name and the joined suffixes and rebased on current master.
I haven't changed the logic for checking whether we have a multiroot-workspace. I also think that it is fine to display the suffix in a multi-root environment with just one root.

[colin-grant-work]

Looks good to me. 👍