fix(electron-auto-updater): uncaught SHA2 checksum mismatch exception

Author: develar

.idea/dictionaries/develar.xml

@@ -3,8 +3,8 @@ import { spawn } from "child_process"
 import * as path from "path"
 import { tmpdir } from "os"
 import { gt as isVersionGreaterThan, valid as parseVersion } from "semver"
-import { download, executorHolder } from "electron-builder-http"
-import { Provider, UpdateCheckResult, FileInfo } from "./api"
+import { download, executorHolder, DownloadOptions } from "electron-builder-http"
+import { Provider, UpdateCheckResult, FileInfo, UpdaterSignal, DOWNLOAD_PROGRESS } from "./api"
 import { BintrayProvider } from "./BintrayProvider"
 import BluebirdPromise from "bluebird-lst-c"
 import { BintrayOptions, PublishConfiguration, GithubOptions, GenericServerOptions, VersionInfo } from "electron-builder-http/out/publishOptions"
@@ -38,6 +38,8 @@ export class NsisUpdater extends EventEmitter {
   private versionInfo: VersionInfo | null
   private fileInfo: FileInfo | null
 
+  public signals = new UpdaterSignal(this)
+
   constructor(options?: PublishConfiguration | BintrayOptions | GithubOptions) {
     super()
 
@@ -148,12 +150,16 @@ export class NsisUpdater extends EventEmitter {
   async downloadUpdate() {
     const versionInfo = this.versionInfo
     const fileInfo = this.fileInfo
-    const downloadOptions: any = {
-      onProgress: (progress: any) => this.emit("download-progress", {}, progress)
+    const downloadOptions: DownloadOptions = {
+      skipDirCreation: true,
+    }
+
+    if (this.listenerCount(DOWNLOAD_PROGRESS) > 0) {
+      downloadOptions.onProgress = it => this.emit(DOWNLOAD_PROGRESS, it)
     }
 
-    if (fileInfo && fileInfo.sha2) {
-      downloadOptions["sha2"] = fileInfo.sha2
+    if (fileInfo != null && fileInfo.sha2 != null) {
+      downloadOptions.sha2 = fileInfo.sha2
     }
 
     if (versionInfo == null || fileInfo == null) {

packages/electron-auto-updater/src/NsisUpdater.ts

@@ -1,4 +1,6 @@
 import { VersionInfo } from "electron-builder-http/out/publishOptions"
+import { EventEmitter } from "events"
+import { ProgressInfo } from "electron-builder-http"
 
 export interface FileInfo {
   name: string
@@ -19,4 +21,29 @@ export interface UpdateCheckResult {
   readonly fileInfo?: FileInfo
 
   readonly downloadPromise?: Promise<any> | null
+}
+
+export const DOWNLOAD_PROGRESS = "download-progress"
+
+export class UpdaterSignal {
+  constructor(private emitter: EventEmitter) {
+  }
+
+  progress(handler: (event: ProgressInfo) => void) {
+    addHandler(this.emitter, DOWNLOAD_PROGRESS, handler)
+  }
+}
+
+const isLogEvent = false
+
+function addHandler(emitter: EventEmitter, event: string, handler: Function) {
+  if (isLogEvent) {
+    emitter.on(event, function (...args: any[]) {
+      console.log("%s %s", event, args)
+      handler.apply(this, args)
+    })
+  }
+  else {
+    emitter.on(event, handler)
+  }
 }

packages/electron-auto-updater/src/api.ts

@@ -77,7 +77,9 @@ export class ElectronHttpExecutor extends HttpExecutor<Electron.RequestOptions,
 
   doApiRequest<T>(options: Electron.RequestOptions, token: string | null, requestProcessor: (request: Electron.ClientRequest, reject: (error: Error) => void) => void, redirectCount: number = 0): Promise<T> {
     const requestOptions: any = options
-    this.debug(`HTTPS request: ${JSON.stringify(requestOptions, null, 2)}`)
+    if (this.debug.enabled) {
+      this.debug(`HTTPS request: ${JSON.stringify(requestOptions, null, 2)}`)
+    }
 
     if (token != null) {
       (<any>requestOptions.headers).authorization = token.startsWith("Basic") ? token : `token ${token}`

packages/electron-auto-updater/src/electronHttpExecutor.ts

@@ -198,6 +198,7 @@ export function configurePipes(options: DownloadOptions, response: any, destinat
 
   let lastStream = response
   for (const stream of streams) {
+    stream.on("error", callback)
     lastStream = lastStream.pipe(stream)
   }
 

packages/electron-builder-http/src/httpExecutor.ts

@@ -80,9 +80,10 @@ export class NodeHttpExecutor extends HttpExecutor<RequestOptions, ClientRequest
     request.end()
   }
 
-
   doApiRequest<T>(options: RequestOptions, token: string | null, requestProcessor: (request: ClientRequest, reject: (error: Error) => void) => void, redirectCount: number = 0): Promise<T> {
-    debug(`HTTPS request: ${JSON.stringify(options, null, 2)}`)
+    if (debug.enabled) {
+      debug(`HTTPS request: ${JSON.stringify(options, null, 2)}`)
+    }
 
     if (token != null) {
       (<any>options.headers).authorization = token.startsWith("Basic") ? token : `token ${token}`

packages/electron-builder/src/util/nodeHttpExecutor.ts

@@ -61,6 +61,22 @@ Object {
 }
 `;
 
+exports[`test sha2 mismatch error event 1`] = `
+Object {
+  "name": "TestApp Setup 1.1.0.exe",
+  "sha2": "f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd1",
+  "url": "https://develar.s3.amazonaws.com/test/TestApp Setup 1.1.0.exe",
+}
+`;
+
+exports[`test sha2 mismatch error event 2`] = `
+Array [
+  "checking-for-update",
+  "update-available",
+  "error",
+]
+`;
+
 exports[`test test error 1`] = `
 Array [
   "checking-for-update",

test/out/__snapshots__/nsisUpdaterTest.js.snap

@@ -12,8 +12,6 @@ if (process.env.ELECTRON_BUILDER_OFFLINE === "true") {
   })
 }
 
-const NsisUpdaterClass = require("../../packages/electron-auto-updater/out/NsisUpdater").NsisUpdater
-
 const g = (<any>global)
 g.__test_app = {
   getVersion: function () {
@@ -26,17 +24,17 @@ g.__test_app = {
 }
 
 test("check updates - no versions at all", async () => {
-  const updater: NsisUpdater = new NsisUpdaterClass({
-      provider: "bintray",
-      owner: "actperepo",
-      package: "no-versions",
-    })
+  const updater = new NsisUpdater({
+    provider: "bintray",
+    owner: "actperepo",
+    package: "no-versions",
+  })
 
   await assertThat(updater.checkForUpdates()).throws(/No latest version, please ensure that/)
 })
 
 test("cannot find suitable file for version", async () => {
-  const updater: NsisUpdater = new NsisUpdaterClass({
+  const updater = new NsisUpdater({
     provider: "bintray",
     owner: "actperepo",
     package: "incorrect-file-version",
@@ -54,7 +52,7 @@ test("file url", async () => {
     package: "TestApp",
   }))
   g.__test_resourcesPath = testResourcesPath
-  const updater: NsisUpdater = new NsisUpdaterClass()
+  const updater = new NsisUpdater()
 
   const actualEvents: Array<string> = []
   const expectedEvents = ["checking-for-update", "update-available", "update-downloaded"]
@@ -79,7 +77,7 @@ test("file url generic", async () => {
     url: "https://develar.s3.amazonaws.com/test",
   }))
   g.__test_resourcesPath = testResourcesPath
-  const updater: NsisUpdater = new NsisUpdaterClass()
+  const updater = new NsisUpdater()
 
   const actualEvents = trackEvents(updater)
 
@@ -90,6 +88,26 @@ test("file url generic", async () => {
   expect(actualEvents).toMatchSnapshot()
 })
 
+test("sha2 mismatch error event", async () => {
+  const tmpDir = new TmpDir()
+  const testResourcesPath = await tmpDir.getTempFile("update-config")
+  await outputFile(path.join(testResourcesPath, "app-update.yml"), safeDump(<GenericServerOptions>{
+    provider: "generic",
+    url: "https://develar.s3.amazonaws.com/test",
+    channel: "beta",
+  }))
+  g.__test_resourcesPath = testResourcesPath
+  const updater = new NsisUpdater()
+
+  const actualEvents = trackEvents(updater)
+
+  const updateCheckResult = await updater.checkForUpdates()
+  expect(updateCheckResult.fileInfo).toMatchSnapshot()
+  await assertThat(updateCheckResult.downloadPromise).throws(/SHA2 checksum mismatch,/)
+
+  expect(actualEvents).toMatchSnapshot()
+})
+
 test("file url generic - manual download", async () => {
   const tmpDir = new TmpDir()
   const testResourcesPath = await tmpDir.getTempFile("update-config")
@@ -98,7 +116,7 @@ test("file url generic - manual download", async () => {
     url: "https://develar.s3.amazonaws.com/test",
   }))
   g.__test_resourcesPath = testResourcesPath
-  const updater: NsisUpdater = new NsisUpdaterClass()
+  const updater = new NsisUpdater()
   updater.autoDownload = false
 
   const actualEvents = trackEvents(updater)
@@ -120,7 +138,7 @@ test("checkForUpdates several times", async () => {
     url: "https://develar.s3.amazonaws.com/test",
   }))
   g.__test_resourcesPath = testResourcesPath
-  const updater: NsisUpdater = new NsisUpdaterClass()
+  const updater: NsisUpdater = new NsisUpdater()
 
   const actualEvents = trackEvents(updater)
 
@@ -144,7 +162,7 @@ test("file url github", async () => {
     repo: "__test_nsis_release",
   }))
   g.__test_resourcesPath = testResourcesPath
-  const updater: NsisUpdater = new NsisUpdaterClass()
+  const updater: NsisUpdater = new NsisUpdater()
 
   const actualEvents: Array<string> = []
   const expectedEvents = ["checking-for-update", "update-available", "update-downloaded"]
@@ -163,7 +181,7 @@ test("file url github", async () => {
 
 test("test error", async () => {
   g.__test_resourcesPath = null
-  const updater: NsisUpdater = new NsisUpdaterClass()
+  const updater: NsisUpdater = new NsisUpdater()
 
   const actualEvents = trackEvents(updater)
 
@@ -179,14 +197,12 @@ test("test download progress", async () => {
     url: "https://develar.s3.amazonaws.com/test",
   }))
   g.__test_resourcesPath = testResourcesPath
-  const updater: NsisUpdater = new NsisUpdaterClass()
+  const updater = new NsisUpdater()
   updater.autoDownload = false
 
   const progressEvents: Array<any> = []
 
-  updater.addListener("download-progress", (e: any, progress: any) => {
-    progressEvents.push(progress)
-  })
+  updater.signals.progress(it => progressEvents.push(it))
 
   await updater.checkForUpdates()
   await updater.downloadUpdate()
@@ -195,7 +211,7 @@ test("test download progress", async () => {
 
   const lastEvent = progressEvents.pop()
 
-  expect(parseInt(lastEvent.percent, 10)).toBe(100)
+  expect(lastEvent.percent).toBe(100)
   expect(lastEvent.bytesPerSecond).toBeGreaterThan(1)
   expect(lastEvent.transferred).toBe(lastEvent.total)
 })