feat: add support for force-build-from-source argument

[gribnoysup]

This patch adds support for the --build-from-source option of the prebuild-install package similar to the --tag-prefix flag from the same tool that is already supported. Sometimes it is helpful to be able to force rebuild for native modules when the electron application is packaged, but currently the --force flag just makes sure that prebuild-install is activated, and this tool will prioritize downloading a prebuilt binary if it exists. It might make sense to make --force implicitly activate this flag, but to avoid breaking change to the package I added it as a separate flag (but happy to change to whatever the maintainers would prefer)

[ckerr]

Looks like exactly what the description says, a simple pass-through to access the --build-from-source flag.

Approving, but since this repo flies under the radar a lot of the time I'm going to hold off for merging for a bit in case @malept or anyone wants to object

[malept]

There's a few things I'd like to see from this:

• if we're going to be adding a flag to force building from source, it shouldn't be limited to prebuild-install - it should also work for prebuildify and any other build system we choose to add in the future. In that case I'd prefer if the flag were called --force-build-from-source and forceBuildFromSource respectively (similar to forceAbi).
• There should be tests to verify that we're passing the correct arguments to prebuild-install, given the value of the build from source flag.

[codecov-commenter]

Codecov Report

Merging #989 (7af98bb) into main (29365ad) will decrease coverage by 0.33%.
The diff coverage is 79.62%.

@@            Coverage Diff             @@
##             main     #989      +/-   ##
==========================================
- Coverage   76.44%   76.12%   -0.33%     
==========================================
  Files          19       20       +1     
  Lines         692      691       -1     
  Branches      134      131       -3     
==========================================
- Hits          529      526       -3     
  Misses        118      118              
- Partials       45       47       +2     

Impacted Files	Coverage Δ
src/clang-fetcher.ts	81.42% <ø> (+0.34%)	⬆️
src/types.ts	100.00% <ø> (ø)
src/module-type/node-gyp/node-gyp.ts	83.87% <75.00%> (ø)
src/module-type/node-gyp/worker.ts	76.19% <76.19%> (ø)
src/module-rebuilder.ts	91.52% <100.00%> (ø)
src/module-type/prebuild-install.ts	90.00% <100.00%> (ø)
src/rebuild.ts	72.82% <100.00%> (+0.29%)	⬆️
src/sysroot-fetcher.ts	83.87% <100.00%> (-0.51%)	⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[gribnoysup]

Renamed and added a test

[mmaietta]

Hey folks, I'd like to bump up this PR. @malept can you please take a look? It seems the requested changes were made.

Context: I'm looking to migrate the electron-builder package to use electron-rebuild directly (as opposed to the Go-library that handles it), and one of the requirements for us is to have forceBuildFromSource for us to cleanly transition

[BlackHole1]

LGTM.
/cc @malept

[gribnoysup]

@mmaietta not sure if this is of any help, but if you're looking for a temporary workaround while this is being approved what we ended up doing in our case is passing a completely fake tag prefix which ensures that prebuilt version cannot be found and forces the build from source to happen

[mmaietta]

Thanks @gribnoysup ! I'll use that for an alpha release of the npm package electron-builder. However, I don't think it should be the long-term implementation I use, so I'll still need this PR merged/released before I can proceed with a "prod" RC

[mmaietta]

@malept if no objections, can you please merge when you have a chance? 🙂

[gaodeng]

Hi @malept , just wanted to remind you of the pending pull request. Many users are waiting for this important update.

Apparently the changes requested have been made

[gribnoysup]

Rebased on main to resolve conflicts

[erickzhao]

rebuild/src/rebuild.ts

Lines 179 to 182 in 82da9d9

	if (await moduleRebuilder.prebuildInstallNativeModuleExists()) {
	d(`skipping: ${path.basename(modulePath)} as it was prebuilt`);
	return;
	}

Hey @gribnoysup, won't this actually short-circuit the rebuild logic before we even call moduleRebuilder.rebuild()?