Use Query Planner from Hive Router

.changeset/sharp-cars-act.md

@@ -0,0 +1,5 @@
+---
+'@graphql-mesh/fusion-runtime': minor
+---
+
+Use Query Planner from Hive Router

.github/workflows/memtest.yml

@@ -18,18 +18,27 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        test_name:
-          - auto-type-merging
-          - federation-example
-          - federation-mixed
-          - federation-subscriptions-passthrough
-          - opentelemetry
-          - programmatic-batching
-          - logger
+        test:
+          - name: auto-type-merging
+            hive-router-runtime: false
+          - name: federation-example
+            hive-router-runtime: false
+          - name: federation-example
+            hive-router-runtime: true
+          - name: federation-mixed
+            hive-router-runtime: false
+          - name: federation-subscriptions-passthrough
+            hive-router-runtime: false
+          - name: opentelemetry
+            hive-router-runtime: false
+          - name: programmatic-batching
+            hive-router-runtime: false
+          - name: logger
+            hive-router-runtime: false
         e2e_runner:
           - node
           # - bun TODO: get memory snaps and heap sampling for bun. is it even necessary?
-    name: ${{matrix.e2e_runner}} / ${{matrix.test_name}}
+    name: ${{matrix.e2e_runner}} / ${{matrix.test.name}} ${{ matrix.test.hive-router-runtime && 'with hive router runtime' || '' }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -57,15 +66,18 @@ jobs:
         continue-on-error: true
         with:
           key: docker-images-${{ runner.os }}-${{ steps.hash-docker-images.outputs.result }}
+      - if: matrix.test.hive-router-runtime == 'true'
+        name: Enable Hive Router Runtime
+        run: echo "HIVE_ROUTER_RUNTIME=1" >> $GITHUB_ENV
       - name: Test
         env:
           E2E_GATEWAY_RUNNER: ${{matrix.e2e_runner}}
-        run: yarn test:mem ${{matrix.test_name}}
+        run: yarn test:mem ${{matrix.test.name}}
       - name: Upload heap snapshots
         if: failure()
         uses: actions/upload-artifact@v5
         with:
-          name: ${{matrix.test_name}}-heap-snapshots
+          name: ${{matrix.test.name}}-heap-snapshots
           path: |
-            e2e/${{matrix.test_name}}/*.heapsnapshot
+            e2e/${{matrix.test.name}}/*.heapsnapshot
             packages/logger/tests/*.heapsnapshot

.github/workflows/test.yml

@@ -33,7 +33,11 @@ jobs:
         uses: the-guild-org/shared-config/setup@v1
         with:
           node-version: ${{matrix.node-version}}
-      - name: Test
+      - name: Test with Stitching Runtime
+        run: yarn test
+      - name: Test with Router Runtime
+        env:
+          HIVE_ROUTER_RUNTIME: 1
         run: yarn test
 
   unit-bun:
@@ -46,8 +50,16 @@ jobs:
         uses: the-guild-org/shared-config/setup@v1
         with:
           node-version-file: .node-version
-      - name: Test
+      - name: Test with Stitching Runtime
+        uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3
+        with:
+          timeout_minutes: 10
+          max_attempts: 3
+          command: yarn test:bun
+      - name: Test with Router Runtime
         uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3
+        env:
+          HIVE_ROUTER_RUNTIME: 1
         with:
           timeout_minutes: 10
           max_attempts: 3
@@ -72,8 +84,16 @@ jobs:
         uses: the-guild-org/shared-config/setup@v1
         with:
           node-version: ${{matrix.node-version}}
-      - name: Run Tests
+      - name: Test with Stitching Runtime
+        uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3
+        with:
+          timeout_minutes: 10
+          max_attempts: 3
+          command: yarn test:leaks
+      - name: Test with Router Runtime
         uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3
+        env:
+          HIVE_ROUTER_RUNTIME: 1
         with:
           timeout_minutes: 10
           max_attempts: 3

e2e/federation-example/federation-example.bench.ts

@@ -9,23 +9,31 @@ import { fetch } from '@whatwg-node/fetch';
 import { bench, describe, expect } from 'vitest';
 
 describe('Gateway', async () => {
-  const { gateway, service } = createTenv(__dirname);
+  const { gateway, service: _service } = createTenv(__dirname);
   const example = createExampleSetup(__dirname, 1000);
 
   const supergraph = await example.supergraph();
 
   const gateways: Record<string, Gateway | Service> = {
-    'Apollo Gateway': await service('apollo-gateway', {
+    // TODO: tests are failing for whatever reason
+    // 'Apollo Gateway': await service('apollo-gateway', {
+    //   env: {
+    //     SUPERGRAPH: supergraph,
+    //   },
+    // }),
+    'Hive Gateway w/ Tools': await gateway({
+      supergraph,
       env: {
-        SUPERGRAPH: supergraph,
+        FORK: 1,
+        NODE_ENV: 'production',
       },
     }),
-    'Hive Gateway': await gateway({
+    'Hive Gateway w/ Hive Router Query Planner': await gateway({
       supergraph,
-      args: ['--jit'],
       env: {
-        JIT: 'true',
+        FORK: 1,
         NODE_ENV: 'production',
+        HIVE_ROUTER_RUNTIME: 1,
       },
     }),
   };

e2e/nestjs/package.json

@@ -2,16 +2,5 @@
   "name": "@e2e/nestjs",
   "version": "0.0.1",
   "type": "module",
-  "private": true,
-  "dependencies": {
-    "@graphql-hive/nestjs": "workspace:^",
-    "@nestjs/common": "^11.1.8",
-    "@nestjs/core": "^11.1.8",
-    "@nestjs/graphql": "^13.2.0",
-    "@nestjs/platform-express": "^11.1.8",
-    "file-type": "^21.0.0",
-    "graphql": "^16.12.0",
-    "reflect-metadata": "^0.2.2",
-    "rxjs": "^7.8.1"
-  }
+  "private": true
 }

internal/e2e/src/tenv.ts

@@ -18,6 +18,7 @@ import {
   createServicePortOpt,
   getLocalhost,
   isDebug,
+  ResponseError,
 } from '@internal/testing';
 import { cancelledSignal } from '@internal/testing/vitest';
 import { DisposableSymbols } from '@whatwg-node/disposablestack';
@@ -595,14 +596,12 @@ export function createTenv(cwd: string): Tenv {
               } catch {
                 // not a GraphQL error, something weird happened
               }
-              const err = new Error(
-                `${res.status} ${res.statusText}\n${resText}`,
-              );
-              err.name = 'ResponseError';
-              if (resText.includes('Unexpected')) {
-                process.stderr.write(proc.getStd('both'));
-              }
-              throw err;
+              throw new ResponseError({
+                status: res.status,
+                statusText: res.statusText,
+                resText,
+                proc,
+              });
             }
             const resBody: ExecutionResult = await res.json();
             if (

internal/env/src/ResponseError.ts

@@ -0,0 +1,29 @@
+import type { Proc } from '@internal/proc';
+
+export type ResponseErrorOptions = (
+  | {
+      message: string;
+    }
+  | {
+      status: number;
+      statusText: string;
+    }
+) & {
+  resText: string;
+  proc?: Proc;
+};
+
+export class ResponseError extends Error {
+  constructor({ resText, proc, ...options }: ResponseErrorOptions) {
+    const message =
+      'message' in options
+        ? options.message
+        : `Status is not 200, got status ${options.status} ${options.statusText} and body:\n${resText}`;
+    super(message);
+    this.name = 'ResponseError';
+    if (proc != null && resText.includes('Unexpected')) {
+      process.stderr.write(proc.getStd('both'));
+    }
+    Error.captureStackTrace(this, this.constructor);
+  }
+}

internal/env/src/index.ts

@@ -141,3 +141,14 @@ export function getNodeVer(): {
   const [major, minor, patch] = process.versions.node.split('.').map(Number);
   return { major: major || NaN, minor: minor || NaN, patch: patch || NaN };
 }
+
+/**
+ * Whether the federation query planner is using Hive Router node-addon for query planning.
+ * @experimental
+ */
+export function usingHiveRouterRuntime(): boolean {
+  // @ts-expect-error - pkgroll needs this for dead code elimination
+  return process.env.HIVE_ROUTER_RUNTIME === '1';
+}
+
+export { ResponseError } from './ResponseError.js';

internal/heapsnapshot/dist/HeapSnapshotLoader-00ODhOoc.js → internal/heapsnapshot/dist/HeapSnapshotLoader-BRkJkvg1.js

@@ -4160,6 +4160,119 @@ var HeapSnapshot$1 = /*#__PURE__*/Object.freeze({
   serializeUIString: serializeUIString
 });
 
+const kFakePromise = Symbol.for('@whatwg-node/promise-helpers/FakePromise');
+function isPromise(value) {
+    return value?.then != null;
+}
+function isActualPromise(value) {
+    const maybePromise = value;
+    return maybePromise && maybePromise.then && maybePromise.catch && maybePromise.finally;
+}
+function fakePromise(value) {
+    if (value && isActualPromise(value)) {
+        return value;
+    }
+    if (isPromise(value)) {
+        return {
+            then: (resolve, reject) => fakePromise(value.then(resolve, reject)),
+            catch: reject => fakePromise(value.then(res => res, reject)),
+            finally: cb => fakePromise(cb ? promiseLikeFinally(value, cb) : value),
+            [Symbol.toStringTag]: 'Promise',
+        };
+    }
+    // Write a fake promise to avoid the promise constructor
+    // being called with `new Promise` in the browser.
+    return {
+        then(resolve) {
+            if (resolve) {
+                try {
+                    return fakePromise(resolve(value));
+                }
+                catch (err) {
+                    return fakeRejectPromise(err);
+                }
+            }
+            return this;
+        },
+        catch() {
+            return this;
+        },
+        finally(cb) {
+            if (cb) {
+                try {
+                    return fakePromise(cb()).then(() => value, () => value);
+                }
+                catch (err) {
+                    return fakeRejectPromise(err);
+                }
+            }
+            return this;
+        },
+        [Symbol.toStringTag]: 'Promise',
+        __fakePromiseValue: value,
+        [kFakePromise]: 'resolved',
+    };
+}
+function fakeRejectPromise(error) {
+    return {
+        then(_resolve, reject) {
+            if (reject) {
+                try {
+                    return fakePromise(reject(error));
+                }
+                catch (err) {
+                    return fakeRejectPromise(err);
+                }
+            }
+            return this;
+        },
+        catch(reject) {
+            if (reject) {
+                try {
+                    return fakePromise(reject(error));
+                }
+                catch (err) {
+                    return fakeRejectPromise(err);
+                }
+            }
+            return this;
+        },
+        finally(cb) {
+            if (cb) {
+                try {
+                    cb();
+                }
+                catch (err) {
+                    return fakeRejectPromise(err);
+                }
+            }
+            return this;
+        },
+        __fakeRejectError: error,
+        [Symbol.toStringTag]: 'Promise',
+        [kFakePromise]: 'rejected',
+    };
+}
+function promiseLikeFinally(value, onFinally) {
+    if ('finally' in value) {
+        return value.finally(onFinally);
+    }
+    return value.then(res => {
+        const finallyRes = onFinally();
+        return isPromise(finallyRes) ? finallyRes.then(() => res) : res;
+    }, err => {
+        const finallyRes = onFinally();
+        if (isPromise(finallyRes)) {
+            return finallyRes.then(() => {
+                throw err;
+            });
+        }
+        else {
+            throw err;
+        }
+    });
+}
+
 class HeapSnapshotWorkerDispatcher {
   // TODO(crbug.com/1172300) Ignored during the jsdoc to ts migration)
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -4426,7 +4539,7 @@ class HeapSnapshotLoader {
   }
   #fetchChunk() {
     if (this.#buffer.length > 0) {
-      return Promise.resolve(this.#buffer.shift());
+      return fakePromise(this.#buffer.shift());
     }
     const { promise, resolve } = withResolvers();
     this.#dataCallback = resolve;

internal/heapsnapshot/dist/heap_snapshot_worker-entrypoint.js

@@ -1,5 +1,5 @@
 import { parentPort } from 'node:worker_threads';
-import { P as HeapSnapshotWorkerDispatcher } from './HeapSnapshotLoader-00ODhOoc.js';
+import { P as HeapSnapshotWorkerDispatcher } from './HeapSnapshotLoader-BRkJkvg1.js';
 
 const dispatcher = new HeapSnapshotWorkerDispatcher(
   parentPort.postMessage.bind(parentPort)

internal/heapsnapshot/dist/index.js

@@ -1,5 +1,5 @@
-import { H as HeapSnapshotLoader, a as HeapSnapshotProgress } from './HeapSnapshotLoader-00ODhOoc.js';
-export { z as Aggregate, B as AggregateForDiff, A as AllocationNodeCallers, y as AllocationStackFrame, F as ComparatorConfig, D as Diff, C as DiffForClass, E as Edge, m as HeapSnapshot, b as HeapSnapshotEdge, d as HeapSnapshotEdgeIndexProvider, f as HeapSnapshotEdgeIterator, o as HeapSnapshotEdgesProvider, l as HeapSnapshotFilteredIterator, k as HeapSnapshotIndexRangeIterator, n as HeapSnapshotItemProvider, i as HeapSnapshotNode, c as HeapSnapshotNodeIndexProvider, j as HeapSnapshotNodeIterator, p as HeapSnapshotNodesProvider, u as HeapSnapshotProgressEvent, g as HeapSnapshotRetainerEdge, e as HeapSnapshotRetainerEdgeIndexProvider, h as HeapSnapshotRetainerEdgeIterator, I as ItemsRange, J as JSHeapSnapshot, r as JSHeapSnapshotEdge, q as JSHeapSnapshotNode, t as JSHeapSnapshotRetainerEdge, O as Location, N as Node, K as NodeFilter, M as Samples, L as SearchConfig, S as SecondaryInitManager, x as SerializedAllocationNode, G as StaticData, W as WorkerCommand, v as baseSystemDistance, w as baseUnreachableDistance, s as serializeUIString } from './HeapSnapshotLoader-00ODhOoc.js';
+import { H as HeapSnapshotLoader, a as HeapSnapshotProgress } from './HeapSnapshotLoader-BRkJkvg1.js';
+export { z as Aggregate, B as AggregateForDiff, A as AllocationNodeCallers, y as AllocationStackFrame, F as ComparatorConfig, D as Diff, C as DiffForClass, E as Edge, m as HeapSnapshot, b as HeapSnapshotEdge, d as HeapSnapshotEdgeIndexProvider, f as HeapSnapshotEdgeIterator, o as HeapSnapshotEdgesProvider, l as HeapSnapshotFilteredIterator, k as HeapSnapshotIndexRangeIterator, n as HeapSnapshotItemProvider, i as HeapSnapshotNode, c as HeapSnapshotNodeIndexProvider, j as HeapSnapshotNodeIterator, p as HeapSnapshotNodesProvider, u as HeapSnapshotProgressEvent, g as HeapSnapshotRetainerEdge, e as HeapSnapshotRetainerEdgeIndexProvider, h as HeapSnapshotRetainerEdgeIterator, I as ItemsRange, J as JSHeapSnapshot, r as JSHeapSnapshotEdge, q as JSHeapSnapshotNode, t as JSHeapSnapshotRetainerEdge, O as Location, N as Node, K as NodeFilter, M as Samples, L as SearchConfig, S as SecondaryInitManager, x as SerializedAllocationNode, G as StaticData, W as WorkerCommand, v as baseSystemDistance, w as baseUnreachableDistance, s as serializeUIString } from './HeapSnapshotLoader-BRkJkvg1.js';
 import path from 'node:path';
 import { fileURLToPath, URL } from 'node:url';
 import { Worker } from 'node:worker_threads';