fix(runtime): compare the results from factory functions correctly #420

ardatan · 2025-01-08T11:48:00Z

Fixes #419

Leave the supergraph configuration handling logic to fusion-runtime package so it can compare bare read supergraph sdl directly inside unified graph manager to decide if the supergraph has changed.
Before, it was parsed by gateway runtime and printed sdls might be different on manager side, so it was wrongly assuming that supergraph has changed whenever the supergraph fetcher has given by the user as a factory function.

Another set of improvements;

In case of schema reload, throw SCHEMA_RELOAD error while recreating the transports and executors
In case of shut down, throw SHUTTING_DOWN error while cleaning the transports and executors up

Previously, these errors are only thrown for subscriptions, it wasn't thrown in other type of operations as well.
And previously the thrown errors during these two cleanup and restart process were cryptic, now the mentioned two errors above are thrown with more clear messages

No more timers
Instead of setTimeout, on each request as we do on initial request, we compare the last fetch time and the current time to see if the supergraph should be refetched. We use a shared promise here to prevent race condition.
This will relax the usage in serverless, because some serverless envs complain about timers.
It will also relax the event loop which won't be busy if there is no request in the background.
In case of clustering, it will also relax the supergraph source, because when there is setTimeout, all members of the cluster will send requests at the same time to the source(CDN etc). Now they will make those requests lazily.

theguild-bot · 2025-01-10T08:40:59Z

🚀 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/executor-http`	`1.2.5-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-tools/federation`	`3.0.9-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/fusion-runtime`	`0.10.29-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-hive/gateway`	`1.7.9-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/plugin-opentelemetry`	`1.3.36-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/plugin-prometheus`	`1.3.24-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-hive/gateway-runtime`	`1.4.8-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/transport-common`	`0.7.27-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/transport-http`	`0.6.31-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/transport-http-callback`	`0.5.18-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/transport-ws`	`0.4.16-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413`	npm ↗︎ unpkg ↗︎

theguild-bot · 2025-01-10T08:43:37Z

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

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

theguild-bot · 2025-01-10T08:43:46Z

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

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

theguild-bot · 2025-01-10T08:44:39Z

🚀 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:1.7.9-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413-bun

theguild-bot · 2025-01-10T08:45:25Z

🚀 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:1.7.9-alpha-2f4a1173f1280a85a6f87d9c1ab2db7e2a48d413

theguild-bot · 2025-01-10T08:45:58Z

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

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

theguild-bot · 2025-01-10T08:52:28Z

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

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

packages/runtime/src/createGatewayRuntime.ts

enisdenjo

Aside from one small comment, LGTM.

fauna5 · 2025-01-10T12:07:46Z

Hey - i pulled the snapshot version 1.7.9-alpha-4221681019dfd2fd156d1f27570765f312fb6cd8 and the operation was not aborted. This fixes the issue we have for now. Thanks so much for getting on to this so quickly 🫶 This'll get us to a production deploy!

It still does abort when there is a schema change (this is much more rare, ~once/day). I guess it's a lot harder logic to allow the in-flight requests to complete on the old schema whilst validating new requests with the new schema. Keeping the old context around until all requests have completed.

However as a client, when that request is aborted we don't know if the downstream request passed or failed. We can add retry logic on the specific abort error. If the failed request is a non-idempotent mutation we'd need to investigate via extra reads and logic to see if the mutation is successful. Whilst it's a tiny edge-case that we will probably not see, it still is there.

One way around this is recycling our k8s pods on schema update, but that defies the point of the pollingInterval

ardatan · 2025-01-11T23:22:08Z

@fauna5 If you try the new alphas, the errors will be more clear in case of schema reload. With 503 status code and SCHEMA_RELOAD code inside the error, you will know that the gateway is reloading the schema. During the schema reload, any ongoing HTTP calls will be aborted and the execution will immediately be stopped to prevent leaks.
I think blocking the schema reload for those ongoing calls can be too much. Like you said, it is not that often, and can be solved with a retry logic.

Co-authored-by: Denis Badurina <[email protected]>

ardatan force-pushed the polling-disposal branch 3 times, most recently from 582b325 to 64e7a04 Compare January 8, 2025 12:09

ardatan changed the title ~~fix: dispose the executor only if the schema has changed~~ Reproduction #419 Jan 8, 2025

ardatan force-pushed the polling-disposal branch 2 times, most recently from 26f4a0a to 8d8c090 Compare January 8, 2025 21:41

ardatan mentioned this pull request Jan 9, 2025

Downstream requests aborted when refreshing schema #419

Closed

ardatan force-pushed the polling-disposal branch 2 times, most recently from a1f433b to c90f029 Compare January 9, 2025 13:09

ardatan changed the title ~~Reproduction #419~~ fix(runtime): compare the results from factory functions correctly Jan 9, 2025

ardatan marked this pull request as ready for review January 9, 2025 13:10

enisdenjo force-pushed the polling-disposal branch from 517f716 to 9def8f4 Compare January 9, 2025 15:40

ardatan requested review from Urigo, dotansimha and enisdenjo January 10, 2025 10:44

enisdenjo reviewed Jan 10, 2025

View reviewed changes

packages/runtime/src/createGatewayRuntime.ts Outdated Show resolved Hide resolved

enisdenjo approved these changes Jan 10, 2025

View reviewed changes

ardatan force-pushed the polling-disposal branch from f4c47f2 to c6ccdfd Compare January 10, 2025 22:45

ardatan marked this pull request as draft January 11, 2025 15:29

ardatan marked this pull request as ready for review January 11, 2025 23:14

ardatan requested a review from enisdenjo January 11, 2025 23:22

ardatan and others added 26 commits January 15, 2025 15:29

Fix

9eef7cd

Fix

5500587

Add supergraph to Docker instance

8bada1d

Fix for Docker

291aa5f

Changeset

6f93fb5

Update packages/runtime/src/createGatewayRuntime.ts

b218545

Co-authored-by: Denis Badurina <[email protected]>

isUrl

c6701a6

..

94e66a1

Check if AST

10a49a1

Better error messages

541d9f8

..

75ffefd

Fix Bun

2143296

Fix bun

9e234a6

Changeset

801c499

Lazy polling mechanism

82dbdff

chore(dependencies): updated changesets for modified dependencies

cdc582f

Fix lockfile

bdbcf26

Bump versions

ce2cfcb

Fix bun tests

a6253cc

chore(dependencies): updated changesets for modified dependencies

13555cb

Fix bun tests

a08114e

WS

c7702f6

Fix

6a8e784

..

9e59849

Reduce dif

9e86ccd

Apply suggestions

2f4a117

ardatan force-pushed the polling-disposal branch from 1409d49 to 2f4a117 Compare January 15, 2025 12:30

ardatan merged commit 14152f7 into main Jan 15, 2025
31 checks passed

ardatan deleted the polling-disposal branch January 15, 2025 12:31

theguild-bot mentioned this pull request Jan 15, 2025

Upcoming Release Changes #452

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(runtime): compare the results from factory functions correctly #420

fix(runtime): compare the results from factory functions correctly #420

ardatan commented Jan 8, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

enisdenjo left a comment

fauna5 commented Jan 10, 2025 •

edited

Loading

ardatan commented Jan 11, 2025

fix(runtime): compare the results from factory functions correctly #420

fix(runtime): compare the results from factory functions correctly #420

Conversation

ardatan commented Jan 8, 2025 • edited Loading

theguild-bot commented Jan 10, 2025 • edited Loading

🚀 Snapshot Release (alpha)

theguild-bot commented Jan 10, 2025 • edited Loading

🚀 Snapshot Release (Binary for Linux-X64)

theguild-bot commented Jan 10, 2025 • edited Loading

🚀 Snapshot Release (Binary for macOS-ARM64)

theguild-bot commented Jan 10, 2025 • edited Loading

🚀 Snapshot Release (Bun Docker Image)

theguild-bot commented Jan 10, 2025 • edited Loading

🚀 Snapshot Release (Node Docker Image)

theguild-bot commented Jan 10, 2025 • edited Loading

🚀 Snapshot Release (Binary for macOS-X64)

theguild-bot commented Jan 10, 2025 • edited Loading

🚀 Snapshot Release (Binary for Windows-X64)

enisdenjo left a comment

Choose a reason for hiding this comment

fauna5 commented Jan 10, 2025 • edited Loading

ardatan commented Jan 11, 2025

ardatan commented Jan 8, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

🚀 Snapshot Release (`alpha`)

theguild-bot commented Jan 10, 2025 •

edited

Loading

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

theguild-bot commented Jan 10, 2025 •

edited

Loading

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

theguild-bot commented Jan 10, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

theguild-bot commented Jan 10, 2025 •

edited

Loading

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

theguild-bot commented Jan 10, 2025 •

edited

Loading

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

fauna5 commented Jan 10, 2025 •

edited

Loading