builds broken since v26.0.4

[t3chguy]

Affects Windows & macOS at least. Linux seems unaffected https://github.com/element-hq/element-desktop/actions/runs/13135755860/job/36653217694?pr=624

Seems related to #8571

Run yarn build:universal --publish never
yarn run v1.22.22
$ yarn run build:ts && yarn run build:res && electron-builder --universal --publish never
$ tsc
$ tsx scripts/copy-res.ts
  • electron-builder  version=26.0.4 os=23.6.0
  • loaded configuration  file=/Users/runner/work/element-desktop/element-desktop/electron-builder.ts
  • executing @electron/rebuild  electronVersion=34.0.1 arch=x64 buildFromSource=false appDir=./
  • installing native dependencies  arch=x64
  • completed installing native dependencies
  • packaging       platform=darwin arch=x64 electron=34.0.1 appOutDir=dist/mac-universal-x64-temp
  • downloading     url=https://github.com/electron/electron/releases/download/v34.0.1/electron-v34.0.1-darwin-x64.zip size=105 MB parts=6
  • downloaded      url=https://github.com/electron/electron/releases/download/v34.0.1/electron-v34.0.1-darwin-x64.zip duration=2.323s
  ⨯ The "path" argument must be of type string. Received undefined  failedTask=build stackTrace=TypeError: The "path" argument must be of type string. Received undefined
    at Object.normalize (node:path:[12](https://github.com/element-hq/element-desktop/actions/runs/13135755860/job/36650705352?pr=624#step:13:13)05:5)
    at flatten (/Users/runner/work/element-desktop/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:63:49)
    at flatten (/Users/runner/work/element-desktop/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:68:9)
    at YarnNodeModulesCollector.convertToDependencyGraph (/Users/runner/work/element-desktop/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:72:5)
    at YarnNodeModulesCollector.getNodeModules (/Users/runner/work/element-desktop/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:[13](https://github.com/element-hq/element-desktop/actions/runs/13135755860/job/36650705352?pr=624#step:13:14)0:34)
    at computeNodeModuleFileSets (/Users/runner/work/element-desktop/element-desktop/node_modules/app-builder-lib/src/util/appFileCopier.ts:181:[16](https://github.com/element-hq/element-desktop/actions/runs/13135755860/job/36650705352?pr=624#step:13:17))
    at /Users/runner/work/element-desktop/element-desktop/node_modules/app-builder-lib/src/platformPackager.ts:509:34
    at async Promise.all (index 0)
    at AsyncTaskManager.awaitTasks (/Users/runner/work/element-desktop/element-desktop/node_modules/builder-util/src/asyncTaskManager.ts:65:25)
    at MacPackager.doPack (/Users/runner/work/element-desktop/element-desktop/node_modules/app-builder-lib/src/platformPackager.ts:324:5)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
Error: Process completed with exit code 1.

[mmaietta]

@t3chguy can you please try 26.0.3?

@beyondkmp, can you please investigate this asap? Stacktrace is from #8571

[mmaietta]

Hmmm I'm struggling to reproduce with your repo @t3chguy
I did the following: git clone from master, bumped app-builder-lib, electron-builder, and electron-builder-squirrel-windows to 26.0.4. Then ran yarn build and it worked successfully.

Can you provide a minimum reproducible repo or instructions on how to repro your issue?

~/D/element-desktop> yarn build                                                                                                                  1 develop!
yarn run v1.22.19
$ yarn run build:ts && yarn run build:res && electron-builder
$ tsc
$ tsx scripts/copy-res.ts
  • electron-builder  version=26.0.4 os=24.2.0
  • loaded configuration  file=/Users/mikemaietta/Development/element-desktop/electron-builder.ts
  • writing effective config  file=dist/builder-effective-config.yaml
  • executing @electron/rebuild  electronVersion=34.0.1 arch=arm64 buildFromSource=false appDir=./
  • installing native dependencies  arch=arm64
  • completed installing native dependencies
  • packaging       platform=darwin arch=arm64 electron=34.0.1 appOutDir=dist/mac-arm64
  • executing @electron/fuses  electronPath=dist/mac-arm64/Element.app
  • signing         file=dist/mac-arm64/Element.app platform=darwin type=distribution identityName=<identity name> identityHash=<hash> provisioningProfile=none
  • skipped macOS notarization  reason=`notarize` options were unable to be generated
  • building        target=macOS zip arch=arm64 file=dist/Element-1.11.91-arm64-mac.zip
  • building        target=DMG arch=arm64 file=dist/Element-1.11.91-arm64.dmg
  • building block map  blockMapFile=dist/Element-1.11.91-arm64.dmg.blockmap
  • building block map  blockMapFile=dist/Element-1.11.91-arm64-mac.zip.blockmap

[t3chguy]

Maybe it only breaks when our native dependencies are installed, can you try yarn hak before yarn build - you may need rust and co installed, I can try dig deeper in a little while, just wrapping up a release.

[mmaietta]

Will test that now

[mmaietta]

Bingo, that did the trick.

@beyondkmp here's the repro steps from the repo's master branch

git clone https://github.com/element-hq/element-desktop

Pin electron-builder app-builder-lib electron-builder-squirrel-windows to 26.0.4 in package.json

brew install rust (if needed)

yarn install && yarn run hak && yarn run build

DEBUG Logs:

spawning        command=/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-bin/mac/app-builder_arm64 unpack-electron --configuration [{"platform":"darwin","arch":"arm64","version":"34.0.1"}] --output /Users/mikemaietta/Development/element-desktop/dist/mac-arm64 --distMacOsAppName Electron.app
  • map async       taskCount=2
  • map async       taskCount=1
  • map async       taskCount=255
  • exited          command=app-builder_arm64 code=0 pid=31786
  • executing       file=npm args=list --omit dev -a --json --long --silent cwd=/Users/mikemaietta/Development/element-desktop
  • error resolving path  message=The "path" argument must be of type string or an instance of Buffer or URL. Received undefined
  • async task error  error=The "path" argument must be of type string. Received undefined
  ⨯ The "path" argument must be of type string. Received undefined  failedTask=build stackTrace=TypeError: The "path" argument must be of type string. Received undefined
    at Object.normalize (node:path:1205:5)
    at flatten (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:63:49)
    at flatten (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:68:9)
    at YarnNodeModulesCollector.convertToDependencyGraph (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:72:5)
    at YarnNodeModulesCollector.getNodeModules (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:130:34)
    at processTicksAndRejections (node:internal/process/task_queues:105:5)
    at computeNodeModuleFileSets (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/util/appFileCopier.ts:181:16)
    at /Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/platformPackager.ts:509:34
    at async Promise.all (index 0)
    at AsyncTaskManager.awaitTasks (/Users/mikemaietta/Development/element-desktop/node_modules/builder-util/src/asyncTaskManager.ts:65:25)

Two additional notes:

• The package manager selected was npm, however this is a yarn project
• I also notice a hakDependencies in the package.json, which might need to be parsed in the nodeModuleCollector

[t3chguy]

Linux seems unaffected

This would then be because the "hak" stage happens in another runner and gets copied over, not affecting the local node_modules at time of electron-builder running

I also notice a hakDependencies in the package.json, which might need to be parsed in the nodeModuleCollector

This is a non-standard thing used in the build scripts, it builds (cross-compiles if necessary) native rust & c dependencies and links them into node_modules - this has worked fine for years until this change =(

can you please try 26.0.3?

That worked as expected: https://github.com/element-hq/element-desktop/actions/runs/13139390509/job/36662667175?pr=624

(edit) consolidating into one comment

[mmaietta]

So 26.0.3 will have the app-builder & squirrel changes you want prob.

26.0.4 was solely a release with a migration of GOlang app-builder-bin's node_modules collection logic to a JS-based solution (allowing us to more aptly control the logic, support additional package managers, and remove the workaround needed for pnpm hoisting)

We added quite a few additional tests, as well as copied the entire test suite for yarn berry's hoist.ts logic (we could have installed the yarn package to leverage the logic, but holy moly that would increase our dependency tree/chain to unnecessarily huge)

[mmaietta]

@beyondkmp update from my side:
Added log.info({ key, value: JSON.stringify(value) }, "dependency found") to convertToDependencyGraph::flatten and received this before path.normalize throws an error since path is missing:

  ⨯ dependency found  key=lodash.escaperegexp value={"required":"^4.1.2","missing":true,"problems":["missing: lodash.escaperegexp@^4.1.2, required by electron-updater@6.5.0"]}

This seems to resolve this particular issue, but I'd like a deeper investigation as to why path doesn't exist since it's a required prop in DependencyTree

        if (value.missing === true) {
          continue
        }
        const version = value.version || ""
        const newKey = `${key}@${version}`
        this.dependencyPathMap.set(newKey, path.normalize(this.resolvePath(value.path)))

The changes above then throws a different error:

  ⨯ ENOTDIR: not a directory, scandir '/Users/mikemaietta/Development/element-desktop/node_modules/tsconfig-base.json'  failedTask=build stackTrace=Error: ENOTDIR: not a directory, scandir '/Users/mikemaietta/Development/element-desktop/node_modules/tsconfig-base.json'

[mmaietta]

Alright, can reproduce with a unit test now, this will significantly streamline debugging.

CC @beyondkmp

test.only("yarn electron-clear-data", () =>
  assertPack(
    "test-app-hoisted",
    {
      targets: Platform.MAC.createTarget(DIR_TARGET, Arch.x64),
    },
    {
      isInstallDepsBefore: true,
      projectDirCreated: projectDir => {
        return Promise.all([
          modifyPackageJson(projectDir, data => {
            data.dependencies = {
              "electron-clear-data": "^1.0.5",
            }
          }),
          outputFile(path.join(projectDir, "yarn.lock"), ""),
        ])
      }
    }
  ))

[beyondkmp]

@mmaietta I currently don't have a macOS testing machine, so I can't test element-desktop. When I tried running yarn run hak on Windows, I encountered a lot of errors. Could you help test it on macOS when you have time?

[t3chguy]

The requirements to run element-desktop's hak on Windows are not short unfortunately.

- [Git for Windows](https://git-scm.com/download/win)
- [Node LTS](https://nodejs.org)
- [Python 3](https://www.python.org/downloads/) (if you type 'python' into command prompt it will offer to install it from the windows store)
- [Strawberry Perl](https://strawberryperl.com/)
- [Rustup](https://rustup.rs/)
- [NASM](https://www.nasm.us/)
- [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019) with the following configuration:
    - On the Workloads tab:
        - Desktop & Mobile -> C++ build tools
    - On the Individual components tab:
        - MSVC VS 2019 C++ build tools
        - Windows 10 SDK (latest version available)
        - C++ CMake tools for Windows
       

[beyondkmp]

Bingo, that did the trick.

@beyondkmp here's the repro steps from the repo's master branch

git clone https://github.com/element-hq/element-desktop

Pin electron-builder app-builder-lib electron-builder-squirrel-windows to 26.0.4 in package.json

brew install rust (if needed)

yarn install && yarn run hak && yarn run build

DEBUG Logs:

spawning        command=/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-bin/mac/app-builder_arm64 unpack-electron --configuration [{"platform":"darwin","arch":"arm64","version":"34.0.1"}] --output /Users/mikemaietta/Development/element-desktop/dist/mac-arm64 --distMacOsAppName Electron.app
  • map async       taskCount=2
  • map async       taskCount=1
  • map async       taskCount=255
  • exited          command=app-builder_arm64 code=0 pid=31786
  • executing       file=npm args=list --omit dev -a --json --long --silent cwd=/Users/mikemaietta/Development/element-desktop
  • error resolving path  message=The "path" argument must be of type string or an instance of Buffer or URL. Received undefined
  • async task error  error=The "path" argument must be of type string. Received undefined
  ⨯ The "path" argument must be of type string. Received undefined  failedTask=build stackTrace=TypeError: The "path" argument must be of type string. Received undefined
    at Object.normalize (node:path:1205:5)
    at flatten (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:63:49)
    at flatten (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:68:9)
    at YarnNodeModulesCollector.convertToDependencyGraph (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:72:5)
    at YarnNodeModulesCollector.getNodeModules (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/node-module-collector/nodeModulesCollector.ts:130:34)
    at processTicksAndRejections (node:internal/process/task_queues:105:5)
    at computeNodeModuleFileSets (/Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/util/appFileCopier.ts:181:16)
    at /Users/mikemaietta/Development/element-desktop/node_modules/app-builder-lib/src/platformPackager.ts:509:34
    at async Promise.all (index 0)
    at AsyncTaskManager.awaitTasks (/Users/mikemaietta/Development/element-desktop/node_modules/builder-util/src/asyncTaskManager.ts:65:25)

Two additional notes:

• The package manager selected was npm, however this is a yarn project

@mmaietta yarn list does not provide a specific path parameter, so in a Yarn project, npm list is also used to obtain the dependencies tree.

• I also notice a hakDependencies in the package.json, which might need to be parsed in the nodeModuleCollector