react-relay 13.0.3 → 13.2.0

package/lib/relay-hooks/QueryResource.js

@@ -24,7 +24,6 @@ var SuspenseResource = require('./SuspenseResource');
 var invariant = require('invariant');
 
 var _require = require('relay-runtime'),
-    RelayFeatureFlags = _require.RelayFeatureFlags,
     isPromise = _require.isPromise;
 
 var warning = require("fbjs/lib/warning");
@@ -66,18 +65,6 @@ function getQueryResult(operation, cacheIdentifier) {
 var nextID = 200000;
 
 function createCacheEntry(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose) {
-  // There should be no behavior difference between createCacheEntry_new and
-  // createCacheEntry_old, and it doesn't directly relate to Client Edges.
-  // It was just a refactoring that was needed for Client Edges but that
-  // is behind the feature flag just in case there is any accidental breakage.
-  if (RelayFeatureFlags.REFACTOR_SUSPENSE_RESOURCE) {
-    return createCacheEntry_new(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose);
-  } else {
-    return createCacheEntry_old(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose);
-  }
-}
-
-function createCacheEntry_new(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose) {
   var isLiveQuery = operationIsLiveQuery(operation);
   var currentValue = value;
   var currentNetworkSubscription = networkSubscription;
@@ -108,12 +95,6 @@ function createCacheEntry_new(cacheIdentifier, operation, operationAvailability,
     setValue: function setValue(val) {
       currentValue = val;
     },
-    getRetainCount: function getRetainCount() {
-      return suspenseResource.getRetainCount();
-    },
-    getNetworkSubscription: function getNetworkSubscription() {
-      return currentNetworkSubscription;
-    },
     setNetworkSubscription: function setNetworkSubscription(subscription) {
       if (isLiveQuery && currentNetworkSubscription != null) {
         currentNetworkSubscription.unsubscribe();
@@ -134,156 +115,12 @@ function createCacheEntry_new(cacheIdentifier, operation, operationAvailability,
   return cacheEntry;
 }
 
-var DATA_RETENTION_TIMEOUT = 5 * 60 * 1000;
-
-function createCacheEntry_old(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose) {
-  var isLiveQuery = operationIsLiveQuery(operation);
-  var currentValue = value;
-  var retainCount = 0;
-  var retainDisposable = null;
-  var _releaseTemporaryRetain = null;
-  var currentNetworkSubscription = networkSubscription;
-
-  var retain = function retain(environment) {
-    retainCount++;
-
-    if (retainCount === 1) {
-      retainDisposable = environment.retain(operation);
-    }
-
-    return {
-      dispose: function dispose() {
-        retainCount = Math.max(0, retainCount - 1);
-
-        if (retainCount === 0) {
-          !(retainDisposable != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected disposable to release query to be defined.' + "If you're seeing this, this is likely a bug in Relay.") : invariant(false) : void 0;
-          retainDisposable.dispose();
-          retainDisposable = null;
-        }
-
-        onDispose(cacheEntry);
-      }
-    };
-  };
-
-  var cacheEntry = {
-    cacheIdentifier: cacheIdentifier,
-    id: nextID++,
-    processedPayloadsCount: 0,
-    operationAvailability: operationAvailability,
-    getValue: function getValue() {
-      return currentValue;
-    },
-    setValue: function setValue(val) {
-      currentValue = val;
-    },
-    getRetainCount: function getRetainCount() {
-      return retainCount;
-    },
-    getNetworkSubscription: function getNetworkSubscription() {
-      return currentNetworkSubscription;
-    },
-    setNetworkSubscription: function setNetworkSubscription(subscription) {
-      if (isLiveQuery && currentNetworkSubscription != null) {
-        currentNetworkSubscription.unsubscribe();
-      }
-
-      currentNetworkSubscription = subscription;
-    },
-    temporaryRetain: function temporaryRetain(environment) {
-      // NOTE: If we're executing in a server environment, there's no need
-      // to create temporary retains, since the component will never commit.
-      if (environment.isServer()) {
-        return {
-          dispose: function dispose() {}
-        };
-      } // NOTE: temporaryRetain is called during the render phase. However,
-      // given that we can't tell if this render will eventually commit or not,
-      // we create a timer to autodispose of this retain in case the associated
-      // component never commits.
-      // If the component /does/ commit, permanentRetain will clear this timeout
-      // and permanently retain the data.
-
-
-      var disposable = retain(environment);
-      var releaseQueryTimeout = null;
-
-      var localReleaseTemporaryRetain = function localReleaseTemporaryRetain() {
-        clearTimeout(releaseQueryTimeout);
-        releaseQueryTimeout = null;
-        _releaseTemporaryRetain = null;
-        disposable.dispose(); // Normally if this entry never commits, the request would've ended by the
-        // time this timeout expires and the temporary retain is released. However,
-        // we need to do this for live queries which remain open indefinitely.
-
-        if (isLiveQuery && retainCount <= 0 && currentNetworkSubscription != null) {
-          currentNetworkSubscription.unsubscribe();
-        }
-      };
-
-      releaseQueryTimeout = setTimeout(localReleaseTemporaryRetain, DATA_RETENTION_TIMEOUT); // NOTE: Since temporaryRetain can be called multiple times, we release
-      // the previous temporary retain after we re-establish a new one, since
-      // we only ever need a single temporary retain until the permanent retain is
-      // established.
-      // temporaryRetain may be called multiple times by React during the render
-      // phase, as well as multiple times by other query components that are
-      // rendering the same query/variables.
-
-      if (_releaseTemporaryRetain != null) {
-        _releaseTemporaryRetain();
-      }
-
-      _releaseTemporaryRetain = localReleaseTemporaryRetain;
-      return {
-        dispose: function dispose() {
-          _releaseTemporaryRetain && _releaseTemporaryRetain();
-        }
-      };
-    },
-    permanentRetain: function permanentRetain(environment) {
-      var disposable = retain(environment);
-
-      if (_releaseTemporaryRetain != null) {
-        _releaseTemporaryRetain();
-
-        _releaseTemporaryRetain = null;
-      }
-
-      return {
-        dispose: function dispose() {
-          disposable.dispose();
-
-          if (isLiveQuery && retainCount <= 0 && currentNetworkSubscription != null) {
-            currentNetworkSubscription.unsubscribe();
-          }
-        }
-      };
-    },
-    releaseTemporaryRetain: function releaseTemporaryRetain() {
-      if (_releaseTemporaryRetain != null) {
-        _releaseTemporaryRetain();
-
-        _releaseTemporaryRetain = null;
-      }
-    }
-  };
-  return cacheEntry;
-}
-
 var QueryResourceImpl = /*#__PURE__*/function () {
   function QueryResourceImpl(environment) {
     var _this = this;
 
     (0, _defineProperty2["default"])(this, "_clearCacheEntry", function (cacheEntry) {
-      // The new code does this retainCount <= 0 check within SuspenseResource
-      // before calling _clearCacheEntry, whereas with the old code we do it here.
-      if (RelayFeatureFlags.REFACTOR_SUSPENSE_RESOURCE) {
-        _this._cache["delete"](cacheEntry.cacheIdentifier);
-      } else {
-        if (cacheEntry.getRetainCount() <= 0) {
-          _this._cache["delete"](cacheEntry.cacheIdentifier);
-        }
-      }
+      _this._cache["delete"](cacheEntry.cacheIdentifier);
     });
     this._environment = environment;
     this._cache = LRUCache.create(CACHE_CAPACITY);
@@ -529,7 +366,7 @@ var QueryResourceImpl = /*#__PURE__*/function () {
           } else {
             // TODO:T92030819 Remove this warning and actually throw the network error
             // To complete this task we need to have a way of precisely tracking suspendable points
-            process.env.NODE_ENV !== "production" ? warning(false, 'QueryResource: An incremental payload for query `%` returned an error: `%`:`%`.', operation.fragment.node.name, _error.message, _error.stack) : void 0;
+            process.env.NODE_ENV !== "production" ? warning(false, 'QueryResource: An incremental payload for query `%s` returned an error: `%s`.', operation.fragment.node.name, String(_error.message)) : void 0;
           }
 
           resolveNetworkPromise();

package/lib/relay-hooks/preloadQuery_DEPRECATED.js

@@ -64,17 +64,13 @@ function preloadQuery(environment, preloadableRequest, variables, options, envir
         return;
       }
 
-      if (RelayFeatureFlags.DELAY_CLEANUP_OF_PENDING_PRELOAD_QUERIES === true) {
-        setTimeout(function () {
-          // Clear the cache entry after the default timeout
-          // null-check for Flow
-          if (queryEntry != null) {
-            cleanup(pendingQueries, queryEntry);
-          }
-        }, DEFAULT_PREFETCH_TIMEOUT);
-      } else {
-        cleanup(pendingQueries, queryEntry);
-      }
+      setTimeout(function () {
+        // Clear the cache entry after the default timeout
+        // null-check for Flow
+        if (queryEntry != null) {
+          cleanup(pendingQueries, queryEntry);
+        }
+      }, DEFAULT_PREFETCH_TIMEOUT);
     };
   }) : null;
   return {

package/lib/relay-hooks/react-cache/RelayReactCache.js

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * 
+ * @emails oncall+relay
+ * @format
+ */
+// flowlint ambiguous-object-type:error
+'use strict';
+
+var invariant = require('invariant'); // $FlowFixMe[prop-missing] These exist in experimental builds but aren't in React's types yet.
+
+
+var _require = require('react'),
+    unstable_getCacheForType = _require.unstable_getCacheForType,
+    unstable_getCacheSignal = _require.unstable_getCacheSignal;
+
+var _require2 = require('relay-runtime'),
+    RelayFeatureFlags = _require2.RelayFeatureFlags;
+
+function getCacheForType(factory) {
+  !(typeof unstable_getCacheForType === 'function' && RelayFeatureFlags.USE_REACT_CACHE) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReactCache.getCacheForType should only be called when the USE_REACT_CACHE feature flag is enabled and when on an experimental React build that supports it.') : invariant(false) : void 0;
+  return unstable_getCacheForType(factory);
+}
+
+function getCacheSignal() {
+  !(typeof unstable_getCacheSignal === 'function' && RelayFeatureFlags.USE_REACT_CACHE) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReactCache.getCacheSignal should only be called when the USE_REACT_CACHE feature flag is enabled and when on an experimental React build that supports it.') : invariant(false) : void 0;
+  return unstable_getCacheSignal();
+}
+
+module.exports = {
+  getCacheForType: getCacheForType,
+  getCacheSignal: getCacheSignal
+};

package/lib/relay-hooks/react-cache/getQueryResultOrFetchQuery_REACT_CACHE.js

@@ -0,0 +1,197 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * 
+ * @emails oncall+relay
+ * @format
+ */
+// flowlint ambiguous-object-type:error
+'use strict';
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _require = require('./RelayReactCache'),
+    getCacheForType = _require.getCacheForType,
+    getCacheSignal = _require.getCacheSignal;
+
+var invariant = require('invariant');
+
+var _require2 = require('relay-runtime'),
+    fetchQueryInternal = _require2.__internal.fetchQuery;
+
+var warning = require("fbjs/lib/warning");
+
+var DEFAULT_FETCH_POLICY = 'store-or-network';
+
+function createQueryCache() {
+  return new Map();
+}
+
+function getQueryCacheKey(operation, fetchPolicy, renderPolicy) {
+  var cacheIdentifier = "".concat(fetchPolicy, "-").concat(renderPolicy, "-").concat(operation.request.identifier);
+  return cacheIdentifier;
+}
+
+function constructQueryResult(operation) {
+  var rootFragmentRef = {
+    __id: operation.fragment.dataID,
+    __fragments: (0, _defineProperty2["default"])({}, operation.fragment.node.name, operation.request.variables),
+    __fragmentOwner: operation.request
+  };
+  return {
+    fragmentNode: operation.request.node.fragment,
+    fragmentRef: rootFragmentRef
+  };
+}
+
+function getQueryResultOrFetchQuery_REACT_CACHE(environment, queryOperationDescriptor) {
+  var fetchPolicy = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : DEFAULT_FETCH_POLICY;
+  var maybeRenderPolicy = arguments.length > 3 ? arguments[3] : undefined;
+  var renderPolicy = maybeRenderPolicy !== null && maybeRenderPolicy !== void 0 ? maybeRenderPolicy : environment.UNSTABLE_getDefaultRenderPolicy();
+  var cache = getCacheForType(createQueryCache);
+  var cacheKey = getQueryCacheKey(queryOperationDescriptor, fetchPolicy, renderPolicy);
+  var entry = cache.get(cacheKey);
+
+  if (entry === undefined) {
+    // Initiate a query to fetch the data if needed:
+    entry = onCacheMiss(environment, queryOperationDescriptor, fetchPolicy, renderPolicy, function (newCacheEntry) {
+      cache.set(cacheKey, newCacheEntry);
+    });
+    cache.set(cacheKey, entry); // Since this is the first time rendering, retain the query. React will
+    // trigger the abort signal when this cache entry is no longer needed.
+
+    var retention = environment.retain(queryOperationDescriptor);
+    var abortSignal = getCacheSignal();
+    abortSignal.addEventListener('abort', function () {
+      retention.dispose();
+      cache["delete"](cacheKey);
+    }, {
+      once: true
+    });
+  }
+
+  switch (entry.status) {
+    case 'pending':
+      throw entry.promise;
+
+    case 'rejected':
+      throw entry.error;
+
+    case 'resolved':
+      return entry.result;
+  }
+
+  !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'switch statement should be exhaustive') : invariant(false) : void 0;
+}
+
+function onCacheMiss(environment, operation, fetchPolicy, renderPolicy, updateCache) {
+  // NB: Besides checking if the data is available, calling `check` will write missing
+  // data to the store using any missing data handlers specified in the environment.
+  var queryAvailability = environment.check(operation);
+  var queryStatus = queryAvailability.status;
+  var hasFullQuery = queryStatus === 'available';
+  var canPartialRender = hasFullQuery || renderPolicy === 'partial' && queryStatus !== 'stale';
+  var shouldFetch;
+  var shouldRenderNow;
+
+  switch (fetchPolicy) {
+    case 'store-only':
+      {
+        shouldFetch = false;
+        shouldRenderNow = true;
+        break;
+      }
+
+    case 'store-or-network':
+      {
+        shouldFetch = !hasFullQuery;
+        shouldRenderNow = canPartialRender;
+        break;
+      }
+
+    case 'store-and-network':
+      {
+        shouldFetch = true;
+        shouldRenderNow = canPartialRender;
+        break;
+      }
+
+    case 'network-only':
+    default:
+      {
+        shouldFetch = true;
+        shouldRenderNow = false;
+        break;
+      }
+  }
+
+  var promise = shouldFetch ? executeOperationAndKeepUpToDate(environment, operation, updateCache) : undefined;
+
+  if (shouldRenderNow) {
+    return {
+      status: 'resolved',
+      result: constructQueryResult(operation)
+    };
+  } else {
+    !promise ? process.env.NODE_ENV !== "production" ? invariant(false, 'Should either fetch or render (or both), otherwise we would suspend forever.') : invariant(false) : void 0;
+    return {
+      status: 'pending',
+      promise: promise
+    };
+  }
+}
+
+function executeOperationAndKeepUpToDate(environment, operation, updateCache) {
+  var resolvePromise;
+  var promise = new Promise(function (r) {
+    resolvePromise = r;
+  }); // $FlowExpectedError[prop-missing] Expando to annotate Promises.
+
+  promise.displayName = 'Relay(' + operation.request.node.operation.name + ')';
+  var isFirstPayload = true; // FIXME We may still need to cancel network requests for live queries.
+
+  var fetchObservable = fetchQueryInternal(environment, operation);
+  fetchObservable.subscribe({
+    start: function start(subscription) {},
+    error: function error(_error) {
+      if (isFirstPayload) {
+        updateCache({
+          status: 'rejected',
+          error: _error
+        });
+      } else {
+        // TODO:T92030819 Remove this warning and actually throw the network error
+        // To complete this task we need to have a way of precisely tracking suspendable points
+        process.env.NODE_ENV !== "production" ? warning(false, 'getQueryResultOrFetchQuery: An incremental payload for query `%` returned an error: `%`:`%`.', operation.request.node.operation.name, _error.message, _error.stack) : void 0;
+      }
+
+      resolvePromise();
+      isFirstPayload = false;
+    },
+    next: function next(response) {
+      // Stop suspending on the first payload because of streaming, defer, etc.
+      updateCache({
+        status: 'resolved',
+        result: constructQueryResult(operation)
+      });
+      resolvePromise();
+      isFirstPayload = false;
+    },
+    complete: function complete() {
+      updateCache({
+        status: 'resolved',
+        result: constructQueryResult(operation)
+      });
+      resolvePromise();
+      isFirstPayload = false;
+    }
+  });
+  return promise;
+}
+
+module.exports = getQueryResultOrFetchQuery_REACT_CACHE;