react-relay 12.0.0 → 13.0.0

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

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -12,15 +12,6 @@
 // flowlint ambiguous-object-type:error
 
 import type {LoadMoreFn} from '../useLoadMoreFunction';
-import usePaginationFragment from '../usePaginationFragment';
-import {
-  fragmentInput,
-  fragmentData,
-  keyAnotherNonNullable,
-  keyAnotherNullable,
-  keyNonNullable,
-  keyNullable,
-} from './utils';
 import type {
   FetchFn,
   NonNullableData,
@@ -31,6 +22,16 @@ import type {
 } from './utils';
 import type {IEnvironment, OperationType} from 'relay-runtime';
 
+import usePaginationFragment from '../usePaginationFragment';
+import {
+  fragmentData,
+  fragmentInput,
+  keyAnotherNonNullable,
+  keyAnotherNullable,
+  keyNonNullable,
+  keyNullable,
+} from './utils';
+
 type ExpectedReturnType<
   TQuery: OperationType,
   TQueryVariables,

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

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -11,15 +11,6 @@
 
 // flowlint ambiguous-object-type:error
 
-import useRefetchableFragment from '../useRefetchableFragment';
-import {
-  fragmentInput,
-  keyAnotherNonNullable,
-  keyAnotherNullable,
-  keyNonNullable,
-  keyNullable,
-  fragmentData,
-} from './utils';
 import type {
   FetchFn,
   NonNullableData,
@@ -30,6 +21,16 @@ import type {
 } from './utils';
 import type {IEnvironment} from 'relay-runtime';
 
+import useRefetchableFragment from '../useRefetchableFragment';
+import {
+  fragmentData,
+  fragmentInput,
+  keyAnotherNonNullable,
+  keyAnotherNullable,
+  keyNonNullable,
+  keyNullable,
+} from './utils';
+
 /* eslint-disable react-hooks/rules-of-hooks */
 
 // Nullability of returned data type is correct

package/relay-hooks/__flowtests__/utils.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -13,21 +13,26 @@
 
 'use strict';
 
-import type {
-  Disposable,
-  FragmentReference,
-  GraphQLTaggedNode,
-} from 'relay-runtime';
+import type {Disposable, Fragment, FragmentType} from 'relay-runtime';
 
-declare export var fragmentInput: GraphQLTaggedNode;
+declare export var fragmentInput: Fragment<
+  Example_user$fragmentType,
+  Example_user$data,
+>;
+
+declare export opaque type Example_user$fragmentType: FragmentType;
+export type Example_user$data = NonNullableData;
+export type Example_user$key = {
+  +$data?: Example_user$data,
+  +$fragmentSpreads: Example_user$fragmentType,
+  ...
+};
 
 export type NonNullableData = {|
   +id: string,
   +count: number,
 |};
-
 export type NullableData = ?NonNullableData;
-
 export type NonNullablePluralData = $ReadOnlyArray<NonNullableData>;
 export type NullablePluralData = ?$ReadOnlyArray<NonNullableData>;
 
@@ -36,44 +41,28 @@ export type AnotherNonNullableData = {|
   +friends: ?number,
 |};
 
-declare export var keyNonNullable: {
-  +$data?: NonNullableData,
-  +$fragmentRefs: FragmentReference,
-  ...
-};
+declare export var keyNonNullable: Example_user$key;
 
-declare export var keyNonNullablePlural: $ReadOnlyArray<{
-  +$data?: NonNullablePluralData,
-  +$fragmentRefs: FragmentReference,
-  ...
-}>;
+declare export var keyNonNullablePlural: $ReadOnlyArray<Example_user$key>;
 
-declare export var keyNullablePlural: ?$ReadOnlyArray<{
-  +$data?: NonNullablePluralData,
-  +$fragmentRefs: FragmentReference,
-  ...
-}>;
+declare export var keyNullablePlural: ?$ReadOnlyArray<Example_user$key>;
 
-declare export var keyNullable: ?{
-  +$data?: NonNullableData,
-  +$fragmentRefs: FragmentReference,
-  ...
-};
+declare export var keyNullable: ?Example_user$key;
 
 declare export var keyAnotherNonNullable: {
   +$data: AnotherNonNullableData,
-  +$fragmentRefs: FragmentReference,
+  +$fragmentSpreads: FragmentType,
   ...
 };
 
 declare export var keyAnotherNullable: ?{
   +$data: AnotherNonNullableData,
-  +$fragmentRefs: FragmentReference,
+  +$fragmentSpreads: FragmentType,
   ...
 };
 
 declare export var fragmentData: {
-  +$refType: FragmentReference,
+  +$fragmentType: FragmentType,
   ...
 };
 

package/relay-hooks/loadEntryPoint.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -11,8 +11,6 @@
 
 'use strict';
 
-const {loadQuery} = require('./loadQuery');
-
 import type {
   EntryPoint,
   EntryPointComponent,
@@ -21,6 +19,8 @@ import type {
   PreloadedEntryPoint,
 } from './EntryPointTypes.flow';
 
+const {loadQuery} = require('./loadQuery');
+
 function loadEntryPoint<
   TEntryPointParams: {...},
   TPreloadedQueries: {...},
@@ -51,12 +51,8 @@ function loadEntryPoint<
   if (queries != null) {
     const queriesPropNames = Object.keys(queries);
     queriesPropNames.forEach(queryPropName => {
-      const {
-        environmentProviderOptions,
-        options,
-        parameters,
-        variables,
-      } = queries[queryPropName];
+      const {environmentProviderOptions, options, parameters, variables} =
+        queries[queryPropName];
 
       const environment = environmentProvider.getEnvironment(
         environmentProviderOptions,
@@ -83,10 +79,8 @@ function loadEntryPoint<
       if (entryPointDescription == null) {
         return;
       }
-      const {
-        entryPoint: nestedEntryPoint,
-        entryPointParams: nestedParams,
-      } = entryPointDescription;
+      const {entryPoint: nestedEntryPoint, entryPointParams: nestedParams} =
+        entryPointDescription;
       preloadedEntryPoints[entryPointPropName] = loadEntryPoint(
         environmentProvider,
         nestedEntryPoint,

package/relay-hooks/loadQuery.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -11,37 +11,35 @@
 
 'use strict';
 
-const React = require('react');
-
-const invariant = require('invariant');
-const warning = require('warning');
-
-const {
-  PreloadableQueryRegistry,
-  ReplaySubject,
-  createOperationDescriptor,
-  getRequest,
-  getRequestIdentifier,
-  Observable,
-  RelayFeatureFlags,
-  __internal: {fetchQueryDeduped},
-} = require('relay-runtime');
-
 import type {
+  LoadQueryOptions,
   PreloadableConcreteRequest,
   PreloadedQueryInner,
-  LoadQueryOptions,
 } from './EntryPointTypes.flow';
 import type {
+  GraphQLResponse,
+  GraphQLTaggedNode,
   IEnvironment,
   OperationDescriptor,
   OperationType,
-  GraphQLTaggedNode,
-  GraphQLResponse,
   RequestIdentifier,
   RequestParameters,
 } from 'relay-runtime';
 
+const invariant = require('invariant');
+const React = require('react');
+const {
+  Observable,
+  PreloadableQueryRegistry,
+  RelayFeatureFlags,
+  ReplaySubject,
+  __internal: {fetchQueryDeduped},
+  createOperationDescriptor,
+  getRequest,
+  getRequestIdentifier,
+} = require('relay-runtime');
+const warning = require('warning');
+
 let RenderDispatcher = null;
 let fetchKey = 100001;
 
@@ -59,7 +57,7 @@ function useTrackLoadQueryInRender() {
 function loadQuery<TQuery: OperationType, TEnvironmentProviderOptions>(
   environment: IEnvironment,
   preloadableRequest: GraphQLTaggedNode | PreloadableConcreteRequest<TQuery>,
-  variables: $ElementType<TQuery, 'variables'>,
+  variables: TQuery['variables'],
   options?: ?LoadQueryOptions,
   environmentProviderOptions?: ?TEnvironmentProviderOptions,
 ): PreloadedQueryInner<TQuery, TEnvironmentProviderOptions> {
@@ -274,7 +272,8 @@ function loadQuery<TQuery: OperationType, TEnvironmentProviderOptions>(
   let cancelOnLoadCallback;
   let queryId;
   if (preloadableRequest.kind === 'PreloadableConcreteRequest') {
-    const preloadableConcreteRequest: PreloadableConcreteRequest<TQuery> = (preloadableRequest: $FlowFixMe);
+    const preloadableConcreteRequest: PreloadableConcreteRequest<TQuery> =
+      (preloadableRequest: $FlowFixMe);
     ({params} = preloadableConcreteRequest);
 
     ({id: queryId} = params);
@@ -300,7 +299,6 @@ function loadQuery<TQuery: OperationType, TEnvironmentProviderOptions>(
         fetchPolicy === 'store-only' ? null : makeNetworkRequest(params);
       // $FlowFixMe[method-unbinding] added when improving typing for this parameters
       ({dispose: cancelOnLoadCallback} = PreloadableQueryRegistry.onLoad(
-        // $FlowFixMe[incompatible-call]
         queryId,
         preloadedModule => {
           cancelOnLoadCallback();
@@ -319,7 +317,8 @@ function loadQuery<TQuery: OperationType, TEnvironmentProviderOptions>(
       ));
     }
   } else {
-    const graphQlTaggedNode: GraphQLTaggedNode = (preloadableRequest: $FlowFixMe);
+    const graphQlTaggedNode: GraphQLTaggedNode =
+      (preloadableRequest: $FlowFixMe);
     const request = getRequest(graphQlTaggedNode);
     params = request.params;
     queryId = params.cacheID != null ? params.cacheID : params.id;

package/relay-hooks/preloadQuery_DEPRECATED.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -13,15 +13,6 @@
 
 'use strict';
 
-const {
-  createOperationDescriptor,
-  getRequest,
-  getRequestIdentifier,
-  Observable,
-  PreloadableQueryRegistry,
-  ReplaySubject,
-} = require('relay-runtime');
-
 import type {
   PreloadableConcreteRequest,
   PreloadedQueryInner_DEPRECATED,
@@ -39,6 +30,16 @@ import type {
   Subscription,
 } from 'relay-runtime';
 
+const {
+  Observable,
+  PreloadableQueryRegistry,
+  RelayFeatureFlags,
+  ReplaySubject,
+  createOperationDescriptor,
+  getRequest,
+  getRequestIdentifier,
+} = require('relay-runtime');
+
 // Expire results by this delay after they resolve.
 const DEFAULT_PREFETCH_TIMEOUT = 30 * 1000; // 30 seconds
 
@@ -111,7 +112,23 @@ function preloadQuery<TQuery: OperationType, TEnvironmentProviderOptions>(
           }
           return () => {
             subscription?.unsubscribe();
-            cleanup(pendingQueries, queryEntry);
+            if (environment.isServer()) {
+              return;
+            }
+            if (
+              RelayFeatureFlags.DELAY_CLEANUP_OF_PENDING_PRELOAD_QUERIES ===
+              true
+            ) {
+              setTimeout(() => {
+                // Clear the cache entry after the default timeout
+                // null-check for Flow
+                if (queryEntry != null) {
+                  cleanup(pendingQueries, queryEntry);
+                }
+              }, DEFAULT_PREFETCH_TIMEOUT);
+            } else {
+              cleanup(pendingQueries, queryEntry);
+            }
           };
         })
       : null;
@@ -140,7 +157,8 @@ function preloadQueryDeduped<TQuery: OperationType>(
   let params;
   let query: ?ConcreteRequest;
   if (preloadableRequest.kind === 'PreloadableConcreteRequest') {
-    const preloadableConcreteRequest: PreloadableConcreteRequest<TQuery> = (preloadableRequest: $FlowFixMe);
+    const preloadableConcreteRequest: PreloadableConcreteRequest<TQuery> =
+      (preloadableRequest: $FlowFixMe);
     params = preloadableConcreteRequest.params;
     query = params.id != null ? PreloadableQueryRegistry.get(params.id) : null;
   } else {
@@ -238,9 +256,7 @@ function preloadQueryDeduped<TQuery: OperationType>(
   } else {
     nextQueryEntry = prevQueryEntry;
   }
-  // $FlowFixMe[incompatible-call]
   pendingQueries.set(cacheKey, nextQueryEntry);
-  // $FlowFixMe[incompatible-return]
   return nextQueryEntry;
 }
 

package/relay-hooks/prepareEntryPoint_DEPRECATED.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -13,8 +13,6 @@
 
 'use strict';
 
-const preloadQuery = require('./preloadQuery_DEPRECATED');
-
 import type {
   EntryPoint,
   EntryPointComponent,
@@ -22,6 +20,8 @@ import type {
   IEnvironmentProvider,
 } from './EntryPointTypes.flow';
 
+const preloadQuery = require('./preloadQuery_DEPRECATED');
+
 function prepareEntryPoint<
   TEntryPointParams: {...},
   TPreloadedQueries: {...},
@@ -51,12 +51,8 @@ function prepareEntryPoint<
   if (queries != null) {
     const queriesPropNames = Object.keys(queries);
     queriesPropNames.forEach(queryPropName => {
-      const {
-        environmentProviderOptions,
-        options,
-        parameters,
-        variables,
-      } = queries[queryPropName];
+      const {environmentProviderOptions, options, parameters, variables} =
+        queries[queryPropName];
 
       const environment = environmentProvider.getEnvironment(
         environmentProviderOptions,
@@ -79,10 +75,8 @@ function prepareEntryPoint<
       if (entryPointDescription == null) {
         return;
       }
-      const {
-        entryPoint: nestedEntryPoint,
-        entryPointParams: nestedParams,
-      } = entryPointDescription;
+      const {entryPoint: nestedEntryPoint, entryPointParams: nestedParams} =
+        entryPointDescription;
       preloadedEntryPoints[entryPointPropName] = prepareEntryPoint(
         environmentProvider,
         nestedEntryPoint,

package/relay-hooks/useBlockingPaginationFragment.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -13,11 +13,20 @@
 
 'use strict';
 
-const invariant = require('invariant');
+import type {LoadMoreFn, UseLoadMoreFunctionArgs} from './useLoadMoreFunction';
+import type {RefetchFnDynamic} from './useRefetchableFragmentNode';
+import type {
+  FragmentType,
+  GraphQLResponse,
+  GraphQLTaggedNode,
+  Observer,
+  OperationType,
+} from 'relay-runtime';
+
 const useLoadMoreFunction = require('./useLoadMoreFunction');
 const useRefetchableFragmentNode = require('./useRefetchableFragmentNode');
 const useStaticFragmentNodeWarning = require('./useStaticFragmentNodeWarning');
-
+const invariant = require('invariant');
 const {useCallback, useEffect, useRef, useState} = require('react');
 const {
   getFragment,
@@ -25,16 +34,6 @@ const {
   getPaginationMetadata,
 } = require('relay-runtime');
 
-import type {LoadMoreFn, UseLoadMoreFunctionArgs} from './useLoadMoreFunction';
-import type {RefetchFnDynamic} from './useRefetchableFragmentNode';
-import type {
-  FragmentReference,
-  GraphQLResponse,
-  GraphQLTaggedNode,
-  Observer,
-  OperationType,
-} from 'relay-runtime';
-
 export type ReturnType<TQuery: OperationType, TKey, TFragmentData> = {|
   data: TFragmentData,
   loadNext: LoadMoreFn<TQuery>,
@@ -46,7 +45,7 @@ export type ReturnType<TQuery: OperationType, TKey, TFragmentData> = {|
 
 function useBlockingPaginationFragment<
   TQuery: OperationType,
-  TKey: ?{+$data?: mixed, +$fragmentRefs: FragmentReference, ...},
+  TKey: ?{+$data?: mixed, +$fragmentSpreads: FragmentType, ...},
 >(
   fragmentInput: GraphQLTaggedNode,
   parentFragmentRef: TKey,

package/relay-hooks/useEntryPointLoader.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -13,12 +13,6 @@
 
 'use strict';
 
-const loadEntryPoint = require('./loadEntryPoint');
-const useIsMountedRef = require('./useIsMountedRef');
-
-const {useTrackLoadQueryInRender} = require('./loadQuery');
-const {useCallback, useEffect, useRef, useState} = require('react');
-
 import type {
   EntryPoint,
   EntryPointComponent,
@@ -27,6 +21,11 @@ import type {
   PreloadedEntryPoint,
 } from './EntryPointTypes.flow';
 
+const loadEntryPoint = require('./loadEntryPoint');
+const {useTrackLoadQueryInRender} = require('./loadQuery');
+const useIsMountedRef = require('./useIsMountedRef');
+const {useCallback, useEffect, useRef, useState} = require('react');
+
 type UseEntryPointLoaderHookReturnType<
   TEntryPointParams: {...},
   TPreloadedQueries: {...},
@@ -121,10 +120,8 @@ function useLoadEntryPoint<
   const [entryPointReference, setEntryPointReference] = useState<
     PreloadedEntryPoint<TEntryPointComponent> | NullEntryPointReference,
   >(initialEntryPointReferenceInternal);
-  const [
-    entryPointParams,
-    setEntryPointParams,
-  ] = useState<TEntryPointParams | null>(initialEntryPointParamsInternal);
+  const [entryPointParams, setEntryPointParams] =
+    useState<TEntryPointParams | null>(initialEntryPointParamsInternal);
 
   const disposeEntryPoint = useCallback(() => {
     if (isMountedRef.current) {

package/relay-hooks/useFetchTrackingRef.js.flow

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * 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.
@@ -13,10 +13,10 @@
 
 'use strict';
 
-const {useCallback, useEffect, useRef} = require('react');
-
 import type {Subscription} from 'relay-runtime';
 
+const {useCallback, useEffect, useRef} = require('react');
+
 /**
  * This hook returns a mutable React ref that holds the value of whether a
  * fetch request is in flight. The reason this is a mutable ref instead of