fix: Respect unpack minimatch for symlinks within previously unpacked directories

[mmaietta]

Summary:
Fixes issue with unpack configuration when considering symlinks within previously unpacked directories. This directly fixes unpacking static .framework modules on Mac, as otherwise codesigning will fail due to symlink files/directories not being reflected in the app.asar.unpacked directory.

Fix:

• Tracks all symlinks in a list (similar as files) as to what are supposed to be unpacked.
• Adds unpacked flag as node.unpacked=true
• Extracts common logic for detecting if a path is unpacked
• Added promisified symlink and readlink
• Adds Hello.framework for mac/linux symlink verification

Added unit test with Hello.framework, generated from HelloWorld tutorial https://jano.dev/apple/mach-o/2024/06/28/Hello-Static-Framework.html

Note: This implementation is isolated to mac/linux. It seems symlinks created on Windows (mklink) do not get properly committed to git, they seem to be committed as an actual file and I couldn't figure out why

Details:
.framework has to have all symlinks reproduced in the unpacked directory for signing. The top is with electron/asar unpacked folder, the bottom is the actual framework contents.

Without this PR, codesigning will fail with QtCore.framework: bundle format unrecognized, invalid, or unsuitable

  • signing         file=dist/mac/SanitizedAppName.app platform=darwin type=distribution identity=<SanitizedIdentity> provisioningProfile=none
  ⨯ Command failed: codesign --sign <SanitizedIdentity> --force --timestamp --options runtime --entitlements ./build/entitlements.mac.plist /Users/<project-folder>/dist/mac/SanitizedAppName.app/Contents/Resources/app.asar.unpacked/node_modules/<sanitized-dep-name>/lib/Release/QtCore.framework
/Users/<project-folder>/dist/mac/SanitizedAppName.app/Contents/Resources/app.asar.unpacked/node_modules/<sanitized-dep-name>/lib/Release/QtCore.framework: bundle format unrecognized, invalid, or unsuitable

~/D/asar> tree test/input/packthis-with-symlink                                   fix/static-framework-symlinks-2!
test/input/packthis-with-symlink
├── A
│   └── real.txt
├── Current -> A
├── Hello.framework
│   ├── Headers -> Versions/Current/Headers
│   ├── Hello -> Versions/Current/Hello
│   ├── Info.plist -> Versions/Current/Info.plist
│   ├── Modules -> Versions/Current/Modules
│   └── Versions
│       ├── A
│       │   ├── Headers
│       │   │   └── HelloFramework.h
│       │   ├── Hello
│       │   ├── Info.plist
│       │   ├── Modules
│       │   │   ├── Hello.abi.json
│       │   │   ├── Hello.swiftdoc
│       │   │   ├── Hello.swiftmodule
│       │   │   │   ├── arm64.private.swiftinterface
│       │   │   │   ├── arm64.swiftinterface
│       │   │   │   ├── arm64.swiftmodule
│       │   │   │   ├── x86_64.private.swiftinterface
│       │   │   │   ├── x86_64.swiftinterface
│       │   │   │   └── x86_64.swiftmodule
│       │   │   ├── Hello.swiftsourceinfo
│       │   │   └── module.modulemap
│       │   └── Resources
│       └── Current -> A
└── real.txt -> Current/real.txt

16 directories, 18 files

Fixes: electron-userland/electron-builder#8655 (comment)

[beyondkmp]

On Windows, using junction to create symlinks should avoid permission issues.

[mmaietta]

Great callout. I read somewhere (can't find the link atm) that junctions are absolute links, as opposed to a "pointer" relative path. If so, we don't want absolute links between folders in the unpacked folder, otherwise I don't think the asar will work on other computers.

[beyondkmp]

After git cloning on Windows, SymlinkedDir is not a symlink but rather a regular file. I suggest only testing this on macOS/Linux. No need to test on Windows since you're not handling symlink in window.

https://github.com/mmaietta/asar/blob/1676a0ea070967f818167164be5bf7d0e378fb41/src/disk.ts#L65-L68