@lvce-editor/update-worker 2.13.0 → 2.15.0

package/README.md

@@ -2,6 +2,20 @@
 
 Webworker for the update functionality in LVCE Editor.
 
+## Emulating the current version
+
+Set `update.emulateCurrentVersion` in LVCE Editor's `settings.json` to test update detection without installing an older build:
+
+```json
+{
+  "update.emulateCurrentVersion": "0.115.14"
+}
+```
+
+Update checks compare the latest GitHub release with this version. Remove the setting to use the normal application version. Empty, non-string, or malformed values also fall back to the application version; overrides must use numeric `major.minor.patch` format. The override only affects update comparisons, not the application's reported version or the selected release asset.
+
+The host must expose `Preferences.get` and `Process.getVersion` to the worker and use `Update.getLatestVersion` for manual update detection. Both manual checks and the install flow use the override. This requires an application build containing the worker and host integration; existing installed builds do not gain the setting automatically.
+
 ## Contributing
 
 ```sh
@@ -10,3 +24,9 @@ cd update-worker &&
 npm ci &&
 npm test
 ```
+
+## macOS updates
+
+The worker selects the release DMG matching the app's architecture, downloads it, and verifies its size and GitHub SHA-256 digest before writing it through the existing filesystem RPC. It then asks the host's small native helper to stage and validate the bundle. Install Update and Restart are separate confirmations; cancelling Restart leaves the app running. The Windows NSIS path remains in place.
+
+The host must expose `AutoUpdater.getPlatform`, `Process.getArch`, `AutoUpdater.stageMacUpdate`, and `AutoUpdater.restartMacUpdate`. Installation errors are returned to the host for notification. A release without the requested architecture or checksum is rejected. The native helper and host wiring must ship together with this worker before the installed macOS app can use the flow.

package/dist/updateWorkerMain.js

@@ -96,7 +96,6 @@ const walkValue = (value, transferrables, isTransferrable) => {
     for (const property of Object.values(value)) {
       walkValue(property, transferrables, isTransferrable);
     }
-    return;
   }
 };
 const getTransferrables = value => {
@@ -250,7 +249,14 @@ class IpcError extends VError {
       const cause = new Error(message);
       // @ts-ignore
       cause.code = code;
-      cause.stack = stack;
+      if (stack) {
+        Object.defineProperty(cause, 'stack', {
+          configurable: true,
+          enumerable: false,
+          value: stack,
+          writable: true
+        });
+      }
       super(cause, betterMessage);
     } else {
       super(betterMessage);
@@ -959,6 +965,34 @@ const listen$1 = async (module, options) => {
   return ipc;
 };
 
+const createSharedLazyRpc = factory => {
+  let rpcPromise;
+  const getOrCreate = () => {
+    if (!rpcPromise) {
+      rpcPromise = factory();
+    }
+    return rpcPromise;
+  };
+  return {
+    async dispose() {
+      const rpc = await getOrCreate();
+      await rpc.dispose();
+    },
+    async invoke(method, ...params) {
+      const rpc = await getOrCreate();
+      return rpc.invoke(method, ...params);
+    },
+    async invokeAndTransfer(method, ...params) {
+      const rpc = await getOrCreate();
+      return rpc.invokeAndTransfer(method, ...params);
+    },
+    async send(method, ...params) {
+      const rpc = await getOrCreate();
+      rpc.send(method, ...params);
+    }
+  };
+};
+
 const create$4 = async ({
   commandMap,
   isMessagePortOpen = true,
@@ -994,34 +1028,6 @@ const create$3 = async ({
   });
 };
 
-const createSharedLazyRpc = factory => {
-  let rpcPromise;
-  const getOrCreate = () => {
-    if (!rpcPromise) {
-      rpcPromise = factory();
-    }
-    return rpcPromise;
-  };
-  return {
-    async dispose() {
-      const rpc = await getOrCreate();
-      await rpc.dispose();
-    },
-    async invoke(method, ...params) {
-      const rpc = await getOrCreate();
-      return rpc.invoke(method, ...params);
-    },
-    async invokeAndTransfer(method, ...params) {
-      const rpc = await getOrCreate();
-      return rpc.invokeAndTransfer(method, ...params);
-    },
-    async send(method, ...params) {
-      const rpc = await getOrCreate();
-      rpc.send(method, ...params);
-    }
-  };
-};
-
 const create$2 = async ({
   commandMap,
   isMessagePortOpen,
@@ -1115,9 +1121,14 @@ const create = rpcId => {
   };
 };
 
+const Electron = 2;
+
 const DialogWorker = 7014;
 const RendererWorker = 1;
 
+const DownloadingUpdate = 2;
+const DownloadedUpdate = 3;
+
 const {
   invoke: invoke$1,
   set: set$1
@@ -1133,11 +1144,6 @@ const sendMessagePortToDialogWorker = async port => {
   await invokeAndTransfer('SendMessagePortToExtensionHostWorker.sendMessagePortToDialogWorker', port, command);
 };
 
-const Electron = 2;
-
-const DownloadingUpdate = 2;
-const DownloadedUpdate = 3;
-
 const emptyObject = {};
 const RE_PLACEHOLDER = /\{(PH\d+)\}/g;
 const i18nString = (key, placeholders = emptyObject) => {
@@ -1271,6 +1277,30 @@ const getDiskPath = async downloadUrl => {
   return diskPath;
 };
 
+const isGreater = (version, otherVersion) => {
+  const versionParts = version.split('.').map(Number);
+  const otherVersionParts = otherVersion.split('.').map(Number);
+  const partCount = Math.max(versionParts.length, otherVersionParts.length);
+  for (let index = 0; index < partCount; index++) {
+    const versionPart = versionParts[index] || 0;
+    const otherVersionPart = otherVersionParts[index] || 0;
+    if (versionPart !== otherVersionPart) {
+      return versionPart > otherVersionPart;
+    }
+  }
+  return false;
+};
+
+const getCurrentVersion = async () => {
+  // @ts-ignore
+  const override = await invoke('Preferences.get', 'update.emulateCurrentVersion');
+  if (typeof override === 'string' && /^\d+\.\d+\.\d+$/.test(override)) {
+    return override;
+  }
+  // @ts-ignore
+  return invoke('Process.getVersion');
+};
+
 const parseVersionFromUrl = (url, repository) => {
   if (!url.includes('releases/tag')) {
     if (url.endsWith('/releases')) {
@@ -1301,6 +1331,15 @@ const getLatestReleaseVersion = async repository => {
   }
 };
 
+const getLatestVersion = async repository => {
+  const currentVersion = await getCurrentVersion();
+  const release = await getLatestReleaseVersion(repository);
+  if (isGreater(release.version, currentVersion)) {
+    return release;
+  }
+  return undefined;
+};
+
 const getUpdateUrl = (repository, fileNameTemplate, version) => {
   const fileName = fileNameTemplate.replace('${version}', () => version);
   const url = `https://github.com/${repository}/releases/download/v${version}/${fileName}`;
@@ -1342,6 +1381,103 @@ const installAndRestart = async downloadPath => {
   }
 };
 
+const downloadMacUpdate = async (version, arch) => {
+  if (!/^\d+\.\d+\.\d+$/.test(version) || !['arm64', 'x64'].includes(arch)) {
+    throw new Error('Invalid macOS update version or architecture');
+  }
+  const repository = 'lvce-editor/lvce-editor';
+  const assetName = `lvce-v${version}_${arch}.dmg`;
+  const url = `https://github.com/${repository}/releases/download/v${version}/${assetName}`;
+  const metadata = await fetch(`https://api.github.com/repos/${repository}/releases/tags/v${version}`, {
+    headers: {
+      Accept: 'application/vnd.github+json'
+    },
+    signal: AbortSignal.timeout(30_000)
+  });
+  if (!metadata.ok) {
+    throw new Error(`Failed to read release metadata: HTTP ${metadata.status}`);
+  }
+  const release = await metadata.json();
+  const asset = release.assets?.find(item => item.name === assetName);
+  const maxSize = 512 * 1024 * 1024;
+  if (!asset || asset.browser_download_url !== url || !/^sha256:[a-f0-9]{64}$/.test(asset.digest) || !(asset.size > 0 && asset.size <= maxSize)) {
+    throw new Error(`Release is missing a valid ${assetName} asset or SHA-256 digest`);
+  }
+  const response = await fetch(url, {
+    signal: AbortSignal.timeout(600_000)
+  });
+  if (!response.ok || !response.body) {
+    throw new Error(`Failed to download update: HTTP ${response.status}`);
+  }
+  const reader = response.body.getReader();
+  const chunks = [];
+  let size = 0;
+  try {
+    while (true) {
+      const {
+        done,
+        value
+      } = await reader.read();
+      if (done) {
+        break;
+      }
+      size += value.byteLength;
+      if (size > asset.size) {
+        throw new Error('Update download exceeds the expected size');
+      }
+      chunks.push(new Uint8Array(value).buffer);
+    }
+  } finally {
+    await reader.cancel();
+  }
+  const blob = new Blob(chunks);
+  const hash = await crypto.subtle.digest('SHA-256', await blob.arrayBuffer());
+  const digest = `sha256:${Array.from(new Uint8Array(hash), byte => byte.toString(16).padStart(2, '0')).join('')}`;
+  if (size !== asset.size || digest !== asset.digest) {
+    throw new Error('Update download checksum or size does not match');
+  }
+  const diskPath = await getDiskPath(url);
+  await downloadToDisk(diskPath, new Response(blob));
+  return diskPath;
+};
+
+const installMacUpdate = async (version, download = downloadMacUpdate) => {
+  const install = await invoke$1('ConfirmPrompt.prompt', `Version ${version} is available. Install this update?`, {
+    confirmMessage: 'Install Update',
+    platform: Electron
+  });
+  if (!install) {
+    return {
+      error: undefined,
+      updated: false
+    };
+  }
+  // @ts-ignore
+  await invoke('Notification.create', 'info', `Preparing update ${version}...`);
+  // @ts-ignore
+  const arch = await invoke('Process.getArch');
+  const diskPath = await download(version, arch);
+  // @ts-ignore
+  await invoke('AutoUpdater.stageMacUpdate', diskPath, version);
+  const restart = await invoke$1('ConfirmPrompt.prompt', `Update ${version} is ready. Restart to finish installing?`, {
+    cancelMessage: 'Later',
+    confirmMessage: 'Restart',
+    platform: Electron
+  });
+  if (!restart) {
+    return {
+      error: undefined,
+      updated: false
+    };
+  }
+  // @ts-ignore
+  await invoke('AutoUpdater.restartMacUpdate');
+  return {
+    error: undefined,
+    updated: true
+  };
+};
+
 const isCached = async (url, cache) => {
   const match = await cache.match(url);
   return !!match;
@@ -1368,13 +1504,18 @@ const doCheckForUpdates = async (updateSetting, repository, fileNameTemplate, bu
         updated: false
       };
     }
-    const info = await getLatestReleaseVersion(repository);
+    const info = await getLatestVersion(repository);
     if (!info || !info.version) {
       return {
         error: undefined,
         updated: false
       };
     }
+    // @ts-ignore
+    const platform = await invoke('AutoUpdater.getPlatform');
+    if (platform === 'darwin') {
+      return await installMacUpdate(info.version);
+    }
     const cache = await getCache(bucketName, cacheName);
     if (!(await shouldUpdate(updateSetting, info.version))) {
       return {
@@ -1424,7 +1565,7 @@ const doCheckForUpdates = async (updateSetting, repository, fileNameTemplate, bu
   } catch (error) {
     console.error(error);
     return {
-      error: undefined,
+      error: error instanceof Error ? error.message : String(error),
       updated: false
     };
   }
@@ -1457,7 +1598,8 @@ const checkForUpdates = async (updateSetting, repository) => {
 
 const commandMap = {
   'Update.checkForUpdates': checkForUpdates,
-  'Update.downloadToCache': downloadUpdateToCache
+  'Update.downloadToCache': downloadUpdateToCache,
+  'Update.getLatestVersion': getLatestVersion
 };
 
 const listen = async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/update-worker",
-  "version": "2.13.0",
+  "version": "2.15.0",
   "description": "Update Worker",
   "repository": {
     "type": "git",