feat: programmatically update the debug config <select>

before starting the debug session

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

Diff for: arduino-ide-extension/package.json

@@ -69,6 +69,7 @@
     "deepmerge": "^4.2.2",
     "drivelist": "^9.2.4",
     "electron-updater": "^4.6.5",
+    "fast-deep-equal": "^3.1.3",
     "fast-json-stable-stringify": "^2.1.0",
     "fast-safe-stringify": "^2.1.1",
     "filename-reserved-regex": "^2.0.0",

Diff for: arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts

@@ -1,5 +1,5 @@
 import '../../src/browser/style/index.css';
-import { ContainerModule } from '@theia/core/shared/inversify';
+import { Container, ContainerModule } from '@theia/core/shared/inversify';
 import { WidgetFactory } from '@theia/core/lib/browser/widget-manager';
 import { CommandContribution } from '@theia/core/lib/common/command';
 import { bindViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
@@ -363,6 +363,14 @@ import { CommandService } from '@theia/core/lib/common/command';
 import { CorePreferences } from '@theia/core/lib/browser/core-preferences';
 import { AutoSelectProgrammer } from './contributions/auto-select-programmer';
 import { HostedPluginSupport } from './hosted/hosted-plugin-support';
+import { DebugSessionManager as TheiaDebugSessionManager } from '@theia/debug/lib/browser/debug-session-manager';
+import { DebugSessionManager } from './theia/debug/debug-session-manager';
+import { DebugWidget } from '@theia/debug/lib/browser/view/debug-widget';
+import { DebugViewModel } from '@theia/debug/lib/browser/view/debug-view-model';
+import { DebugSessionWidget } from '@theia/debug/lib/browser/view/debug-session-widget';
+import { DebugConfigurationWidget } from './theia/debug/debug-configuration-widget';
+import { DebugConfigurationWidget as TheiaDebugConfigurationWidget } from '@theia/debug/lib/browser/view/debug-configuration-widget';
+import { DebugToolBar } from '@theia/debug/lib/browser/view/debug-toolbar-widget';
 
 // Hack to fix copy/cut/paste issue after electron version update in Theia.
 // https://github.com/eclipse-theia/theia/issues/12487
@@ -860,6 +868,28 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   // To be able to use a `launch.json` from outside of the workspace.
   bind(DebugConfigurationManager).toSelf().inSingletonScope();
   rebind(TheiaDebugConfigurationManager).toService(DebugConfigurationManager);
+  // To update the currently selected debug config <select> option when starting a debug session.
+  bind(DebugSessionManager).toSelf().inSingletonScope();
+  rebind(TheiaDebugSessionManager).toService(DebugSessionManager);
+  // Customized debug widget with its customized config <select> to update it programmatically.
+  bind(WidgetFactory)
+    .toDynamicValue(({ container }) => ({
+      id: DebugWidget.ID,
+      createWidget: () => {
+        const child = new Container({ defaultScope: 'Singleton' });
+        child.parent = container;
+        child.bind(DebugViewModel).toSelf();
+        child.bind(DebugToolBar).toSelf();
+        child.bind(DebugSessionWidget).toSelf();
+        child.bind(DebugConfigurationWidget).toSelf(); // with the patched select
+        child // use the customized one in the Theia DI
+          .bind(TheiaDebugConfigurationWidget)
+          .toService(DebugConfigurationWidget);
+        child.bind(DebugWidget).toSelf();
+        return child.get(DebugWidget);
+      },
+    }))
+    .inSingletonScope();
 
   // To avoid duplicate tabs use deepEqual instead of string equal: https://github.com/eclipse-theia/theia/issues/11309
   bind(WidgetManager).toSelf().inSingletonScope();

Diff for: arduino-ide-extension/src/browser/theia/debug/debug-configuration-widget.tsx

@@ -0,0 +1,57 @@
+import { DisposableCollection } from '@theia/core/lib/common/disposable';
+import { nls } from '@theia/core/lib/common/nls';
+import { injectable } from '@theia/core/shared/inversify';
+import React from '@theia/core/shared/react';
+import { DebugAction } from '@theia/debug/lib/browser/view/debug-action';
+import { DebugConfigurationSelect as TheiaDebugConfigurationSelect } from '@theia/debug/lib/browser/view/debug-configuration-select';
+import { DebugConfigurationWidget as TheiaDebugConfigurationWidget } from '@theia/debug/lib/browser/view/debug-configuration-widget';
+
+/**
+ * Patched to programmatically update the debug config <select> in the widget.
+ */
+@injectable()
+export class DebugConfigurationWidget extends TheiaDebugConfigurationWidget {
+  override render(): React.ReactNode {
+    return (
+      <React.Fragment>
+        <DebugAction
+          run={this.start}
+          label={nls.localizeByDefault('Start Debugging')}
+          iconClass="debug-start"
+          ref={this.setStepRef}
+        />
+        {/* The customized select component that will refresh when the config manager did change */}
+        <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>
+    );
+  }
+}
+
+class DebugConfigurationSelect extends TheiaDebugConfigurationSelect {
+  private readonly toDisposeOnUnmount = new DisposableCollection();
+
+  override componentDidMount(): void {
+    super.componentDidMount();
+    this.toDisposeOnUnmount.push(
+      this['manager'].onDidChange(() => this.refreshDebugConfigurations())
+    );
+  }
+
+  override componentWillUnmount(): void {
+    this.toDisposeOnUnmount.dispose();
+  }
+}

Diff for: arduino-ide-extension/src/browser/theia/debug/debug-session-manager.ts

@@ -0,0 +1,39 @@
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { DebugSession } from '@theia/debug/lib/browser/debug-session';
+import { DebugSessionManager as TheiaDebugSessionManager } from '@theia/debug/lib/browser/debug-session-manager';
+import { DebugConfigurationSessionOptions } from '@theia/debug/lib/browser/debug-session-options';
+import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
+import deepEqual from 'fast-deep-equal';
+
+@injectable()
+export class DebugSessionManager extends TheiaDebugSessionManager {
+  @inject(WorkspaceService)
+  private readonly workspaceService: WorkspaceService;
+
+  protected override doStart(
+    sessionId: string,
+    options: DebugConfigurationSessionOptions
+  ): Promise<DebugSession> {
+    this.syncCurrentOptions(options);
+    return super.doStart(sessionId, options);
+  }
+
+  /**
+   * If the debug config manager knows about the currently started options, and it's not the currently selected one, select it.
+   */
+  private syncCurrentOptions(options: DebugConfigurationSessionOptions): void {
+    const knownConfigOptions = this.debugConfigurationManager.find(
+      options.configuration,
+      options.workspaceFolderUri ??
+        this.workspaceService
+          .tryGetRoots()
+          .map((stat) => stat.resource.toString())[0]
+    );
+    if (
+      knownConfigOptions &&
+      !deepEqual(knownConfigOptions, this.debugConfigurationManager.current)
+    ) {
+      this.debugConfigurationManager.current = knownConfigOptions;
+    }
+  }
+}