Query Planner as Node.js addon

.changeset/this_is_first_release_ever.md

@@ -0,0 +1,51 @@
+---
+node-addon: minor
+---
+
+# A node addon containing the query planner of hive router
+
+To use in TypeScript, you would go ahead and do something like:
+
+```ts
+import {
+  QueryPlanner,
+  type QueryPlan,
+} from "@graphql-hive/router-query-planner";
+
+const supergraphSdl = "<your sdl from file or in code>";
+
+const qp = new QueryPlanner(supergraphSdl);
+
+const plan: QueryPlan = qp.plan(/* GraphQL */ `
+  {
+    posts {
+      title
+      author {
+        name
+      }
+    }
+  }
+`);
+
+// see QueryPlan types in lib/node-addon/src/query-plan.d.ts
+```
+
+which will generate you a [Query Plan used in Apollo Federation](https://www.apollographql.com/docs/graphos/schema-design/federated-schemas/reference/query-plans).
+
+Hive Gateway uses it as an alternative federation query planner in the [`@graphql-hive/router-runtime`](https://github.com/graphql-hive/gateway/blob/main/packages/router-runtime).
+
+To use in with Hive Gateway, you first install the runtime
+
+```sh
+npm i @graphql-hive/router-runtime
+```
+
+```ts
+// gateway.config.ts
+import { defineConfig } from "@graphql-hive/gateway";
+import { unifiedGraphHandler } from "@graphql-hive/router-runtime";
+
+export const gatewayConfig = defineConfig({
+  unifiedGraphHandler,
+});
+```

.github/workflows/build-router.yaml

@@ -62,7 +62,14 @@ jobs:
 
   binary:
     name: ${{ matrix.name }}
-    if: github.event_name == 'push' || github.event_name == 'pull_request' || (github.event_name == 'release' && startsWith(github.event.release.tag_name, 'router/v'))
+    if: |
+      github.event_name == 'push' || github.event_name == 'pull_request' || (
+        github.event_name == 'release' &&
+        (
+          startsWith(github.event.release.tag_name, 'router/v') ||
+          startsWith(github.event.release.tag_name, 'node-addon/v')
+        )
+      )
     runs-on: ${{ matrix.action_runner }}
     strategy:
       matrix:
@@ -112,19 +119,78 @@ jobs:
         if: ${{ !matrix.zigbuild }}
 
       - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
-        name: upload build artifact
+        name: upload router 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 }}
+          if-no-files-found: error
+
+      # 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 node addon artifact
+        with:
+          name: node_addon_${{ matrix.name }}
+          path: |
+            lib/node-addon/*.node
           if-no-files-found: error
-      - name: Upload binaries to release
+
+      - name: Upload binaries to router release
         uses: svenstaro/upload-release-action@81c65b7cd4de9b2570615ce3aad67a41de5b1a13 # v2
-        if: ${{ github.event_name == 'release' }}
+        if: github.event_name == 'release' && startsWith(github.event.release.tag_name, 'router/v')
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           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' && startsWith(github.event.release.tag_name, 'node-addon/v')
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: lib/node-addon/*.node
+          tag: ${{ github.ref }}
+
+  # NOTE: would publish from release.yaml but we need the artifacts. doing it from here is simpler
+  npm-publish:
+    name: publish node addon
+    runs-on: ubuntu-latest
+    needs:
+      - binary
+    if: github.event_name == 'release' && startsWith(github.event.release.tag_name, 'node-addon/v')
+    steps:
+      - name: checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+      - name: setup node
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6
+        with:
+          node-version-file: lib/node-addon/.node-version
+          registry-url: https://registry.npmjs.org
+      - name: download node addon artifacts
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6
+        with:
+          pattern: node_addon_*
+          path: lib/node-addon
+      - name: prepare artifacts
+        working-directory: lib/node-addon
+        run: |
+          mv ./node_addon_linux_arm64/* .
+          mv ./node_addon_linux_amd64/* .
+          mv ./node_addon_macos_arm64/* .
+          mv ./node_addon_macos_amd64/* .
+      - name: npm publish
+        working-directory: lib/node-addon
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish --provenance
 
   docker:
     runs-on: ubuntu-latest

.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

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

knope.toml

@@ -26,6 +26,11 @@ versioned_files = ["bin/router/Cargo.toml", "Cargo.lock"]
 scopes = ["hive-router", "router", "config", "qp", "executor"]
 changelog = "bin/router/CHANGELOG.md"
 
+[packages.node-addon]
+versioned_files = ["lib/node-addon/package.json"]
+scopes = ["node-addon"]
+changelog = "lib/node-addon/CHANGELOG.md"
+
 # "release" pipeline that prepares the release and pushes a release PR
 [[workflows]]
 name = "release"

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/CHANGELOG.md

@@ -0,0 +1 @@
+# @graphql-hive/router-query-planner changelog

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"