patch the index.html only in the bundled app.

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

Author: Akos Kitta

arduino-ide-extension/src/browser/theia/core/frontend-application.ts

@@ -36,9 +36,22 @@ export class FrontendApplication extends TheiaFrontendApplication {
   }
 
   protected getStartupIndicator(host: HTMLElement): HTMLElement | undefined {
-    const startupElements = host.getElementsByClassName('old-theia-preload'); // https://github.com/eclipse-theia/theia/pull/10761#issuecomment-1131476318
-    return startupElements.length === 0
-      ? undefined
-      : (startupElements[0] as HTMLElement);
+    let startupElement = this.doGetStartupIndicator(host, 'old-theia-preload'); // https://github.com/eclipse-theia/theia/pull/10761#issuecomment-1131476318
+    if (!startupElement) {
+      startupElement = this.doGetStartupIndicator(host, 'theia-preload'); // We show the new Theia spinner in dev mode.
+    }
+    return startupElement;
+  }
+
+  private doGetStartupIndicator(
+    host: HTMLElement,
+    classNames: string
+  ): HTMLElement | undefined {
+    const elements = host.getElementsByClassName(classNames);
+    const first = elements[0];
+    if (first instanceof HTMLElement) {
+      return first;
+    }
+    return undefined;
   }
 }

arduino-ide-extension/src/electron-main/theia/electron-main-application.ts

@@ -91,6 +91,9 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
     const workspaces: WorkspaceOptions[] | undefined = this.electronStore.get(WORKSPACES);
     let useDefault = true;
     if (workspaces && workspaces.length > 0) {
+      console.log(
+        `Restoring workspace roots: ${workspaces.map(({ file }) => file)}`
+      );
       for (const workspace of workspaces) {
         if (await this.isValidSketchPath(workspace.file)) {
           useDefault = false;
@@ -181,7 +184,7 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
     options = this.avoidOverlap(options);
     let electronWindow: BrowserWindow | undefined;
     if (this.windows.size) {
-      electronWindow = await super.createWindow(options);
+      electronWindow = await this.doCreateWindow(options);
     } else {
       const { bounds } = screen.getDisplayNearestPoint(
         screen.getCursorScreenPoint()
@@ -221,11 +224,22 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
           minVisible: 2000,
           splashScreenOpts,
         },
-        (windowOptions) => super.createWindow(windowOptions),
+        (windowOptions) => this.doCreateWindow(windowOptions),
         this.splashService.onCloseRequested
       );
     }
+    return electronWindow;
+  }
+
+  private async doCreateWindow(
+    options: TheiaBrowserWindowOptions
+  ): Promise<BrowserWindow> {
+    const electronWindow = await super.createWindow(options);
+    this.attachListenersToWindow(electronWindow);
+    return electronWindow;
+  }
 
+  private attachListenersToWindow(electronWindow: BrowserWindow) {
     electronWindow.webContents.on(
       'new-window',
       (event, url, frameName, disposition, options) => {
@@ -254,7 +268,6 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
       }
     );
     this.attachClosedWorkspace(electronWindow);
-    return electronWindow;
   }
 
   protected async startBackend(): Promise<number> {
@@ -331,12 +344,16 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
       if (workspace) {
         const workspaceUri = URI.file(workspace);
         const bounds = window.getNormalBounds();
+        const now = Date.now();
+        console.log(
+          `Marking workspace as a closed sketch. Workspace URI: ${workspaceUri.toString()}. Date: ${now}.`
+        );
         this.closedWorkspaces.push({
           ...bounds,
           isMaximized: window.isMaximized(),
           isFullScreen: window.isFullScreen(),
           file: workspaceUri.fsPath,
-          time: Date.now()
+          time: now
         })
       }
     });
@@ -346,14 +363,29 @@ export class ElectronMainApplication extends TheiaElectronMainApplication {
     // Only add workspaces which were closed within the last second (1000 milliseconds)
     const threshold = Date.now() - 1000;
     const visited = new Set<string>();
-    const workspaces = this.closedWorkspaces.filter(e => {
-      if (e.time < threshold || visited.has(e.file)) {
-        return false;
-      }
-      visited.add(e.file);
-      return true;
-    }).sort((a, b) => a.file.localeCompare(b.file));
+    const workspaces = this.closedWorkspaces
+      .filter((e) => {
+        if (e.time < threshold) {
+          console.log(
+            `Skipped storing sketch as workspace root. Expected minimum threshold: <${threshold}>. Was: <${e.time}>.`
+          );
+          return false;
+        }
+        if (visited.has(e.file)) {
+          console.log(
+            `Skipped storing sketch as workspace root. Already visited: <${e.file}>.`
+          );
+          return false;
+        }
+        visited.add(e.file);
+        console.log(`Storing the sketch as a workspace root: <${e.file}>.`);
+        return true;
+      })
+      .sort((a, b) => a.file.localeCompare(b.file));
     this.electronStore.set(WORKSPACES, workspaces);
+    console.log(
+      `Stored workspaces roots: ${workspaces.map(({ file }) => file)}`
+    );
 
     super.onWillQuit(event);
   }

electron-app/package.json

@@ -29,7 +29,7 @@
     "electron": "^15.3.5"
   },
   "scripts": {
-    "prepare": "theia build --mode development && node ./scripts/patch-theia-preload.js ./lib/index.html",
+    "prepare": "theia build --mode development",
     "start": "theia start --plugins=local-dir:../plugins",
     "watch": "theia build --watch --mode development"
   },

electron/build/scripts/patch-theia-preload.js

@@ -0,0 +1,16 @@
+// Patch the Theia spinner: https://github.com/eclipse-theia/theia/pull/10761#issuecomment-1131476318
+// Replaces the `theia-preload` selector with `old-theia-preload` in the generated `index.html`.
+let arg = process.argv.splice(2)[0]
+if (!arg) {
+    console.error("The path to the index.html to patch is missing. Use 'node patch-theia-preload.js ./path/to/index.html'")
+    process.exit(1)
+}
+(async () => {
+    const { promises: fs } = require('fs')
+    const path = require('path')
+    const index = path.isAbsolute(arg) ? arg : path.join(process.cwd(), arg)
+    console.log(`>>> Patching 'theia-preload' with 'old-theia-preload' in ${index}.`)
+    const content = await fs.readFile(index, { encoding: 'utf-8' })
+    await fs.writeFile(index, content.replace(/theia-preload/g, 'old-theia-preload'), { encoding: 'utf-8' })
+    console.log(`<<< Successfully patched index.html.`)
+})()

electron/build/template-package.json

@@ -25,7 +25,7 @@
     "package": "cross-env DEBUG=* && electron-builder --publish=never",
     "package:publish": "cross-env DEBUG=* && electron-builder --publish=always",
     "download:plugins": "theia download:plugins",
-    "patch": "ncp ./patch/main.js ./src-gen/backend/main.js && node ../../electron-app/scripts/patch-theia-preload.js ./lib/index.html"
+    "patch": "ncp ./patch/main.js ./src-gen/backend/main.js && node ./scripts/patch-theia-preload.js ./lib/index.html"
   },
   "engines": {
     "node": ">=14.0.0 <15"

yarn.lock

@@ -4408,7 +4408,7 @@ array-ify@^1.0.0:
   resolved "https://registry.yarnpkg.com/array-ify/-/array-ify-1.0.0.tgz#9e528762b4a9066ad163a6962a364418e9626ece"
   integrity sha512-c5AMf34bKdvPhQ7tBGhqkgKNUzMr4WUs+WDtC2ZUGOUncbxKMTvqxYctiseW3+L4bA8ec+GcZ6/A/FW4m8ukng==
 
-array-includes@^3.1.4:
+array-includes@^3.1.4, array-includes@^3.1.5:
   version "3.1.5"
   resolved "https://registry.yarnpkg.com/array-includes/-/array-includes-3.1.5.tgz#2c320010db8d31031fd2a5f6b3bbd4b1aad31bdb"
   integrity sha512-iSDYZMMyTPkiFasVqfuAQnWAYcvO/SeBSCGKePoEthjp4LEMTe4uLc7b025o4jAZpHhihh8xPo99TNWUWWkGDQ==
@@ -4450,7 +4450,7 @@ array-unique@^0.3.2:
   resolved "https://registry.yarnpkg.com/array-unique/-/array-unique-0.3.2.tgz#a894b75d4bc4f6cd679ef3244a9fd8f46ae2d428"
   integrity sha512-SleRWjh9JUud2wH1hPs9rZBZ33H6T9HOiL0uwGnGx9FpE6wKGyfWugmbkEOIs6qWrZhg0LWeLziLrEwQJhs5mQ==
 
-array.prototype.flatmap@^1.2.5:
+array.prototype.flatmap@^1.3.0:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/array.prototype.flatmap/-/array.prototype.flatmap-1.3.0.tgz#a7e8ed4225f4788a70cd910abcf0791e76a5534f"
   integrity sha512-PZC9/8TKAIxcWKdyeb77EzULHPrIX/tIZebLJUQOMR1OwYosT8yggdfWScfTBCDj5utONvOuPQQumYsU2ULbkg==
@@ -5023,7 +5023,7 @@ cacache@^15.2.0:
     tar "^6.0.2"
     unique-filename "^1.1.1"
 
-cacache@^16.0.2:
+cacache@^16.1.0:
   version "16.1.0"
   resolved "https://registry.yarnpkg.com/cacache/-/cacache-16.1.0.tgz#87a6bae558a511c9cb2a13768073e240ca76153a"
   integrity sha512-Pk4aQkwCW82A4jGKFvcGkQFqZcMspfP9YWq9Pr87/ldDvlWf718zeI6KWCdKt/jeihu6BytHRUicJPB1K2k8EQ==
@@ -6822,24 +6822,24 @@ eslint-plugin-react-hooks@^4.2.0:
   integrity sha512-8k1gRt7D7h03kd+SAAlzXkQwWK22BnK6GKZG+FJA6BAGy22CFvl8kCIXKpVux0cCxMWDQUPqSok0LKaZ0aOcCw==
 
 eslint-plugin-react@^7.24.0:
-  version "7.29.4"
-  resolved "https://registry.yarnpkg.com/eslint-plugin-react/-/eslint-plugin-react-7.29.4.tgz#4717de5227f55f3801a5fd51a16a4fa22b5914d2"
-  integrity sha512-CVCXajliVh509PcZYRFyu/BoUEz452+jtQJq2b3Bae4v3xBUWPLCmtmBM+ZinG4MzwmxJgJ2M5rMqhqLVn7MtQ==
+  version "7.30.0"
+  resolved "https://registry.yarnpkg.com/eslint-plugin-react/-/eslint-plugin-react-7.30.0.tgz#8e7b1b2934b8426ac067a0febade1b13bd7064e3"
+  integrity sha512-RgwH7hjW48BleKsYyHK5vUAvxtE9SMPDKmcPRQgtRCYaZA0XQPt5FSkrU3nhz5ifzMZcA8opwmRJ2cmOO8tr5A==
   dependencies:
-    array-includes "^3.1.4"
-    array.prototype.flatmap "^1.2.5"
+    array-includes "^3.1.5"
+    array.prototype.flatmap "^1.3.0"
     doctrine "^2.1.0"
     estraverse "^5.3.0"
     jsx-ast-utils "^2.4.1 || ^3.0.0"
     minimatch "^3.1.2"
     object.entries "^1.1.5"
     object.fromentries "^2.0.5"
-    object.hasown "^1.1.0"
+    object.hasown "^1.1.1"
     object.values "^1.1.5"
     prop-types "^15.8.1"
     resolve "^2.0.0-next.3"
     semver "^6.3.0"
-    string.prototype.matchall "^4.0.6"
+    string.prototype.matchall "^4.0.7"
 
 eslint-plugin-unused-imports@^1.1.1:
   version "1.1.5"
@@ -9503,9 +9503,9 @@ keyv@^3.0.0:
     json-buffer "3.0.0"
 
 keyv@^4.0.0:
-  version "4.2.8"
-  resolved "https://registry.yarnpkg.com/keyv/-/keyv-4.2.8.tgz#6c91189fe6134d8a526cb360566693c095fcfb60"
-  integrity sha512-IZZo6krhHWPhgsP5mBkEdPopVPN/stgCnBVuqi6dda/Nm5mDTOSVTrFMkWqlJsDum+B0YSe887tNxdjDWkO7aQ==
+  version "4.2.9"
+  resolved "https://registry.yarnpkg.com/keyv/-/keyv-4.2.9.tgz#b8f25d4968b583ed7f07fceadab646d4baadad6b"
+  integrity sha512-vqRBrN4xQHud7UMAGzGGFbt96MtGB9pb0OOg8Dhtq5RtiswCb1pCFq878iqC4hdeOP6eDPnCoFxA+2TXx427Ow==
   dependencies:
     compress-brotli "^1.3.8"
     json-buffer "3.0.1"
@@ -10027,12 +10027,12 @@ make-dir@^3.0.0, make-dir@^3.0.2, make-dir@^3.1.0:
     semver "^6.0.0"
 
 make-fetch-happen@^10.0.3:
-  version "10.1.3"
-  resolved "https://registry.yarnpkg.com/make-fetch-happen/-/make-fetch-happen-10.1.3.tgz#d7ecd4a22563b2c05b74735eda46569da26a46f6"
-  integrity sha512-s/UjmGjUHn9m52cctFhN2ITObbT+axoUhgeir8xGrOlPbKDyJsdhQzb8PGncPQQ28uduHybFJ6Iumy2OZnreXw==
+  version "10.1.4"
+  resolved "https://registry.yarnpkg.com/make-fetch-happen/-/make-fetch-happen-10.1.4.tgz#b68a64367d2c402f24edc48308ff193d11fc2618"
+  integrity sha512-hU1w68PqfH7FdMgjbiziJoACY0edlbIZ0CyKnpcEruVdCjsUrN+qoenOCIayNqVBK7toSWwbDxvQlrhH0gjRdg==
   dependencies:
     agentkeepalive "^4.2.1"
-    cacache "^16.0.2"
+    cacache "^16.1.0"
     http-cache-semantics "^4.1.0"
     http-proxy-agent "^5.0.0"
     https-proxy-agent "^5.0.0"
@@ -10910,7 +10910,7 @@ nano@^9.0.5:
     qs "^6.9.4"
     tough-cookie "^4.0.0"
 
-nanoid@^3.3.3:
+nanoid@^3.3.4:
   version "3.3.4"
   resolved "https://registry.yarnpkg.com/nanoid/-/nanoid-3.3.4.tgz#730b67e3cd09e2deacf03c027c81c9d9dbc5e8ab"
   integrity sha512-MqBkQh/OHTS2egovRtLk45wEyNXwF+cokD+1YPf9u5VfJiRdAiRwB2froX5Co9Rh20xs4siNPm8naNotSD6RBw==
@@ -11396,7 +11396,7 @@ object.getownpropertydescriptors@^2.0.3:
     define-properties "^1.1.3"
     es-abstract "^1.19.1"
 
-object.hasown@^1.1.0:
+object.hasown@^1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/object.hasown/-/object.hasown-1.1.1.tgz#ad1eecc60d03f49460600430d97f23882cf592a3"
   integrity sha512-LYLe4tivNQzq4JdaWW6WO3HMZZJWzkkH8fnI6EebWl0VZth2wL2Lovm74ep2/gZzlaTdV62JZHEqHQ2yVn8Q/A==
@@ -12069,11 +12069,11 @@ postcss-value-parser@^4.1.0, postcss-value-parser@^4.2.0:
   integrity sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==
 
 postcss@^8.4.7:
-  version "8.4.13"
-  resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.4.13.tgz#7c87bc268e79f7f86524235821dfdf9f73e5d575"
-  integrity sha512-jtL6eTBrza5MPzy8oJLFuUscHDXTV5KcLlqAWHl5q5WYRfnNRGSmOZmOZ1T6Gy7A99mOZfqungmZMpMmCVJ8ZA==
+  version "8.4.14"
+  resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.4.14.tgz#ee9274d5622b4858c1007a74d76e42e56fd21caf"
+  integrity sha512-E398TUmfAYFPBSdzgeieK2Y1+1cpdxJx8yXbK/m57nRhKSmk1GB2tO4lbLBtlkfPQTDKfe4Xqv1ASWPpayPEig==
   dependencies:
-    nanoid "^3.3.3"
+    nanoid "^3.3.4"
     picocolors "^1.0.0"
     source-map-js "^1.0.2"
 
@@ -13965,7 +13965,7 @@ string-width@^3.0.0, string-width@^3.1.0:
     is-fullwidth-code-point "^2.0.0"
     strip-ansi "^5.1.0"
 
-string.prototype.matchall@^4.0.6:
+string.prototype.matchall@^4.0.7:
   version "4.0.7"
   resolved "https://registry.yarnpkg.com/string.prototype.matchall/-/string.prototype.matchall-4.0.7.tgz#8e6ecb0d8a1fb1fda470d81acecb2dba057a481d"
   integrity sha512-f48okCX7JiwVi1NXCVWcFnZgADDC/n2vePlQ/KUCNqCikLLilQvwjMO8+BHVKvgzH0JB0J9LEPgxOGT02RoETg==