react-relay 15.0.0 → 16.1.0

package/lib/relay-hooks/{react-cache/useFragmentInternal_REACT_CACHE.js → experimental/useFragmentInternal_EXPERIMENTAL.js}

@@ -1,14 +1,3 @@
-/**
- * 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.
- *
- * 
- * @format
- * @oncall relay
- */
-
 'use strict';
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
@@ -27,6 +16,7 @@ var _require2 = require('react'),
   useState = _require2.useState;
 var _require3 = require('relay-runtime'),
   fetchQueryInternal = _require3.__internal.fetchQuery,
+  RelayFeatureFlags = _require3.RelayFeatureFlags,
   areEqualSelectors = _require3.areEqualSelectors,
   createOperationDescriptor = _require3.createOperationDescriptor,
   getPendingOperationsForFragment = _require3.getPendingOperationsForFragment,
@@ -140,22 +130,14 @@ function handlePotentialSnapshotErrorsForState(environment, state) {
     }
   }
 }
-
-/**
- * Check for updates to the store that occurred concurrently with rendering the given `state` value,
- * returning a new (updated) state if there were updates or null if there were no changes.
- */
 function handleMissedUpdates(environment, state) {
   if (state.kind === 'bailout') {
     return null;
   }
-  // FIXME this is invalid if we've just switched environments.
   var currentEpoch = environment.getStore().getEpoch();
   if (currentEpoch === state.epoch) {
     return null;
   }
-  // The store has updated since we rendered (without us being subscribed yet),
-  // so check for any updates to the data we're rendering:
   if (state.kind === 'singular') {
     var currentSnapshot = environment.lookup(state.snapshot.selector);
     var updatedData = recycleNodesInto(state.snapshot.data, currentSnapshot.data);
@@ -207,14 +189,9 @@ function handleMissedUpdates(environment, state) {
 function handleMissingClientEdge(environment, parentFragmentNode, parentFragmentRef, missingClientEdgeRequestInfo, queryOptions) {
   var originalVariables = getVariablesFromFragment(parentFragmentNode, parentFragmentRef);
   var variables = (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, originalVariables), {}, {
-    id: missingClientEdgeRequestInfo.clientEdgeDestinationID // TODO should be a reserved name
+    id: missingClientEdgeRequestInfo.clientEdgeDestinationID
   });
-
   var queryOperationDescriptor = createOperationDescriptor(missingClientEdgeRequestInfo.request, variables, queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.networkCacheConfig);
-  // This may suspend. We don't need to do anything with the results; all we're
-  // doing here is started the query if needed and retaining and releasing it
-  // according to the component mount/suspense cycle; QueryResource
-  // already handles this by itself.
   var QueryResource = getQueryResourceForEnvironment(environment);
   return QueryResource.prepare(queryOperationDescriptor, fetchQueryInternal(environment, queryOperationDescriptor), queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.fetchPolicy);
 }
@@ -224,11 +201,19 @@ function subscribeToSnapshot(environment, state, setState) {
   } else if (state.kind === 'singular') {
     var disposable = environment.subscribe(state.snapshot, function (latestSnapshot) {
       setState(function (prevState) {
-        // In theory a setState from a subscription could be batched together
-        // with a setState to change the fragment selector. Guard against this
-        // by bailing out of the state update if the selector has changed.
         if (prevState.kind !== 'singular' || prevState.snapshot.selector !== latestSnapshot.selector) {
-          return prevState;
+          var updates = handleMissedUpdates(environment, prevState);
+          if (updates != null) {
+            var dataChanged = updates[0],
+              nextState = updates[1];
+            environment.__log({
+              name: 'useFragment.subscription.missedUpdates',
+              hasDataChanges: dataChanged
+            });
+            return dataChanged ? nextState : prevState;
+          } else {
+            return prevState;
+          }
         }
         return {
           kind: 'singular',
@@ -245,11 +230,19 @@ function subscribeToSnapshot(environment, state, setState) {
       return environment.subscribe(snapshot, function (latestSnapshot) {
         setState(function (prevState) {
           var _prevState$snapshots$;
-          // In theory a setState from a subscription could be batched together
-          // with a setState to change the fragment selector. Guard against this
-          // by bailing out of the state update if the selector has changed.
           if (prevState.kind !== 'plural' || ((_prevState$snapshots$ = prevState.snapshots[index]) === null || _prevState$snapshots$ === void 0 ? void 0 : _prevState$snapshots$.selector) !== latestSnapshot.selector) {
-            return prevState;
+            var updates = handleMissedUpdates(environment, prevState);
+            if (updates != null) {
+              var dataChanged = updates[0],
+                nextState = updates[1];
+              environment.__log({
+                name: 'useFragment.subscription.missedUpdates',
+                hasDataChanges: dataChanged
+              });
+              return dataChanged ? nextState : prevState;
+            } else {
+              return prevState;
+            }
           }
           var updated = (0, _toConsumableArray2["default"])(prevState.snapshots);
           updated[index] = latestSnapshot;
@@ -283,8 +276,6 @@ function getFragmentState(environment, fragmentSelector) {
       kind: 'bailout'
     };
   } else if (fragmentSelector.kind === 'PluralReaderSelector') {
-    // Note that if fragmentRef is an empty array, fragmentSelector will be null so we'll hit the above case.
-    // Null is returned by getSelector if fragmentRef has no non-null items.
     return {
       kind: 'plural',
       snapshots: fragmentSelector.selectors.map(function (s) {
@@ -300,20 +291,18 @@ function getFragmentState(environment, fragmentSelector) {
     };
   }
 }
-
-// fragmentNode cannot change during the lifetime of the component, though fragmentRef may change.
-function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayName, queryOptions, fragmentKey) {
+function useFragmentInternal_EXPERIMENTAL(fragmentNode, fragmentRef, hookDisplayName, queryOptions) {
   var _fragmentNode$metadat, _fragmentNode$metadat2;
   var fragmentSelector = useMemo(function () {
     return getSelector(fragmentNode, fragmentRef);
   }, [fragmentNode, fragmentRef]);
   var isPlural = (fragmentNode === null || fragmentNode === void 0 ? void 0 : (_fragmentNode$metadat = fragmentNode.metadata) === null || _fragmentNode$metadat === void 0 ? void 0 : _fragmentNode$metadat.plural) === true;
   if (isPlural) {
-    !(fragmentRef == null || Array.isArray(fragmentRef)) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected fragment pointer%s for fragment `%s` to be ' + 'an array, instead got `%s`. Remove `@relay(plural: true)` ' + 'from fragment `%s` to allow the prop to be an object.', fragmentKey != null ? " for key `".concat(fragmentKey, "`") : '', fragmentNode.name, typeof fragmentRef, fragmentNode.name) : invariant(false) : void 0;
+    !(fragmentRef == null || Array.isArray(fragmentRef)) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected fragment pointer%s for fragment `%s` to be ' + 'an array, instead got `%s`. Remove `@relay(plural: true)` ' + 'from fragment `%s` to allow the prop to be an object.', fragmentNode.name, typeof fragmentRef, fragmentNode.name) : invariant(false) : void 0;
   } else {
-    !!Array.isArray(fragmentRef) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected fragment pointer%s for fragment `%s` not to be ' + 'an array, instead got `%s`. Add `@relay(plural: true)` ' + 'to fragment `%s` to allow the prop to be an array.', fragmentKey != null ? " for key `".concat(fragmentKey, "`") : '', fragmentNode.name, typeof fragmentRef, fragmentNode.name) : invariant(false) : void 0;
+    !!Array.isArray(fragmentRef) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected fragment pointer%s for fragment `%s` not to be ' + 'an array, instead got `%s`. Add `@relay(plural: true)` ' + 'to fragment `%s` to allow the prop to be an array.', fragmentNode.name, typeof fragmentRef, fragmentNode.name) : invariant(false) : void 0;
   }
-  !(fragmentRef == null || isPlural && Array.isArray(fragmentRef) && fragmentRef.length === 0 || fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread  - then the fragment reference will not exist. ' + 'In this case, pass `null` if the conditions for evaluating the ' + 'fragment are not met (e.g. if the `@include(if)` value is false.)', fragmentNode.name, fragmentNode.name, hookDisplayName, fragmentNode.name, fragmentKey == null ? 'a fragment reference' : "the `".concat(fragmentKey, "`"), hookDisplayName) : invariant(false) : void 0;
+  !(fragmentRef == null || isPlural && Array.isArray(fragmentRef) && fragmentRef.length === 0 || fragmentSelector != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to receive an object where `...%s` was spread, ' + 'but the fragment reference was not found`. This is most ' + 'likely the result of:\n' + "- Forgetting to spread `%s` in `%s`'s parent's fragment.\n" + '- Conditionally fetching `%s` but unconditionally passing %s prop ' + 'to `%s`. If the parent fragment only fetches the fragment conditionally ' + '- with e.g. `@include`, `@skip`, or inside a `... on SomeType { }` ' + 'spread  - then the fragment reference will not exist. ' + 'In this case, pass `null` if the conditions for evaluating the ' + 'fragment are not met (e.g. if the `@include(if)` value is false.)', fragmentNode.name, fragmentNode.name, hookDisplayName, fragmentNode.name, hookDisplayName) : invariant(false) : void 0;
   var environment = useRelayEnvironment();
   var _useState = useState(function () {
       return getFragmentState(environment, fragmentSelector);
@@ -321,14 +310,9 @@ function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayN
     _state = _useState[0],
     setState = _useState[1];
   var state = _state;
-
-  // This copy of the state we only update when something requires us to
-  // unsubscribe and re-subscribe, namely a changed environment or
-  // fragment selector.
   var _useState2 = useState(state),
     _subscribedState = _useState2[0],
     setSubscribedState = _useState2[1];
-  // FIXME since this is used as an effect dependency, it needs to be memoized.
   var subscribedState = _subscribedState;
   var _useState3 = useState(fragmentSelector),
     previousFragmentSelector = _useState3[0],
@@ -337,40 +321,21 @@ function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayN
     previousEnvironment = _useState4[0],
     setPreviousEnvironment = _useState4[1];
   if (!areEqualSelectors(fragmentSelector, previousFragmentSelector) || environment !== previousEnvironment) {
-    // Enqueue setState to record the new selector and state
     setPreviousFragmentSelector(fragmentSelector);
     setPreviousEnvironment(environment);
     var newState = getFragmentState(environment, fragmentSelector);
     setState(newState);
-    setSubscribedState(newState); // This causes us to form a new subscription
-    // But render with the latest state w/o waiting for the setState. Otherwise
-    // the component would render the wrong information temporarily (including
-    // possibly incorrectly triggering some warnings below).
+    setSubscribedState(newState);
     state = newState;
     subscribedState = newState;
   }
-
-  // The purpose of this is to detect whether we have ever committed, because we
-  // don't suspend on store updates, only when the component either is first trying
-  // to mount or when the our selector changes. The selector change in particular is
-  // how we suspend for pagination and refetech. Also, fragment selector can be null
-  // or undefined, so we use false as a special value to distinguish from all fragment
-  // selectors; false means that the component hasn't mounted yet.
   var committedFragmentSelectorRef = useRef(false);
   useEffect(function () {
     committedFragmentSelectorRef.current = fragmentSelector;
   }, [fragmentSelector]);
-
-  // Handle the queries for any missing client edges; this may suspend.
-  // FIXME handle client edges in parallel.
   if (((_fragmentNode$metadat2 = fragmentNode.metadata) === null || _fragmentNode$metadat2 === void 0 ? void 0 : _fragmentNode$metadat2.hasClientEdges) === true) {
-    // The fragment is validated to be static (in useFragment) and hasClientEdges is
-    // a static (constant) property of the fragment. In practice, this effect will
-    // always or never run for a given invocation of this hook.
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     var clientEdgeQueries = useMemo(function () {
       var missingClientEdges = getMissingClientEdges(state);
-      // eslint-disable-next-line no-shadow
       var clientEdgeQueries;
       if (missingClientEdges !== null && missingClientEdges !== void 0 && missingClientEdges.length) {
         clientEdgeQueries = [];
@@ -389,9 +354,6 @@ function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayN
       }
       return clientEdgeQueries;
     }, [state, environment, fragmentNode, fragmentRef, queryOptions]);
-
-    // See above note
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     useEffect(function () {
       var QueryResource = getQueryResourceForEnvironment(environment);
       if (clientEdgeQueries !== null && clientEdgeQueries !== void 0 && clientEdgeQueries.length) {
@@ -426,19 +388,13 @@ function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayN
     }, [environment, clientEdgeQueries]);
   }
   if (isMissingData(state)) {
-    // Suspend if a Live Resolver within this fragment is in a suspended state:
     var suspendingLiveResolvers = getSuspendingLiveResolver(state);
     if (suspendingLiveResolvers != null && suspendingLiveResolvers.length > 0) {
       throw Promise.all(suspendingLiveResolvers.map(function (_ref) {
         var liveStateID = _ref.liveStateID;
-        // $FlowFixMe[prop-missing] This is expected to be a LiveResolverStore
         return environment.getStore().getLiveResolverPromise(liveStateID);
       }));
     }
-    // Suspend if an active operation bears on this fragment, either the
-    // fragment's owner or some other mutation etc. that could affect it.
-    // We only suspend when the component is first trying to mount or changing
-    // selectors, not if data becomes missing later:
     if (!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;
@@ -447,24 +403,14 @@ function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayN
         throw pendingOperationsResult.promise;
       }
     }
-    // Report required fields only if we're not suspending, since that means
-    // they're missing even though we are out of options for possibly fetching them:
-    handlePotentialSnapshotErrorsForState(environment, state);
   }
+  handlePotentialSnapshotErrorsForState(environment, state);
   useEffect(function () {
-    // Check for updates since the state was rendered
     var currentState = subscribedState;
     var updates = handleMissedUpdates(environment, subscribedState);
     if (updates !== null) {
       var didMissUpdates = updates[0],
         updatedState = updates[1];
-      // TODO: didMissUpdates only checks for changes to snapshot data, but it's possible
-      // that other snapshot properties may have changed that should also trigger a re-render,
-      // such as changed missing resolver fields, missing client edges, etc.
-      // A potential alternative is for handleMissedUpdates() to recycle the entire state
-      // value, and return the new (recycled) state only if there was some change. In that
-      // case the code would always setState if something in the snapshot changed, in addition
-      // to using the latest snapshot to subscribe.
       if (didMissUpdates) {
         setState(updatedState);
       }
@@ -474,17 +420,9 @@ function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayN
   }, [environment, subscribedState]);
   var data;
   if (isPlural) {
-    // Plural fragments require allocating an array of the snasphot data values,
-    // which has to be memoized to avoid triggering downstream re-renders.
-    //
-    // Note that isPlural is a constant property of the fragment and does not change
-    // for a particular useFragment invocation site
-    var fragmentRefIsNullish = fragmentRef == null; // for less sensitive memoization
-    // eslint-disable-next-line react-hooks/rules-of-hooks
+    var fragmentRefIsNullish = fragmentRef == null;
     data = useMemo(function () {
       if (state.kind === 'bailout') {
-        // Bailout state can happen if the fragmentRef is a plural array that is empty or has no
-        // non-null entries. In that case, the compatible behavior is to return [] instead of null.
         return fragmentRefIsNullish ? null : [];
       } else {
         !(state.kind === 'plural') ? process.env.NODE_ENV !== "production" ? invariant(false, 'Expected state to be plural because fragment is plural') : invariant(false) : void 0;
@@ -494,14 +432,12 @@ function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayN
       }
     }, [state, fragmentRefIsNullish]);
   } else if (state.kind === 'bailout') {
-    // This case doesn't allocate a new object so it doesn't have to be memoized
     data = null;
   } else {
-    // This case doesn't allocate a new object so it doesn't have to be memoized
     !(state.kind === 'singular') ? process.env.NODE_ENV !== "production" ? invariant(false, 'Expected state to be singular because fragment is singular') : invariant(false) : void 0;
     data = state.snapshot.data;
   }
-  if (process.env.NODE_ENV !== "production") {
+  if (RelayFeatureFlags.LOG_MISSING_RECORDS_IN_PROD || process.env.NODE_ENV !== "production") {
     if (fragmentRef != null && (data === undefined || Array.isArray(data) && data.length > 0 && data.every(function (d) {
       return d === undefined;
     }))) {
@@ -509,7 +445,6 @@ function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayN
     }
   }
   if (process.env.NODE_ENV !== "production") {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     useDebugValue({
       fragment: fragmentNode.name,
       data: data
@@ -517,4 +452,4 @@ function useFragmentInternal_REACT_CACHE(fragmentNode, fragmentRef, hookDisplayN
   }
   return data;
 }
-module.exports = useFragmentInternal_REACT_CACHE;
+module.exports = useFragmentInternal_EXPERIMENTAL;

package/lib/relay-hooks/{react-cache/useFragment_REACT_CACHE.js → experimental/useFragment_EXPERIMENTAL.js}

@@ -1,36 +1,21 @@
-/**
- * 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.
- *
- * 
- * @format
- * @oncall relay
- */
-
 'use strict';
 
 var _require = require('../loadQuery'),
   useTrackLoadQueryInRender = _require.useTrackLoadQueryInRender;
 var useStaticFragmentNodeWarning = require('../useStaticFragmentNodeWarning');
-var useFragmentInternal = require('./useFragmentInternal_REACT_CACHE');
+var useFragmentInternal = require('./useFragmentInternal_EXPERIMENTAL');
 var _require2 = require('react'),
   useDebugValue = _require2.useDebugValue;
 var _require3 = require('relay-runtime'),
   getFragment = _require3.getFragment;
 function useFragment(fragment, key) {
-  // We need to use this hook in order to be able to track if
-  // loadQuery was called during render
   useTrackLoadQueryInRender();
   var fragmentNode = getFragment(fragment);
   if (process.env.NODE_ENV !== "production") {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     useStaticFragmentNodeWarning(fragmentNode, 'first argument of useFragment()');
   }
   var data = useFragmentInternal(fragmentNode, key, 'useFragment()');
   if (process.env.NODE_ENV !== "production") {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     useDebugValue({
       fragment: fragmentNode.name,
       data: data

package/lib/relay-hooks/{react-cache/usePaginationFragment_REACT_CACHE.js → experimental/usePaginationFragment_EXPERIMENTAL.js}

@@ -1,14 +1,3 @@
-/**
- * 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.
- *
- * 
- * @format
- * @oncall relay
- */
-
 'use strict';
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
@@ -16,7 +5,7 @@ var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/obje
 var useLoadMoreFunction = require('../useLoadMoreFunction');
 var useRelayEnvironment = require('../useRelayEnvironment');
 var useStaticFragmentNodeWarning = require('../useStaticFragmentNodeWarning');
-var useRefetchableFragmentInternal = require('./useRefetchableFragmentInternal_REACT_CACHE');
+var useRefetchableFragmentInternal = require('./useRefetchableFragmentInternal_EXPERIMENTAL');
 var _require = require('react'),
   useCallback = _require.useCallback,
   useDebugValue = _require.useDebugValue,
@@ -32,15 +21,12 @@ function usePaginationFragment(fragmentInput, parentFragmentRef) {
   var _getPaginationMetadat = getPaginationMetadata(fragmentNode, componentDisplayName),
     connectionPathInFragmentData = _getPaginationMetadat.connectionPathInFragmentData,
     paginationRequest = _getPaginationMetadat.paginationRequest,
-    paginationMetadata = _getPaginationMetadat.paginationMetadata,
-    identifierField = _getPaginationMetadat.identifierField;
+    paginationMetadata = _getPaginationMetadat.paginationMetadata;
   var _useRefetchableFragme = useRefetchableFragmentInternal(fragmentNode, parentFragmentRef, componentDisplayName),
     fragmentData = _useRefetchableFragme.fragmentData,
     fragmentRef = _useRefetchableFragme.fragmentRef,
     refetch = _useRefetchableFragme.refetch;
   var fragmentIdentifier = getFragmentIdentifier(fragmentNode, fragmentRef);
-
-  // Backward pagination
   var _useLoadMore = useLoadMore({
       componentDisplayName: componentDisplayName,
       connectionPathInFragmentData: connectionPathInFragmentData,
@@ -49,7 +35,6 @@ function usePaginationFragment(fragmentInput, parentFragmentRef) {
       fragmentIdentifier: fragmentIdentifier,
       fragmentNode: fragmentNode,
       fragmentRef: fragmentRef,
-      identifierField: identifierField,
       paginationMetadata: paginationMetadata,
       paginationRequest: paginationRequest
     }),
@@ -57,8 +42,6 @@ function usePaginationFragment(fragmentInput, parentFragmentRef) {
     hasPrevious = _useLoadMore[1],
     isLoadingPrevious = _useLoadMore[2],
     disposeFetchPrevious = _useLoadMore[3];
-
-  // Forward pagination
   var _useLoadMore2 = useLoadMore({
       componentDisplayName: componentDisplayName,
       connectionPathInFragmentData: connectionPathInFragmentData,
@@ -67,7 +50,6 @@ function usePaginationFragment(fragmentInput, parentFragmentRef) {
       fragmentIdentifier: fragmentIdentifier,
       fragmentNode: fragmentNode,
       fragmentRef: fragmentRef,
-      identifierField: identifierField,
       paginationMetadata: paginationMetadata,
       paginationRequest: paginationRequest
     }),
@@ -83,7 +65,6 @@ function usePaginationFragment(fragmentInput, parentFragmentRef) {
     }));
   }, [disposeFetchNext, disposeFetchPrevious, refetch]);
   if (process.env.NODE_ENV !== "production") {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     useDebugValue({
       fragment: fragmentNode.name,
       data: fragmentData,
@@ -109,9 +90,6 @@ function useLoadMore(args) {
   var _useState = useState(false),
     isLoadingMore = _useState[0],
     reallySetIsLoadingMore = _useState[1];
-  // Schedule this update since it must be observed by components at the same
-  // batch as when hasNext changes. hasNext is read from the store and store
-  // updates are scheduled, so this must be scheduled too.
   var setIsLoadingMore = function setIsLoadingMore(value) {
     var _environment$getSched;
     var schedule = (_environment$getSched = environment.getScheduler()) === null || _environment$getSched === void 0 ? void 0 : _environment$getSched.schedule;

package/lib/relay-hooks/{react-cache/useRefetchableFragmentInternal_REACT_CACHE.js → experimental/useRefetchableFragmentInternal_EXPERIMENTAL.js}

@@ -1,14 +1,3 @@
-/**
- * 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.
- *
- * 
- * @format
- * @oncall relay
- */
-
 'use strict';
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
@@ -19,8 +8,8 @@ var _require = require('../QueryResource'),
 var useIsMountedRef = require('../useIsMountedRef');
 var useQueryLoader = require('../useQueryLoader');
 var useRelayEnvironment = require('../useRelayEnvironment');
-var readFragmentInternal = require('./readFragmentInternal_REACT_CACHE');
-var useFragmentInternal = require('./useFragmentInternal_REACT_CACHE');
+var readFragmentInternal = require('./readFragmentInternal_EXPERIMENTAL');
+var useFragmentInternal = require('./useFragmentInternal_EXPERIMENTAL');
 var invariant = require('invariant');
 var _require2 = require('react'),
   useCallback = _require2.useCallback,
@@ -71,7 +60,7 @@ function useRefetchableFragmentNode(fragmentNode, parentFragmentRef, componentDi
   var _getRefetchMetadata = getRefetchMetadata(fragmentNode, componentDisplayName),
     refetchableRequest = _getRefetchMetadata.refetchableRequest,
     fragmentRefPathInResponse = _getRefetchMetadata.fragmentRefPathInResponse,
-    identifierField = _getRefetchMetadata.identifierField;
+    identifierInfo = _getRefetchMetadata.identifierInfo;
   var fragmentIdentifier = getFragmentIdentifier(fragmentNode, parentFragmentRef);
   var _useReducer = useReducer(reducer, {
       fetchPolicy: undefined,
@@ -108,47 +97,18 @@ function useRefetchableFragmentNode(fragmentNode, parentFragmentRef, componentDi
     });
     disposeQuery();
   } else if (refetchQuery != null && queryRef != null) {
-    // If refetch was called, we expect to have a refetchQuery and queryRef
-    // in state, since both state updates to set the refetchQuery and the
-    // queryRef occur simultaneously.
-    // In this case, we need to read the refetched query data (potentially
-    // suspending if it's in flight), and extract the new fragment ref
-    // from the query in order read the current @refetchable fragment
-    // with the updated fragment owner as the new refetchQuery.
-
-    // Before observing the refetch, record the current ID and typename
-    // so that, if we are refetching existing data on
-    // a field that implements Node, after refetching we
-    // can validate that the received data is consistent
     var debugPreviousIDAndTypename;
     if (process.env.NODE_ENV !== "production") {
-      debugPreviousIDAndTypename = debugFunctions.getInitialIDAndType(refetchQuery.request.variables, fragmentRefPathInResponse, environment);
+      debugPreviousIDAndTypename = debugFunctions.getInitialIDAndType(refetchQuery.request.variables, fragmentRefPathInResponse, identifierInfo === null || identifierInfo === void 0 ? void 0 : identifierInfo.identifierQueryVariableName, environment);
     }
     var handleQueryCompleted = function handleQueryCompleted(maybeError) {
       onComplete && onComplete(maybeError !== null && maybeError !== void 0 ? maybeError : null);
     };
-
-    // The queryRef.source obtained from useQueryLoader will be
-    // an observable we can consume /if/ a network request was
-    // started. Otherwise, given that QueryResource.prepare
-    // always expects an observable we fall back to a new network
-    // observable. Note however that if loadQuery did not make a network
-    // request, we don't expect to make one here, unless the state of
-    // the cache has changed between the call to refetch and this
-    // render.
     var fetchObservable = queryRef.source != null ? queryRef.source : fetchQuery(environment, refetchQuery);
-
-    // Now wwe can we read the refetch query here using the
-    // queryRef provided from useQueryLoader. Note that the
-    // network request is started during the call to refetch,
-    // but if the refetch query is still in flight, we will suspend
-    // at this point:
     var queryResult = profilerContext.wrapPrepareQueryResource(function () {
       return QueryResource.prepare(refetchQuery, fetchObservable, fetchPolicy, renderPolicy, {
         error: handleQueryCompleted,
         complete: function complete() {
-          // Validate that the type of the object we got back matches the type
-          // of the object already in the store
           if (process.env.NODE_ENV !== "production") {
             debugFunctions.checkSameTypeAfterRefetch(debugPreviousIDAndTypename, environment, fragmentNode, componentDisplayName);
           }
@@ -158,40 +118,24 @@ function useRefetchableFragmentNode(fragmentNode, parentFragmentRef, componentDi
     });
     var queryData = readFragmentInternal(environment, queryResult.fragmentNode, queryResult.fragmentRef, componentDisplayName).data;
     !(queryData != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected to be able to read refetch query response. ' + "If you're seeing this, this is likely a bug in Relay.") : invariant(false) : void 0;
-
-    // After reading/fetching the refetch query, we extract from the
-    // refetch query response the new fragment ref we need to use to read
-    // the fragment. The new fragment ref will point to the refetch query
-    // as its fragment owner.
     var refetchedFragmentRef = getValueAtPath(queryData, fragmentRefPathInResponse);
     fragmentRef = refetchedFragmentRef;
     if (process.env.NODE_ENV !== "production") {
-      // Validate that the id of the object we got back matches the id
-      // we queried for in the variables.
-      // We do this during render instead of onComplete to make sure we are
-      // only validating the most recent refetch.
       debugFunctions.checkSameIDAfterRefetch(debugPreviousIDAndTypename, fragmentRef, fragmentNode, componentDisplayName);
     }
   }
-
-  // We read and subscribe to the fragment using useFragmentNode.
-  // If refetch was called, we read the fragment using the new computed
-  // fragment ref from the refetch query response; otherwise, we use the
-  // fragment ref passed by the caller as normal.
   var fragmentData = useFragmentInternal(fragmentNode, fragmentRef, componentDisplayName);
-  var refetch = useRefetchFunction(componentDisplayName, dispatch, disposeQuery, fragmentData, fragmentIdentifier, fragmentNode, fragmentRefPathInResponse, identifierField, loadQuery, parentFragmentRef, refetchableRequest);
+  var refetch = useRefetchFunction(componentDisplayName, dispatch, disposeQuery, fragmentData, fragmentIdentifier, fragmentNode, fragmentRefPathInResponse, identifierInfo, loadQuery, parentFragmentRef, refetchableRequest);
   return {
     fragmentData: fragmentData,
     fragmentRef: fragmentRef,
     refetch: refetch
   };
 }
-function useRefetchFunction(componentDisplayName, dispatch, disposeQuery, fragmentData, fragmentIdentifier, fragmentNode, fragmentRefPathInResponse, identifierField, loadQuery, parentFragmentRef, refetchableRequest) {
+function useRefetchFunction(componentDisplayName, dispatch, disposeQuery, fragmentData, fragmentIdentifier, fragmentNode, fragmentRefPathInResponse, identifierInfo, loadQuery, parentFragmentRef, refetchableRequest) {
   var isMountedRef = useIsMountedRef();
-  var identifierValue = identifierField != null && fragmentData != null && typeof fragmentData === 'object' ? fragmentData[identifierField] : null;
+  var identifierValue = (identifierInfo === null || identifierInfo === void 0 ? void 0 : identifierInfo.identifierField) != null && fragmentData != null && typeof fragmentData === 'object' ? fragmentData[identifierInfo.identifierField] : null;
   return useCallback(function (providedRefetchVariables, options) {
-    // Bail out and warn if we're trying to refetch after the component
-    // has unmounted
     if (isMountedRef.current !== true) {
       process.env.NODE_ENV !== "production" ? warning(false, 'Relay: Unexpected call to `refetch` on unmounted component for fragment ' + '`%s` in `%s`. It looks like some instances of your component are ' + 'still trying to fetch data but they already unmounted. ' + 'Please make sure you clear all timers, intervals, ' + 'async calls, etc that may trigger a fetch.', fragmentNode.name, componentDisplayName) : void 0;
       return {
@@ -219,35 +163,16 @@ function useRefetchFunction(componentDisplayName, dispatch, disposeQuery, fragme
       parentVariables = fragmentSelector.owner.variables;
       fragmentVariables = fragmentSelector.variables;
     }
-
-    // A user of `useRefetchableFragment()` may pass a subset of
-    // all variables required by the fragment when calling `refetch()`.
-    // We fill in any variables not passed by the call to `refetch()` with the
-    // variables from the original parent fragment owner.
     var refetchVariables = (0, _objectSpread2["default"])((0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, parentVariables), fragmentVariables), providedRefetchVariables);
-
-    // If the query needs an identifier value ('id' or similar) and one
-    // was not explicitly provided, read it from the fragment data.
-    if (identifierField != null && !providedRefetchVariables.hasOwnProperty('id')) {
-      // @refetchable fragments are guaranteed to have an `id` selection
-      // if the type is Node, implements Node, or is @fetchable. Double-check
-      // that there actually is a value at runtime.
+    if (identifierInfo != null && !providedRefetchVariables.hasOwnProperty(identifierInfo.identifierQueryVariableName)) {
       if (typeof identifierValue !== 'string') {
-        process.env.NODE_ENV !== "production" ? warning(false, 'Relay: Expected result to have a string  ' + '`%s` in order to refetch, got `%s`.', identifierField, identifierValue) : void 0;
+        process.env.NODE_ENV !== "production" ? warning(false, 'Relay: Expected result to have a string  ' + '`%s` in order to refetch, got `%s`.', identifierInfo.identifierField, identifierValue) : void 0;
       }
-      refetchVariables.id = identifierValue;
+      refetchVariables[identifierInfo.identifierQueryVariableName] = identifierValue;
     }
     var refetchQuery = createOperationDescriptor(refetchableRequest, refetchVariables, {
       force: true
     });
-
-    // We call loadQuery which will start a network request if necessary
-    // and update the querRef from useQueryLoader.
-    // Note the following:
-    // - loadQuery will dispose of any previously refetched queries.
-    // - We use the variables extracted off the OperationDescriptor
-    // so that they have been filtered out to include only the
-    // variables actually declared in the query.
     loadQuery(refetchQuery.request.variables, {
       fetchPolicy: fetchPolicy,
       __environment: refetchEnvironment,
@@ -264,29 +189,21 @@ function useRefetchFunction(componentDisplayName, dispatch, disposeQuery, fragme
     return {
       dispose: disposeQuery
     };
-  },
-  // NOTE: We disable react-hooks-deps warning because:
-  //   - We know fragmentRefPathInResponse is static, so it can be omitted from
-  //     deps
-  //   - We know fragmentNode is static, so it can be omitted from deps.
-  //   - fragmentNode and parentFragmentRef are also captured by including
-  //     fragmentIdentifier
-  // eslint-disable-next-line react-hooks/exhaustive-deps
-  [fragmentIdentifier, dispatch, disposeQuery, identifierValue, loadQuery]);
+  }, [fragmentIdentifier, dispatch, disposeQuery, identifierValue, loadQuery]);
 }
 var debugFunctions;
 if (process.env.NODE_ENV !== "production") {
   debugFunctions = {
-    getInitialIDAndType: function getInitialIDAndType(memoRefetchVariables, fragmentRefPathInResponse, environment) {
+    getInitialIDAndType: function getInitialIDAndType(memoRefetchVariables, fragmentRefPathInResponse, identifierQueryVariableName, environment) {
       var _require4 = require('relay-runtime'),
         Record = _require4.Record;
-      var id = memoRefetchVariables === null || memoRefetchVariables === void 0 ? void 0 : memoRefetchVariables.id;
+      var id = memoRefetchVariables === null || memoRefetchVariables === void 0 ? void 0 : memoRefetchVariables[identifierQueryVariableName !== null && identifierQueryVariableName !== void 0 ? identifierQueryVariableName : 'id'];
       if (fragmentRefPathInResponse.length !== 1 || fragmentRefPathInResponse[0] !== 'node' || id == null) {
         return null;
       }
       var recordSource = environment.getStore().getSource();
       var record = recordSource.get(id);
-      var typename = record && Record.getType(record);
+      var typename = record == null ? null : Record.getType(record);
       if (typename == null) {
         return null;
       }
@@ -314,7 +231,6 @@ if (process.env.NODE_ENV !== "production") {
       }
       var _require6 = require('relay-runtime'),
         ID_KEY = _require6.ID_KEY;
-      // $FlowExpectedError[incompatible-use]
       var resultID = refetchedFragmentRef[ID_KEY];
       if (resultID != null && resultID !== previousIDAndTypename.id) {
         process.env.NODE_ENV !== "production" ? warning(false, 'Relay: Call to `refetch` returned a different id, expected ' + '`%s`, got `%s`, on `%s` in `%s`. ' + 'Please make sure the server correctly implements ' + 'unique id requirement.', resultID, previousIDAndTypename.id, fragmentNode.name, componentDisplayName) : void 0;