fix: cross-platform prebuild downloads

[mmaietta]

Allow prebuilt binaries to be downloaded for target platform instead of hardcoded process.platform. Throws an error when attempting to cross-compile (buildFromSource || no prebuilds found)
Example:

rebuild/src/module-type/node-pre-gyp.ts

Line 31 in cb372cd

`--target_platform=${this.rebuilder.platform}`,

Origin of issue:

rebuild/src/rebuild.ts

Line 135 in cb372cd

public platform: string = process.platform;

Updated interface with new platform option and added docs

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.05%. Comparing base (cb372cd) to head (79d73e0).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1153      +/-   ##
==========================================
+ Coverage   76.93%   84.05%   +7.11%     
==========================================
  Files          21       21              
  Lines         763      765       +2     
  Branches      142      144       +2     
==========================================
+ Hits          587      643      +56     
+ Misses        122      121       -1     
+ Partials       54        1      -53     

Flag	Coverage Δ
	84.05% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mmaietta]

Writing a few tests for the code coverage requirement. Stay tuned.

[mmaietta]

Good thing I added tests. I had missed adding platform to the cache key.

I could use a tad bit of help though. (I'll continue investigating as well) I'm running into this test failure for the "early exit" when attempting cross-compilation via node-gyp.

  1 failing

  1) node-gyp
       buildArgs
         cross-compilation
           throws error early:
     AssertionError: expected [Function executor] to throw an error

Oddly enough, if I console.log right before the throw new Error, it logs the state correctly. So for some reason, expect(executor).throws() is not receiving the Error being thrown. Any idea why?

rebuild/src/module-type/node-gyp/node-gyp.ts

Lines 86 to 89 in fff2255

	async rebuildModule(): Promise<void> {
	if (this.rebuilder.platform !== process.platform) {
	throw new Error("node-gyp does not support cross-compiling native modules from source")
	}

rebuild/test/module-type-node-gyp.ts

Lines 69 to 74 in fff2255

	const executor = () => nodeGyp.rebuildModule();
	if (process.platform === platform) {
	expect(executor).does.not.throw()
	} else {
	expect(executor).throws()
	}

Example with logging:

    console.error("about to throw an error?", this.rebuilder.platform, process.platform)
    if (this.rebuilder.platform !== process.platform) {
      console.error("throw error")
      throw new Error("node-gyp does not support cross-compiling native modules from source")
    }
    console.error("I guess we build")

Logs in console show error logic is hit. Looks like something is swallowing the error?

about to throw an error? win32 darwin
throw error

---

Also, quick note, I changed platform: string to platform: NodeJS.Platform which shouldn't change much for the end user since platform was never configurable beforehand, so it just helps intellisense out for end users now.

[mmaietta]

Investigation update. It's throwing the error as written, but the event isn't propagating to mocha specifically. It properly logs the error being thrown if I add a .catch(console.error) to nodeGyp.rebuildModule(). I've taken a different approach in using an error message equality (to make sure we're testing this specific error being thrown) and then expect on a boolean flag

All tests are passing 🙃

rebuild/test/module-type-node-gyp.ts

Lines 75 to 82 in 0fbaba0

	const errorMessage = "node-gyp does not support cross-compiling native modules from source.";
	let errorThrown = false;
	await nodeGyp.rebuildModule().catch((err) => {
	if (err.message === errorMessage) {
	errorThrown = true
	}
	});
	expect(errorThrown).to.be.true;

[MarshallOfSound]

@mmaietta throws is used for synchronous checks, because the function you're calling is async you need to use the eventually assertion variants.

E.g. .to.eventually.be.rejectedWith (there are examples of this in other tests)

[mmaietta]

Thanks @MarshallOfSound! I had overlooked the chaiAsPromised. Updated the test accordingly

[samuelmaddock]

thanks for the added tests!

[mmaietta]

😞 Looks like this needed to be rebased off latest main since the eslint PR went in (or vice versa). My apologies

[continuous-auth]

🎉 This PR is included in version 3.6.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀