[wip] Full Query Caching

packages/apollo-engine-reporting/src/extension.ts

@@ -213,7 +213,34 @@ export class EngineReportingExtension<TContext = any>
     };
   }
 
-  public willSendResponse(o: { graphqlResponse: GraphQLResponse }) {
+  public willSendResponse(o: {
+    graphqlResponse: GraphQLResponse;
+    cacheHit: boolean;
+    cachePolicy: string;
+    maxAgeMs: number;
+  }) {
+    this.trace.fullQueryCacheHit = o.cacheHit;
+    if (o.cacheHit) {
+      switch (o.cachePolicy) {
+        case 'public':
+          this.trace.cachePolicy = {
+            scope: Trace.CachePolicy.Scope.PUBLIC,
+            maxAgeNs: o.maxAgeMs * 1000,
+          };
+          break;
+        case 'private':
+          this.trace.cachePolicy = {
+            scope: Trace.CachePolicy.Scope.PRIVATE,
+            maxAgeNs: o.maxAgeMs * 1000,
+          };
+          break;
+        default:
+          this.trace.cachePolicy = {
+            scope: Trace.CachePolicy.Scope.UNKNOWN,
+            maxAgeNs: o.maxAgeMs,
+          };
+      }
+    }
     const { errors } = o.graphqlResponse;
     if (errors) {
       errors.forEach((error: GraphQLError) => {

packages/apollo-server-core/src/__tests__/runQuery.test.ts

@@ -1,5 +1,5 @@
 /* tslint:disable:no-unused-expression */
-import MockReq = require('mock-req');
+import { Request } from 'apollo-server-env';
 
 import {
   GraphQLSchema,
@@ -85,7 +85,7 @@ describe('runQuery', () => {
     return runQuery({
       schema,
       queryString: query,
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toEqual(expected);
     });
@@ -97,7 +97,7 @@ describe('runQuery', () => {
     return runQuery({
       schema,
       parsedQuery: query,
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toEqual(expected);
     });
@@ -110,7 +110,7 @@ describe('runQuery', () => {
       schema,
       queryString: query,
       variables: { base: 1 },
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toBeUndefined();
       expect(res.errors!.length).toEqual(1);
@@ -125,7 +125,7 @@ describe('runQuery', () => {
       schema,
       queryString: query,
       debug: true,
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(() => {
       logStub.mockRestore();
       expect(logStub.mock.calls.length).toEqual(0);
@@ -139,7 +139,7 @@ describe('runQuery', () => {
       schema,
       queryString: query,
       debug: false,
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(() => {
       logStub.mockRestore();
       expect(logStub.mock.calls.length).toEqual(0);
@@ -154,7 +154,7 @@ describe('runQuery', () => {
       schema,
       queryString: query,
       variables: { base: 1 },
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toBeUndefined();
       expect(res.errors!.length).toEqual(1);
@@ -169,7 +169,7 @@ describe('runQuery', () => {
       schema,
       queryString: query,
       rootValue: 'it also',
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toEqual(expected);
     });
@@ -182,7 +182,7 @@ describe('runQuery', () => {
       schema,
       queryString: query,
       context: { s: 'it still' },
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toEqual(expected);
     });
@@ -199,7 +199,7 @@ describe('runQuery', () => {
         response['extensions'] = context.s;
         return response;
       },
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toEqual(expected);
       expect(res['extensions']).toEqual('it still');
@@ -213,7 +213,7 @@ describe('runQuery', () => {
       schema,
       queryString: query,
       variables: { base: 1 },
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toEqual(expected);
     });
@@ -226,7 +226,7 @@ describe('runQuery', () => {
     return runQuery({
       schema,
       queryString: query,
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.errors![0].message).toEqual(expected);
     });
@@ -236,7 +236,7 @@ describe('runQuery', () => {
     return runQuery({
       schema,
       queryString: `{ testAwaitedValue }`,
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toEqual({
         testAwaitedValue: 'it works',
@@ -259,7 +259,7 @@ describe('runQuery', () => {
       schema,
       queryString: query,
       operationName: 'Q1',
-      request: new MockReq(),
+      request: new Request('local'),
     }).then(res => {
       expect(res.data).toEqual(expected);
     });
@@ -278,7 +278,7 @@ describe('runQuery', () => {
       schema,
       queryString: query,
       operationName: 'Q1',
-      request: new MockReq(),
+      request: new Request('local'),
     });
 
     expect(result1.data).toEqual({
@@ -292,7 +292,7 @@ describe('runQuery', () => {
       queryString: query,
       operationName: 'Q1',
       fieldResolver: () => 'a very testful field resolver string',
-      request: new MockReq(),
+      request: new Request('local'),
     });
 
     expect(result2.data).toEqual({
@@ -333,7 +333,7 @@ describe('runQuery', () => {
         }),
         queryString,
         extensions,
-        request: new MockReq(),
+        request: new Request('local'),
       });
     });
 
@@ -345,7 +345,7 @@ describe('runQuery', () => {
         schema,
         queryString,
         extensions,
-        request: new MockReq(),
+        request: new Request('local'),
       }).then(res => {
         expect(res.data).toEqual(expected);
         expect(res.extensions).toEqual({
@@ -390,7 +390,7 @@ describe('runQuery', () => {
         schema,
         queryString: query,
         operationName: 'Q1',
-        request: new MockReq(),
+        request: new Request('local'),
       });
 
       // Expect there to be several async ids provided

packages/apollo-server-core/src/caching.ts

@@ -3,7 +3,11 @@ import { CacheControlFormat } from 'apollo-cache-control';
 
 export function calculateCacheControlHeaders(
   responses: Array<ExecutionResult & { extensions?: Record<string, any> }>,
-): Record<string, string> {
+): Partial<{
+  'Cache-Control': string;
+  lowestMaxAge: number;
+  publicOrPrivate: string;
+}> {
   let lowestMaxAge = Number.MAX_VALUE;
   let publicOrPrivate = 'public';
 
@@ -62,5 +66,7 @@ export function calculateCacheControlHeaders(
 
   return {
     'Cache-Control': `max-age=${lowestMaxAge}, ${publicOrPrivate}`,
+    lowestMaxAge,
+    publicOrPrivate,
   };
 }

packages/apollo-server-core/src/graphqlOptions.ts

@@ -41,6 +41,8 @@ export interface GraphQLServerOptions<
     | (CacheControlExtensionOptions & {
         calculateHttpHeaders?: boolean;
         stripFormattedExtensions?: boolean;
+        cache?: KeyValueCache;
+        privateCache?: KeyValueCache;
       });
   extensions?: Array<() => GraphQLExtension>;
   dataSources?: () => DataSources<TContext>;

packages/apollo-server-core/src/runHttpQuery.ts

@@ -16,6 +16,7 @@ import {
   PersistedQueryNotSupportedError,
   PersistedQueryNotFoundError,
 } from 'apollo-server-errors';
+import { KeyValueCache } from 'apollo-server-caching';
 import { calculateCacheControlHeaders } from './caching';
 
 export interface HttpQueryRequest {
@@ -105,6 +106,8 @@ export async function runHttpQuery(
     | CacheControlExtensionOptions & {
         calculateHttpHeaders: boolean;
         stripFormattedExtensions: boolean;
+        privateCache: KeyValueCache;
+        cache: KeyValueCache;
       }
     | undefined;
 
@@ -186,6 +189,10 @@ export async function runHttpQuery(
         }
       }
 
+      // Used for calculating cache key
+      const calculatedSha: string = sha256()
+        .update(queryString)
+        .digest('hex');
       if (extensions && extensions.persistedQuery) {
         // It looks like we've received an Apollo Persisted Query. Check if we
         // support them. In an ideal world, we always would, however since the
@@ -233,9 +240,6 @@ export async function runHttpQuery(
             );
           }
         } else {
-          const calculatedSha = sha256()
-            .update(queryString)
-            .digest('hex');
           if (sha !== calculatedSha) {
             throw new HttpQueryError(400, 'provided sha does not match query');
           }
@@ -366,15 +370,22 @@ export async function runHttpQuery(
           cacheControl = {
             stripFormattedExtensions: false,
             calculateHttpHeaders: false,
+            privateCache: optionsObject.cache!,
+            cache: optionsObject.cache!,
             defaultMaxAge: 0,
           };
         } else {
+          const privateCache =
+            (optionsObject.cacheControl && optionsObject.cacheControl.cache) ||
+            optionsObject.cache!;
           // Default behavior is to run default header calculation and return
           // no cacheControl extensions
           cacheControl = {
             stripFormattedExtensions: true,
             calculateHttpHeaders: true,
             defaultMaxAge: 0,
+            privateCache,
+            cache: optionsObject.cache!,
             ...optionsObject.cacheControl,
           };
         }
@@ -393,7 +404,7 @@ export async function runHttpQuery(
         formatResponse: optionsObject.formatResponse,
         fieldResolver: optionsObject.fieldResolver,
         debug: optionsObject.debug,
-        tracing: optionsObject.tracing,
+        tracing: optionsObject.tracing || false,
         cacheControl: cacheControl
           ? omit(cacheControl, [
               'calculateHttpHeaders',
@@ -404,6 +415,7 @@ export async function runHttpQuery(
         extensions: optionsObject.extensions,
         persistedQueryHit,
         persistedQueryRegister,
+        queryHash: calculatedSha,
       };
 
       return runQuery(params);
@@ -445,7 +457,10 @@ export async function runHttpQuery(
 
       responseInit.headers = {
         ...responseInit.headers,
-        ...calculatedHeaders,
+        ...(omit(calculatedHeaders, [
+          'lowestMaxAge',
+          'publicOrPrivate',
+        ]) as Record<string, string>),
       };
     }