Add option to disable caching with default/named caches

Author: mrbbot

src/cli.ts

@@ -122,6 +122,10 @@ export default function parseArgv(raw: string[]): Options {
         // type: "boolean" | "string",
         description: "Path to persist cached data to (omit path for default)",
       },
+      "disable-cache": {
+        type: "boolean",
+        description: "Disable caching with default/named caches",
+      },
       site: {
         type: "string",
         description: "Path to serve Workers Site files from",
@@ -212,6 +216,7 @@ export default function parseArgv(raw: string[]): Options {
     kvNamespaces: asStringArray(argv.kv),
     kvPersist: argv["kv-persist"] as boolean | string | undefined,
     cachePersist: argv["cache-persist"] as boolean | string | undefined,
+    disableCache: argv["disable-cache"],
     sitePath: argv.site,
     siteInclude: asStringArray(argv["site-include"]),
     siteExclude: asStringArray(argv["site-exclude"]),

src/kv/cache.ts

@@ -35,7 +35,16 @@ function getKey(req: Request): string {
   return `${req.url}.json`;
 }
 
-export class Cache {
+export interface CacheInterface {
+  put(req: string | Request, res: Response): Promise<undefined>;
+  match(
+    req: string | Request,
+    options?: CacheMatchOptions
+  ): Promise<Response | undefined>;
+  delete(req: string | Request, options?: CacheMatchOptions): Promise<boolean>;
+}
+
+export class Cache implements CacheInterface {
   readonly #storage: KVStorage;
   readonly #clock: KVClock;
   readonly #namespace: KVStorageNamespace;
@@ -149,3 +158,23 @@ export class Cache {
     return this.#storage.delete(key);
   }
 }
+
+export class NoOpCache implements CacheInterface {
+  async put(_req: string | Request, _res: Response): Promise<undefined> {
+    return;
+  }
+
+  async match(
+    _req: string | Request,
+    _options?: CacheMatchOptions
+  ): Promise<Response | undefined> {
+    return;
+  }
+
+  async delete(
+    _req: string | Request,
+    _options?: CacheMatchOptions
+  ): Promise<boolean> {
+    return false;
+  }
+}

src/modules/cache.ts

@@ -1,6 +1,6 @@
 import path from "path";
 import { MiniflareError } from "../error";
-import { Cache } from "../kv";
+import { Cache, NoOpCache } from "../kv";
 import { KVStorageFactory } from "../kv/helpers";
 import { Log } from "../log";
 import { ProcessedOptions } from "../options";
@@ -9,6 +9,8 @@ import { Context, Module } from "./module";
 const defaultPersistRoot = path.resolve(".mf", "cache");
 const defaultCacheName = "default";
 
+const noopCache = new NoOpCache();
+
 export class CacheModule extends Module {
   constructor(
     log: Log,
@@ -22,7 +24,9 @@ export class CacheModule extends Module {
   }
 
   buildSandbox(options: ProcessedOptions): Context {
-    const defaultCache = this.getCache(undefined, options.cachePersist);
+    const defaultCache = options.disableCache
+      ? noopCache
+      : this.getCache(undefined, options.cachePersist);
     return {
       caches: {
         default: defaultCache,
@@ -32,7 +36,9 @@ export class CacheModule extends Module {
               `\"${defaultCacheName}\" is a reserved cache name`
             );
           }
-          return this.getCache(name, options.cachePersist);
+          return options.disableCache
+            ? noopCache
+            : this.getCache(name, options.cachePersist);
         },
       },
     };
@@ -42,3 +48,5 @@ export class CacheModule extends Module {
     this.storageFactory.dispose();
   }
 }
+
+export { Cache, NoOpCache };

src/modules/index.ts

@@ -1,3 +1,4 @@
+export { Cache, NoOpCache } from "./cache";
 export { DurableObject } from "./do";
 export { FetchEvent, ScheduledEvent, ResponseWaitUntil } from "./events";
 export {

src/options/index.ts

@@ -83,6 +83,7 @@ export interface Options {
   kvPersist?: boolean | string;
 
   cachePersist?: boolean | string;
+  disableCache?: boolean;
 
   sitePath?: string;
   siteInclude?: string[];
@@ -140,6 +141,7 @@ export function logOptions(log: Log, options: ProcessedOptions): void {
     "KV Namespaces": options.kvNamespaces,
     "KV Persistence": options.kvPersist,
     "Cache Persistence": options.cachePersist,
+    "Disable Cache": options.disableCache,
     "Workers Site Path": options.sitePath,
     "Workers Site Include": options.siteIncludeRegexps,
     // Only include excludeRegexps if there are no includeRegexps

test/cli.spec.ts

@@ -44,6 +44,7 @@ test("parseArgv: parses complete argv", (t) => {
     "TEST_NAMESPACE2",
     "--kv-persist",
     "--cache-persist",
+    "--disable-cache",
     "--site",
     "public",
     "--site-include",
@@ -91,6 +92,7 @@ test("parseArgv: parses complete argv", (t) => {
     kvNamespaces: ["TEST_NAMESPACE1", "TEST_NAMESPACE2"],
     kvPersist: true,
     cachePersist: true,
+    disableCache: true,
     sitePath: "public",
     siteInclude: ["upload_dir"],
     siteExclude: ["ignore_dir"],

test/kv/cache.spec.ts

@@ -6,6 +6,7 @@ import {
   CachedResponse,
   KVStorage,
   MemoryKVStorage,
+  NoOpCache,
   Request,
   Response,
 } from "../../src";
@@ -205,3 +206,12 @@ test("Cache: hides implementation details", (t) => {
   const { cache } = t.context;
   t.deepEqual(getObjectProperties(cache), ["delete", "match", "put"]);
 });
+
+test("NoOpCache: doesn't cache", async (t) => {
+  const req = "http://localhost:8787/test";
+  const cache = new NoOpCache();
+  t.is(await cache.put(req, testResponse.clone()), undefined);
+  t.is(await cache.match(req), undefined);
+  t.is(await cache.put(req, testResponse.clone()), undefined);
+  t.false(await cache.delete(req));
+});

test/modules/cache.spec.ts

@@ -3,6 +3,7 @@ import path from "path";
 import test from "ava";
 import {
   Cache,
+  CacheInterface,
   CachedResponse,
   MiniflareError,
   NoOpLog,
@@ -263,3 +264,34 @@ test("buildSandbox: trying to open default cache throws", async (t) => {
     message: '"default" is a reserved cache name',
   });
 });
+
+test("buildSandbox: disabling cache disables caches", async (t) => {
+  const res = await runInWorker({ disableCache: true }, async () => {
+    const sandbox = self as any;
+    const cache = sandbox.caches.default as CacheInterface;
+    const otherCache = (await sandbox.caches.open("other")) as CacheInterface;
+
+    const req = "http://localhost:8787/test";
+    const res = new sandbox.Response("value", {
+      headers: { "Cache-Control": "max-age=3600" },
+    });
+
+    await cache.put(req, res.clone());
+    const matched = (await cache.match(req)) !== undefined;
+    await cache.put(req, res.clone());
+    const deleted = await cache.delete(req);
+
+    await otherCache.put(req, res.clone());
+    const matchedOther = (await otherCache.match(req)) !== undefined;
+    await otherCache.put(req, res.clone());
+    const deletedOther = await otherCache.delete(req);
+
+    return { matched, deleted, matchedOther, deletedOther };
+  });
+  t.deepEqual(res, {
+    matched: false,
+    deleted: false,
+    matchedOther: false,
+    deletedOther: false,
+  });
+});

test/options/index.spec.ts

@@ -54,6 +54,7 @@ test("logOptions: logs all options", (t) => {
     kvNamespaces: ["NAMESPACE1", "NAMESPACE2"],
     kvPersist: "kv-data",
     cachePersist: false,
+    disableCache: true,
     sitePath: "public",
     siteIncludeRegexps: [regexp1, regexp2],
     processedDurableObjects: [
@@ -77,6 +78,7 @@ test("logOptions: logs all options", (t) => {
     "- KV Namespaces: NAMESPACE1, NAMESPACE2",
     "- KV Persistence: kv-data",
     "- Cache Persistence: false",
+    "- Disable Cache: true",
     "- Workers Site Path: public",
     "- Workers Site Include: regexp1, regexp2",
     "- Durable Objects: OBJECT1, OBJECT2",