Strapi v4 with plugin-graphQL: use @cacheControl custom directives for apollo

Hadrien_DELAITRE · January 5, 2024, 8:25am

Hi all!
I’m struggling using the Apollo Server-side caching features. I just want to use the static way defining cache control directly in the graphQL Schema (see the v3 documentation of server-side caching of apollo).

It uses a custom directive named @cacheControl, but it seems that the graphQL strapi plugin totally skip this directive when it builds the nexus schema using the content-api service:

github.com

strapi/strapi/blob/develop/packages/plugins/graphql/server/src/services/content-api/index.ts#L78-L94


      
          const nexusSchema = makeSchema({
            types: [],
            // Build the schema from the merged GraphQL schema.
            // Since we're passing the schema to the mergeSchema property, it'll transform our SDL type definitions
            // into Nexus type definition, thus allowing them to be handled by  Nexus plugins & other processing
            mergeSchema: { schema: schemaWithResolvers },
          
            // Apply user-defined plugins
            plugins: extension.plugins,
          
            // Whether to generate artifacts (GraphQL schema, TS types definitions) or not.
            // By default, we generate artifacts only on development environment
            shouldGenerateArtifacts: config('generateArtifacts', currentEnv === 'development'),
          
            // Artifacts generation configuration
            outputs,
          });

I saw some old issues about it:

github.com/graphql-nexus/nexus

Support for operation directives

opened 03:40AM - 16 Jul 21 UTC

closed 08:59PM - 15 May 22 UTC

Fryuni

type/feat

The discussion on issue #53 seems to be about schema directives, so I'm opening …a new issue regarding query directives which is also not supported, It seems quite simple to add this feature by passing an extra field to the `GraphQLSchema` constructor here: https://github.com/graphql-nexus/nexus/blob/8e0ce1b4a156cd50b061b47c8a1241729b4dd2a3/src/builder.ts#L1700-L1709 Since that is just one function down from `makeSchema` and uses the same type, all it requires is adding a new field on the `SchemaConfig` [here](https://github.com/graphql-nexus/nexus/blob/8e0ce1b4a156cd50b061b47c8a1241729b4dd2a3/src/builder.ts#L259-L277) and passing it along. I tested it locally, and it works perfectly. The schema gets generated correctly with the directive specification at the top, and the information is passed to the resolvers at `info.fieldNodes.directives` as [graphql-js defines](https://github.com/graphql/graphql-js/blob/6a5f51f3bd07f3914c7f1ec01908e9e325b77d58/src/language/ast.ts#L304). Here is how it ended up being with this change: ```typescript /* file: directives.ts */ import {GraphQLDirective, GraphQLInt} from 'graphql'; export const cacheDirective = new GraphQLDirective({ name: 'cached', args: { lifetime: { type: GraphQLInt, }, }, locations: ['FIELD'], }); /* file: schema.ts */ import {makeSchema} from 'nexus'; import {cacheDirective} from './directives'; export const NexusGraphQLSchema = makeSchema({ directives: [cacheDirective], ... }); /* file: testResolver.ts */ import {queryField} from 'nexus'; import {cacheDirective} from '../directives'; import {getArgumentValues} from 'graphql/execution/values'; export const testField = queryField(def => def.string('testField', { resolve: (_, __, ___, info) => { const cacheConfiguration = getDirectiveValues(cacheDirective, info.fieldNodes[0], info.variableValues); return cacheConfiguration?.lifetime?.toFixed(0) ?? 'no-cache'; }, }); ``` It seems deceptively simple for no one to have done it by now, is there a problem with this that happens not to affect my application, or should I open a PR?

But it doesn’t help me

I know that I can define cache-control in a dynamic way, and it works like a charm but I want to try the static way.

Maybe I miss something obvious?

In my typeDefs of registering strapi I use:

extensionService.use(({ strapi }) => ({
      typeDefs: `
            enum CacheControlScope {
              PUBLIC
              PRIVATE
            }
            
            directive @cacheControl(
              maxAge: Int
              scope: CacheControlScope
              inheritMaxAge: Boolean
            ) on FIELD_DEFINITION | OBJECT | INTERFACE | UNION

            type CategoryRelationResponseCollection @cacheControl(maxAge: 1000) {
              data: [CategoryEntity!]!
            }
  `
...

In order to make my CategoryRelationResponseCollection cached, but it litterally caches nothing…

Best regards.

System Information

Strapi Version: 4.15.5
Operating System: WSL on Windows (docker)
Database: postgresql
Node Version: 18.18.2
NPM Version: 9.8.1
Yarn Version: 1.22.21