@khanacademy/wonder-blocks-data 8.0.3 → 9.0.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @khanacademy/wonder-blocks-data
 
+## 9.0.0
+
+### Major Changes
+
+-   778f8e43: `SharedCache` export added for interacting with the shared in-memory cache. `purgeSharedCache` method has been removed.
+-   778f8e43: Rename `ScopedCache` type to `RawScopedCache`
+
+## 8.0.5
+
+### Patch Changes
+
+-   08238b89: Export the `getGqlDataFromResponse` method so we can use it in custom `gqlFetch` scenarios for a consistent experience
+
+## 8.0.4
+
+### Patch Changes
+
+-   dc2e00f4: Do not fetch if FetchPolicy is CacheBeforeNetwork and there is already a cached value, even if the requestId changes
+
 ## 8.0.3
 
 ### Patch Changes

package/dist/es/index.js

@@ -390,13 +390,7 @@ const abortInflightRequests = () => {
 };
 
 const cache$1 = new ScopedInMemoryCache();
-const purgeSharedCache = (scope = "") => {
-  if (scope && typeof scope === "string") {
-    cache$1.purgeScope(scope);
-  } else {
-    cache$1.purgeAll();
-  }
-};
+const SharedCache = cache$1;
 const useSharedCache = (id, scope, initialValue) => {
   if (!id || typeof id !== "string") {
     throw new DataError("id must be a non-empty string", DataErrors.InvalidInput);
@@ -422,7 +416,7 @@ const useSharedCache = (id, scope, initialValue) => {
 };
 
 const purgeCaches = () => {
-  purgeSharedCache();
+  SharedCache.purgeAll();
   purgeHydrationCache();
 };
 
@@ -585,7 +579,6 @@ const useCachedEffect = (requestId, handler, options = {}) => {
 
     return fetchFn;
   }, [requestId, onResultChanged, forceUpdate, setMostRecentResult, fetchPolicy]);
-  const requestIdRef = React.useRef(requestId);
   const shouldFetch = React.useMemo(() => {
     if (hardSkip) {
       return false;
@@ -596,14 +589,13 @@ const useCachedEffect = (requestId, handler, options = {}) => {
         return false;
 
       case FetchPolicy.CacheBeforeNetwork:
-        return mostRecentResult == null || requestId !== requestIdRef.current;
+        return mostRecentResult == null;
 
       case FetchPolicy.CacheAndNetwork:
       case FetchPolicy.NetworkOnly:
         return networkResultRef.current == null;
     }
-  }, [requestId, mostRecentResult, fetchPolicy, hardSkip]);
-  requestIdRef.current = requestId;
+  }, [mostRecentResult, fetchPolicy, hardSkip]);
   React.useEffect(() => {
     if (!shouldFetch) {
       return;
@@ -721,6 +713,71 @@ const getGqlRequestId = (operation, variables, context) => {
   return parts.join("|");
 };
 
+const GqlErrors = Object.freeze({
+  Internal: "Internal",
+  BadResponse: "BadResponse",
+  ErrorResult: "ErrorResult"
+});
+class GqlError extends KindError {
+  constructor(message, kind, {
+    metadata,
+    cause
+  } = {}) {
+    super(message, kind, {
+      metadata,
+      cause,
+      name: "Gql"
+    });
+  }
+
+}
+
+const getGqlDataFromResponse = async response => {
+  const bodyText = await response.text();
+  let result;
+
+  try {
+    result = JSON.parse(bodyText);
+  } catch (e) {
+    throw new DataError("Failed to parse response", DataErrors.Parse, {
+      metadata: {
+        statusCode: response.status,
+        bodyText
+      },
+      cause: e
+    });
+  }
+
+  if (response.status >= 300) {
+    throw new DataError("Response unsuccessful", DataErrors.Network, {
+      metadata: {
+        statusCode: response.status,
+        result
+      }
+    });
+  }
+
+  if (!Object.prototype.hasOwnProperty.call(result, "data") && !Object.prototype.hasOwnProperty.call(result, "errors")) {
+    throw new GqlError("Server response missing", GqlErrors.BadResponse, {
+      metadata: {
+        statusCode: response.status,
+        result
+      }
+    });
+  }
+
+  if (result.errors != null && Array.isArray(result.errors) && result.errors.length > 0) {
+    throw new GqlError("GraphQL errors", GqlErrors.ErrorResult, {
+      metadata: {
+        statusCode: response.status,
+        result
+      }
+    });
+  }
+
+  return result.data;
+};
+
 const DocumentTypes = Object.freeze({
   query: "query",
   mutation: "mutation"
@@ -825,25 +882,6 @@ const mergeGqlContext = (defaultContext, overrides) => {
   }, _extends({}, defaultContext));
 };
 
-const GqlErrors = Object.freeze({
-  Internal: "Internal",
-  BadResponse: "BadResponse",
-  ErrorResult: "ErrorResult"
-});
-class GqlError extends KindError {
-  constructor(message, kind, {
-    metadata,
-    cause
-  } = {}) {
-    super(message, kind, {
-      metadata,
-      cause,
-      name: "Gql"
-    });
-  }
-
-}
-
 const useGqlRouterContext = (contextOverrides = {}) => {
   const gqlRouterContext = useContext(GqlRouterContext);
 
@@ -873,52 +911,6 @@ const useGqlRouterContext = (contextOverrides = {}) => {
   return finalRouterContext;
 };
 
-const getGqlDataFromResponse = async response => {
-  const bodyText = await response.text();
-  let result;
-
-  try {
-    result = JSON.parse(bodyText);
-  } catch (e) {
-    throw new DataError("Failed to parse response", DataErrors.Parse, {
-      metadata: {
-        statusCode: response.status,
-        bodyText
-      },
-      cause: e
-    });
-  }
-
-  if (response.status >= 300) {
-    throw new DataError("Response unsuccessful", DataErrors.Network, {
-      metadata: {
-        statusCode: response.status,
-        result
-      }
-    });
-  }
-
-  if (!Object.prototype.hasOwnProperty.call(result, "data") && !Object.prototype.hasOwnProperty.call(result, "errors")) {
-    throw new GqlError("Server response missing", GqlErrors.BadResponse, {
-      metadata: {
-        statusCode: response.status,
-        result
-      }
-    });
-  }
-
-  if (result.errors != null && Array.isArray(result.errors) && result.errors.length > 0) {
-    throw new GqlError("GraphQL errors", GqlErrors.ErrorResult, {
-      metadata: {
-        statusCode: response.status,
-        result
-      }
-    });
-  }
-
-  return result.data;
-};
-
 const useGql = (context = {}) => {
   const gqlRouterContext = useGqlRouterContext(context);
   const gqlFetch = useCallback((operation, options = Object.freeze({})) => {
@@ -936,4 +928,4 @@ const useGql = (context = {}) => {
   return gqlFetch;
 };
 
-export { Data, DataError, DataErrors, FetchPolicy, GqlError, GqlErrors, GqlRouter, InterceptRequests, ScopedInMemoryCache, SerializableInMemoryCache, Status, TrackData, WhenClientSide, abortInflightRequests, fetchTrackedRequests, getGqlRequestId, graphQLDocumentNodeParser, hasTrackedRequestsToBeFetched, initializeHydrationCache, purgeCaches, purgeHydrationCache, purgeSharedCache, toGqlOperation, useCachedEffect, useGql, useHydratableEffect, useServerEffect, useSharedCache };
+export { Data, DataError, DataErrors, FetchPolicy, GqlError, GqlErrors, GqlRouter, InterceptRequests, ScopedInMemoryCache, SerializableInMemoryCache, SharedCache, Status, TrackData, WhenClientSide, abortInflightRequests, fetchTrackedRequests, getGqlDataFromResponse, getGqlRequestId, graphQLDocumentNodeParser, hasTrackedRequestsToBeFetched, initializeHydrationCache, purgeCaches, purgeHydrationCache, toGqlOperation, useCachedEffect, useGql, useHydratableEffect, useServerEffect, useSharedCache };