Merge remote-tracking branch 'origin/master' into explore/vitest-rollup-2

# Conflicts:
#	packages/electron-updater/src/AppUpdater.ts
#	packages/electron-updater/src/NsisUpdater.ts
#	packages/electron-updater/src/main.ts

Author: mmaietta

.changeset/fuzzy-trains-grab.md

@@ -0,0 +1,5 @@
+---
+"electron-updater": minor
+---
+
+feat: add `isUpdateAvailable` property to `checkForUpdates` result

.changeset/smart-starfishes-invent.md

@@ -0,0 +1,5 @@
+---
+"electron-updater": minor
+---
+
+feat: add support for custom `isUpdateSupported` hook for validating `UpdateInfo`, with fallback to previous `minimumSystemVersion` logic

.changeset/weak-owls-obey.md

@@ -0,0 +1,5 @@
+---
+"app-builder-lib": patch
+---
+
+fix: handle yarn berry patch format in electron-updater version check

packages/app-builder-lib/src/util/packageMetadata.ts

@@ -98,12 +98,23 @@ function checkDependencies(dependencies: Record<string, string> | Nullish, error
     return
   }
 
-  const updaterVersion = dependencies["electron-updater"]
-  const requiredElectronUpdaterVersion = "4.0.0"
-  if (updaterVersion != null && !versionSatisfies(updaterVersion, `>=${requiredElectronUpdaterVersion}`)) {
-    errors.push(
-      `At least electron-updater ${requiredElectronUpdaterVersion} is recommended by current electron-builder version. Please set electron-updater version to "^${requiredElectronUpdaterVersion}"`
-    )
+  let updaterVersion = dependencies["electron-updater"]
+  if (updaterVersion != null) {
+    // Pick the version out of yarn berry patch syntax
+    // "patch:electron-updater@npm%3A6.4.1#~/.yarn/patches/electron-updater-npm-6.4.1-ef33e6cc39.patch"
+    if (updaterVersion.startsWith('patch:')) {
+      const match = updaterVersion.match(/@npm%3A(.+?)#/)
+      if (match) {
+        updaterVersion = match[1]
+      }
+    }
+
+    const requiredElectronUpdaterVersion = "4.0.0"
+    if (!versionSatisfies(updaterVersion, `>=${requiredElectronUpdaterVersion}`)) {
+      errors.push(
+        `At least electron-updater ${requiredElectronUpdaterVersion} is recommended by current electron-builder version. Please set electron-updater version to "^${requiredElectronUpdaterVersion}"`
+      )
+    }
   }
 
   const swVersion = dependencies["electron-builder-squirrel-windows"]

packages/electron-updater/src/AppUpdater.ts

@@ -36,6 +36,7 @@ import { blockmapFiles } from "./util"
 import { DifferentialDownloaderOptions } from "./differentialDownloader/DifferentialDownloader"
 import { GenericDifferentialDownloader } from "./differentialDownloader/GenericDifferentialDownloader"
 import { DOWNLOAD_PROGRESS, Logger, ResolvedUpdateFileInfo, UPDATE_DOWNLOADED, UpdateCheckResult, UpdateDownloadedEvent, UpdaterSignal } from "./exports"
+import { VerifyUpdateSupport } from "./main"
 
 export type AppUpdaterEvents = {
   error: (error: Error, message?: string) => void
@@ -203,6 +204,22 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
     this.configOnDisk = new Lazy<any>(() => this.loadUpdateConfig())
   }
 
+  protected _isUpdateSupported: VerifyUpdateSupport = (updateInfo: UpdateInfo): boolean | Promise<boolean> => this.checkIfUpdateSupported(updateInfo)
+
+  /**
+   * Allows developer to override default logic for determining if an update is supported.
+   * The default logic compares the `UpdateInfo` minimum system version against the `os.release()` with `semver` package
+   */
+  get isUpdateSupported(): VerifyUpdateSupport {
+    return this._isUpdateSupported
+  }
+
+  set isUpdateSupported(value: VerifyUpdateSupport) {
+    if (value) {
+      this._isUpdateSupported = value
+    }
+  }
+
   private clientPromise: Promise<Provider<any>> | null = null
 
   protected readonly stagingUserIdPromise = new Lazy<string>(() => this.getOrCreateStagingUserId())
@@ -279,6 +296,7 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
 
   /**
    * Asks the server whether there is an update.
+   * @returns null if the updater is disabled, otherwise info about the latest version
    */
   checkForUpdates(): Promise<UpdateCheckResult | null> {
     if (!this.isUpdaterActive()) {
@@ -395,17 +413,8 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
       return false
     }
 
-    const minimumSystemVersion = updateInfo?.minimumSystemVersion
-    const currentOSVersion = release()
-    if (minimumSystemVersion) {
-      try {
-        if (isVersionLessThan(currentOSVersion, minimumSystemVersion)) {
-          this._logger.info(`Current OS version ${currentOSVersion} is less than the minimum OS version required ${minimumSystemVersion} for version ${currentOSVersion}`)
-          return false
-        }
-      } catch (e: any) {
-        this._logger.warn(`Failed to compare current OS version(${currentOSVersion}) with minimum OS version(${minimumSystemVersion}): ${(e.message || e).toString()}`)
-      }
+    if (!(await Promise.resolve(this.isUpdateSupported(updateInfo)))) {
+      return false
     }
 
     const isStagingMatch = await this.isStagingMatch(updateInfo)
@@ -424,6 +433,22 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
     return this.allowDowngrade && isLatestVersionOlder
   }
 
+  private checkIfUpdateSupported(updateInfo: UpdateInfo) {
+    const minimumSystemVersion = updateInfo?.minimumSystemVersion
+    const currentOSVersion = release()
+    if (minimumSystemVersion) {
+      try {
+        if (isVersionLessThan(currentOSVersion, minimumSystemVersion)) {
+          this._logger.info(`Current OS version ${currentOSVersion} is less than the minimum OS version required ${minimumSystemVersion} for version ${currentOSVersion}`)
+          return false
+        }
+      } catch (e: any) {
+        this._logger.warn(`Failed to compare current OS version(${currentOSVersion}) with minimum OS version(${minimumSystemVersion}): ${(e.message || e).toString()}`)
+      }
+    }
+    return true
+  }
+
   protected async getUpdateInfoAndProvider(): Promise<UpdateInfoAndProvider> {
     await this.app.whenReady()
 
@@ -461,6 +486,7 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
       )
       this.emit("update-not-available", updateInfo)
       return {
+        isUpdateAvailable: false,
         versionInfo: updateInfo,
         updateInfo,
       }
@@ -472,6 +498,7 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
     const cancellationToken = new CancellationToken()
     //noinspection ES6MissingAwait
     return {
+      isUpdateAvailable: true,
       versionInfo: updateInfo,
       updateInfo,
       cancellationToken,

packages/electron-updater/src/NsisUpdater.ts

@@ -5,8 +5,8 @@ import { DownloadUpdateOptions } from "./AppUpdater"
 import { BaseUpdater, InstallOptions } from "./BaseUpdater"
 import { DifferentialDownloaderOptions } from "./differentialDownloader/DifferentialDownloader"
 import { FileWithEmbeddedBlockMapDifferentialDownloader } from "./differentialDownloader/FileWithEmbeddedBlockMapDifferentialDownloader"
-import { verifyUpdateCodeSignature } from "./main"
 import { DOWNLOAD_PROGRESS } from "./exports"
+import { VerifyUpdateCodeSignature } from "./main"
 import { findFile, Provider } from "./providers/Provider"
 import { unlink } from "fs-extra"
 import { verifySignature } from "./windowsExecutableCodeSignatureVerifier"
@@ -23,18 +23,18 @@ export class NsisUpdater extends BaseUpdater {
     super(options, app)
   }
 
-  protected _verifyUpdateCodeSignature: verifyUpdateCodeSignature = (publisherNames: Array<string>, unescapedTempUpdateFile: string) =>
+  protected _verifyUpdateCodeSignature: VerifyUpdateCodeSignature = (publisherNames: Array<string>, unescapedTempUpdateFile: string) =>
     verifySignature(publisherNames, unescapedTempUpdateFile, this._logger)
 
   /**
    * The verifyUpdateCodeSignature. You can pass [win-verify-signature](https://github.com/beyondkmp/win-verify-trust) or another custom verify function: ` (publisherName: string[], path: string) => Promise<string | null>`.
    * The default verify function uses [windowsExecutableCodeSignatureVerifier](https://github.com/electron-userland/electron-builder/blob/master/packages/electron-updater/src/windowsExecutableCodeSignatureVerifier.ts)
    */
-  get verifyUpdateCodeSignature(): verifyUpdateCodeSignature {
+  get verifyUpdateCodeSignature(): VerifyUpdateCodeSignature {
     return this._verifyUpdateCodeSignature
   }
 
-  set verifyUpdateCodeSignature(value: verifyUpdateCodeSignature) {
+  set verifyUpdateCodeSignature(value: VerifyUpdateCodeSignature) {
     if (value) {
       this._verifyUpdateCodeSignature = value
     }

packages/electron-updater/src/exports.ts

@@ -53,6 +53,8 @@ export function addHandler(emitter: EventEmitter, event: UpdaterEvents, handler:
 }
 
 export interface UpdateCheckResult {
+  readonly isUpdateAvailable: boolean
+
   readonly updateInfo: UpdateInfo
 
   readonly downloadPromise?: Promise<Array<string>> | null

packages/electron-updater/src/main.ts

@@ -1,6 +1,7 @@
 import { existsSync, readFileSync } from "fs-extra"
 import * as path from "path"
 import { AppUpdater } from "./AppUpdater"
+import { UpdateInfo } from "builder-util-runtime"
 
 export { BaseUpdater } from "./BaseUpdater"
 export { AppUpdater, NoOpLogger } from "./AppUpdater"
@@ -66,6 +67,10 @@ Object.defineProperty(exports, "autoUpdater", {
   },
 })
 
-// return null if verify signature succeed
-// return error message if verify signature failed
-export type verifyUpdateCodeSignature = (publisherName: string[], path: string) => Promise<string | null>
+/**
+ * return null if verify signature succeed
+ * return error message if verify signature failed
+ */
+export type VerifyUpdateCodeSignature = (publisherName: string[], path: string) => Promise<string | null>
+
+export type VerifyUpdateSupport = (updateInfo: UpdateInfo) => boolean | Promise<boolean>