最近使用electron-builder提供的nsis模块重新设计了windows平台的打包方式。区别于electron-packager的squirrel更新机制,nsis有个安装过程。nsis打包方式好处显而易见:更多配置项、较好的安装界面,实际运用后,发现在自动更新
electron-updater
这块遇到了问题。
问题
先简单介绍下autoUpdater的使用:
const autoUpdate = () => {
// 新的打包机制下,win和mac都采用该更新方式
const {autoUpdater} = require('electron-updater');
autoUpdater.on('checking-for-update', () => {
log.info('Checking for update...');
});
autoUpdater.on('update-available', (ev, info) => {
log.info('Update available.');
});
autoUpdater.on('update-not-available', (ev, info) => {
log.info('Update not available.');
});
autoUpdater.on('error', (ev, err) => {
log.error('Error in auto-updater.' + err + '|' + ev);
const updateWindow = glb.get(cfg.GLB.UPDATE_WINDOW);
const option = glb.get(cfg.GLB.SHOW_UPDATE_WINODW, {});
const errDesc = cfg.CONST.VERSION? '版本更新下载出错,请联系U聊团队': '版本更新下载出错,建议前往官网手动下载, https://upchat.95516.net/#pc';
_.assign(option, {
downloading: false,
desc: errDesc,
});
updateWindow.webContents.send(cfg.CHANNEL.LOCAL.UPDATE.UPDATE_OPTION, option);
});
autoUpdater.on('download-progress', (progress) => {
log.info('Download progress...', progress.percent);
const mainWindow = glb.get(cfg.GLB.MAIN_WINDOW);
if (!!mainWindow) {
mainWindow.setProgressBar(progress.percent / 100);
}
});
autoUpdater.on('update-downloaded', (ev, info) => {
log.info('update downloaded...');
const updateWindow = glb.get(cfg.GLB.UPDATE_WINDOW);
const option = glb.get(cfg.GLB.SHOW_UPDATE_WINODW, {});
_.assign(option, {
downloading: false,
downloaded: true,
});
updateWindow.webContents.send(cfg.CHANNEL.LOCAL.UPDATE.UPDATE_OPTION, option);
});
autoUpdater.checkForUpdates();
};
调用autoUpdater.checkForUpdates()
来请求打包时配好的更新地址,检测是否有新版本,然后在相应事件中做监听处理。
update-downloaded
事件触发表示更新包已成功下载,这时候可以通过autoUpdater.quitAndInstall()
方法来退出当前应用并安装新包。我们这有个让用户选择是否立即退出更新的交互,因此,检测到下载完成后只是通知了UI,待收到用户指令后再决定是否quitAndInstall。
现象
调用了quitAndInstall()
后,win7上正常,即退出当前程序,并打开了新版本的安装界面(electron-packager那种自动替换到新包,下次打开便已经是新版本,个人觉得这样的交互更好些,但…)。mac上也正常,quit后立即重新打开了新版本。
然而,在win8和win10上,程序退出后无反应,没有弹出新版本安装界面。再次打开快捷方式,依然是旧版本..打开日志,发现quitAndInstall
方法报错了:
[2017-05-24 09:42:04:0249] [info] Update downloaded; will install in 5 seconds
[2017-05-24 09:42:13:0894] [error] Error: Error: spawn EACCES
at exports._errnoException (util.js:1050:11)
at ChildProcess.spawn (internal/child_process.js:319:11)
at exports.spawn (child_process.js:390:9)
at NsisUpdater.install (C:\Program Files\electron-updater-generic-example\resources\app.asar\node_modules\electron-updater\src\NsisUpdater.ts:116:7)
at NsisUpdater.quitAndInstall (C:\Program Files\electron-updater-generic-example\resources\app.asar\node_modules\electron-updater\src\NsisUpdater.ts:86:14)
at Timeout._onTimeout (C:\Program Files\electron-updater-generic-example\resources\app.asar\main.js:122:17)
at ontimeout (timers.js:386:14)
at tryOnTimeout (timers.js:250:5)
at Timer.listOnTimeout (timers.js:214:5)
[2017-05-24 09:42:13:0894] [info] Error in auto-updater.
[2017-05-24 09:42:13:0898] [info] Auto install update on quit
spawn EACCES,这是一个很常见的错误,通常指权限引起的问题。
分析
在issue中查看有关quitAndInstall()
或spawn EACCES
相关:
- electron-updater raising EACCES in spawned process when executing "quitAndInstall" #1580
- Updater not working with Windows 10/Electron 1.7.3 #1725
总结下来,无法安装更新的原因竟然是和nsis打包方式有关:
nsis的配置项里有个属性为perMachine
(具体参考https://www.electron.build/configuration/nsis),该字段用于配置安装应用是面向windows所有用户,还是仅自己..我理解如果设为true,则打开安装程序需要管理员权限..
而我们的打包配置里确实设置了perMachine: true
,文档里有提到如果nsis的oneClick如果设为false,则perMachine默认为true,但实际操作下来,两者都设为false后,无法自动安装更新的问题解决了。
解决
不修改
perMachine=false
时,使用管理员权限运行程序,这时可以下载更新并成功安装;-
修改
perMachine=false
:"nsis": { "oneClick": false, "perMachine": false, "allowToChangeInstallationDirectory": true, "deleteAppDataOnUninstall": false, "installerSidebar": "../../resources/siderbars.bmp", "uninstallerSidebar": "../../resources/siderbars.bmp" },
总结
- electron-builder提供的nsis配置项
perMachine
影响了自动更新的安装权限问题(windows7不受影响) -
quitAndInstall
在windows上会退出当前应用并打开新版本的安装界面,这点与electron-packager不一样,这种交互可能会有点让用户难以接受..