electron-incremental-update 1.3.0 → 2.0.0-beta.10

package/dist/index.js

@@ -1,291 +1,167 @@
-import {
-  __require,
-  getPathFromAppNameAsar,
-  getVersions,
-  is,
-  isUpdateJSON,
-  parseVersion,
-  restartApp,
-  unzipFile,
-  waitAppReady
-} from "./chunk-SBPTSLG7.js";
+import { isDev, getEntryVersion, getAppVersion, getPathFromAppNameAsar, restartApp } from './chunk-4MH6ZXCY.js';
+import { isUpdateJSON, __require } from './chunk-72ZAJ7AF.js';
+import fs2 from 'node:fs';
+import { EventEmitter } from 'node:events';
+import { app } from 'electron';
+import path from 'node:path';
 
-// src/index.ts
-import { resolve } from "node:path";
-import { existsSync as existsSync2, renameSync } from "node:fs";
-import { app as app2 } from "electron";
-
-// src/updater/core.ts
-import { existsSync, rmSync, writeFileSync } from "node:fs";
-import { app } from "electron";
-
-// src/crypto/dec.ts
-import { createDecipheriv, createVerify } from "node:crypto";
-
-// src/crypto/utils.ts
-import { createHash } from "node:crypto";
-function hashString(data, length) {
-  const hash = createHash("SHA256").update(data).digest("binary");
-  return Buffer.from(hash).subarray(0, length);
-}
-
-// src/crypto/dec.ts
-function decrypt(encryptedText, key, iv) {
-  const decipher = createDecipheriv("aes-256-cbc", key, iv);
-  let decrypted = decipher.update(encryptedText, "base64url", "utf8");
-  decrypted += decipher.final("utf8");
-  return decrypted;
-}
-var verify = (buffer, signature, cert) => {
-  try {
-    const [sig, version] = decrypt(signature, hashString(cert, 32), hashString(buffer, 16)).split("%");
-    const result = createVerify("RSA-SHA256").update(buffer).verify(cert, sig, "base64");
-    return result ? version : false;
-  } catch (error) {
-    return false;
-  }
-};
-
-// src/updater/types.ts
+// src/entry/types.ts
 var ErrorInfo = {
-  downlaod: "Download failed",
-  validate: "Validate failed",
-  param: "Missing params",
-  version: "Unsatisfied version"
+  download: "Download Failed",
+  validate: "Validate Failed",
+  param: "Missing Params",
+  network: "Network Error"
 };
 var UpdaterError = class extends Error {
+  code;
   constructor(msg, info) {
-    super(msg + ": " + info);
-  }
-};
-
-// src/updater/defaultFunctions/download.ts
-import { net } from "electron";
-async function downlaodFn(url, headers, onResponse) {
-  await waitAppReady();
-  return new Promise((resolve2, reject) => {
-    const request = net.request({ url, method: "GET", redirect: "follow" });
-    Object.keys(headers).forEach((key) => request.setHeader(key, headers[key]));
-    request.on("response", (res) => onResponse(res, resolve2, reject));
-    request.on("error", reject);
-    request.end();
-  });
-}
-var downloadJSONDefault = async (url, headers) => {
-  return await downlaodFn(url, headers, (resp, resolve2, reject) => {
-    let data = "";
-    resp.on("data", (chunk) => data += chunk);
-    resp.on("end", () => {
-      try {
-        const json = JSON.parse(data);
-        if (isUpdateJSON(json)) {
-          resolve2(json);
-        } else {
-          throw Error;
-        }
-      } catch (ignore) {
-        reject(new Error("invalid update json"));
-      }
-    });
-    resp.on("aborted", () => reject(new Error("aborted")));
-    resp.on("error", () => reject(new Error("download error")));
-  });
-};
-var downloadBufferDefault = async (url, headers, total, onDownloading) => {
-  let current = 0;
-  return await downlaodFn(url, headers, (resp, resolve2, reject) => {
-    let data = [];
-    resp.on("data", (chunk) => {
-      current += chunk.length;
-      onDownloading?.({ percent: `${+(current / total).toFixed(2) * 100}%`, total, current });
-      data.push(chunk);
-    });
-    resp.on("end", () => resolve2(Buffer.concat(data)));
-    resp.on("aborted", () => reject(new Error("aborted")));
-    resp.on("error", () => reject(new Error("download error")));
-  });
-};
-
-// src/updater/defaultFunctions/compareVersion.ts
-var isLowerVersionDefault = (version1, version2) => {
-  const oldV = parseVersion(version1);
-  const newV = parseVersion(version2);
-  function compareStrings(str1, str2) {
-    if (str1 === "") {
-      return str2 !== "";
-    } else if (str2 === "") {
-      return true;
-    }
-    return str1 < str2;
+    super("[" + ErrorInfo[msg] + "] " + info);
+    this.code = msg;
   }
-  for (let key of Object.keys(oldV)) {
-    if (key === "stage" && compareStrings(oldV[key], newV[key])) {
-      return true;
-    } else if (oldV[key] !== newV[key]) {
-      return oldV[key] < newV[key];
-    }
-  }
-  return false;
 };
 
-// src/updater/core.ts
-var Updater = class {
-  CERT = __SIGNATURE_CERT__;
+// src/entry/updater.ts
+var Updater = class extends EventEmitter {
+  CERT = __EIU_SIGNATURE_CERT__;
   info;
-  option;
-  asarPath;
-  gzipPath;
-  tmpFilePath;
+  provider;
   /**
-   * updater logger
+   * Updater logger
    */
   logger;
   /**
-   * downloading progress hook
-   * @param progress download progress
-   * @example
-   * updater.onDownloading = ({ percent, total, current }) => {
-   *   console.log(`download progress: ${percent}, total: ${total}, current: ${current}`)
-   * }
+   * Whether to receive beta update
    */
-  onDownloading;
+  receiveBeta;
   /**
-   * whether receive beta version
+   * Whether force update in DEV
    */
-  get receiveBeta() {
-    return !!this.option.receiveBeta;
-  }
-  set receiveBeta(receiveBeta) {
-    this.option.receiveBeta = receiveBeta;
-  }
+  forceUpdate;
   /**
-   * initialize incremental updater
-   * @param option UpdaterOption
+   * Initialize incremental updater
+   * @param options UpdaterOption
    */
-  constructor(option = {}) {
-    this.option = option;
-    if (option.SIGNATURE_CERT) {
-      this.CERT = option.SIGNATURE_CERT;
+  constructor(options = {}) {
+    super();
+    this.provider = options.provider;
+    this.receiveBeta = options.receiveBeta;
+    this.CERT = options.SIGNATURE_CERT || __EIU_SIGNATURE_CERT__;
+    this.logger = options.logger;
+    if (isDev && !this.logger) {
+      this.logger = {
+        info: (...args) => console.log("[EIU-INFO ]", ...args),
+        debug: (...args) => console.log("[EIU-DEBUG]", ...args),
+        warn: (...args) => console.log("[EIU-WARN ]", ...args),
+        error: (...args) => console.error("[EIU-ERROR]", ...args)
+      };
+      this.logger.info("no logger set, enable dev-only logger");
     }
-    this.asarPath = getPathFromAppNameAsar();
-    this.gzipPath = `${this.asarPath}.gz`;
-    this.tmpFilePath = `${this.asarPath}.tmp`;
-  }
-  async needUpdate(version, minVersion) {
-    const isLowerVersion = this.option.overrideFunctions?.isLowerVersion ?? isLowerVersionDefault;
-    const { appVersion, entryVersion } = getVersions();
-    if (await isLowerVersion(entryVersion, minVersion)) {
-      throw new UpdaterError(ErrorInfo.version, `entry version (${entryVersion}) < minimumVersion (${minVersion})`);
+    if (!this.provider) {
+      this.logger?.debug("No update provider, please setup provider before checking update");
     }
-    this.logger?.info(`check update: current version is ${appVersion}, new version is ${version}`);
-    return await isLowerVersion(appVersion, version);
   }
-  async parseData(format, data) {
-    if (existsSync(this.tmpFilePath)) {
-      this.logger?.warn(`remove tmp file: ${this.tmpFilePath}`);
-      rmSync(this.tmpFilePath);
-    }
-    if (existsSync(this.gzipPath)) {
-      this.logger?.warn(`remove .gz file: ${this.gzipPath}`);
-      rmSync(this.gzipPath);
+  checkProvider() {
+    if (!this.provider) {
+      throw new UpdaterError("param", "missing update provider");
     }
+  }
+  async fetch(format, data) {
     if (typeof data === "object") {
       if (format === "json" && isUpdateJSON(data) || format === "buffer" && Buffer.isBuffer(data)) {
         return data;
       } else {
-        throw new UpdaterError(ErrorInfo.param, `invalid type at format '${format}': ${JSON.stringify(data)}`);
+        this.err("invalid type", "param", `invalid type at format '${format}': ${JSON.stringify(data)}`);
+        return;
       }
     }
-    const ua = this.option.downloadConfig?.userAgent || "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36";
-    const headers = {
-      Accept: `application/${format === "json" ? "json" : "octet-stream"}`,
-      UserAgent: ua,
-      ...this.option.downloadConfig?.extraHeader
-    };
-    this.logger?.debug(`download headers: ${JSON.stringify(headers)}`);
-    const config = format === "json" ? {
-      name: "updateJsonURL",
-      url: this.option.updateJsonURL,
-      repoFallback: `${this.option.repository?.replace("github.com", "raw.githubusercontent.com")}/master/version.json`,
-      fn: this.option.overrideFunctions?.downloadJSON ?? downloadJSONDefault
-    } : {
-      name: "releaseAsarURL",
-      url: this.option.releaseAsarURL,
-      repoFallback: `${this.option.repository}/releases/download/v${this.info?.version}/${app.name}-${this.info?.version}.asar.gz`,
-      fn: this.option.overrideFunctions?.downloadBuffer ?? downloadBufferDefault
-    };
-    data ??= config.url;
-    if (!data) {
-      this.logger?.debug(`no ${config.name}, fallback to use repository`);
-      if (!this.option.repository) {
-        throw new UpdaterError(ErrorInfo.param, `${config.name} or repository is not set`);
-      }
-      if (format === "buffer" && !this.info?.version) {
-        throw new UpdaterError(ErrorInfo.param, "version is not set");
-      }
-      data = config.repoFallback;
-    }
-    this.logger?.debug(`download ${format} from ${data}`);
+    this.logger?.debug(`download from ${this.provider.name}`);
     try {
-      const ret = format === "json" ? await config.fn(data, headers) : await config.fn(data, headers, this.info.size, this.onDownloading);
-      this.logger?.debug(`download ${format} success${format === "buffer" ? `, file size: ${ret.length}` : ""}`);
-      return ret;
+      const result = format === "json" ? await this.provider.downloadJSON(data ?? __EIU_VERSION_PATH__) : await this.provider.downloadAsar(app.name, this.info, (data2) => this.emit("download-progress", data2));
+      this.logger?.debug(`download ${format} success${format === "buffer" ? `, file size: ${result.length}` : ""}`);
+      return result;
     } catch (e) {
-      throw new UpdaterError(ErrorInfo.downlaod, e.toString());
+      this.err(`fetch ${format} failed`, "network", `download ${format} failed: ${e}`);
     }
   }
+  /**
+   * Handle error message and emit error event
+   */
+  err(msg, code, errorInfo) {
+    const err = new UpdaterError(code, errorInfo);
+    this.logger?.error(msg, err);
+    this.emit("error", err);
+  }
   async checkUpdate(data) {
+    this.checkProvider();
+    const emitUnavailable = (msg) => {
+      this.logger?.info(msg);
+      this.emit("update-unavailable", msg);
+      return false;
+    };
+    const _data = await this.fetch("json", data);
+    if (!_data) {
+      return emitUnavailable("failed to get update info");
+    }
+    let { signature, version, minimumVersion, beta } = _data;
+    if (this.receiveBeta) {
+      version = beta.version;
+      signature = beta.signature;
+      minimumVersion = beta.minimumVersion;
+    }
+    this.logger?.debug(`checked update, version: ${version}, signature: ${signature}`);
+    if (isDev && !this.forceUpdate && !data) {
+      return emitUnavailable("skip check update in dev mode, to force update, set `updater.forceUpdate` to true or call checkUpdate with UpdateJSON");
+    }
+    const isLowerVersion = this.provider.isLowerVersion;
+    const entryVersion = getEntryVersion();
+    const appVersion = getAppVersion();
     try {
-      let { signature, size, version, minimumVersion, beta } = await this.parseData("json", data);
-      if (this.receiveBeta) {
-        version = beta.version;
-        signature = beta.signature;
-        minimumVersion = beta.minimumVersion;
-        size = beta.size;
+      if (isLowerVersion(entryVersion, minimumVersion)) {
+        return emitUnavailable(`entry version (${entryVersion}) < minimumVersion (${minimumVersion})`);
       }
-      this.logger?.debug(`checked version: ${version}, size: ${size}, signature: ${signature}`);
-      if (!await this.needUpdate(version, minimumVersion)) {
-        this.logger?.info(`update unavailable: ${version} is the latest version`);
-        return void 0;
-      } else {
-        this.logger?.info(`update available: ${version}`);
-        this.info = {
-          signature,
-          minimumVersion,
-          version,
-          size
-        };
-        return this.info;
+      this.logger?.info(`check update: current version is ${appVersion}, new version is ${version}`);
+      if (!isLowerVersion(appVersion, version)) {
+        return emitUnavailable(`current version (${appVersion}) < new version (${version})`);
       }
-    } catch (error) {
-      this.logger?.error("check update failed", error);
-      return error;
+      this.logger?.info(`update available: ${version}`);
+      this.info = { signature, minimumVersion, version };
+      this.emit("update-available", this.info);
+      return true;
+    } catch {
+      this.err("Fail to parse version", "validate", "fail to parse version string");
+      return false;
     }
   }
-  async download(data, sig) {
+  async downloadUpdate(data, info) {
+    this.checkProvider();
+    const _sig = info?.signature ?? this.info?.signature;
+    const _version = info?.version ?? this.info?.version;
+    if (!_sig || !_version) {
+      this.err("download failed", "param", "no update signature, please call `checkUpdate` first or manually setup params");
+      return false;
+    }
+    const buffer = await this.fetch("buffer", data ? Buffer.from(data) : void 0);
+    if (!buffer) {
+      this.err("download failed", "param", "no update asar file buffer");
+      return false;
+    }
+    this.logger?.debug("verify start");
+    if (!await this.provider.verifySignaure(buffer, _version, _sig, this.CERT)) {
+      this.err("download failed", "validate", "invalid update asar file");
+      return false;
+    }
+    this.logger?.debug("verify success");
     try {
-      const _sig = sig ?? this.info?.signature;
-      if (!_sig) {
-        throw new UpdaterError(ErrorInfo.param, "signature is empty");
-      }
-      const buffer = await this.parseData("buffer", data);
-      this.logger?.debug("verify start");
-      const _verify = this.option.overrideFunctions?.verifySignaure ?? verify;
-      const _ver = await _verify(buffer, _sig, this.CERT);
-      if (!_ver) {
-        throw new UpdaterError(ErrorInfo.validate, "invalid signature or certificate");
-      }
-      this.logger?.debug("verify success");
-      this.logger?.debug(`write to ${this.gzipPath}`);
-      writeFileSync(this.gzipPath, buffer);
-      this.logger?.debug(`extract to ${this.tmpFilePath}`);
-      await unzipFile(this.gzipPath, this.tmpFilePath);
-      this.logger?.info(`download success, version: ${_ver}`);
+      const tmpFilePath = getPathFromAppNameAsar() + ".tmp";
+      this.logger?.debug(`install to ${tmpFilePath}`);
+      fs2.writeFileSync(tmpFilePath, await this.provider.unzipFile(buffer));
+      this.logger?.info(`download success, version: ${_version}`);
       this.info = void 0;
+      this.emit("update-downloaded");
       return true;
     } catch (error) {
-      this.logger?.error("download asar failed", error);
-      return error;
+      this.err("download failed", "download", `fail to unwrap asar file, ${error}`);
+      return false;
     }
   }
   /**
@@ -296,13 +172,11 @@ var Updater = class {
     restartApp();
   }
 };
-
-// src/updater/index.ts
-function createUpdater(option) {
-  return new Updater(option);
+async function autoUpdate(updater) {
+  if (await updater.checkUpdate() && await updater.downloadUpdate()) {
+    updater.quitAndInstall();
+  }
 }
-
-// src/index.ts
 function startupWithUpdater(fn) {
   return fn;
 }
@@ -313,23 +187,13 @@ var defaultOnInstall = (install, _, __, logger) => {
 async function initApp(appOptions = {}) {
   const {
     updater,
-    electronDevDistPath = "../dist-electron",
-    mainPath = "main/index.js",
-    hooks
-  } = appOptions || {};
-  const {
     onInstall = defaultOnInstall,
     beforeStart,
     onStartError
-  } = hooks || {};
-  function handleError(err, logger2) {
-    console.error(err);
-    onStartError?.(err, logger2);
-    app2.quit();
-  }
+  } = appOptions;
   let updaterInstance;
   if (typeof updater === "object" || !updater) {
-    updaterInstance = createUpdater(updater);
+    updaterInstance = new Updater(updater);
   } else {
     updaterInstance = await updater();
   }
@@ -337,26 +201,22 @@ async function initApp(appOptions = {}) {
   try {
     const appNameAsarPath = getPathFromAppNameAsar();
     const tempAsarPath = `${appNameAsarPath}.tmp`;
-    if (existsSync2(tempAsarPath)) {
+    if (fs2.existsSync(tempAsarPath)) {
       logger?.info(`installing new asar: ${tempAsarPath}`);
-      await onInstall(() => renameSync(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
+      await onInstall(() => fs2.renameSync(tempAsarPath, appNameAsarPath), tempAsarPath, appNameAsarPath, logger);
     }
-    const mainDir = is.dev ? electronDevDistPath : appNameAsarPath;
-    const entry = resolve(__dirname, mainDir, mainPath);
-    await beforeStart?.(entry, logger);
-    __require(entry)(updaterInstance);
+    const mainFilePath = path.join(
+      isDev ? path.join(app.getAppPath(), __EIU_MAIN_DEV_DIR__) : appNameAsarPath,
+      "main",
+      __EIU_MAIN_FILE__
+    );
+    await beforeStart?.(mainFilePath, logger);
+    __require(mainFilePath)(updaterInstance);
   } catch (error) {
-    handleError(error, logger);
+    logger?.error("startup error", error);
+    onStartError?.(error, logger);
+    app.quit();
   }
 }
-export {
-  ErrorInfo,
-  Updater,
-  UpdaterError,
-  createUpdater,
-  downloadBufferDefault,
-  downloadJSONDefault,
-  initApp,
-  isLowerVersionDefault,
-  startupWithUpdater
-};
+
+export { ErrorInfo, Updater, UpdaterError, autoUpdate, initApp, startupWithUpdater };