fix(linux): AppImage doesn't update when filename contains spaces (#8802

)

.changeset/beige-pillows-relate.md

@@ -0,0 +1,5 @@
+---
+"electron-updater": patch
+---
+
+fix(linux): AppImage update fails when filename contains spaces

packages/electron-updater/src/AppImageUpdater.ts

@@ -86,16 +86,21 @@ export class AppImageUpdater extends BaseUpdater {
 
     let destination: string
     const existingBaseName = path.basename(appImageFile)
+    const installerPath = this.installerPath
+    if (installerPath == null) {
+      this.dispatchError(new Error("No valid update available, can't quit and install"))
+      return false
+    }
     // https://github.com/electron-userland/electron-builder/issues/2964
     // if no version in existing file name, it means that user wants to preserve current custom name
-    if (path.basename(options.installerPath) === existingBaseName || !/\d+\.\d+\.\d+/.test(existingBaseName)) {
+    if (path.basename(installerPath) === existingBaseName || !/\d+\.\d+\.\d+/.test(existingBaseName)) {
       // no version in the file name, overwrite existing
       destination = appImageFile
     } else {
-      destination = path.join(path.dirname(appImageFile), path.basename(options.installerPath))
+      destination = path.join(path.dirname(appImageFile), path.basename(installerPath))
     }
 
-    execFileSync("mv", ["-f", options.installerPath, destination])
+    execFileSync("mv", ["-f", installerPath, destination])
     if (destination !== appImageFile) {
       this.emit("appimage-filename-updated", destination)
     }

packages/electron-updater/src/BaseUpdater.ts

@@ -37,6 +37,10 @@ export abstract class BaseUpdater extends AppUpdater {
     })
   }
 
+  protected get installerPath(): string | null {
+    return this.downloadedUpdateHelper == null ? null : this.downloadedUpdateHelper.file
+  }
+
   // must be sync
   protected abstract doInstall(options: InstallOptions): boolean
 
@@ -48,17 +52,7 @@ export abstract class BaseUpdater extends AppUpdater {
     }
 
     const downloadedUpdateHelper = this.downloadedUpdateHelper
-
-    // Get the installer path, ensuring spaces are escaped on Linux
-    // 1. Check if downloadedUpdateHelper is not null
-    // 2. Check if downloadedUpdateHelper.file is not null
-    // 3. If both checks pass:
-    //    a. If the platform is Linux, replace spaces with '\ ' for shell compatibility
-    //    b. If the platform is not Linux, use the original path
-    // 4. If any check fails, set installerPath to null
-    const installerPath =
-      downloadedUpdateHelper && downloadedUpdateHelper.file ? (process.platform === "linux" ? downloadedUpdateHelper.file.replace(/ /g, "\\ ") : downloadedUpdateHelper.file) : null
-
+    const installerPath = this.installerPath
     const downloadedFileInfo = downloadedUpdateHelper == null ? null : downloadedUpdateHelper.downloadedFileInfo
     if (installerPath == null || downloadedFileInfo == null) {
       this.dispatchError(new Error("No valid update available, can't quit and install"))
@@ -71,7 +65,6 @@ export abstract class BaseUpdater extends AppUpdater {
     try {
       this._logger.info(`Install: isSilent: ${isSilent}, isForceRunAfter: ${isForceRunAfter}`)
       return this.doInstall({
-        installerPath,
         isSilent,
         isForceRunAfter,
         isAdminRightsRequired: downloadedFileInfo.isAdminRightsRequired,
@@ -164,7 +157,6 @@ export abstract class BaseUpdater extends AppUpdater {
 }
 
 export interface InstallOptions {
-  readonly installerPath: string
   readonly isSilent: boolean
   readonly isForceRunAfter: boolean
   readonly isAdminRightsRequired: boolean

packages/electron-updater/src/DebUpdater.ts

@@ -27,11 +27,20 @@ export class DebUpdater extends BaseUpdater {
     })
   }
 
+  protected get installerPath(): string | null {
+    return super.installerPath?.replace(/ /g, "\\ ") ?? null
+  }
+
   protected doInstall(options: InstallOptions): boolean {
     const sudo = this.wrapSudo()
     // pkexec doesn't want the command to be wrapped in " quotes
     const wrapper = /pkexec/i.test(sudo) ? "" : `"`
-    const cmd = ["dpkg", "-i", options.installerPath, "||", "apt-get", "install", "-f", "-y"]
+    const installerPath = this.installerPath
+    if (installerPath == null) {
+      this.dispatchError(new Error("No valid update available, can't quit and install"))
+      return false
+    }
+    const cmd = ["dpkg", "-i", installerPath, "||", "apt-get", "install", "-f", "-y"]
     this.spawnSyncLog(sudo, [`${wrapper}/bin/bash`, "-c", `'${cmd.join(" ")}'${wrapper}`])
     if (options.isForceRunAfter) {
       this.app.relaunch()

packages/electron-updater/src/NsisUpdater.ts

@@ -123,6 +123,12 @@ export class NsisUpdater extends BaseUpdater {
   }
 
   protected doInstall(options: InstallOptions): boolean {
+    const installerPath = this.installerPath
+    if (installerPath == null) {
+      this.dispatchError(new Error("No valid update available, can't quit and install"))
+      return false
+    }
+
     const args = ["--updated"]
     if (options.isSilent) {
       args.push("/S")
@@ -144,7 +150,7 @@ export class NsisUpdater extends BaseUpdater {
     }
 
     const callUsingElevation = (): void => {
-      this.spawnLog(path.join(process.resourcesPath, "elevate.exe"), [options.installerPath].concat(args)).catch(e => this.dispatchError(e))
+      this.spawnLog(path.join(process.resourcesPath, "elevate.exe"), [installerPath].concat(args)).catch(e => this.dispatchError(e))
     }
 
     if (options.isAdminRightsRequired) {
@@ -153,7 +159,7 @@ export class NsisUpdater extends BaseUpdater {
       return true
     }
 
-    this.spawnLog(options.installerPath, args).catch((e: Error) => {
+    this.spawnLog(installerPath, args).catch((e: Error) => {
       // https://github.com/electron-userland/electron-builder/issues/1129
       // Node 8 sends errors: https://nodejs.org/dist/latest-v8.x/docs/api/errors.html#errors_common_system_errors
       const errorCode = (e as NodeJS.ErrnoException).code
@@ -164,7 +170,7 @@ export class NsisUpdater extends BaseUpdater {
         callUsingElevation()
       } else if (errorCode === "ENOENT") {
         require("electron")
-          .shell.openPath(options.installerPath)
+          .shell.openPath(installerPath)
           .catch((err: Error) => this.dispatchError(err))
       } else {
         this.dispatchError(e)

packages/electron-updater/src/PacmanUpdater.ts

@@ -27,11 +27,20 @@ export class PacmanUpdater extends BaseUpdater {
     })
   }
 
+  protected get installerPath(): string | null {
+    return super.installerPath?.replace(/ /g, "\\ ") ?? null
+  }
+
   protected doInstall(options: InstallOptions): boolean {
     const sudo = this.wrapSudo()
     // pkexec doesn't want the command to be wrapped in " quotes
     const wrapper = /pkexec/i.test(sudo) ? "" : `"`
-    const cmd = ["pacman", "-U", "--noconfirm", options.installerPath]
+    const installerPath = this.installerPath
+    if (installerPath == null) {
+      this.dispatchError(new Error("No valid update available, can't quit and install"))
+      return false
+    }
+    const cmd = ["pacman", "-U", "--noconfirm", installerPath]
     this.spawnSyncLog(sudo, [`${wrapper}/bin/bash`, "-c", `'${cmd.join(" ")}'${wrapper}`])
     if (options.isForceRunAfter) {
       this.app.relaunch()

packages/electron-updater/src/RpmUpdater.ts

@@ -27,18 +27,26 @@ export class RpmUpdater extends BaseUpdater {
     })
   }
 
+  protected get installerPath(): string | null {
+    return super.installerPath?.replace(/ /g, "\\ ") ?? null
+  }
+
   protected doInstall(options: InstallOptions): boolean {
-    const upgradePath = options.installerPath
     const sudo = this.wrapSudo()
     // pkexec doesn't want the command to be wrapped in " quotes
     const wrapper = /pkexec/i.test(sudo) ? "" : `"`
     const packageManager = this.spawnSyncLog("which zypper")
+    const installerPath = this.installerPath
+    if (installerPath == null) {
+      this.dispatchError(new Error("No valid update available, can't quit and install"))
+      return false
+    }
     let cmd: string[]
     if (!packageManager) {
       const packageManager = this.spawnSyncLog("which dnf || which yum")
-      cmd = [packageManager, "-y", "install", upgradePath]
+      cmd = [packageManager, "-y", "install", installerPath]
     } else {
-      cmd = [packageManager, "--no-refresh", "install", "--allow-unsigned-rpm", "-y", "-f", upgradePath]
+      cmd = [packageManager, "--no-refresh", "install", "--allow-unsigned-rpm", "-y", "-f", installerPath]
     }
     this.spawnSyncLog(sudo, [`${wrapper}/bin/bash`, "-c", `'${cmd.join(" ")}'${wrapper}`])
     if (options.isForceRunAfter) {