@graphql-yoga/plugin-defer-stream

Changelog for @graphql-yoga/plugin-defer-stream: every release with its changes and the pull requests behind them.

4.0.0

Major Changes

#4574 79b0e8b Thanks @egoodwinx! - ### Breaking Changes
- Node: minimum supported version is now Node 22. Node 18 and 20 are no longer supported. Future releases will only support Node >=22.
- GraphQL: minimum supported version is now GraphQL 16. GraphQL 14 and 15 are no longer supported.
- Request body parsing: Yoga now limits request bodies to 25,000,000 bytes by default. Enforcing this limit streams the body through a byte counter, making POST body parsing asynchronous even for an in-memory body. As a result, yoga.fetch() can return a Promise where it previously returned a synchronous Response, even when all resolvers and plugins are synchronous.
Migration
- If you’re on Node 18/20, upgrade to Node 22 or later before upgrading this package.
- If you’re on graphql 14/15, upgrade to graphql 16 or 17 first.
- Await yoga.fetch() and response body parsing instead of relying on synchronous results. Set maxRequestBodySize: false in createYoga to disable the body-size limit and preserve synchronous parsing for in-memory bodies, but only if you enforce an appropriate request-body limit elsewhere.
#4623 be89d05 Thanks @ardatan! - ### Dependencies
- Bump @graphql-tools/utils to ^13.1.1, @graphql-tools/schema to ^11.0.0, and @graphql-tools/executor to ^4.1.2.
Incremental delivery

Yoga maps the GraphQL HTTP Accept header through INCREMENTAL_DELIVERY_SPECS from @graphql-tools/utils onto executor incrementalSpec. multipart/mixed;incrementalSpec=v0.2 runs the v0.2 payload format and echoes that spec on Content-Type. multipart/mixed;deferSpec=20220824 or bare multipart/mixed stays on v0.1. An unsupported incremental spec yields 406.

A later incremental spec is a graphql-tools table row plus an executor publisher. Yoga, Hive Gateway, and HTTP executors pick it up by bumping @graphql-tools/utils / @graphql-tools/executor.

Breaking Changes
- createGraphQLError is removed. Use new GraphQLError(message, options) from graphql. To attach Yoga’s experimental schema coordinate, use withSchemaCoordinate(error, coordinate) and read with getSchemaCoordinate from @graphql-tools/utils.
- mapMaybePromise is removed (was exported from Yoga / @envelop/core). Use handleMaybePromise from @whatwg-node/promise-helpers.
- Yoga no longer re-exports helpers that already live upstream:
  - getSchemaCoordinate -> @graphql-tools/utils
  - mergeSchemas -> @graphql-tools/schema
  - DisposableSymbols -> @whatwg-node/server
  - mapAsyncIterator / isPromise / fakePromise / handleMaybePromise / MaybePromise -> @whatwg-node/promise-helpers
- @envelop/core utils no longer re-exports mapAsyncIterator or isPromise. Import from @whatwg-node/promise-helpers.
- Use asGetArgumentValuesVariables / coerceGetVariableValuesResult from @graphql-tools/utils for GraphQL 16/17 VariableValues compatibility.
Migration
```
import { GraphQLError } from 'graphql'
import { withSchemaCoordinate } from 'graphql-yoga'
import { mergeSchemas } from '@graphql-tools/schema'
import { getSchemaCoordinate } from '@graphql-tools/utils'
import { handleMaybePromise, isPromise, type MaybePromise } from '@whatwg-node/promise-helpers'
import { DisposableSymbols } from '@whatwg-node/server'

throw withSchemaCoordinate(new GraphQLError('not found'), 'Query.user')
```

Patch Changes

Updated dependencies [862447a, 79b0e8b, be89d05, 5334079, 79b0e8b]:
- graphql-yoga@6.0.0

3.24.6

Patch Changes

Updated dependencies [9294289]:
- graphql-yoga@5.24.6

3.24.5

Patch Changes

Updated dependencies []:
- graphql-yoga@5.24.5

3.24.4

Patch Changes

#4607 d8b8860 Thanks @enisdenjo! - dependencies updates:
- Updated dependency @graphql-tools/utils@^12.0.3 ↗︎ (from ^11.2.2, in dependencies)
Updated dependencies [d8b8860]:
- graphql-yoga@5.24.4

3.24.3

Patch Changes

#4604 c6febdc Thanks @enisdenjo! - dependencies updates:
- Updated dependency @graphql-tools/utils@^11.2.2 ↗︎ (from ^11.2.0, in dependencies)
Updated dependencies [c6febdc]:
- graphql-yoga@5.24.3

3.24.2

Patch Changes

Updated dependencies [c08efde]:
- graphql-yoga@5.24.2

3.24.1

Patch Changes

Updated dependencies [c6a9aa4]:
- graphql-yoga@5.24.1

3.24.0

Patch Changes

#4577 7bff35c Thanks @egoodwinx! - Add homepage and bugs.url to package.json files
Updated dependencies [7bff35c, 3763aca]:
- graphql-yoga@5.24.0

3.23.0

Patch Changes

Updated dependencies [c80f43c, d3b4164]:
- graphql-yoga@5.23.0

3.22.0

Minor Changes

#4545 94ebe5b Thanks @egoodwinx! - Update to support graphql-js 17

Bump package versions, fix expected typing, and update compatability with subscribe.

Patch Changes

Updated dependencies [94ebe5b]:
- graphql-yoga@5.22.0

3.21.3

Patch Changes

Updated dependencies [04014d2]:
- graphql-yoga@5.21.3

3.21.2

Patch Changes

Updated dependencies [39b55ba]:
- graphql-yoga@5.21.2

3.21.1

Patch Changes

#4450 08c3cb6 Thanks @ardatan! - When adding the defer and stream directives to the schema, we need to make sure to also move the extensions from the old schema to the new one, otherwise we might lose important information like plugin metadata.
Updated dependencies [4b43efd]:
- graphql-yoga@5.21.1

3.21.0

Patch Changes

Updated dependencies [e263f7e]:
- graphql-yoga@5.21.0

3.20.0

Patch Changes

Updated dependencies [93f1dc0]:
- graphql-yoga@5.20.0

3.19.0

Patch Changes

Updated dependencies [7e0aaf6]:
- graphql-yoga@5.19.0

3.18.1

Patch Changes

Updated dependencies [9a221c3, f98149a]:
- graphql-yoga@5.18.1

3.18.0

Patch Changes

Updated dependencies [3eabd17]:
- graphql-yoga@5.18.0

3.17.1

Patch Changes

Updated dependencies [c27f550]:
- graphql-yoga@5.17.1

3.17.0

Patch Changes

#4288 66c370c Thanks @EmrysMyrddin! - dependencies updates:
- Updated dependency @graphql-tools/utils@^10.11.0 ↗︎ (from ^10.6.1, in dependencies)
Updated dependencies [66c370c, 66c370c]:
- graphql-yoga@5.17.0

3.16.2

Patch Changes

Updated dependencies [ba38629]:
- graphql-yoga@5.16.2

3.16.1

Patch Changes

Updated dependencies [6f83cea, e1f52b6, 6f83cea]:
- graphql-yoga@5.16.1

3.16.0

Patch Changes

Updated dependencies [a4e1c5f, 0a7a635]:
- graphql-yoga@5.16.0

3.15.2

Patch Changes

Updated dependencies [e7b8906]:
- graphql-yoga@5.15.2

3.15.1

Patch Changes

Updated dependencies [ecd605b]:
- graphql-yoga@5.15.1

3.15.0

Patch Changes

Updated dependencies [ccb5c53, ccb5c53]:
- graphql-yoga@5.15.0

3.14.0

Patch Changes

Updated dependencies [5f75a42, 98c82a5, 98c82a5]:
- graphql-yoga@5.14.0

3.13.5

Patch Changes

Updated dependencies [8b41a52]:
- graphql-yoga@5.13.5

3.13.4

Patch Changes

#3995 000c33d Thanks @enisdenjo! - Update whatwg-node packages

In light of https://github.com/ardatan/whatwg-node/pull/2305. Please upgrade as soon as possible!
Updated dependencies [000c33d]:
- graphql-yoga@5.13.4

3.13.3

Patch Changes

#3930 3a7ef74 Thanks @ardatan! - Bump @whatwg-node/server
Updated dependencies [1773c8c, 3a7ef74]:
- graphql-yoga@5.13.3

3.13.2

Patch Changes

Updated dependencies [abe91bd, 9311842]:
- graphql-yoga@5.13.2

3.13.1

Patch Changes

Updated dependencies [dee7995]:
- graphql-yoga@5.13.1

3.13.0

Patch Changes

Updated dependencies [63b78d5, 63b78d5, 6ed67e8]:
- graphql-yoga@5.13.0

3.12.2

Patch Changes

Updated dependencies [a6b3de9]:
- graphql-yoga@5.12.2

3.12.1

Patch Changes

Updated dependencies [fbf328c]:
- graphql-yoga@5.12.1

3.12.0

Patch Changes

Updated dependencies [96498ee, 5150146, 5150146]:
- graphql-yoga@5.12.0

3.11.0

Patch Changes

Updated dependencies [5fd15b8, d13b8a4]:
- graphql-yoga@5.11.0

3.10.11

Patch Changes

Updated dependencies [1c055f5]:
- graphql-yoga@5.10.11

3.10.10

Patch Changes

Updated dependencies []:
- graphql-yoga@5.10.10

3.10.9

Patch Changes

Updated dependencies [d24c5d5, d24c5d5]:
- graphql-yoga@5.10.9

3.10.8

Patch Changes

Updated dependencies [ed344ea]:
- graphql-yoga@5.10.8

3.10.7

Patch Changes

Updated dependencies [8fee214, 1df4912]:
- graphql-yoga@5.10.7

3.10.6

Patch Changes

Updated dependencies [121ccba]:
- graphql-yoga@5.10.6

3.10.5

Patch Changes

Updated dependencies [eca7cd1, 05fe345]:
- graphql-yoga@5.10.5

3.10.4

Patch Changes

#3520 944ecd5 Thanks @ardatan! - dependencies updates:
- Updated dependency @graphql-tools/utils@^10.6.1 ↗︎ (from ^10.0.0, in dependencies)
Updated dependencies [944ecd5]:
- graphql-yoga@5.10.4

3.10.3

Patch Changes

#3501 c93366d Thanks @enisdenjo! - Update transport executors containing improvements and fixes
Updated dependencies [c93366d, c93366d]:
- graphql-yoga@5.10.3

3.10.2

Patch Changes

Updated dependencies [7a413bc, 7a413bc]:
- graphql-yoga@5.10.2

3.10.1

Patch Changes

Updated dependencies [20cd9b6]:
- graphql-yoga@5.10.1

3.10.0

Patch Changes

Updated dependencies [f81501c]:
- graphql-yoga@5.10.0

3.9.0

Patch Changes

Updated dependencies [2523d9f, 87ee333]:
- graphql-yoga@5.9.0

3.8.0

Patch Changes

Updated dependencies [18fe916, 6bb19ed]:
- graphql-yoga@5.8.0

3.7.0

Patch Changes

Updated dependencies [5dae4ab, 5dae4ab, 5dae4ab, 5dae4ab]:
- graphql-yoga@5.7.0

3.6.3

Patch Changes

Updated dependencies [0866c1b]:
- graphql-yoga@5.6.3

3.6.2

Patch Changes

Updated dependencies [b7bf47b, 81a736b]:
- graphql-yoga@5.6.2

3.6.1

Patch Changes

Updated dependencies [4252e3d]:
- graphql-yoga@5.6.1

3.6.0

Patch Changes

Updated dependencies [9f3f945]:
- graphql-yoga@5.6.0

3.5.0

Patch Changes

Updated dependencies [0208024]:
- graphql-yoga@5.5.0

3.4.0

Patch Changes

#3300 fdd902c Thanks @EmrysMyrddin! - dependencies updates:
- Updated dependency graphql-yoga@workspace:^ ↗︎ (from ^5.3.1, in peerDependencies)
Updated dependencies [4cd43b9, fdd902c, d5dfe99, 7335a82, f9aa1cd]:
- graphql-yoga@5.4.0

3.3.1

Patch Changes

Updated dependencies [3324bbab, 3324bbab]:
- graphql-yoga@5.3.1

3.3.0

Patch Changes

Updated dependencies [f775b341, f775b341, f89a1aa2]:
- graphql-yoga@5.3.0

3.2.0

Patch Changes

Updated dependencies [71db7548, 71db7548]:
- graphql-yoga@5.2.0

3.1.1

Patch Changes

Updated dependencies [3ef877a7]:
- graphql-yoga@5.1.1

3.1.0

Patch Changes

Updated dependencies [b1f0e3a2]:
- graphql-yoga@5.1.0

3.0.3

Patch Changes

Updated dependencies [77d107fe]:
- graphql-yoga@5.0.2

3.0.2

Patch Changes

Updated dependencies [3fea19f2]:
- graphql-yoga@5.0.1

3.0.1

Patch Changes

#3118 694e78b9 Thanks @enisdenjo! - Bump @graphql-tools/executor-http for better SSE stream chunks and messages handling

3.0.0

Major Changes

#3063 01430e03 Thanks @EmrysMyrddin! - Breaking Change: Drop support of Node.js 16

Patch Changes

Updated dependencies [01430e03, 5b615478, 350bb851]:
- graphql-yoga@5.0.0

2.0.5

Patch Changes

Updated dependencies [bf602edf]:
- graphql-yoga@4.0.5

2.0.4

Patch Changes

Updated dependencies [5f182006]:
- graphql-yoga@4.0.4

2.0.3

Patch Changes

Updated dependencies [5efb8250]:
- graphql-yoga@4.0.3

2.0.2

Patch Changes

Updated dependencies [ce6d2465]:
- graphql-yoga@4.0.2

2.0.1

Patch Changes

Updated dependencies [bb739b05, 8f7d7abc]:
- graphql-yoga@4.0.1

2.0.0

Major Changes

#2767 4228c1d5 Thanks @renovate! - Drop support for Node.js 14. Require Node.js >=16.

Patch Changes

Updated dependencies [4228c1d5, 34ecb4bb, ec318fe6, cc370691, b309ca0d, dd699c4b, 4228c1d5, 0522c740]:
- graphql-yoga@4.0.0

1.9.1

Patch Changes

#2686 c50ea51c Thanks @n1ru4l! - dependencies updates:
- Updated dependency @graphql-tools/utils@^9.2.1 ↗︎ (from ^9.0.1, in dependencies)
Updated dependencies [e1a60e21, c50ea51c, c50ea51c]:
- graphql-yoga@3.9.1

1.9.0

Patch Changes

Updated dependencies [aff69200]:
- graphql-yoga@3.9.0

1.8.1

Patch Changes

Updated dependencies [ebb65b14, 528941cb]:
- graphql-yoga@3.8.1

1.8.0

Patch Changes

Updated dependencies [99b72696, 99b72696, 09d23a4b]:
- graphql-yoga@3.8.0

1.7.3

Patch Changes

Updated dependencies [46e75917]:
- graphql-yoga@3.7.3

1.7.2

Patch Changes

Updated dependencies [7ad50529]:
- graphql-yoga@3.7.2

1.7.1

Patch Changes

Updated dependencies [9fdd94b5, 47b1c4a4, 02ac055c, 02ac055c]:
- graphql-yoga@3.7.1

1.7.0

Patch Changes

Updated dependencies [23d1b26c, 9e743db5, 23d1b26c]:
- graphql-yoga@3.7.0

1.6.1

Patch Changes

Updated dependencies [3c8c8434]:
- graphql-yoga@3.6.1

1.6.0

Patch Changes

Updated dependencies [790330be, 6bc1410f, ddb2607d, 6bc1410f, 1caac99b, 790330be, 7587d5c5, cc0d3899, a747d249, 2933fc89, 543e490b]:
- graphql-yoga@3.6.0

1.5.1

Patch Changes

Updated dependencies [3a8446df]:
- graphql-yoga@3.5.1

1.5.0

Patch Changes

Updated dependencies [03597a5a]:
- graphql-yoga@3.5.0

1.4.1

Patch Changes

#2254 00843174 Thanks @ardatan! - Use the new fetch implementation
Updated dependencies [00843174, 00843174]:
- graphql-yoga@3.4.1

1.4.0

Patch Changes

Updated dependencies [76c1ecb9, 8cd8b5a5, 6e8bddba, 6ee252db, 8f139e15, 9beef914, c46d75e8, f9ab8a70]:
- graphql-yoga@3.4.0

1.3.1

Patch Changes

Updated dependencies [d4dab446]:
- graphql-yoga@3.3.1

1.3.0

Patch Changes

#2266 3e5f688f Thanks @ardatan! - Accept URL patterns like /:path and * in graphqlEndpoint
Updated dependencies [3e5f688f, 3e5f688f, 8b288a23]:
- graphql-yoga@3.3.0

1.2.1

Patch Changes

Updated dependencies [5528d312]:
- graphql-yoga@3.2.1

1.2.0

Patch Changes

Updated dependencies [a86aaa0f, 82f58934, 290c7f7f]:
- graphql-yoga@3.2.0

1.1.2

Patch Changes

Updated dependencies [c5b1cc46, c152105e, 26d780cd, d2958781]:
- graphql-yoga@3.1.2

1.1.1

Patch Changes

Updated dependencies [534780c9]:
- graphql-yoga@3.1.1

1.1.0

Patch Changes

Updated dependencies [86fe453c, ea81e1dd, ea81e1dd]:
- graphql-yoga@3.1.0

1.0.3

Patch Changes

Updated dependencies [491ef5da]:
- graphql-yoga@3.0.3

1.0.2

Patch Changes

Updated dependencies [0007c58d, 39a8fe89]:
- graphql-yoga@3.0.2

1.0.1

Patch Changes

Updated dependencies [d63fe841]:
- graphql-yoga@3.0.1

1.0.0

Patch Changes

73e56068 Thanks @ardatan! - Fix cancellation logic for defer/stream queries.
Updated dependencies [2e0c4824, 8773a27f, 720898db, 9f991a27, 6e250209, cebca219, eeaced00, 74e1f830, e7a47b56, 5f5b1160, 1d7f810a, 209b1620, 098e139f, 73e56068, 02d2aecd, 74e1f830, c4b3a9c8, b079c93b, 71554172, b19a9104, 1d5cde96, 44878a5b, 1d508495]:
- graphql-yoga@3.0.0

1.0.0-next.2

Patch Changes

73e56068 Thanks @ardatan! - Fix cancellation logic for defer/stream queries
Updated dependencies [73e56068]:
- graphql-yoga@3.0.0-next.12

1.0.0-next.1

Patch Changes

Updated dependencies [720898db, 9f991a27, ef191eee]:
- graphql-yoga@3.0.0-next.11

0.0.1-next.0

Patch Changes

#1997 8773a27f Thanks @saihaj! - plugin to enable defer stream in yoga
Updated dependencies [8773a27f, cedde92f, bf69a561]:
- graphql-yoga@3.0.0-next.10