electron-updator 0.1.4 → 0.1.6

package/README.md

@@ -2,7 +2,6 @@
 
 [![NPM version][npm-image]][npm-url]
 [![CI][ci-image]][ci-url]
-[![Test coverage][codecov-image]][codecov-url]
 [![node version][node-image]][node-url]
 [![npm download][download-image]][download-url]
 
@@ -10,8 +9,6 @@
 [npm-url]: https://npmjs.org/package/electron-updator
 [ci-image]: https://github.com/electron-modules/electron-updator/actions/workflows/ci.yml/badge.svg
 [ci-url]: https://github.com/electron-modules/electron-updator/actions/workflows/ci.yml
-[codecov-image]: https://img.shields.io/codecov/c/github/electron-modules/electron-updator.svg?logo=codecov
-[codecov-url]: https://codecov.io/gh/electron-modules/electron-updator
 [node-image]: https://img.shields.io/badge/node.js-%3E=_16-green.svg
 [node-url]: http://nodejs.org/download/
 [download-image]: https://img.shields.io/npm/dm/electron-updator.svg
@@ -28,11 +25,11 @@ $ npm i electron-updator --save
 
 ## Contributors
 
-|[<img src="https://avatars.githubusercontent.com/u/1011681?v=4" width="100px;"/><br/><sub><b>xudafeng</b></sub>](https://github.com/xudafeng)<br/>|[<img src="https://avatars.githubusercontent.com/u/4081746?v=4" width="100px;"/><br/><sub><b>zlyi</b></sub>](https://github.com/zlyi)<br/>|
-| :---: | :---: |
+|[<img src="https://avatars.githubusercontent.com/u/4081746?v=4" width="100px;"/><br/><sub><b>zlyi</b></sub>](https://github.com/zlyi)<br/>|[<img src="https://avatars.githubusercontent.com/u/1011681?v=4" width="100px;"/><br/><sub><b>xudafeng</b></sub>](https://github.com/xudafeng)<br/>|[<img src="https://avatars.githubusercontent.com/u/52845048?v=4" width="100px;"/><br/><sub><b>snapre</b></sub>](https://github.com/snapre)<br/>|
+| :---: | :---: | :---: |
 
 
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Mon Jan 30 2023 19:21:07 GMT+0800`.
+This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Tue Jan 31 2023 14:31:40 GMT+0800`.
 
 <!-- GITCONTRIBUTOR_END -->
 

package/build/app-updator.js

@@ -9,12 +9,12 @@ const elelctron_app_adapter_1 = require("./elelctron-app-adapter");
 class AppUpdator extends eventemitter3_1.EventEmitter {
     constructor(options, app) {
         super();
-        this.state = "idle" /* StateType.Idle */;
+        this.state = constants_1.StateType.Idle;
         this.options = options;
         this.logger = this._wrapLogger(options.logger);
         this.app = app || new elelctron_app_adapter_1.ElectronAppAdapter();
         this.startTimeStamp = new Date().getTime();
-        this.logger.info('AppUpdator#constructor');
+        this.logger.info('ElectronUpdator#constructor');
         this.availableUpdate = {
             resourcePath: '',
             latestAsarPath: '',
@@ -41,22 +41,22 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         return _logger;
     }
     setState(state) {
-        this.logger.info(`AppUpdator#setState${state}`);
+        this.logger.info(`ElectronUpdator#setState${state}`);
         this.state = state;
     }
     setFeedUrl(url) {
-        this.logger.info(`AppUpdator#setFeedUrl:url is ${url}`);
+        this.logger.info(`ElectronUpdator#setFeedUrl:url is ${url}`);
         if (url && this.options) {
             this.options.url = url;
         }
     }
     async checkForUpdates(executeType = constants_1.ExecuteType.Auto) {
-        this.logger.info(`AppUpdator#checkForUpdates:state is ${this.state}`);
-        this.setState("idle" /* StateType.Idle */);
+        this.logger.info(`ElectronUpdator#checkForUpdates:state is ${this.state}`);
+        this.setState(constants_1.StateType.Idle);
         try {
             // 新一轮更新流程，更新 TimeStamp
             this.startTimeStamp = new Date().getTime();
-            this.setState("checking-for-update" /* StateType.CheckingForUpdate */);
+            this.setState(constants_1.StateType.CheckingForUpdate);
             this.emit(constants_1.EventType.CHECKING_FOR_UPDATE);
             const updateInfoResponse = await (0, utils_1.requestUpdateInfo)(this.options);
             this.updateInfo = (this.options?.responseFormatter ? this.options?.responseFormatter(updateInfoResponse) : updateInfoResponse);
@@ -67,13 +67,13 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
                     updateInfo: this.updateInfo,
                     executeType,
                 });
-                this.setState("idle" /* StateType.Idle */);
+                this.setState(constants_1.StateType.Idle);
                 return;
             }
-            this.logger.info('AppUpdator#checkForUpdates:needUpdate is true');
+            this.logger.info('ElectronUpdator#checkForUpdates:needUpdate is true');
             this.availableUpdate = this.doGetAvailableUpdateInfo(this.updateInfo);
             if (!this.options?.autoDownload || executeType === constants_1.ExecuteType.User) {
-                this.logger.info('AppUpdator#checkForUpdates:emit UPDATE_AVAILABLE');
+                this.logger.info('ElectronUpdator#checkForUpdates:emit UPDATE_AVAILABLE');
                 this.emit(constants_1.EventType.UPDATE_AVAILABLE, {
                     updateInfo: this.updateInfo,
                     executeType,
@@ -85,31 +85,31 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         catch (e) {
             e.customMessage = e.customMessage ? e.customMessage : `${constants_1.InstallResultType.CheckForUpdatesError}_${e.message}`;
             this.logError(e);
-            this.setState("idle" /* StateType.Idle */);
+            this.setState(constants_1.StateType.Idle);
         }
     }
     async downloadUpdate(executeType = constants_1.ExecuteType.User) {
-        this.logger.info(`AppUpdator#downloadUpdate:executeType is ${executeType}`);
-        await this.downloadUpdateFile(this.updateInfo);
-        const result = await this.preCheck();
+        this.logger.info(`ElectronUpdator#downloadUpdate:executeType is ${executeType}`);
+        await this.downloadUpdateFile(this.updateInfo, executeType);
+        const result = await this.preCheck(executeType);
         if (result.success) {
-            this.logger.info('AppUpdator#downloadUpdate:emit UPDATE_DOWNLOADED');
+            this.logger.info('ElectronUpdator#downloadUpdate:emit UPDATE_DOWNLOADED');
             this.emit(constants_1.EventType.UPDATE_DOWNLOADED, {
                 executeType,
             });
         }
         else {
             this.logError(result.error);
-            this.setState("idle" /* StateType.Idle */);
+            this.setState(constants_1.StateType.Idle);
         }
     }
     async quitAndInstall() {
-        this.logger.info(`AppUpdator#quitAndInstall:state is ${this.state}`);
-        if (this.state !== "downloaded" /* StateType.Downloaded */) {
+        this.logger.info(`ElectronUpdator#quitAndInstall:state is ${this.state}`);
+        if (this.state !== constants_1.StateType.Downloaded) {
             this.downloadUpdate();
             return;
         }
-        this.setState("idle" /* StateType.Idle */);
+        this.setState(constants_1.StateType.Idle);
         try {
             let result = { success: false };
             if (this.updateInfo?.updateType === constants_1.UpdateType.Package) {
@@ -119,7 +119,7 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
                 result = await this.doQuitAndInstallAsar();
             }
             if (result.success) {
-                this.logger.warn('AppUpdator#quitAndInstall:install success');
+                this.logger.warn('ElectronUpdator#quitAndInstall:install success');
                 this.emit(constants_1.EventType.BEFORE_QUIT_FOR_UPDATE);
             }
             else {
@@ -132,21 +132,21 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         }
     }
     async preCheckForAsar() {
-        this.logger.info('AppUpdator#preCheckForAsar');
+        this.logger.info('ElectronUpdator#preCheckForAsar');
         return await this.unzip();
     }
-    async preCheck() {
-        this.logger.info('AppUpdator#preCheck');
+    async preCheck(executeType) {
+        this.logger.info('ElectronUpdator#preCheck');
         const { resourcePath } = this.availableUpdate;
-        if (this.state !== "downloaded" /* StateType.Downloaded */) {
+        if (this.state !== constants_1.StateType.Downloaded) {
             return {
                 success: false,
-                error: new Error(`AppUpdator#preCheck:update status(${this.state}) error`),
+                error: new Error(`ElectronUpdator#preCheck:update status(${this.state}) error`),
             };
         }
         // 清理老包
         try {
-            this.logger.info('AppUpdator#preCheck:cleanOldArchive');
+            this.logger.info('ElectronUpdator#preCheck:cleanOldArchive');
             await (0, utils_1.cleanOldArchive)(resourcePath);
         }
         catch (e) {
@@ -171,20 +171,23 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
             };
         }
         if (this.updateInfo?.updateType === constants_1.UpdateType.Package) {
-            result = await this.doPreCheckForPackage();
+            if (executeType === constants_1.ExecuteType.Auto) {
+                // 自动安装时，才进行预检查，提升安装效率
+                result = await this.doPreCheckForPackage();
+            }
         }
         else {
             result = await this.preCheckForAsar();
         }
         return result;
     }
-    async downloadUpdateFile(updateInfo) {
-        if (this.state !== "checking-for-update" /* StateType.CheckingForUpdate */) {
-            throw new Error(`AppUpdator#downloadUpdateFile:update status(${this.state}) error`);
+    async downloadUpdateFile(updateInfo, executeType) {
+        if (this.state !== constants_1.StateType.CheckingForUpdate) {
+            throw new Error(`ElectronUpdator#downloadUpdateFile:update status(${this.state}) error`);
         }
         const { url, signature } = updateInfo.files[0];
         const { downloadTargetDir } = this.availableUpdate;
-        this.setState("downloading" /* StateType.Downloading */);
+        this.setState(constants_1.StateType.Downloading);
         try {
             await (0, download_file_1.downloadFile)({
                 logger: this.logger,
@@ -193,20 +196,20 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
                 targetDir: downloadTargetDir,
                 emit: this.emit,
                 progressHandle: (data) => {
-                    this.emit(constants_1.EventType.UPDATE_DOWNLOAD_PROGRESS, data);
+                    this.emit(constants_1.EventType.UPDATE_DOWNLOAD_PROGRESS, { ...data, executeType });
                 },
             });
-            this.logger.info('AppUpdator#downloadUpdateFile:Downloaded');
-            this.setState("downloaded" /* StateType.Downloaded */);
+            this.logger.info('ElectronUpdator#downloadUpdateFile:Downloaded');
+            this.setState(constants_1.StateType.Downloaded);
         }
         catch (e) {
-            this.setState("idle" /* StateType.Idle */);
+            this.setState(constants_1.StateType.Idle);
             e.customMessage = `${constants_1.InstallResultType.DownloadError}_${e.message}`;
             this.logError(e);
         }
     }
     async unzip() {
-        this.logger.info('AppUpdator#unzip:start');
+        this.logger.info('ElectronUpdator#unzip:start');
         try {
             const result = await this.doUnzip();
             if (!result.success) {

package/build/common/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventType = exports.DownloadProgressStatus = exports.ExecuteType = exports.UpdateType = exports.InstallResultType = exports.OldArchivePrefix = void 0;
+exports.EventType = exports.DownloadProgressStatus = exports.ExecuteType = exports.UpdateType = exports.StateType = exports.InstallResultType = exports.OldArchivePrefix = void 0;
 /**
  * 更新包备份前缀
  */
@@ -15,6 +15,28 @@ var InstallResultType;
     InstallResultType["UpdateSuccess"] = "update-success";
     InstallResultType["CheckForUpdatesError"] = "check-for-updates-error";
 })(InstallResultType = exports.InstallResultType || (exports.InstallResultType = {}));
+/**
+ * 更新状态
+ */
+var StateType;
+(function (StateType) {
+    /**
+     * 空闲
+     */
+    StateType["Idle"] = "idle";
+    /**
+     * 检查更新中
+     */
+    StateType["CheckingForUpdate"] = "checking-for-update";
+    /**
+     * 下载中
+     */
+    StateType["Downloading"] = "downloading";
+    /**
+     * 下载完成
+     */
+    StateType["Downloaded"] = "downloaded";
+})(StateType = exports.StateType || (exports.StateType = {}));
 /**
  * 更新类型
  */

package/build/index.js

@@ -4,7 +4,12 @@ const constants_1 = require("./common/constants");
 const mac_updator_1 = require("./mac-updator");
 const windows_updator_1 = require("./windows-updator");
 exports.default = {
-    UpdateType: constants_1.UpdateType, EventType: constants_1.EventType, ExecuteType: constants_1.ExecuteType,
-    MacUpdator: mac_updator_1.MacUpdator, WindowsUpdator: windows_updator_1.WindowsUpdator, DownloadProgressStatus: constants_1.DownloadProgressStatus,
+    UpdateType: constants_1.UpdateType,
+    EventType: constants_1.EventType,
+    ExecuteType: constants_1.ExecuteType,
+    StateType: constants_1.StateType,
+    MacUpdator: mac_updator_1.MacUpdator,
+    WindowsUpdator: windows_updator_1.WindowsUpdator,
+    DownloadProgressStatus: constants_1.DownloadProgressStatus,
 };
 //# sourceMappingURL=index.js.map

package/build/mac-updator.js

@@ -10,9 +10,6 @@ const constants_1 = require("./common/constants");
 const install_macos_dmg_1 = __importDefault(require("./utils/install-macos-dmg"));
 const utils_1 = require("./utils");
 class MacUpdator extends app_updator_1.AppUpdator {
-    constructor(options) {
-        super(options);
-    }
     doGetAvailableUpdateInfo(updateInfo) {
         this.logger.info('MacUpdator#doGetAvailableUpdateInfo:start');
         const exePath = this.app.exePath;
@@ -96,7 +93,7 @@ class MacUpdator extends app_updator_1.AppUpdator {
         };
     }
     async doQuitAndInstallPackage() {
-        this.logger.info('AppUpdator#doQuitAndInstallPackage:start');
+        this.logger.info('ElectronUpdator#doQuitAndInstallPackage:start');
         return await (0, install_macos_dmg_1.default)(this.options, this.logger, this.availableUpdate, this.updateInfo);
     }
 }

package/build/utils/index.js

@@ -5,12 +5,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getExecuteFile = exports.requestUpdateInfo = exports.existFile = exports.cleanOldArchive = exports.spawnAsync = exports.waitUntil = exports.sleep = exports.getMacOSAppPath = exports.sudoPrompt = exports.existsSync = exports.createWriteStream = exports.isMac = exports.isWin = exports.execAsync = exports.rimrafAsync = exports.readdirAsync = exports.existsAsync = exports.renameAsync = void 0;
 const path_1 = __importDefault(require("path"));
-const child_process_1 = require("child_process");
 const util_1 = __importDefault(require("util"));
 const urllib_1 = __importDefault(require("urllib"));
 const sudo_prompt_alt_1 = __importDefault(require("sudo-prompt-alt"));
 exports.sudoPrompt = sudo_prompt_alt_1.default;
 const rimraf_alt_1 = __importDefault(require("rimraf-alt"));
+const child_process_1 = require("child_process");
 const original_fs_1 = require("original-fs");
 Object.defineProperty(exports, "existsSync", { enumerable: true, get: function () { return original_fs_1.existsSync; } });
 Object.defineProperty(exports, "createWriteStream", { enumerable: true, get: function () { return original_fs_1.createWriteStream; } });

package/build/utils/install-macos-dmg.js

@@ -51,6 +51,7 @@ exports.default = async (updatorOptions, logger, availableUpdate, updateInfo, pr
             if (preCheck) {
                 _log(logger, error);
             }
+            // eslint-disable-next-line
             return {
                 success: false,
                 error,
@@ -75,6 +76,7 @@ exports.default = async (updatorOptions, logger, availableUpdate, updateInfo, pr
             if (preCheck) {
                 _log(logger, error);
             }
+            // eslint-disable-next-line
             return {
                 success: false,
                 error,
@@ -109,6 +111,7 @@ exports.default = async (updatorOptions, logger, availableUpdate, updateInfo, pr
         });
         if (!tmpPathExist) {
             const error = new Error('cp to tmp path fail');
+            // eslint-disable-next-line
             return {
                 success: false,
                 error,
@@ -131,6 +134,7 @@ exports.default = async (updatorOptions, logger, availableUpdate, updateInfo, pr
         if (!appExist) {
             const error = new Error('cp to app fail');
             await (0, index_1.spawnAsync)('mv', [tmpPath, appPath]);
+            // eslint-disable-next-line
             return {
                 success: false,
                 error,

package/build/utils/sudo-prompt-exec.js

@@ -8,7 +8,7 @@ function sudoPromptExec(appUpdatorOptions, logger, shell) {
     };
     return new Promise((resolve, reject) => {
         logger.warn(`update#sudoPromptExec_shell_${shell}`);
-        index_1.sudoPrompt.exec(shell, options, (error, stdout, _) => {
+        index_1.sudoPrompt.exec(shell, options, (error, stdout) => {
             if (error) {
                 reject(error);
                 logger.error(`update#sudoPromptExec_error_${error}`);

package/build/windows-updator.js

@@ -13,7 +13,7 @@ const utils_1 = require("./utils");
 class WindowsUpdator extends app_updator_1.AppUpdator {
     doGetAvailableUpdateInfo(updateInfo) {
         this.logger.info('WindowsUpdator#doGetAvailableUpdateInfo:start');
-        let resourcePath = path_1.default.resolve(this.app.userDataPath);
+        const resourcePath = path_1.default.resolve(this.app.userDataPath);
         const latestAsarPath = path_1.default.resolve(resourcePath, 'latest.asar');
         const latestAppPath = path_1.default.resolve(resourcePath, 'latest');
         let downloadTargetDir = `${latestAsarPath}.zip`;
@@ -76,7 +76,7 @@ class WindowsUpdator extends app_updator_1.AppUpdator {
         const executeCommand = `"${updateExePath}" "${targetPath}" "${resourcePath}" "${productName}.exe" "${exePath}"`;
         try {
             await (0, sudo_prompt_exec_1.sudoPromptExec)(this.options, this.logger, executeCommand);
-            this.logger.warn('AppUpdator#quitAndInstall:install success');
+            this.logger.warn('ElectronUpdator#quitAndInstall:install success');
             this.emit(constants_1.EventType.BEFORE_QUIT_FOR_UPDATE);
             return Promise.resolve({ success: true });
         }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "electron-updator",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "electron-updator is a software updator management solution for Electron applications, It is convenient to complete full software update and dynamic update.",
   "scripts": {
     "build": "sh ./build.sh",
     "test": "egg-bin test test/**/index.test.ts",
-    "lint": "eslint --fix --quiet --ext .js,.jsx ./src",
+    "lint": "eslint --fix --quiet --ext .js,.ts ./src",
     "prepublishOnly": "npm run build",
     "contributor": "git-contributor",
     "dev": "ttsc -p tsconfig.json -watch"
@@ -26,11 +26,11 @@
   },
   "dependencies": {
     "eventemitter3": "^4.0.0",
-    "lodash": "4.17.21",
-    "moment": "2.29.4",
+    "lodash": "4",
+    "moment": "2",
     "rimraf-alt": "*",
     "sudo-prompt-alt": "9",
-    "urllib": "2.34.1"
+    "urllib": "2"
   },
   "devDependencies": {
     "@applint/spec": "^1.2.0",
@@ -48,8 +48,8 @@
     "electron": "18",
     "electron-windows": "18",
     "eslint": "^7.32.0",
-    "eslint-config-egg": "^9.0.0",
-    "eslint-plugin-no-only-tests": "^2.6.0",
+    "eslint-config-egg": "^12.1.0",
+    "eslint-plugin-no-only-tests": "^3.1.0",
     "git-contributor": "*",
     "husky": "^7.0.4",
     "mm": "^3.0.2",
@@ -69,4 +69,4 @@
     }
   },
   "license": "MIT"
-}
+}