@holochain/hc-spin 0.200.13 → 0.200.15

package/cli/cli.js

@@ -1,36 +1,39 @@
 #!/usr/bin/env node
-const { spawn } = require('child_process');
+const { spawn, spawnSync } = require('child_process');
 const path = require('path');
 const fs = require('fs');
 
-let electronBinary;
-let pathStr =
-  process.platform === 'win32'
-    ? '../node_modules/electron/dist/electron.exe'
-    : '../node_modules/.bin/electron';
-
-// recursively look for electron binary in node_modules folder
-for (let i = 0; i < 7; i++) {
-  const maybeElectronBinary = path.resolve(__dirname, pathStr);
-  if (fs.existsSync(maybeElectronBinary)) {
-    electronBinary = maybeElectronBinary;
-    break;
-  } else {
-    pathStr = '../' + pathStr;
-  }
-}
+let electronBinary = process.env.ELECTRON_BINARY;
+
+if (!electronBinary) {
+  // Check whether electron is installed globally and compare with the expected version
+  const electronHandleTemp = spawnSync('electron', ['--version']);
 
-// https://github.com/electron/electron/issues/17972
-if (process.platform === 'linux') {
-  let chromeSandboxPathStr = '../node_modules/electron/dist/chrome-sandbox';
-  // recursively look for electron binary in node_modules folder
-  for (let i = 0; i < 7; i++) {
-    const maybeChromeSandbox = path.resolve(__dirname, chromeSandboxPathStr);
-    if (fs.existsSync(maybeChromeSandbox)) {
-      fs.chmodSync(maybeChromeSandbox, 0o4755);
-      break;
+  if (electronHandleTemp.stdout) {
+    if (!electronHandleTemp.stdout.toString().startsWith('v###REPLACE_AT_BUILD_TIME###')) {
+      console.warn(
+        'WARNING: Found a globally installed electron version but it does not match the version requirements of hc-spin (v29.x). The electron binary from node_modules will be used instead.',
+      );
     } else {
-      chromeSandboxPathStr = '../' + chromeSandboxPathStr;
+      electronBinary = 'electron';
+    }
+  }
+
+  if (!electronBinary) {
+    let pathStr =
+      process.platform === 'win32'
+        ? '../node_modules/electron/dist/electron.exe'
+        : '../node_modules/.bin/electron';
+
+    // recursively look for electron binary in node_modules folder
+    for (let i = 0; i < 7; i++) {
+      const maybeElectronBinary = path.resolve(__dirname, pathStr);
+      if (fs.existsSync(maybeElectronBinary)) {
+        electronBinary = maybeElectronBinary;
+        break;
+      } else {
+        pathStr = '../' + pathStr;
+      }
     }
   }
 }

package/dist/cli.js

@@ -1,36 +1,39 @@
 #!/usr/bin/env node
-const { spawn } = require('child_process');
+const { spawn, spawnSync } = require('child_process');
 const path = require('path');
 const fs = require('fs');
 
-let electronBinary;
-let pathStr =
-  process.platform === 'win32'
-    ? '../node_modules/electron/dist/electron.exe'
-    : '../node_modules/.bin/electron';
-
-// recursively look for electron binary in node_modules folder
-for (let i = 0; i < 7; i++) {
-  const maybeElectronBinary = path.resolve(__dirname, pathStr);
-  if (fs.existsSync(maybeElectronBinary)) {
-    electronBinary = maybeElectronBinary;
-    break;
-  } else {
-    pathStr = '../' + pathStr;
-  }
-}
+let electronBinary = process.env.ELECTRON_BINARY;
+
+if (!electronBinary) {
+  // Check whether electron is installed globally and compare with the expected version
+  const electronHandleTemp = spawnSync('electron', ['--version']);
 
-// https://github.com/electron/electron/issues/17972
-if (process.platform === 'linux') {
-  let chromeSandboxPathStr = '../node_modules/electron/dist/chrome-sandbox';
-  // recursively look for electron binary in node_modules folder
-  for (let i = 0; i < 7; i++) {
-    const maybeChromeSandbox = path.resolve(__dirname, chromeSandboxPathStr);
-    if (fs.existsSync(maybeChromeSandbox)) {
-      fs.chmodSync(maybeChromeSandbox, 0o4755);
-      break;
+  if (electronHandleTemp.stdout) {
+    if (!electronHandleTemp.stdout.toString().startsWith('v29.')) {
+      console.warn(
+        'WARNING: Found a globally installed electron version but it does not match the version requirements of hc-spin (v29.x). The electron binary from node_modules will be used instead.',
+      );
     } else {
-      chromeSandboxPathStr = '../' + chromeSandboxPathStr;
+      electronBinary = 'electron';
+    }
+  }
+
+  if (!electronBinary) {
+    let pathStr =
+      process.platform === 'win32'
+        ? '../node_modules/electron/dist/electron.exe'
+        : '../node_modules/.bin/electron';
+
+    // recursively look for electron binary in node_modules folder
+    for (let i = 0; i < 7; i++) {
+      const maybeElectronBinary = path.resolve(__dirname, pathStr);
+      if (fs.existsSync(maybeElectronBinary)) {
+        electronBinary = maybeElectronBinary;
+        break;
+      } else {
+        pathStr = '../' + pathStr;
+      }
     }
   }
 }

package/dist/main/index.js

@@ -115,6 +115,7 @@ electron.contextBridge.exposeInMainWorld("__HC_LAUNCHER_ENV__", {
     title: `Agent ${agentNum} - ${appId}`,
     webPreferences: {
       preload: preloadPath,
+      sandbox: true,
       partition
     }
   });
@@ -11860,7 +11861,13 @@ electron.protocol.registerSchemesAsPrivileged([
 contextMenu({
   showSaveImageAs: true,
   showSearchWithGoogle: false,
-  showInspectElement: true
+  showInspectElement: true,
+  append: (_defaultActions, _parameters, browserWindow) => [
+    {
+      label: "Reload",
+      click: () => browserWindow.reload()
+    }
+  ]
 });
 const handleSignZomeCall = async (e, request) => {
   const windowInfo = WINDOW_INFO_MAP[e.sender.id];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/hc-spin",
-  "version": "0.200.13",
+  "version": "0.200.15",
   "holochainVersion": "0.2.x",
   "description": "CLI to run Holochain aps during development.",
   "author": "matthme",
@@ -30,7 +30,7 @@
     "typecheck": "npm run typecheck:node && npm run typecheck:web",
     "start": "electron-vite preview",
     "dev": "electron-vite dev",
-    "build": "rimraf dist && npm run typecheck && electron-vite build && mv ./out ./dist && cp ./cli/cli.js ./dist/cli.js"
+    "build": "rimraf dist && npm run typecheck && electron-vite build && mv ./out ./dist && cp ./cli/cli.js ./dist/cli.js && node ./scripts/replace-electron-version.js"
   },
   "dependencies": {
     "@electron-toolkit/preload": "^3.0.0",
@@ -39,7 +39,7 @@
     "@holochain/hc-spin-rust-utils": "^0.200.3",
     "@msgpack/msgpack": "^2.8.0",
     "commander": "11.1.0",
-    "electron": "^28.1.1",
+    "electron": "^29.3.1",
     "electron-context-menu": "3.6.1",
     "get-port": "7.0.0",
     "nanoid": "5.0.4",

package/scripts/replace-electron-version.js

@@ -0,0 +1,11 @@
+const fs = require('fs');
+
+const packageJsonString = fs.readFileSync('package.json');
+const packageJson = JSON.parse(packageJsonString);
+const electronVersion = packageJson.dependencies.electron;
+const majorElectronVersion = electronVersion.replace('^', '').slice(0, 3);
+console.log('electron version: ', majorElectronVersion);
+
+const cliJs = fs.readFileSync('./dist/cli.js', 'utf-8');
+const modifiedCliJs = cliJs.replace('###REPLACE_AT_BUILD_TIME###', majorElectronVersion);
+fs.writeFileSync('./dist/cli.js', modifiedCliJs);

package/src/main/index.ts

@@ -1,4 +1,4 @@
-import { app, IpcMainInvokeEvent, ipcMain, protocol, Menu } from 'electron';
+import { app, IpcMainInvokeEvent, ipcMain, protocol, Menu, BrowserWindow } from 'electron';
 import fs from 'fs';
 import path from 'path';
 import { nanoid } from 'nanoid';
@@ -119,6 +119,12 @@ contextMenu({
   showSaveImageAs: true,
   showSearchWithGoogle: false,
   showInspectElement: true,
+  append: (_defaultActions, _parameters, browserWindow) => [
+    {
+      label: 'Reload',
+      click: () => (browserWindow as BrowserWindow).reload(),
+    },
+  ],
 });
 
 const handleSignZomeCall = async (e: IpcMainInvokeEvent, request: CallZomeRequest) => {

package/src/main/windows.ts

@@ -88,6 +88,7 @@ electron.contextBridge.exposeInMainWorld("__HC_LAUNCHER_ENV__", {
     title: `Agent ${agentNum} - ${appId}`,
     webPreferences: {
       preload: preloadPath,
+      sandbox: true,
       partition,
     },
   });