pair session changes.

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

Author: Akos Kitta

arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts

@@ -302,7 +302,7 @@ import { CoreErrorHandler } from './contributions/core-error-handler';
 import { CompilerErrors } from './contributions/compiler-errors';
 import { WidgetManager } from './theia/core/widget-manager';
 import { WidgetManager as TheiaWidgetManager } from '@theia/core/lib/browser/widget-manager';
-import { EncodedCommandsContribution } from './widgets/sketchbook/encoded-commands-contribution';
+import { StartupTask } from './widgets/sketchbook/startup-task';
 
 MonacoThemingService.register({
   id: 'arduino-theme',
@@ -699,7 +699,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   Contribution.configure(bind, PlotterFrontendContribution);
   Contribution.configure(bind, Format);
   Contribution.configure(bind, CompilerErrors);
-  Contribution.configure(bind, EncodedCommandsContribution);
+  Contribution.configure(bind, StartupTask);
 
   // Disabled the quick-pick customization from Theia when multiple formatters are available.
   // Use the default VS Code behavior, and pick the first one. In the IDE2, clang-format has `exclusive` selectors.
@@ -834,7 +834,6 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
 
   bind(CloudSketchbookWidget).toSelf();
   rebind(SketchbookWidget).toService(CloudSketchbookWidget);
-  bind(CommandContribution).toService(CloudSketchbookWidget);
   bind(CloudSketchbookTreeWidget).toDynamicValue(({ container }) =>
     createCloudSketchbookTreeWidget(container)
   );

arduino-ide-extension/src/browser/contributions/sketch-control.ts

@@ -250,7 +250,7 @@ export class SketchControl extends SketchContribution {
     });
   }
 
-  isCloudSketch(uri: string): boolean {
+  protected isCloudSketch(uri: string): boolean {
     try {
       const cloudCacheLocation = this.localCacheFsProvider.from(new URI(uri));
 

arduino-ide-extension/src/browser/theia/workspace/workspace-service.ts

@@ -20,11 +20,8 @@ import {
 } from '../../../common/protocol/sketches-service';
 import { BoardsServiceProvider } from '../../boards/boards-service-provider';
 import { BoardsConfig } from '../../boards/boards-config';
-import { EncodableCommad } from '../../widgets/sketchbook/encoded-commands-contribution';
-
-interface WorkspaceOptions extends WorkspaceInput {
-  commands: EncodableCommad[];
-}
+import { FileStat } from '@theia/filesystem/lib/common/files';
+import { StartupTask } from '../../widgets/sketchbook/startup-task';
 
 @injectable()
 export class WorkspaceService extends TheiaWorkspaceService {
@@ -90,11 +87,13 @@ export class WorkspaceService extends TheiaWorkspaceService {
     }
   }
 
-  /*
-    This method mostly duplicates super.doOpen and super.openWindow because they didn't let pass any custom
-    option to openNewWindow
-  */
-  async openWithCommands(uri: URI, options?: WorkspaceOptions): Promise<void> {
+  /**
+   * Copied from Theia as-is to be able to pass the original `options` down.
+   */
+  protected override async doOpen(
+    uri: URI,
+    options?: WorkspaceInput
+  ): Promise<URI | undefined> {
     const stat = await this.toFileStat(uri);
     if (stat) {
       if (!stat.isDirectory && !this.isWorkspaceFile(stat)) {
@@ -114,41 +113,46 @@ export class WorkspaceService extends TheiaWorkspaceService {
       if (preserveWindow) {
         this._workspace = stat;
       }
-
-      const workspacePath = stat.resource.path.toString();
-
-      if (this.shouldPreserveWindow(options)) {
-        this.reloadWindow();
-      } else {
-        try {
-          this.openNewWindow(workspacePath, options);
-          return;
-        } catch (error) {
-          // Fall back to reloading the current window in case the browser has blocked the new window
-          this._workspace = stat;
-          this.logger.error(error.toString()).then(() => this.reloadWindow());
-        }
-      }
+      this.openWindow(stat, Object.assign(options ?? {}, { preserveWindow }));
+      return;
     }
     throw new Error(
       'Invalid workspace root URI. Expected an existing directory or workspace file.'
     );
   }
 
+  /**
+   * Copied from Theia. Can pass the `options` further down the chain.
+   */
+  protected override openWindow(uri: FileStat, options?: WorkspaceInput): void {
+    const workspacePath = uri.resource.path.toString();
+    if (this.shouldPreserveWindow(options)) {
+      this.reloadWindow();
+    } else {
+      try {
+        this.openNewWindow(workspacePath, options); // Unlike Theia, IDE2 passes the `input` downstream.
+      } catch (error) {
+        // Fall back to reloading the current window in case the browser has blocked the new window
+        this._workspace = uri;
+        this.logger.error(error.toString()).then(() => this.reloadWindow());
+      }
+    }
+  }
+
   protected override openNewWindow(
     workspacePath: string,
-    options?: WorkspaceOptions
+    options?: WorkspaceInput
   ): void {
     const { boardsConfig } = this.boardsServiceProvider;
     const url = BoardsConfig.Config.setConfig(
       boardsConfig,
       new URL(window.location.href)
     ); // Set the current boards config for the new browser window.
     url.hash = workspacePath;
-    if (options?.commands) {
+    if (StartupTask.WorkspaceInput.is(options)) {
       url.searchParams.set(
-        'commands',
-        encodeURIComponent(JSON.stringify(options.commands))
+        StartupTask.QUERY_STRING,
+        encodeURIComponent(JSON.stringify(options.tasks))
       );
     }
 

arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-widget.ts

@@ -1,36 +1,15 @@
-import {
-  inject,
-  injectable,
-  postConstruct,
-} from '@theia/core/shared/inversify';
+import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
 import { CloudSketchbookCompositeWidget } from './cloud-sketchbook-composite-widget';
 import { SketchbookWidget } from '../sketchbook/sketchbook-widget';
 import { ArduinoPreferences } from '../../arduino-preferences';
-import { CommandContribution, CommandRegistry } from '@theia/core';
-import { ApplicationShell } from '@theia/core/lib/browser';
-import { CloudSketchbookCommands } from './cloud-sketchbook-contributions';
-import { EditorManager } from '@theia/editor/lib/browser';
-import { SketchbookWidgetContribution } from '../sketchbook/sketchbook-widget-contribution';
 
 @injectable()
-export class CloudSketchbookWidget
-  extends SketchbookWidget
-  implements CommandContribution
-{
+export class CloudSketchbookWidget extends SketchbookWidget {
   @inject(CloudSketchbookCompositeWidget)
-  private readonly cloudSketchbookCompositeWidget: CloudSketchbookCompositeWidget;
+  protected readonly widget: CloudSketchbookCompositeWidget;
 
   @inject(ArduinoPreferences)
-  private readonly arduinoPreferences: ArduinoPreferences;
-
-  @inject(ApplicationShell)
-  private readonly shell: ApplicationShell;
-
-  @inject(SketchbookWidgetContribution)
-  private readonly sketchbookWidgetContribution: SketchbookWidgetContribution;
-
-  @inject(EditorManager)
-  private readonly editorManager: EditorManager;
+  protected readonly arduinoPreferences: ArduinoPreferences;
 
   @postConstruct()
   protected override init(): void {
@@ -48,9 +27,7 @@ export class CloudSketchbookWidget
 
   checkCloudEnabled() {
     if (this.arduinoPreferences['arduino.cloud.enabled']) {
-      this.sketchbookTreesContainer.activateWidget(
-        this.cloudSketchbookCompositeWidget
-      );
+      this.sketchbookTreesContainer.activateWidget(this.widget);
     } else {
       this.sketchbookTreesContainer.activateWidget(
         this.localSketchbookTreeWidget
@@ -68,9 +45,7 @@ export class CloudSketchbookWidget
   }
 
   protected override onAfterAttach(msg: any): void {
-    this.sketchbookTreesContainer.addWidget(
-      this.cloudSketchbookCompositeWidget
-    );
+    this.sketchbookTreesContainer.addWidget(this.widget);
     this.setDocumentMode();
     this.arduinoPreferences.onPreferenceChanged((event) => {
       if (event.preferenceName === 'arduino.cloud.enabled') {
@@ -79,29 +54,4 @@ export class CloudSketchbookWidget
     });
     super.onAfterAttach(msg);
   }
-
-  registerCommands(registry: CommandRegistry): void {
-    this.sketchbookTreesContainer.addWidget(
-      this.cloudSketchbookCompositeWidget
-    );
-    registry.registerCommand(
-      CloudSketchbookCommands.SHOW_CLOUD_SKETCHBOOK_WIDGET,
-      {
-        execute: () => this.showCloudSketchbookWidget(),
-      }
-    );
-  }
-
-  showCloudSketchbookWidget(): void {
-    if (this.arduinoPreferences['arduino.cloud.enabled']) {
-      this.shell.activateWidget(this.id).then((widget) => {
-        if (widget instanceof CloudSketchbookWidget) {
-          widget.activateTreeWidget(this.cloudSketchbookCompositeWidget.id);
-        }
-        this.sketchbookWidgetContribution.selectWidgetFileNode(
-          this.editorManager.currentEditor
-        );
-      });
-    }
-  }
 }

arduino-ide-extension/src/browser/widgets/sketchbook/encoded-commands-contribution.ts

@@ -5,12 +5,11 @@ export namespace SketchbookCommands {
     id: 'arduino-sketchbook-widget:toggle',
   };
 
-  export const SHOW_SKETCHBOOK_WIDGET = Command.toLocalizedCommand(
+  export const REVEAL_SKETCH_NODE = Command.toLocalizedCommand(
     {
-      id: 'arduino-sketchbook--show-sketchbook-widget',
-      label: 'Show Sketchbook Widget',
+      id: 'arduino-sketchbook--reveal-sketch-node',
     },
-    'arduino/sketch/showSketchbookWidget'
+    'arduino/sketch/revealSketchNode'
   );
 
   export const OPEN_NEW_WINDOW = Command.toLocalizedCommand(

arduino-ide-extension/src/browser/widgets/sketchbook/sketchbook-commands.ts

@@ -17,7 +17,6 @@ import {
   Navigatable,
   RenderContextMenuOptions,
   SelectableTreeNode,
-  TreeNode,
   Widget,
 } from '@theia/core/lib/browser';
 import {
@@ -30,9 +29,7 @@ import {
 } from '../../../common/protocol/sketches-service-client-impl';
 import { FileService } from '@theia/filesystem/lib/browser/file-service';
 import { URI } from '../../contributions/contribution';
-import { SketchControl } from '../../contributions/sketch-control';
-import { SketchbookTreeWidget } from './sketchbook-tree-widget';
-import { EncodableCommad } from './encoded-commands-contribution';
+import { WorkspaceInput } from '@theia/workspace/lib/browser';
 
 export const SKETCHBOOK__CONTEXT = ['arduino-sketchbook--context'];
 
@@ -71,9 +68,6 @@ export class SketchbookWidgetContribution
   @inject(FileService)
   protected readonly fileService: FileService;
 
-  @inject(SketchControl)
-  protected readonly sketchControl: SketchControl;
-
   protected readonly toDisposeBeforeNewContextMenu = new DisposableCollection();
 
   constructor() {
@@ -107,12 +101,32 @@ export class SketchbookWidgetContribution
 
   override registerCommands(registry: CommandRegistry): void {
     super.registerCommands(registry);
-    registry.registerCommand(SketchbookCommands.SHOW_SKETCHBOOK_WIDGET, {
-      execute: (treeWidget: SketchbookTreeWidget, node: TreeNode) =>
-        this.showSketchbookWidget(treeWidget, node),
+    registry.registerCommand(SketchbookCommands.REVEAL_SKETCH_NODE, {
+      execute: (treeWidgetId: string, nodeId: string) =>
+        this.revealSketchNode(treeWidgetId, nodeId),
     });
     registry.registerCommand(SketchbookCommands.OPEN_NEW_WINDOW, {
-      execute: (arg) => this.openSketchInNewWindow(arg),
+      execute: (arg) => {
+        const widget = this.tryGetWidget();
+        if (widget) {
+          const treeWidgetId = widget.activeTreeWidgetId();
+          if (!treeWidgetId) {
+            console.warn(`Could not retrieve active sketchbook tree ID.`);
+            return;
+          }
+          const nodeId = arg.node.id;
+          const options: WorkspaceInput = {};
+          Object.assign(options, {
+            tasks: [
+              {
+                command: SketchbookCommands.REVEAL_SKETCH_NODE.id,
+                args: [treeWidgetId, nodeId],
+              },
+            ],
+          });
+          return this.workspaceService.open(arg.node.uri, options);
+        }
+      },
       isEnabled: (arg) =>
         !!arg && 'node' in arg && SketchbookTree.SketchDirNode.is(arg.node),
       isVisible: (arg) =>
@@ -200,19 +214,6 @@ export class SketchbookWidgetContribution
     });
   }
 
-  async openSketchInNewWindow(arg: any): Promise<any> {
-    const treeWidget: SketchbookTreeWidget = (
-      await this.widget
-    ).getTreeWidget();
-    const command: EncodableCommad = {
-      id: SketchbookCommands.SHOW_SKETCHBOOK_WIDGET.id,
-      args: [treeWidget, arg.node],
-    };
-    return this.workspaceService.openWithCommands(arg.node.uri, {
-      commands: [command],
-    });
-  }
-
   override registerMenus(registry: MenuModelRegistry): void {
     super.registerMenus(registry);
 
@@ -252,19 +253,15 @@ export class SketchbookWidgetContribution
     this.selectWidgetFileNode(this.shell.currentWidget);
   }
 
-  protected async showSketchbookWidget(
-    treeWidget: SketchbookTreeWidget,
-    node: TreeNode
+  private async revealSketchNode(
+    treeWidgetId: string,
+    nodeId: string
   ): Promise<void> {
-    this.widget
+    return this.widget
       .then((widget) => this.shell.activateWidget(widget.id))
       .then((widget) => {
         if (widget instanceof SketchbookWidget) {
-          widget.activateTreeWidget(treeWidget.id);
-          if (SelectableTreeNode.is(node)) {
-            const { model } = treeWidget;
-            model.selectNode(node);
-          }
+          return widget.revealSketchNode(treeWidgetId, nodeId);
         }
       });
   }