Upcoming Release Changes (refs/heads/v3) (v3)

[github-actions]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to v3, this PR will be updated.

⚠️⚠️⚠️⚠️⚠️⚠️

v3 is currently in pre mode so this branch has prereleases rather than normal releases. If you want to exit prereleases, run changeset pre exit on v3.

⚠️⚠️⚠️⚠️⚠️⚠️

Releases

@graphql-yoga/[email protected]

Major Changes

• #1660 87d1070a Thanks @saihaj! - New Apollo Link

@graphql-yoga/[email protected]

Major Changes

• #1660 87d1070a Thanks @saihaj! - New URQL Exchange

@graphql-yoga/[email protected]

Major Changes

• #1660 2e0c4824 Thanks @saihaj! - Drop Node 12 Support

  GraphQL Yoga no longer supports Node 12 which is no longer an LTS version. GraphQL Yoga now needs Node 14 at least.

• #1660 f46addd7 Thanks @saihaj! - See the migration guide for more information;

  Migration from Yoga V2

Minor Changes

• #1359 5629a5cb Thanks @ardatan! - New setResult helper is available in onRequestParseDone hook to set ExecutionResult before any GraphQL specific process.

  You can check @graphql-yoga/plugin-response-cache's implementation to see how it can be useful.

  Also now onResultProcess and useResultProcessor hooks use generics to get more type-safety.

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

@graphql-yoga/[email protected]

Major Changes

• #1761 b2407c6a Thanks @ardatan! - BREAKING:

  • Drop TypedEvent in favor of CustomEvent
  • Use @whatwg-node/events as a ponyfill instead of @whatwg-node/fetch

Patch Changes

• Updated dependencies [b2407c6a]:
  • @graphql-yoga/[email protected]

@graphql-yoga/[email protected]

Major Changes

• #1761 b2407c6a Thanks @ardatan! - BREAKING:

  • Drop TypedEvent in favor of CustomEvent
  • Use @whatwg-node/events as a ponyfill instead of @whatwg-node/fetch

[email protected]

Major Changes

• #1660 2e0c4824 Thanks @saihaj! - Drop Node 12 Support

  GraphQL Yoga no longer supports Node 12 which is no longer an LTS version. GraphQL Yoga now needs Node 14 at least.

• #1660 f46addd7 Thanks @saihaj! - See the migration guide for more information;

  Migration from Yoga V2

• #1753 eeaced00 Thanks @ardatan! - schema no longer accepts an object of typeDefs and resolvers but instead you can use createSchema to create a GraphQL schema.

• #1516 209b1620 Thanks @ardatan! - Now it is possible to decide the returned Content-Type by specifying the Accept header. So if Accept header has text/event-stream without application/json, Yoga respects that returns text/event-stream instead of application/json.

• #1473 c4b3a9c8 Thanks @ardatan! - BREAKING: Remove GraphQLYogaError in favor of GraphQLError
  Check the documentation to see how to use GraphQLError

Minor Changes

• #1610 f4b23387 Thanks @ardatan! - Pass the parsed request as-is and validate the final GraphQLParams in useCheckGraphQLParams

• #1497 1d7f810a Thanks @ardatan! - Support a schema factory function that runs per request or a promise to be resolved before the first request.

  createYoga({
    schema(request: Request) {
      return getSchemaForToken(request.headers.get('x-my-token'))
    },
  })

  async function buildSchemaAsync() {
    const typeDefs = await fs.promises.readFile('./schema.graphql', 'utf8')
    const resolvers = await import('./resolvers.js')
    return makeExecutableSchema({ typeDefs, resolvers })
  }
  
  createYoga({
    schema: buildSchemaAsync(),
  })

• #1662 098e139f Thanks @ardatan! - - Batching RFC support with batchingLimit option to enable batching with an exact limit of requests per batch.

  • New onParams hook that takes a single GraphQLParams object
  • Changes in onRequestParse and onRequestParseDone hook
  • • Now onRequestParseDone receives the exact object that is passed by the request parser so it can be GraphQLParams or an array of GraphQLParams so use onParams if you need to manipulate batched execution params individually.

Patch Changes

• #1609 74e1f830 Thanks @enisdenjo! - usePreventMutationViaGET doesn't do assertion if it is not YogaContext, so it is possible to use Yoga's Envelop instance with other server implementations like graphql-ws.

• #1567 e7a47b56 Thanks @n1ru4l! - Handle invalid POST body gracefully; - Reject null - Reject non-object body - Reject invalid JSON body

• #1609 74e1f830 Thanks @enisdenjo! - Expose readonly graphqlEndpoint in YogaServerInstance

  const yoga = createYoga({
    /*...*/
  })
  console.log(yoga.graphqlEndpoint) // /graphql by default

• #1616 1d5cde96 Thanks @ardatan! - Support application/graphql-response+json as Accepted content type for the response

• Updated dependencies [b2407c6a]:

  • @graphql-yoga/[email protected]

@graphql-yoga/[email protected]

Major Changes

• #1660 2e0c4824 Thanks @saihaj! - Drop Node 12 Support

  GraphQL Yoga no longer supports Node 12 which is no longer an LTS version. GraphQL Yoga now needs Node 14 at least.

• #1660 f46addd7 Thanks @saihaj! - See the migration guide for more information;

  Migration from Yoga V2

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

@graphql-yoga/[email protected]

Major Changes

• #1621 66b87b02 Thanks @enisdenjo! - Implementation of Apollo's federated inline tracing

  Learn more how to enable inline tracing in the docs

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

@graphql-yoga/[email protected]

Major Changes

• #1137 3eebe6f2 Thanks @ardatan! - New Persisted Operations Plugin;
  https://www.graphql-yoga.com/v3/features/persisted-operations

  New Automatic Persisted Queries Plugin;
  https://www.graphql-yoga.com/v3/features/automatic-persisted-queries

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

@graphql-yoga/[email protected]

Major Changes

• #1137 3eebe6f2 Thanks @ardatan! - New Persisted Operations Plugin;
  https://www.graphql-yoga.com/v3/features/persisted-operations

  New Automatic Persisted Queries Plugin;
  https://www.graphql-yoga.com/v3/features/automatic-persisted-queries

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

@graphql-yoga/[email protected]

Major Changes

• #1359 5629a5cb Thanks @ardatan! - New Response Cache Plugin!!!

  On top of @envelop/response-cache, this new plugin allows you to skip execution phase even before all the GraphQL execution phases immediately after the GraphQL request parameters is parsed by Yoga.

  Also it doesn't need to have documentString stored in somewhere in order to get it back during the execution to generate the cache key.

  All the features of the same except for the following:

  • session factory function takes GraphQLParams and Request objects instead of GraphQL context as arguments.

    • type SessionIdFactory = (params: GraphQLParams, request: Request) => Maybe<string>

  • enabled function takes GraphQLParams and Request objects instead of GraphQL context as arguments.

    • type EnabledFn = (params: GraphQLParams, request: Request) => boolean

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

@graphql-yoga/[email protected]

Major Changes

• #1761 b2407c6a Thanks @ardatan! - BREAKING:

  • Drop TypedEvent in favor of CustomEvent
  • Use @whatwg-node/events as a ponyfill instead of @whatwg-node/fetch

Patch Changes

• Updated dependencies [b2407c6a]:
  • @graphql-yoga/[email protected]

@graphql-yoga/[email protected]

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

[email protected]

Patch Changes

• Updated dependencies [2e0c4824, f46addd7, f4b23387, eeaced00, 74e1f830, e7a47b56, 1d7f810a, 209b1620, 098e139f, 74e1f830, c4b3a9c8, 1d5cde96]:
  • [email protected]

[github-actions]

✅ Benchmark Results

     ✓ no_errors
     ✓ expected_result

     checks.........................: 100.00% ✓ 199774      ✗ 0    
     data_received..................: 30 MB   992 kB/s
     data_sent......................: 12 MB   383 kB/s
     http_req_blocked...............: avg=1.1µs    min=799ns    med=1µs      max=246.79µs p(90)=1.3µs    p(95)=1.6µs   
     http_req_connecting............: avg=0ns      min=0s       med=0s       max=99.49µs  p(90)=0s       p(95)=0s      
   ✓ http_req_duration..............: avg=232.93µs min=164.79µs med=211.39µs max=18.04ms  p(90)=248.79µs p(95)=283.06µs
       { expected_response:true }...: avg=232.93µs min=164.79µs med=211.39µs max=18.04ms  p(90)=248.79µs p(95)=283.06µs
     http_req_failed................: 0.00%   ✓ 0           ✗ 99887
     http_req_receiving.............: avg=17.42µs  min=10.3µs   med=16.1µs   max=5.39ms   p(90)=19.9µs   p(95)=22.29µs 
     http_req_sending...............: avg=5.79µs   min=3.9µs    med=4.59µs   max=8.01ms   p(90)=6µs      p(95)=7.7µs   
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=209.71µs min=142.59µs med=191.29µs max=17.95ms  p(90)=222.89µs p(95)=254.29µs
     http_reqs......................: 99887   3329.406468/s
     iteration_duration.............: avg=295.94µs min=218.99µs med=273.49µs max=18.48ms  p(90)=319.59µs p(95)=362.69µs
     iterations.....................: 99887   3329.406468/s
     vus............................: 1       min=1         max=1  
     vus_max........................: 1       min=1         max=1