relay-runtime 12.0.0 → 13.0.0-rc.0

package/store/readInlineData.js.flow

@@ -12,24 +12,23 @@
 
 'use strict';
 
-const invariant = require('invariant');
+import type {GraphQLTaggedNode} from '../query/GraphQLTag';
+import type {FragmentType} from './RelayStoreTypes';
 
 const {getInlineDataFragment} = require('../query/GraphQLTag');
 const {FRAGMENTS_KEY} = require('./RelayStoreUtils');
-
-import type {GraphQLTaggedNode} from '../query/GraphQLTag';
-import type {FragmentReference} from './RelayStoreTypes';
+const invariant = require('invariant');
 
 /**
  * Reads an @inline data fragment that was spread into the parent fragment.
  */
 
 declare function readInlineData<
-  TRef: FragmentReference,
+  TFragmentType: FragmentType,
   TData,
   TKey: {
     +$data?: TData,
-    +$fragmentRefs: TRef,
+    +$fragmentSpreads: TFragmentType,
     ...
   },
 >(
@@ -37,11 +36,11 @@ declare function readInlineData<
   fragmentRef: TKey,
 ): TData;
 declare function readInlineData<
-  TRef: FragmentReference,
+  TFragmentType: FragmentType,
   TData,
   TKey: ?{
     +$data?: TData,
-    +$fragmentRefs: TRef,
+    +$fragmentSpreads: TFragmentType,
     ...
   },
 >(

package/subscription/requestSubscription.js.flow

@@ -12,17 +12,6 @@
 
 'use strict';
 
-const RelayDeclarativeMutationConfig = require('../mutations/RelayDeclarativeMutationConfig');
-const RelayFeatureFlags = require('../util/RelayFeatureFlags');
-
-const warning = require('warning');
-
-const {getRequest} = require('../query/GraphQLTag');
-const {
-  createOperationDescriptor,
-} = require('../store/RelayModernOperationDescriptor');
-const {createReaderSelector} = require('../store/RelayModernSelector');
-
 import type {DeclarativeMutationConfig} from '../mutations/RelayDeclarativeMutationConfig';
 import type {GraphQLTaggedNode} from '../query/GraphQLTag';
 import type {
@@ -35,6 +24,15 @@ import type {
   Variables,
 } from '../util/RelayRuntimeTypes';
 
+const RelayDeclarativeMutationConfig = require('../mutations/RelayDeclarativeMutationConfig');
+const {getRequest} = require('../query/GraphQLTag');
+const {
+  createOperationDescriptor,
+} = require('../store/RelayModernOperationDescriptor');
+const {createReaderSelector} = require('../store/RelayModernSelector');
+const RelayFeatureFlags = require('../util/RelayFeatureFlags');
+const warning = require('warning');
+
 export type SubscriptionParameters = {|
   +response: {...},
   +variables: interface {},
@@ -45,11 +43,11 @@ export type GraphQLSubscriptionConfig<T: SubscriptionParameters> = {|
   configs?: Array<DeclarativeMutationConfig>,
   cacheConfig?: CacheConfig,
   subscription: GraphQLTaggedNode,
-  variables: $ElementType<T, 'variables'>,
+  variables: T['variables'],
   onCompleted?: ?() => void,
   onError?: ?(error: Error) => void,
-  onNext?: ?(response: ?$ElementType<T, 'response'>) => void,
-  updater?: ?SelectorStoreUpdater,
+  onNext?: ?(response: ?T['response']) => void,
+  updater?: ?SelectorStoreUpdater<T['response']>,
 |};
 
 export type DEPRECATED_GraphQLSubscriptionConfig<TSubscriptionPayload> = {|
@@ -60,7 +58,7 @@ export type DEPRECATED_GraphQLSubscriptionConfig<TSubscriptionPayload> = {|
   onCompleted?: ?() => void,
   onError?: ?(error: Error) => void,
   onNext?: ?(response: ?TSubscriptionPayload) => void,
-  updater?: ?SelectorStoreUpdater,
+  updater?: ?SelectorStoreUpdater<TSubscriptionPayload>,
 |};
 
 function requestSubscription<TSubscriptionPayload>(
@@ -71,14 +69,8 @@ function requestSubscription<TSubscriptionPayload>(
   if (subscription.params.operationKind !== 'subscription') {
     throw new Error('requestSubscription: Must use Subscription operation');
   }
-  const {
-    configs,
-    onCompleted,
-    onError,
-    onNext,
-    variables,
-    cacheConfig,
-  } = config;
+  const {configs, onCompleted, onError, onNext, variables, cacheConfig} =
+    config;
   const operation = createOperationDescriptor(
     subscription,
     variables,
@@ -100,7 +92,7 @@ function requestSubscription<TSubscriptionPayload>(
     : config;
 
   const sub = environment
-    .execute({
+    .executeSubscription({
       operation,
       updater,
     })

package/util/ReaderNode.js.flow

@@ -226,13 +226,22 @@ export type ReaderRelayResolver = {|
   +fragment: ReaderFragmentSpread,
   +resolverModule: (rootKey: {
     +$data?: any, // flowlint-line unclear-type:off
+    +$fragmentSpreads: any, // flowlint-line unclear-type:off
     +$fragmentRefs: any, // flowlint-line unclear-type:off
     ...
   }) => mixed,
 |};
 
+export type ReaderClientEdge = {|
+  +kind: 'ClientEdge',
+  +linkedField: ReaderLinkedField,
+  +operation: ConcreteRequest,
+  +backingField: ReaderRelayResolver | ReaderClientExtension,
+|};
+
 export type ReaderSelection =
   | ReaderCondition
+  | ReaderClientEdge
   | ReaderClientExtension
   | ReaderDefer
   | ReaderField

package/util/RelayConcreteNode.js.flow

@@ -70,6 +70,7 @@ const RelayConcreteNode = {
   ACTOR_CHANGE: 'ActorChange',
   CONDITION: 'Condition',
   CLIENT_COMPONENT: 'ClientComponent',
+  CLIENT_EDGE: 'ClientEdge',
   CLIENT_EXTENSION: 'ClientExtension',
   DEFER: 'Defer',
   CONNECTION: 'Connection',

package/util/RelayFeatureFlags.js.flow

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow strict
+ * @flow strict-local
  * @format
  */
 
@@ -14,7 +14,9 @@
 
 import type {Disposable} from '../util/RelayRuntimeTypes';
 
-type FeatureFlags = {|
+export type FeatureFlags = {|
+  DELAY_CLEANUP_OF_PENDING_PRELOAD_QUERIES: boolean,
+  ENABLE_CLIENT_EDGES: boolean,
   ENABLE_VARIABLE_CONNECTION_KEY: boolean,
   ENABLE_PARTIAL_RENDERING_DEFAULT: boolean,
   ENABLE_REACT_FLIGHT_COMPONENT_FIELD: boolean,
@@ -28,9 +30,15 @@ type FeatureFlags = {|
   BATCH_ASYNC_MODULE_UPDATES_FN: ?(() => void) => Disposable,
   ENABLE_CONTAINERS_SUBSCRIBE_ON_COMMIT: boolean,
   ENABLE_QUERY_RENDERER_OFFSCREEN_SUPPORT: boolean,
+  MAX_DATA_ID_LENGTH: ?number,
+  REFACTOR_SUSPENSE_RESOURCE: boolean,
+  STRING_INTERN_LEVEL: number,
+  USE_REACT_CACHE: boolean,
 |};
 
 const RelayFeatureFlags: FeatureFlags = {
+  DELAY_CLEANUP_OF_PENDING_PRELOAD_QUERIES: false,
+  ENABLE_CLIENT_EDGES: false,
   ENABLE_VARIABLE_CONNECTION_KEY: false,
   ENABLE_PARTIAL_RENDERING_DEFAULT: true,
   ENABLE_REACT_FLIGHT_COMPONENT_FIELD: false,
@@ -44,6 +52,10 @@ const RelayFeatureFlags: FeatureFlags = {
   BATCH_ASYNC_MODULE_UPDATES_FN: null,
   ENABLE_CONTAINERS_SUBSCRIBE_ON_COMMIT: false,
   ENABLE_QUERY_RENDERER_OFFSCREEN_SUPPORT: false,
+  MAX_DATA_ID_LENGTH: null,
+  REFACTOR_SUSPENSE_RESOURCE: true,
+  STRING_INTERN_LEVEL: 0,
+  USE_REACT_CACHE: false,
 };
 
 module.exports = RelayFeatureFlags;

package/util/RelayReplaySubject.js.flow

@@ -12,12 +12,11 @@
 
 'use strict';
 
-const RelayObservable = require('../network/RelayObservable');
+import type {Observer, Sink, Subscription} from '../network/RelayObservable';
 
+const RelayObservable = require('../network/RelayObservable');
 const invariant = require('invariant');
 
-import type {Observer, Sink, Subscription} from '../network/RelayObservable';
-
 type Event<T> =
   | {
       kind: 'next',

package/util/RelayRuntimeTypes.js.flow

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow strict
+ * @flow strict-local
  * @format
  */
 
@@ -16,6 +16,9 @@
  * Basic types used throughout Relay.
  */
 
+import type {ReaderFragment, ReaderInlineDataFragment} from './ReaderNode';
+import type {ConcreteRequest} from './RelayConcreteNode';
+
 /**
  * Represents any resource that must be explicitly disposed of. The most common
  * use-case is as a return value for subscriptions, where calling `dispose()`
@@ -38,7 +41,7 @@ export type OperationType = {|
   +rawResponse?: {...},
 |};
 
-export type VariablesOf<T: OperationType> = $ElementType<T, 'variables'>;
+export type VariablesOf<T: OperationType> = T['variables'];
 
 /**
  * Settings for how a query response may be cached.
@@ -69,3 +72,67 @@ export type FetchPolicy =
   | 'store-and-network'
   | 'store-only';
 export type RenderPolicy = 'full' | 'partial';
+
+/* eslint-disable no-undef */
+
+/**
+ * Return type of graphql tag literals for all operations.
+ */
+declare export opaque type Operation<
+  -TVariables: Variables,
+  +TData,
+  TRawResponse,
+>: ConcreteRequest;
+
+/**
+ * Return type of graphql tag literals for queries.
+ */
+declare export opaque type Query<
+  -TVariables: Variables,
+  +TData,
+  TRawResponse = void,
+>: Operation<TVariables, TData, TRawResponse>;
+
+/**
+ * Return type of graphql tag literals for mutations.
+ */
+declare export opaque type Mutation<
+  -TVariables: Variables,
+  +TData,
+  TRawResponse = void,
+>: Operation<TVariables, TData, TRawResponse>;
+
+/**
+ * Return type of graphql tag literals for subscriptions.
+ *
+ * NOTE: Using the GraphQL prefix here because of a naming conflict with
+ *       `RelayObservable`'s `Subscription` type.
+ */
+declare export opaque type GraphQLSubscription<
+  -TVariables: Variables,
+  +TData,
+  TRawResponse = void,
+>: Operation<TVariables, TData, TRawResponse>;
+
+/**
+ * Return type of graphql tag literals for `@inline` fragments.
+ */
+declare export opaque type InlineFragment<
+  TFragmentType,
+  +TData,
+>: ReaderInlineDataFragment;
+
+/**
+ * Return type of graphql tag literals for fragments, except `@inline`
+ * fragments.
+ */
+declare export opaque type Fragment<TFragmentType, +TData>: ReaderFragment;
+
+/**
+ * Return type of graphql tag literals for `@refetchable` fragments.
+ */
+declare export opaque type RefetchableFragment<
+  TFragmentType,
+  +TData,
+  -TVariables: Variables,
+>: Fragment<TFragmentType, TData>;

package/util/StringInterner.js.flow

@@ -0,0 +1,69 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict
+ * @format
+ */
+
+// flowlint ambiguous-object-type:error
+
+'use strict';
+
+const internTable = new Map();
+let nextIndex = 1;
+const digits = initDigitTable();
+
+// Character used as the prefix for interned strings. The specific character is
+// chosen to reduce the likelihood that non-interned input strings need to be
+// escaped (choosing eg a-Z would increase the likelihood we need to escape)
+const INTERN_PREFIX = '\t';
+// Character used as the prefix of escaped strings. As above, this is also
+// chosen to be unlikely in normal input strings.
+const ESCAPE_PREFIX = '\v';
+
+function initDigitTable() {
+  // disable lint because digits isn't defined when this function is called
+  // eslint-disable-next-line no-shadow
+  const digits = new Set();
+  for (let i = 0; i < 10; ++i) {
+    digits.add(i.toString());
+  }
+  return digits;
+}
+
+// Escape a string so that it cannot conflict with an interned string
+function escape(str: string): string {
+  if (
+    // "\t<digit>..." -> "\v\t<digit>..."
+    (str[0] === INTERN_PREFIX && digits.has(str[1])) ||
+    // "\v..." -> "\v\v..."
+    str[0] === ESCAPE_PREFIX
+  ) {
+    return ESCAPE_PREFIX + str;
+  }
+  return str;
+}
+
+// Interns the input string if its length equals or exceeds the given `limit`,
+// returning a shorter replacement string that is uniquely associated with the
+// input: multiple calls to intern() for the equivalent input strings (and limit)
+// will always return the exact same string.
+// Strings shorter than the limit are not interned but are escaped if they
+// could conflict with interned strings.
+function intern(str: string, limit: ?number): string {
+  if (limit == null || str.length < limit) {
+    return escape(str);
+  }
+  let internedString = internTable.get(str);
+  if (internedString != null) {
+    return internedString;
+  }
+  internedString = INTERN_PREFIX + nextIndex++;
+  internTable.set(str, internedString);
+  return internedString;
+}
+
+module.exports = {intern};

package/util/createPayloadFor3DField.js.flow

@@ -13,14 +13,14 @@
 
 'use strict';
 
+import type {JSResourceReference} from 'JSResourceReference';
+import type {NormalizationSplitOperation} from './NormalizationNode';
+
 const {
   getModuleComponentKey,
   getModuleOperationKey,
 } = require('../store/RelayStoreUtils');
 
-import type {NormalizationSplitOperation} from './NormalizationNode';
-import type {JSResourceReference} from 'JSResourceReference';
-
 export opaque type Local3DPayload<
   +DocumentName: string,
   +Response: {...},

package/util/getFragmentIdentifier.js.flow

@@ -13,18 +13,17 @@
 
 'use strict';
 
-const RelayFeatureFlags = require('./RelayFeatureFlags');
-
-const isEmptyObject = require('./isEmptyObject');
-const stableCopy = require('./stableCopy');
+import type {ReaderFragment} from './ReaderNode';
 
 const {
   getDataIDsFromFragment,
-  getVariablesFromFragment,
   getSelector,
+  getVariablesFromFragment,
 } = require('../store/RelayModernSelector');
-
-import type {ReaderFragment} from './ReaderNode';
+const isEmptyObject = require('./isEmptyObject');
+const RelayFeatureFlags = require('./RelayFeatureFlags');
+const stableCopy = require('./stableCopy');
+const {intern} = require('./StringInterner');
 
 function getFragmentIdentifier(
   fragmentNode: ReaderFragment,
@@ -43,6 +42,19 @@ function getFragmentIdentifier(
   const dataIDs = getDataIDsFromFragment(fragmentNode, fragmentRef);
 
   if (RelayFeatureFlags.ENABLE_GETFRAGMENTIDENTIFIER_OPTIMIZATION) {
+    let ids =
+      typeof dataIDs === 'undefined'
+        ? 'missing'
+        : dataIDs == null
+        ? 'null'
+        : Array.isArray(dataIDs)
+        ? '[' + dataIDs.join(',') + ']'
+        : dataIDs;
+    ids =
+      RelayFeatureFlags.STRING_INTERN_LEVEL <= 1
+        ? ids
+        : intern(ids, RelayFeatureFlags.MAX_DATA_ID_LENGTH);
+
     return (
       fragmentOwnerIdentifier +
       '/' +
@@ -52,15 +64,15 @@ function getFragmentIdentifier(
         ? '{}'
         : JSON.stringify(stableCopy(fragmentVariables))) +
       '/' +
-      (typeof dataIDs === 'undefined'
-        ? 'missing'
-        : dataIDs == null
-        ? 'null'
-        : Array.isArray(dataIDs)
-        ? '[' + dataIDs.join(',') + ']'
-        : dataIDs)
+      ids
     );
   } else {
+    let ids = JSON.stringify(dataIDs) ?? 'missing';
+    ids =
+      RelayFeatureFlags.STRING_INTERN_LEVEL <= 1
+        ? ids
+        : intern(ids, RelayFeatureFlags.MAX_DATA_ID_LENGTH);
+
     return (
       fragmentOwnerIdentifier +
       '/' +
@@ -68,7 +80,7 @@ function getFragmentIdentifier(
       '/' +
       JSON.stringify(stableCopy(fragmentVariables)) +
       '/' +
-      (JSON.stringify(dataIDs) ?? 'missing')
+      ids
     );
   }
 }

package/util/getOperation.js.flow

@@ -13,14 +13,14 @@
 
 'use strict';
 
-const {REQUEST, SPLIT_OPERATION} = require('./RelayConcreteNode');
-
 import type {
   NormalizationOperation,
   NormalizationRootNode,
   NormalizationSplitOperation,
 } from './NormalizationNode';
 
+const {REQUEST, SPLIT_OPERATION} = require('./RelayConcreteNode');
+
 /**
  * OperationLoaders can return either a NormalizationSplitOperation or
  * ConcreteRequest.

package/util/getPaginationMetadata.js.flow

@@ -13,15 +13,15 @@
 
 'use strict';
 
-const getRefetchMetadata = require('./getRefetchMetadata');
-const invariant = require('invariant');
-
 import type {
   ConcreteRequest,
   ReaderFragment,
   ReaderPaginationMetadata,
 } from 'relay-runtime';
 
+const getRefetchMetadata = require('./getRefetchMetadata');
+const invariant = require('invariant');
+
 function getPaginationMetadata(
   fragmentNode: ReaderFragment,
   componentDisplayName: string,
@@ -32,10 +32,8 @@ function getPaginationMetadata(
   paginationMetadata: ReaderPaginationMetadata,
   stream: boolean,
 |} {
-  const {
-    refetchableRequest: paginationRequest,
-    refetchMetadata,
-  } = getRefetchMetadata(fragmentNode, componentDisplayName);
+  const {refetchableRequest: paginationRequest, refetchMetadata} =
+    getRefetchMetadata(fragmentNode, componentDisplayName);
 
   const paginationMetadata = refetchMetadata.connection;
   invariant(

package/util/getPaginationVariables.js.flow

@@ -13,12 +13,12 @@
 
 'use strict';
 
-const invariant = require('invariant');
-const warning = require('warning');
-
 import type {ReaderPaginationMetadata} from './ReaderNode';
 import type {Variables} from './RelayRuntimeTypes';
 
+const invariant = require('invariant');
+const warning = require('warning');
+
 export type Direction = 'forward' | 'backward';
 
 function getPaginationVariables(
@@ -29,10 +29,8 @@ function getPaginationVariables(
   extraVariables: Variables,
   paginationMetadata: ReaderPaginationMetadata,
 ): {[string]: mixed, ...} {
-  const {
-    backward: backwardMetadata,
-    forward: forwardMetadata,
-  } = paginationMetadata;
+  const {backward: backwardMetadata, forward: forwardMetadata} =
+    paginationMetadata;
 
   if (direction === 'backward') {
     invariant(
@@ -56,7 +54,6 @@ function getPaginationVariables(
         'determined by Relay.',
       backwardMetadata.count,
     );
-    // $FlowFixMe[cannot-spread-interface]
     const paginationVariables = {
       ...baseVariables,
       ...extraVariables,
@@ -93,7 +90,6 @@ function getPaginationVariables(
       'determined by Relay.',
     forwardMetadata.count,
   );
-  // $FlowFixMe[cannot-spread-interface]
   const paginationVariables = {
     ...baseVariables,
     ...extraVariables,

package/util/getPendingOperationsForFragment.js.flow

@@ -13,11 +13,11 @@
 
 'use strict';
 
-const {getPromiseForActiveRequest} = require('../query/fetchQueryInternal');
-
 import type {IEnvironment, RequestDescriptor} from '../store/RelayStoreTypes';
 import type {ReaderFragment} from './ReaderNode';
 
+const {getPromiseForActiveRequest} = require('../query/fetchQueryInternal');
+
 function getPendingOperationsForFragment(
   environment: IEnvironment,
   fragmentNode: ReaderFragment,

package/util/getRefetchMetadata.js.flow

@@ -13,14 +13,14 @@
 
 'use strict';
 
-const invariant = require('invariant');
-
 import type {
   ConcreteRequest,
   ReaderFragment,
   ReaderRefetchMetadata,
 } from 'relay-runtime';
 
+const invariant = require('invariant');
+
 function getRefetchMetadata(
   fragmentNode: ReaderFragment,
   componentDisplayName: string,
@@ -51,11 +51,10 @@ function getRefetchMetadata(
   );
 
   // handle both commonjs and es modules
-  const refetchableRequest:
-    | ConcreteRequest
-    | string = (refetchMetadata: $FlowFixMe).operation.default
-    ? (refetchMetadata: $FlowFixMe).operation.default
-    : refetchMetadata.operation;
+  const refetchableRequest: ConcreteRequest | string =
+    (refetchMetadata: $FlowFixMe).operation.default
+      ? (refetchMetadata: $FlowFixMe).operation.default
+      : refetchMetadata.operation;
   const fragmentRefPathInResponse = refetchMetadata.fragmentPathInResult;
   invariant(
     typeof refetchableRequest !== 'string',

package/util/getRelayHandleKey.js.flow

@@ -12,9 +12,8 @@
 
 'use strict';
 
-const invariant = require('invariant');
-
 const {DEFAULT_HANDLE_KEY} = require('./RelayDefaultHandleKey');
+const invariant = require('invariant');
 
 /**
  * @internal

package/util/getRequestIdentifier.js.flow

@@ -12,12 +12,12 @@
 
 'use strict';
 
-const invariant = require('invariant');
-const stableCopy = require('./stableCopy');
-
 import type {RequestParameters} from './RelayConcreteNode';
 import type {Variables} from './RelayRuntimeTypes';
 
+const stableCopy = require('./stableCopy');
+const invariant = require('invariant');
+
 export type RequestIdentifier = string;
 
 /**

package/util/resolveImmediate.js.flow

@@ -21,7 +21,7 @@ function resolveImmediate(callback: () => void) {
   resolvedPromise.then(callback).catch(throwNext);
 }
 
-function throwNext(error) {
+function throwNext(error: $FlowFixMe) {
   setTimeout(() => {
     throw error;
   }, 0);