🏡 index : quine-global-boneyard/electron-builder.git

import { Platform } from "app-builder-lib"
import { readAsar } from "app-builder-lib/out/asar/asar"
import { outputFile } from "fs-extra"
import * as fs from "fs/promises"
import * as path from "path"
import { assertThat } from "./helpers/fileAssert"
import { app, appThrows, assertPack, linuxDirTarget, modifyPackageJson, PackedContext, removeUnstableProperties, verifyAsarFileTree } from "./helpers/packTester"
import { verifySmartUnpack } from "./helpers/verifySmartUnpack"
import { spawnSync } from "child_process"
import { ExpectStatic } from "vitest"
import { spawn } from "builder-util/out/util"

async function createFiles(appDir: string) {
  await Promise.all([
    outputFile(path.join(appDir, "assets", "file1"), "data"),
    outputFile(path.join(appDir, "assets", "file2"), "data"),
    outputFile(path.join(appDir, "assets", "subdir", "file3"), "data"),
    outputFile(path.join(appDir, "b2", "file"), "data"),
    outputFile(path.join(appDir, "do-not-unpack-dir", "file.json"), "{}").then(() => fs.writeFile(path.join(appDir, "do-not-unpack-dir", "must-be-not-unpacked"), "{}")),
  ])

  const dir = path.join(appDir, "do-not-unpack-dir", "dir-2", "dir-3", "dir-3")
  await fs.mkdir(dir, { recursive: true })
  await fs.writeFile(path.join(dir, "file-in-asar"), "{}")

  await fs.symlink(path.join(appDir, "assets", "file1"), path.join(appDir, "assets", "subdir", "file-symlink1")) // "reverse" symlink up one directory
  await fs.symlink(path.join(appDir, "assets", "file2"), path.join(appDir, "assets", "file-symlink2")) // same dir symlink
  await fs.symlink(path.join(appDir, "assets", "subdir", "file3"), path.join(appDir, "file-symlink3")) // symlink down
}

test.ifNotWindows.ifDevOrLinuxCi("unpackDir one", ({ expect }) =>
  app(
    expect,
    {
      targets: linuxDirTarget,
      config: {
        asarUnpack: ["assets", "b2", "do-not-unpack-dir/file.json"],
      },
    },
    {
      projectDirCreated: createFiles,
      packed: context => assertDirs(expect, context),
    }
  )
)

async function assertDirs(expect: ExpectStatic, context: PackedContext) {
  const resourceDir = context.getResources(Platform.LINUX)
  await Promise.all([
    assertThat(expect, path.join(resourceDir, "app.asar.unpacked", "assets")).isDirectory(),
    assertThat(expect, path.join(resourceDir, "app.asar.unpacked", "b2")).isDirectory(),
    assertThat(expect, path.join(resourceDir, "app.asar.unpacked", "do-not-unpack-dir", "file.json")).isFile(),
    assertThat(expect, path.join(resourceDir, "app.asar.unpacked", "do-not-unpack-dir", "must-be-not-unpacked")).doesNotExist(),
    assertThat(expect, path.join(resourceDir, "app.asar.unpacked", "do-not-unpack-dir", "dir-2")).doesNotExist(),
  ])

  await verifyAsarFileTree(expect, resourceDir)
}

test.ifNotWindows.ifDevOrLinuxCi("unpackDir", ({ expect }) => {
  return assertPack(
    expect,
    "test-app",
    {
      targets: linuxDirTarget,
      config: {
        asarUnpack: ["assets", "b2", "do-not-unpack-dir/file.json"],
      },
    },
    {
      projectDirCreated: projectDir => createFiles(path.join(projectDir, "app")),
      packed: context => assertDirs(expect, context),
    }
  )
})

test.ifDevOrLinuxCi("asarUnpack and files ignore", ({ expect }) => {
  return assertPack(
    expect,
    "test-app",
    {
      targets: linuxDirTarget,
      config: {
        asarUnpack: ["!**/ffprobe-static/bin/darwin/x64/ffprobe"],
      },
    },
    {
      projectDirCreated: projectDir => outputFile(path.join(projectDir, "node_modules/ffprobe-static/bin/darwin/x64/ffprobe"), "data"),
      packed: async context => {
        const resourceDir = context.getResources(Platform.LINUX)
        await Promise.all([assertThat(expect, path.join(resourceDir, "app.asar.unpacked", "node_modules/ffprobe-static/bin/darwin/x64/ffprobe")).doesNotExist()])

        await verifyAsarFileTree(expect, resourceDir)
      },
    }
  )
})

test.ifNotWindows("link", ({ expect }) =>
  app(
    expect,
    {
      targets: linuxDirTarget,
    },
    {
      projectDirCreated: projectDir => {
        return fs.symlink(path.join(projectDir, "index.js"), path.join(projectDir, "foo.js"))
      },
      packed: async context => {
        const resources = context.getResources(Platform.LINUX)
        expect((await readAsar(path.join(resources, "app.asar"))).getFile("foo.js", false)).toMatchSnapshot()
        await verifyAsarFileTree(expect, resources)
      },
    }
  )
)

test.ifNotWindows("outside link", ({ expect }) =>
  appThrows(
    expect,
    {
      targets: linuxDirTarget,
    },
    {
      projectDirCreated: async (projectDir, tmpDir) => {
        const tempDir = await tmpDir.getTempDir()
        await outputFile(path.join(tempDir, "foo"), "data")
        await fs.symlink(tempDir, path.join(projectDir, "o-dir"))
      },
    },
    error => expect(error.message).toContain("violates asar security integrity")
  )
)
describe("isInstallDepsBefore=true", { sequential: true }, () => {
  test.ifNotWindows("symlinks everywhere with static framework", ({ expect }) =>
    assertPack(
      expect,
      "test-app-symlink-framework",
      {
        targets: linuxDirTarget,
        config: {
          files: ["!hello-world"],
        },
      },
      {
        isInstallDepsBefore: true,
        projectDirCreated: async projectDir => {
          await modifyPackageJson(projectDir, data => {
            data.dependencies = {
              debug: "4.1.1",
              ...data.dependencies,
            }
          })
          return fs.symlink(path.join(projectDir, "index.js"), path.join(projectDir, "foo.js"))
        },
        packed: async context => {
          const resources = context.getResources(Platform.LINUX)
          expect((await readAsar(path.join(resources, "app.asar"))).getFile("foo.js", false)).toMatchSnapshot()
          await verifySmartUnpack(expect, resources)
        },
      }
    )
  )

  test.ifDevOrLinuxCi("local node module with file protocol", ({ expect }) => {
    return assertPack(
      expect,
      "test-app-one",
      {
        targets: linuxDirTarget,
        config: {
          asarUnpack: ["**/node_modules/foo/**/*"],
        },
      },
      {
        projectDirCreated: async (projectDir, tmpDir) => {
          const tempDir = await tmpDir.getTempDir()
          const localPath = path.join(tempDir, "foo")
          await outputFile(path.join(localPath, "package.json"), `{"name":"foo","version":"9.0.0","main":"index.js","license":"MIT","dependencies":{"ms":"2.0.0"}}`)
          spawnSync("npm", ["install"], { cwd: localPath })
          await modifyPackageJson(projectDir, data => {
            data.dependencies = {
              foo: `file:${localPath}`,
            }
          })

          // we can't use `isInstallDepsBefore` as `localPath` is dynamic and changes for every which causes `--frozen-lockfile` and `npm ci` to fail
          await spawn("npm", ["install"], {
            cwd: projectDir,
          })
        },
        packed: async context => {
          await assertThat(expect, path.join(path.join(context.getResources(Platform.LINUX), "app.asar.unpacked", "node_modules", "foo", "package.json"))).isFile()
        },
      }
    )
  })

  // cannot be enabled
  // https://github.com/electron-userland/electron-builder/issues/611
  test.ifDevOrLinuxCi("failed peer dep", ({ expect }) => {
    return assertPack(
      expect,
      "test-app-one",
      {
        targets: linuxDirTarget,
      },
      {
        isInstallDepsBefore: true,
        projectDirCreated: projectDir => {
          return Promise.all([
            modifyPackageJson(projectDir, data => {
              //noinspection SpellCheckingInspection
              data.dependencies = {
                debug: "4.1.1",
                "rc-datepicker": "4.0.0",
                react: "15.2.1",
                "react-dom": "15.2.1",
              }
            }),
            outputFile(path.join(projectDir, "yarn.lock"), ""),
          ])
        },
        packed: context => {
          return verifySmartUnpack(expect, context.getResources(Platform.LINUX))
        },
      }
    )
  })

  test.ifDevOrLinuxCi("ignore node_modules", ({ expect }) => {
    return assertPack(
      expect,
      "test-app-one",
      {
        targets: linuxDirTarget,
        config: {
          asar: false,
          files: ["!node_modules/**/*"],
        },
      },
      {
        isInstallDepsBefore: true,
        projectDirCreated: projectDir =>
          modifyPackageJson(projectDir, data => {
            //noinspection SpellCheckingInspection
            data.dependencies = {
              "ci-info": "2.0.0",
              // this contains string-width-cjs 4.2.3
              "@isaacs/cliui": "8.0.2",
            }
          }),
        packed: context => {
          return assertThat(expect, path.join(context.getResources(Platform.LINUX), "app", "node_modules")).doesNotExist()
        },
      }
    )
  })

  test.ifDevOrLinuxCi("asarUnpack node_modules", ({ expect }) => {
    return assertPack(
      expect,
      "test-app-one",
      {
        targets: linuxDirTarget,
        config: {
          asarUnpack: "node_modules",
        },
      },
      {
        isInstallDepsBefore: true,
        projectDirCreated: projectDir =>
          modifyPackageJson(projectDir, data => {
            data.dependencies = {
              "ci-info": "2.0.0",
            }
          }),
        packed: async context => {
          const nodeModulesNode = (await readAsar(path.join(context.getResources(Platform.LINUX), "app.asar"))).getNode("node_modules")
          expect(removeUnstableProperties(nodeModulesNode)).toMatchSnapshot()
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/ci-info")).isDirectory()
        },
      }
    )
  })

  test.ifDevOrLinuxCi("asarUnpack node_modules which has many modules", ({ expect }) => {
    return assertPack(
      expect,
      "test-app-one",
      {
        targets: linuxDirTarget,
        config: {
          asarUnpack: "node_modules",
        },
      },
      {
        isInstallDepsBefore: true,
        projectDirCreated: async projectDir => {
          await modifyPackageJson(projectDir, data => {
            data.dependencies = {
              "@react-navigation/stack": "6.3.7",
              "@sentry/electron": "4.4.0",
              axios: "1.1.3",
              "deep-equal": "2.1.0",
              dotenv: "16.4.5",
              "electron-log": "4.4.8",
              "electron-updater": "6.0.4",
              "electron-window-state": "5.0.3",
              "jwt-decode": "3.1.2",
              keytar: "7.9.0",
              webpack: "5.74.0",
              "pubsub-js": "1.9.4",
              react: "18.2.0",
              "react-dom": "18.2.0",
              "react-native-web": "0.18.10",
              "react-router-dom": "6.4.0",
              "source-map-support": "0.5.16",
              yargs: "16.2.0",
              "ci-info": "2.0.0",
            }
          })
          await outputFile(path.join(projectDir, "yarn.lock"), "")
        },
        packed: async context => {
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/jwt-decode")).isDirectory()
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/keytar")).isDirectory()
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/yargs")).isDirectory()
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/@sentry/electron")).isDirectory()
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/ci-info")).isDirectory()
        },
      }
    )
  })

  test.ifDevOrLinuxCi("exclude some modules when asarUnpack node_modules which has many modules", ({ expect }) => {
    return assertPack(
      expect,
      "test-app-one",
      {
        targets: linuxDirTarget,
        config: {
          asarUnpack: ["node_modules", "!**/node_modules/ci-info/**/*"],
        },
      },
      {
        isInstallDepsBefore: true,
        projectDirCreated: async projectDir => {
          await modifyPackageJson(projectDir, data => {
            data.dependencies = {
              "@react-navigation/stack": "6.3.7",
              "@sentry/electron": "4.4.0",
              axios: "1.1.3",
              "deep-equal": "2.1.0",
              dotenv: "16.4.5",
              "electron-log": "4.4.8",
              "electron-updater": "6.0.4",
              "electron-window-state": "5.0.3",
              "jwt-decode": "3.1.2",
              keytar: "7.9.0",
              webpack: "5.74.0",
              "pubsub-js": "1.9.4",
              react: "18.2.0",
              "react-dom": "18.2.0",
              "react-native-web": "0.18.10",
              "react-router-dom": "6.4.0",
              "source-map-support": "0.5.16",
              yargs: "16.2.0",
              "ci-info": "2.0.0",
            }
          })
          await outputFile(path.join(projectDir, "yarn.lock"), "")
        },
        packed: async context => {
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/jwt-decode")).isDirectory()
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/keytar")).isDirectory()
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/yargs")).isDirectory()
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/@sentry/electron")).isDirectory()
          await assertThat(expect, path.join(context.getResources(Platform.LINUX), "app.asar.unpacked/node_modules/ci-info")).doesNotExist()
        },
      }
    )
  })
})