@khanacademy/wonder-blocks-data 8.0.1 → 8.0.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @khanacademy/wonder-blocks-data
 
+## 8.0.2
+
+### Patch Changes
+
+-   580141ed: Always initialize SSR-only cache
+
 ## 8.0.1
 
 ### Patch Changes

package/dist/es/index.js

@@ -172,11 +172,10 @@ class SsrCache {
     };
 
     this.getEntry = id => {
-      var _this$_ssrOnlyCache$g, _this$_ssrOnlyCache;
+      const ssrEntry = Server.isServerSide() ? this._ssrOnlyCache.get(DefaultScope$2, id) : null;
+      const internalEntry = ssrEntry != null ? ssrEntry : this._hydrationCache.get(DefaultScope$2, id);
 
-      const internalEntry = (_this$_ssrOnlyCache$g = (_this$_ssrOnlyCache = this._ssrOnlyCache) == null ? void 0 : _this$_ssrOnlyCache.get(DefaultScope$2, id)) != null ? _this$_ssrOnlyCache$g : this._hydrationCache.get(DefaultScope$2, id);
-
-      if (this._ssrOnlyCache == null && internalEntry != null) {
+      if (!Server.isServerSide() && internalEntry != null) {
         this._hydrationCache.purge(DefaultScope$2, id);
       }
 
@@ -184,13 +183,11 @@ class SsrCache {
     };
 
     this.purgeData = predicate => {
-      var _this$_ssrOnlyCache2;
-
       const realPredicate = predicate ? (_, key, cachedEntry) => predicate(key, cachedEntry) : undefined;
 
       this._hydrationCache.purgeAll(realPredicate);
 
-      (_this$_ssrOnlyCache2 = this._ssrOnlyCache) == null ? void 0 : _this$_ssrOnlyCache2.purgeAll(realPredicate);
+      this._ssrOnlyCache.purgeAll(realPredicate);
     };
 
     this.cloneHydratableData = () => {
@@ -201,7 +198,7 @@ class SsrCache {
       return (_cache$DefaultScope = cache[DefaultScope$2]) != null ? _cache$DefaultScope : {};
     };
 
-    this._ssrOnlyCache = process.env.NODE_ENV === "test" || Server.isServerSide() ? ssrOnlyCache || new SerializableInMemoryCache() : undefined;
+    this._ssrOnlyCache = ssrOnlyCache || new SerializableInMemoryCache();
     this._hydrationCache = hydrationCache || new SerializableInMemoryCache();
   }
 
@@ -212,9 +209,7 @@ class SsrCache {
       if (hydrate) {
         this._hydrationCache.set(DefaultScope$2, id, frozenEntry);
       } else {
-        var _this$_ssrOnlyCache3;
-
-        (_this$_ssrOnlyCache3 = this._ssrOnlyCache) == null ? void 0 : _this$_ssrOnlyCache3.set(DefaultScope$2, id, frozenEntry);
+        this._ssrOnlyCache.set(DefaultScope$2, id, frozenEntry);
       }
     }
 

package/dist/index.js

@@ -165,6 +165,12 @@ module.exports = require("react");
 
 /***/ }),
 /* 2 */
+/***/ (function(module, exports) {
+
+module.exports = require("@khanacademy/wonder-blocks-core");
+
+/***/ }),
+/* 3 */
 /***/ (function(module, __webpack_exports__, __webpack_require__) {
 
 "use strict";
@@ -187,12 +193,6 @@ const FetchPolicy = __webpack_require__(22).Mirrored(["CacheBeforeNetwork", "Cac
  * and functions are not allowed.
  */
 
-/***/ }),
-/* 3 */
-/***/ (function(module, exports) {
-
-module.exports = require("@khanacademy/wonder-blocks-core");
-
 /***/ }),
 /* 4 */
 /***/ (function(module, __webpack_exports__, __webpack_require__) {
@@ -556,7 +556,7 @@ class RequestTracker {
 
 "use strict";
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return SsrCache; });
-/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(3);
+/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(2);
 /* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(_khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var _serializable_in_memory_cache_js__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(13);
 
@@ -608,14 +608,14 @@ class SsrCache {
     };
 
     this.getEntry = id => {
-      var _this$_ssrOnlyCache$g, _this$_ssrOnlyCache;
-
       // Get the cached entry for this value.
-      // We first look in the ssr cache and then the hydration cache.
-      const internalEntry = (_this$_ssrOnlyCache$g = (_this$_ssrOnlyCache = this._ssrOnlyCache) == null ? void 0 : _this$_ssrOnlyCache.get(DefaultScope, id)) != null ? _this$_ssrOnlyCache$g : this._hydrationCache.get(DefaultScope, id); // If we are not server-side and we hydrated something, let's clear
+      // We first look in the ssr cache, if we need to.
+      const ssrEntry = _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__["Server"].isServerSide() ? this._ssrOnlyCache.get(DefaultScope, id) : null; // Now we defer to the SSR value, and fallback to the hydration cache.
+
+      const internalEntry = ssrEntry != null ? ssrEntry : this._hydrationCache.get(DefaultScope, id); // If we are not server-side and we hydrated something, let's clear
       // that from the hydration cache to save memory.
 
-      if (this._ssrOnlyCache == null && internalEntry != null) {
+      if (!_khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__["Server"].isServerSide() && internalEntry != null) {
         // We now delete this from our hydration cache as we don't need it.
         // This does mean that if another handler of the same type but
         // without some sort of linked cache won't get the value, but
@@ -632,8 +632,6 @@ class SsrCache {
     };
 
     this.purgeData = predicate => {
-      var _this$_ssrOnlyCache2;
-
       const realPredicate = predicate ? // We know what we're putting into the cache so let's assume it
       // conforms.
       // $FlowIgnore[incompatible-call]
@@ -641,7 +639,7 @@ class SsrCache {
 
       this._hydrationCache.purgeAll(realPredicate);
 
-      (_this$_ssrOnlyCache2 = this._ssrOnlyCache) == null ? void 0 : _this$_ssrOnlyCache2.purgeAll(realPredicate);
+      this._ssrOnlyCache.purgeAll(realPredicate);
     };
 
     this.cloneHydratableData = () => {
@@ -658,13 +656,7 @@ class SsrCache {
       return (_cache$DefaultScope = cache[DefaultScope]) != null ? _cache$DefaultScope : {};
     };
 
-    // 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._ssrOnlyCache = ssrOnlyCache || new _serializable_in_memory_cache_js__WEBPACK_IMPORTED_MODULE_1__[/* SerializableInMemoryCache */ "a"]();
     this._hydrationCache = hydrationCache || new _serializable_in_memory_cache_js__WEBPACK_IMPORTED_MODULE_1__[/* SerializableInMemoryCache */ "a"]();
   }
 
@@ -677,12 +669,10 @@ class SsrCache {
       if (hydrate) {
         this._hydrationCache.set(DefaultScope, id, frozenEntry);
       } else {
-        var _this$_ssrOnlyCache3;
-
         // Usually, when server-side, this cache will always be present.
         // We do fake server-side in our doc example though, when it
         // won't be.
-        (_this$_ssrOnlyCache3 = this._ssrOnlyCache) == null ? void 0 : _this$_ssrOnlyCache3.set(DefaultScope, id, frozenEntry);
+        this._ssrOnlyCache.set(DefaultScope, id, frozenEntry);
       }
     }
 
@@ -927,7 +917,7 @@ class ScopedInMemoryCache {
 /* harmony import */ var _use_server_effect_js__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(16);
 /* harmony import */ var _use_shared_cache_js__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(5);
 /* harmony import */ var _use_cached_effect_js__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(17);
-/* harmony import */ var _util_types_js__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(2);
+/* harmony import */ var _util_types_js__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(3);
 
 
 
@@ -1129,7 +1119,7 @@ const purgeHydrationCache = predicate => _ssr_cache_js__WEBPACK_IMPORTED_MODULE_
 
 "use strict";
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return useServerEffect; });
-/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(3);
+/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(2);
 /* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(_khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var react__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(1);
 /* harmony import */ var react__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(react__WEBPACK_IMPORTED_MODULE_1__);
@@ -1194,14 +1184,14 @@ const useServerEffect = (requestId, handler, options = {}) => {
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return useCachedEffect; });
 /* harmony import */ var react__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(1);
 /* harmony import */ var react__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(react__WEBPACK_IMPORTED_MODULE_0__);
-/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(3);
+/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(2);
 /* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(_khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_1__);
 /* harmony import */ var _util_data_error_js__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(0);
 /* harmony import */ var _util_request_fulfillment_js__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(10);
 /* harmony import */ var _util_status_js__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(6);
 /* harmony import */ var _use_shared_cache_js__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(5);
 /* harmony import */ var _use_request_interception_js__WEBPACK_IMPORTED_MODULE_6__ = __webpack_require__(19);
-/* harmony import */ var _util_types_js__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(2);
+/* harmony import */ var _util_types_js__WEBPACK_IMPORTED_MODULE_7__ = __webpack_require__(3);
 
 
 
@@ -1718,7 +1708,7 @@ module.exports = Object.freeze(Enum);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "b", function() { return fetchTrackedRequests; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "c", function() { return hasTrackedRequestsToBeFetched; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return abortInflightRequests; });
-/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(3);
+/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(2);
 /* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(_khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var _request_tracking_js__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(8);
 /* harmony import */ var _request_fulfillment_js__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(10);
@@ -1818,7 +1808,7 @@ const purgeCaches = () => {
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "a", function() { return TrackData; });
 /* harmony import */ var react__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(1);
 /* harmony import */ var react__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(react__WEBPACK_IMPORTED_MODULE_0__);
-/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(3);
+/* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(2);
 /* harmony import */ var _khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_1___default = /*#__PURE__*/__webpack_require__.n(_khanacademy_wonder_blocks_core__WEBPACK_IMPORTED_MODULE_1__);
 /* harmony import */ var _util_request_tracking_js__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(8);
 
@@ -2272,7 +2262,7 @@ const getGqlDataFromResponse = async response => {
 
 "use strict";
 __webpack_require__.r(__webpack_exports__);
-/* harmony import */ var _util_types_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(2);
+/* harmony import */ var _util_types_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(3);
 /* harmony reexport (safe) */ __webpack_require__.d(__webpack_exports__, "FetchPolicy", function() { return _util_types_js__WEBPACK_IMPORTED_MODULE_0__["a"]; });
 
 /* harmony import */ var _util_hydration_cache_api_js__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(15);

package/package.json

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

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

@@ -17,61 +17,51 @@ describe("../ssr-cache.js", () => {
     });
 
     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("should default the ssr-only cache to a cache instance", () => {
+            // Arrange
+
+            // Act
+            const cache = new SsrCache();
+
+            // Assert
+            expect(cache._ssrOnlyCache).toBeInstanceOf(
+                SerializableInMemoryCache,
+            );
         });
 
-        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;
+        it("should set the hydration cache to the passed instance if there is one", () => {
+            // Arrange
+            const passedInstance = new SerializableInMemoryCache();
 
-                // Act
-                const cache = new SsrCache();
+            // Act
+            const cache = new SsrCache(null, passedInstance);
 
-                // Assert
-                expect(cache._ssrOnlyCache).toBeUndefined();
-            },
-        );
+            // Assert
+            expect(cache._ssrOnlyCache).toBe(passedInstance);
+        });
 
-        it("should default the ssr-only cache to a cache instance when client-side in test", () => {
+        it("should default the hydration cache to a cache instance", () => {
             // Arrange
-            jest.spyOn(Server, "isServerSide").mockReturnValue(false);
-            process.env.NODE_ENV = "test";
 
             // Act
             const cache = new SsrCache();
 
             // Assert
-            expect(cache._ssrOnlyCache).toBeInstanceOf(
+            expect(cache._hydrationCache).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;
+        it("should set the hydration cache to the passed instance if there is one", () => {
+            // Arrange
+            const passedInstance = new SerializableInMemoryCache();
 
-                // Act
-                const cache = new SsrCache();
+            // Act
+            const cache = new SsrCache(passedInstance);
 
-                // Assert
-                expect(cache._ssrOnlyCache).toBeInstanceOf(
-                    SerializableInMemoryCache,
-                );
-            },
-        );
+            // Assert
+            expect(cache._hydrationCache).toBe(passedInstance);
+        });
     });
 
     describe("@Default", () => {

package/src/util/ssr-cache.js

@@ -26,22 +26,13 @@ export class SsrCache {
     }
 
     _hydrationCache: SerializableInMemoryCache;
-    _ssrOnlyCache: ?SerializableInMemoryCache;
+    _ssrOnlyCache: SerializableInMemoryCache;
 
     constructor(
         hydrationCache: ?SerializableInMemoryCache = null,
         ssrOnlyCache: ?SerializableInMemoryCache = null,
     ) {
-        // 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._ssrOnlyCache = ssrOnlyCache || new SerializableInMemoryCache();
         this._hydrationCache =
             hydrationCache || new SerializableInMemoryCache();
     }
@@ -61,7 +52,7 @@ export class SsrCache {
                 // Usually, when server-side, this cache will always be present.
                 // We do fake server-side in our doc example though, when it
                 // won't be.
-                this._ssrOnlyCache?.set(DefaultScope, id, frozenEntry);
+                this._ssrOnlyCache.set(DefaultScope, id, frozenEntry);
             }
         }
         return frozenEntry;
@@ -127,14 +118,18 @@ export class SsrCache {
     ): ?$ReadOnly<CachedResponse<TData>> => {
         // Get the cached entry for this value.
 
-        // We first look in the ssr cache and then the hydration cache.
+        // We first look in the ssr cache, if we need to.
+        const ssrEntry = Server.isServerSide()
+            ? this._ssrOnlyCache.get(DefaultScope, id)
+            : null;
+
+        // Now we defer to the SSR value, and fallback to the hydration cache.
         const internalEntry =
-            this._ssrOnlyCache?.get(DefaultScope, id) ??
-            this._hydrationCache.get(DefaultScope, id);
+            ssrEntry ?? this._hydrationCache.get(DefaultScope, id);
 
         // If we are not server-side and we hydrated something, let's clear
         // that from the hydration cache to save memory.
-        if (this._ssrOnlyCache == null && internalEntry != null) {
+        if (!Server.isServerSide() && internalEntry != null) {
             // We now delete this from our hydration cache as we don't need it.
             // This does mean that if another handler of the same type but
             // without some sort of linked cache won't get the value, but
@@ -172,7 +167,7 @@ export class SsrCache {
 
         // Apply the predicate to what we have in our caches.
         this._hydrationCache.purgeAll(realPredicate);
-        this._ssrOnlyCache?.purgeAll(realPredicate);
+        this._ssrOnlyCache.purgeAll(realPredicate);
     };
 
     /**