graphql/yoga-server/docs/features/response-caching

[giscus[bot]]

graphql/yoga-server/docs/features/response-caching

GraphQL Yoga: documentation

https://www.the-guild.dev/graphql/yoga-server/docs/features/response-caching

[alexandre-dev29]

i created a brand new project using nestjs and graphql Yoga following the steps here https://www.the-guild.dev/graphql/yoga-server/v3/integrations/integration-with-nestjs

and all thinks works great ☺☺
but i tried to add response caching as describe here https://www.the-guild.dev/graphql/yoga-server/v3/features/response-caching
then there is an error
on the first request the response return without problem but on the second a get an error

{
  "data": null,
  "errors": [
    {
      "message": "setResult is not a function"
    }
  ]
}

if i remove the caching all things works great again
here is how i declared the caching

    GraphQLModule.forRoot<YogaDriverConfig>({
      driver: YogaDriver,
      autoSchemaFile: true,
      transformSchema: schema => upperDirectiveTransformer(schema, 'upper'),
      installSubscriptionHandlers: true,
      plugins: [
          useResponseCache({session: () => null, ttl: 10000})
      ],
      buildSchemaOptions: {
        directives: [
          new GraphQLDirective({
            name: 'upper',
            locations: [DirectiveLocation.FIELD_DEFINITION],
          }),
        ],
      },
    })

[n1ru4l]

@alexandre-dev29 Could you figure this one out? If not might you be up to creating a GitHub issue with a full reproduction?

[defsteph]

I'm trying to figure out how to deal with nullvalues, and not caching them indefinitely.

This is my response:

{
  "data": {
    "explain": null
  },
  "extensions": {
    "responseCache": {
      "hit": false,
      "didCache": true,
      "ttl": null
    }
  }
}

How would I go about setting a TTL of, say 15 seconds, for a query that returns null?

[defsteph]

Oh yeah, maybe I should say.

I'm using an InMemoryCache in local dev, but Redis in production. But they seem to behave in the same way.

Say I'm querying for something, and it doesn't exist, then if a mutation is run that adds the thing, a second query for the thing yields null straight from the cache.

[defsteph]

Nevermind, I realized I had the query parameter as String! when it should be ID!. Sorted it out, and now it works as expected.

[SiNONiMiTY]

https://the-guild.dev/graphql/yoga-server/docs/features/response-caching#session-based-caching

It says here that the object passed is of type Request

However, the TS Autocomplete says it is of type YogaInitialContext, therefore, I cannot access the request headers.

[ardatan]

Are you sure you are using @graphql-yoga/plugin-response-cache?
See session has request as parameter not context;
https://github.com/dotansimha/graphql-yoga/blob/main/packages/plugins/response-cache/src/index.ts#L25

Also you don't need an additional parser caching setup in Yoga (I see you have useParserCache);
https://the-guild.dev/graphql/yoga-server/docs/features/parsing-and-validation-caching

[SiNONiMiTY]

@ardatan, I see, I was using this plugin @envelop/response-cache

Does this have a different functionality? Will try installing @graphql-yoga/plugin-response-cache

[ardatan]

Yes it is different. It has more features and optimizations.

[SiNONiMiTY]

I see, thanks for the guidance. @ardatan

[nghiepdev]

I encountered a problem while working with Using Schema directive @cacheControl

Module '"@graphql-yoga/plugin-response-cache"' has no exported member 'cacheControlDirective'.

[gurusharma08]

While we are using graphql-yoga for our service. when we implemented few queries and schemas defines. if any value in requested input has syntax error it is returning unexpected error due UseHttpValidationError.js function it is checking for extension object but for syntax error it will not have that object and same case is happening for requested field syntax error then also it is checking for extension object in response it is checking in regular.js. could you please check this bug and let us know the fix

[ardatan]

If you provide a reproduction, we would love to take a look :)