Enable cache: no-cache compat flag and enum

Author: tewaro

src/workerd/api/http-test-ts.ts

@@ -50,40 +50,56 @@ async function assertFetchCacheRejectsError(
 
 export const cacheMode = {
   async test(ctrl: any, env: any, ctx: any) {
-    const allowedCacheModes: RequestCache[] = [
+    const allowedCacheModes: Set<RequestCache> = new Set([
       'default',
       'force-cache',
       'no-cache',
       'no-store',
       'only-if-cached',
       'reload',
-    ];
+    ]);
     assert.strictEqual('cache' in Request.prototype, env.CACHE_ENABLED);
     {
       const req = new Request('https://example.org', {});
       assert.strictEqual(req.cache, undefined);
     }
-    if (!env.CACHE_ENABLED) {
-      for (const cacheMode of allowedCacheModes) {
+
+    var enabledCacheModes: Set<RequestCache> = new Set();
+
+    if (env.CACHE_ENABLED) {
+      enabledCacheModes.add('no-store');
+    }
+    if (env.NO_CACHE_ENABLED) {
+      enabledCacheModes.add('no-cache');
+    }
+
+    const failureCacheModes = allowedCacheModes.difference(enabledCacheModes);
+    for (const cacheMode of failureCacheModes) {
+      if (!env.CACHE_ENABLED) {
         await assertRequestCacheThrowsError(cacheMode);
         await assertFetchCacheRejectsError(cacheMode);
+      } else {
+        await assertRequestCacheThrowsError(
+          cacheMode,
+          'TypeError',
+          'Unsupported cache mode: ' + cacheMode
+        );
+        await assertFetchCacheRejectsError(
+          cacheMode,
+          'TypeError',
+          'Unsupported cache mode: ' + cacheMode
+        );
       }
-    } else {
-      var failureCacheModes: RequestCache[] = [
-        'default',
-        'no-cache',
-        'force-cache',
-        'only-if-cached',
-        'reload',
-      ];
+    }
+    for (const cacheMode of enabledCacheModes) {
       {
-        const req = new Request('https://example.org', { cache: 'no-store' });
-        assert.strictEqual(req.cache, 'no-store');
+        const req = new Request('https://example.org', { cache: cacheMode });
+        assert.strictEqual(req.cache, cacheMode);
       }
       {
         const response = await env.SERVICE.fetch(
           'http://placeholder/not-found',
-          { cache: 'no-store' }
+          { cache: cacheMode }
         );
         assert.strictEqual(
           util.inspect(response),
@@ -106,18 +122,6 @@ export const cacheMode = {
 }`
         );
       }
-      for (const cacheMode of failureCacheModes) {
-        await assertRequestCacheThrowsError(
-          cacheMode,
-          'TypeError',
-          'Unsupported cache mode: ' + cacheMode
-        );
-        await assertFetchCacheRejectsError(
-          cacheMode,
-          'TypeError',
-          'Unsupported cache mode: ' + cacheMode
-        );
-      }
     }
   },
 };

src/workerd/api/http-test-ts.ts-wd-test

@@ -10,6 +10,7 @@ const unitTests :Workerd.Config = (
         bindings = [
           ( name = "SERVICE", service = "http-test" ),
           ( name = "CACHE_ENABLED", json = "false" ),
+          ( name = "NO_CACHE_ENABLED", json = "false" ),
         ],
         compatibilityDate = "2023-08-01",
         compatibilityFlags = ["nodejs_compat", "service_binding_extra_handlers", "cache_option_disabled"],
@@ -23,9 +24,24 @@ const unitTests :Workerd.Config = (
         bindings = [
           ( name = "SERVICE", service = "http-test-cache-option-enabled" ),
           ( name = "CACHE_ENABLED", json = "true" ),
+          ( name = "NO_CACHE_ENABLED", json = "false" ),
         ],
-        compatibilityDate = "2023-08-01",
-        compatibilityFlags = ["nodejs_compat", "service_binding_extra_handlers", "cache_option_enabled"],
+        compatibilityDate = "2024-11-11",
+        compatibilityFlags = ["nodejs_compat", "service_binding_extra_handlers"],
+      )
+    ),
+    ( name = "http-test-cache-no-cache",
+      worker = (
+        modules = [
+          ( name = "worker-cache-no-cache", esModule = embed "http-test-ts.js" )
+        ],
+        bindings = [
+          ( name = "SERVICE", service = "http-test-cache-no-cache" ),
+          ( name = "CACHE_ENABLED", json = "true" ),
+          ( name = "NO_CACHE_ENABLED", json = "true" ),
+        ],
+        compatibilityDate = "2024-11-11",
+        compatibilityFlags = ["nodejs_compat", "service_binding_extra_handlers", "cache_no_cache_enabled"],
       )
     ),
   ],

src/workerd/api/http.c++

@@ -1208,7 +1208,7 @@ kj::Maybe<kj::String> Request::serializeCfBlobJson(jsg::Lock& js) {
       break;
     case CacheMode::NOCACHE:
       ttl = 0;
-      KJ_FALLTHROUGH;
+      break;
     case CacheMode::NONE:
       KJ_UNREACHABLE;
   }
@@ -1233,8 +1233,11 @@ void RequestInitializerDict::validate(jsg::Lock& js) {
 
     // Validate that the cache type is valid
     auto cacheMode = getCacheModeFromName(c);
-    JSG_REQUIRE(cacheMode != Request::CacheMode::NOCACHE, TypeError,
-        kj::str("Unsupported cache mode: ", c));
+
+    if (!FeatureFlags::get(js).getCacheNoCache()) {
+      JSG_REQUIRE(cacheMode != Request::CacheMode::NOCACHE, TypeError,
+          kj::str("Unsupported cache mode: ", c));
+    }
   }
 }
 

src/workerd/api/http.h

@@ -753,12 +753,21 @@ struct RequestInitializerDict {
              referrer, referrerPolicy, integrity, signal);
   JSG_STRUCT_TS_OVERRIDE_DYNAMIC(CompatibilityFlags::Reader flags) {
     if(flags.getCacheOptionEnabled()) {
-      JSG_TS_OVERRIDE(RequestInit<Cf = CfProperties> {
-        headers?: HeadersInit;
-        body?: BodyInit | null;
-        cache?: 'no-store';
-        cf?: Cf;
-      });
+      if(flags.getCacheNoCache()) {
+        JSG_TS_OVERRIDE(RequestInit<Cf = CfProperties> {
+          headers?: HeadersInit;
+          body?: BodyInit | null;
+          cache?: 'no-store' | 'no-cache';
+          cf?: Cf;
+        });
+      } else {
+        JSG_TS_OVERRIDE(RequestInit<Cf = CfProperties> {
+          headers?: HeadersInit;
+          body?: BodyInit | null;
+          cache?: 'no-store';
+          cf?: Cf;
+        });
+      }
     } else {
       JSG_TS_OVERRIDE(RequestInit<Cf = CfProperties> {
         headers?: HeadersInit;
@@ -927,12 +936,21 @@ class Request final: public Body {
       JSG_READONLY_PROTOTYPE_PROPERTY(keepalive, getKeepalive);
       if(flags.getCacheOptionEnabled()) {
         JSG_READONLY_PROTOTYPE_PROPERTY(cache, getCache);
-        JSG_TS_OVERRIDE(<CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>> {
-          constructor(input: RequestInfo<CfProperties> | URL, init?: RequestInit<Cf>);
-          clone(): Request<CfHostMetadata, Cf>;
-          cache?: "no-store";
-          get cf(): Cf | undefined;
-        });
+        if(flags.getCacheNoCache()) {
+          JSG_TS_OVERRIDE(<CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>> {
+            constructor(input: RequestInfo<CfProperties> | URL, init?: RequestInit<Cf>);
+            clone(): Request<CfHostMetadata, Cf>;
+            cache?: "no-store" | "no-cache";
+            get cf(): Cf | undefined;
+          });
+        } else {
+          JSG_TS_OVERRIDE(<CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>> {
+            constructor(input: RequestInfo<CfProperties> | URL, init?: RequestInit<Cf>);
+            clone(): Request<CfHostMetadata, Cf>;
+            cache?: "no-store";
+            get cf(): Cf | undefined;
+          });
+        }
       } else {
         JSG_TS_OVERRIDE(<CfHostMetadata = unknown, Cf = CfProperties<CfHostMetadata>> {
           constructor(input: RequestInfo<CfProperties> | URL, init?: RequestInit<Cf>);

src/workerd/io/compatibility-date.capnp

@@ -668,4 +668,10 @@ struct CompatibilityFlags @0x8f8c1b68151b6cef {
   # A bug in the original implementation of TransformStream failed to apply backpressure
   # correctly. The fix, however, can break existing implementations that don't account
   # for the bug so we need to put the fix behind a compat flag.
+
+  cacheNoCache @69 :Bool
+      $compatEnableFlag("cache_no_cache_enabled")
+      $compatDisableFlag("cache_no_cache_disabled")
+      $experimental;
+  # Enables the use of cache: no-cache in the fetch api.
 }