#1089: IDE2 falls back to new sketch if opening failed. (#1152)

IDE2 falls back to a new sketch if the opening fails.

Closes #1089

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

arduino-ide-extension/src/browser/widgets/sketchbook/startup-task.ts

@@ -1,36 +1,86 @@
 import { injectable } from '@theia/core/shared/inversify';
 import { WorkspaceInput as TheiaWorkspaceInput } from '@theia/workspace/lib/browser';
 import { Contribution } from '../../contributions/contribution';
+import { setURL } from '../../utils/window';
 
-export interface Task {
+@injectable()
+export class StartupTasks extends Contribution {
+  override onReady(): void {
+    const tasks = StartupTask.get(new URL(window.location.href));
+    console.log(`Executing startup tasks: ${JSON.stringify(tasks)}`);
+    tasks.forEach(({ command, args = [] }) =>
+      this.commandService
+        .executeCommand(command, ...args)
+        .catch((err) =>
+          console.error(
+            `Error occurred when executing the startup task '${command}'${
+              args?.length ? ` with args: '${JSON.stringify(args)}` : ''
+            }.`,
+            err
+          )
+        )
+    );
+    if (tasks.length) {
+      // Remove the startup tasks after the execution.
+      // Otherwise, IDE2 executes them again on a window reload event.
+      setURL(StartupTask.set([], new URL(window.location.href)));
+      console.info(`Removed startup tasks from URL.`);
+    }
+  }
+}
+
+export interface StartupTask {
   command: string;
   /**
-   * This must be JSON serializable.
+   * Must be JSON serializable.
    */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   args?: any[];
 }
-
-@injectable()
-export class StartupTask extends Contribution {
-  override onReady(): void {
-    const params = new URLSearchParams(window.location.search);
-    const encoded = params.get(StartupTask.QUERY_STRING);
-    if (!encoded) return;
-
-    const commands = JSON.parse(decodeURIComponent(encoded));
-
-    if (Array.isArray(commands)) {
-      commands.forEach(({ command, args }) => {
-        this.commandService.executeCommand(command, ...args);
-      });
+export namespace StartupTask {
+  const QUERY = 'startupTasks';
+  export function is(arg: unknown): arg is StartupTasks {
+    if (typeof arg === 'object') {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const object = arg as any;
+      return 'command' in object && typeof object['command'] === 'string';
     }
+    return false;
+  }
+  export function get(url: URL): StartupTask[] {
+    const { searchParams } = url;
+    const encodedTasks = searchParams.get(QUERY);
+    if (encodedTasks) {
+      const rawTasks = decodeURIComponent(encodedTasks);
+      const tasks = JSON.parse(rawTasks);
+      if (Array.isArray(tasks)) {
+        return tasks.filter((task) => {
+          if (StartupTask.is(task)) {
+            return true;
+          }
+          console.warn(`Was not a task: ${JSON.stringify(task)}. Ignoring.`);
+          return false;
+        });
+      } else {
+        debugger;
+        console.warn(`Startup tasks was not an array: ${rawTasks}. Ignoring.`);
+      }
+    }
+    return [];
+  }
+  export function set(tasks: StartupTask[], url: URL): URL {
+    const copy = new URL(url);
+    copy.searchParams.set(QUERY, encodeURIComponent(JSON.stringify(tasks)));
+    return copy;
+  }
+  export function append(tasks: StartupTask[], url: URL): URL {
+    return set([...get(url), ...tasks], url);
   }
 }
-export namespace StartupTask {
-  export const QUERY_STRING = 'startupTasks';
+
+export namespace StartupTasks {
   export interface WorkspaceInput extends TheiaWorkspaceInput {
-    tasks: Task[];
+    tasks: StartupTask[];
   }
   export namespace WorkspaceInput {
     export function is(