feat(electron-updater): MacOS delta update

Close electron-userland#2995, Close electron-userland#3269
develar · Sep 8, 2018 · 952c867 · 952c867
1 parent 9eec0a9
commit 952c867
Show file tree

Hide file tree

Showing 22 changed files with 410 additions and 58 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -3,7 +3,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/node:10.9.0
+      - image: circleci/node:10.10.0
     steps:
       - checkout
       - restore_cache:

diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
diff --git a/docker/10/Dockerfile b/docker/10/Dockerfile
@@ -1,6 +1,6 @@
 FROM electronuserland/builder:base
 
-ENV NODE_VERSION 10.9.0
+ENV NODE_VERSION 10.10.0
 
 # this package is used for snapcraft and we should not clear apt list - to avoid apt-get update during snap build
 RUN apt-get -qq update && \

diff --git a/package.json b/package.json
@@ -31,7 +31,7 @@
   "dependencies": {
     "7zip-bin": "~4.0.2",
     "@types/is-ci": "^1.1.0",
-    "app-builder-bin": "2.1.2",
+    "app-builder-bin": "2.1.3",
     "archiver": "^3.0.0",
     "async-exit-hook": "^2.0.1",
     "bluebird-lst": "^1.0.5",
@@ -66,18 +66,33 @@
     "temp-file": "^3.1.3",
     "tunnel-agent": "^0.6.0",
     "update-notifier": "^2.5.0",
-    "yargs": "^12.0.1"
+    "yargs": "^12.0.2"
   },
   "devDependencies": {
     "@babel/core": "^7.0.0",
+    "@babel/plugin-proposal-class-properties": "^7.0.0",
+    "@babel/plugin-proposal-decorators": "^7.0.0",
+    "@babel/plugin-proposal-do-expressions": "^7.0.0",
+    "@babel/plugin-proposal-export-default-from": "^7.0.0",
+    "@babel/plugin-proposal-export-namespace-from": "^7.0.0",
+    "@babel/plugin-proposal-function-bind": "^7.0.0",
+    "@babel/plugin-proposal-function-sent": "^7.0.0",
+    "@babel/plugin-proposal-json-strings": "^7.0.0",
+    "@babel/plugin-proposal-logical-assignment-operators": "^7.0.0",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.0.0",
+    "@babel/plugin-proposal-numeric-separator": "^7.0.0",
+    "@babel/plugin-proposal-optional-chaining": "^7.0.0",
+    "@babel/plugin-proposal-pipeline-operator": "^7.0.0",
+    "@babel/plugin-proposal-throw-expressions": "^7.0.0",
+    "@babel/plugin-syntax-dynamic-import": "^7.0.0",
+    "@babel/plugin-syntax-import-meta": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-react": "^7.0.0",
-    "@babel/preset-stage-0": "^7.0.0",
     "@types/debug": "^0.0.30",
     "@types/ejs": "^2.6.0",
     "@types/electron-is-dev": "^0.3.0",
     "@types/ini": "^1.3.29",
-    "@types/jest": "^23.3.1",
+    "@types/jest": "^23.3.2",
     "@types/js-yaml": "^3.11.2",
     "@types/lodash.isequal": "^4.5.3",
     "@types/node-emoji": "^1.8.0",
@@ -86,6 +101,7 @@
     "@types/semver": "^5.5.0",
     "@types/source-map-support": "^0.4.1",
     "@types/stat-mode": "^0.2.0",
+    "babel-core": "^7.0.0-bridge.0",
     "babel-preset-ts-node6-bluebird": "^2.0.11",
     "convert-source-map": "^1.6.0",
     "cross-env": "^5.2.0",

diff --git a/packages/app-builder-lib/package.json b/packages/app-builder-lib/package.json
@@ -42,7 +42,7 @@
   "homepage": "https://github.com/electron-userland/electron-builder",
   "dependencies": {
     "7zip-bin": "~4.0.2",
-    "app-builder-bin": "2.1.2",
+    "app-builder-bin": "2.1.3",
     "async-exit-hook": "^2.0.1",
     "bluebird-lst": "^1.0.5",
     "chromium-pickle-js": "^0.2.0",

diff --git a/packages/app-builder-lib/src/ProtonFramework.ts b/packages/app-builder-lib/src/ProtonFramework.ts
@@ -40,9 +40,33 @@ class ProtonFramework implements Framework {
       // out test dir can be located outside of electron-builder node_modules and babel cannot resolve string names of preset
       babelOptions.presets = [
         [require("@babel/preset-env").default, {targets: {node: this.version}}],
-        [require("@babel/preset-stage-0"), {decoratorsLegacy: true}],
         require("@babel/preset-react"),
       ]
+      babelOptions.plugins = [
+        // stage 0
+        require("@babel/plugin-proposal-function-bind").default,
+
+        // stage 1
+        require("@babel/plugin-proposal-export-default-from").default,
+        require("@babel/plugin-proposal-logical-assignment-operators").default,
+        [require("@babel/plugin-proposal-optional-chaining").default, {loose: false}],
+        [require("@babel/plugin-proposal-pipeline-operator").default, {proposal: "minimal"}],
+        [require("@babel/plugin-proposal-nullish-coalescing-operator").default, {loose: false}],
+        require("@babel/plugin-proposal-do-expressions").default,
+
+        // stage 2
+        [require("@babel/plugin-proposal-decorators").default, {legacy: true}],
+        require("@babel/plugin-proposal-function-sent").default,
+        require("@babel/plugin-proposal-export-namespace-from").default,
+        require("@babel/plugin-proposal-numeric-separator").default,
+        require("@babel/plugin-proposal-throw-expressions").default,
+
+        // stage 3
+        require("@babel/plugin-syntax-dynamic-import").default,
+        require("@babel/plugin-syntax-import-meta").default,
+        [require("@babel/plugin-proposal-class-properties").default, {loose: false}],
+        require("@babel/plugin-proposal-json-strings").default,
+      ]
       babelOptions.babelrc = false
     }
     else {

diff --git a/packages/app-builder-lib/src/targets/ArchiveTarget.ts b/packages/app-builder-lib/src/targets/ArchiveTarget.ts
@@ -4,6 +4,7 @@ import { Platform, Target, TargetSpecificOptions } from "../core"
 import { copyFiles, getFileMatchers } from "../fileMatcher"
 import { PlatformPackager } from "../platformPackager"
 import { archive, tar } from "./archive"
+import { appendBlockmap } from "./differentialUpdateInfoBuilder"
 
 export class ArchiveTarget extends Target {
   readonly options: TargetSpecificOptions = (this.packager.config as any)[this.name]
@@ -31,6 +32,7 @@ export class ArchiveTarget extends Target {
     const artifactPath = path.join(this.outDir, artifactName)
 
     this.logBuilding(`${isMac ? "macOS " : ""}${format}`, artifactPath, arch)
+    let updateInfo: any = null
     if (format.startsWith("tar.")) {
       await tar(packager.compression, format, artifactPath, appOutDir, isMac, packager.info.tempDirManager)
     }
@@ -54,9 +56,14 @@ export class ArchiveTarget extends Target {
         withoutDir,
       }
       await archive(format, artifactPath, dirToArchive, archiveOptions)
+
+      if (this.isWriteUpdateInfo && format === "zip") {
+        updateInfo = await appendBlockmap(artifactPath)
+      }
     }
 
     packager.info.dispatchArtifactCreated({
+      updateInfo,
       file: artifactPath,
       // tslint:disable-next-line:no-invalid-template-strings
       safeArtifactName: packager.computeSafeArtifactName(artifactName, format, arch, false, defaultPattern.replace("${productName}", "${name}")),

diff --git a/packages/app-builder-lib/src/targets/nsis/NsisTarget.ts b/packages/app-builder-lib/src/targets/nsis/NsisTarget.ts
@@ -96,7 +96,6 @@ export class NsisTarget extends Target {
       const data = await appendBlockmap(archiveFile)
       return {
         ...data,
-        size: data.size!!,
         path: archiveFile,
       }
     }

diff --git a/packages/builder-util/package.json b/packages/builder-util/package.json
@@ -11,7 +11,7 @@
     "out"
   ],
   "dependencies": {
-    "app-builder-bin": "2.1.2",
+    "app-builder-bin": "2.1.3",
     "temp-file": "^3.1.3",
     "fs-extra-p": "^4.6.1",
     "is-ci": "^1.2.0",

diff --git a/packages/electron-builder/package.json b/packages/electron-builder/package.json
@@ -55,7 +55,7 @@
     "read-config-file": "3.1.2",
     "sanitize-filename": "^1.6.1",
     "update-notifier": "^2.5.0",
-    "yargs": "^12.0.1",
+    "yargs": "^12.0.2",
     "lazy-val": "^1.0.3",
     "app-builder-lib": "0.0.0-semantic-release",
     "dmg-builder": "0.0.0-semantic-release"

diff --git a/packages/electron-updater/src/AppUpdater.ts b/packages/electron-updater/src/AppUpdater.ts
@@ -526,7 +526,6 @@ export abstract class AppUpdater extends EventEmitter {
         await this.downloadedUpdateHelper.cacheUpdateInfo(updateFileName)
       }
 
-      this.emit(UPDATE_DOWNLOADED, updateInfo)
       await taskOptions.done!!(updateFile)
       return packageFile == null ? [updateFile] : [updateFile, packageFile]
     }

diff --git a/packages/electron-updater/src/BaseUpdater.ts b/packages/electron-updater/src/BaseUpdater.ts
@@ -1,5 +1,6 @@
 import { AllPublishOptions } from "builder-util-runtime"
 import { AppUpdater, DownloadExecutorTask } from "./AppUpdater"
+import { UPDATE_DOWNLOADED } from "./main"
 
 export abstract class BaseUpdater extends AppUpdater {
   protected quitAndInstallCalled = false
@@ -28,6 +29,7 @@ export abstract class BaseUpdater extends AppUpdater {
     return super.executeDownload({
       ...taskOptions,
       done: async () => {
+        this.emit(UPDATE_DOWNLOADED, taskOptions.downloadUpdateOptions.updateInfo)
         this.addQuitHandler()
       }
     })

diff --git a/packages/electron-updater/src/MacUpdater.ts b/packages/electron-updater/src/MacUpdater.ts
@@ -1,25 +1,34 @@
-import { AllPublishOptions, CancellationToken, configureRequestOptionsFromUrl, DigestTransform, newError, RequestHeaders, safeStringifyJson } from "builder-util-runtime"
+import { AllPublishOptions, CancellationToken, configureRequestOptionsFromUrl, DigestTransform, newError, RequestHeaders, safeStringifyJson, UpdateInfo } from "builder-util-runtime"
 import { createServer, IncomingMessage, OutgoingHttpHeaders, ServerResponse } from "http"
 import { AddressInfo } from "net"
 import { AppUpdater, DownloadUpdateOptions } from "./AppUpdater"
-import { DOWNLOAD_PROGRESS } from "./main"
+import { DOWNLOAD_PROGRESS, UPDATE_DOWNLOADED } from "./main"
 import { findFile } from "./providers/Provider"
 import { createReadStream, stat } from "fs-extra-p"
 import AutoUpdater = Electron.AutoUpdater
 
 export class MacUpdater extends AppUpdater {
   private readonly nativeUpdater: AutoUpdater = require("electron").autoUpdater
 
+  private updateInfoForPendingUpdateDownloadedEvent: UpdateInfo | null = null
+
   constructor(options?: AllPublishOptions) {
     super(options)
 
     this.nativeUpdater.on("error", it => {
       this._logger.warn(it)
       this.emit("error", it)
     })
+    this.nativeUpdater.on("update-downloaded", () => {
+      const updateInfo = this.updateInfoForPendingUpdateDownloadedEvent
+      this.updateInfoForPendingUpdateDownloadedEvent = null
+      this.emit(UPDATE_DOWNLOADED, updateInfo)
+    })
   }
 
   protected async doDownloadUpdate(downloadUpdateOptions: DownloadUpdateOptions): Promise<Array<string>> {
+    this.updateInfoForPendingUpdateDownloadedEvent = null
+
     const files = (await this.provider).resolveFiles(downloadUpdateOptions.updateInfo)
     const zipFileInfo = findFile(files, "zip", ["pkg", "dmg"])
     if (zipFileInfo == null) {
@@ -44,6 +53,7 @@ export class MacUpdater extends AppUpdater {
         return this.httpExecutor.download(zipFileInfo.url.href, destinationFile, downloadOptions)
       },
       done: async updateFile => {
+        this.updateInfoForPendingUpdateDownloadedEvent = downloadUpdateOptions.updateInfo
         let updateFileSize = zipFileInfo.info.size
         if (updateFileSize == null) {
           updateFileSize = (await stat(updateFile)).size

diff --git a/test/out/__snapshots__/PublishManagerTest.js.snap b/test/out/__snapshots__/PublishManagerTest.js.snap
@@ -19,7 +19,9 @@ Object {
       "fileContent": Object {
         "files": Array [
           Object {
+            "blockMapSize": "@blockMapSize",
             "sha512": "@sha512",
+            "size": "@size",
             "url": "TestApp-1.1.0-mac.zip",
           },
         ],
@@ -34,7 +36,9 @@ Object {
       "fileContent": Object {
         "files": Array [
           Object {
+            "blockMapSize": "@blockMapSize",
             "sha512": "@sha512",
+            "size": "@size",
             "url": "TestApp-1.1.0-mac.zip",
           },
         ],
@@ -49,7 +53,9 @@ Object {
       "fileContent": Object {
         "files": Array [
           Object {
+            "blockMapSize": "@blockMapSize",
             "sha512": "@sha512",
+            "size": "@size",
             "url": "TestApp-1.1.0-mac.zip",
           },
         ],
@@ -64,7 +70,9 @@ Object {
       "fileContent": Object {
         "files": Array [
           Object {
+            "blockMapSize": "@blockMapSize",
             "sha512": "@sha512",
+            "size": "@size",
             "url": "TestApp-1.1.0-mac.zip",
           },
         ],
@@ -79,7 +87,9 @@ Object {
       "fileContent": Object {
         "files": Array [
           Object {
+            "blockMapSize": "@blockMapSize",
             "sha512": "@sha512",
+            "size": "@size",
             "url": "TestApp-1.1.0-mac.zip",
           },
         ],
@@ -94,7 +104,9 @@ Object {
       "fileContent": Object {
         "files": Array [
           Object {
+            "blockMapSize": "@blockMapSize",
             "sha512": "@sha512",
+            "size": "@size",
             "url": "TestApp-1.1.0-mac.zip",
           },
         ],
@@ -109,7 +121,9 @@ Object {
       "fileContent": Object {
         "files": Array [
           Object {
+            "blockMapSize": "@blockMapSize",
             "sha512": "@sha512",
+            "size": "@size",
             "url": "TestApp-1.1.0-mac.zip",
           },
         ],
@@ -123,6 +137,11 @@ Object {
       "arch": "x64",
       "file": "Test App ßW-1.1.0-mac.zip",
       "safeArtifactName": "TestApp-1.1.0-mac.zip",
+      "updateInfo": Object {
+        "blockMapSize": "@blockMapSize",
+        "sha512": "@sha512",
+        "size": "@size",
+      },
     },
   ],
 }
@@ -190,7 +209,9 @@ Object {
       "fileContent": Object {
         "files": Array [
           Object {
+            "blockMapSize": "@blockMapSize",
             "sha512": "@sha512",
+            "size": "@size",
             "url": "Test App ßW_1.1.0_mac.zip",
           },
         ],
@@ -204,6 +225,11 @@ Object {
       "arch": "x64",
       "file": "Test App ßW_1.1.0_mac.zip",
       "safeArtifactName": "TestApp-1.1.0-mac.zip",
+      "updateInfo": Object {
+        "blockMapSize": "@blockMapSize",
+        "sha512": "@sha512",
+        "size": "@size",
+      },
     },
   ],
 }
@@ -244,7 +270,9 @@ Object {
       "fileContent": Object {
         "files": Array [
           Object {
+            "blockMapSize": "@blockMapSize",
             "sha512": "@sha512",
+            "size": "@size",
             "url": "Test App ßW-1.1.0-mac.zip",
           },
         ],
@@ -258,6 +286,11 @@ Object {
       "arch": "x64",
       "file": "Test App ßW-1.1.0-mac.zip",
       "safeArtifactName": "TestApp-1.1.0-mac.zip",
+      "updateInfo": Object {
+        "blockMapSize": "@blockMapSize",
+        "sha512": "@sha512",
+        "size": "@size",
+      },
     },
   ],
 }