[bindgen] Adding prebuild and configuring it
#5447
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kraenhansen
changed the title
prebuild and configuring it
kraenhansen
force-pushed
the
kh/bindgen/prebuild
branch
from
f9c6cf3 to
1e1bdd2
Compare
takameyer
approved these changes
Feb 21, 2023
kraenhansen
commented
Feb 21, 2023
Comment on lines
+80
to
+85
| "binary": { | ||
| "module_name": "realm", | ||
| "module_path": "generated/ts", | ||
| "host": "https://static.realm.io", | ||
| "package_name": "realm-v{version}-napi-v6-{platform}-{arch}.tar.gz", | ||
| "remote_path": "realm-js-prebuilds/{version}" |
There was a problem hiding this comment.
Because we're leaving out the api_versions from this object, we signal to cmake-js that we're not targeting napi explicitly, which ensures we get the uv.h in our include path.
There was a problem hiding this comment.
Just curious how this avoids importing uv.h
@takameyer this is where the magic happens 🪄
papafe
added a commit
that referenced
this pull request
Feb 24, 2023
* bindgen: Implement getAllSyncSessions (#5492) Ensure that Realm enums are accessible (#5484) Apply suggestions from code review [skip ci] Small corrections [skip ci] Added changelog and final corrections Stub add test to validate that foreach throws on a dictionary (#5467) Using `RealmInsertionModel` on `Results#update` Updated "react-native" dev dep to 0.71.0 Bumped lower bound on our RN peer dependency [bindgen] SDK packaging (#5466) Adding "prebuild" and configuring it (#5447) add synthetic private brand fields to TS wrappers for C++ classes, and fix found bug import bindings directly rather than through internal Stub work
kraenhansen
added a commit
that referenced
this pull request
Mar 1, 2023
kraenhansen
added a commit
that referenced
this pull request
Mar 3, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What, How & Why?
This adds prebuild of the Node.js native module for separate architectures.
For context, I've included an excerpt from an internal discussion we had on Slack:
I just learned that
uv.his not covered by the ABI stability of node-api: https://nodejs.org/dist/latest-v18.x/docs/api/n-api.html#implications-of-abi-stabilityIn our current SDK we use a pre v7 version of cmake-js, which incorrectly assumes we're building for a specific node version and incorrectly expose uv.h to object-store and risking crashes.
I noticed this when I upgraded to cmake-js v7.1.1 on master where it correctly detects that we want to compile for node-api (because of this check) and I start getting:
I believe this means that we're risking crashes of our current native binary, because we're depending on the ABI of libuv, which we can't assume is stable.
I see the following options:
Napi::ThreadSafeFunctionAPI.This PR takes the latter approach by avoiding to include the