Introduce DebugSession#workspaceFolder (#11090)

* add workspaceFolder to DebugSession model and adjust session creation
* Adapt DebugSession Tree Model to show in UI for multi root workspaces

Signed-off-by: Johannes Faltermeier <[email protected]>
Co-authored-by: colin-grant-work <[email protected]>

Contributed on behalf of STMicroelectronics

Author: jfaltermeier

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 - [Previous Changelogs](https://github.com/eclipse-theia/theia/tree/master/doc/changelogs/)
 
+## v.1.26.0
+
+- [plugin] Introduce `DebugSession#workspaceFolder` [#11090](https://github.com/eclipse-theia/theia/pull/11090) - Contributed on behalf of STMicroelectronics
+
 ## v1.25.0 - 4/28/2022
 
 [1.25.0 Milestone](https://github.com/eclipse-theia/theia/milestone/35)

packages/debug/src/browser/debug-session-contribution.ts

@@ -30,6 +30,7 @@ import { Channel, DebugAdapterPath } from '../common/debug-service';
 import { ContributionProvider } from '@theia/core/lib/common/contribution-provider';
 import { FileService } from '@theia/filesystem/lib/browser/file-service';
 import { DebugContribution } from './debug-contribution';
+import { WorkspaceService } from '@theia/workspace/lib/browser';
 
 /**
  * DebugSessionContribution symbol for DI.
@@ -114,6 +115,8 @@ export class DefaultDebugSessionFactory implements DebugSessionFactory {
     protected readonly fileService: FileService;
     @inject(ContributionProvider) @named(DebugContribution)
     protected readonly debugContributionProvider: ContributionProvider<DebugContribution>;
+    @inject(WorkspaceService)
+    protected readonly workspaceService: WorkspaceService;
 
     get(sessionId: string, options: DebugSessionOptions, parentSession?: DebugSession): DebugSession {
         const connection = new DebugSessionConnection(
@@ -135,7 +138,8 @@ export class DefaultDebugSessionFactory implements DebugSessionFactory {
             this.labelProvider,
             this.messages,
             this.fileService,
-            this.debugContributionProvider);
+            this.debugContributionProvider,
+            this.workspaceService);
     }
 
     protected getTraceOutputChannel(): OutputChannel | undefined {

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

@@ -214,7 +214,7 @@ export class DebugSessionManager {
                     }
                 }
 
-                const sessionId = await this.debug.createDebugSession(resolved.configuration);
+                const sessionId = await this.debug.createDebugSession(resolved.configuration, options.workspaceFolderUri);
                 return this.doStart(sessionId, resolved);
             } catch (e) {
                 if (DebugError.NotFound.is(e)) {

packages/debug/src/browser/debug-session.tsx

@@ -41,6 +41,7 @@ import { DebugFunctionBreakpoint } from './model/debug-function-breakpoint';
 import { FileService } from '@theia/filesystem/lib/browser/file-service';
 import { DebugContribution } from './debug-contribution';
 import { waitForEvent } from '@theia/core/lib/common/promise-util';
+import { WorkspaceService } from '@theia/workspace/lib/browser';
 
 export enum DebugState {
     Inactive,
@@ -79,7 +80,8 @@ export class DebugSession implements CompositeTreeElement {
         protected readonly labelProvider: LabelProvider,
         protected readonly messages: MessageClient,
         protected readonly fileService: FileService,
-        protected readonly debugContributionProvider: ContributionProvider<DebugContribution>
+        protected readonly debugContributionProvider: ContributionProvider<DebugContribution>,
+        protected readonly workspaceService: WorkspaceService,
     ) {
         this.connection.onRequest('runInTerminal', (request: DebugProtocol.RunInTerminalRequest) => this.runInTerminal(request));
         this.connection.onDidClose(() => {
@@ -747,10 +749,14 @@ export class DebugSession implements CompositeTreeElement {
     }
 
     get label(): string {
+        const suffixes = [];
         if (InternalDebugSessionOptions.is(this.options) && this.options.id) {
-            return this.configuration.name + ' (' + (this.options.id + 1) + ')';
+            suffixes.push(String(this.options.id + 1));
         }
-        return this.configuration.name;
+        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(' - ')})`;
     }
 
     get visible(): boolean {

packages/debug/src/common/debug-service.ts

@@ -100,9 +100,10 @@ export interface DebugService extends Disposable {
     /**
      * Creates a new [debug adapter session](#DebugAdapterSession).
      * @param config The resolved [debug configuration](#DebugConfiguration).
+     * @param workspaceFolderUri The worspace folder for this sessions or undefined when folderless
      * @returns The identifier of the created [debug adapter session](#DebugAdapterSession).
      */
-    createDebugSession(config: DebugConfiguration): Promise<string>;
+    createDebugSession(config: DebugConfiguration, workspaceFolderUri: string | undefined): Promise<string>;
 
     /**
      * Stop a running session for the given session id.

packages/debug/src/node/debug-service-impl.ts

@@ -65,7 +65,7 @@ export class DebugServiceImpl implements DebugService {
     }
 
     protected readonly sessions = new Set<string>();
-    async createDebugSession(config: DebugConfiguration): Promise<string> {
+    async createDebugSession(config: DebugConfiguration, _workspaceFolderUri?: string): Promise<string> {
         const session = await this.sessionManager.create(config, this.registry);
         this.sessions.add(session.id);
         return session.id;

packages/plugin-ext/src/common/plugin-api-rpc.ts

@@ -1701,7 +1701,7 @@ export interface DebugExt {
         debugConfiguration: theia.DebugConfiguration
     ): Promise<theia.DebugConfiguration | undefined | null>;
 
-    $createDebugSession(debugConfiguration: theia.DebugConfiguration): Promise<string>;
+    $createDebugSession(debugConfiguration: theia.DebugConfiguration, workspaceFolder: string | undefined): Promise<string>;
     $terminateDebugSession(sessionId: string): Promise<void>;
     $getTerminalCreationOptions(debugType: string): Promise<TerminalOptionsExt | undefined>;
 }

packages/plugin-ext/src/main/browser/debug/debug-main.ts

@@ -54,6 +54,7 @@ import { DebugConsoleSession } from '@theia/debug/lib/browser/console/debug-cons
 import { ContributionProvider } from '@theia/core/lib/common';
 import { DebugContribution } from '@theia/debug/lib/browser/debug-contribution';
 import { ConnectionImpl } from '../../../common/connection';
+import { WorkspaceService } from '@theia/workspace/lib/browser';
 
 export class DebugMainImpl implements DebugMain, Disposable {
     private readonly debugExt: DebugExt;
@@ -73,6 +74,7 @@ export class DebugMainImpl implements DebugMain, Disposable {
     private readonly fileService: FileService;
     private readonly pluginService: HostedPluginSupport;
     private readonly debugContributionProvider: ContributionProvider<DebugContribution>;
+    private readonly workspaceService: WorkspaceService;
 
     private readonly debuggerContributions = new Map<string, DisposableCollection>();
     private readonly configurationProviders = new Map<number, DisposableCollection>();
@@ -95,6 +97,7 @@ export class DebugMainImpl implements DebugMain, Disposable {
         this.debugContributionProvider = container.getNamed(ContributionProvider, DebugContribution);
         this.fileService = container.get(FileService);
         this.pluginService = container.get(HostedPluginSupport);
+        this.workspaceService = container.get(WorkspaceService);
 
         const fireDidChangeBreakpoints = ({ added, removed, changed }: BreakpointsChangeEvent<SourceBreakpoint | FunctionBreakpoint>) => {
             this.debugExt.$breakpointsDidChange(
@@ -155,7 +158,8 @@ export class DebugMainImpl implements DebugMain, Disposable {
             },
             this.fileService,
             terminalOptionsExt,
-            this.debugContributionProvider
+            this.debugContributionProvider,
+            this.workspaceService,
         );
 
         const toDispose = new DisposableCollection(

packages/plugin-ext/src/main/browser/debug/plugin-debug-adapter-contribution.ts

@@ -37,9 +37,9 @@ export class PluginDebugAdapterContribution {
         return this.description.label;
     }
 
-    async createDebugSession(config: DebugConfiguration): Promise<string> {
+    async createDebugSession(config: DebugConfiguration, workspaceFolder: string | undefined): Promise<string> {
         await this.pluginService.activateByDebug('onDebugAdapterProtocolTracker', config.type);
-        return this.debugExt.$createDebugSession(config);
+        return this.debugExt.$createDebugSession(config, workspaceFolder);
     }
 
     async terminateDebugSession(sessionId: string): Promise<void> {

packages/plugin-ext/src/main/browser/debug/plugin-debug-service.ts

@@ -264,14 +264,14 @@ export class PluginDebugService implements DebugService {
         return snippets;
     }
 
-    async createDebugSession(config: DebugConfiguration): Promise<string> {
+    async createDebugSession(config: DebugConfiguration, workspaceFolder: string | undefined): Promise<string> {
         const contributor = this.contributors.get(config.type);
         if (contributor) {
-            const sessionId = await contributor.createDebugSession(config);
+            const sessionId = await contributor.createDebugSession(config, workspaceFolder);
             this.sessionId2contrib.set(sessionId, contributor);
             return sessionId;
         } else {
-            return this.delegated.createDebugSession(config);
+            return this.delegated.createDebugSession(config, workspaceFolder);
         }
     }