graceful-electron-updater 1.0.1 → 1.0.4

package/README.md

@@ -1,24 +1,24 @@
-# electron-updator
+# graceful-electron-updater
 
 [![NPM version][npm-image]][npm-url]
 [![CI][ci-image]][ci-url]
 [![node version][node-image]][node-url]
 [![npm download][download-image]][download-url]
 
-[npm-image]: https://img.shields.io/npm/v/electron-updator.svg
-[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
+[npm-image]: https://img.shields.io/npm/v/graceful-electron-updater.svg
+[npm-url]: https://npmjs.org/package/graceful-electron-updater
+[ci-image]: https://github.com/electron-modules/graceful-electron-updater/actions/workflows/ci.yml/badge.svg
+[ci-url]: https://github.com/electron-modules/graceful-electron-updater/actions/workflows/ci.yml
 [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
-[download-url]: https://npmjs.org/package/electron-updator
+[download-image]: https://img.shields.io/npm/dm/graceful-electron-updater.svg
+[download-url]: https://npmjs.org/package/graceful-electron-updater
 
 > electron updator
 ## Installment
 
 ```bash
-$ npm i electron-updator --save
+$ npm i graceful-electron-updater --save
 ```
 
 <!-- GITCONTRIBUTOR_START -->

package/build/app-updator.js

@@ -1,33 +1,43 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppUpdator = void 0;
 const eventemitter3_1 = require("eventemitter3");
+const nanoid_1 = require("nanoid");
+const path_1 = __importDefault(require("path"));
 const constants_1 = require("./common/constants");
 const download_file_1 = require("./utils/download-file");
 const utils_1 = require("./utils");
 const elelctron_app_adapter_1 = require("./elelctron-app-adapter");
+const DEFAULT_EXEFILE_DIR = path_1.default.join(__dirname, '..', 'helper');
 class AppUpdator extends eventemitter3_1.EventEmitter {
     constructor(options, app) {
         super();
         this.state = constants_1.StateType.Idle;
         this.options = options;
+        this._windowHelperExeDir = this.options?.getWindowsHelperExeDir?.() || DEFAULT_EXEFILE_DIR;
         this.logger = this._wrapLogger(options.logger);
         this.app = app || new elelctron_app_adapter_1.ElectronAppAdapter();
-        this.startTimeStamp = new Date().getTime();
-        this.logger.info('ElectronUpdator#constructor');
+        this.startUuid = this._getStartUuid();
+        this.logger.info('constructor');
         this.availableUpdate = {
             resourcePath: '',
             latestAsarPath: '',
             downloadTargetDir: '',
         };
     }
+    _getStartUuid() {
+        return `${(0, nanoid_1.nanoid)(16)}${Date.now()}`;
+    }
     _wrapLogger(logger) {
         if (!logger) {
             logger = console;
         }
         const _logger = { ...logger };
         const _wrap = (message, callback) => {
-            callback(`ElectronUpdator(${this.startTimeStamp})${message}`);
+            callback(`[ElectronUpdator][${this.startUuid}]#${message}`);
         };
         _logger.error = (message) => {
             _wrap(message, logger.error);
@@ -41,28 +51,28 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         return _logger;
     }
     setState(state) {
-        this.logger.info(`ElectronUpdator#setState${state}`);
+        this.logger.info(`setState:${state}`);
         this.state = state;
     }
     setFeedUrl(url) {
-        this.logger.info(`ElectronUpdator#setFeedUrl:url is ${url}`);
+        this.logger.info(`setFeedUrl:url is ${url}`);
         if (url && this.options) {
             this.options.url = url;
         }
     }
     async checkForUpdates(executeType = constants_1.ExecuteType.Auto) {
-        this.logger.info(`ElectronUpdator#checkForUpdates:state is ${this.state}`);
+        this.logger.info(`checkForUpdates:state is ${this.state}`);
         this.setState(constants_1.StateType.Idle);
         try {
-            // 新一轮更新流程，更新 TimeStamp
-            this.startTimeStamp = new Date().getTime();
+            // 新一轮更新流程，更新 startUuid
+            this.startUuid = this._getStartUuid();
             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?.updateInfoFormatter ? this.options?.updateInfoFormatter(updateInfoResponse) : updateInfoResponse);
             const ifNeedUpdate = this.options?.ifNeedUpdate(updateInfoResponse);
             if (!ifNeedUpdate) {
-                this.logger.info(`ElectronUpdator#updateInfo is ${JSON.stringify(this.updateInfo)},ifNeedUpdate is false`);
+                this.logger.info(`checkForUpdates:updateInfo is ${JSON.stringify(this.updateInfo)},ifNeedUpdate is false`);
                 this.emit(constants_1.EventType.UPDATE_NOT_AVAILABLE, {
                     updateInfo: this.updateInfo,
                     executeType,
@@ -70,10 +80,10 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
                 this.setState(constants_1.StateType.Idle);
                 return;
             }
-            this.logger.info('ElectronUpdator#checkForUpdates:ifNeedUpdate is true');
+            this.logger.info('checkForUpdates:ifNeedUpdate is true');
             this.availableUpdate = this.doGetAvailableUpdateInfo(this.updateInfo);
             if (!this.options?.autoDownload || executeType === constants_1.ExecuteType.User) {
-                this.logger.info('ElectronUpdator#checkForUpdates:emit UPDATE_AVAILABLE');
+                this.logger.info('checkForUpdates:emit UPDATE_AVAILABLE');
                 this.emit(constants_1.EventType.UPDATE_AVAILABLE, {
                     updateInfo: this.updateInfo,
                     executeType,
@@ -89,11 +99,11 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         }
     }
     async downloadUpdate(executeType = constants_1.ExecuteType.User) {
-        this.logger.info(`ElectronUpdator#downloadUpdate:executeType is ${executeType}`);
+        this.logger.info(`downloadUpdate:executeType is ${executeType}`);
         await this.downloadUpdateFile(this.updateInfo, executeType);
         const result = await this.preCheck(executeType);
         if (result.success) {
-            this.logger.info('ElectronUpdator#downloadUpdate:emit UPDATE_DOWNLOADED');
+            this.logger.info('downloadUpdate:emit UPDATE_DOWNLOADED');
             this.emit(constants_1.EventType.UPDATE_DOWNLOADED, {
                 executeType,
             });
@@ -104,7 +114,7 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         }
     }
     async quitAndInstall() {
-        this.logger.info(`ElectronUpdator#quitAndInstall:state is ${this.state}`);
+        this.logger.info(`quitAndInstall:state is ${this.state}`);
         if (this.state !== constants_1.StateType.Downloaded) {
             this.downloadUpdate();
             return;
@@ -112,17 +122,14 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         this.setState(constants_1.StateType.Idle);
         try {
             let result = { success: false };
+            this.emit(constants_1.EventType.BEFORE_QUIT_FOR_UPDATE);
             if (this.updateInfo?.updateType === constants_1.UpdateType.Package) {
                 result = await this.doQuitAndInstallPackage();
             }
             else {
                 result = await this.doQuitAndInstallAsar();
             }
-            if (result.success) {
-                this.logger.warn('ElectronUpdator#quitAndInstall:install success');
-                this.emit(constants_1.EventType.BEFORE_QUIT_FOR_UPDATE);
-            }
-            else {
+            if (!result.success) {
                 result.message = `error: ${result.error?.message}`;
                 this.dispatchError(result.error);
             }
@@ -132,21 +139,21 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         }
     }
     async preCheckForAsar() {
-        this.logger.info('ElectronUpdator#preCheckForAsar');
+        this.logger.info('preCheckForAsar');
         return await this.unzip();
     }
     async preCheck(executeType) {
-        this.logger.info('ElectronUpdator#preCheck');
+        this.logger.info('preCheck');
         const { resourcePath } = this.availableUpdate;
         if (this.state !== constants_1.StateType.Downloaded) {
             return {
                 success: false,
-                error: new Error(`ElectronUpdator#preCheck:update status(${this.state}) error`),
+                error: new Error(`preCheck:update status(${this.state}) error`),
             };
         }
         // 清理老包
         try {
-            this.logger.info('ElectronUpdator#preCheck:cleanOldArchive');
+            this.logger.info('preCheck:cleanOldArchive');
             await (0, utils_1.cleanOldArchive)(resourcePath);
         }
         catch (e) {
@@ -183,7 +190,7 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
     }
     async downloadUpdateFile(updateInfo, executeType) {
         if (this.state !== constants_1.StateType.CheckingForUpdate) {
-            throw new Error(`ElectronUpdator#downloadUpdateFile:update status(${this.state}) error`);
+            throw new Error(`downloadUpdateFile:update status(${this.state}) error`);
         }
         const { url, signature } = updateInfo.files[0];
         const { downloadTargetDir } = this.availableUpdate;
@@ -199,7 +206,7 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
                     this.emit(constants_1.EventType.UPDATE_DOWNLOAD_PROGRESS, { ...data, executeType });
                 },
             });
-            this.logger.info('ElectronUpdator#downloadUpdateFile:Downloaded');
+            this.logger.info('downloadUpdateFile:Downloaded');
             this.setState(constants_1.StateType.Downloaded);
         }
         catch (e) {
@@ -209,7 +216,7 @@ class AppUpdator extends eventemitter3_1.EventEmitter {
         }
     }
     async unzip() {
-        this.logger.info('ElectronUpdator#unzip:start');
+        this.logger.info('unzip:start');
         try {
             const result = await this.doUnzip();
             if (!result.success) {

package/build/mac-updator.js

@@ -36,7 +36,7 @@ class MacUpdator extends app_updator_1.AppUpdator {
      * @return
      */
     async doUnzip() {
-        this.logger.info('ElectronUpdator#MacUpdator#doUnzip:start');
+        this.logger.info('MacUpdator#doUnzip:start');
         const { resourcePath, downloadTargetDir } = this.availableUpdate;
         try {
             // 直接解压
@@ -88,13 +88,20 @@ class MacUpdator extends app_updator_1.AppUpdator {
                 error,
             };
         }
+        this.logger.warn('quitAndInstall:install success');
+        this.app.relaunch();
         return {
             success: true,
         };
     }
     async doQuitAndInstallPackage() {
         this.logger.info('ElectronUpdator#doQuitAndInstallPackage:start');
-        return await (0, install_macos_dmg_1.default)(this.options, this.logger, this.availableUpdate, this.updateInfo);
+        const result = await (0, install_macos_dmg_1.default)(this.options, this.logger, this.availableUpdate, this.updateInfo);
+        if (result.success) {
+            this.logger.warn('quitAndInstall:install success');
+            this.app.relaunch();
+        }
+        return result;
     }
 }
 exports.MacUpdator = MacUpdator;

package/build/utils/download-file.js

@@ -17,7 +17,7 @@ const _1 = require(".");
  * @return
  */
 const downloadFile = async ({ logger, url, signature, targetDir, progressHandle }) => {
-    logger.info('ElectronUpdator#downloadFile#downloadFile (start)');
+    logger.info('downloadFile#downloadFile (start)');
     const writeStream = (0, _1.createWriteStream)(targetDir);
     let currentLength = 0;
     let currentProgress = 0;
@@ -33,7 +33,7 @@ const downloadFile = async ({ logger, url, signature, targetDir, progressHandle
         })
             .then((res) => {
             const totalLength = res.headers['content-length'];
-            logger.info(`ElectronUpdator#downloadFile#downloadFile (then),totalLength is ${totalLength}`);
+            logger.info(`downloadFile#downloadFile (then),totalLength is ${totalLength}`);
             res.res.on('data', (data) => {
                 try {
                     currentLength += data.length;
@@ -63,7 +63,7 @@ const downloadFile = async ({ logger, url, signature, targetDir, progressHandle
                         url,
                         signature,
                     });
-                    logger.info('ElectronUpdator#download file success, url:%s, to %s', url, targetDir);
+                    logger.info('downloadFile#download file success, url:%s, to %s', url, targetDir);
                     resolve();
                 }
                 catch (e) {

package/build/utils/index.js

@@ -115,8 +115,8 @@ const requestUpdateInfo = async (options) => {
     return res.data;
 };
 exports.requestUpdateInfo = requestUpdateInfo;
-const getExecuteFile = (file) => {
-    return path_1.default.join(__dirname, '..', 'libs', file);
+const getExecuteFile = (helperExeFileDir, file) => {
+    return path_1.default.join(helperExeFileDir, file);
 };
 exports.getExecuteFile = getExecuteFile;
 //# sourceMappingURL=index.js.map

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

@@ -2,20 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sudoPromptExec = void 0;
 const index_1 = require("./index");
-function sudoPromptExec(appUpdatorOptions, logger, shell) {
+function sudoPromptExec(logger, shell) {
     const options = {
-        name: appUpdatorOptions.productName,
+        name: 'SoftwareUpdate',
     };
     return new Promise((resolve, reject) => {
-        logger.warn(`ElectronUpdator#update#sudoPromptExec_shell_${shell}`);
+        logger.warn(`sudoPromptExec#_shell_${shell}`);
         index_1.sudoPrompt.exec(shell, options, (error, stdout) => {
             if (error) {
                 reject(error);
-                logger.error(`ElectronUpdator#update#sudoPromptExec_error_${error}`);
+                logger.error(`sudoPromptExec#error_${error}`);
                 return;
             }
             resolve(stdout);
-            logger.warn(`ElectronUpdator#update#sudoPromptExec_stdout_${stdout}`);
+            logger.warn(`sudoPromptExec#stdout_${stdout}`);
         });
     });
 }

package/build/windows-updator.js

@@ -12,7 +12,7 @@ const app_updator_1 = require("./app-updator");
 const utils_1 = require("./utils");
 class WindowsUpdator extends app_updator_1.AppUpdator {
     doGetAvailableUpdateInfo(updateInfo) {
-        this.logger.info('ElectronUpdator#WindowsUpdator#doGetAvailableUpdateInfo:start');
+        this.logger.info('WindowsUpdator#doGetAvailableUpdateInfo:start');
         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');
@@ -27,15 +27,15 @@ class WindowsUpdator extends app_updator_1.AppUpdator {
         };
     }
     async doPreCheckForPackage() {
-        this.logger.info('ElectronUpdator#WindowsUpdator#doPreCheckForPackage:start');
+        this.logger.info('WindowsUpdator#doPreCheckForPackage:start');
         // Windows 全量安装默认预检正常
         return Promise.resolve({ success: true });
     }
     async doUnzip() {
-        this.logger.info('ElectronUpdator#WindowsUpdator#doUnzip:start');
+        this.logger.info('WindowsUpdator#doUnzip:start');
         try {
             const { downloadTargetDir, resourcePath } = this.availableUpdate;
-            const unzipExe = (0, utils_1.getExecuteFile)('unzip.exe');
+            const unzipExe = (0, utils_1.getExecuteFile)(this._windowHelperExeDir, 'unzip.exe');
             const executeCommand = `"${unzipExe}" -o "${downloadTargetDir}" -d "${resourcePath}"`;
             await (0, utils_1.execAsync)(executeCommand);
         }
@@ -45,13 +45,13 @@ class WindowsUpdator extends app_updator_1.AppUpdator {
                 error,
             };
         }
-        this.logger.info('ElectronUpdator#WindowsUpdator#doUnzip:success');
+        this.logger.info('WindowsUpdator#doUnzip:success');
         return {
             success: true,
         };
     }
     async doQuitAndInstallPackage() {
-        this.logger.info('ElectronUpdator#WindowsUpdator#doQuitAndInstallPackage:success');
+        this.logger.info('WindowsUpdator#doQuitAndInstallPackage:success');
         const { downloadTargetDir } = this.availableUpdate;
         try {
             // Windows 全量安装
@@ -60,6 +60,7 @@ class WindowsUpdator extends app_updator_1.AppUpdator {
             setTimeout(() => {
                 this.app.exit(0);
             }, 30);
+            this.logger.warn('WindowsUpdator#quitAndInstall:install success');
             return Promise.resolve({ success: true });
         }
         catch (error) {
@@ -67,17 +68,16 @@ class WindowsUpdator extends app_updator_1.AppUpdator {
         }
     }
     async doQuitAndInstallAsar() {
-        this.logger.info('ElectronUpdator#WindowsUpdator#doQuitAndInstallAsar:start');
+        this.logger.info('WindowsUpdator#doQuitAndInstallAsar:start');
         const productName = this.options?.productName;
         const { resourcePath } = this.availableUpdate;
         const exePath = this.app.exePath;
-        const updateExePath = (0, utils_1.getExecuteFile)('installer.exe');
+        const updateExePath = (0, utils_1.getExecuteFile)(this._windowHelperExeDir, 'installer.exe');
         const targetPath = path_1.default.resolve(exePath, '..', 'resources');
         const executeCommand = `"${updateExePath}" "${targetPath}" "${resourcePath}" "${productName}.exe" "${exePath}"`;
         try {
-            await (0, sudo_prompt_exec_1.sudoPromptExec)(this.options, this.logger, executeCommand);
-            this.logger.warn('ElectronUpdator#quitAndInstall:install success');
-            this.emit(constants_1.EventType.BEFORE_QUIT_FOR_UPDATE);
+            await (0, sudo_prompt_exec_1.sudoPromptExec)(this.logger, executeCommand);
+            this.logger.warn('WindowsUpdator#quitAndInstall:install success');
             return Promise.resolve({ success: true });
         }
         catch (error) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "graceful-electron-updater",
-  "version": "1.0.1",
-  "description": "electron-updator is a software updator management solution for Electron applications, It is convenient to complete full software update and dynamic update.",
+  "version": "1.0.4",
+  "description": "graceful-electron-updater 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",
@@ -22,12 +22,13 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/electron-modules/electron-updator"
+    "url": "https://github.com/electron-modules/graceful-electron-updater"
   },
   "dependencies": {
     "eventemitter3": "^4.0.0",
     "lodash": "4",
     "moment": "2",
+    "nanoid": "^3.3.4",
     "rimraf-alt": "*",
     "sudo-prompt-alt": "9",
     "urllib": "2"