feat: Adding download-progress event to AutoUpdater (#1042)

Closes #958

Author: badams

nsis-auto-updater/src/NsisUpdater.ts

@@ -148,6 +148,13 @@ 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)
+    }
+
+    if (fileInfo && fileInfo.sha2) {
+      downloadOptions["sha2"] = fileInfo.sha2
+    }
 
     if (versionInfo == null || fileInfo == null) {
       const message = "Please check update first"
@@ -157,7 +164,7 @@ export class NsisUpdater extends EventEmitter {
     }
 
     return mkdtemp(`${path.join(tmpdir(), "up")}-`)
-      .then(it => download(fileInfo.url, path.join(it, fileInfo.name), fileInfo.sha2 == null ? null : {sha2: fileInfo.sha2}))
+      .then(it => download(fileInfo.url, path.join(it, fileInfo.name), downloadOptions))
       .then(it => {
         this.setupPath = it
         this.addQuitHandler()

nsis-auto-updater/src/electronHttpExecutor.ts

@@ -3,7 +3,7 @@ import { net } from "electron"
 import { createWriteStream, ensureDir } from "fs-extra-p"
 import BluebirdPromise from "bluebird-lst-c"
 import * as path from "path"
-import { HttpExecutor, DownloadOptions, HttpError, DigestTransform, checkSha2 } from "../../src/util/httpExecutor"
+import { HttpExecutor, DownloadOptions, HttpError, DigestTransform, checkSha2, calculateDownloadProgress } from "../../src/util/httpExecutor"
 import { Url } from "url"
 import { safeLoad } from "js-yaml"
 import _debug from "debug"
@@ -69,7 +69,7 @@ export class ElectronHttpExecutor implements HttpExecutor {
     // user-agent must be specified, otherwise some host can return 401 unauthorised
 
     //FIXME hack, the electron typings specifies Protocol with capital but the code actually uses with small case
-    const requestOpts  = {
+    const requestOpts = {
       protocol: parsedUrl.protocol,
       hostname: parsedUrl.hostname,
       path: parsedUrl.path,
@@ -99,6 +99,16 @@ export class ElectronHttpExecutor implements HttpExecutor {
         return
       }
 
+      if (options.onProgress != null) {
+        const total = parseInt(String(safeGetHeader(response, "content-length")), 10)
+        const start = Date.now()
+        let transferred = 0
+
+        response.on("data", (chunk: any) => {
+          transferred = calculateDownloadProgress(total, start, transferred, chunk, options.onProgress)
+        })
+      }
+
       ensureDirPromise
         .then(() => {
           const fileOut = createWriteStream(destination)

src/util/httpExecutor.ts

@@ -5,6 +5,7 @@ import { Transform } from "stream"
 export interface DownloadOptions {
   skipDirCreation?: boolean
   sha2?: string
+  onProgress?(progress: any): void
 }
 
 export class HttpExecutorHolder {
@@ -75,4 +76,15 @@ export function checkSha2(sha2Header: string | null | undefined, sha2: string |
     }
   }
   return true
+}
+
+export function calculateDownloadProgress(total: number, start: number, transferred: number, chunk: any, callback: any): number {
+    transferred += chunk.length
+    callback({
+      total: total,
+      transferred: transferred,
+      percent: ((transferred / total) * 100).toFixed(2),
+      bytesPerSecond: Math.round(transferred / ((Date.now() - start) / 1000))
+    })
+    return transferred
 }

src/util/nodeHttpExecutor.ts

@@ -6,7 +6,7 @@ import BluebirdPromise from "bluebird-lst-c"
 import * as path from "path"
 import { homedir } from "os"
 import { parse as parseIni } from "ini"
-import { HttpExecutor, DownloadOptions, HttpError, DigestTransform, checkSha2 } from "./httpExecutor"
+import { HttpExecutor, DownloadOptions, HttpError, DigestTransform, checkSha2, calculateDownloadProgress} from "./httpExecutor"
 import { Url } from "url"
 import { RequestOptions } from "https"
 import { safeLoad } from "js-yaml"
@@ -95,6 +95,18 @@ export class NodeHttpExecutor implements HttpExecutor {
         return
       }
 
+      if (options.onProgress != null) {
+        const total = parseInt(response.headers["content-length"], 10)
+        const start = Date.now()
+        let transferred = 0
+
+        response.on("data", (chunk: any) => {
+          transferred = calculateDownloadProgress(total, start, transferred, chunk, options.onProgress)
+        })
+
+        response.pause()
+      }
+
       ensureDirPromise
         .then(() => {
           const fileOut = createWriteStream(destination)

test/src/nsisUpdaterTest.ts

@@ -171,6 +171,35 @@ test("test error", async () => {
   expect(actualEvents).toMatchSnapshot()
 })
 
+test("test download progress", 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",
+  }))
+  g.__test_resourcesPath = testResourcesPath
+  const updater: NsisUpdater = new NsisUpdaterClass()
+  updater.autoDownload = false
+
+  const progressEvents: Array<any> = []
+
+  updater.addListener("download-progress", (e: any, progress: any) => {
+    progressEvents.push(progress)
+  })
+
+  await updater.checkForUpdates()
+  await updater.downloadUpdate()
+
+  expect(progressEvents.length).toBeGreaterThanOrEqual(1)
+
+  const lastEvent = progressEvents.pop()
+
+  expect(parseInt(lastEvent.percent, 10)).toBe(100)
+  expect(lastEvent.bytesPerSecond).toBeGreaterThan(1)
+  expect(lastEvent.transferred).toBe(lastEvent.total)
+})
+
 function trackEvents(updater: NsisUpdater) {
   const actualEvents: Array<string> = []
   for (const eventName of ["checking-for-update", "update-available", "update-downloaded", "error"]) {