CDN cache-control headers by evans · Pull Request #1138 · apollographql/apollo-server

evans · 2018-06-05T00:14:27Z

In order to se the cache-control headers inside of GraphQL execution, we need to return Response Headers. Currently runHttpQuery manufactures them from scratch. It could instead accept in a responseInit object and append it. However, none of the integrations currently use this functionality and it could be added in later, so to keep things simple, this PR takes the most direct route.

glasser · 2018-06-05T21:31:49Z

+          Object.keys(responseInit.headers).forEach(key =>
+            response.header(key, responseInit.headers[key]),
+          );
+          response.header(


this wasn't needed before?

The express variant contained this, so I thought that the hapi and koa variants should be at feature parity. The reason it's not inside of apollo-server-core is because of the cloudflare integration. We can move the calculation there and then decide how to do the Buffer length in a V8 environment later

glasser · 2018-06-05T21:32:10Z

+          ctx.set(key, responseInit.headers[key]),
+        );
+        ctx.set(
+          'Content-Length',


glasser · 2018-06-05T21:32:54Z


-  return JSON.stringify(responses);
+  return {
+    gqlResponse: JSON.stringify(responses),


I think this might be better as graphqlResponse — do we really use "gql" much in actual APIs outside of graphql-tag?

glasser · 2018-06-05T21:33:36Z

  const responses = await Promise.all(requests);

+  const responseInit: ResponseInit = {
+    status: 200,


Seems like this isn't getting consistently used in all variants (even express lacks it).

glasser · 2018-06-05T21:35:26Z


+export interface HttpQueryResponse {
+  gqlResponse: string;
+  responseInit: ResponseInit;


The typing here is a little funky, since ResponseInit.headers is a HeadersInit which allows various options (Headers object, array of arrays, dictionary object) but the consumers assume that it's the latter. I'm almost surprised this typechecks, though maybe TS lets you [] index anything? Not sure what to do about this — maybe just roll your own type, or at least comment on it you can assume that the headers field is a record?

Makes sense, we'll roll our own for now

…t type

…through extensions

glasser · 2018-06-15T18:22:36Z

  get(key: string): Promise<string | null>;
 }
+
+export function calcualteCacheControlHeaders(


"calculate"

glasser · 2018-06-15T18:46:00Z

+  let maxAge = Number.MAX_VALUE;
+  let publicOrPrivate = 'public';
+
+  for (let i = 0; i < responses.length; i++) {


So the key thing in the engineproxy calculation of cacheControl is you need to put a hint on every top-level data piece in order for it to count. See the rootDataKey loop in parseCacheControl.

glasser · 2018-06-18T22:36:59Z

    });
    describe('file uploads', () => {
      it('enabled uploads', async () => {
+        //XXX This is currently a failing test for node 10


Would you like to pair on tracking this down? Node 10 is released so it seems like we should make this work.

glasser · 2018-06-18T22:39:27Z

+  let maxAge = Number.MAX_VALUE;
+  let publicOrPrivate = 'public';
+
+  //Because of the early exit, we are unable to use forEach. While a reduce


I am hesitant to mention any formatting issues that prettier doesn't deal with automatically, but I've been meaning to mention that your style of not putting a space after // seems to be idiosyncratic in our codebases.

glasser · 2018-06-18T22:40:24Z

+    }
+
+    const rootHints = new Set<string>();
+    for (let y = 0; y < cacheControl.hints.length; y++) {


grab cacheControl.hints[y] immediately like you did in the outer loop? (Also a little odd that the loop indices are i/y.)

glasser · 2018-06-18T22:41:11Z

+
+    const rootHints = new Set<string>();
+    for (let y = 0; y < cacheControl.hints.length; y++) {
+      if (cacheControl.hints[y].scope === 'PRIVATE') {


In Engineproxy we do this comparison case-insensitively.

glasser · 2018-06-18T22:43:26Z

+        maxAge = cacheControl.hints[y].maxAge;
+      }
+
+      rootHints.add(cacheControl.hints[y].path[0]);


This is not quite right (or at least, not quite what we did before). This would mean that if you got a hint for "foo.bar" but nothing else, we would count this as being a hint on "foo". But if there's also a "foo.baz" and that was the only hint, then there are no hints on "foo.baz", so it wouldn't be right to count this as covering everything.

(Arguably we could change the "all roots must have hints" logic to be something more like "every leaf must be the descendent of a node with a hint" although that wouldn't be quite right either, as even interior nodes have resolvers whose return values can change.)

glasser · 2018-06-18T22:47:28Z

+        //we always want cacheControl to either set the CDN headers or for the
+        //engine proxy
+        cacheControl:
+          optionsObject.cacheControl !== null &&


hmm, why not just optionsObject.cacheControl === undefined ? true : optionsObject.cacheControl? Looks like this will override explicitly cacheControl: false which seems wrong.

glasser · 2018-06-18T22:50:28Z

+  if (!optionsObject.cacheControl) {
+    responseInit.headers = {
+      ...responseInit.headers,
+      ...calculateCacheControlHeaders(responses),


Shouldn't we do this even when you explicitly ask for cacheControl? Perhaps there is a second option to cacheControl, eg cacheControl.setHTTPHeaders, which default to true.

glasser · 2018-06-18T22:53:33Z

+      ...calculateCacheControlHeaders(responses),
+    };
+
+    //remove cacheControl headers. This could be done in production only,


It's extensions, not headers (so fix the comment).

However this all seems to be weirdly intricate. We create the CacheControlExtension object and ask it to put things in the JSON extension format, but then we turn it into headers and delete the extension. Why not just put header calculation (or perhaps, "max age and privacy tuple" calculation) into CacheControlExtension itself, and (via an option to the CacheControlExtension constructor that can be overridden) make format into a no-op?

Adds cache-control toggles for http header calculation and stripping out the cache control extensions from the respose. Brings the default calculation of headers in line with the proxy.

glasser · 2018-06-20T23:44:01Z

-With ENGINE_API_KEY set as an environment variable, Apollo Server creates a reporting agent that sends execution traces to the Engine UI. In addition by default, Apollo Server supports [persisted queries](./features/apq.html).
-
-<!-- FIXME add something about CDN headers-->
+Apollo Server 2 is able to completely replace the Engine Proxy. To enable metrics reporting, add `ENGINE_API_KEY` as an environment variable. Apollo Server will then create a reporting agent that sends execution traces to the Engine UI. In addition by default, Apollo Server supports [persisted queries](./features/apq.html) without needing the proxy's cache. Apollo Server also provides cache-control headers for consumption by a [CDN](./features/cdn.html). Integration with a CDN provides a replacement for the full response caching in Engine Proxy.


I don't think that last sentence really is true. After all that was already a feature of the Proxy.

glasser · 2018-06-20T23:44:18Z

 ```

-## Starting Engine Proxy
+## Starting Engine Proxy as a Sidecar


I think we moved away from the "sidecar" terminology because it never made sense to anybody

glasser · 2018-06-20T23:49:07Z

        tracing: optionsObject.tracing,
-        cacheControl: optionsObject.cacheControl,
+        cacheControl: cacheControl
+          ? { defaultMaxAge: cacheControl.defaultMaxAge }


Is the implication that this is the only parameter that the underlying package supports? maybe use _.omit or whatever to blacklist instead of whitelist?

ghost added the ⛲️ feature New addition or enhancement to existing solutions label Jun 5, 2018

glasser reviewed Jun 5, 2018

View reviewed changes

evans force-pushed the server-2.0/response-construction branch from 18c1b61 to cf75381 Compare June 11, 2018 22:28

evans changed the title ~~Return response object in runHttpQuery~~ Return response object in runHttpQuery + CDN cache-control headers Jun 12, 2018

ghost added the ⛲️ feature New addition or enhancement to existing solutions label Jun 12, 2018

evans changed the title ~~Return response object in runHttpQuery + CDN cache-control headers~~ CDN cache-control headers Jun 12, 2018

ghost added the ⛲️ feature New addition or enhancement to existing solutions label Jun 12, 2018

evans force-pushed the server-2.0/response-construction branch from 47a21d3 to 772d8a6 Compare June 12, 2018 01:57

evans force-pushed the version-2 branch from 5770674 to afcd170 Compare June 13, 2018 06:11

evans added 7 commits June 14, 2018 15:58

core: return response object from runHttpQuery

d85275a

core: change gqlResponse to graphqlResponse and add custom RequestIni…

b805493

…t type

core: add cache-control headers based on the calcualted maxAge

e5986a2

core: add extensions check during cache-control header creation

156981b

core: create headers when cacheControl is not enabled otherwise pass …

dc8dba8

…through extensions

express: initial tests of CDN cach-contol headers

d0368cb

core: fixed tests with applyMiddleware and pass cacheControl config

6890156

evans force-pushed the server-2.0/response-construction branch from fc85b04 to 6890156 Compare June 14, 2018 23:01

evans added this to the Release 2.0 milestone Jun 15, 2018

glasser reviewed Jun 15, 2018

View reviewed changes

evans added 4 commits June 18, 2018 11:23

Merge branch 'version-2' into server-2.0/cdn

534de91

core: cache hint fixes, ignore when no maxAge, and check for rootKeys

92fba23

core: check for hints of length 0

d0e2625

core: node 10 fails file upload test for some stream reason

cdffba8

glasser reviewed Jun 18, 2018

View reviewed changes

evans added 6 commits June 18, 2018 16:25

docs: add cdn caching section to features

025a271

add space after // in comments

7c35dc2

fix feedback: proxy alignment and response creation

fab0c2f

Adds cache-control toggles for http header calculation and stripping out the cache control extensions from the respose. Brings the default calculation of headers in line with the proxy.

fix links in comments

3333695

fix tests with null dereference

631a0d4

update cdn docs and migration guide to include latest cdn configuration

e1750d0

evans added 5 commits June 19, 2018 17:29

add not for engine migration to set engine to false

fc7de7f

Merge branch 'version-2' into server-2.0/cdn

bd547f7

add engine set to false in migration guide

44a6e4b

Merge branch 'version-2' into server-2.0/cdn

c90bfea

Merge branch 'version-2' into server-2.0/cdn

39d3872

glasser reviewed Jun 20, 2018

View reviewed changes

evans added 7 commits June 21, 2018 10:52

express: fixed tests

d5c0de9

address feedback to use omit and documentation

e7190fa

Merge branch 'version-2' into server-2.0/response-construction

7300cac

Merge branch 'version-2' into server-2.0/response-construction

b421821

docs: cdn caching is alternative to full response caching

55835e2

add back epipe check in upload tests

ccc4357

Merge branch 'version-2' into server-2.0/response-construction

a5e6c41

evans merged commit 65d7b10 into version-2 Jun 21, 2018

evans deleted the server-2.0/response-construction branch June 21, 2018 20:29

evans mentioned this pull request Jun 21, 2018

Apollo Server 2.0 #1125

Merged

ghost mentioned this pull request Aug 15, 2018

Update apollo-server-express in / from 1.2.0 to 2.0.2 LibreTubeApp/LibreTube#158

Open

github-actions Bot locked as resolved and limited conversation to collaborators Apr 23, 2023

Conversation

evans commented Jun 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

evans commented Jun 5, 2018 •

edited

Loading