Build with node-gyp

.github/workflows/main.yml

@@ -39,8 +39,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # windows-latest disabled by now, unable to build
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
         node: [10, 11, 12, 13, 14]
     steps:
       - uses: actions/checkout@v2
@@ -57,6 +56,12 @@ jobs:
           name: blst_wrap.cpp
           path: prebuild/
 
+      # Solution from: https://github.com/nodejs/node-gyp/issues/1898#issuecomment-540864130
+      # Solution edit: https://github.com/nodejs/node-gyp/issues/119#issuecomment-331778053
+      - name: Install windows build tools
+        if: matrix.os == 'windows-latest' && matrix.node <= 11
+        run: yarn add windows-build-tools --ignore-scripts
+
       - name: Install && Build TS + bindings
         run: yarn bootstrap
       - name: Test
@@ -93,7 +98,7 @@ jobs:
           name: binding.node
           path: prebuild/
 
-      - name: Install && Build TS + bindings
+      - name: Build .ts source for release
         run: yarn bootstrap
 
       - name: Create Github release with prebuilds

.mocharc.yaml

@@ -1,2 +1,3 @@
 colors: true
 require: ts-node/register
+exit: true

package.json

@@ -37,6 +37,7 @@
     "typescript": "^4.0.3"
   },
   "dependencies": {
-    "node-fetch": "^2.6.1"
+    "node-fetch": "^2.6.1",
+    "node-gyp": "^7.1.2"
   }
 }

src/scripts/buildBindings.ts

@@ -3,11 +3,11 @@ import { exec } from "child_process";
 import { testBindings } from "./testBindings";
 import {
   bindingsDirSrc,
-  bindingsSrc,
   ensureDirFromFilepath,
   prebuiltSwigSrc,
   prebuiltSwigTarget,
   blstWrapCppName,
+  findBindingsFile,
 } from "./paths";
 import { downloadReleaseAsset } from "./downloadReleaseAsset";
 
@@ -28,8 +28,15 @@ export async function buildBindings(binaryPath: string) {
 
   // Use BLST run.me script to build libblst.a + blst.node
   await new Promise((resolve, reject): void => {
+    const buildCmd =
+      process.platform === "darwin"
+        ? // MacOS builds fail, use previous script run.me
+          //see tracking issue https://github.com/supranational/blst/pull/43#issuecomment-735180399
+          "./run.me"
+        : "node-gyp rebuild";
+
     const proc = exec(
-      "./run.me",
+      buildCmd,
       {
         timeout: 3 * 60 * 1000, // ms
         maxBuffer: 10e6, // bytes
@@ -44,9 +51,13 @@ export async function buildBindings(binaryPath: string) {
     if (proc.stderr) proc.stderr.pipe(process.stderr);
   });
 
+  // The output of node-gyp is not at a predictable path but various
+  // depending on the OS.
+  const bindingsFileOutput = findBindingsFile(bindingsDirSrc);
+
   // Copy built .node file to expected path
   ensureDirFromFilepath(binaryPath);
-  fs.copyFileSync(bindingsSrc, binaryPath);
+  fs.copyFileSync(bindingsFileOutput, binaryPath);
 
   // Make sure downloaded bindings work
   await testBindings(binaryPath);

src/scripts/paths.ts

@@ -2,14 +2,14 @@ import fs from "fs";
 import path from "path";
 
 const rootDir = path.join(__dirname, "../..");
+const bindingsName = "blst.node";
 
 export const packageJsonPath = path.join(rootDir, "package.json");
 
 export const bindingsDirSrc = path.join(rootDir, "blst/bindings/node.js");
 export const blstWrapCppName = "blst_wrap.cpp";
 export const prebuiltSwigSrc = path.join(rootDir, "prebuild", blstWrapCppName);
 export const prebuiltSwigTarget = path.join(bindingsDirSrc, blstWrapCppName);
-export const bindingsSrc = path.join(bindingsDirSrc, "blst.node");
 
 export const defaultBinaryDir = path.join(rootDir, "prebuild");
 
@@ -47,6 +47,47 @@ export function ensureDirFromFilepath(filepath: string) {
   }
 }
 
+/**
+ * The output of node-gyp is not at a predictable path but various
+ * depending on the OS.
+ * Paths based on https://github.com/TooTallNate/node-bindings/blob/c8033dcfc04c34397384e23f7399a30e6c13830d/bindings.js#L36
+ */
+export function findBindingsFile(dirpath: string): string {
+  const filepaths = [
+    // In dirpath
+    [dirpath, bindingsName],
+    // node-gyp's linked version in the "build" dir
+    [dirpath, "build", bindingsName],
+    // node-waf and gyp_addon (a.k.a node-gyp)
+    [dirpath, "build", "Debug", bindingsName],
+    [dirpath, "build", "Release", bindingsName],
+    // Debug files, for development (legacy behavior, remove for node v0.9)
+    [dirpath, "out", "Debug", bindingsName],
+    [dirpath, "Debug", bindingsName],
+    // Release files, but manually compiled (legacy behavior, remove for node v0.9)
+    [dirpath, "out", "Release", bindingsName],
+    [dirpath, "Release", bindingsName],
+    // Legacy from node-waf, node <= 0.4.x
+    [dirpath, "build", "default", bindingsName],
+    // Production "Release" buildtype binary (meh...)
+    [dirpath, "compiled", "version", "platform", "arch", bindingsName],
+    // node-qbs builds
+    [dirpath, "addon-build", "release", "install-root", bindingsName],
+    [dirpath, "addon-build", "debug", "install-root", bindingsName],
+    [dirpath, "addon-build", "default", "install-root", bindingsName],
+    // node-pre-gyp path ./lib/binding/{node_abi}-{platform}-{arch}
+    [dirpath, "lib", "binding", "nodePreGyp", bindingsName],
+  ].map((pathParts) => path.join(...pathParts));
+
+  for (const filepath of filepaths) {
+    if (fs.existsSync(filepath)) {
+      return filepath;
+    }
+  }
+
+  throw Error(`Could not find bindings file. Tried:\n${filepaths.join("\n")}`);
+}
+
 export class NotNodeJsError extends Error {
   constructor(missingItem: string) {
     super(