feat(graphql): allow to pass cache hints to graphql fields

examples/getstarted/src/api/category/content-types/category/schema.json

@@ -15,6 +15,18 @@
  "pluginOptions": {
  "i18n": {
  "localized": true
+ },
+ "graphql": {
+ "cacheHint": {
+ "find": {
+ "maxAge": 1000,
+ "scope": "PUBLIC"
+ },
+ "findOne": {
+ "maxAge": 2000,
+ "scope": "PUBLIC"
+ }
+ }
  }
  },
  "attributes": {
@@ -30,7 +42,15 @@
  "type": "relation",
  "relation": "manyToMany",
  "target": "api::address.address",
- "mappedBy": "categories"
+ "mappedBy": "categories",
+ "pluginOptions": {
+ "graphql": {
+ "cacheHint": {
+ "maxAge": 10,
+ "scope": "PUBLIC"
+ }
+ }
+ }
  },
  "temps": {
  "type": "relation",

packages/core/content-manager/server/src/services/data-mapper.ts

@@ -12,7 +12,6 @@ const dtoFields = [
  'options',
  'pluginOptions',
  'attributes',
- 'pluginOptions',
 ];
 
 export default () => ({

packages/core/types/src/types/core/schemas/index.ts

@@ -1,4 +1,5 @@
 import type { Attribute, Common } from '../..';
+import type { CacheHint } from 'apollo-server-types';
 
 /**
  * Literal union type representing the possible natures of a content type
@@ -97,6 +98,12 @@ export interface Options {
 
 export interface PluginOptions {
  i18n?: { localized: boolean };
+ graphql?: {
+ cacheHint?: {
+ find?: CacheHint;
+ findOne?: CacheHint;
+ }
+ };
 }
 
 /**

packages/plugins/graphql/server/src/bootstrap.ts

@@ -3,6 +3,7 @@ import { ApolloServer } from 'apollo-server-koa';
 import {
  ApolloServerPluginLandingPageDisabled,
  ApolloServerPluginLandingPageGraphQLPlayground,
+ ApolloServerPluginCacheControl,
 } from 'apollo-server-core';
 import depthLimit from 'graphql-depth-limit';
 import { graphqlUploadKoa } from 'graphql-upload';
@@ -74,6 +75,8 @@ export async function bootstrap({ strapi }: { strapi: Strapi }) {
  bodyParserConfig: true,
 
  plugins: [
+ // TODO: Remove this. Will be added by user in config if they want to enable cache
+ ApolloServerPluginCacheControl({ defaultMaxAge: 3600 }),
  process.env.NODE_ENV === 'production' && !config('playgroundAlways')
  ? ApolloServerPluginLandingPageDisabled()
  : ApolloServerPluginLandingPageGraphQLPlayground(),

packages/plugins/graphql/server/src/services/builders/queries/collection-type.ts

@@ -74,7 +74,12 @@ export default ({ strapi }: Context) => {
 
  args: getContentTypeArgs(contentType, { multiple: false }),
 
- async resolve(parent, args, ctx) {
+ async resolve(parent, args, ctx, info) {
+ // TODO: pluginOptions.graphql not recognised
+ if ((contentType.pluginOptions as any)?.graphql?.cacheHint?.findOne) {
+ info.cacheControl.setCacheHint((contentType.pluginOptions as any).graphql.cacheHint.findOne);
+ }
+
  const transformedArgs = transformArgs(args, { contentType });
 
  const { findOne } = getService('builders')
@@ -106,7 +111,12 @@ export default ({ strapi }: Context) => {
 
  args: getContentTypeArgs(contentType),
 
- async resolve(parent, args, ctx) {
+ async resolve(parent, args, ctx, info) {
+ // TODO: pluginOptions.graphql not recognised
+ if ((contentType.pluginOptions as any)?.graphql?.cacheHint?.find) {
+ info.cacheControl.setCacheHint((contentType.pluginOptions as any).graphql.cacheHint.find);
+ }
+
  const transformedArgs = transformArgs(args, { contentType, usePagination: true });
 
  const { find } = getService('builders')

packages/plugins/graphql/server/src/services/builders/queries/single-type.ts

@@ -56,7 +56,12 @@ export default ({ strapi }: Context) => {
 
  args: getContentTypeArgs(contentType),
 
- async resolve(parent, args, ctx) {
+ async resolve(parent, args, ctx, info) {
+ // TODO: pluginOptions.graphql not recognised
+ if ((contentType.pluginOptions as any)?.graphql?.cacheHint?.findOne) {
+ info.cacheControl.setCacheHint((contentType.pluginOptions as any).graphql.cacheHint.findOne);
+ }
+
  const transformedArgs = transformArgs(args, { contentType });
 
  const queriesResolvers = getService('builders')

packages/plugins/graphql/server/src/services/builders/resolvers/association.ts

@@ -1,8 +1,10 @@
+import type { CacheHint } from 'apollo-server-types';
 import { get } from 'lodash/fp';
 import { sanitize, validate, pipeAsync, errors } from '@strapi/utils';
 import type { UID } from '@strapi/types';
 
 import type { Context } from '../../types';
+import { FieldResolver } from 'nexus';
 
 const { ApplicationError } = errors;
 
@@ -17,10 +19,12 @@ export default ({ strapi }: Context) => {
  buildAssociationResolver({
  contentTypeUID,
  attributeName,
+ cacheHint,
  }: {
  contentTypeUID: UID.ContentType;
  attributeName: string;
- }) {
+ cacheHint?: CacheHint;
+ }): FieldResolver<string, string> {
  const contentType = strapi.getModel(contentTypeUID);
  const attribute: any = contentType.attributes[attributeName];
 
@@ -38,7 +42,11 @@ export default ({ strapi }: Context) => {
 
  const targetContentType = strapi.getModel(targetUID);
 
- return async (parent: any, args: any = {}, context: any = {}) => {
+ return async (parent: any, args: any = {}, context: any = {}, resolveInfo) => {
+ if (cacheHint) {
+ resolveInfo.cacheControl.setCacheHint(cacheHint);
+ }
+
  const { auth } = context.state;
 
  const transformedArgs = transformArgs(args, {

packages/plugins/graphql/server/src/services/builders/resolvers/component.ts

@@ -1,19 +1,27 @@
+import type { CacheHint } from 'apollo-server-types';
 import { sanitize, validate } from '@strapi/utils';
 import type { Attribute, UID } from '@strapi/types';
 
 import type { Context } from '../../types';
+import { FieldResolver } from 'nexus';
 
 export default ({ strapi }: Context) => ({
  buildComponentResolver({
  contentTypeUID,
  attributeName,
+ cacheHint,
  }: {
  contentTypeUID: UID.ContentType;
  attributeName: string;
- }) {
+ cacheHint?: CacheHint;
+ }): FieldResolver<string, string> {
  const { transformArgs } = strapi.plugin('graphql').service('builders').utils;
 
- return async (parent: any, args: any, ctx: any) => {
+ return async (parent: any, args: any, ctx: any, info) => {
+ if (cacheHint) {
+ info.cacheControl.setCacheHint(cacheHint);
+ }
+
  const contentType = strapi.getModel(contentTypeUID);
 
  const { component: componentName } = contentType.attributes[

packages/plugins/graphql/server/src/services/builders/resolvers/dynamic-zone.ts

@@ -1,16 +1,24 @@
+import type { CacheHint } from 'apollo-server-types';
 import type { UID } from '@strapi/types';
 
 import type { Context } from '../../types';
+import { FieldResolver } from 'nexus';
 
 export default ({ strapi }: Context) => ({
  buildDynamicZoneResolver({
  contentTypeUID,
  attributeName,
+ cacheHint,
  }: {
  contentTypeUID: UID.ContentType;
  attributeName: string;
- }) {
- return async (parent: any) => {
+ cacheHint?: CacheHint;
+ }): FieldResolver<string, string> {
+ return async (parent, _args, _context, info) => {
+ if (cacheHint) {
+ info.cacheControl.setCacheHint(cacheHint);
+ }
+
  return strapi.entityService!.load(contentTypeUID, parent, attributeName);
  };
  },