react-relay 16.1.0 → 16.2.0

package/ReactRelayContext.js

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

package/ReactRelayTypes.js.flow

@@ -103,6 +103,7 @@ export type $FragmentRef<T> = {
  */
 // prettier-ignore
 // $FlowFixMe[extra-type-arg] xplat redux flow type error
+// $FlowFixMe[deprecated-type]
 export type $RelayProps<Props, RelayPropT = RelayProp> = $ObjMap<
   $Diff<Props, { relay: RelayPropT | void, ... }>,
   & (<T: { +$fragmentType: empty, ... }>( T) =>  T)

package/hooks.js

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

package/hooks.js.flow

@@ -42,7 +42,7 @@ export type {
   RefetchFn,
   RefetchFnDynamic,
   Options as RefetchOptions,
-} from './relay-hooks/useRefetchableFragmentNode';
+} from './relay-hooks/legacy/useRefetchableFragmentNode';
 export type {
   DataID,
   DeclarativeMutationConfig,

package/index.js

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

package/index.js.flow

@@ -59,7 +59,7 @@ export type {
   RefetchFn,
   RefetchFnDynamic,
   Options as RefetchOptions,
-} from './relay-hooks/useRefetchableFragmentNode';
+} from './relay-hooks/legacy/useRefetchableFragmentNode';
 export type {
   DataID,
   DeclarativeMutationConfig,

package/legacy.js

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

package/lib/relay-hooks/SuspenseResource.js

@@ -2,7 +2,7 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var invariant = require('invariant');
+var warning = require("fbjs/lib/warning");
 var TEMPORARY_RETAIN_DURATION_MS = 5 * 60 * 1000;
 var SuspenseResource = /*#__PURE__*/function () {
   function SuspenseResource(retain) {
@@ -19,9 +19,12 @@ var SuspenseResource = /*#__PURE__*/function () {
         dispose: function dispose() {
           _this._retainCount = Math.max(0, _this._retainCount - 1);
           if (_this._retainCount === 0) {
-            !(_this._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;
-            _this._retainDisposable.dispose();
-            _this._retainDisposable = null;
+            if (_this._retainDisposable != null) {
+              _this._retainDisposable.dispose();
+              _this._retainDisposable = null;
+            } else {
+              process.env.NODE_ENV !== "production" ? warning(false, 'Relay: Expected disposable to release query to be defined.' + "If you're seeing this, this is likely a bug in Relay.") : void 0;
+            }
           }
         }
       };

package/lib/relay-hooks/experimental/readFragmentInternal_EXPERIMENTAL.js

@@ -66,14 +66,14 @@ function getMissingClientEdges(state) {
 }
 function handlePotentialSnapshotErrorsForState(environment, state) {
   if (state.kind === 'singular') {
-    handlePotentialSnapshotErrors(environment, state.snapshot.missingRequiredFields, state.snapshot.relayResolverErrors);
+    handlePotentialSnapshotErrors(environment, state.snapshot.missingRequiredFields, state.snapshot.relayResolverErrors, state.snapshot.errorResponseFields);
   } else if (state.kind === 'plural') {
     var _iterator3 = (0, _createForOfIteratorHelper2["default"])(state.snapshots),
       _step3;
     try {
       for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
         var snapshot = _step3.value;
-        handlePotentialSnapshotErrors(environment, snapshot.missingRequiredFields, snapshot.relayResolverErrors);
+        handlePotentialSnapshotErrors(environment, snapshot.missingRequiredFields, snapshot.relayResolverErrors, snapshot.errorResponseFields);
       }
     } catch (err) {
       _iterator3.e(err);

package/lib/relay-hooks/experimental/useFragmentInternal_EXPERIMENTAL.js

@@ -15,7 +15,9 @@ var _require2 = require('react'),
   useRef = _require2.useRef,
   useState = _require2.useState;
 var _require3 = require('relay-runtime'),
-  fetchQueryInternal = _require3.__internal.fetchQuery,
+  _require3$__internal = _require3.__internal,
+  fetchQueryInternal = _require3$__internal.fetchQuery,
+  getPromiseForActiveRequest = _require3$__internal.getPromiseForActiveRequest,
   RelayFeatureFlags = _require3.RelayFeatureFlags,
   areEqualSelectors = _require3.areEqualSelectors,
   createOperationDescriptor = _require3.createOperationDescriptor,
@@ -114,14 +116,14 @@ function getSuspendingLiveResolver(state) {
 }
 function handlePotentialSnapshotErrorsForState(environment, state) {
   if (state.kind === 'singular') {
-    handlePotentialSnapshotErrors(environment, state.snapshot.missingRequiredFields, state.snapshot.relayResolverErrors);
+    handlePotentialSnapshotErrors(environment, state.snapshot.missingRequiredFields, state.snapshot.relayResolverErrors, state.snapshot.errorResponseFields);
   } else if (state.kind === 'plural') {
     var _iterator5 = (0, _createForOfIteratorHelper2["default"])(state.snapshots),
       _step5;
     try {
       for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
         var snapshot = _step5.value;
-        handlePotentialSnapshotErrors(environment, snapshot.missingRequiredFields, snapshot.relayResolverErrors);
+        handlePotentialSnapshotErrors(environment, snapshot.missingRequiredFields, snapshot.relayResolverErrors, snapshot.errorResponseFields);
       }
     } catch (err) {
       _iterator5.e(err);
@@ -149,7 +151,8 @@ function handleMissedUpdates(environment, state) {
       seenRecords: currentSnapshot.seenRecords,
       selector: currentSnapshot.selector,
       missingRequiredFields: currentSnapshot.missingRequiredFields,
-      relayResolverErrors: currentSnapshot.relayResolverErrors
+      relayResolverErrors: currentSnapshot.relayResolverErrors,
+      errorResponseFields: currentSnapshot.errorResponseFields
     };
     return [updatedData !== state.snapshot.data, {
       kind: 'singular',
@@ -171,7 +174,8 @@ function handleMissedUpdates(environment, state) {
         seenRecords: _currentSnapshot.seenRecords,
         selector: _currentSnapshot.selector,
         missingRequiredFields: _currentSnapshot.missingRequiredFields,
-        relayResolverErrors: _currentSnapshot.relayResolverErrors
+        relayResolverErrors: _currentSnapshot.relayResolverErrors,
+        errorResponseFields: _currentSnapshot.errorResponseFields
       };
       if (_updatedData !== snapshot.data) {
         didMissUpdates = true;
@@ -193,9 +197,10 @@ function handleMissingClientEdge(environment, parentFragmentNode, parentFragment
   });
   var queryOperationDescriptor = createOperationDescriptor(missingClientEdgeRequestInfo.request, variables, queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.networkCacheConfig);
   var QueryResource = getQueryResourceForEnvironment(environment);
-  return QueryResource.prepare(queryOperationDescriptor, fetchQueryInternal(environment, queryOperationDescriptor), queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.fetchPolicy);
+  var queryResult = QueryResource.prepare(queryOperationDescriptor, fetchQueryInternal(environment, queryOperationDescriptor), queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.fetchPolicy);
+  return [queryResult, getPromiseForActiveRequest(environment, queryOperationDescriptor.request)];
 }
-function subscribeToSnapshot(environment, state, setState) {
+function subscribeToSnapshot(environment, state, setState, hasPendingStateChanges) {
   if (state.kind === 'bailout') {
     return function () {};
   } else if (state.kind === 'singular') {
@@ -210,11 +215,13 @@ function subscribeToSnapshot(environment, state, setState) {
               name: 'useFragment.subscription.missedUpdates',
               hasDataChanges: dataChanged
             });
+            hasPendingStateChanges.current = dataChanged;
             return dataChanged ? nextState : prevState;
           } else {
             return prevState;
           }
         }
+        hasPendingStateChanges.current = true;
         return {
           kind: 'singular',
           snapshot: latestSnapshot,
@@ -239,6 +246,7 @@ function subscribeToSnapshot(environment, state, setState) {
                 name: 'useFragment.subscription.missedUpdates',
                 hasDataChanges: dataChanged
               });
+              hasPendingStateChanges.current = hasPendingStateChanges.current || dataChanged;
               return dataChanged ? nextState : prevState;
             } else {
               return prevState;
@@ -246,6 +254,7 @@ function subscribeToSnapshot(environment, state, setState) {
           }
           var updated = (0, _toConsumableArray2["default"])(prevState.snapshots);
           updated[index] = latestSnapshot;
+          hasPendingStateChanges.current = true;
           return {
             kind: 'plural',
             snapshots: updated,
@@ -334,26 +343,38 @@ function useFragmentInternal_EXPERIMENTAL(fragmentNode, fragmentRef, hookDisplay
     committedFragmentSelectorRef.current = fragmentSelector;
   }, [fragmentSelector]);
   if (((_fragmentNode$metadat2 = fragmentNode.metadata) === null || _fragmentNode$metadat2 === void 0 ? void 0 : _fragmentNode$metadat2.hasClientEdges) === true) {
-    var clientEdgeQueries = useMemo(function () {
-      var missingClientEdges = getMissingClientEdges(state);
-      var clientEdgeQueries;
-      if (missingClientEdges !== null && missingClientEdges !== void 0 && missingClientEdges.length) {
-        clientEdgeQueries = [];
-        var _iterator7 = (0, _createForOfIteratorHelper2["default"])(missingClientEdges),
-          _step7;
-        try {
-          for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
-            var edge = _step7.value;
-            clientEdgeQueries.push(handleMissingClientEdge(environment, fragmentNode, fragmentRef, edge, queryOptions));
+    var _useMemo = useMemo(function () {
+        var missingClientEdges = getMissingClientEdges(state);
+        var clientEdgeQueries;
+        var activeRequestPromises = [];
+        if (missingClientEdges !== null && missingClientEdges !== void 0 && missingClientEdges.length) {
+          clientEdgeQueries = [];
+          var _iterator7 = (0, _createForOfIteratorHelper2["default"])(missingClientEdges),
+            _step7;
+          try {
+            for (_iterator7.s(); !(_step7 = _iterator7.n()).done;) {
+              var edge = _step7.value;
+              var _handleMissingClientE = handleMissingClientEdge(environment, fragmentNode, fragmentRef, edge, queryOptions),
+                queryResult = _handleMissingClientE[0],
+                requestPromise = _handleMissingClientE[1];
+              clientEdgeQueries.push(queryResult);
+              if (requestPromise != null) {
+                activeRequestPromises.push(requestPromise);
+              }
+            }
+          } catch (err) {
+            _iterator7.e(err);
+          } finally {
+            _iterator7.f();
           }
-        } catch (err) {
-          _iterator7.e(err);
-        } finally {
-          _iterator7.f();
         }
-      }
-      return clientEdgeQueries;
-    }, [state, environment, fragmentNode, fragmentRef, queryOptions]);
+        return [clientEdgeQueries, activeRequestPromises];
+      }, [state, environment, fragmentNode, fragmentRef, queryOptions]),
+      clientEdgeQueries = _useMemo[0],
+      activeRequestPromises = _useMemo[1];
+    if (activeRequestPromises.length) {
+      throw Promise.all(activeRequestPromises);
+    }
     useEffect(function () {
       var QueryResource = getQueryResourceForEnvironment(environment);
       if (clientEdgeQueries !== null && clientEdgeQueries !== void 0 && clientEdgeQueries.length) {
@@ -395,7 +416,7 @@ function useFragmentInternal_EXPERIMENTAL(fragmentNode, fragmentRef, hookDisplay
         return environment.getStore().getLiveResolverPromise(liveStateID);
       }));
     }
-    if (!committedFragmentSelectorRef.current || !areEqualSelectors(committedFragmentSelectorRef.current, fragmentSelector)) {
+    if (environment !== previousEnvironment || !committedFragmentSelectorRef.current || !areEqualSelectors(committedFragmentSelectorRef.current, fragmentSelector)) {
       !(fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'refinement, see invariants above') : invariant(false) : void 0;
       var fragmentOwner = fragmentSelector.kind === 'PluralReaderSelector' ? fragmentSelector.selectors[0].owner : fragmentSelector.owner;
       var pendingOperationsResult = getPendingOperationsForFragment(environment, fragmentNode, fragmentOwner);
@@ -405,6 +426,7 @@ function useFragmentInternal_EXPERIMENTAL(fragmentNode, fragmentRef, hookDisplay
     }
   }
   handlePotentialSnapshotErrorsForState(environment, state);
+  var hasPendingStateChanges = useRef(false);
   useEffect(function () {
     var currentState = subscribedState;
     var updates = handleMissedUpdates(environment, subscribedState);
@@ -416,8 +438,20 @@ function useFragmentInternal_EXPERIMENTAL(fragmentNode, fragmentRef, hookDisplay
       }
       currentState = updatedState;
     }
-    return subscribeToSnapshot(environment, currentState, setState);
+    return subscribeToSnapshot(environment, currentState, setState, hasPendingStateChanges);
   }, [environment, subscribedState]);
+  if (hasPendingStateChanges.current) {
+    var updates = handleMissedUpdates(environment, state);
+    if (updates != null) {
+      var hasStateUpdates = updates[0],
+        updatedState = updates[1];
+      if (hasStateUpdates) {
+        setState(updatedState);
+        state = updatedState;
+      }
+    }
+    hasPendingStateChanges.current = false;
+  }
   var data;
   if (isPlural) {
     var fragmentRefIsNullish = fragmentRef == null;

package/lib/relay-hooks/{FragmentResource.js → legacy/FragmentResource.js}

@@ -4,10 +4,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-var LRUCache = require('./LRUCache');
-var _require = require('./QueryResource'),
+var LRUCache = require('../LRUCache');
+var _require = require('../QueryResource'),
   getQueryResourceForEnvironment = _require.getQueryResourceForEnvironment;
-var SuspenseResource = require('./SuspenseResource');
+var SuspenseResource = require('../SuspenseResource');
 var invariant = require('invariant');
 var _require2 = require('relay-runtime'),
   _require2$__internal = _require2.__internal,
@@ -311,10 +311,10 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     var _this4 = this;
     if (Array.isArray(snapshot)) {
       snapshot.forEach(function (s) {
-        handlePotentialSnapshotErrors(_this4._environment, s.missingRequiredFields, s.relayResolverErrors);
+        handlePotentialSnapshotErrors(_this4._environment, s.missingRequiredFields, s.relayResolverErrors, s.errorResponseFields);
       });
     } else {
-      handlePotentialSnapshotErrors(this._environment, snapshot.missingRequiredFields, snapshot.relayResolverErrors);
+      handlePotentialSnapshotErrors(this._environment, snapshot.missingRequiredFields, snapshot.relayResolverErrors, snapshot.errorResponseFields);
     }
   };
   _proto2.readSpec = function readSpec(fragmentNodes, fragmentRefs, componentDisplayName) {
@@ -459,7 +459,8 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
       seenRecords: currentSnapshot.seenRecords,
       selector: currentSnapshot.selector,
       missingRequiredFields: currentSnapshot.missingRequiredFields,
-      relayResolverErrors: currentSnapshot.relayResolverErrors
+      relayResolverErrors: currentSnapshot.relayResolverErrors,
+      errorResponseFields: currentSnapshot.errorResponseFields
     };
     if (updatedData !== renderData) {
       var _result = getFragmentResult(cacheKey, updatedCurrentSnapshot, storeEpoch);

package/lib/relay-hooks/{useBlockingPaginationFragment.js → legacy/useBlockingPaginationFragment.js}

@@ -4,9 +4,9 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 var _excluded = ["disableStoreUpdates", "enableStoreUpdates"];
-var useLoadMoreFunction = require('./useLoadMoreFunction');
+var useLoadMoreFunction = require('../useLoadMoreFunction');
+var useStaticFragmentNodeWarning = require('../useStaticFragmentNodeWarning');
 var useRefetchableFragmentNode = require('./useRefetchableFragmentNode');
-var useStaticFragmentNodeWarning = require('./useStaticFragmentNodeWarning');
 var invariant = require('invariant');
 var _require = require('react'),
   useCallback = _require.useCallback,

package/lib/relay-hooks/{useFragmentNode.js → legacy/useFragmentNode.js}

@@ -1,9 +1,9 @@
 'use strict';
 
+var useRelayEnvironment = require('../useRelayEnvironment');
+var useUnsafeRef_DEPRECATED = require('../useUnsafeRef_DEPRECATED');
 var _require = require('./FragmentResource'),
   getFragmentResourceForEnvironment = _require.getFragmentResourceForEnvironment;
-var useRelayEnvironment = require('./useRelayEnvironment');
-var useUnsafeRef_DEPRECATED = require('./useUnsafeRef_DEPRECATED');
 var _require2 = require('react'),
   useEffect = _require2.useEffect,
   useState = _require2.useState;

package/lib/relay-hooks/{useRefetchableFragmentNode.js → legacy/useRefetchableFragmentNode.js}

@@ -2,15 +2,15 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-var _require = require('./FragmentResource'),
-  getFragmentResourceForEnvironment = _require.getFragmentResourceForEnvironment;
-var ProfilerContext = require('./ProfilerContext');
-var _require2 = require('./QueryResource'),
-  getQueryResourceForEnvironment = _require2.getQueryResourceForEnvironment;
+var ProfilerContext = require('../ProfilerContext');
+var _require = require('../QueryResource'),
+  getQueryResourceForEnvironment = _require.getQueryResourceForEnvironment;
+var useIsMountedRef = require('../useIsMountedRef');
+var useQueryLoader = require('../useQueryLoader');
+var useRelayEnvironment = require('../useRelayEnvironment');
+var _require2 = require('./FragmentResource'),
+  getFragmentResourceForEnvironment = _require2.getFragmentResourceForEnvironment;
 var useFragmentNode = require('./useFragmentNode');
-var useIsMountedRef = require('./useIsMountedRef');
-var useQueryLoader = require('./useQueryLoader');
-var useRelayEnvironment = require('./useRelayEnvironment');
 var invariant = require('invariant');
 var _require3 = require('react'),
   useCallback = _require3.useCallback,

package/lib/relay-hooks/useFragment.js

@@ -1,9 +1,9 @@
 'use strict';
 
 var HooksImplementation = require('./HooksImplementation');
+var useFragmentNode = require('./legacy/useFragmentNode');
 var _require = require('./loadQuery'),
   useTrackLoadQueryInRender = _require.useTrackLoadQueryInRender;
-var useFragmentNode = require('./useFragmentNode');
 var useStaticFragmentNodeWarning = require('./useStaticFragmentNodeWarning');
 var _require2 = require('react'),
   useDebugValue = _require2.useDebugValue;

package/lib/relay-hooks/useLazyLoadQueryNode.js

@@ -1,12 +1,12 @@
 'use strict';
 
 var HooksImplementation = require('./HooksImplementation');
+var useFragmentNode = require('./legacy/useFragmentNode');
 var ProfilerContext = require('./ProfilerContext');
 var _require = require('./QueryResource'),
   getQueryCacheIdentifier = _require.getQueryCacheIdentifier,
   getQueryResourceForEnvironment = _require.getQueryResourceForEnvironment;
 var useFetchTrackingRef = require('./useFetchTrackingRef');
-var useFragmentNode = require('./useFragmentNode');
 var useRelayEnvironment = require('./useRelayEnvironment');
 var React = require('react');
 var useContext = React.useContext,

package/lib/relay-hooks/usePaginationFragment.js

@@ -3,8 +3,8 @@
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 var HooksImplementation = require('./HooksImplementation');
+var useRefetchableFragmentNode = require('./legacy/useRefetchableFragmentNode');
 var useLoadMoreFunction = require('./useLoadMoreFunction');
-var useRefetchableFragmentNode = require('./useRefetchableFragmentNode');
 var useStaticFragmentNodeWarning = require('./useStaticFragmentNodeWarning');
 var _require = require('react'),
   useCallback = _require.useCallback,

package/lib/relay-hooks/useRefetchableFragment.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var HooksImplementation = require('./HooksImplementation');
-var useRefetchableFragmentNode = require('./useRefetchableFragmentNode');
+var useRefetchableFragmentNode = require('./legacy/useRefetchableFragmentNode');
 var useStaticFragmentNodeWarning = require('./useStaticFragmentNodeWarning');
 var _require = require('react'),
   useDebugValue = _require.useDebugValue;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-relay",
   "description": "A framework for building GraphQL-driven React applications.",
-  "version": "16.1.0",
+  "version": "16.2.0",
   "keywords": [
     "graphql",
     "relay",
@@ -20,7 +20,7 @@
     "fbjs": "^3.0.2",
     "invariant": "^2.2.4",
     "nullthrows": "^1.1.1",
-    "relay-runtime": "16.1.0"
+    "relay-runtime": "16.2.0"
   },
   "peerDependencies": {
     "react": "^16.9.0 || ^17 || ^18"