react-relay 19.0.0 → 20.0.0

package/ReactRelayContext.js

@@ -1,5 +1,5 @@
 /**
- * Relay v19.0.0
+ * Relay v20.0.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/buildReactRelayContainer.js.flow

@@ -82,8 +82,7 @@ function buildReactRelayContainer<TBase: component(...empty)>(
     );
   }
   ForwardRef.displayName = containerName;
-  // $FlowFixMe[incompatible-call]
-  const ForwardContainer = React.forwardRef(ForwardRef);
+  const ForwardContainer = (React as $FlowFixMe).forwardRef(ForwardRef);
 
   if (__DEV__) {
     // Used by RelayModernTestUtils

package/hooks.js

@@ -1,5 +1,5 @@
 /**
- * Relay v19.0.0
+ * Relay v20.0.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v19.0.0
+ * Relay v20.0.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/legacy.js

@@ -1,5 +1,5 @@
 /**
- * Relay v19.0.0
+ * Relay v20.0.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/lib/relay-hooks/readFragmentInternal.js

@@ -130,7 +130,7 @@ function readFragmentInternal(environment, fragmentNode, fragmentRef, hookDispla
   !(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;
   var state = getFragmentState(environment, fragmentSelector);
   var clientEdgeQueries = null;
-  if (((_fragmentNode$metadat2 = fragmentNode.metadata) === null || _fragmentNode$metadat2 === void 0 ? void 0 : _fragmentNode$metadat2.hasClientEdges) === true) {
+  if (((_fragmentNode$metadat2 = fragmentNode.metadata) === null || _fragmentNode$metadat2 === void 0 ? void 0 : _fragmentNode$metadat2.hasClientEdges) === true || RelayFeatureFlags.CHECK_ALL_FRAGMENTS_FOR_MISSING_CLIENT_EDGES) {
     var missingClientEdges = getMissingClientEdges(state);
     if (missingClientEdges !== null && missingClientEdges !== void 0 && missingClientEdges.length) {
       clientEdgeQueries = [];

package/lib/relay-hooks/useFragmentInternal_CURRENT.js

@@ -343,7 +343,7 @@ function useFragmentInternal(fragmentNode, fragmentRef, hookDisplayName, queryOp
   useEffect(function () {
     committedFragmentSelectorRef.current = fragmentSelector;
   }, [fragmentSelector]);
-  if (((_fragmentNode$metadat2 = fragmentNode.metadata) === null || _fragmentNode$metadat2 === void 0 ? void 0 : _fragmentNode$metadat2.hasClientEdges) === true) {
+  if (((_fragmentNode$metadat2 = fragmentNode.metadata) === null || _fragmentNode$metadat2 === void 0 ? void 0 : _fragmentNode$metadat2.hasClientEdges) === true || RelayFeatureFlags.CHECK_ALL_FRAGMENTS_FOR_MISSING_CLIENT_EDGES) {
     var _useMemo = useMemo(function () {
         var missingClientEdges = getMissingClientEdges(state);
         var clientEdgeQueries;

package/lib/relay-hooks/useFragmentInternal_EXPERIMENTAL.js

@@ -199,7 +199,11 @@ function handleMissingClientEdge(environment, parentFragmentNode, parentFragment
   var queryOperationDescriptor = createOperationDescriptor(missingClientEdgeRequestInfo.request, variables, queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.networkCacheConfig);
   var QueryResource = getQueryResourceForEnvironment(environment);
   var queryResult = QueryResource.prepare(queryOperationDescriptor, fetchQueryInternal(environment, queryOperationDescriptor), queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.fetchPolicy);
-  return [queryResult, getPromiseForActiveRequest(environment, queryOperationDescriptor.request)];
+  var promise = getPromiseForActiveRequest(environment, queryOperationDescriptor.request);
+  if (promise != null && promise.displayName == null) {
+    promise.displayName = missingClientEdgeRequestInfo.request.params.name;
+  }
+  return [queryResult, promise];
 }
 function subscribeToSnapshot(environment, state, setState) {
   if (state.kind === 'bailout') {
@@ -345,7 +349,7 @@ function useFragmentInternal_EXPERIMENTAL(fragmentNode, fragmentRef, hookDisplay
   useEffect(function () {
     committedFragmentSelectorRef.current = fragmentSelector;
   }, [fragmentSelector]);
-  if (((_fragmentNode$metadat2 = fragmentNode.metadata) === null || _fragmentNode$metadat2 === void 0 ? void 0 : _fragmentNode$metadat2.hasClientEdges) === true) {
+  if (((_fragmentNode$metadat2 = fragmentNode.metadata) === null || _fragmentNode$metadat2 === void 0 ? void 0 : _fragmentNode$metadat2.hasClientEdges) === true || RelayFeatureFlags.CHECK_ALL_FRAGMENTS_FOR_MISSING_CLIENT_EDGES) {
     var _useMemo = useMemo(function () {
         var missingClientEdges = getMissingClientEdges(state);
         var clientEdgeQueries;
@@ -376,7 +380,11 @@ function useFragmentInternal_EXPERIMENTAL(fragmentNode, fragmentRef, hookDisplay
       clientEdgeQueries = _useMemo[0],
       activeRequestPromises = _useMemo[1];
     if (activeRequestPromises.length) {
-      throw Promise.all(activeRequestPromises);
+      var allPromises = Promise.all(activeRequestPromises);
+      allPromises.displayName = "RelayClientEdge(".concat(activeRequestPromises.map(function (promise) {
+        return promise.displayName;
+      }).join(','), ")");
+      throw allPromises;
     }
     useEffect(function () {
       var QueryResource = getQueryResourceForEnvironment(environment);
@@ -406,9 +414,11 @@ function useFragmentInternal_EXPERIMENTAL(fragmentNode, fragmentRef, hookDisplay
   if (isMissingData(state)) {
     var suspendingLiveResolvers = getSuspendingLiveResolver(state);
     if (suspendingLiveResolvers != null && suspendingLiveResolvers.length > 0) {
-      throw Promise.all(suspendingLiveResolvers.map(function (liveStateID) {
+      var promise = Promise.all(suspendingLiveResolvers.map(function (liveStateID) {
         return environment.getStore().getLiveResolverPromise(liveStateID);
       }));
+      promise.displayName = 'RelayLiveResolver(' + fragmentNode.name + ')';
+      throw promise;
     }
     if (RelayFeatureFlags.ENABLE_RELAY_OPERATION_TRACKER_SUSPENSE || 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;

package/package.json

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

package/relay-hooks/EntryPointTypes.flow.js.flow

@@ -37,6 +37,7 @@ export type PreloadOptions = {
   +fetchKey?: string | number,
   +fetchPolicy?: ?PreloadFetchPolicy,
   +includeIf?: ?boolean,
+  +prefetchExpiryInHours?: ?number,
   +networkCacheConfig?: ?CacheConfig,
 };
 

package/relay-hooks/loadQuery.js.flow

@@ -43,7 +43,7 @@ const {
 
 let fetchKey = 100001;
 
-type QueryType<T> =
+export type QueryType<T> =
   T extends Query<infer V, infer D, infer RR>
     ? {
         variables: V,
@@ -126,7 +126,7 @@ function loadQuery<
   let networkError = null;
   // makeNetworkRequest will immediately start a raw network request if
   // one isn't already in flight and return an Observable that when
-  // subscribed to will replay the network events that have occured so far,
+  // subscribed to will replay the network events that have occurred so far,
   // as well as subsequent events.
   let didMakeNetworkRequest = false;
   const makeNetworkRequest = (

package/relay-hooks/readFragmentInternal.js.flow

@@ -213,7 +213,10 @@ function readFragmentInternal(
   // Handle the queries for any missing client edges; this may suspend.
   // FIXME handle client edges in parallel.
   let clientEdgeQueries = null;
-  if (fragmentNode.metadata?.hasClientEdges === true) {
+  if (
+    fragmentNode.metadata?.hasClientEdges === true ||
+    RelayFeatureFlags.CHECK_ALL_FRAGMENTS_FOR_MISSING_CLIENT_EDGES
+  ) {
     const missingClientEdges = getMissingClientEdges(state);
     if (missingClientEdges?.length) {
       clientEdgeQueries = ([]: Array<QueryResult>);

package/relay-hooks/useEntryPointLoader.js.flow

@@ -158,7 +158,7 @@ hook useLoadEntryPoint<
   useEffect(() => {
     return () => {
       // Attempt to detect if the component was
-      // hidden (by Offscreen API), or fast refresh occured;
+      // hidden (by Offscreen API), or fast refresh occurred;
       // Only in these situations would the effect cleanup
       // for "unmounting" run multiple times, so if
       // we are ever able to read this ref with a value

package/relay-hooks/useFragmentInternal_CURRENT.js.flow

@@ -461,7 +461,10 @@ hook useFragmentInternal(
 
   // Handle the queries for any missing client edges; this may suspend.
   // FIXME handle client edges in parallel.
-  if (fragmentNode.metadata?.hasClientEdges === true) {
+  if (
+    fragmentNode.metadata?.hasClientEdges === true ||
+    RelayFeatureFlags.CHECK_ALL_FRAGMENTS_FOR_MISSING_CLIENT_EDGES
+  ) {
     // 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.

package/relay-hooks/useFragmentInternal_EXPERIMENTAL.js.flow

@@ -222,13 +222,15 @@ function handleMissedUpdates(
   }
 }
 
+type PromiseWithDisplayName = Promise<mixed> & {displayName?: string};
+
 function handleMissingClientEdge(
   environment: IEnvironment,
   parentFragmentNode: ReaderFragment,
   parentFragmentRef: mixed,
   missingClientEdgeRequestInfo: MissingClientEdgeRequestInfo,
   queryOptions?: FragmentQueryOptions,
-): [QueryResult, ?Promise<mixed>] {
+): [QueryResult, ?PromiseWithDisplayName] {
   const originalVariables = getVariablesFromFragment(
     parentFragmentNode,
     parentFragmentRef,
@@ -253,10 +255,17 @@ function handleMissingClientEdge(
     queryOptions?.fetchPolicy,
   );
 
-  return [
-    queryResult,
-    getPromiseForActiveRequest(environment, queryOperationDescriptor.request),
-  ];
+  const promise = getPromiseForActiveRequest(
+    environment,
+    queryOperationDescriptor.request,
+  );
+  // $FlowExpectedError[prop-missing]
+  if (promise != null && promise.displayName == null) {
+    // $FlowExpectedError[prop-missing]
+    promise.displayName = missingClientEdgeRequestInfo.request.params.name;
+  }
+  // $FlowFixMe[incompatible-exact] - Intentionally bypassing exactness check
+  return [queryResult, promise];
 }
 
 function subscribeToSnapshot(
@@ -476,7 +485,10 @@ hook useFragmentInternal_EXPERIMENTAL(
 
   // Handle the queries for any missing client edges; this may suspend.
   // FIXME handle client edges in parallel.
-  if (fragmentNode.metadata?.hasClientEdges === true) {
+  if (
+    fragmentNode.metadata?.hasClientEdges === true ||
+    RelayFeatureFlags.CHECK_ALL_FRAGMENTS_FOR_MISSING_CLIENT_EDGES
+  ) {
     // 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.
@@ -487,7 +499,7 @@ hook useFragmentInternal_EXPERIMENTAL(
       const missingClientEdges = getMissingClientEdges(state);
       // eslint-disable-next-line no-shadow
       let clientEdgeQueries;
-      const activeRequestPromises = [];
+      const activeRequestPromises: Array<PromiseWithDisplayName> = [];
       if (missingClientEdges?.length) {
         clientEdgeQueries = ([]: Array<QueryResult>);
         for (const edge of missingClientEdges) {
@@ -508,7 +520,12 @@ hook useFragmentInternal_EXPERIMENTAL(
     }, [state, environment, fragmentNode, fragmentRef, queryOptions]);
 
     if (activeRequestPromises.length) {
-      throw Promise.all(activeRequestPromises);
+      const allPromises = Promise.all(activeRequestPromises);
+      // $FlowExpectedError[prop-missing] Expando to annotate Promises.
+      allPromises.displayName = `RelayClientEdge(${activeRequestPromises
+        .map(promise => promise.displayName)
+        .join(',')})`;
+      throw allPromises;
     }
 
     // See above note
@@ -535,12 +552,15 @@ hook useFragmentInternal_EXPERIMENTAL(
     // Suspend if a Live Resolver within this fragment is in a suspended state:
     const suspendingLiveResolvers = getSuspendingLiveResolver(state);
     if (suspendingLiveResolvers != null && suspendingLiveResolvers.length > 0) {
-      throw Promise.all(
+      const promise = Promise.all(
         suspendingLiveResolvers.map(liveStateID => {
           // $FlowFixMe[prop-missing] This is expected to be a RelayModernStore
           return environment.getStore().getLiveResolverPromise(liveStateID);
         }),
       );
+      // $FlowExpectedError[prop-missing] Expando to annotate Promises.
+      promise.displayName = 'RelayLiveResolver(' + fragmentNode.name + ')';
+      throw promise;
     }
     // Suspend if an active operation bears on this fragment, either the
     // fragment's owner or some other mutation etc. that could affect it.

package/relay-hooks/useLazyLoadQuery.js.flow

@@ -32,23 +32,72 @@ const {
 export type UseLazyLoadQueryHookType = hook <TVariables: Variables, TData>(
   gqlQuery: Query<TVariables, TData>,
   variables: TVariables,
-  options?: $ReadOnly<{
-    fetchKey?: string | number,
-    fetchPolicy?: FetchPolicy,
-    networkCacheConfig?: CacheConfig,
-    UNSTABLE_renderPolicy?: RenderPolicy,
-  }>,
+  options?: Options,
 ) => TData;
 
+type Options = {
+  /**
+   * Determines if cached data should be used, and when to send a network request based on the cached data that is currently available in the Relay store (for more details, see our [Fetch Policies](../../guided-tour/reusing-cached-data/fetch-policies) and [Garbage Collection](../../guided-tour/reusing-cached-data/presence-of-data) guides):
+   *      * "store-or-network": _*(default)*_ *will* reuse locally cached data and will *only* send a network request if any data for the query is missing. If the query is fully cached, a network request will *not* be made.
+   *      * "store-and-network": *will* reuse locally cached data and will *always* send a network request, regardless of whether any data was missing from the local cache or not.
+   *      * "network-only": *will* *not* reuse locally cached data, and will *always* send a network request to fetch the query, ignoring any data that might be locally cached in Relay.
+   *      * "store-only": *will* *only* reuse locally cached data, and will *never* send a network request to fetch the query. In this case, the responsibility of fetching the query falls to the caller, but this policy could also be used to read and operate on data that is entirely [local](../../guided-tour/updating-data/local-data-updates).
+   */
+  +fetchPolicy?: FetchPolicy,
+  /**
+   * A `fetchKey` can be passed to force a re-evaluation of the current query and variables when the component re-renders, even if the variables didn't change, or even if the component isn't remounted (similarly to how passing a different `key` to a React component will cause it to remount). If the `fetchKey` is different from the one used in the previous render, the current query will be re-evaluated against the store, and it might be refetched depending on the current `fetchPolicy` and the state of the cache.
+   */
+  +fetchKey?: string | number,
+  /**
+   * Default value: `{force: true}`. Object containing cache config options for the *network layer*. Note that the network layer may contain an *additional* query response cache which will reuse network responses for identical queries. If you want to bypass this cache completely (which is the default behavior), pass `{force: true}` as the value for this option.
+   */
+  +networkCacheConfig?: CacheConfig,
+  /**
+   * Undocumented option.
+   */
+  +UNSTABLE_renderPolicy?: RenderPolicy,
+};
+
+/**
+ * Hook used to fetch a GraphQL query during render. This hook can trigger multiple nested or waterfalling round trips if used without caution, and waits until render to start a data fetch (when it can usually start a lot sooner than render), thereby degrading performance. Instead, prefer [`usePreloadedQuery`](../use-preloaded-query).
+ *
+ * @example
+ * const React = require('React');
+ *
+ * const {graphql, useLazyLoadQuery} = require('react-relay');
+ *
+ * function App() {
+ *   const data = useLazyLoadQuery(
+ *     graphql`
+ *       query AppQuery($id: ID!) {
+ *         user(id: $id) {
+ *           name
+ *         }
+ *       }
+ *     `,
+ *     {id: 4},
+ *     {fetchPolicy: 'store-or-network'},
+ *   );
+ *
+ *  return <h1>{data.user?.name}</h1>;
+ * }
+ *
+ * @returns - `data`: Object that contains data which has been read out from the Relay store; the object matches the shape of specified query.
+ *   - The Flow type for data will also match this shape, and contain types derived from the GraphQL Schema. For example, the type of `data` above is: `{| user: ?{| name: ?string |} |}`.
+ */
 hook useLazyLoadQuery<TVariables: Variables, TData>(
+  /**
+   * GraphQL query specified using a `graphql` template literal.
+   */
   gqlQuery: Query<TVariables, TData>,
+  /**
+   * Object containing the variable values to fetch the query. These variables need to match GraphQL variables declared inside the query.
+   */
   variables: TVariables,
-  options?: $ReadOnly<{
-    fetchKey?: string | number,
-    fetchPolicy?: FetchPolicy,
-    networkCacheConfig?: CacheConfig,
-    UNSTABLE_renderPolicy?: RenderPolicy,
-  }>,
+  /**
+   * options object
+   */
+  options?: Options,
 ): TData {
   const environment = useRelayEnvironment();
 
@@ -71,4 +120,4 @@ hook useLazyLoadQuery<TVariables: Variables, TData>(
 }
 
 // $FlowFixMe[react-rule-hook-incompatible]
-module.exports = (useLazyLoadQuery: UseLazyLoadQueryHookType);
+module.exports = useLazyLoadQuery;

package/relay-hooks/useLazyLoadQueryNode.js.flow

@@ -78,7 +78,7 @@ hook useLazyLoadQueryNode<TQuery: OperationType>({
   useEffect(() => {
     return () => {
       // Attempt to detect if the component was
-      // hidden (by Offscreen API), or fast refresh occured;
+      // hidden (by Offscreen API), or fast refresh occurred;
       // Only in these situations would the effect cleanup
       // for "unmounting" run multiple times, so if
       // we are ever able to read this ref with a value

package/relay-hooks/usePreloadedQuery.js.flow

@@ -126,7 +126,7 @@ hook usePreloadedQuery<
       // 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
+      // TODO T68036756 track occurrences of this warning and turn it into a hard error
       warning(
         false,
         'usePreloadedQuery(): usePreloadedQuery was passed a preloaded query ' +

package/relay-hooks/useQueryLoader.js.flow

@@ -236,7 +236,7 @@ hook useQueryLoader_CURRENT<
   useEffect(() => {
     return () => {
       // Attempt to detect if the component was
-      // hidden (by Offscreen API), or fast refresh occured;
+      // hidden (by Offscreen API), or fast refresh occurred;
       // Only in these situations would the effect cleanup
       // for "unmounting" run multiple times, so if
       // we are ever able to read this ref with a value

package/relay-hooks/useRelayEnvironment.js.flow

@@ -17,6 +17,28 @@ const ReactRelayContext = require('./../ReactRelayContext');
 const invariant = require('invariant');
 const {useContext} = require('react');
 
+/**
+ * Hook used to access a Relay environment that was set by a [`RelayEnvironmentProvider`](../relay-environment-provider):
+ *
+ * @example
+ * const React = require('React');
+ *
+ * const {useRelayEnvironment} = require('react-relay');
+ *
+ * function MyComponent() {
+ *   const environment = useRelayEnvironment();
+ *
+ *   const handler = useCallback(() => {
+ *     // For example, can be used to pass the environment to functions
+ *     // that require a Relay environment.
+ *     commitMutation(environment, ...);
+ *   }, [environment])
+ *
+ *   return (...);
+ * }
+ *
+ * module.exports = MyComponent;
+ */
 hook useRelayEnvironment(): IEnvironment {
   const context = useContext(ReactRelayContext);
   invariant(