Switch to N-API prebuilds

[dennisameling]

Closes #330

This PR creates N-API prebuild binaries instead of separate ones for Node and Electron. This is supported by NodeJS versions 8.11.2 and higher: https://nodejs.org/api/n-api.html#n_api_n_api_version_matrix

Testing this PR

Tested this on GitHub Desktop by doing yarn remove keytar && yarn add @dennisameling/keytar-temp (https://github.com/dennisameling/node-keytar/releases/tag/v7.4.99-beta) - it works as expected 🚀

C:\repos\desktop\app>yarn add @dennisameling/keytar-temp
yarn add v1.21.1
[1/4] Resolving packages...
[2/4] Fetching packages...
[3/4] Linking dependencies...
[4/4] Building fresh packages...
success Saved lockfile.
success Saved 3 new dependencies.
info Direct dependencies
└─ @dennisameling/[email protected]
info All dependencies
├─ @dennisameling/[email protected]
├─ [email protected]
└─ [email protected]
Done in 18.29s.

Output of prebuild-install --verbose also shows that prebuild is correctly downloading the N-API prebuild binaries:

C:\repos\node-keytar>prebuild-install --verbose
prebuild-install info begin Prebuild-install version 6.0.0
prebuild-install info looking for cached prebuild @ C:\Users\denni\AppData\Roaming\npm-cache\_prebuilds\14731b-keytar-temp-v7.1.1-beta-napi-v3-win32-arm64.tar.gz
prebuild-install http request GET https://github.com/dennisameling/node-keytar/releases/download/v7.1.1-beta/keytar-temp-v7.1.1-beta-napi-v3-win32-arm64.tar.gz
prebuild-install http 200 https://github.com/dennisameling/node-keytar/releases/download/v7.1.1-beta/keytar-temp-v7.1.1-beta-napi-v3-win32-arm64.tar.gz
prebuild-install info downloading to @ C:\Users\denni\AppData\Roaming\npm-cache\_prebuilds\14731b-keytar-temp-v7.1.1-beta-napi-v3-win32-arm64.tar.gz.21480-fe4ffc5c96c92.tmp
prebuild-install info renaming to @ C:\Users\denni\AppData\Roaming\npm-cache\_prebuilds\14731b-keytar-temp-v7.1.1-beta-napi-v3-win32-arm64.tar.gz
prebuild-install info unpacking @ C:\Users\denni\AppData\Roaming\npm-cache\_prebuilds\14731b-keytar-temp-v7.1.1-beta-napi-v3-win32-arm64.tar.gz
prebuild-install info unpack resolved to C:\repos\node-keytar\build\Release\keytar.node
prebuild-install info install Successfully installed prebuilt binary!

[dennisameling]

Test release with Windows/macOS/Linux binaries: https://github.com/dennisameling/node-keytar/releases/tag/v7.4.99-beta

Will test extensively in the coming days on different platforms

[dennisameling]

Let's put this on hold until develar/app-builder#47 is fixed - that will ensure that prebuild-install will look for N-API prebuilds if a package supports N-API 👍🏼

[shiftkey]

@dennisameling I think I'm interested in revisiting this now that our prebuild support is expanding to other setups (ARM, Alpine, etc).

Did you have any bandwidth coming up to update this PR now that we're migrated over to Actions? I'm happy to take a swing at it if that's not the case, but carving out time is my eternal challenge these days...

[dennisameling]

Sorry for the late reply @shiftkey - will try to make some time for this in the coming weekend! 👍🏼

[dennisameling]

@shiftkey rebased, but this is dependent on #375 for the failing Ubuntu runs. Let me know if I can be of any help with that PR, have subscribed to it so will continue here once that's done!

[shiftkey]

@dennisameling I'm reverting the dependency update that introduced this issue in #377 so we can march onwards with this work

[shiftkey]

@dennisameling #377 has been merged, please rebase when you have time and let's see if we're good

[dennisameling]

@shiftkey looks like we're good to go now! Would be great if we could release a new major version (beta) with N-API to see if it works as expected. I could e.g. try with GitHub Desktop and see if all tests are passing there

[shiftkey]

@dennisameling that's the plan, cc @sergiou87 for 👀

[sergiou87]

I just built a test version using keytar from @dennisameling 's branch and, at least on x64, everything worked fine. In case anyone can or wants to test it:

• Windows arm64: https://s3.amazonaws.com/github-desktop/releases/2.7.3-test3-e1b5226e/GitHubDesktopSetup-arm64.exe
• Windows x64: https://s3.amazonaws.com/github-desktop/releases/2.7.3-test3-e1b5226e/GitHubDesktopSetup-x64.exe
• macOS arm64: https://s3.amazonaws.com/github-desktop/releases/2.7.3-test3-e1b5226e/GitHubDesktop-arm64.zip
• macOS x64: https://s3.amazonaws.com/github-desktop/releases/2.7.3-test3-e1b5226e/GitHubDesktop-x64.zip

[sergiou87]

@trulyronak it'd be great if you could give that a try too, since you had issues with the first build 😅 🤞

[shiftkey]

Merging this in now, but I'd like to adapt this step to support setting the next dist-tag on publish when I push a pre-release tag, so I can freely publish builds using Actions and not have them bleed over to latest for users:

node-keytar/.github/workflows/ci.yml

Lines 148 to 151 in 57fc618

	- run: npm publish --access public
	name: Upload to NPM
	env:
	NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

[cb1kenobi]

Thank you guys so much!