Query Planner as Node.js addon

.github/workflows/build.yaml

@@ -111,11 +111,23 @@ jobs:
         run: cargo build --release --target ${{ matrix.rust_target }}
         if: ${{ !matrix.zigbuild }}
 
+      # napi build will use zigbuild when cross compiling
+      - name: node-addon build (${{ matrix.rust_target }})
+        working-directory: lib/node-addon
+        env:
+          CROSS_COMPILE: ${{ matrix.zigbuild }}
+          TARGET: ${{ matrix.rust_target }}
+        run: |
+          npm ci
+          npm run build
+
       - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
         name: upload build artifact
         with:
           name: hive_router_${{ matrix.name }}
-          path: target/${{ matrix.rust_target }}/release/${{ env.BINARY_NAME }}
+          path: |
+            target/${{ matrix.rust_target }}/release/${{ env.BINARY_NAME }}
+            lib/node-addon/${{ env.BINARY_NAME }}.*.node
           if-no-files-found: error
       - name: Upload binaries to release
         uses: svenstaro/upload-release-action@81c65b7cd4de9b2570615ce3aad67a41de5b1a13 # v2
@@ -125,6 +137,13 @@ jobs:
           file: target/${{ matrix.rust_target }}/release/${{ env.BINARY_NAME }}
           asset_name: hive_router_${{ matrix.name }}
           tag: ${{ github.ref }}
+      - name: Upload node addons to release
+        uses: svenstaro/upload-release-action@81c65b7cd4de9b2570615ce3aad67a41de5b1a13 # v2
+        if: ${{ github.event_name == 'release' }}
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: lib/node-addon/${{ env.BINARY_NAME }}.*.node
+          tag: ${{ github.ref }}
 
   docker:
     runs-on: ubuntu-latest
@@ -163,8 +182,8 @@ jobs:
           mkdir -p ./target/linux/arm64
           mkdir -p ./target/linux/amd64
 
-          mv ./artifacts/${{ env.BINARY_NAME }}_linux_arm64/${{ env.BINARY_NAME }} ./target/linux/arm64/${{ env.BINARY_NAME }}
-          mv ./artifacts/${{ env.BINARY_NAME }}_linux_amd64/${{ env.BINARY_NAME }} ./target/linux/amd64/${{ env.BINARY_NAME }}
+          mv ./artifacts/target/aarch64-unknown-linux-gnu/release/${{ env.BINARY_NAME }} ./target/linux/arm64/${{ env.BINARY_NAME }}
+          mv ./artifacts/target/x86_64-unknown-linux-gnu/release/${{ env.BINARY_NAME }} ./target/linux/amd64/${{ env.BINARY_NAME }}
           ls -ltra ./target/linux/arm64/
           ls -ltra ./target/linux/amd64/
       - uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0

.github/workflows/ci.yaml

@@ -29,6 +29,15 @@ jobs:
         env:
           RUST_BACKTRACE: full
           RUST_LOG: debug
+      - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
+        with:
+          node-version-file: lib/node-addon/.node-version
+      - name: node-addon test
+        working-directory: lib/node-addon
+        run: |
+          npm ci
+          npm run build:debug
+          npm test
 
   build-release:
     name: cargo build

Cargo.toml

@@ -4,6 +4,7 @@ members = [
   "lib/router-config",
   "lib/wasm-lib",
   "lib/executor",
+  "lib/node-addon",
   "bin/dev-cli",
   "bin/router",
   "e2e",

lib/node-addon/.cargo/config.toml

@@ -0,0 +1,2 @@
+[target.x86_64-pc-windows-msvc]
+rustflags = ["-C", "target-feature=+crt-static"]

lib/node-addon/.gitignore

@@ -0,0 +1 @@
+*.node

lib/node-addon/.node-version

@@ -0,0 +1 @@
+v24

lib/node-addon/.prettierignore

@@ -0,0 +1,2 @@
+index.js
+index.d.ts

lib/node-addon/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+edition = "2021"
+version = "0.0.0"
+name = "node-addon"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+hive-router-query-planner = { path = "../query-planner", version = "2.0.0" }
+tokio = { workspace = true }
+serde_json = { workspace = true }
+napi = { version = "3.0.0", features = ["async", "serde-json"] }
+napi-derive = "3.0.0"
+
+[build-dependencies]
+napi-build = "2"
+
+# TODO: profiles need to specified at root Cargo.toml, does it make a difference? I see lto is true there too
+# [profile.release]
+# lto = true
+# strip = "symbols"

lib/node-addon/build.js

@@ -0,0 +1,30 @@
+import { NapiCli } from "@napi-rs/cli";
+import fs from "node:fs/promises";
+
+const cli = new NapiCli();
+
+const release = process.env["RELEASE"] === "true";
+const crossCompile = process.env["CROSS_COMPILE"] === "true";
+
+(async function build() {
+  const target = process.env["TARGET"];
+  console.log(
+    `Building node-addon in ${release ? "release" : "debug"} mode for ${
+      target || "current os and arch"
+    }${crossCompile ? " with cross compile" : ""}...`
+  );
+  const { task } = await cli.build({
+    release,
+    platform: true,
+    esm: true,
+    crossCompile,
+    target,
+  });
+  await task;
+
+  console.log("Adding QueryPlan definitions...");
+  const queryPlanTypeDefs = await fs.readFile("src/query-plan.d.ts", "utf8");
+  await fs.appendFile("index.d.ts", `\n${queryPlanTypeDefs}`);
+
+  console.log("Ok");
+})();

lib/node-addon/build.rs

@@ -0,0 +1,3 @@
+fn main() {
+    napi_build::setup();
+}

lib/node-addon/fixture/federation-example/query.graphql

@@ -0,0 +1,58 @@
+fragment User on User {
+  id
+  username
+  name
+}
+
+fragment Review on Review {
+  id
+  body
+}
+
+fragment Product on Product {
+  inStock
+  name
+  price
+  shippingEstimate
+  upc
+  weight
+}
+
+query TestQuery {
+  users {
+    ...User
+    reviews {
+      ...Review
+      product {
+        ...Product
+        reviews {
+          ...Review
+          author {
+            ...User
+            reviews {
+              ...Review
+              product {
+                ...Product
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+  topProducts {
+    ...Product
+    reviews {
+      ...Review
+      author {
+        ...User
+        reviews {
+          ...Review
+          product {
+            ...Product
+          }
+        }
+      }
+    }
+  }
+}