Avoid deleting the workspace when it's still in use.

 - From now on, NSFW service disposes after last reference
is removed. No more 10sec delay.
 - Moved the temp workspace deletion to a startup task.
 - Can set initial task for the window from electron-main.
 - Removed the `browser-app`.

Closes arduino#39

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

Author: Akos Kitta

Diff for: .vscode/launch.json

@@ -14,14 +14,14 @@
         ".",
         "--log-level=debug",
         "--hostname=localhost",
-        "--no-cluster",
         "--app-project-path=${workspaceRoot}/electron-app",
         "--remote-debugging-port=9222",
         "--no-app-auto-install",
         "--plugins=local-dir:../plugins",
         "--hosted-plugin-inspect=9339",
         "--content-trace",
-        "--open-devtools"
+        "--open-devtools",
+        "--nsfw-watcher-verbose"
       ],
       "env": {
         "NODE_ENV": "development"
@@ -51,7 +51,6 @@
         ".",
         "--log-level=debug",
         "--hostname=localhost",
-        "--no-cluster",
         "--app-project-path=${workspaceRoot}/electron-app",
         "--remote-debugging-port=9222",
         "--no-app-auto-install",
@@ -80,37 +79,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",

Diff for: .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",

Diff for: 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"
     },
     {

Diff for: 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[] = [
@@ -757,6 +760,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.

Diff for: 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;
-      }
-    }
   }
 }

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

@@ -23,9 +23,15 @@ 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
+{
   @inject(ILogger)
   protected logger: ILogger;
 
@@ -652,14 +658,15 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
       }
     } else {
       // If we could not restore the latest valid config, try to restore something, the board at least.
-      let storedLatestBoardsConfig = await this.getData<
+      const storedLatestBoardsConfig = await this.getData<
         BoardsConfig.Config | undefined
       >('latest-boards-config');
       // Try to get from the URL if it was not persisted.
       if (!storedLatestBoardsConfig) {
-        storedLatestBoardsConfig = BoardsConfig.Config.getConfig(
-          new URL(window.location.href)
-        );
+        console.warn('TODO: restore this');
+        // storedLatestBoardsConfig = BoardsConfig.Config.getConfig(
+        //   new URL(window.location.href)
+        // );
       }
       if (storedLatestBoardsConfig) {
         this.latestBoardsConfig = storedLatestBoardsConfig;
@@ -682,6 +689,28 @@ export class BoardsServiceProvider implements FrontendApplicationContribution {
       key
     );
   }
+
+  tasks(): StartupTask[] {
+    const { selectedBoard: currentBoard, selectedPort: currentPort } =
+      this.boardsConfig;
+    const selectedBoard = currentBoard && {
+      name: currentBoard.name,
+      fqbn: currentBoard.fqbn,
+    };
+    const selectedPort = currentPort && {
+      protocol: currentPort.protocol,
+      address: currentPort.address,
+    };
+    if (!selectedBoard && !selectedPort) {
+      return [];
+    }
+    return [
+      {
+        command: 'arduino-select-board',
+        args: [{ selectedBoard, selectedPort }],
+      },
+    ];
+  }
 }
 
 /**

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

@@ -0,0 +1,43 @@
+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',
+    };
+  }
+}

Diff for: arduino-ide-extension/src/browser/contributions/save-as-sketch.ts

@@ -12,21 +12,19 @@ import {
 } from './contribution';
 import { nls } from '@theia/core/lib/common';
 import { ApplicationShell, NavigatableWidget, Saveable } from '@theia/core/lib/browser';
-import { EditorManager } from '@theia/editor/lib/browser';
 import { WindowService } from '@theia/core/lib/browser/window/window-service';
 import { CurrentSketch } from '../../common/protocol/sketches-service-client-impl';
+import { WorkspaceInput } from '@theia/workspace/lib/browser';
+import { StartupTask } from '../../electron-common/startup-task';
+import { DeleteSketch } from './delete-sketch';
 
 @injectable()
 export class SaveAsSketch extends SketchContribution {
-
   @inject(ApplicationShell)
-  protected readonly applicationShell: ApplicationShell;
-
-  @inject(EditorManager)
-  protected override readonly editorManager: EditorManager;
+  private readonly applicationShell: ApplicationShell;
 
   @inject(WindowService)
-  protected readonly windowService: WindowService;
+  private readonly windowService: WindowService;
 
   override registerCommands(registry: CommandRegistry): void {
     registry.registerCommand(SaveAsSketch.Commands.SAVE_AS_SKETCH, {
@@ -107,21 +105,19 @@ export class SaveAsSketch extends SketchContribution {
         this.sketchService.markAsRecentlyOpened(workspaceUri);
       }
     }
+    const options: WorkspaceInput & { tasks: StartupTask[] } = {
+      preserveWindow: true,
+      tasks: [],
+    };
     if (workspaceUri && openAfterMove) {
       this.windowService.setSafeToShutDown();
       if (wipeOriginal || (openAfterMove && execOnlyIfTemp)) {
-        // This window will navigate away.
-        // Explicitly stop the contribution to dispose the file watcher before deleting the temp sketch.
-        // Otherwise, users might see irrelevant _Unable to watch for file changes in this large workspace._ notification.
-        // https://github.com/arduino/arduino-ide/issues/39.
-        this.sketchServiceClient.onStop();
-        // TODO: consider implementing the temp sketch deletion the following way:
-        // Open the other sketch with a `delete the temp sketch` startup-task.
-        this.sketchService.notifyDeleteSketch(sketch); // This is a notification and will execute on the backend.
+        options.tasks.push({
+          command: DeleteSketch.Commands.DELETE_SKETCH.id,
+          args: [sketch.uri],
+        });
       }
-      this.workspaceService.open(new URI(workspaceUri), {
-        preserveWindow: true,
-      });
+      this.workspaceService.open(new URI(workspaceUri), options);
     }
     return !!workspaceUri;
   }