react-relay 13.1.1 → 13.2.0

package/ReactRelayContext.js

@@ -1,5 +1,5 @@
 /**
- * Relay v13.1.1
+ * Relay v13.2.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/ReactRelayLocalQueryRenderer.js.flow

@@ -40,7 +40,7 @@ const queryRendererContext: ReactRelayQueryRendererContextType = {
   rootIsQueryRenderer: true,
 };
 
-function useDeepCompare<T: interface {}>(value: T): T {
+function useDeepCompare<T: {...}>(value: T): T {
   const latestValue = React.useRef(value);
   if (!areEqual(latestValue.current, value)) {
     if (__DEV__) {

package/ReactRelayQueryRenderer.js.flow

@@ -157,10 +157,7 @@ class ReactRelayQueryRenderer extends React.Component<Props, State> {
   }
 
   componentDidMount() {
-    if (
-      RelayFeatureFlags.ENABLE_QUERY_RENDERER_OFFSCREEN_SUPPORT === true &&
-      this._maybeHiddenOrFastRefresh === true
-    ) {
+    if (this._maybeHiddenOrFastRefresh === true) {
       // This block only runs if the component has previously "unmounted"
       // due to it being hidden by the Offscreen API, or during fast refresh.
       // At this point, the current cached resource will have been disposed

package/hooks.js

@@ -1,5 +1,5 @@
 /**
- * Relay v13.1.1
+ * Relay v13.2.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v13.1.1
+ * Relay v13.2.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/jest-react/internalAct.js.flow

@@ -36,7 +36,7 @@ interface Thenable<+R> {
 
 let actingUpdatesScopeDepth = 0;
 
-function act(scope: () => Thenable<mixed> | void) {
+function act<T>(scope: () => Thenable<T> | T): Thenable<T> {
   if (Scheduler.unstable_flushAllWithoutAsserting === undefined) {
     throw Error(
       'This version of `act` requires a special mock build of Scheduler.',
@@ -49,10 +49,19 @@ function act(scope: () => Thenable<mixed> | void) {
     );
   }
 
+  const previousIsActEnvironment = global.IS_REACT_ACT_ENVIRONMENT;
   const previousActingUpdatesScopeDepth = actingUpdatesScopeDepth;
   actingUpdatesScopeDepth++;
+  if (__DEV__ && actingUpdatesScopeDepth === 1) {
+    // Because this is not the "real" `act`, we set this to `false` so React
+    // knows not to fire `act` warnings.
+    global.IS_REACT_ACT_ENVIRONMENT = false;
+  }
 
   const unwind = () => {
+    if (__DEV__ && actingUpdatesScopeDepth === 1) {
+      global.IS_REACT_ACT_ENVIRONMENT = previousIsActEnvironment;
+    }
     actingUpdatesScopeDepth--;
 
     if (__DEV__) {
@@ -71,20 +80,21 @@ function act(scope: () => Thenable<mixed> | void) {
   // returned and 2) we could use async/await. Since it's only our used in
   // our test suite, we should be able to.
   try {
-    const thenable = scope();
+    const result = scope();
     if (
-      typeof thenable === 'object' &&
-      thenable !== null &&
-      typeof thenable.then === 'function'
+      typeof result === 'object' &&
+      result !== null &&
+      typeof result.then === 'function'
     ) {
+      const thenableResult: Thenable<T> = (result: any);
       return {
-        then(resolve: () => void, reject: (error: mixed) => void) {
-          thenable.then(
-            () => {
+        then(resolve, reject) {
+          thenableResult.then(
+            returnValue => {
               flushActWork(
                 () => {
                   unwind();
-                  resolve();
+                  resolve(returnValue);
                 },
                 error => {
                   unwind();
@@ -100,6 +110,7 @@ function act(scope: () => Thenable<mixed> | void) {
         },
       };
     } else {
+      const returnValue: T = (result: any);
       try {
         // TODO: Let's not support non-async scopes at all in our tests. Need to
         // migrate existing tests.
@@ -107,6 +118,11 @@ function act(scope: () => Thenable<mixed> | void) {
         do {
           didFlushWork = Scheduler.unstable_flushAllWithoutAsserting();
         } while (didFlushWork);
+        return {
+          then(resolve, reject) {
+            resolve(returnValue);
+          },
+        };
       } finally {
         unwind();
       }

package/legacy.js

@@ -1,5 +1,5 @@
 /**
- * Relay v13.1.1
+ * Relay v13.2.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/lib/ReactRelayQueryRenderer.js

@@ -132,7 +132,7 @@ var ReactRelayQueryRenderer = /*#__PURE__*/function (_React$Component) {
   _proto.componentDidMount = function componentDidMount() {
     var _this2 = this;
 
-    if (RelayFeatureFlags.ENABLE_QUERY_RENDERER_OFFSCREEN_SUPPORT === true && this._maybeHiddenOrFastRefresh === true) {
+    if (this._maybeHiddenOrFastRefresh === true) {
       // This block only runs if the component has previously "unmounted"
       // due to it being hidden by the Offscreen API, or during fast refresh.
       // At this point, the current cached resource will have been disposed

package/lib/jest-react/internalAct.js

@@ -36,10 +36,21 @@ function act(scope) {
     throw Error("This version of `act` requires Jest's timer mocks " + '(i.e. jest.useFakeTimers).');
   }
 
+  var previousIsActEnvironment = global.IS_REACT_ACT_ENVIRONMENT;
   var previousActingUpdatesScopeDepth = actingUpdatesScopeDepth;
   actingUpdatesScopeDepth++;
 
+  if (process.env.NODE_ENV !== "production" && actingUpdatesScopeDepth === 1) {
+    // Because this is not the "real" `act`, we set this to `false` so React
+    // knows not to fire `act` warnings.
+    global.IS_REACT_ACT_ENVIRONMENT = false;
+  }
+
   var unwind = function unwind() {
+    if (process.env.NODE_ENV !== "production" && actingUpdatesScopeDepth === 1) {
+      global.IS_REACT_ACT_ENVIRONMENT = previousIsActEnvironment;
+    }
+
     actingUpdatesScopeDepth--;
 
     if (process.env.NODE_ENV !== "production") {
@@ -55,15 +66,16 @@ function act(scope) {
 
 
   try {
-    var thenable = scope();
+    var result = scope();
 
-    if (typeof thenable === 'object' && thenable !== null && typeof thenable.then === 'function') {
+    if (typeof result === 'object' && result !== null && typeof result.then === 'function') {
+      var thenableResult = result;
       return {
         then: function then(resolve, reject) {
-          thenable.then(function () {
+          thenableResult.then(function (returnValue) {
             flushActWork(function () {
               unwind();
-              resolve();
+              resolve(returnValue);
             }, function (error) {
               unwind();
               reject(error);
@@ -75,6 +87,8 @@ function act(scope) {
         }
       };
     } else {
+      var returnValue = result;
+
       try {
         // TODO: Let's not support non-async scopes at all in our tests. Need to
         // migrate existing tests.
@@ -83,6 +97,12 @@ function act(scope) {
         do {
           didFlushWork = Scheduler.unstable_flushAllWithoutAsserting();
         } while (didFlushWork);
+
+        return {
+          then: function then(resolve, reject) {
+            resolve(returnValue);
+          }
+        };
       } finally {
         unwind();
       }

package/lib/relay-hooks/FragmentResource.js

@@ -38,9 +38,9 @@ var _require2 = require('relay-runtime'),
     getPendingOperationsForFragment = _require2.getPendingOperationsForFragment,
     getSelector = _require2.getSelector,
     getVariablesFromFragment = _require2.getVariablesFromFragment,
+    handlePotentialSnapshotErrors = _require2.handlePotentialSnapshotErrors,
     isPromise = _require2.isPromise,
-    recycleNodesInto = _require2.recycleNodesInto,
-    reportMissingRequiredFields = _require2.reportMissingRequiredFields;
+    recycleNodesInto = _require2.recycleNodesInto;
 
 var WEAKMAP_SUPPORTED = typeof WeakMap === 'function';
 // TODO: Fix to not rely on LRU. If the number of active fragments exceeds this
@@ -263,7 +263,7 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
       }
 
       if (cachedValue.kind === 'done' && cachedValue.result.snapshot) {
-        this._reportMissingRequiredFieldsInSnapshot(cachedValue.result.snapshot);
+        this._handlePotentialSnapshotErrorsInSnapshot(cachedValue.result.snapshot);
 
         return cachedValue.result;
       }
@@ -279,7 +279,7 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     var fragmentResult = getFragmentResult(fragmentIdentifier, snapshot, storeEpoch);
 
     if (!fragmentResult.isMissingData) {
-      this._reportMissingRequiredFieldsInSnapshot(snapshot);
+      this._handlePotentialSnapshotErrorsInSnapshot(snapshot);
 
       this._cache.set(fragmentIdentifier, {
         kind: 'done',
@@ -361,7 +361,7 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
       throw ((_clientEdgePromises2 = clientEdgePromises) === null || _clientEdgePromises2 === void 0 ? void 0 : _clientEdgePromises2.length) ? Promise.all([parentQueryPromiseResultPromise].concat((0, _toConsumableArray2["default"])(clientEdgePromises))) : parentQueryPromiseResultPromise;
     }
 
-    this._reportMissingRequiredFieldsInSnapshot(snapshot);
+    this._handlePotentialSnapshotErrorsInSnapshot(snapshot);
 
     return getFragmentResult(fragmentIdentifier, snapshot, storeEpoch);
   };
@@ -383,19 +383,15 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     };
   };
 
-  _proto2._reportMissingRequiredFieldsInSnapshot = function _reportMissingRequiredFieldsInSnapshot(snapshot) {
+  _proto2._handlePotentialSnapshotErrorsInSnapshot = function _handlePotentialSnapshotErrorsInSnapshot(snapshot) {
     var _this4 = this;
 
     if (Array.isArray(snapshot)) {
       snapshot.forEach(function (s) {
-        if (s.missingRequiredFields != null) {
-          reportMissingRequiredFields(_this4._environment, s.missingRequiredFields);
-        }
+        handlePotentialSnapshotErrors(_this4._environment, s.missingRequiredFields, s.relayResolverErrors);
       });
     } else {
-      if (snapshot.missingRequiredFields != null) {
-        reportMissingRequiredFields(this._environment, snapshot.missingRequiredFields);
-      }
+      handlePotentialSnapshotErrors(this._environment, snapshot.missingRequiredFields, snapshot.relayResolverErrors);
     }
   };
 
@@ -559,7 +555,8 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
       missingClientEdges: currentSnapshot.missingClientEdges,
       seenRecords: currentSnapshot.seenRecords,
       selector: currentSnapshot.selector,
-      missingRequiredFields: currentSnapshot.missingRequiredFields
+      missingRequiredFields: currentSnapshot.missingRequiredFields,
+      relayResolverErrors: currentSnapshot.relayResolverErrors
     };
 
     if (updatedData !== renderData) {

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
+};