Hive Gateway tester and testing utilities #1625

enisdenjo · 2025-10-24T12:57:30Z

import { createGatewayTester } from '@graphql-hive/gateway-testing';

{
  // will be disposed of on scope exit
  await using gw = createGatewayTester({
    subgraphs: [
      {
        name: 'helloer',
        schema: {
          typeDefs: /* GraphQL */ `
            type Query {
              hello: String
            }
          `,
          resolvers: {
            Query: {
              hello: () => 'world',
            },
          },
        },
      },
    ],
    // your gateway config for testing
    plugins: () => [
      // your plugins for testing
    ],
  });

  // gateway is running in supergraph mode

  const result = await gw.execute({
    query: /* GraphQL */ `
      query {
        hello
      }
    `,
  });

  // the complete lifecycle of the gateway has been run

  console.log(result); // { data: { hello: 'world' } }
}

TODO

Supergraph mode
Subgraph mode
Proxy mode
Explicit resource management (await using gw = createGatewayTester())
dispose() as alternative to await using
Hive Gateway Tester documentation console#7180
Refactor internal tests to use the tester
- A good chunk was refactored, but not all to avoid wasting time

theguild-bot · 2025-10-24T13:07:02Z

🚀 Snapshot Release (`alpha`)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package	Version	Info
`@graphql-tools/batch-delegate`	`10.0.2-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-tools/delegate`	`11.0.2-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-tools/federation`	`4.0.6-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/fusion-runtime`	`1.2.6-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-hive/gateway`	`2.1.11-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-hive/logger`	`1.0.7-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-hive/nestjs`	`2.0.16-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-hive/plugin-aws-sigv4`	`2.0.11-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-hive/plugin-opentelemetry`	`1.0.13-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/plugin-prometheus`	`2.0.14-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-hive/gateway-runtime`	`2.1.10-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-tools/stitch`	`10.0.3-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-tools/stitching-directives`	`4.0.2-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-hive/gateway-testing`	`1.0.0-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/transport-common`	`1.0.7-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/transport-http`	`1.0.7-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/transport-http-callback`	`1.0.7-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/transport-ws`	`2.0.7-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎
`@graphql-tools/wrap`	`11.0.2-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5`	npm ↗︎ unpkg ↗︎

theguild-bot · 2025-10-24T13:10:24Z

🚀 Snapshot Release (Binary for `macOS-ARM64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-10-24T13:10:49Z

🚀 Snapshot Release (Binary for `Linux-ARM64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-10-24T13:10:55Z

🚀 Snapshot Release (Binary for `Linux-X64`)

The latest changes of this PR are available for download (based on the declared changesets).

packages/testing/src/createGatewayTester.ts

theguild-bot · 2025-10-24T13:17:06Z

🚀 Snapshot Release (Node Docker Image)

The latest changes of this PR are available as image on GitHub Container Registry (based on the declared changesets):

ghcr.io/graphql-hive/gateway:2.1.11-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5

theguild-bot · 2025-10-24T13:17:42Z

🚀 Snapshot Release (Binary for `macOS-X64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-10-24T13:17:45Z

🚀 Snapshot Release (Bun Docker Image)

The latest changes of this PR are available as image on GitHub Container Registry (based on the declared changesets):

ghcr.io/graphql-hive/gateway:2.1.11-alpha-f555607556652b06a7b1e5c992d6d87454afc1e5-bun

theguild-bot · 2025-10-24T13:19:49Z

🚀 Snapshot Release (Binary for `Windows-X64`)

The latest changes of this PR are available for download (based on the declared changesets).

Copilot

Pull Request Overview

This PR introduces a new testing package (@graphql-hive/gateway-testing) that provides utilities for testing Hive Gateway configurations, supporting supergraph, subgraph composition, and proxy modes with explicit resource management through await using. The PR also refactors existing internal tests to use the new tester, demonstrating its usage across different testing scenarios.

Key changes:

New @graphql-hive/gateway-testing package with createGatewayTester utility
Support for explicit resource management (await using and manual dispose())
Refactored tests across multiple packages to use the new testing utilities

Reviewed Changes

Copilot reviewed 12 out of 14 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/testing/src/index.ts	Core implementation of the gateway tester with support for supergraph, subgraph, and proxy modes
packages/testing/package.json	Package configuration for the new testing utilities
packages/runtime/tests/upstream-timeout.test.ts	Refactored to use `createGatewayTester` instead of direct runtime creation
packages/runtime/tests/subscriptions.test.ts	Simplified subscription tests using the new tester utilities
packages/runtime/tests/propagateHeaders.spec.ts	Refactored header propagation tests with new testing approach
packages/runtime/src/types.ts	Exported previously internal interfaces for use in testing package
packages/plugins/prometheus/tests/prometheus.spec.ts	Updated Prometheus plugin tests to use gateway tester
packages/plugins/hmac-upstream-signature/tests/hmac-upstream-signature.spec.ts	Simplified HMAC signature tests with new testing utilities
packages/plugins/aws-sigv4/tests/aws-sigv4-outgoing.test.ts	Refactored AWS SigV4 outgoing request tests
packages/plugins/aws-sigv4/tests/aws-sigv4-incoming.test.ts	Updated AWS SigV4 incoming request tests with minor header type correction
.changeset/dry-numbers-deliver.md	Changeset documenting the new testing package
.changeset/@graphql-hive_plugin-aws-sigv4-1625-dependencies.md	Changeset documenting AWS SDK dependency update

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-27T16:21:14Z

packages/plugins/aws-sigv4/tests/aws-sigv4-incoming.test.ts

          'content-type': 'application/json',
          Host: 'sigv4examplegraphqlbucket.s3-eu-central-1.amazonaws.com',
-          'Content-Length': 30,
+          'Content-Length': '30',


The Content-Length header value has been changed from a number (30) to a string ('30'). This may indicate a breaking change in how headers are handled. Verify that the gateway and AWS SigV4 signing logic correctly handle Content-Length as a string, as HTTP headers are typically strings but the signature calculation might expect specific formatting.

Copilot · 2025-10-27T16:21:14Z

packages/plugins/aws-sigv4/tests/aws-sigv4-incoming.test.ts

          'content-type': 'application/json',
          Host: 'sigv4examplegraphqlbucket.s3-eu-central-1.amazonaws.com',
-          'Content-Length': 30,
+          'Content-Length': '30',


The Content-Length header value has been changed from a number (30) to a string ('30'). This may indicate a breaking change in how headers are handled. Verify that the gateway and AWS SigV4 signing logic correctly handle Content-Length as a string, as HTTP headers are typically strings but the signature calculation might expect specific formatting.

enisdenjo added 11 commits October 24, 2025 15:03

v0 gateway-testing

ee748a0

provide maybe yoga

825f7da

rename to simply testing

8f1f2a9

export necessary

3fe1550

try out

c36d6b3

use subgraph url

5de48c4

changeset

ac2c4bb

really test

d560b9a

easier build schema and better yoga provider

0959980

async disposable

2d4355f

update lockfile

9a72245

enisdenjo force-pushed the gateway-testing branch from 5caf53f to 9a72245 Compare October 24, 2025 13:03

ardatan reviewed Oct 24, 2025

View reviewed changes

packages/testing/src/createGatewayTester.ts Outdated Show resolved Hide resolved

dispose

a0bfd37

enisdenjo and others added 8 commits October 24, 2025 15:22

bun is ok now?

c758f4f

use build subgraph schema instead

76f75ec

chore(dependencies): updated changesets for modified dependencies

bd3d405

executor http is a dep

a00b314

no mask errors when testing

b9e8871

use yoga graphql endpoint for url

32071c8

refactor use gateway tester

f26cd28

tester host for whatever

8977282

enisdenjo added 14 commits October 27, 2025 13:16

aws outgoing

1a00156

proxy mode

4c85a61

unnecessary createyoga

aae0514

hmac signatures

aa8eb81

no createyoga in tester

f6cc854

support polling

b32b8ab

match mode types

cacff36

better fetch setter and susbiscrpns migrate

7e6c17b

start prop headers

36b9ff6

propagat hed teste

c86b839

debug enables logging

cb6291e

headers only for proxy

533f2a0

up tim

80cf1f9

tester in index because why not

23e9828

enisdenjo mentioned this pull request Oct 27, 2025

Hive Gateway Tester documentation graphql-hive/console#7180

Merged

unused

f555607

enisdenjo marked this pull request as ready for review October 27, 2025 16:20

Copilot AI review requested due to automatic review settings October 27, 2025 16:20

enisdenjo merged commit 357d931 into main Oct 27, 2025
19 checks passed

enisdenjo deleted the gateway-testing branch October 27, 2025 16:20

Copilot AI reviewed Oct 27, 2025

View reviewed changes

theguild-bot mentioned this pull request Oct 24, 2025

Upcoming Release Changes #1606

Merged

Hive Gateway tester and testing utilities #1625

Hive Gateway tester and testing utilities #1625

Uh oh!

Conversation

enisdenjo commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO

Uh oh!

theguild-bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (alpha)

Uh oh!

theguild-bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for macOS-ARM64)

Uh oh!

theguild-bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for Linux-ARM64)

Uh oh!

theguild-bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for Linux-X64)

Uh oh!

Uh oh!

theguild-bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Node Docker Image)

Uh oh!

theguild-bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for macOS-X64)

Uh oh!

theguild-bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Bun Docker Image)

Uh oh!

theguild-bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for Windows-X64)

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

enisdenjo commented Oct 24, 2025 •

edited

Loading

theguild-bot commented Oct 24, 2025 •

edited

Loading

🚀 Snapshot Release (`alpha`)

theguild-bot commented Oct 24, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `macOS-ARM64`)

theguild-bot commented Oct 24, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `Linux-ARM64`)

theguild-bot commented Oct 24, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `Linux-X64`)

theguild-bot commented Oct 24, 2025 •

edited

Loading

theguild-bot commented Oct 24, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `macOS-X64`)

theguild-bot commented Oct 24, 2025 •

edited

Loading

theguild-bot commented Oct 24, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `Windows-X64`)