@theia/debug 1.26.0 → 1.27.0-next.10

package/src/browser/editor/debug-breakpoint-widget.tsx

@@ -214,7 +214,7 @@ export class DebugBreakpointWidget implements Disposable {
             this._input.getControl().setValue(this._values[this.context] || '');
         }
         ReactDOM.render(<SelectComponent
-            value={this.context} onChange={this.updateInput}
+            defaultValue={this.context} onChange={this.updateInput}
             options={[
                 { value: 'condition', label: nls.localizeByDefault('Expression') },
                 { value: 'hitCondition', label: nls.localizeByDefault('Hit Count') },

package/src/browser/view/debug-configuration-select.tsx

@@ -0,0 +1,234 @@
+/********************************************************************************
+ * Copyright (C) 2021 Ericsson and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import URI from '@theia/core/lib/common/uri';
+import * as React from '@theia/core/shared/react';
+import { DebugConfigurationManager } from '../debug-configuration-manager';
+import { DebugSessionOptions, InternalDebugSessionOptions } from '../debug-session-options';
+import { SelectComponent, SelectOption } from '@theia/core/lib/browser/widgets/select-component';
+import { QuickInputService } from '@theia/core/lib/browser';
+import { nls } from '@theia/core/lib/common/nls';
+
+interface DynamicPickItem { label: string, configurationType: string, request: string, providerType: string }
+
+export interface DebugConfigurationSelectProps {
+    manager: DebugConfigurationManager,
+    quickInputService: QuickInputService,
+    isMultiRoot: boolean
+}
+
+export interface DebugProviderSelectState {
+    providerTypes: string[],
+    currentValue: string | undefined
+}
+
+export class DebugConfigurationSelect extends React.Component<DebugConfigurationSelectProps, DebugProviderSelectState> {
+    protected static readonly SEPARATOR = '──────────';
+    protected static readonly PICK = '__PICK__';
+    protected static readonly NO_CONFIGURATION = '__NO_CONF__';
+    protected static readonly ADD_CONFIGURATION = '__ADD_CONF__';
+
+    private readonly selectRef = React.createRef<SelectComponent>();
+    private manager: DebugConfigurationManager;
+    private quickInputService: QuickInputService;
+
+    constructor(props: DebugConfigurationSelectProps) {
+        super(props);
+        this.manager = props.manager;
+        this.quickInputService = props.quickInputService;
+        this.state = {
+            providerTypes: [],
+            currentValue: undefined
+        };
+        this.manager.onDidChangeConfigurationProviders(() => {
+            this.refreshDebugConfigurations();
+        });
+    }
+
+    override componentDidMount(): void {
+        this.refreshDebugConfigurations();
+    }
+
+    override render(): React.ReactNode {
+        return <SelectComponent
+            options={this.renderOptions()}
+            defaultValue={this.currentValue}
+            onChange={option => this.setCurrentConfiguration(option)}
+            onFocus={() => this.refreshDebugConfigurations()}
+            onBlur={() => this.refreshDebugConfigurations()}
+            ref={this.selectRef}
+        />;
+    }
+
+    protected get currentValue(): string {
+        const { current } = this.manager;
+        return current ? InternalDebugSessionOptions.toValue(current) : DebugConfigurationSelect.NO_CONFIGURATION;
+    }
+
+    protected readonly setCurrentConfiguration = (option: SelectOption) => {
+        const value = option.value;
+        if (!value) {
+            return false;
+        } else if (value === DebugConfigurationSelect.ADD_CONFIGURATION) {
+            this.manager.addConfiguration();
+        } else if (value.startsWith(DebugConfigurationSelect.PICK)) {
+            const providerType = this.parsePickValue(value);
+            this.selectDynamicConfigFromQuickPick(providerType);
+        } else {
+            const { name, type, request, workspaceFolderUri, providerType } = InternalDebugSessionOptions.parseValue(value);
+            this.manager.current = this.manager.find(
+                { name, type, request },
+                workspaceFolderUri,
+                providerType === 'undefined' ? undefined : providerType
+            );
+        }
+    };
+
+    protected toPickValue(providerType: string): string {
+        return DebugConfigurationSelect.PICK + providerType;
+    }
+
+    protected parsePickValue(value: string): string {
+        return value.slice(DebugConfigurationSelect.PICK.length);
+    }
+
+    protected async resolveDynamicConfigurationPicks(providerType: string): Promise<DynamicPickItem[]> {
+        const configurationsOfProviderType =
+            (await this.manager.provideDynamicDebugConfigurations())[providerType];
+
+        if (!configurationsOfProviderType) {
+            return [];
+        }
+
+        return configurationsOfProviderType.map(configuration => ({
+            label: configuration.name,
+            configurationType: configuration.type,
+            request: configuration.request,
+            providerType
+        }));
+    }
+
+    protected async selectDynamicConfigFromQuickPick(providerType: string): Promise<void> {
+        const picks: DynamicPickItem[] = await this.resolveDynamicConfigurationPicks(providerType);
+
+        if (picks.length === 0) {
+            return;
+        }
+
+        const selected: DynamicPickItem | undefined = await this.quickInputService.showQuickPick(
+            picks,
+            {
+                placeholder: nls.localizeByDefault('Select Launch Configuration')
+            }
+        );
+
+        if (!selected) {
+            return;
+        }
+
+        const selectedConfiguration = {
+            name: selected.label,
+            type: selected.configurationType,
+            request: selected.request
+        };
+        this.manager.current = this.manager.find(selectedConfiguration, undefined, selected.providerType);
+        this.refreshDebugConfigurations();
+    }
+
+    protected refreshDebugConfigurations = async () => {
+        const configsPerType = await this.manager.provideDynamicDebugConfigurations();
+        const providerTypes = [];
+        for (const [ type, configurations ] of Object.entries(configsPerType)) {
+            if (configurations.length > 0) {
+                providerTypes.push(type);
+            }
+        }
+        this.selectRef.current!.value = this.currentValue;
+        this.setState({ providerTypes, currentValue: this.currentValue });
+    };
+
+    protected renderOptions(): SelectOption[] {
+        const options: SelectOption[] = [];
+
+        // Add non dynamic debug configurations
+        for (const config of this.manager.all) {
+            const value = InternalDebugSessionOptions.toValue(config);
+            options.push({
+                value,
+                label: this.toName(config, this.props.isMultiRoot)
+            });
+        }
+
+        // Add recently used dynamic debug configurations
+        const { recentDynamicOptions } = this.manager;
+        if (recentDynamicOptions.length > 0) {
+            if (options.length > 0) {
+                options.push({
+                    separator: true
+                });
+            }
+            for (const dynamicOption of recentDynamicOptions) {
+                const value = InternalDebugSessionOptions.toValue(dynamicOption);
+                options.push({
+                    value,
+                    label: this.toName(dynamicOption, this.props.isMultiRoot) + ' (' + dynamicOption.providerType + ')'
+                });
+            }
+        }
+
+        // Placing a 'No Configuration' entry enables proper functioning of the 'onChange' event, by
+        // having an entry to switch from (E.g. a case where only one dynamic configuration type is available)
+        if (options.length === 0) {
+            const value = DebugConfigurationSelect.NO_CONFIGURATION;
+            options.push({
+                value,
+                label: nls.localizeByDefault('No Configurations')
+            });
+        }
+
+        // Add dynamic configuration types for quick pick selection
+        const types = this.state.providerTypes;
+        if (types.length > 0) {
+            options.push({
+                separator: true
+            });
+            for (const type of types) {
+                const value = this.toPickValue(type);
+                options.push({
+                    value,
+                    label: type + '...'
+                });
+            }
+        }
+
+        options.push({
+            separator: true
+        });
+        options.push({
+            value: DebugConfigurationSelect.ADD_CONFIGURATION,
+            label: nls.localizeByDefault('Add Configuration...')
+        });
+
+        return options;
+    }
+
+    protected toName({ configuration, workspaceFolderUri }: DebugSessionOptions, multiRoot: boolean): string {
+        if (!workspaceFolderUri || !multiRoot) {
+            return configuration.name;
+        }
+        return `${configuration.name} (${new URI(workspaceFolderUri).path.base})`;
+    }
+}

package/src/browser/view/debug-configuration-widget.tsx

@@ -14,20 +14,18 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 // *****************************************************************************
 
+import { ReactWidget, QuickInputService } from '@theia/core/lib/browser';
+import { CommandRegistry, Disposable, MessageService } from '@theia/core/lib/common';
+import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
 import * as React from '@theia/core/shared/react';
-import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
-import { CommandRegistry, Disposable } from '@theia/core/lib/common';
-import { SelectComponent, SelectOption } from '@theia/core/lib/browser/widgets/select-component';
-import URI from '@theia/core/lib/common/uri';
-import { ReactWidget } from '@theia/core/lib/browser';
 import { WorkspaceService } from '@theia/workspace/lib/browser';
 import { DebugConsoleContribution } from '../console/debug-console-contribution';
 import { DebugConfigurationManager } from '../debug-configuration-manager';
+import { DebugCommands } from '../debug-frontend-application-contribution';
 import { DebugSessionManager } from '../debug-session-manager';
 import { DebugAction } from './debug-action';
+import { DebugConfigurationSelect } from './debug-configuration-select';
 import { DebugViewModel } from './debug-view-model';
-import { DebugSessionOptions } from '../debug-session-options';
-import { DebugCommands } from '../debug-frontend-application-contribution';
 import { nls } from '@theia/core/lib/common/nls';
 
 @injectable()
@@ -48,9 +46,15 @@ export class DebugConfigurationWidget extends ReactWidget {
     @inject(DebugConsoleContribution)
     protected readonly debugConsole: DebugConsoleContribution;
 
+    @inject(QuickInputService)
+    protected readonly quickInputService: QuickInputService;
+
     @inject(WorkspaceService)
     protected readonly workspaceService: WorkspaceService;
 
+    @inject(MessageService)
+    protected readonly messageService: MessageService;
+
     @postConstruct()
     protected init(): void {
         this.addClass('debug-toolbar');
@@ -74,68 +78,33 @@ export class DebugConfigurationWidget extends ReactWidget {
         this.stepRef.focus();
         return true;
     }
+
     protected stepRef: DebugAction | undefined;
     protected setStepRef = (stepRef: DebugAction | null) => this.stepRef = stepRef || undefined;
 
     render(): React.ReactNode {
-        const { options } = this;
         return <React.Fragment>
             <DebugAction run={this.start} label={nls.localizeByDefault('Start Debugging')} iconClass='debug-start' ref={this.setStepRef} />
-            <SelectComponent options={options} value={this.currentValue} onChange={option => this.setCurrentConfiguration(option)} />
+            <DebugConfigurationSelect
+                manager={this.manager}
+                quickInputService={this.quickInputService}
+                isMultiRoot={this.workspaceService.isMultiRootWorkspaceOpened}
+            />
             <DebugAction run={this.openConfiguration} label={nls.localizeByDefault('Open {0}', '"launch.json"')}
                 iconClass='settings-gear' />
             <DebugAction run={this.openConsole} label={nls.localizeByDefault('Debug Console')} iconClass='terminal' />
         </React.Fragment>;
     }
-    protected get currentValue(): string {
-        const { current } = this.manager;
-        return current ? this.toValue(current) : '__NO_CONF__';
-    }
-    protected get options(): SelectOption[] {
-        const items: SelectOption[] = Array.from(this.manager.all).map(option => ({
-            value: this.toValue(option),
-            label: this.toName(option)
-        }));
-        if (items.length === 0) {
-            items.push({
-                value: '__NO_CONF__',
-                label: nls.localizeByDefault('No Configurations')
-            });
-        }
-        items.push({
-            separator: true
-        });
-        items.push({
-            value: '__ADD_CONF__',
-            label: nls.localizeByDefault('Add Configuration...')
-        });
-        return items;
-    }
-    protected toValue({ configuration, workspaceFolderUri }: DebugSessionOptions): string {
-        if (!workspaceFolderUri) {
-            return configuration.name;
-        }
-        return configuration.name + '__CONF__' + workspaceFolderUri;
-    }
-    protected toName({ configuration, workspaceFolderUri }: DebugSessionOptions): string {
-        if (!workspaceFolderUri || !this.workspaceService.isMultiRootWorkspaceOpened) {
-            return configuration.name;
-        }
-        return configuration.name + ' (' + new URI(workspaceFolderUri).path.base + ')';
-    }
 
-    protected readonly setCurrentConfiguration = (option: SelectOption) => {
-        const value = option.value!;
-        if (value === '__ADD_CONF__') {
-            this.manager.addConfiguration();
-        } else {
-            const [name, workspaceFolderUri] = value.split('__CONF__');
-            this.manager.current = this.manager.find(name, workspaceFolderUri);
+    protected readonly start = async () => {
+        let configuration;
+        try {
+            configuration = await this.manager.getSelectedConfiguration();
+        } catch (e) {
+            this.messageService.error(e.message);
+            return;
         }
-    };
 
-    protected readonly start = () => {
-        const configuration = this.manager.current;
         this.commandRegistry.executeCommand(DebugCommands.START.id, configuration);
     };
 

package/src/common/debug-configuration.ts

@@ -74,9 +74,6 @@ export interface DebugConfiguration {
 
     /** Task to run after debug session ends */
     postDebugTask?: string | TaskIdentifier;
-
-    /** Indicates if it's a dynamic debug configuration */
-    dynamic?: boolean;
 }
 export namespace DebugConfiguration {
     export function is(arg: DebugConfiguration | any): arg is DebugConfiguration {

package/src/common/debug-service.ts

@@ -16,10 +16,10 @@
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
-import { Disposable } from '@theia/core';
+import { Disposable, Event } from '@theia/core';
 import { ApplicationError } from '@theia/core/lib/common/application-error';
 import { IJSONSchema, IJSONSchemaSnippet } from '@theia/core/lib/common/json-schema';
-import { CommandIdVariables } from '@theia/variable-resolver/lib/browser';
+import { CommandIdVariables } from '@theia/variable-resolver/lib/common/variable-types';
 import { DebugConfiguration } from './debug-configuration';
 
 export interface DebuggerDescription {
@@ -82,6 +82,11 @@ export interface DebugService extends Disposable {
      */
     provideDynamicDebugConfigurations?(): Promise<Record<string, DebugConfiguration[]>>;
 
+    /**
+     * Provides a dynamic debug configuration matching the name and the provider debug type
+     */
+    fetchDynamicDebugConfiguration(name: string, type: string): Promise<DebugConfiguration | undefined>;
+
     /**
      * Resolves a [debug configuration](#DebugConfiguration) by filling in missing values
      * or by adding/changing/removing attributes before variable substitution.
@@ -116,6 +121,12 @@ export interface DebugService extends Disposable {
      * Stop a running session for the given session id.
      */
     terminateDebugSession(sessionId: string): Promise<void>;
+
+    /**
+     * Event handle to indicate when one or more dynamic debug configuration providers
+     * have been registered or unregistered.
+     */
+    onDidChangeDebugConfigurationProviders: Event<void>;
 }
 
 /**

package/src/node/debug-adapter-session.ts

@@ -26,7 +26,7 @@ import {
     DebugAdapterSession
 } from './debug-model';
 import { DebugProtocol } from 'vscode-debugprotocol';
-import { Channel } from '../common/debug-service';
+import { Channel } from '@theia/core';
 
 /**
  * [DebugAdapterSession](#DebugAdapterSession) implementation.
@@ -53,7 +53,7 @@ export class DebugAdapterSessionImpl implements DebugAdapterSession {
             throw new Error('The session has already been started, id: ' + this.id);
         }
         this.channel = channel;
-        this.channel.onMessage((message: string) => this.write(message));
+        this.channel.onMessage(message => this.write(message().readString()));
         this.channel.onClose(() => this.channel = undefined);
 
     }
@@ -80,7 +80,7 @@ export class DebugAdapterSessionImpl implements DebugAdapterSession {
 
     protected send(message: string): void {
         if (this.channel) {
-            this.channel.send(message);
+            this.channel.getWriteBuffer().writeString(message);
         }
     }
 

package/src/node/debug-model.ts

@@ -25,8 +25,7 @@
 import { DebugConfiguration } from '../common/debug-configuration';
 import { IJSONSchema, IJSONSchemaSnippet } from '@theia/core/lib/common/json-schema';
 import { MaybePromise } from '@theia/core/lib/common/types';
-import { Event } from '@theia/core/lib/common/event';
-import { Channel } from '../common/debug-service';
+import { Channel, Event } from '@theia/core';
 
 // FIXME: break down this file to debug adapter and debug adapter contribution (see Theia file naming conventions)
 

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

@@ -17,11 +17,11 @@
 import { injectable, inject } from '@theia/core/shared/inversify';
 import { DebugConfiguration } from '../common/debug-configuration';
 import { DebugService, DebuggerDescription } from '../common/debug-service';
-
 import { IJSONSchema, IJSONSchemaSnippet } from '@theia/core/lib/common/json-schema';
-import { CommandIdVariables } from '@theia/variable-resolver/lib/browser';
+import { CommandIdVariables } from '@theia/variable-resolver/lib/common/variable-types';
 import { DebugAdapterSessionManager } from './debug-adapter-session-manager';
 import { DebugAdapterContributionRegistry } from './debug-adapter-contribution-registry';
+import { Event } from '@theia/core';
 
 /**
  * DebugService implementation.
@@ -35,6 +35,10 @@ export class DebugServiceImpl implements DebugService {
     @inject(DebugAdapterContributionRegistry)
     protected readonly registry: DebugAdapterContributionRegistry;
 
+    get onDidChangeDebugConfigurationProviders(): Event<void> {
+        return Event.None;
+    }
+
     dispose(): void {
         this.terminateDebugSession();
     }
@@ -63,6 +67,14 @@ export class DebugServiceImpl implements DebugService {
     async provideDebugConfigurations(debugType: string, workspaceFolderUri?: string): Promise<DebugConfiguration[]> {
         return this.registry.provideDebugConfigurations(debugType, workspaceFolderUri);
     }
+    async provideDynamicDebugConfigurations(): Promise<Record<string, DebugConfiguration[]>> {
+        // TODO: Support dynamic debug configurations through Theia extensions?
+        return {};
+    }
+    fetchDynamicDebugConfiguration(name: string, type: string): Promise<DebugConfiguration | undefined> {
+        // TODO: Support dynamic debug configurations through Theia extensions?
+        return Promise.resolve(undefined);
+    }
     async resolveDebugConfiguration(config: DebugConfiguration, workspaceFolderUri?: string): Promise<DebugConfiguration> {
         return this.registry.resolveDebugConfiguration(config, workspaceFolderUri);
     }
@@ -104,5 +116,4 @@ export class DebugServiceImpl implements DebugService {
             await debugSession.stop();
         }
     }
-
 }