react-relay 20.1.1 → 21.0.0

package/relay-hooks/legacy/useRefetchableFragmentNode.js.flow

@@ -46,7 +46,7 @@ const {
 const warning = require('warning');
 
 export type RefetchFn<
-  TQuery: OperationType,
+  TQuery extends OperationType,
   TOptions = Options,
 > = RefetchFnExact<TQuery, TOptions>;
 
@@ -56,20 +56,20 @@ export type RefetchFn<
 //  - Or, expects /a subset/ of the query variables if the provided key type is
 //    /non-null/.
 export type RefetchFnDynamic<
-  TQuery: OperationType,
-  TKey: ?{+$data?: mixed, ...},
+  TQuery extends OperationType,
+  TKey extends ?{+$data?: unknown, ...},
   TOptions = Options,
-> = [TKey] extends [{+$data?: mixed, ...}]
+> = [TKey] extends [{+$data?: unknown, ...}]
   ? RefetchFnInexact<TQuery, TOptions>
   : RefetchFnExact<TQuery, TOptions>;
 
 export type ReturnType<
-  TQuery: OperationType,
-  TKey: ?{+$data?: mixed, ...},
+  TQuery extends OperationType,
+  TKey extends ?{+$data?: unknown, ...},
   TOptions = Options,
 > = {
-  fragmentData: mixed,
-  fragmentRef: mixed,
+  fragmentData: unknown,
+  fragmentRef: unknown,
   refetch: RefetchFnDynamic<TQuery, TKey, TOptions>,
   disableStoreUpdates: () => void,
   enableStoreUpdates: () => void,
@@ -91,12 +91,12 @@ type RefetchFnBase<TVars, TOptions> = (
   options?: TOptions,
 ) => Disposable;
 
-type RefetchFnExact<TQuery: OperationType, TOptions = Options> = RefetchFnBase<
-  VariablesOf<TQuery>,
-  TOptions,
->;
+type RefetchFnExact<
+  TQuery extends OperationType,
+  TOptions = Options,
+> = RefetchFnBase<VariablesOf<TQuery>, TOptions>;
 type RefetchFnInexact<
-  TQuery: OperationType,
+  TQuery extends OperationType,
   TOptions = Options,
 > = RefetchFnBase<Partial<VariablesOf<TQuery>>, TOptions>;
 
@@ -156,18 +156,18 @@ function reducer(state: RefetchState, action: Action): RefetchState {
       };
     }
     default: {
-      (action.type: empty);
+      action.type as empty;
       throw new Error('useRefetchableFragmentNode: Unexpected action type');
     }
   }
 }
 
 hook useRefetchableFragmentNode<
-  TQuery: OperationType,
-  TKey: ?{+$data?: mixed, ...},
+  TQuery extends OperationType,
+  TKey extends ?{+$data?: unknown, ...},
 >(
   fragmentNode: ReaderFragment,
-  parentFragmentRef: mixed,
+  parentFragmentRef: unknown,
   componentDisplayName: string,
 ): ReturnType<TQuery, TKey, InternalOptions> {
   const parentEnvironment = useRelayEnvironment();
@@ -188,7 +188,7 @@ hook useRefetchableFragmentNode<
     refetchEnvironment: null,
     refetchQuery: null,
     renderPolicy: undefined,
-  });
+  } as RefetchState);
   const {
     fetchPolicy,
     mirroredEnvironment,
@@ -211,7 +211,7 @@ hook useRefetchableFragmentNode<
     TQuery['variables'],
     TQuery['response'],
     TQuery['rawResponse'],
-  >((refetchableRequest: $FlowFixMe));
+  >(refetchableRequest as $FlowFixMe);
 
   let fragmentRef = parentFragmentRef;
 
@@ -222,9 +222,9 @@ hook useRefetchableFragmentNode<
 
   if (shouldReset) {
     dispatch({
-      type: 'reset',
       environment,
       fragmentIdentifier,
+      type: 'reset',
     });
     disposeQuery();
   } else if (refetchQuery != null && queryRef != null) {
@@ -279,7 +279,6 @@ hook useRefetchableFragmentNode<
         fetchPolicy,
         renderPolicy,
         {
-          error: handleQueryCompleted,
           complete: () => {
             // Validate that the type of the object we got back matches the type
             // of the object already in the store
@@ -293,6 +292,7 @@ hook useRefetchableFragmentNode<
             }
             handleQueryCompleted();
           },
+          error: handleQueryCompleted,
         },
         queryRef.fetchKey,
         profilerContext,
@@ -342,7 +342,7 @@ hook useRefetchableFragmentNode<
     data: fragmentData,
     disableStoreUpdates,
     enableStoreUpdates,
-  } = useFragmentNode<mixed>(fragmentNode, fragmentRef, componentDisplayName);
+  } = useFragmentNode<unknown>(fragmentNode, fragmentRef, componentDisplayName);
 
   const refetch = useRefetchFunction<TQuery>(
     componentDisplayName,
@@ -358,16 +358,16 @@ hook useRefetchableFragmentNode<
     refetchableRequest,
   );
   return {
+    disableStoreUpdates,
+    enableStoreUpdates,
     fragmentData,
     fragmentRef,
-    // $FlowFixMe[incompatible-return] RefetchFn not compatible with RefetchFnDynamic
+    // $FlowFixMe[incompatible-type] RefetchFn not compatible with RefetchFnDynamic
     refetch,
-    disableStoreUpdates,
-    enableStoreUpdates,
   };
 }
 
-hook useRefetchFunction<TQuery: OperationType>(
+hook useRefetchFunction<TQuery extends OperationType>(
   componentDisplayName: string,
   dispatch: (
     | {
@@ -385,13 +385,13 @@ hook useRefetchFunction<TQuery: OperationType>(
       },
   ) => void,
   disposeQuery: () => void,
-  fragmentData: mixed,
+  fragmentData: unknown,
   fragmentIdentifier: string,
   fragmentNode: ReaderFragment,
-  fragmentRefPathInResponse: $ReadOnlyArray<string | number>,
+  fragmentRefPathInResponse: ReadonlyArray<string | number>,
   identifierInfo: ?RefetchableIdentifierInfo,
   loadQuery: LoaderFn<TQuery>,
-  parentFragmentRef: mixed,
+  parentFragmentRef: unknown,
   refetchableRequest: ConcreteRequest,
 ): RefetchFn<TQuery, InternalOptions> {
   const isMountedRef = useIsMountedRef();
@@ -458,7 +458,7 @@ hook useRefetchFunction<TQuery: OperationType>(
       // We fill in any variables not passed by the call to `refetch()` with the
       // variables from the original parent fragment owner.
       const refetchVariables: VariablesOf<TQuery> = {
-        ...(parentVariables: $FlowFixMe),
+        ...(parentVariables as $FlowFixMe),
         ...fragmentVariables,
         ...providedRefetchVariables,
       };
@@ -483,7 +483,7 @@ hook useRefetchFunction<TQuery: OperationType>(
             identifierValue,
           );
         }
-        (refetchVariables: $FlowFixMe)[
+        (refetchVariables as $FlowFixMe)[
           identifierInfo.identifierQueryVariableName
         ] = identifierValue;
       }
@@ -502,18 +502,18 @@ hook useRefetchFunction<TQuery: OperationType>(
       // so that they have been filtered out to include only the
       // variables actually declared in the query.
       loadQuery(refetchQuery.request.variables, {
-        fetchPolicy,
         __environment: refetchEnvironment,
         __nameForWarning: 'refetch',
+        fetchPolicy,
       });
 
       dispatch({
-        type: 'refetch',
         fetchPolicy,
         onComplete,
         refetchEnvironment,
         refetchQuery,
         renderPolicy,
+        type: 'refetch',
       });
       return {dispose: disposeQuery};
     },
@@ -531,33 +531,32 @@ hook useRefetchFunction<TQuery: OperationType>(
 let debugFunctions;
 if (__DEV__) {
   debugFunctions = {
-    getInitialIDAndType(
-      memoRefetchVariables: ?Variables,
-      fragmentRefPathInResponse: $ReadOnlyArray<string | number>,
-      identifierQueryVariableName: ?string,
-      environment: IEnvironment,
-    ): ?DebugIDandTypename {
-      const {Record} = require('relay-runtime');
-      const id = memoRefetchVariables?.[identifierQueryVariableName ?? 'id'];
-      if (
-        fragmentRefPathInResponse.length !== 1 ||
-        fragmentRefPathInResponse[0] !== 'node' ||
-        id == null
-      ) {
-        return null;
+    checkSameIDAfterRefetch(
+      previousIDAndTypename: ?DebugIDandTypename,
+      refetchedFragmentRef: unknown,
+      fragmentNode: ReaderFragment,
+      componentDisplayName: string,
+    ): void {
+      if (previousIDAndTypename == null || refetchedFragmentRef == null) {
+        return;
       }
-      const recordSource = environment.getStore().getSource();
-      const record = recordSource.get(id);
-      const typename = record == null ? null : Record.getType(record);
-      if (typename == null) {
-        return null;
+      const {ID_KEY} = require('relay-runtime');
+      // $FlowExpectedError[incompatible-use]
+      const resultID = refetchedFragmentRef[ID_KEY];
+      if (resultID != null && resultID !== previousIDAndTypename.id) {
+        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,
+        );
       }
-      return {
-        id,
-        typename,
-      };
     },
-
     checkSameTypeAfterRefetch(
       previousIDAndType: ?DebugIDandTypename,
       environment: IEnvironment,
@@ -585,32 +584,31 @@ if (__DEV__) {
         );
       }
     },
-
-    checkSameIDAfterRefetch(
-      previousIDAndTypename: ?DebugIDandTypename,
-      refetchedFragmentRef: mixed,
-      fragmentNode: ReaderFragment,
-      componentDisplayName: string,
-    ): void {
-      if (previousIDAndTypename == null || refetchedFragmentRef == null) {
-        return;
+    getInitialIDAndType(
+      memoRefetchVariables: ?Variables,
+      fragmentRefPathInResponse: ReadonlyArray<string | number>,
+      identifierQueryVariableName: ?string,
+      environment: IEnvironment,
+    ): ?DebugIDandTypename {
+      const {Record} = require('relay-runtime');
+      const id = memoRefetchVariables?.[identifierQueryVariableName ?? 'id'];
+      if (
+        fragmentRefPathInResponse.length !== 1 ||
+        fragmentRefPathInResponse[0] !== 'node' ||
+        id == null
+      ) {
+        return null;
       }
-      const {ID_KEY} = require('relay-runtime');
-      // $FlowExpectedError[incompatible-use]
-      const resultID = refetchedFragmentRef[ID_KEY];
-      if (resultID != null && resultID !== previousIDAndTypename.id) {
-        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,
-        );
+      const recordSource = environment.getStore().getSource();
+      const record = recordSource.get(id);
+      const typename = record == null ? null : Record.getType(record);
+      if (typename == null) {
+        return null;
       }
+      return {
+        id,
+        typename,
+      };
     },
   };
 }

package/relay-hooks/loadEntryPoint.js.flow

@@ -23,19 +23,19 @@ import type {
 const {loadQuery} = require('./loadQuery');
 
 function loadEntryPoint<
-  TEntryPointParams: {...},
+  TEntryPointParams extends {...},
   // $FlowExpectedError[unclear-type] Need any to make it supertype of all PreloadedQuery
-  TPreloadedQueries: {+[string]: PreloadedQuery<any>},
-  TPreloadedEntryPoints: {...},
-  TRuntimeProps: {...},
+  TPreloadedQueries extends {+[string]: PreloadedQuery<any>},
+  TPreloadedEntryPoints extends {...},
+  TRuntimeProps extends {...},
   TExtraProps,
-  TEntryPointComponent: EntryPointComponent<
+  TEntryPointComponent extends EntryPointComponent<
     TPreloadedQueries,
     TPreloadedEntryPoints,
     TRuntimeProps,
     TExtraProps,
   >,
-  TEntryPoint: EntryPoint<TEntryPointParams, TEntryPointComponent>,
+  TEntryPoint extends EntryPoint<TEntryPointParams, TEntryPointComponent>,
 >(
   environmentProvider: IEnvironmentProvider<EnvironmentProviderOptions>,
   entryPoint: TEntryPoint,
@@ -78,9 +78,9 @@ function loadEntryPoint<
         parameters,
         variables,
         {
+          __nameForWarning: 'loadEntryPoint',
           fetchPolicy: options?.fetchPolicy,
           networkCacheConfig: options?.networkCacheConfig,
-          __nameForWarning: 'loadEntryPoint',
         },
         environmentProviderOptions,
       );
@@ -101,8 +101,8 @@ function loadEntryPoint<
         {},
         {...},
         {...},
-        mixed,
-        EntryPointComponent<{}, {...}, {...}, mixed>,
+        unknown,
+        EntryPointComponent<{}, {...}, {...}, unknown>,
         _,
       >(environmentProvider, nestedEntryPoint, nestedParams);
     });
@@ -130,7 +130,8 @@ function loadEntryPoint<
       }
       isDisposed = true;
     },
-    entryPoints: (preloadedEntryPoints: TPreloadedEntryPoints),
+    // $FlowFixMe[incompatible-type]
+    entryPoints: preloadedEntryPoints as TPreloadedEntryPoints,
     extraProps: extraProps ?? null,
     getComponent: () => {
       const componentModule = entryPoint.root.getModuleIfRequired();
@@ -148,14 +149,15 @@ function loadEntryPoint<
         componentModule.default != null
           ? componentModule.default
           : componentModule;
-      // $FlowFixMe[incompatible-cast] - trust me Flow, its entryPoint component
-      return (component: TEntryPointComponent);
+      // $FlowFixMe[incompatible-type] - trust me Flow, its entryPoint component
+      return component as TEntryPointComponent;
     },
     // $FlowFixMe[unsafe-getters-setters] - this has no side effects
     get isDisposed() {
       return isDisposed;
     },
-    queries: (preloadedQueries: TPreloadedQueries),
+    // $FlowFixMe[incompatible-type]
+    queries: preloadedQueries as TPreloadedQueries,
     rootModuleID: entryPoint.root.getModuleId(),
   };
 }

package/relay-hooks/loadQuery.js.flow

@@ -48,7 +48,7 @@ export type QueryType<T> =
     ? {
         variables: V,
         response: D,
-        rawResponse?: $NonMaybeType<RR>,
+        rawResponse?: NonNullable<RR>,
       }
     : [+t: T] extends [+t: PreloadableConcreteRequest<infer V>]
       ? V
@@ -66,7 +66,7 @@ declare function loadQuery<
 ): PreloadedQueryInner<QueryType<T>, TEnvironmentProviderOptions>;
 
 function loadQuery<
-  TQuery: OperationType,
+  TQuery extends OperationType,
   TEnvironmentProviderOptions = EnvironmentProviderOptions,
 >(
   environment: IEnvironment,
@@ -175,6 +175,9 @@ function loadQuery<
     });
 
     const {unsubscribe} = observable.subscribe({
+      complete() {
+        subject.complete();
+      },
       error(err) {
         networkError = err;
         subject.error(err);
@@ -182,9 +185,6 @@ function loadQuery<
       next(data) {
         subject.next(data);
       },
-      complete() {
-        subject.complete();
-      },
     });
     unsubscribeFromNetworkRequest = unsubscribe;
     return Observable.create(sink => {
@@ -230,15 +230,15 @@ function loadQuery<
       operation.request.identifier,
       fetchFn,
     ).subscribe({
+      complete() {
+        executionSubject.complete();
+      },
       error(err) {
         executionSubject.error(err);
       },
       next(data) {
         executionSubject.next(data);
       },
-      complete() {
-        executionSubject.complete();
-      },
     }));
   };
 
@@ -284,7 +284,7 @@ function loadQuery<
   let queryId;
   if (preloadableRequest.kind === 'PreloadableConcreteRequest') {
     const preloadableConcreteRequest: PreloadableConcreteRequest<TQuery> =
-      (preloadableRequest: $FlowFixMe);
+      preloadableRequest as $FlowFixMe;
     ({params} = preloadableConcreteRequest);
 
     ({id: queryId} = params);
@@ -329,7 +329,7 @@ function loadQuery<
     }
   } else {
     const graphQlTaggedNode: GraphQLTaggedNode =
-      (preloadableRequest: $FlowFixMe);
+      preloadableRequest as $FlowFixMe;
     const request = getRequest(graphQlTaggedNode);
     params = request.params;
     queryId = params.cacheID != null ? params.cacheID : params.id;
@@ -365,9 +365,7 @@ function loadQuery<
     isNetworkRequestCancelled = true;
   };
   return {
-    kind: 'PreloadedQuery',
-    environment,
-    environmentProviderOptions,
+    cancelNetworkRequest,
     dispose() {
       if (isDisposed) {
         return;
@@ -376,21 +374,23 @@ function loadQuery<
       cancelNetworkRequest();
       isDisposed = true;
     },
-    releaseQuery,
-    cancelNetworkRequest,
+    environment,
+    environmentProviderOptions,
     fetchKey,
+    fetchPolicy,
     id: queryId,
     // $FlowFixMe[unsafe-getters-setters] - this has no side effects
     get isDisposed() {
       return isDisposed || isReleased;
     },
+    kind: 'PreloadedQuery',
+    name: params.name,
+    networkCacheConfig,
     // $FlowFixMe[unsafe-getters-setters] - this has no side effects
     get networkError() {
       return networkError;
     },
-    name: params.name,
-    networkCacheConfig,
-    fetchPolicy,
+    releaseQuery,
     source: didMakeNetworkRequest ? returnedObservable : undefined,
     variables,
   };

package/relay-hooks/preloadQuery_DEPRECATED.js.flow

@@ -49,7 +49,7 @@ const pendingQueriesByEnvironment = WEAKMAP_SUPPORTED
   : new Map<IEnvironment, Map<string, PendingQueryEntry>>();
 
 type PendingQueryEntry =
-  | $ReadOnly<{
+  | Readonly<{
       cacheKey: string,
       fetchKey: ?string | ?number,
       fetchPolicy: PreloadFetchPolicy,
@@ -60,7 +60,7 @@ type PendingQueryEntry =
       subject: ReplaySubject<GraphQLResponse>,
       subscription: Subscription,
     }>
-  | $ReadOnly<{
+  | Readonly<{
       cacheKey: string,
       fetchKey: ?string | ?number,
       fetchPolicy: PreloadFetchPolicy,
@@ -70,7 +70,10 @@ type PendingQueryEntry =
       status: PreloadQueryStatus,
     }>;
 
-function preloadQuery<TQuery: OperationType, TEnvironmentProviderOptions>(
+function preloadQuery<
+  TQuery extends OperationType,
+  TEnvironmentProviderOptions,
+>(
   environment: IEnvironment,
   preloadableRequest: GraphQLTaggedNode | PreloadableConcreteRequest<TQuery>,
   variables: VariablesOf<TQuery>,
@@ -124,21 +127,21 @@ function preloadQuery<TQuery: OperationType, TEnvironmentProviderOptions>(
         })
       : null;
   return {
-    kind: 'PreloadedQuery_DEPRECATED',
     environment,
     environmentProviderOptions,
     fetchKey: queryEntry.fetchKey,
     fetchPolicy: queryEntry.fetchPolicy,
-    networkCacheConfig: options?.networkCacheConfig,
     id: queryEntry.id,
+    kind: 'PreloadedQuery_DEPRECATED',
     name: queryEntry.name,
+    networkCacheConfig: options?.networkCacheConfig,
     source,
-    variables,
     status: queryEntry.status,
+    variables,
   };
 }
 
-function preloadQueryDeduped<TQuery: OperationType>(
+function preloadQueryDeduped<TQuery extends OperationType>(
   environment: IEnvironment,
   pendingQueries: Map<string, PendingQueryEntry>,
   preloadableRequest: GraphQLTaggedNode | PreloadableConcreteRequest<TQuery>,
@@ -149,11 +152,11 @@ function preloadQueryDeduped<TQuery: OperationType>(
   let query: ?ConcreteRequest;
   if (preloadableRequest.kind === 'PreloadableConcreteRequest') {
     const preloadableConcreteRequest: PreloadableConcreteRequest<TQuery> =
-      (preloadableRequest: $FlowFixMe);
+      preloadableRequest as $FlowFixMe;
     params = preloadableConcreteRequest.params;
     query = params.id != null ? PreloadableQueryRegistry.get(params.id) : null;
   } else {
-    query = getRequest((preloadableRequest: $FlowFixMe));
+    query = getRequest(preloadableRequest as $FlowFixMe);
     params = query.params;
   }
   const network = environment.getNetwork();
@@ -189,13 +192,13 @@ function preloadQueryDeduped<TQuery: OperationType>(
             cacheKey,
             fetchKey,
             fetchPolicy,
-            kind: 'cache',
             id: params.id,
+            kind: 'cache',
             name: params.name,
             status: {
               cacheConfig: networkCacheConfig,
-              source: 'cache',
               fetchTime: availability?.fetchTime ?? null,
+              source: 'cache',
             },
           };
     if (!environment.isServer() && prevQueryEntry == null) {
@@ -224,13 +227,13 @@ function preloadQueryDeduped<TQuery: OperationType>(
       cacheKey,
       fetchKey,
       fetchPolicy,
-      kind: 'network',
       id: params.id,
+      kind: 'network',
       name: params.name,
       status: {
         cacheConfig: networkCacheConfig,
-        source: 'network',
         fetchTime: null,
+        source: 'network',
       },
       subject,
       subscription: source

package/relay-hooks/prepareEntryPoint_DEPRECATED.js.flow

@@ -22,19 +22,19 @@ import type {
 const preloadQuery = require('./preloadQuery_DEPRECATED');
 
 function prepareEntryPoint<
-  TEntryPointParams: {...},
+  TEntryPointParams extends {...},
   // $FlowExpectedError[unclear-type] Need any to make it supertype of all PreloadedQuery
-  TPreloadedQueries: {+[string]: PreloadedQuery<any>},
-  TPreloadedEntryPoints: {...},
-  TRuntimeProps: {...},
+  TPreloadedQueries extends {+[string]: PreloadedQuery<any>},
+  TPreloadedEntryPoints extends {...},
+  TRuntimeProps extends {...},
   TExtraProps,
-  TEntryPointComponent: EntryPointComponent<
+  TEntryPointComponent extends EntryPointComponent<
     TPreloadedQueries,
     TPreloadedEntryPoints,
     TRuntimeProps,
     TExtraProps,
   >,
-  TEntryPoint: EntryPoint<TEntryPointParams, TEntryPointComponent>,
+  TEntryPoint extends EntryPoint<TEntryPointParams, TEntryPointComponent>,
 >(
   environmentProvider: IEnvironmentProvider<EnvironmentProviderOptions>,
   entryPoint: TEntryPoint,
@@ -62,7 +62,7 @@ function prepareEntryPoint<
       );
 
       // $FlowFixMe[incompatible-type]
-      preloadedQueries[queryPropName] = preloadQuery<OperationType, mixed>(
+      preloadedQueries[queryPropName] = preloadQuery<OperationType, unknown>(
         environment,
         parameters,
         variables,