react-relay 14.1.0 → 16.0.0

package/lib/relay-hooks/useMemoOperationDescriptor.js

@@ -1,35 +1,16 @@
-/**
- * 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
- */
 'use strict';
 
 var useMemoVariables = require('./useMemoVariables');
-
 var React = require('react');
-
 var _require = require('relay-runtime'),
-    createOperationDescriptor = _require.createOperationDescriptor,
-    getRequest = _require.getRequest;
-
+  createOperationDescriptor = _require.createOperationDescriptor,
+  getRequest = _require.getRequest;
 var useMemo = React.useMemo;
-
 function useMemoOperationDescriptor(gqlQuery, variables, cacheConfig) {
-  var _useMemoVariables = useMemoVariables(variables),
-      memoVariables = _useMemoVariables[0];
-
-  var _useMemoVariables2 = useMemoVariables(cacheConfig || {}),
-      memoCacheConfig = _useMemoVariables2[0];
-
+  var memoVariables = useMemoVariables(variables);
+  var memoCacheConfig = useMemoVariables(cacheConfig || {});
   return useMemo(function () {
     return createOperationDescriptor(getRequest(gqlQuery), memoVariables, memoCacheConfig);
   }, [gqlQuery, memoVariables, memoCacheConfig]);
 }
-
 module.exports = useMemoOperationDescriptor;

package/lib/relay-hooks/useMemoVariables.js

@@ -1,52 +1,17 @@
-/**
- * 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
- */
 'use strict';
 
 var areEqual = require("fbjs/lib/areEqual");
-
-var React = require('react');
-
-var useMemo = React.useMemo,
-    useRef = React.useRef,
-    useState = React.useState;
-
+var _require = require('react'),
+  useState = _require.useState;
 function useMemoVariables(variables) {
-  var _variablesChangedGene2;
-
-  // The value of this ref is a counter that should be incremented when
-  // variables change. This allows us to use the counter as a
-  // memoization value to indicate if the computation for useMemo
-  // should be re-executed.
-  var variablesChangedGenerationRef = useRef(0); // We mirror the variables to check if they have changed between renders
-
   var _useState = useState(variables),
-      mirroredVariables = _useState[0],
-      setMirroredVariables = _useState[1];
-
-  var variablesChanged = !areEqual(variables, mirroredVariables);
-
-  if (variablesChanged) {
-    var _variablesChangedGene;
-
-    variablesChangedGenerationRef.current = ((_variablesChangedGene = variablesChangedGenerationRef.current) !== null && _variablesChangedGene !== void 0 ? _variablesChangedGene : 0) + 1;
+    mirroredVariables = _useState[0],
+    setMirroredVariables = _useState[1];
+  if (areEqual(variables, mirroredVariables)) {
+    return mirroredVariables;
+  } else {
     setMirroredVariables(variables);
-  } // NOTE: We disable react-hooks-deps warning because we explicitly
-  // don't want to memoize on object identity
-  // eslint-disable-next-line react-hooks/exhaustive-deps
-
-
-  var memoVariables = useMemo(function () {
     return variables;
-  }, [variablesChangedGenerationRef.current]);
-  return [memoVariables, (_variablesChangedGene2 = variablesChangedGenerationRef.current) !== null && _variablesChangedGene2 !== void 0 ? _variablesChangedGene2 : 0];
+  }
 }
-
 module.exports = useMemoVariables;

package/lib/relay-hooks/useMutation.js

@@ -1,33 +1,16 @@
-/**
- * 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
- */
 'use strict';
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
-
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
 var useIsMountedRef = require('./useIsMountedRef');
-
 var useRelayEnvironment = require('./useRelayEnvironment');
-
 var React = require('react');
-
 var _require = require('relay-runtime'),
-    defaultCommitMutation = _require.commitMutation;
-
+  defaultCommitMutation = _require.commitMutation;
 var useState = React.useState,
-    useEffect = React.useEffect,
-    useRef = React.useRef,
-    useCallback = React.useCallback;
-
+  useEffect = React.useEffect,
+  useRef = React.useRef,
+  useCallback = React.useCallback;
 function useMutation(mutation) {
   var commitMutationFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : defaultCommitMutation;
   var environment = useRelayEnvironment();
@@ -35,15 +18,12 @@ function useMutation(mutation) {
   var environmentRef = useRef(environment);
   var mutationRef = useRef(mutation);
   var inFlightMutationsRef = useRef(new Set());
-
   var _useState = useState(false),
-      isMutationInFlight = _useState[0],
-      setMutationInFlight = _useState[1];
-
+    isMutationInFlight = _useState[0],
+    setMutationInFlight = _useState[1];
   var cleanup = useCallback(function (disposable) {
     if (environmentRef.current === environment && mutationRef.current === mutation) {
       inFlightMutationsRef.current["delete"](disposable);
-
       if (isMountedRef.current) {
         setMutationInFlight(inFlightMutationsRef.current.size > 0);
       }
@@ -52,11 +32,9 @@ function useMutation(mutation) {
   useEffect(function () {
     if (environmentRef.current !== environment || mutationRef.current !== mutation) {
       inFlightMutationsRef.current = new Set();
-
       if (isMountedRef.current) {
         setMutationInFlight(false);
       }
-
       environmentRef.current = environment;
       mutationRef.current = mutation;
     }
@@ -65,30 +43,25 @@ function useMutation(mutation) {
     if (isMountedRef.current) {
       setMutationInFlight(true);
     }
-
     var disposable = commitMutationFn(environment, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, config), {}, {
       mutation: mutation,
       onCompleted: function onCompleted(response, errors) {
         var _config$onCompleted;
-
         cleanup(disposable);
         (_config$onCompleted = config.onCompleted) === null || _config$onCompleted === void 0 ? void 0 : _config$onCompleted.call(config, response, errors);
       },
       onError: function onError(error) {
         var _config$onError;
-
         cleanup(disposable);
         (_config$onError = config.onError) === null || _config$onError === void 0 ? void 0 : _config$onError.call(config, error);
       },
       onUnsubscribe: function onUnsubscribe() {
         var _config$onUnsubscribe;
-
         cleanup(disposable);
         (_config$onUnsubscribe = config.onUnsubscribe) === null || _config$onUnsubscribe === void 0 ? void 0 : _config$onUnsubscribe.call(config);
       },
       onNext: function onNext() {
         var _config$onNext;
-
         (_config$onNext = config.onNext) === null || _config$onNext === void 0 ? void 0 : _config$onNext.call(config);
       }
     }));
@@ -97,5 +70,4 @@ function useMutation(mutation) {
   }, [cleanup, commitMutationFn, environment, isMountedRef, mutation]);
   return [commit, isMutationInFlight];
 }
-
 module.exports = useMutation;

package/lib/relay-hooks/usePaginationFragment.js

@@ -1,90 +1,62 @@
-/**
- * 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
- */
 'use strict';
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault")["default"];
-
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
-
 var HooksImplementation = require('./HooksImplementation');
-
 var useLoadMoreFunction = require('./useLoadMoreFunction');
-
 var useRefetchableFragmentNode = require('./useRefetchableFragmentNode');
-
 var useStaticFragmentNodeWarning = require('./useStaticFragmentNodeWarning');
-
 var _require = require('react'),
-    useCallback = _require.useCallback,
-    useDebugValue = _require.useDebugValue,
-    useState = _require.useState;
-
+  useCallback = _require.useCallback,
+  useDebugValue = _require.useDebugValue,
+  useState = _require.useState;
 var _require2 = require('relay-runtime'),
-    getFragment = _require2.getFragment,
-    getFragmentIdentifier = _require2.getFragmentIdentifier,
-    getPaginationMetadata = _require2.getPaginationMetadata;
-
+  getFragment = _require2.getFragment,
+  getFragmentIdentifier = _require2.getFragmentIdentifier,
+  getPaginationMetadata = _require2.getPaginationMetadata;
 function usePaginationFragment_LEGACY(fragmentInput, parentFragmentRef) {
   var fragmentNode = getFragment(fragmentInput);
   useStaticFragmentNodeWarning(fragmentNode, 'first argument of usePaginationFragment()');
   var componentDisplayName = 'usePaginationFragment()';
-
   var _getPaginationMetadat = getPaginationMetadata(fragmentNode, componentDisplayName),
-      connectionPathInFragmentData = _getPaginationMetadat.connectionPathInFragmentData,
-      paginationRequest = _getPaginationMetadat.paginationRequest,
-      paginationMetadata = _getPaginationMetadat.paginationMetadata,
-      identifierField = _getPaginationMetadat.identifierField;
-
+    connectionPathInFragmentData = _getPaginationMetadat.connectionPathInFragmentData,
+    paginationRequest = _getPaginationMetadat.paginationRequest,
+    paginationMetadata = _getPaginationMetadat.paginationMetadata;
   var _useRefetchableFragme = useRefetchableFragmentNode(fragmentNode, parentFragmentRef, componentDisplayName),
-      fragmentData = _useRefetchableFragme.fragmentData,
-      fragmentRef = _useRefetchableFragme.fragmentRef,
-      refetch = _useRefetchableFragme.refetch;
-
-  var fragmentIdentifier = getFragmentIdentifier(fragmentNode, fragmentRef); // Backward pagination
-
+    fragmentData = _useRefetchableFragme.fragmentData,
+    fragmentRef = _useRefetchableFragme.fragmentRef,
+    refetch = _useRefetchableFragme.refetch;
+  var fragmentIdentifier = getFragmentIdentifier(fragmentNode, fragmentRef);
   var _useLoadMore = useLoadMore({
-    componentDisplayName: componentDisplayName,
-    connectionPathInFragmentData: connectionPathInFragmentData,
-    direction: 'backward',
-    fragmentData: fragmentData,
-    fragmentIdentifier: fragmentIdentifier,
-    fragmentNode: fragmentNode,
-    fragmentRef: fragmentRef,
-    identifierField: identifierField,
-    paginationMetadata: paginationMetadata,
-    paginationRequest: paginationRequest
-  }),
-      loadPrevious = _useLoadMore[0],
-      hasPrevious = _useLoadMore[1],
-      isLoadingPrevious = _useLoadMore[2],
-      disposeFetchPrevious = _useLoadMore[3]; // Forward pagination
-
-
+      componentDisplayName: componentDisplayName,
+      connectionPathInFragmentData: connectionPathInFragmentData,
+      direction: 'backward',
+      fragmentData: fragmentData,
+      fragmentIdentifier: fragmentIdentifier,
+      fragmentNode: fragmentNode,
+      fragmentRef: fragmentRef,
+      paginationMetadata: paginationMetadata,
+      paginationRequest: paginationRequest
+    }),
+    loadPrevious = _useLoadMore[0],
+    hasPrevious = _useLoadMore[1],
+    isLoadingPrevious = _useLoadMore[2],
+    disposeFetchPrevious = _useLoadMore[3];
   var _useLoadMore2 = useLoadMore({
-    componentDisplayName: componentDisplayName,
-    connectionPathInFragmentData: connectionPathInFragmentData,
-    direction: 'forward',
-    fragmentData: fragmentData,
-    fragmentIdentifier: fragmentIdentifier,
-    fragmentNode: fragmentNode,
-    fragmentRef: fragmentRef,
-    identifierField: identifierField,
-    paginationMetadata: paginationMetadata,
-    paginationRequest: paginationRequest
-  }),
-      loadNext = _useLoadMore2[0],
-      hasNext = _useLoadMore2[1],
-      isLoadingNext = _useLoadMore2[2],
-      disposeFetchNext = _useLoadMore2[3];
-
+      componentDisplayName: componentDisplayName,
+      connectionPathInFragmentData: connectionPathInFragmentData,
+      direction: 'forward',
+      fragmentData: fragmentData,
+      fragmentIdentifier: fragmentIdentifier,
+      fragmentNode: fragmentNode,
+      fragmentRef: fragmentRef,
+      paginationMetadata: paginationMetadata,
+      paginationRequest: paginationRequest
+    }),
+    loadNext = _useLoadMore2[0],
+    hasNext = _useLoadMore2[1],
+    isLoadingNext = _useLoadMore2[2],
+    disposeFetchNext = _useLoadMore2[3];
   var refetchPagination = useCallback(function (variables, options) {
     disposeFetchNext();
     disposeFetchPrevious();
@@ -92,9 +64,7 @@ function usePaginationFragment_LEGACY(fragmentInput, parentFragmentRef) {
       __environment: undefined
     }));
   }, [disposeFetchNext, disposeFetchPrevious, refetch]);
-
   if (process.env.NODE_ENV !== "production") {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     useDebugValue({
       fragment: fragmentNode.name,
       data: fragmentData,
@@ -104,7 +74,6 @@ function usePaginationFragment_LEGACY(fragmentInput, parentFragmentRef) {
       isLoadingPrevious: isLoadingPrevious
     });
   }
-
   return {
     data: fragmentData,
     loadNext: loadNext,
@@ -116,12 +85,10 @@ function usePaginationFragment_LEGACY(fragmentInput, parentFragmentRef) {
     refetch: refetchPagination
   };
 }
-
 function useLoadMore(args) {
   var _useState = useState(false),
-      isLoadingMore = _useState[0],
-      setIsLoadingMore = _useState[1];
-
+    isLoadingMore = _useState[0],
+    setIsLoadingMore = _useState[1];
   var observer = {
     start: function start() {
       return setIsLoadingMore(true);
@@ -133,31 +100,24 @@ function useLoadMore(args) {
       return setIsLoadingMore(false);
     }
   };
-
   var handleReset = function handleReset() {
     return setIsLoadingMore(false);
   };
-
   var _useLoadMoreFunction = useLoadMoreFunction((0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, args), {}, {
-    observer: observer,
-    onReset: handleReset
-  })),
-      loadMore = _useLoadMoreFunction[0],
-      hasMore = _useLoadMoreFunction[1],
-      disposeFetch = _useLoadMoreFunction[2];
-
+      observer: observer,
+      onReset: handleReset
+    })),
+    loadMore = _useLoadMoreFunction[0],
+    hasMore = _useLoadMoreFunction[1],
+    disposeFetch = _useLoadMoreFunction[2];
   return [loadMore, hasMore, isLoadingMore, disposeFetch];
 }
-
 function usePaginationFragment(fragmentInput, parentFragmentRef) {
   var impl = HooksImplementation.get();
-
   if (impl) {
     return impl.usePaginationFragment(fragmentInput, parentFragmentRef);
   } else {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     return usePaginationFragment_LEGACY(fragmentInput, parentFragmentRef);
   }
 }
-
 module.exports = usePaginationFragment;

package/lib/relay-hooks/usePreloadedQuery.js

@@ -1,52 +1,28 @@
-/**
- * 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
- */
 'use strict';
 
 var _require = require('./loadQuery'),
-    useTrackLoadQueryInRender = _require.useTrackLoadQueryInRender;
-
+  useTrackLoadQueryInRender = _require.useTrackLoadQueryInRender;
 var useLazyLoadQueryNode = require('./useLazyLoadQueryNode');
-
 var useMemoOperationDescriptor = require('./useMemoOperationDescriptor');
-
 var useRelayEnvironment = require('./useRelayEnvironment');
-
 var invariant = require('invariant');
-
 var _require2 = require('react'),
-    useDebugValue = _require2.useDebugValue;
-
+  useDebugValue = _require2.useDebugValue;
 var _require3 = require('relay-runtime'),
-    _require3$__internal = _require3.__internal,
-    fetchQueryDeduped = _require3$__internal.fetchQueryDeduped,
-    fetchQuery = _require3$__internal.fetchQuery;
-
-var warning = require("fbjs/lib/warning"); // This separate type export is only needed as long as we are injecting
-// a separate hooks implementation in ./HooksImplementation -- it can
-// be removed after we stop doing that.
-
-
+  _require3$__internal = _require3.__internal,
+  fetchQueryDeduped = _require3$__internal.fetchQueryDeduped,
+  fetchQuery = _require3$__internal.fetchQuery;
+var warning = require("fbjs/lib/warning");
 function usePreloadedQuery(gqlQuery, preloadedQuery, options) {
-  // We need to use this hook in order to be able to track if
-  // loadQuery was called during render
   useTrackLoadQueryInRender();
   var environment = useRelayEnvironment();
   var fetchKey = preloadedQuery.fetchKey,
-      fetchPolicy = preloadedQuery.fetchPolicy,
-      source = preloadedQuery.source,
-      variables = preloadedQuery.variables,
-      networkCacheConfig = preloadedQuery.networkCacheConfig;
+    fetchPolicy = preloadedQuery.fetchPolicy,
+    source = preloadedQuery.source,
+    variables = preloadedQuery.variables,
+    networkCacheConfig = preloadedQuery.networkCacheConfig;
   var operation = useMemoOperationDescriptor(gqlQuery, variables, networkCacheConfig);
   var useLazyLoadQueryNodeParams;
-
   if (preloadedQuery.kind === 'PreloadedQuery_DEPRECATED') {
     !(operation.request.node.params.name === preloadedQuery.name) ? process.env.NODE_ENV !== "production" ? invariant(false, 'usePreloadedQuery(): Expected data to be prefetched for query `%s`, ' + 'got prefetch results for query `%s`.', operation.request.node.params.name, preloadedQuery.name) : invariant(false) : void 0;
     useLazyLoadQueryNodeParams = {
@@ -72,29 +48,14 @@ function usePreloadedQuery(gqlQuery, preloadedQuery, options) {
     process.env.NODE_ENV !== "production" ? warning(preloadedQuery.isDisposed === false, 'usePreloadedQuery(): Expected preloadedQuery to not be disposed yet. ' + 'This is because disposing the query marks it for future garbage ' + 'collection, and as such query results may no longer be present in the Relay ' + 'store. In the future, this will become a hard error.') : void 0;
     var fallbackFetchObservable = fetchQuery(environment, operation);
     var fetchObservable;
-
     if (source != null && environment === preloadedQuery.environment) {
-      // If the source observable exists and the environments match, reuse
-      // the source observable.
-      // If the source observable happens to be empty, we need to fall back
-      // and re-execute and de-dupe the query (at render time).
       fetchObservable = source.ifEmpty(fallbackFetchObservable);
     } else if (environment !== preloadedQuery.environment) {
-      // If a call to loadQuery is made with a particular environment, and that
-      // preloaded query is passed to usePreloadedQuery in a different environment
-      // context, we cannot re-use the existing preloaded query.
-      // Instead, we need to fall back and re-execute and de-dupe the query with
-      // the new environment (at render time).
-      // TODO T68036756 track occurences of this warning and turn it into a hard error
       process.env.NODE_ENV !== "production" ? warning(false, 'usePreloadedQuery(): usePreloadedQuery was passed a preloaded query ' + 'that was created with a different environment than the one that is currently ' + 'in context. In the future, this will become a hard error.') : void 0;
       fetchObservable = fallbackFetchObservable;
     } else {
-      // if (source == null)
-      // If the source observable does not exist, we need to
-      // fall back and re-execute and de-dupe the query (at render time).
       fetchObservable = fallbackFetchObservable;
     }
-
     useLazyLoadQueryNodeParams = {
       componentDisplayName: 'usePreloadedQuery()',
       fetchObservable: fetchObservable,
@@ -104,11 +65,8 @@ function usePreloadedQuery(gqlQuery, preloadedQuery, options) {
       renderPolicy: options === null || options === void 0 ? void 0 : options.UNSTABLE_renderPolicy
     };
   }
-
   var data = useLazyLoadQueryNode(useLazyLoadQueryNodeParams);
-
   if (process.env.NODE_ENV !== "production") {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
     useDebugValue({
       query: preloadedQuery.name,
       variables: preloadedQuery.variables,
@@ -118,8 +76,6 @@ function usePreloadedQuery(gqlQuery, preloadedQuery, options) {
       renderPolicy: options === null || options === void 0 ? void 0 : options.UNSTABLE_renderPolicy
     });
   }
-
   return data;
 }
-
 module.exports = usePreloadedQuery;