indexer-native: Install uses precompiled binaries hosted on GitHub releases #414
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
fordN
force-pushed
the
ford/precompile-indexer-native
branch
5 times, most recently
from
ffc3ff4 to
896b2ad
Compare
fordN
force-pushed
the
ford/precompile-indexer-native
branch
from
896b2ad to
63d6955
Compare
- Update install process to download precompiled binary,if that fails fallback to the current behavior and compile directly on user's machine - Add GitHub Actions workflow for pre-compiling the Node add-on module on various machines and binaries and pushing to the GitHub releases page
fordN
force-pushed
the
ford/precompile-indexer-native
branch
from
63d6955 to
ff39606
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
Description
We use neon to package rust binaries with node-bindings (as Node add-on modules), so they can be called by our indexer component packages. The system works well, but has a few shortcomings the most commonly reported point of friction has been in compiling the binaries on our users machines (see Related Issues below). In order to compile there are a few requirements to be installed on the machine: Rust, python, node-gyp, and in some cases nan. This PR aims to avoid these requirements/issues by precompiling the binaries on various machines and for various versions of the Node ABI and publishing these binaries to the GitHub releases page and making the defaulting the install process download the relevant precompiled binary instead of compiling it on the users machine. Another benefit of this update is that hosting the binaries separately allows us to reduce the size of the NPM package significantly, and will provide us more control of the compilation process (optimizing the Rust compilation configs).
Related issues
indexer-cliinstall is very large:neonbuilds in debug mode #222npm#386 (potentially related)Updates