Yoga
On this page

@graphql-yoga/plugin-response-cache

Changelog for @graphql-yoga/plugin-response-cache: 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.

Patch Changes

  • #4575 862447a Thanks @egoodwinx! - Use @graphql-hive/logger and add correlated, per-request logging (closes #4048)

    Every request now gets its own logger, available as context.log (and serverContext.log in plugin hooks), tagged with a requestId. Everything logged while handling a request can be correlated by that id.

    The request id is taken from the host integration if it already assigned one (e.g. Fastify’s request.id), otherwise from the incoming x-request-id header, otherwise generated. It is also sent back in the x-request-id response header. Configure it with the new requestId option:

    createYoga({
  requestId: {
    // don't trust the incoming header, recommended when clients can reach the server directly
    trustHeader: false,
    headerName: 'x-correlation-id',
    generateRequestId: () => myId()
  }
})

    Pass requestId: false to disable it.

    At the info level, a single “Request processed” line is logged per request with the method, path, operation name and type, response status, error count and duration. At the debug level, more details about request processing are logged.

    Masked errors are now logged with the request’s logger, so they can be traced back to the request that caused them. Custom maskError functions receive the request’s context as an optional fourth argument.

    The @envelop/newrelic, @envelop/auth0, @envelop/resource-limitations, @envelop/statsd, @envelop/graphql-jit, @envelop/response-cache and @envelop/response-cache-cloudflare-kv plugins accept a new log option for their own messages, instead of always writing to the console.

    @envelop/response-cache’s shouldCacheResult now also receives the GraphQL context.

    Breaking Changes

    • The @graphql-yoga/logger package has been removed. graphql-yoga re-exports Logger, MemoryLogWriter and LogLevel from @graphql-hive/logger instead.
    • createLogger and the YogaLogger type are no longer exported. Use new Logger(options) instead.
    • The logging option now takes boolean | Logger | LogLevel, where Logger is the one from @graphql-hive/logger.
    • yoga.logger has been renamed to yoga.log.
    • The logger option of useGraphiQL and useHealthCheck has been removed. They now log through the request’s logger.
    • @graphql-yoga/nestjs now logs through Nest’s Logger by default instead of not logging at all. Pass logging: false to keep the previous behaviour. logging: true on Fastify no longer logs through Fastify’s logger, pass it explicitly instead (see below).
    • @envelop/apollo-federation, @envelop/auth0, @envelop/graphql-jit, @envelop/newrelic, @envelop/resource-limitations, @envelop/response-cache, @envelop/response-cache-cloudflare-kv and @envelop/statsd now have a peer dependency on @graphql-hive/logger that you must install.
    • @envelop/apollo-federation’s logger option now expects a Logger from @graphql-hive/logger and defaults to new Logger() instead of console.

    Migration

    Create loggers with Logger:

    - import { createLogger } from 'graphql-yoga';
+ import { Logger } from 'graphql-yoga';

  createYoga({
-   logging: createLogger('debug'),
+   logging: new Logger({ level: 'debug' }),
  });

    Use log instead of logger on the Yoga instance:

      const plugin = {
    onYogaInit({ yoga }) {
-     yoga.logger.info('ready');
+     yoga.log.info('ready');
    },
  };

    Prefer the request-scoped logger inside resolvers and plugin hooks so the logs carry the request id:

    const resolvers = {
  Query: {
    hello: (_, __, context) => {
      context.log.debug('resolving hello')
      return 'world'
    }
  }
}

    If you use any of the @envelop/* plugins listed above, install the logger:

    npm i @graphql-hive/logger

    If you depended on @graphql-yoga/logger directly, switch to @graphql-hive/logger:

    - import { Logger } from '@graphql-yoga/logger';
+ import { Logger } from '@graphql-hive/logger';

    To keep logging through Fastify’s logger in @graphql-yoga/nestjs:

    import { Logger } from 'graphql-yoga'
import { PinoLogWriter } from '@graphql-hive/logger/writers/pino'

// in your yoga driver options
logging: new Logger({ writers: [new PinoLogWriter(app.log)] })

  • Updated dependencies [862447a, 79b0e8b, be89d05, 5334079, 79b0e8b]:

    • graphql-yoga@6.0.0
    • @envelop/response-cache@10.0.0
    • @envelop/core@6.0.0

3.26.6

Patch Changes

  • Updated dependencies [9fde867, 9294289]:
    • @envelop/response-cache@9.3.4
    • graphql-yoga@5.24.6

3.26.5

Patch Changes

  • Updated dependencies []:
    • graphql-yoga@5.24.5

3.26.4

Patch Changes

  • Updated dependencies [d8b8860, d8b8860]:
    • @envelop/response-cache@9.3.3
    • graphql-yoga@5.24.4

3.26.3

Patch Changes

  • Updated dependencies [c6febdc, c6febdc]:
    • @envelop/response-cache@9.3.2
    • graphql-yoga@5.24.3

3.26.2

Patch Changes

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

3.26.1

Patch Changes

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

3.26.0

Patch Changes

  • #4577 7bff35c Thanks @egoodwinx! - Add homepage and bugs.url to package.json files

  • Updated dependencies [7bff35c, 3763aca]:

    • @envelop/response-cache@9.3.1
    • @envelop/core@5.6.1
    • graphql-yoga@5.24.0

3.25.0

Patch Changes

3.24.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]:
    • @envelop/response-cache@9.2.0
    • @envelop/core@5.6.0
    • graphql-yoga@5.22.0

3.23.3

Patch Changes

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

3.23.2

Patch Changes

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

3.23.1

Patch Changes

  • #4492 fbd8436 Thanks @copilot-swe-agent! - Include the Last-Modified header in early 304 Not Modified responses returned by the response-cache plugin’s onRequest short-circuit path.

    Previously, this path returned only ETag. Now it returns both ETag and Last-Modified from cached response metadata so conditional revalidation responses are consistent with the original cached 200 response headers.

    This improves interoperability with HTTP intermediaries and edge caches that rely on both validators (If-None-Match and If-Modified-Since) during revalidation, helping avoid unstable cache states when only one validator is present in a 304 response.

  • Updated dependencies [4b43efd]:

    • graphql-yoga@5.21.1

3.23.0

Patch Changes

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

3.22.0

Patch Changes

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

3.21.0

Patch Changes

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

3.20.1

Patch Changes

3.20.0

Patch Changes

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

3.19.1

Patch Changes

3.19.0

Patch Changes

3.18.2

Patch Changes

3.18.1

Patch Changes

3.18.0

Patch Changes

  • #4184 3841884 Thanks @EmrysMyrddin! - Fix types for the cache option. Envelop cache implementations (redis and CloudFlare KV) are now usable without TS errors.
  • Updated dependencies [a4e1c5f, 0a7a635]:
    • graphql-yoga@5.16.0

3.17.2

Patch Changes

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

3.17.1

Patch Changes

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

3.17.0

Patch Changes

3.16.0

Patch Changes

3.15.6

Patch Changes

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

3.15.5

Patch Changes

  • Updated dependencies [000c33d]:
    • graphql-yoga@5.13.4

3.15.4

Patch Changes

3.15.3

Patch Changes

3.15.2

Patch Changes

3.15.1

Patch Changes

3.15.0

Patch Changes

3.14.2

Patch Changes

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

3.14.1

Patch Changes

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

3.14.0

Patch Changes

3.13.1

Patch Changes

  • #3759 bba7a83 Thanks @enisdenjo! - Provide cache key per oparation in a batched request

    Instead of per request, which would give out the same cache key for every operation in a batched request.

3.13.0

Patch Changes

3.12.11

Patch Changes

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

3.12.10

Patch Changes

  • Updated dependencies []:
    • graphql-yoga@5.10.10

3.12.9

Patch Changes

3.12.8

Patch Changes

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

3.12.7

Patch Changes

3.12.6

Patch Changes

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

3.12.5

Patch Changes

3.12.4

Patch Changes

  • #3520 944ecd5 Thanks @ardatan! - dependencies updates:

  • #3520 944ecd5 Thanks @ardatan! - Pass `context` to session and buildResponseCacheKey

    So now session can get the context to use the JWT token extracted by JWT Plugin for instance;

    useResponseCache({
  session: (req, ctx) => ctx.jwt.token
})

  • Updated dependencies [944ecd5]:

    • graphql-yoga@5.10.4

3.12.3

Patch Changes

3.12.2

Patch Changes

3.12.1

Patch Changes

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

3.12.0

Patch Changes

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

3.11.0

Patch Changes

3.10.0

Patch Changes

3.9.0

Patch Changes

3.8.3

Patch Changes

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

3.8.2

Patch Changes

3.8.1

Patch Changes

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

3.8.0

Patch Changes

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

3.7.0

Patch Changes

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

3.6.0

Patch Changes

3.5.1

Patch Changes

3.5.0

Patch Changes

3.4.0

Patch Changes

3.3.0

Minor Changes

  • #3164 353c0fed Thanks @n1ru4l! - Add servedFromResponseCache symbol property to responses served from the response cache in order to allow other plugins to determine, whether a response was served from the cache and apply custom logic based on that.

3.2.1

Patch Changes

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

3.2.0

Patch Changes

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

3.1.3

Patch Changes

3.1.2

Patch Changes

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

3.1.1

Patch Changes

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

3.1.0

Minor Changes

Patch Changes

3.0.0

Major Changes

Patch Changes

2.2.0

Minor Changes

Patch Changes

2.1.1

Patch Changes

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

2.1.0

Minor Changes

  • 96882491 Thanks @EmrysMyrddin! - Add @cacheControl directive to configure cache in a schema first approach

Patch Changes

2.0.2

Patch Changes

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

2.0.1

Patch Changes

2.0.0

Major Changes

Patch Changes

1.9.1

Patch Changes

1.9.0

Patch Changes

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

1.8.1

Patch Changes

1.8.0

Patch Changes

1.7.3

Patch Changes

1.7.2

Patch Changes

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

1.7.1

Patch Changes

1.7.0

Minor Changes

Patch Changes

1.6.1

Patch Changes

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

1.6.0

Patch Changes

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

1.4.0

Patch Changes

1.3.1

Patch Changes

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

1.3.0

Patch Changes

1.2.1

Patch Changes

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

1.2.0

Patch Changes

1.1.2

Patch Changes

1.1.1

Patch Changes

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

1.1.0

Patch Changes

1.0.3

Patch Changes

1.0.2

Patch Changes

1.0.1

Patch Changes

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

1.0.0

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

1.0.0-next.12

Patch Changes

  • Updated dependencies [73e56068]:
    • graphql-yoga@3.0.0-next.12

1.0.0-next.11

Patch Changes

1.0.0-next.10

Patch Changes

1.0.0-next.9

Patch Changes

1.0.0-next.8

Patch Changes

  • Updated dependencies [6e250209]:
    • graphql-yoga@3.0.0-next.8

1.0.0-next.7

Patch Changes

1.0.0-next.6

Patch Changes

  • Updated dependencies [dc45a7b5]:
    • graphql-yoga@3.0.0-next.6

1.0.0-next.5

Patch Changes

  • Updated dependencies [71554172]:
    • graphql-yoga@3.0.0-next.5

1.0.0-next.4

Patch Changes

1.0.0-next.3

Patch Changes

  • Updated dependencies [64e06d74]:
    • graphql-yoga@3.0.0-next.3

1.0.0-next.2

Patch Changes

  • Updated dependencies [8c674c36]:
    • graphql-yoga@3.0.0-next.2

1.0.0-next.1

Patch Changes

  • Updated dependencies [44878a5b]:
    • graphql-yoga@3.0.0-next.1

1.0.0-next.0

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