electron-incremental-update 2.3.7 → 2.4.0

package/README.md

@@ -103,7 +103,6 @@ export default defineConfig(async ({ command }) => {
     plugins: [
       electronWithUpdater({
         isBuild,
-        logParsedOptions: true,
         main: {
           files: ['./electron/main/index.ts', './electron/main/worker.ts'],
           // see https://github.com/electron-vite/electron-vite-vue/blob/85ed267c4851bf59f32888d766c0071661d4b94c/vite.config.ts#L22-L28
@@ -278,7 +277,7 @@ const plugin = electronWithUpdater({
         db: './electron/native/db.ts',
         img: './electron/native/img.ts',
       },
-      postBuild: async ({ copyToEntryOutputDir, copyModules }) => {
+      postBuild: ({ copyToEntryOutputDir, copyModules }) => {
         // for better-sqlite3
         copyToEntryOutputDir({
           from: './node_modules/better-sqlite3/build/Release/better_sqlite3.node',
@@ -286,7 +285,7 @@ const plugin = electronWithUpdater({
         })
         // for @napi-rs/image
         const startStr = '@napi-rs+image-'
-        const fileName = (await readdir('./node_modules/.pnpm')).filter(p => p.startsWith(startStr))[0]
+        const fileName = readdirSync('./node_modules/.pnpm').find(p => p.startsWith(startStr))!
         const archName = fileName.substring(startStr.length).split('@')[0]
         copyToEntryOutputDir({
           from: `./node_modules/.pnpm/${fileName}/node_modules/@napi-rs/image-${archName}/image.${archName}.node`,
@@ -350,6 +349,74 @@ module.exports = {
 }
 ```
 
+#### Result in app.asar
+
+Before: Redundant 🤮
+
+```
+.
+├── dist-entry
+│   ├── chunk-IVHNGRZY-BPUeB0jT.js
+│   ├── db.js
+│   ├── entry.js
+│   └── image.js
+├── node_modules
+│   ├── @napi-rs
+│   ├── base64-js
+│   ├── better-sqlite3
+│   ├── bindings
+│   ├── bl
+│   ├── buffer
+│   ├── chownr
+│   ├── decompress-response
+│   ├── deep-extend
+│   ├── detect-libc
+│   ├── end-of-stream
+│   ├── expand-template
+│   ├── file-uri-to-path
+│   ├── fs-constants
+│   ├── github-from-package
+│   ├── ieee754
+│   ├── inherits
+│   ├── ini
+│   ├── mimic-response
+│   ├── minimist
+│   ├── mkdirp-classic
+│   ├── napi-build-utils
+│   ├── node-abi
+│   ├── once
+│   ├── prebuild-install
+│   ├── pump
+│   ├── rc
+│   ├── readable-stream
+│   ├── safe-buffer
+│   ├── semver
+│   ├── simple-concat
+│   ├── simple-get
+│   ├── string_decoder
+│   ├── strip-json-comments
+│   ├── tar-fs
+│   ├── tar-stream
+│   ├── tunnel-agent
+│   ├── util-deprecate
+│   └── wrappy
+└── package.json
+```
+
+After: Clean 😍
+
+```
+.
+├── dist-entry
+│   ├── better_sqlite3.node
+│   ├── chunk-IVHNGRZY-BPUeB0jT.js
+│   ├── db.js
+│   ├── entry.js
+│   ├── image.js
+│   └── image.win32-x64-msvc.node
+└── package.json
+```
+
 ### Bytecode Protection
 
 Use V8 cache to protect the source code
@@ -756,12 +823,6 @@ export interface ElectronWithUpdaterOptions {
    * @default isCI
    */
   buildVersionJson?: boolean
-  /**
-   * Whether to log parsed options
-   *
-   * To show certificate and private keys, set `logParsedOptions: { showKeys: true }`
-   */
-  logParsedOptions?: boolean | { showKeys: boolean }
   /**
    * Main process options
    *
@@ -923,7 +984,9 @@ export interface BuildEntryOption {
   /**
    * `external` option in `build.rollupOptions`,
    * default is node built-in modules or native modules.
-   * If is in dev, also external `dependencies` in package.json
+   *
+   * If is in dev and {@link postBuild} is not setup, will also
+   * external `dependencies` in `package.json`
    */
   external?: NonNullable<NonNullable<InlineConfig['build']>['rollupOptions']>['external']
   /**
@@ -944,8 +1007,9 @@ export interface BuildEntryOption {
    */
   overrideViteOptions?: InlineConfig
   /**
-   * Resolve extra files on startup, such as `.node`
-   * @remark won't trigger will reload
+   * By default, all the unbundled modules will be packaged by packager like `electron-builder`.
+   * If setup, all the `dependencies` in `package.json` will be bundled by default, and you need
+   * to manually handle the native module files.
    */
   postBuild?: (args: {
     /**

package/dist/index.cjs

@@ -56,6 +56,7 @@ var Updater = class extends events.EventEmitter {
   controller;
   info;
   tmpFilePath;
+  processing = false;
   provider;
   /**
    * Updater logger
@@ -142,9 +143,17 @@ var Updater = class extends events.EventEmitter {
   async checkForUpdates(data) {
     const emitUnavailable = (msg, code, info2) => {
       this.logger?.info(`[${code}] ${msg}`);
+      this.logger?.debug("Check update end");
+      this.processing = false;
       this.emit("update-not-available", code, msg, info2);
       return false;
     };
+    if (this.processing) {
+      this.logger?.info("Updater is already processing, skip check update");
+      return false;
+    }
+    this.processing = true;
+    this.logger?.debug("Check update start");
     if (!data && !this.provider) {
       const msg = "No update json or provider";
       this.err("Check update failed", "ERR_PARAM", msg);
@@ -195,8 +204,10 @@ var Updater = class extends events.EventEmitter {
         );
       }
       this.logger?.info(`Update available: ${version}`);
-      this.emit("update-available", extraVersionInfo);
       this.info = info;
+      this.processing = false;
+      this.logger?.debug("Check update end");
+      this.emit("update-available", extraVersionInfo);
       return true;
     } catch {
       const msg = "Fail to parse version string";
@@ -209,41 +220,45 @@ var Updater = class extends events.EventEmitter {
     }
   }
   async downloadUpdate(data, info) {
+    const emitError = (code, errorInfo) => {
+      this.err(`Download update failed`, code, errorInfo);
+      this.logger?.debug("Download update end");
+      this.processing = false;
+      return false;
+    };
+    if (this.processing) {
+      this.logger?.info("Updater is already processing, skip download update");
+      return false;
+    }
+    this.processing = true;
+    this.logger?.debug("Download update start");
     const _sig = info?.signature ?? this.info?.signature;
     const _version = info?.version ?? this.info?.version;
     if (!_sig || !_version) {
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_PARAM",
         "No update signature, please call `checkUpdate` first or manually setup params"
       );
-      return false;
     }
     if (!data && !this.provider) {
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_PARAM",
         "No update asar buffer and provider"
       );
-      return false;
     }
     const buffer = await this.fetch("buffer", data ? Buffer.from(data) : void 0);
     if (!buffer) {
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_PARAM",
         "No update asar file buffer"
       );
-      return false;
     }
     this.logger?.debug("Validation start");
     if (!await this.provider.verifySignaure(buffer, _version, _sig, this.CERT)) {
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_VALIDATE",
         "Invalid update asar file"
       );
-      return false;
     }
     this.logger?.debug("Validation end");
     try {
@@ -253,15 +268,15 @@ var Updater = class extends events.EventEmitter {
       this.logger?.info(`Download success, version: ${_version}`);
       this.info = void 0;
       this.emit("update-downloaded");
+      this.processing = false;
+      this.logger?.debug("Download update end");
       return true;
     } catch (error) {
       this.cleanup();
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_DOWNLOAD",
-        `Fail to unwrap asar file, ${error}`
+        `Failed to write update file: ${error instanceof Error ? error.message : error}`
       );
-      return false;
     }
   }
   /**

package/dist/index.d.cts

@@ -62,6 +62,7 @@ declare class Updater<T extends UpdateInfoWithExtraVersion = UpdateInfoWithExtra
     private controller;
     private info?;
     private tmpFilePath?;
+    private processing;
     provider?: IProvider;
     /**
      * Updater logger

package/dist/index.d.ts

@@ -62,6 +62,7 @@ declare class Updater<T extends UpdateInfoWithExtraVersion = UpdateInfoWithExtra
     private controller;
     private info?;
     private tmpFilePath?;
+    private processing;
     provider?: IProvider;
     /**
      * Updater logger

package/dist/index.js

@@ -20,6 +20,7 @@ var Updater = class extends EventEmitter {
   controller;
   info;
   tmpFilePath;
+  processing = false;
   provider;
   /**
    * Updater logger
@@ -106,9 +107,17 @@ var Updater = class extends EventEmitter {
   async checkForUpdates(data) {
     const emitUnavailable = (msg, code, info2) => {
       this.logger?.info(`[${code}] ${msg}`);
+      this.logger?.debug("Check update end");
+      this.processing = false;
       this.emit("update-not-available", code, msg, info2);
       return false;
     };
+    if (this.processing) {
+      this.logger?.info("Updater is already processing, skip check update");
+      return false;
+    }
+    this.processing = true;
+    this.logger?.debug("Check update start");
     if (!data && !this.provider) {
       const msg = "No update json or provider";
       this.err("Check update failed", "ERR_PARAM", msg);
@@ -159,8 +168,10 @@ var Updater = class extends EventEmitter {
         );
       }
       this.logger?.info(`Update available: ${version}`);
-      this.emit("update-available", extraVersionInfo);
       this.info = info;
+      this.processing = false;
+      this.logger?.debug("Check update end");
+      this.emit("update-available", extraVersionInfo);
       return true;
     } catch {
       const msg = "Fail to parse version string";
@@ -173,41 +184,45 @@ var Updater = class extends EventEmitter {
     }
   }
   async downloadUpdate(data, info) {
+    const emitError = (code, errorInfo) => {
+      this.err(`Download update failed`, code, errorInfo);
+      this.logger?.debug("Download update end");
+      this.processing = false;
+      return false;
+    };
+    if (this.processing) {
+      this.logger?.info("Updater is already processing, skip download update");
+      return false;
+    }
+    this.processing = true;
+    this.logger?.debug("Download update start");
     const _sig = info?.signature ?? this.info?.signature;
     const _version = info?.version ?? this.info?.version;
     if (!_sig || !_version) {
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_PARAM",
         "No update signature, please call `checkUpdate` first or manually setup params"
       );
-      return false;
     }
     if (!data && !this.provider) {
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_PARAM",
         "No update asar buffer and provider"
       );
-      return false;
     }
     const buffer = await this.fetch("buffer", data ? Buffer.from(data) : void 0);
     if (!buffer) {
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_PARAM",
         "No update asar file buffer"
       );
-      return false;
     }
     this.logger?.debug("Validation start");
     if (!await this.provider.verifySignaure(buffer, _version, _sig, this.CERT)) {
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_VALIDATE",
         "Invalid update asar file"
       );
-      return false;
     }
     this.logger?.debug("Validation end");
     try {
@@ -217,15 +232,15 @@ var Updater = class extends EventEmitter {
       this.logger?.info(`Download success, version: ${_version}`);
       this.info = void 0;
       this.emit("update-downloaded");
+      this.processing = false;
+      this.logger?.debug("Download update end");
       return true;
     } catch (error) {
       this.cleanup();
-      this.err(
-        "Download failed",
+      return emitError(
         "ERR_DOWNLOAD",
-        `Fail to unwrap asar file, ${error}`
+        `Failed to write update file: ${error instanceof Error ? error.message : error}`
       );
-      return false;
     }
   }
   /**

package/dist/provider.cjs

@@ -337,6 +337,8 @@ var GitHubAtomProvider = class extends BaseGitHubProvider {
     return `releases/download/v${tag}/${versionPath}`;
   }
 };
+
+// src/provider/github/file.ts
 var GitHubProvider = class extends BaseGitHubProvider {
   name = "GithubProvider";
   /**

package/dist/provider.js

@@ -149,6 +149,8 @@ var GitHubAtomProvider = class extends BaseGitHubProvider {
     return `releases/download/v${tag}/${versionPath}`;
   }
 };
+
+// src/provider/github/file.ts
 var GitHubProvider = class extends BaseGitHubProvider {
   name = "GithubProvider";
   /**

package/dist/vite.d.ts

@@ -106,7 +106,9 @@ interface BuildEntryOption {
     /**
      * `external` option in `build.rollupOptions`,
      * default is node built-in modules or native modules.
-     * If is in dev, also external `dependencies` in package.json
+     *
+     * If is in dev and {@link postBuild} is not setup, will also
+     * external `dependencies` in `package.json`
      */
     external?: NonNullable<NonNullable<InlineConfig['build']>['rollupOptions']>['external'];
     /**
@@ -127,8 +129,12 @@ interface BuildEntryOption {
      */
     overrideViteOptions?: InlineConfig;
     /**
-     * Resolve extra files on startup, such as `.node`
-     * @remark won't trigger will reload
+     * By default, all the unbundled modules will be packaged by packager like `electron-builder`.
+     * If setup, all the `dependencies` in `package.json` will be bundled by default, and you need
+     * to manually handle the native module files.
+     *
+     * If you are using `electron-buidler`, don't forget to append `'!node_modules/**'` in
+     * electron-build config's `files` array
      */
     postBuild?: (args: {
         /**
@@ -401,14 +407,6 @@ interface ElectronWithUpdaterOptions {
      * @default isCI
      */
     buildVersionJson?: boolean;
-    /**
-     * Whether to log parsed options
-     *
-     * To show certificate and private keys, set `logParsedOptions: { showKeys: true }`
-     */
-    logParsedOptions?: boolean | {
-        showKeys: boolean;
-    };
     /**
      * Main process options
      *
@@ -448,7 +446,6 @@ interface ElectronWithUpdaterOptions {
  *     plugins: [
  *       electronWithUpdater({
  *         isBuild,
- *         logParsedOptions: true,
  *         main: {
  *           files: ['./electron/main/index.ts', './electron/main/worker.ts'],
  *           // see https://github.com/electron-vite/electron-vite-vue/blob/85ed267c4851bf59f32888d766c0071661d4b94c/vite.config.ts#L22-L28

package/dist/vite.js

@@ -607,7 +607,7 @@ function parseOptions(isBuild, pkg, sourcemap = false, minify = false, options =
         /.*\.(node|dll|dylib|so)$/,
         "original-fs",
         ...builtinModules,
-        ...isBuild ? [] : Object.keys("dependencies" in pkg ? pkg.dependencies : {})
+        ...isBuild || postBuild ? [] : Object.keys("dependencies" in pkg ? pkg.dependencies : {})
       ],
       overrideViteOptions = {}
     } = {},
@@ -735,8 +735,7 @@ async function electronWithUpdater(options) {
     buildVersionJson,
     updater,
     bytecode,
-    useNotBundle = true,
-    logParsedOptions
+    useNotBundle = true
   } = options;
   if (!pkg || !pkg.version || !pkg.name || !pkg.main) {
     log.error("package.json not found or invalid", { timestamp: true });
@@ -792,12 +791,12 @@ async function electronWithUpdater(options) {
       getPathFromEntryOutputDir(...paths) {
         return path5.join(entryOutputDirPath, ...paths);
       },
-      copyToEntryOutputDir({ from, to, skipIfExist = true }) {
+      copyToEntryOutputDir({ from, to = path5.basename(from), skipIfExist = true }) {
         if (!fs5.existsSync(from)) {
           log.warn(`${from} not found`, { timestamp: true });
           return;
         }
-        const target = path5.join(entryOutputDirPath, to ?? path5.basename(from));
+        const target = path5.join(entryOutputDirPath, to);
         copyAndSkipIfExist(from, target, skipIfExist);
       },
       copyModules({ modules, skipIfExist = true }) {
@@ -887,20 +886,6 @@ async function electronWithUpdater(options) {
       )
     }
   };
-  if (logParsedOptions) {
-    const shouldShowKey = typeof logParsedOptions === "object" && logParsedOptions.showKeys === true;
-    log.info(
-      JSON.stringify(
-        {
-          ...electronPluginOptions,
-          updater: { buildAsarOption, buildEntryOption, buildVersionOption }
-        },
-        (key, value) => key === "privateKey" || key === "cert" ? shouldShowKey ? value : `<${key.toUpperCase()}>` : value,
-        2
-      ),
-      { timestamp: true }
-    );
-  }
   const result = [ElectronSimple(electronPluginOptions)];
   if (nativeModuleEntryMap) {
     const files = [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-incremental-update",
   "type": "module",
-  "version": "2.3.7",
+  "version": "2.4.0",
   "description": "Electron incremental update tools with Vite plugin, support bytecode protection",
   "author": "subframe7536",
   "license": "MIT",