@khanacademy/wonder-blocks-data 8.0.0 → 8.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @khanacademy/wonder-blocks-data
 
+## 8.0.1
+
+### Patch Changes
+
+-   e5fa4d9e: Make sure ssr-only cache is initialized when purging caches in test environment
+
 ## 8.0.0
 
 ### Major Changes

package/dist/es/index.js

@@ -201,7 +201,7 @@ class SsrCache {
       return (_cache$DefaultScope = cache[DefaultScope$2]) != null ? _cache$DefaultScope : {};
     };
 
-    this._ssrOnlyCache = Server.isServerSide() ? ssrOnlyCache || new SerializableInMemoryCache() : undefined;
+    this._ssrOnlyCache = process.env.NODE_ENV === "test" || Server.isServerSide() ? ssrOnlyCache || new SerializableInMemoryCache() : undefined;
     this._hydrationCache = hydrationCache || new SerializableInMemoryCache();
   }
 

package/dist/index.js

@@ -658,7 +658,13 @@ class SsrCache {
       return (_cache$DefaultScope = cache[DefaultScope]) != null ? _cache$DefaultScope : {};
     };
 
-    this._ssrOnlyCache = _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__["Server"].isServerSide() ? ssrOnlyCache || new _serializable_in_memory_cache_js__WEBPACK_IMPORTED_MODULE_1__[/* SerializableInMemoryCache */ "a"]() : undefined;
+    // The default instance gets made on first reference and if that happens
+    // before server-side mode is turned on, the Default instance would
+    // never have an SSR-only cache instance, which would then mean that if
+    // server-side mode got turned on, it wouldn't work right.
+    // This should only be an issue of surprise during testing, so, let's
+    // always have an instance in that circumstance.
+    this._ssrOnlyCache =  false || _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__["Server"].isServerSide() ? ssrOnlyCache || new _serializable_in_memory_cache_js__WEBPACK_IMPORTED_MODULE_1__[/* SerializableInMemoryCache */ "a"]() : undefined;
     this._hydrationCache = hydrationCache || new _serializable_in_memory_cache_js__WEBPACK_IMPORTED_MODULE_1__[/* SerializableInMemoryCache */ "a"]();
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@khanacademy/wonder-blocks-data",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "design": "v1",
   "publishConfig": {
     "access": "public"

package/src/util/__tests__/ssr-cache.test.js

@@ -16,6 +16,64 @@ describe("../ssr-cache.js", () => {
         jest.restoreAllMocks();
     });
 
+    describe("#constructor", () => {
+        const NODE_ENV = process.env.NODE_ENV;
+
+        afterEach(() => {
+            if (NODE_ENV == null) {
+                delete process.env.NODE_ENV;
+            } else {
+                process.env.NODE_ENV = NODE_ENV;
+            }
+        });
+
+        it.each(["development", "production"])(
+            "should default the ssr-only cache to a undefined when client-side in %s",
+            (nodeEnv) => {
+                // Arrange
+                jest.spyOn(Server, "isServerSide").mockReturnValue(false);
+                process.env.NODE_ENV = nodeEnv;
+
+                // Act
+                const cache = new SsrCache();
+
+                // Assert
+                expect(cache._ssrOnlyCache).toBeUndefined();
+            },
+        );
+
+        it("should default the ssr-only cache to a cache instance when client-side in test", () => {
+            // Arrange
+            jest.spyOn(Server, "isServerSide").mockReturnValue(false);
+            process.env.NODE_ENV = "test";
+
+            // Act
+            const cache = new SsrCache();
+
+            // Assert
+            expect(cache._ssrOnlyCache).toBeInstanceOf(
+                SerializableInMemoryCache,
+            );
+        });
+
+        it.each(["development", "production"])(
+            "should default the ssr-only cache to a cache instance when server-side in %s",
+            (nodeEnv) => {
+                // Arrange
+                jest.spyOn(Server, "isServerSide").mockReturnValue(true);
+                process.env.NODE_ENV = nodeEnv;
+
+                // Act
+                const cache = new SsrCache();
+
+                // Assert
+                expect(cache._ssrOnlyCache).toBeInstanceOf(
+                    SerializableInMemoryCache,
+                );
+            },
+        );
+    });
+
     describe("@Default", () => {
         it("should return an instance of SsrCache", () => {
             // Arrange

package/src/util/ssr-cache.js

@@ -32,9 +32,16 @@ export class SsrCache {
         hydrationCache: ?SerializableInMemoryCache = null,
         ssrOnlyCache: ?SerializableInMemoryCache = null,
     ) {
-        this._ssrOnlyCache = Server.isServerSide()
-            ? ssrOnlyCache || new SerializableInMemoryCache()
-            : undefined;
+        // The default instance gets made on first reference and if that happens
+        // before server-side mode is turned on, the Default instance would
+        // never have an SSR-only cache instance, which would then mean that if
+        // server-side mode got turned on, it wouldn't work right.
+        // This should only be an issue of surprise during testing, so, let's
+        // always have an instance in that circumstance.
+        this._ssrOnlyCache =
+            process.env.NODE_ENV === "test" || Server.isServerSide()
+                ? ssrOnlyCache || new SerializableInMemoryCache()
+                : undefined;
         this._hydrationCache =
             hydrationCache || new SerializableInMemoryCache();
     }