react-relay 16.1.0 → 17.0.0

package/relay-hooks/__flowtests__/usePaginationFragment-flowtest.js.flow

@@ -49,29 +49,40 @@ type ExpectedReturnType<
 // Nullability of returned data type is correct
 // $FlowFixMe[prop-missing]
 // $FlowFixMe[incompatible-cast]
+// $FlowFixMe[incompatible-exact]
+// $FlowFixMe[react-rule-hook]
 (usePaginationFragment(
   refetchableFragmentInput,
   keyNonNullable,
 ): ExpectedReturnType<QueryVariablesSubset, QueryVariables, NonNullableData>);
 
+// $FlowFixMe[react-rule-hook]
 (usePaginationFragment(
   refetchableFragmentInput,
   keyNullable,
 ): ExpectedReturnType<QueryVariables, QueryVariables, NullableData>);
 
 // $FlowExpectedError: can't cast nullable to non-nullable
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[incompatible-cast]
 (usePaginationFragment(
   refetchableFragmentInput,
   keyNullable,
 ): ExpectedReturnType<QueryVariables, QueryVariables, NonNullableData>);
 
 // $FlowExpectedError: actual type of returned data is correct
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[incompatible-exact]
+// $FlowFixMe[prop-missing]
+// $FlowFixMe[incompatible-cast]
 (usePaginationFragment(
   refetchableFragmentInput,
   // $FlowFixMe[incompatible-call]
   keyAnotherNonNullable,
 ): ExpectedReturnType<QueryVariables, QueryVariablesSubset, NonNullableData>);
 // $FlowExpectedError
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[incompatible-cast]
 (usePaginationFragment(
   refetchableFragmentInput,
   // $FlowFixMe[incompatible-call]
@@ -79,18 +90,25 @@ type ExpectedReturnType<
 ): ExpectedReturnType<QueryVariables, QueryVariables, NonNullableData>);
 
 // $FlowExpectedError: Key should not be a user provided object
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[prop-missing]
 usePaginationFragment(refetchableFragmentInput, {abc: 123});
 
 // $FlowExpectedError: Key should not be an empty object
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[prop-missing]
 usePaginationFragment(refetchableFragmentInput, {});
 
 // $FlowExpectedError: Key should be the `<name>$key` type from generated flow
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[prop-missing]
 usePaginationFragment(refetchableFragmentInput, fragmentData);
 
 // Refetch function options:
 declare var variables: QueryVariables;
 declare var environment: IEnvironment;
 
+// $FlowFixMe[react-rule-hook]
 const {refetch} = usePaginationFragment(
   refetchableFragmentInput,
   keyNonNullable,
@@ -109,6 +127,7 @@ refetch(variables, {
 declare var extraVariables: {nickname: string};
 declare var invalidVariables: {foo: string};
 
+// $FlowFixMe[react-rule-hook]
 const {loadNext} = usePaginationFragment(
   refetchableFragmentInput,
   keyNonNullable,

package/relay-hooks/__flowtests__/useRefetchableFragment-flowtest.js.flow

@@ -33,53 +33,75 @@ import {
 // Nullability of returned data type is correct
 // $FlowFixMe[prop-missing]
 // $FlowFixMe[incompatible-cast]
+// $FlowFixMe[incompatible-exact]
+// $FlowFixMe[react-rule-hook]
 (useRefetchableFragment(refetchableFragmentInput, keyNonNullable): [
   NonNullableData,
   FetchFn<QueryVariablesSubset>,
 ]);
 
+// $FlowFixMe[react-rule-hook]
 (useRefetchableFragment(refetchableFragmentInput, keyNullable): [
   NullableData,
   FetchFn<QueryVariables>,
 ]);
 
 // $FlowExpectedError: can't cast nullable to non-nullable
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[incompatible-cast]
 (useRefetchableFragment(refetchableFragmentInput, keyNullable): [
   NonNullableData,
   FetchFn<QueryVariables>,
 ]);
 
 // $FlowExpectedError: refetch requires exact type if key is nullable
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[incompatible-exact]
+// $FlowFixMe[prop-missing]
 (useRefetchableFragment(refetchableFragmentInput, keyNullable): [
   NullableData,
   FetchFn<QueryVariablesSubset>,
 ]);
 
 // $FlowExpectedError: actual type of returned data is correct
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[incompatible-call]
+// $FlowFixMe[incompatible-exact]
+// $FlowFixMe[prop-missing]
+// $FlowFixMe[incompatible-cast]
 (useRefetchableFragment(refetchableFragmentInput, keyAnotherNonNullable): [
   NonNullableData,
   FetchFn<QueryVariablesSubset>,
 ]);
 
 // $FlowExpectedError - incompatible key types
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[incompatible-call]
 (useRefetchableFragment(refetchableFragmentInput, keyAnotherNullable): [
   NullableData,
   FetchFn<QueryVariables>,
 ]);
 
 // $FlowExpectedError: Key should not be a user provided object
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[prop-missing]
 useRefetchableFragment(refetchableFragmentInput, {abc: 123});
 
 // $FlowExpectedError: Key should not be an empty object
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[prop-missing]
 useRefetchableFragment(refetchableFragmentInput, {});
 
 // $FlowExpectedError: Key should be the `<name>$key` type from generated flow
+// $FlowFixMe[react-rule-hook]
+// $FlowFixMe[prop-missing]
 useRefetchableFragment(refetchableFragmentInput, fragmentData);
 
 // Refetch function options:
 declare var variables: QueryVariables;
 declare var environment: IEnvironment;
 
+// $FlowFixMe[react-rule-hook]
 const [, refetch] = useRefetchableFragment(
   refetchableFragmentInput,
   keyNonNullable,

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

@@ -11,8 +11,8 @@
 
 'use strict';
 
-import type {Cache} from './LRUCache';
-import type {QueryResource, QueryResult} from './QueryResource';
+import type {Cache} from '../LRUCache';
+import type {QueryResource, QueryResult} from '../QueryResource';
 import type {
   ConcreteRequest,
   DataID,
@@ -24,9 +24,9 @@ import type {
 } from 'relay-runtime';
 import type {MissingLiveResolverField} from 'relay-runtime/store/RelayStoreTypes';
 
-const LRUCache = require('./LRUCache');
-const {getQueryResourceForEnvironment} = require('./QueryResource');
-const SuspenseResource = require('./SuspenseResource');
+const LRUCache = require('../LRUCache');
+const {getQueryResourceForEnvironment} = require('../QueryResource');
+const SuspenseResource = require('../SuspenseResource');
 const invariant = require('invariant');
 const {
   __internal: {fetchQuery, getPromiseForActiveRequest},
@@ -206,11 +206,9 @@ class FragmentResourceImpl {
   constructor(environment: IEnvironment) {
     this._environment = environment;
     this._cache = LRUCache.create(CACHE_CAPACITY);
-    if (RelayFeatureFlags.ENABLE_CLIENT_EDGES) {
-      this._clientEdgeQueryResultsCache = new ClientEdgeQueryResultsCache(
-        environment,
-      );
-    }
+    this._clientEdgeQueryResultsCache = new ClientEdgeQueryResultsCache(
+      environment,
+    );
   }
 
   /**
@@ -397,7 +395,6 @@ class FragmentResourceImpl {
     // First, initiate a query for any client edges that were missing data:
     let clientEdgeRequests: ?Array<RequestDescriptor> = null;
     if (
-      RelayFeatureFlags.ENABLE_CLIENT_EDGES &&
       fragmentNode.metadata?.hasClientEdges === true &&
       hasMissingClientEdges(snapshot)
     ) {
@@ -432,7 +429,7 @@ class FragmentResourceImpl {
       );
     }
     let clientEdgePromises: Array<Promise<void>> = [];
-    if (RelayFeatureFlags.ENABLE_CLIENT_EDGES && clientEdgeRequests) {
+    if (clientEdgeRequests) {
       clientEdgePromises = clientEdgeRequests
         .map(request => getPromiseForActiveRequest(this._environment, request))
         .filter(Boolean);
@@ -566,6 +563,8 @@ class FragmentResourceImpl {
           this._environment,
           s.missingRequiredFields,
           s.relayResolverErrors,
+          s.errorResponseFields,
+          s.selector.node.metadata?.throwOnFieldError ?? false,
         );
       });
     } else {
@@ -573,6 +572,8 @@ class FragmentResourceImpl {
         this._environment,
         snapshot.missingRequiredFields,
         snapshot.relayResolverErrors,
+        snapshot.errorResponseFields,
+        snapshot.selector.node.metadata?.throwOnFieldError ?? false,
       );
     }
   }
@@ -670,15 +671,13 @@ class FragmentResourceImpl {
       );
     }
 
-    if (RelayFeatureFlags.ENABLE_CLIENT_EDGES) {
-      const clientEdgeQueryResults =
-        this._clientEdgeQueryResultsCache?.get(cacheKey) ?? undefined;
-      if (clientEdgeQueryResults?.length) {
-        const queryResource = getQueryResourceForEnvironment(this._environment);
-        clientEdgeQueryResults.forEach(queryResult => {
-          disposables.push(queryResource.retain(queryResult));
-        });
-      }
+    const clientEdgeQueryResults =
+      this._clientEdgeQueryResultsCache?.get(cacheKey) ?? undefined;
+    if (clientEdgeQueryResults?.length) {
+      const queryResource = getQueryResourceForEnvironment(this._environment);
+      clientEdgeQueryResults.forEach(queryResult => {
+        disposables.push(queryResource.retain(queryResult));
+      });
     }
 
     return {
@@ -776,6 +775,7 @@ class FragmentResourceImpl {
       selector: currentSnapshot.selector,
       missingRequiredFields: currentSnapshot.missingRequiredFields,
       relayResolverErrors: currentSnapshot.relayResolverErrors,
+      errorResponseFields: currentSnapshot.errorResponseFields,
     };
     if (updatedData !== renderData) {
       const result = getFragmentResult(

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

@@ -11,9 +11,9 @@
 
 'use strict';
 
-import type {RefetchableFragment} from '../../relay-runtime/util/RelayRuntimeTypes';
-import type {LoadMoreFn, UseLoadMoreFunctionArgs} from './useLoadMoreFunction';
+import type {LoadMoreFn, UseLoadMoreFunctionArgs} from '../useLoadMoreFunction';
 import type {Options} from './useRefetchableFragmentNode';
+import type {RefetchableFragment} from 'relay-runtime';
 import type {
   Disposable,
   FragmentType,
@@ -22,9 +22,9 @@ import type {
   Variables,
 } from 'relay-runtime';
 
-const useLoadMoreFunction = require('./useLoadMoreFunction');
+const useLoadMoreFunction = require('../useLoadMoreFunction');
+const useStaticFragmentNodeWarning = require('../useStaticFragmentNodeWarning');
 const useRefetchableFragmentNode = require('./useRefetchableFragmentNode');
-const useStaticFragmentNodeWarning = require('./useStaticFragmentNodeWarning');
 const invariant = require('invariant');
 const {useCallback, useEffect, useRef, useState} = require('react');
 const {
@@ -65,7 +65,7 @@ type ReturnType<TVariables, TData, TKey> = {
   refetch: RefetchFn<TVariables, TKey>,
 };
 
-function useBlockingPaginationFragment<
+hook useBlockingPaginationFragment<
   TFragmentType: FragmentType,
   TVariables: Variables,
   TData,
@@ -166,7 +166,7 @@ function useBlockingPaginationFragment<
   };
 }
 
-function useLoadMore<TVariables: Variables>(args: {
+hook useLoadMore<TVariables: Variables>(args: {
   disableStoreUpdates: () => void,
   enableStoreUpdates: () => void,
   ...$Exact<

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

@@ -13,9 +13,9 @@
 
 import type {ReaderFragment} from 'relay-runtime';
 
+const useRelayEnvironment = require('../useRelayEnvironment');
+const useUnsafeRef_DEPRECATED = require('../useUnsafeRef_DEPRECATED');
 const {getFragmentResourceForEnvironment} = require('./FragmentResource');
-const useRelayEnvironment = require('./useRelayEnvironment');
-const useUnsafeRef_DEPRECATED = require('./useUnsafeRef_DEPRECATED');
 const {useEffect, useState} = require('react');
 const {RelayFeatureFlags, getFragmentIdentifier} = require('relay-runtime');
 const warning = require('warning');
@@ -26,7 +26,7 @@ type ReturnType<TFragmentData: mixed> = {
   enableStoreUpdates: () => void,
 };
 
-function useFragmentNode<TFragmentData: mixed>(
+hook useFragmentNode<TFragmentData: mixed>(
   fragmentNode: ReaderFragment,
   fragmentRef: mixed,
   componentDisplayName: string,

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

@@ -11,8 +11,8 @@
 
 'use strict';
 
-import type {RefetchableIdentifierInfo} from '../../relay-runtime/util/ReaderNode';
-import type {LoaderFn} from './useQueryLoader';
+import type {LoaderFn} from '../useQueryLoader';
+import type {RefetchableIdentifierInfo} from 'relay-runtime';
 import type {
   ConcreteRequest,
   Disposable,
@@ -26,13 +26,13 @@ import type {
   VariablesOf,
 } from 'relay-runtime';
 
+const ProfilerContext = require('../ProfilerContext');
+const {getQueryResourceForEnvironment} = require('../QueryResource');
+const useIsMountedRef = require('../useIsMountedRef');
+const useQueryLoader = require('../useQueryLoader');
+const useRelayEnvironment = require('../useRelayEnvironment');
 const {getFragmentResourceForEnvironment} = require('./FragmentResource');
-const ProfilerContext = require('./ProfilerContext');
-const {getQueryResourceForEnvironment} = require('./QueryResource');
 const useFragmentNode = require('./useFragmentNode');
-const useIsMountedRef = require('./useIsMountedRef');
-const useQueryLoader = require('./useQueryLoader');
-const useRelayEnvironment = require('./useRelayEnvironment');
 const invariant = require('invariant');
 const {useCallback, useContext, useReducer} = require('react');
 const {
@@ -162,7 +162,7 @@ function reducer(state: RefetchState, action: Action): RefetchState {
   }
 }
 
-function useRefetchableFragmentNode<
+hook useRefetchableFragmentNode<
   TQuery: OperationType,
   TKey: ?{+$data?: mixed, ...},
 >(
@@ -367,7 +367,7 @@ function useRefetchableFragmentNode<
   };
 }
 
-function useRefetchFunction<TQuery: OperationType>(
+hook useRefetchFunction<TQuery: OperationType>(
   componentDisplayName: string,
   dispatch: (
     | {

package/relay-hooks/loadQuery.js.flow

@@ -46,7 +46,7 @@ const warning = require('warning');
 let RenderDispatcher = null;
 let fetchKey = 100001;
 
-function useTrackLoadQueryInRender() {
+hook useTrackLoadQueryInRender() {
   if (RenderDispatcher === null) {
     // Flow does not know of React internals (rightly so), but we need to
     // ensure here that this function isn't called inside render.
@@ -57,13 +57,14 @@ function useTrackLoadQueryInRender() {
   }
 }
 
-type QueryType<T> = T extends Query<infer V, infer D, infer RR>
-  ? {
-      variables: V,
-      response: D,
-      rawResponse?: $NonMaybeType<RR>,
-    }
-  : $Call<<T>(PreloadableConcreteRequest<T>) => T, T>;
+type QueryType<T> =
+  T extends Query<infer V, infer D, infer RR>
+    ? {
+        variables: V,
+        response: D,
+        rawResponse?: $NonMaybeType<RR>,
+      } // $FlowFixMe[deprecated-type]
+    : $Call<<T>(PreloadableConcreteRequest<T>) => T, T>;
 
 declare function loadQuery<
   T,

package/relay-hooks/{experimental/readFragmentInternal_EXPERIMENTAL.js.flow → readFragmentInternal.js.flow}

@@ -11,7 +11,7 @@
 
 'use strict';
 
-import type {QueryResult} from '../QueryResource';
+import type {QueryResult} from './QueryResource';
 import type {
   CacheConfig,
   FetchPolicy,
@@ -23,7 +23,7 @@ import type {
 } from 'relay-runtime';
 import type {MissingClientEdgeRequestInfo} from 'relay-runtime/store/RelayStoreTypes';
 
-const {getQueryResourceForEnvironment} = require('../QueryResource');
+const {getQueryResourceForEnvironment} = require('./QueryResource');
 const invariant = require('invariant');
 const {
   __internal: {fetchQuery: fetchQueryInternal},
@@ -87,6 +87,8 @@ function handlePotentialSnapshotErrorsForState(
       environment,
       state.snapshot.missingRequiredFields,
       state.snapshot.relayResolverErrors,
+      state.snapshot.errorResponseFields,
+      state.snapshot.selector.node.metadata?.throwOnFieldError ?? false,
     );
   } else if (state.kind === 'plural') {
     for (const snapshot of state.snapshots) {
@@ -94,6 +96,8 @@ function handlePotentialSnapshotErrorsForState(
         environment,
         snapshot.missingRequiredFields,
         snapshot.relayResolverErrors,
+        snapshot.errorResponseFields,
+        snapshot.selector.node.metadata?.throwOnFieldError ?? false,
       );
     }
   }
@@ -157,7 +161,7 @@ function getFragmentState(
 }
 
 // fragmentNode cannot change during the lifetime of the component, though fragmentRef may change.
-function readFragmentInternal_EXPERIMENTAL(
+function readFragmentInternal(
   environment: IEnvironment,
   fragmentNode: ReaderFragment,
   fragmentRef: mixed,
@@ -295,4 +299,4 @@ function readFragmentInternal_EXPERIMENTAL(
   return {data, clientEdgeQueries};
 }
 
-module.exports = readFragmentInternal_EXPERIMENTAL;
+module.exports = readFragmentInternal;

package/relay-hooks/useClientQuery.js.flow

@@ -20,7 +20,7 @@ const useLazyLoadQuery = require('./useLazyLoadQuery');
  * These queries are consist of queries for client-only data,
  * schematized via local schema extensions and/or Relay resolvers.
  */
-function useClientQuery<TVariables: Variables, TData, TRawResponse>(
+hook useClientQuery<TVariables: Variables, TData, TRawResponse>(
   gqlQuery: ClientQuery<TVariables, TData, TRawResponse>,
   variables: TVariables,
   options?: {

package/relay-hooks/useEntryPointLoader.js.flow

@@ -50,7 +50,7 @@ type NullEntryPointReference = {
 };
 const initialNullEntryPointReferenceState = {kind: 'NullEntryPointReference'};
 
-function useLoadEntryPoint<
+hook useLoadEntryPoint<
   TEntryPointParams: {...},
   TPreloadedQueries: {...},
   TPreloadedEntryPoints: {...},

package/relay-hooks/useFetchTrackingRef.js.flow

@@ -28,7 +28,7 @@ const {useCallback, useEffect} = require('react');
  * The additional functions returned by this Hook can be used to mutate
  * the ref.
  */
-function useFetchTrackingRef(): {
+hook useFetchTrackingRef(): {
   isFetchingRef: {current: ?boolean, ...},
   startFetch: Subscription => void,
   disposeFetch: () => void,

package/relay-hooks/useFragment.js.flow

@@ -13,9 +13,8 @@
 
 import type {Fragment, FragmentType, GraphQLTaggedNode} from 'relay-runtime';
 
-const HooksImplementation = require('./HooksImplementation');
 const {useTrackLoadQueryInRender} = require('./loadQuery');
-const useFragmentNode = require('./useFragmentNode');
+const useFragmentInternal = require('./useFragmentInternal');
 const useStaticFragmentNodeWarning = require('./useStaticFragmentNodeWarning');
 const {useDebugValue} = require('react');
 const {getFragment} = require('relay-runtime');
@@ -26,48 +25,43 @@ type HasSpread<TFragmentType> = {
 };
 
 // if the key is non-nullable, return non-nullable value
-declare function useFragment<TFragmentType: FragmentType, TData>(
+declare hook useFragment<TFragmentType: FragmentType, TData>(
   fragment: Fragment<TFragmentType, TData>,
   key: HasSpread<TFragmentType>,
 ): TData;
 
+// if the key is nullable, return nullable value
+declare hook useFragment<TFragmentType: FragmentType, TData>(
+  fragment: Fragment<TFragmentType, TData>,
+  key: ?HasSpread<TFragmentType>,
+): ?TData;
+
 // if the key is a non-nullable array of keys, return non-nullable array
-declare function useFragment<TFragmentType: FragmentType, TData>(
+declare hook useFragment<TFragmentType: FragmentType, TData>(
   fragment: Fragment<TFragmentType, TData>,
   key: $ReadOnlyArray<HasSpread<TFragmentType>>,
 ): TData;
 
-// if the key is null/void, return null/void value
-declare function useFragment<TFragmentType: FragmentType, TData>(
+// if the key is a nullable array of keys, return nullable array
+declare hook useFragment<TFragmentType: FragmentType, TData>(
   fragment: Fragment<TFragmentType, TData>,
-  key: null | void,
-): null | void;
+  key: ?$ReadOnlyArray<HasSpread<TFragmentType>>,
+): ?TData;
 
-function useFragment_LEGACY(fragment: GraphQLTaggedNode, key: mixed): mixed {
+hook useFragment(fragment: GraphQLTaggedNode, key: mixed): mixed {
   // We need to use this hook in order to be able to track if
   // loadQuery was called during render
   useTrackLoadQueryInRender();
 
   const fragmentNode = getFragment(fragment);
   useStaticFragmentNodeWarning(fragmentNode, 'first argument of useFragment()');
-  const {data} = useFragmentNode<mixed>(fragmentNode, key, 'useFragment()');
+  const data = useFragmentInternal(fragmentNode, key, 'useFragment()');
   if (__DEV__) {
     // eslint-disable-next-line react-hooks/rules-of-hooks
+    // $FlowFixMe[react-rule-hook]
     useDebugValue({fragment: fragmentNode.name, data});
   }
   return data;
 }
 
-function useFragment(fragment: GraphQLTaggedNode, key: mixed): mixed {
-  const impl = HooksImplementation.get();
-  if (impl) {
-    // $FlowFixMe This is safe because impl.useFragment has the type of useFragment...
-    return impl.useFragment(fragment, key);
-    // (i.e. type declared above, but not the supertype used in this function definition)
-  } else {
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    return useFragment_LEGACY(fragment, key);
-  }
-}
-
 module.exports = useFragment;