#39 Avoid deleting the workspace when it's still in use

.eslintrc.js

@@ -17,7 +17,6 @@ module.exports = {
         'scripts/*',
         'electron/*',
         'electron-app/*',
-        'browser-app/*',
         'plugins/*',
         'arduino-ide-extension/src/node/cli-protocol',
     ],

.vscode/launch.json

@@ -80,37 +80,6 @@
       "port": 9222,
       "webRoot": "${workspaceFolder}/electron-app"
     },
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "App (Browser)",
-      "program": "${workspaceRoot}/browser-app/src-gen/backend/main.js",
-      "args": [
-        "--hostname=0.0.0.0",
-        "--port=3000",
-        "--no-cluster",
-        "--no-app-auto-install",
-        "--plugins=local-dir:plugins"
-      ],
-      "windows": {
-        "env": {
-          "NODE_ENV": "development",
-          "NODE_PRESERVE_SYMLINKS": "1"
-        }
-      },
-      "env": {
-        "NODE_ENV": "development"
-      },
-      "sourceMaps": true,
-      "outFiles": [
-        "${workspaceRoot}/browser-app/src-gen/backend/*.js",
-        "${workspaceRoot}/browser-app/lib/**/*.js",
-        "${workspaceRoot}/arduino-ide-extension/lib/**/*.js"
-      ],
-      "smartStep": true,
-      "internalConsoleOptions": "openOnSessionStart",
-      "outputCapture": "std"
-    },
     {
       "type": "node",
       "request": "launch",

.vscode/tasks.json

@@ -12,17 +12,6 @@
         "clear": false
       }
     },
-    {
-      "label": "Arduino IDE - Start Browser App",
-      "type": "shell",
-      "command": "yarn --cwd ./browser-app start",
-      "group": "build",
-      "presentation": {
-        "reveal": "always",
-        "panel": "new",
-        "clear": true
-      }
-    },
     {
       "label": "Arduino IDE - Watch IDE Extension",
       "type": "shell",
@@ -34,17 +23,6 @@
         "clear": false
       }
     },
-    {
-      "label": "Arduino IDE - Watch Browser App",
-      "type": "shell",
-      "command": "yarn --cwd ./browser-app watch",
-      "group": "build",
-      "presentation": {
-        "reveal": "always",
-        "panel": "new",
-        "clear": false
-      }
-    },
     {
       "label": "Arduino IDE - Watch Electron App",
       "type": "shell",
@@ -56,14 +34,6 @@
         "clear": false
       }
     },
-    {
-      "label": "Arduino IDE - Watch All [Browser]",
-      "type": "shell",
-      "dependsOn": [
-        "Arduino IDE - Watch IDE Extension",
-        "Arduino IDE - Watch Browser App"
-      ]
-    },
     {
       "label": "Arduino IDE - Watch All [Electron]",
       "type": "shell",

arduino-ide-extension/package.json

@@ -147,11 +147,9 @@
       "frontend": "lib/browser/arduino-ide-frontend-module"
     },
     {
-      "frontend": "lib/browser/theia/core/browser-menu-module",
       "frontendElectron": "lib/electron-browser/theia/core/electron-menu-module"
     },
     {
-      "frontend": "lib/browser/theia/core/browser-window-module",
       "frontendElectron": "lib/electron-browser/theia/core/electron-window-module"
     },
     {

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

@@ -105,7 +105,8 @@ import {
 } from '@theia/core/lib/browser/connection-status-service';
 import { BoardsDataMenuUpdater } from './boards/boards-data-menu-updater';
 import { BoardsDataStore } from './boards/boards-data-store';
-import { ILogger } from '@theia/core';
+import { ILogger } from '@theia/core/lib/common/logger';
+import { bindContributionProvider } from '@theia/core/lib/common/contribution-provider';
 import {
   FileSystemExt,
   FileSystemExtPath,
@@ -308,7 +309,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 { StartupTasks } from './widgets/sketchbook/startup-task';
+import { StartupTasks } from './contributions/startup-task';
 import { IndexesUpdateProgress } from './contributions/indexes-update-progress';
 import { Daemon } from './contributions/daemon';
 import { FirstStartupInstaller } from './contributions/first-startup-installer';
@@ -334,6 +335,8 @@ import {
 } from './widgets/component-list/filter-renderer';
 import { CheckForUpdates } from './contributions/check-for-updates';
 import { OutputEditorFactory } from './theia/output/output-editor-factory';
+import { StartupTaskProvider } from '../electron-common/startup-task';
+import { DeleteSketch } from './contributions/delete-sketch';
 
 const registerArduinoThemes = () => {
   const themes: MonacoThemeJson[] = [
@@ -433,6 +436,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   // Boards service client to receive and delegate notifications from the backend.
   bind(BoardsServiceProvider).toSelf().inSingletonScope();
   bind(FrontendApplicationContribution).toService(BoardsServiceProvider);
+  bind(CommandContribution).toService(BoardsServiceProvider);
 
   // To be able to track, and update the menu based on the core settings (aka. board details) of the currently selected board.
   bind(FrontendApplicationContribution)
@@ -757,6 +761,10 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   Contribution.configure(bind, OpenBoardsConfig);
   Contribution.configure(bind, SketchFilesTracker);
   Contribution.configure(bind, CheckForUpdates);
+  Contribution.configure(bind, DeleteSketch);
+
+  bindContributionProvider(bind, StartupTaskProvider);
+  bind(StartupTaskProvider).toService(BoardsServiceProvider); // to reuse the boards config in another window
 
   // 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.

arduino-ide-extension/src/browser/boards/boards-config.tsx

@@ -413,53 +413,5 @@ export namespace BoardsConfig {
       const { name } = selectedBoard;
       return `${name}${port ? ` at ${port.address}` : ''}`;
     }
-
-    export function setConfig(
-      config: Config | undefined,
-      urlToAttachTo: URL
-    ): URL {
-      const copy = new URL(urlToAttachTo.toString());
-      if (!config) {
-        copy.searchParams.delete('boards-config');
-        return copy;
-      }
-
-      const selectedBoard = config.selectedBoard
-        ? {
-            name: config.selectedBoard.name,
-            fqbn: config.selectedBoard.fqbn,
-          }
-        : undefined;
-      const selectedPort = config.selectedPort
-        ? {
-            protocol: config.selectedPort.protocol,
-            address: config.selectedPort.address,
-          }
-        : undefined;
-      const jsonConfig = JSON.stringify({ selectedBoard, selectedPort });
-      copy.searchParams.set('boards-config', encodeURIComponent(jsonConfig));
-      return copy;
-    }
-
-    export function getConfig(url: URL): Config | undefined {
-      const encoded = url.searchParams.get('boards-config');
-      if (!encoded) {
-        return undefined;
-      }
-      try {
-        const raw = decodeURIComponent(encoded);
-        const candidate = JSON.parse(raw);
-        if (typeof candidate === 'object') {
-          return candidate;
-        }
-        console.warn(
-          `Expected candidate to be an object. It was ${typeof candidate}. URL was: ${url}`
-        );
-        return undefined;
-      } catch (e) {
-        console.log(`Could not get board config from URL: ${url}.`, e);
-        return undefined;
-      }
-    }
   }
 }

arduino-ide-extension/src/browser/boards/boards-service-provider.ts

@@ -1,7 +1,12 @@
 import { injectable, inject } from '@theia/core/shared/inversify';
 import { Emitter } from '@theia/core/lib/common/event';
 import { ILogger } from '@theia/core/lib/common/logger';
-import { CommandService } from '@theia/core/lib/common/command';
+import {
+  Command,
+  CommandContribution,
+  CommandRegistry,
+  CommandService,
+} from '@theia/core/lib/common/command';
 import { MessageService } from '@theia/core/lib/common/message-service';
 import { FrontendApplicationContribution } from '@theia/core/lib/browser/frontend-application';
 import { RecursiveRequired } from '../../common/types';
@@ -23,9 +28,18 @@ import { nls } from '@theia/core/lib/common';
 import { Deferred } from '@theia/core/lib/common/promise-util';
 import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
 import { Unknown } from '../../common/nls';
+import {
+  StartupTask,
+  StartupTaskProvider,
+} from '../../electron-common/startup-task';
 
 @injectable()
-export class BoardsServiceProvider implements FrontendApplicationContribution {
+export class BoardsServiceProvider
+  implements
+    FrontendApplicationContribution,
+    StartupTaskProvider,
+    CommandContribution
+{
   @inject(ILogger)
   protected logger: ILogger;
 
@@ -50,6 +64,7 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
     AvailableBoard[]
   >();
   protected readonly onAvailablePortsChangedEmitter = new Emitter<Port[]>();
+  private readonly inheritedConfig = new Deferred<BoardsConfig.Config>();
 
   /**
    * Used for the auto-reconnecting. Sometimes, the attached board gets disconnected after uploading something to it.
@@ -115,6 +130,13 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
     });
   }
 
+  registerCommands(registry: CommandRegistry): void {
+    registry.registerCommand(USE_INHERITED_CONFIG, {
+      execute: (inheritedConfig: BoardsConfig.Config) =>
+        this.inheritedConfig.resolve(inheritedConfig),
+    });
+  }
+
   get reconciled(): Promise<void> {
     return this._reconciled.promise;
   }
@@ -655,11 +677,14 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
       let storedLatestBoardsConfig = await this.getData<
         BoardsConfig.Config | undefined
       >('latest-boards-config');
-      // Try to get from the URL if it was not persisted.
+      // Try to get from the startup task. Wait for it, then timeout. Maybe it never arrives.
       if (!storedLatestBoardsConfig) {
-        storedLatestBoardsConfig = BoardsConfig.Config.getConfig(
-          new URL(window.location.href)
-        );
+        storedLatestBoardsConfig = await Promise.race([
+          this.inheritedConfig.promise,
+          new Promise<undefined>((resolve) =>
+            setTimeout(() => resolve(undefined), 2_000)
+          ),
+        ]);
       }
       if (storedLatestBoardsConfig) {
         this.latestBoardsConfig = storedLatestBoardsConfig;
@@ -682,8 +707,31 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
       key
     );
   }
+
+  tasks(): StartupTask[] {
+    return [
+      {
+        command: USE_INHERITED_CONFIG.id,
+        args: [this.boardsConfig],
+      },
+    ];
+  }
 }
 
+/**
+ * It should be neither visible nor called from outside.
+ *
+ * This service creates a startup task with the current board config and
+ * passes the task to the electron-main process so that the new window
+ * can inherit the boards config state of this service.
+ *
+ * Note that the state is always set, but new windows might ignore it.
+ * For example, the new window already has a valid boards config persisted to the local storage.
+ */
+const USE_INHERITED_CONFIG: Command = {
+  id: 'arduino-use-inherited-boards-config',
+};
+
 /**
  * Representation of a ready-to-use board, either the user has configured it or was automatically recognized by the CLI.
  * An available board was not necessarily recognized by the CLI (e.g.: it is a 3rd party board) or correctly configured but ready for `verify`.

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

@@ -0,0 +1,45 @@
+import { injectable } from '@theia/core/shared/inversify';
+import { SketchesError } from '../../common/protocol';
+import {
+  Command,
+  CommandRegistry,
+  SketchContribution,
+  Sketch,
+} from './contribution';
+
+@injectable()
+export class DeleteSketch extends SketchContribution {
+  override registerCommands(registry: CommandRegistry): void {
+    registry.registerCommand(DeleteSketch.Commands.DELETE_SKETCH, {
+      execute: (uri: string) => this.deleteSketch(uri),
+    });
+  }
+
+  private async deleteSketch(uri: string): Promise<void> {
+    const sketch = await this.loadSketch(uri);
+    if (!sketch) {
+      console.info(`Sketch not found at ${uri}. Skipping deletion.`);
+      return;
+    }
+    return this.sketchService.deleteSketch(sketch);
+  }
+
+  private async loadSketch(uri: string): Promise<Sketch | undefined> {
+    try {
+      const sketch = await this.sketchService.loadSketch(uri);
+      return sketch;
+    } catch (err) {
+      if (SketchesError.NotFound.is(err)) {
+        return undefined;
+      }
+      throw err;
+    }
+  }
+}
+export namespace DeleteSketch {
+  export namespace Commands {
+    export const DELETE_SKETCH: Command = {
+      id: 'arduino-delete-sketch',
+    };
+  }
+}