chore(snap): migrate snap generation from app-builder-bin to JS

.changeset/empty-files-itch.md

@@ -0,0 +1,7 @@
+---
+"app-builder-lib": patch
+"builder-util": patch
+"electron-publish": patch
+---
+
+chore(snap): migrate snap generation from app-builder-bin to JS

.github/workflows/test.yaml

@@ -72,7 +72,7 @@ jobs:
       matrix:
         testFiles:
           - ArtifactPublisherTest,BuildTest,ExtraBuildTest,RepoSlugTest,binDownloadTest,configurationValidationTest,filenameUtilTest,filesTest,globTest,ignoreTest,macroExpanderTest,mainEntryTest,urlUtilTest,extraMetadataTest,linuxArchiveTest,linuxPackagerTest,HoistedNodeModuleTest,MemoLazyTest,HoistTest
-          - snapTest,debTest,fpmTest,protonTest
+          - debTest,fpmTest,protonTest
           - winPackagerTest,winCodeSignTest,webInstallerTest
           - oneClickInstallerTest,assistedInstallerTest
     steps:
@@ -219,3 +219,28 @@ jobs:
         env:
           TEST_FILES: ${{ matrix.testFiles }}
           FORCE_COLOR: 1
+
+  test-snap:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 20
+    steps:
+      - name: Checkout code repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+
+      - name: Setup Tests
+        uses: ./.github/actions/pretest
+        with:
+          cache-path: ~/.cache/electron
+          cache-key: v-23.3.10-snap-electron
+
+      - name: Install snapcraft
+        run: |
+          sudo apt-get update -yq
+          sudo apt-get install snapcraft
+
+      - name: Test
+        run: |
+          pnpm ci:test
+        env:
+          TEST_FILES: snapTest
+          FORCE_COLOR: 1

packages/app-builder-lib/package.json

@@ -8,6 +8,7 @@
     "templates",
     "scheme.json",
     "certs/root_certs.keychain"
+
   ],
   "repository": {
     "type": "git",

packages/app-builder-lib/src/binDownload.ts

@@ -16,7 +16,7 @@ export function getBinFromCustomLoc(name: string, version: string, binariesLocUr
   return getBin(dirName, binariesLocUrl, checksum)
 }
 
-export function getBinFromUrl(name: string, version: string, checksum: string): Promise<string> {
+export function getBinFromUrl(name: string, version: string, checksum: string, fileName = `${name}-${version}`): Promise<string> {
   const dirName = `${name}-${version}`
   let url: string
   if (process.env.ELECTRON_BUILDER_BINARIES_DOWNLOAD_OVERRIDE_URL) {
@@ -34,7 +34,7 @@ export function getBinFromUrl(name: string, version: string, checksum: string):
       process.env.npm_package_config_electron_builder_binaries_custom_dir ||
       process.env.ELECTRON_BUILDER_BINARIES_CUSTOM_DIR ||
       dirName
-    const urlSuffix = dirName + ".7z"
+    const urlSuffix = fileName + ".7z"
     url = `${baseUrl}${middleUrl}/${urlSuffix}`
   }
 

packages/app-builder-lib/src/linuxPackager.ts

@@ -8,7 +8,7 @@ import AppImageTarget from "./targets/AppImageTarget"
 import FlatpakTarget from "./targets/FlatpakTarget"
 import FpmTarget from "./targets/FpmTarget"
 import { LinuxTargetHelper } from "./targets/LinuxTargetHelper"
-import SnapTarget from "./targets/snap"
+import SnapTarget from "./targets/snap/snap"
 import { createCommonTarget } from "./targets/targetFactory"
 
 export class LinuxPackager extends PlatformPackager<LinuxConfiguration> {
@@ -44,7 +44,7 @@ export class LinuxPackager extends PlatformPackager<LinuxConfiguration> {
           case "appimage":
             return require("./targets/AppImageTarget").default
           case "snap":
-            return require("./targets/snap").default
+            return require("./targets/snap/snap").default
           case "flatpak":
             return require("./targets/FlatpakTarget").default
           case "deb":

packages/app-builder-lib/src/targets/snap/linuxTools.ts

@@ -0,0 +1,36 @@
+import { isEmptyOrSpaces } from "builder-util"
+import { getBinFromUrl } from "../../binDownload"
+import * as os from "os"
+import * as path from "path"
+import { Lazy } from "lazy-val"
+
+const appImageToolDir = new Lazy<string>(() => getBinFromUrl("appimage", "12.0.1", "3el6RUh6XoYJCI/ZOApyb0LLU/gSxDntVZ46R6+JNEANzfSo7/TfrzCRp5KlDo35c24r3ZOP7nnw4RqHwkMRLw=="))
+
+function getAppImageToolBin(toolDir: string): string {
+  return process.platform === "darwin" ? path.join(toolDir, "darwin") : path.join(toolDir, `linux-${goArchToArchSuffix()}`)
+}
+
+function goArchToArchSuffix(): string {
+  const arch = os.arch()
+  switch (arch) {
+    case "arm":
+      return "arm32"
+    default:
+      return arch
+  }
+}
+
+async function getLinuxTool(name: string): Promise<string> {
+  const toolDir = await appImageToolDir.value
+  return path.join(getAppImageToolBin(toolDir), name)
+}
+
+export async function getMksquashfs(): Promise<string> {
+  if (process.env.USE_SYSTEM_MKSQUASHFS) {
+    return "mksquashfs"
+  }
+  if (!isEmptyOrSpaces(process.env.MKSQUASHFS_PATH)) {
+    return process.env.MKSQUASHFS_PATH
+  }
+  return getLinuxTool("mksquashfs")
+}

packages/app-builder-lib/src/targets/snap.ts → packages/app-builder-lib/src/targets/snap/snap.ts

@@ -1,16 +1,17 @@
-import { replaceDefault as _replaceDefault, Arch, deepAssign, executeAppBuilder, InvalidConfigurationError, log, serializeToYaml, toLinuxArchString } from "builder-util"
+import { replaceDefault as _replaceDefault, Arch, deepAssign, InvalidConfigurationError, log, serializeToYaml, toLinuxArchString } from "builder-util"
 import { asArray, Nullish, SnapStoreOptions } from "builder-util-runtime"
 import { outputFile, readFile } from "fs-extra"
 import { load } from "js-yaml"
 import * as path from "path"
 import * as semver from "semver"
-import { Configuration } from "../configuration"
-import { Publish, Target } from "../core"
-import { LinuxPackager } from "../linuxPackager"
-import { PlugDescriptor, SnapOptions } from "../options/SnapOptions"
-import { getTemplatePath } from "../util/pathManager"
-import { LinuxTargetHelper } from "./LinuxTargetHelper"
-import { createStageDirPath } from "./targetUtil"
+import { Configuration } from "../../configuration"
+import { Publish, Target } from "../../core"
+import { LinuxPackager } from "../../linuxPackager"
+import { PlugDescriptor, SnapOptions } from "../../options/SnapOptions"
+import { getTemplatePath } from "../../util/pathManager"
+import { LinuxTargetHelper } from "../LinuxTargetHelper"
+import { createStageDirPath } from "../targetUtil"
+import { SnapBuilderOptions, createSnap } from "./snapBuilder"
 
 const defaultPlugs = ["desktop", "desktop-legacy", "home", "x11", "wayland", "unity7", "browser-support", "network", "gsettings", "audio-playback", "pulseaudio", "opengl"]
 
@@ -190,14 +191,20 @@ export default class SnapTarget extends Target {
 
     const stageDir = await createStageDirPath(this, packager, arch)
     const snapArch = toLinuxArchString(arch, "snap")
-    const args = ["snap", "--app", appOutDir, "--stage", stageDir, "--arch", snapArch, "--output", artifactPath, "--executable", this.packager.executableName]
+    const args: SnapBuilderOptions = {
+      appDir: appOutDir,
+      stageDir: stageDir,
+      arch: snapArch,
+      output: artifactPath,
+      executableName: this.packager.executableName,
+    }
 
     await this.helper.icons
     if (this.helper.maxIconPath != null) {
       if (!this.isUseTemplateApp) {
         snap.icon = "snap/gui/icon.png"
       }
-      args.push("--icon", this.helper.maxIconPath)
+      args.icon = this.helper.maxIconPath
     }
 
     // snapcraft.yaml inside a snap directory
@@ -215,15 +222,15 @@ export default class SnapTarget extends Target {
         extraAppArgs.push(noSandboxArg)
       }
       if (this.isUseTemplateApp) {
-        args.push("--exclude", "chrome-sandbox")
+        args.excludedAppFiles = ["chrome-sandbox"]
       }
     }
     if (extraAppArgs.length > 0) {
-      args.push("--extraAppArgs=" + extraAppArgs.join(" "))
+      args.extraAppArgs = extraAppArgs
     }
 
     if (snap.compression != null) {
-      args.push("--compression", snap.compression)
+      args.compression = snap.compression
     }
 
     if (this.isUseTemplateApp) {
@@ -234,22 +241,28 @@ export default class SnapTarget extends Target {
       }
     }
 
-    if (packager.packagerOptions.effectiveOptionComputed != null && (await packager.packagerOptions.effectiveOptionComputed({ snap, desktopFile, args }))) {
+    if (this.isUseTemplateApp) {
+      args.template = { templateUrl: `electron4:${snapArch}` }
+    }
+
+    // snapshot tests verify `args`, but we need to extract the dynamic/temp paths from the object first
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { appDir, icon, output, stageDir: _stageDir, ...argsForSnapshotTests } = args
+    if (
+      packager.packagerOptions.effectiveOptionComputed != null &&
+      (await packager.packagerOptions.effectiveOptionComputed({ snap, desktopFile, args: { argsForSnapshotTests, isUseTemplateApp: this.isUseTemplateApp } }))
+    ) {
       return
     }
 
     await outputFile(path.join(snapMetaDir, this.isUseTemplateApp ? "snap.yaml" : "snapcraft.yaml"), serializeToYaml(snap))
 
     const hooksDir = await packager.getResource(options.hooks, "snap-hooks")
     if (hooksDir != null) {
-      args.push("--hooks", hooksDir)
-    }
-
-    if (this.isUseTemplateApp) {
-      args.push("--template-url", `electron4:${snapArch}`)
+      args.hooksDir = hooksDir
     }
 
-    await executeAppBuilder(args)
+    await createSnap(args)
 
     const publishConfig = findSnapPublishConfig(this.packager.config)