Initial work for cache: 'bounded'

apollographql · Jun 7, 2022 · e67c2ae · e67c2ae
1 parent 303afb9
commit e67c2ae
Show file tree

Hide file tree

Showing 32 changed files with 184 additions and 70 deletions.
diff --git a/docs/source/api/apollo-server.mdx b/docs/source/api/apollo-server.mdx
@@ -20,6 +20,7 @@ const server = new ApolloServer({
 	typeDefs,
 	resolvers,
   csrfPrevention: true,  // highly recommended
+  cache: 'bounded',
 });
 ```
 
@@ -726,6 +727,7 @@ async function startApolloServer() {
     typeDefs,
     resolvers,
     csrfPrevention: true,
+    cache: 'bounded',
     plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
   });
 

diff --git a/docs/source/api/plugin/cache-control.md b/docs/source/api/plugin/cache-control.md
@@ -21,6 +21,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     ApolloServerPluginCacheControl({
       // Cache everything for 1 second by default.
@@ -42,6 +43,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [ApolloServerPluginCacheControlDisabled()],
 });
 ```

diff --git a/docs/source/api/plugin/drain-http-server.mdx b/docs/source/api/plugin/drain-http-server.mdx
@@ -39,6 +39,7 @@ async function startApolloServer() {
     typeDefs,
     resolvers,
     csrfPrevention: true,
+    cache: 'bounded',
     plugins: [ApolloServerPluginDrainHttpServer({ httpServer })],
   });
 

diff --git a/docs/source/api/plugin/inline-trace.md b/docs/source/api/plugin/inline-trace.md
@@ -21,6 +21,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     ApolloServerPluginInlineTrace({
       rewriteError: (err) => err.message.match(SENSITIVE_REGEX) ? null : err,
@@ -39,6 +40,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [ApolloServerPluginInlineTraceDisabled()],
 });
 ```

diff --git a/docs/source/api/plugin/landing-pages.md b/docs/source/api/plugin/landing-pages.md
@@ -29,17 +29,19 @@ To configure these default plugins while still using same `NODE_ENV`-based logic
 
 ```js
 import { ApolloServer } from "apollo-server";
-import { ApolloServerPluginLandingPageLocalDefault,
-         ApolloServerPluginLandingPageProductionDefault
+import {
+  ApolloServerPluginLandingPageLocalDefault,
+  ApolloServerPluginLandingPageProductionDefault
 } from "apollo-server-core";
 
 const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     // Install a landing page plugin based on NODE_ENV
-    process.env.NODE_ENV === 'production'
+    process.env.NODE_ENV === "production"
       ? ApolloServerPluginLandingPageProductionDefault({
           graphRef: "my-graph-id@my-graph-variant",
           footer: false,
@@ -428,6 +430,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     ApolloServerPluginLandingPageGraphQLPlayground(),
   ],
@@ -512,6 +515,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     ApolloServerPluginLandingPageDisabled(),
   ],

diff --git a/docs/source/api/plugin/schema-reporting.md b/docs/source/api/plugin/schema-reporting.md
@@ -23,6 +23,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     ApolloServerPluginSchemaReporting(),
   ],

diff --git a/docs/source/api/plugin/usage-reporting.md b/docs/source/api/plugin/usage-reporting.md
@@ -25,6 +25,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     ApolloServerPluginUsageReporting({
       fieldLevelInstrumentation: 0.5,
@@ -454,6 +455,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [ApolloServerPluginUsageReportingDisabled()],
 });
 ```

diff --git a/docs/source/builtin-plugins.md b/docs/source/builtin-plugins.md
@@ -31,6 +31,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     // Sets a non-default option on the usage reporting plugin
     ApolloServerPluginUsageReporting({

diff --git a/docs/source/data/data-sources.mdx b/docs/source/data/data-sources.mdx
@@ -55,6 +55,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   dataSources: () => {
     return {
       moviesAPI: new MoviesAPI(),

diff --git a/docs/source/data/errors.mdx b/docs/source/data/errors.mdx
@@ -343,6 +343,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   formatError: (err) => {
     // Don't give the specific errors to the client.
     if (err.message.startsWith('Database Error: ')) {
@@ -398,6 +399,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     ApolloServerPluginUsageReporting({
       rewriteError(err) {
@@ -429,6 +431,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     ApolloServerPluginUsageReporting({
       rewriteError(err) {
@@ -467,6 +470,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     ApolloServerPluginUsageReporting({
       rewriteError(err) {
@@ -512,6 +516,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: 'bounded',
   plugins: [setHttpPlugin],
 });
 ```
diff --git a/docs/source/data/file-uploads.mdx b/docs/source/data/file-uploads.mdx
@@ -79,6 +79,7 @@ async function startServer() {
     resolvers,
     // Using graphql-upload without CSRF prevention is very insecure.
     csrfPrevention: true,
+    cache: 'bounded',
   });
   await server.start();
 
@@ -181,6 +182,7 @@ const start = async () => {
       resolvers,
       // Using graphql-upload without CSRF prevention is very insecure.
       csrfPrevention: true,
+      cache: 'bounded',
     });
 
     // Start Apollo Server

diff --git a/docs/source/data/resolvers.mdx b/docs/source/data/resolvers.mdx
@@ -145,7 +145,12 @@ const resolvers = {
 
 // Pass schema definition and resolvers to the
 // ApolloServer constructor
-const server = new ApolloServer({ typeDefs, resolvers, csrfPrevention: true });
+const server = new ApolloServer({
+  typeDefs,
+  resolvers,
+  csrfPrevention: true,
+  cache: 'bounded',
+});
 
 // Launch the server
 server.listen().then(({ url }) => {
@@ -323,7 +328,12 @@ const resolvers = {
 
 // Pass schema definition and resolvers to the
 // ApolloServer constructor
-const server = new ApolloServer({ typeDefs, resolvers, csrfPrevention: true });
+const server = new ApolloServer({
+  typeDefs,
+  resolvers,
+  csrfPrevention: true,
+  cache: 'bounded',
+});
 
 // Launch the server
 server.listen().then(({ url }) => {
@@ -388,6 +398,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: 'bounded',
   context: ({ req }) => ({
     authScope: getScope(req.headers.authorization)
   })

diff --git a/docs/source/data/subscriptions.mdx b/docs/source/data/subscriptions.mdx
@@ -82,6 +82,7 @@ To run both an Express app _and_ a separate WebSocket server for subscriptions,
     const server = new ApolloServer({
       schema,
       csrfPrevention: true,
+      cache: "bounded",
     });
     ```
 
@@ -108,6 +109,7 @@ To run both an Express app _and_ a separate WebSocket server for subscriptions,
       const server = new ApolloServer({
         schema,
         csrfPrevention: true,
+        cache: "bounded",
         plugins: [
           // Proper shutdown for the HTTP server.
           ApolloServerPluginDrainHttpServer({ httpServer }),
@@ -168,6 +170,7 @@ const serverCleanup = useServer({ schema }, wsServer);
 const server = new ApolloServer({
   schema,
   csrfPrevention: true,
+  cache: "bounded",
   plugins: [
     // Proper shutdown for the HTTP server.
     ApolloServerPluginDrainHttpServer({ httpServer }),

diff --git a/docs/source/deployment/azure-functions.mdx b/docs/source/deployment/azure-functions.mdx
@@ -95,7 +95,12 @@ const resolvers = {
 };
 
 // Create our server.
-const server = new ApolloServer({ typeDefs, resolvers, csrfPrevention: true });
+const server = new ApolloServer({
+  typeDefs,
+  resolvers,
+  csrfPrevention: true,
+  cache: 'bounded',
+});
 exports.graphqlHandler = server.createHandler();
 ```
 

diff --git a/docs/source/deployment/gcp-functions.mdx b/docs/source/deployment/gcp-functions.mdx
@@ -27,6 +27,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: 'bounded',
 });
 
 exports.handler = server.createHandler();
@@ -164,6 +165,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: 'bounded',
   context: ({ req, res }) => ({
     headers: req.headers,
     req,

diff --git a/docs/source/deployment/lambda.md b/docs/source/deployment/lambda.md
@@ -50,7 +50,12 @@ const resolvers = {
   },
 };
 
-const server = new ApolloServer({ typeDefs, resolvers, csrfPrevention: true });
+const server = new ApolloServer({
+  typeDefs,
+  resolvers,
+  csrfPrevention: true,
+  cache: 'bounded',
+});
 
 exports.graphqlHandler = server.createHandler();
 ```
@@ -211,6 +216,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: 'bounded',
   context: ({ event, context, express }) => ({
     headers: event.headers,
     functionName: context.functionName,

diff --git a/docs/source/getting-started.mdx b/docs/source/getting-started.mdx
@@ -152,6 +152,7 @@ const server = new ApolloServer({
   typeDefs,
   resolvers,
   csrfPrevention: true,
+  cache: 'bounded',
 });
 
 // The `listen` method launches a web server.