relay-runtime 12.0.0 → 13.0.0

package/store/ClientID.js.flow

@@ -1,10 +1,10 @@
 /**
- * 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.
  *
- * @flow strict
+ * @flow strict-local
  * @format
  */
 
@@ -14,6 +14,9 @@
 
 import type {DataID} from '../util/RelayRuntimeTypes';
 
+const RelayFeatureFlags = require('../util/RelayFeatureFlags');
+const {intern} = require('../util/StringInterner');
+
 const PREFIX = 'client:';
 
 function generateClientID(
@@ -21,7 +24,11 @@ function generateClientID(
   storageKey: string,
   index?: number,
 ): DataID {
-  let key = id + ':' + storageKey;
+  const internedId =
+    RelayFeatureFlags.STRING_INTERN_LEVEL <= 0
+      ? id
+      : intern(id, RelayFeatureFlags.MAX_DATA_ID_LENGTH);
+  let key = internedId + ':' + storageKey;
   if (index != null) {
     key += ':' + index;
   }

package/store/DataChecker.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,24 +13,6 @@
 
 'use strict';
 
-const RelayConcreteNode = require('../util/RelayConcreteNode');
-const RelayFeatureFlags = require('../util/RelayFeatureFlags');
-const RelayModernRecord = require('./RelayModernRecord');
-const RelayRecordSourceMutator = require('../mutations/RelayRecordSourceMutator');
-const RelayRecordSourceProxy = require('../mutations/RelayRecordSourceProxy');
-const RelayStoreReactFlightUtils = require('./RelayStoreReactFlightUtils');
-const RelayStoreUtils = require('./RelayStoreUtils');
-
-const cloneRelayHandleSourceField = require('./cloneRelayHandleSourceField');
-const cloneRelayScalarHandleSourceField = require('./cloneRelayScalarHandleSourceField');
-const getOperation = require('../util/getOperation');
-const invariant = require('invariant');
-
-const {isClientID} = require('./ClientID');
-const {getLocalVariables} = require('./RelayConcreteVariables');
-const {EXISTENT, UNKNOWN} = require('./RelayRecordState');
-const {generateTypeID} = require('./TypeID');
-
 import type {ActorIdentifier} from '../multi-actor-environment/ActorIdentifier';
 import type {
   NormalizationField,
@@ -53,6 +35,22 @@ import type {
   RecordSource,
 } from './RelayStoreTypes';
 
+const RelayRecordSourceMutator = require('../mutations/RelayRecordSourceMutator');
+const RelayRecordSourceProxy = require('../mutations/RelayRecordSourceProxy');
+const getOperation = require('../util/getOperation');
+const RelayConcreteNode = require('../util/RelayConcreteNode');
+const RelayFeatureFlags = require('../util/RelayFeatureFlags');
+const {isClientID} = require('./ClientID');
+const cloneRelayHandleSourceField = require('./cloneRelayHandleSourceField');
+const cloneRelayScalarHandleSourceField = require('./cloneRelayScalarHandleSourceField');
+const {getLocalVariables} = require('./RelayConcreteVariables');
+const RelayModernRecord = require('./RelayModernRecord');
+const {EXISTENT, UNKNOWN} = require('./RelayRecordState');
+const RelayStoreReactFlightUtils = require('./RelayStoreReactFlightUtils');
+const RelayStoreUtils = require('./RelayStoreUtils');
+const {generateTypeID} = require('./TypeID');
+const invariant = require('invariant');
+
 export type Availability = {|
   +status: 'available' | 'missing',
   +mostRecentlyInvalidatedAt: ?number,
@@ -75,12 +73,8 @@ const {
   STREAM,
   TYPE_DISCRIMINATOR,
 } = RelayConcreteNode;
-const {
-  ROOT_ID,
-  getModuleOperationKey,
-  getStorageKey,
-  getArgumentValues,
-} = RelayStoreUtils;
+const {ROOT_ID, getModuleOperationKey, getStorageKey, getArgumentValues} =
+  RelayStoreUtils;
 
 /**
  * Synchronously check whether the records required to fulfill the given
@@ -211,7 +205,6 @@ class DataChecker {
       'RelayAsyncLoader(): Undefined variable `%s`.',
       name,
     );
-    // $FlowFixMe[cannot-write]
     return this._variables[name];
   }
 
@@ -595,10 +588,8 @@ class DataChecker {
       const prevMutator = this._mutator;
       const prevRecordSourceProxy = this._recordSourceProxy;
 
-      const [
-        mutator,
-        recordSourceProxy,
-      ] = this._getMutatorAndRecordProxyForActor(actorIdentifier);
+      const [mutator, recordSourceProxy] =
+        this._getMutatorAndRecordProxyForActor(actorIdentifier);
 
       this._source = this._getSourceForActor(actorIdentifier);
       this._mutator = mutator;

package/store/OperationExecutor.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,44 +13,22 @@
 
 'use strict';
 
-const RelayError = require('../util/RelayError');
-const RelayFeatureFlags = require('../util/RelayFeatureFlags');
-const RelayModernRecord = require('./RelayModernRecord');
-const RelayObservable = require('../network/RelayObservable');
-const RelayRecordSource = require('./RelayRecordSource');
-const RelayResponseNormalizer = require('./RelayResponseNormalizer');
-
-const generateID = require('../util/generateID');
-const getOperation = require('../util/getOperation');
-const invariant = require('invariant');
-const stableCopy = require('../util/stableCopy');
-const warning = require('warning');
-const withDuration = require('../util/withDuration');
-
-const {generateClientID, generateUniqueClientID} = require('./ClientID');
-const {getLocalVariables} = require('./RelayConcreteVariables');
-const {
-  createNormalizationSelector,
-  createReaderSelector,
-} = require('./RelayModernSelector');
-const {ROOT_TYPE, TYPENAME_KEY, getStorageKey} = require('./RelayStoreUtils');
-
 import type {ActorIdentifier} from '../multi-actor-environment/ActorIdentifier';
 import type {
   GraphQLResponse,
-  GraphQLSingularResponse,
   GraphQLResponseWithData,
+  GraphQLSingularResponse,
   ReactFlightServerTree,
 } from '../network/RelayNetworkTypes';
 import type {Sink, Subscription} from '../network/RelayObservable';
 import type {
   DeferPlaceholder,
   FollowupPayload,
-  RequestDescriptor,
   HandleFieldPayload,
   IncrementalDataPlaceholder,
   LogFunction,
   ModuleImportPayload,
+  MutationParameters,
   NormalizationSelector,
   OperationDescriptor,
   OperationLoader,
@@ -58,11 +36,12 @@ import type {
   OptimisticResponseConfig,
   OptimisticUpdate,
   PublishQueue,
+  ReactFlightClientResponse,
   ReactFlightPayloadDeserializer,
   ReactFlightServerErrorHandler,
-  ReactFlightClientResponse,
   Record,
   RelayResponsePayload,
+  RequestDescriptor,
   SelectorStoreUpdater,
   Store,
   StreamPlaceholder,
@@ -74,11 +53,31 @@ import type {
   NormalizationSelectableNode,
   NormalizationSplitOperation,
 } from '../util/NormalizationNode';
-import type {DataID, Variables, Disposable} from '../util/RelayRuntimeTypes';
+import type {DataID, Disposable, Variables} from '../util/RelayRuntimeTypes';
 import type {GetDataID} from './RelayResponseNormalizer';
 import type {NormalizationOptions} from './RelayResponseNormalizer';
 
-export type ExecuteConfig = {|
+const RelayObservable = require('../network/RelayObservable');
+const generateID = require('../util/generateID');
+const getOperation = require('../util/getOperation');
+const RelayError = require('../util/RelayError');
+const RelayFeatureFlags = require('../util/RelayFeatureFlags');
+const stableCopy = require('../util/stableCopy');
+const withDuration = require('../util/withDuration');
+const {generateClientID, generateUniqueClientID} = require('./ClientID');
+const {getLocalVariables} = require('./RelayConcreteVariables');
+const RelayModernRecord = require('./RelayModernRecord');
+const {
+  createNormalizationSelector,
+  createReaderSelector,
+} = require('./RelayModernSelector');
+const RelayRecordSource = require('./RelayRecordSource');
+const RelayResponseNormalizer = require('./RelayResponseNormalizer');
+const {ROOT_TYPE, TYPENAME_KEY, getStorageKey} = require('./RelayStoreUtils');
+const invariant = require('invariant');
+const warning = require('warning');
+
+export type ExecuteConfig<TMutation: MutationParameters> = {|
   +actorIdentifier: ActorIdentifier,
   +getDataID: GetDataID,
   +getPublishQueue: (actorIdentifier: ActorIdentifier) => PublishQueue,
@@ -88,7 +87,7 @@ export type ExecuteConfig = {|
   +operationExecutions: Map<string, ActiveState>,
   +operationLoader: ?OperationLoader,
   +operationTracker: OperationTracker,
-  +optimisticConfig: ?OptimisticResponseConfig,
+  +optimisticConfig: ?OptimisticResponseConfig<TMutation>,
   +reactFlightPayloadDeserializer?: ?ReactFlightPayloadDeserializer,
   +reactFlightServerErrorHandler?: ?ReactFlightServerErrorHandler,
   +scheduler?: ?TaskScheduler,
@@ -96,7 +95,7 @@ export type ExecuteConfig = {|
   +sink: Sink<GraphQLResponse>,
   +source: RelayObservable<GraphQLResponse>,
   +treatMissingFieldsAsNull: boolean,
-  +updater?: ?SelectorStoreUpdater,
+  +updater?: ?SelectorStoreUpdater<TMutation['response']>,
   +log: LogFunction,
 |};
 
@@ -125,7 +124,9 @@ type IncrementalGraphQLResponse = {|
   response: GraphQLResponseWithData,
 |};
 
-function execute(config: ExecuteConfig): Executor {
+function execute<TMutation: MutationParameters>(
+  config: ExecuteConfig<TMutation>,
+): Executor<TMutation> {
   return new Executor(config);
 }
 
@@ -134,7 +135,7 @@ function execute(config: ExecuteConfig): Executor {
  * including optimistic payloads, standard payloads, resolution of match
  * dependencies, etc.
  */
-class Executor {
+class Executor<TMutation: MutationParameters> {
   _actorIdentifier: ActorIdentifier;
   _getDataID: GetDataID;
   _treatMissingFieldsAsNull: boolean;
@@ -148,7 +149,7 @@ class Executor {
   _operationLoader: ?OperationLoader;
   _operationTracker: OperationTracker;
   _operationUpdateEpochs: Map<string, number>;
-  _optimisticUpdates: null | Array<OptimisticUpdate>;
+  _optimisticUpdates: null | Array<OptimisticUpdate<TMutation>>;
   _pendingModulePayloadsCount: number;
   +_getPublishQueue: (actorIdentifier: ActorIdentifier) => PublishQueue;
   _reactFlightPayloadDeserializer: ?ReactFlightPayloadDeserializer;
@@ -163,7 +164,7 @@ class Executor {
   _state: 'started' | 'loading_incremental' | 'loading_final' | 'completed';
   +_getStore: (actorIdentifier: ActorIdentifier) => Store;
   _subscriptions: Map<number, Subscription>;
-  _updater: ?SelectorStoreUpdater;
+  _updater: ?SelectorStoreUpdater<TMutation['response']>;
   _asyncStoreUpdateDisposable: ?Disposable;
   _completeFns: Array<() => void>;
   +_retainDisposables: Map<ActorIdentifier, Disposable>;
@@ -191,7 +192,7 @@ class Executor {
     treatMissingFieldsAsNull,
     updater,
     log,
-  }: ExecuteConfig): void {
+  }: ExecuteConfig<TMutation>): void {
     this._actorIdentifier = actorIdentifier;
     this._getDataID = getDataID;
     this._treatMissingFieldsAsNull = treatMissingFieldsAsNull;
@@ -447,7 +448,8 @@ class Executor {
         error.stack;
         throw error;
       } else {
-        const responseWithData: GraphQLResponseWithData = (response: $FlowFixMe);
+        const responseWithData: GraphQLResponseWithData =
+          (response: $FlowFixMe);
         results.push(responseWithData);
       }
     });
@@ -522,10 +524,8 @@ class Executor {
       return;
     }
 
-    const [
-      nonIncrementalResponses,
-      incrementalResponses,
-    ] = partitionGraphQLResponses(responsesWithData);
+    const [nonIncrementalResponses, incrementalResponses] =
+      partitionGraphQLResponses(responsesWithData);
     const hasNonIncrementalResponses = nonIncrementalResponses.length > 0;
 
     // In theory this doesn't preserve the ordering of the batch.
@@ -562,9 +562,8 @@ class Executor {
     }
 
     if (incrementalResponses.length > 0) {
-      const payloadFollowups = this._processIncrementalResponses(
-        incrementalResponses,
-      );
+      const payloadFollowups =
+        this._processIncrementalResponses(incrementalResponses);
 
       this._processPayloadFollowups(payloadFollowups);
     }
@@ -577,7 +576,8 @@ class Executor {
           __relay_subscription_root_id: this._operation.fragment.dataID,
         };
       } else {
-        responsesWithData[0].extensions.__relay_subscription_root_id = this._operation.fragment.dataID;
+        responsesWithData[0].extensions.__relay_subscription_root_id =
+          this._operation.fragment.dataID;
       }
     }
 
@@ -600,7 +600,7 @@ class Executor {
 
   _processOptimisticResponse(
     response: ?GraphQLResponseWithData,
-    updater: ?SelectorStoreUpdater,
+    updater: ?SelectorStoreUpdater<TMutation['response']>,
     treatMissingFieldsAsNull: boolean,
   ): void {
     invariant(
@@ -611,7 +611,7 @@ class Executor {
     if (response == null && updater == null) {
       return;
     }
-    const optimisticUpdates: Array<OptimisticUpdate> = [];
+    const optimisticUpdates: Array<OptimisticUpdate<TMutation>> = [];
     if (response) {
       const payload = normalizeResponse(
         response,
@@ -662,7 +662,7 @@ class Executor {
 
   _processOptimisticFollowups(
     payload: RelayResponsePayload,
-    optimisticUpdates: Array<OptimisticUpdate>,
+    optimisticUpdates: Array<OptimisticUpdate<TMutation>>,
   ): void {
     if (payload.followupPayloads && payload.followupPayloads.length) {
       const followupPayloads = payload.followupPayloads;
@@ -676,10 +676,8 @@ class Executor {
             if (operation == null) {
               this._processAsyncOptimisticModuleImport(followupPayload);
             } else {
-              const moduleImportOptimisticUpdates = this._processOptimisticModuleImport(
-                operation,
-                followupPayload,
-              );
+              const moduleImportOptimisticUpdates =
+                this._processOptimisticModuleImport(operation, followupPayload);
               optimisticUpdates.push(...moduleImportOptimisticUpdates);
             }
             break;
@@ -748,7 +746,7 @@ class Executor {
   _processOptimisticModuleImport(
     normalizationRootNode: NormalizationRootNode,
     moduleImportPayload: ModuleImportPayload,
-  ): $ReadOnlyArray<OptimisticUpdate> {
+  ): $ReadOnlyArray<OptimisticUpdate<TMutation>> {
     const operation = getOperation(normalizationRootNode);
     const optimisticUpdates = [];
     const modulePayload = this._normalizeFollowupPayload(
@@ -774,10 +772,8 @@ class Executor {
         if (operation == null || this._state !== 'started') {
           return;
         }
-        const moduleImportOptimisticUpdates = this._processOptimisticModuleImport(
-          operation,
-          moduleImportPayload,
-        );
+        const moduleImportOptimisticUpdates =
+          this._processOptimisticModuleImport(operation, moduleImportPayload);
         moduleImportOptimisticUpdates.forEach(update =>
           this._getPublishQueueAndSaveActor().applyUpdate(update),
         );
@@ -1179,9 +1175,8 @@ class Executor {
     // If there were any queued responses, process them now that placeholders
     // are in place
     if (pendingResponses != null) {
-      const payloadFollowups = this._processIncrementalResponses(
-        pendingResponses,
-      );
+      const payloadFollowups =
+        this._processIncrementalResponses(pendingResponses);
       this._processPayloadFollowups(payloadFollowups);
     }
   }
@@ -1231,10 +1226,7 @@ class Executor {
         // but Relay records paths relative to the parent of the stream node:
         // therefore we strip the last two elements just to lookup the path
         // (the item index is used later to insert the element in the list)
-        const pathKey = path
-          .slice(0, -2)
-          .map(String)
-          .join('.');
+        const pathKey = path.slice(0, -2).map(String).join('.');
         let resultForPath = resultForLabel.get(pathKey);
         if (resultForPath == null) {
           resultForPath = {kind: 'response', responses: [incrementalResponse]};

package/store/RelayConcreteVariables.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,18 +12,17 @@
 
 'use strict';
 
-const invariant = require('invariant');
-
-const {getArgumentValues} = require('./RelayStoreUtils');
-
 import type {
-  NormalizationLocalArgumentDefinition,
   NormalizationArgument,
+  NormalizationLocalArgumentDefinition,
   NormalizationOperation,
 } from '../util/NormalizationNode';
 import type {ReaderFragment} from '../util/ReaderNode';
 import type {Variables} from '../util/RelayRuntimeTypes';
 
+const {getArgumentValues} = require('./RelayStoreUtils');
+const invariant = require('invariant');
+
 /**
  * Determines the variables that are in scope for a fragment given the variables
  * in scope at the root query as well as any arguments applied at the fragment
@@ -41,7 +40,6 @@ function getFragmentVariables(
     if (argumentVariables.hasOwnProperty(definition.name)) {
       return;
     }
-    // $FlowFixMe[cannot-spread-interface]
     variables = variables || {...argumentVariables};
     switch (definition.kind) {
       case 'LocalArgument':
@@ -58,12 +56,9 @@ function getFragmentVariables(
            * RelayStoreUtils.getStableVariableValue() that variable keys are all
            * present.
            */
-          // $FlowFixMe[incompatible-use]
           variables[definition.name] = undefined;
           break;
         }
-        // $FlowFixMe[incompatible-use]
-        // $FlowFixMe[cannot-write]
         variables[definition.name] = rootVariables[definition.name];
         break;
       default:
@@ -92,7 +87,6 @@ function getOperationVariables(
   const operationVariables = {};
   operation.argumentDefinitions.forEach(def => {
     let value = def.defaultValue;
-    // $FlowFixMe[cannot-write]
     if (variables[def.name] != null) {
       value = variables[def.name];
     }

package/store/RelayExperimentalGraphResponseHandler.js.flow

@@ -0,0 +1,121 @@
+/**
+ * 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.
+ *
+ * @emails oncall+relay
+ * @flow
+ * @format
+ */
+
+import type {
+  DataChunk,
+  GraphModeResponse,
+  RecordChunk,
+} from './RelayExperimentalGraphResponseTransform';
+import type {MutableRecordSource, Record} from './RelayStoreTypes';
+
+const RelayModernRecord = require('./RelayModernRecord');
+const invariant = require('invariant');
+
+/**
+ * Given a stream of GraphMode chunks, populate a MutableRecordSource.
+ */
+export function handleGraphModeResponse(
+  recordSource: MutableRecordSource,
+  response: GraphModeResponse,
+): MutableRecordSource {
+  const handler = new GraphModeHandler(recordSource);
+  return handler.populateRecordSource(response);
+}
+
+class GraphModeHandler {
+  _recordSource: MutableRecordSource;
+  _streamIdToCacheKey: Map<number, string>;
+  constructor(recordSource: MutableRecordSource) {
+    this._recordSource = recordSource;
+    this._streamIdToCacheKey = new Map();
+  }
+  populateRecordSource(response: GraphModeResponse): MutableRecordSource {
+    for (const chunk of response) {
+      switch (chunk.$kind) {
+        case 'Record':
+          this._handleRecordChunk(chunk);
+          break;
+        case 'Extend': {
+          const cacheKey = this._lookupCacheKey(chunk.$streamID);
+          const record = this._recordSource.get(cacheKey);
+          invariant(
+            record != null,
+            `Expected to have a record for cache key ${cacheKey}`,
+          );
+          this._populateRecord(record, chunk);
+          break;
+        }
+        case 'Complete':
+          this._streamIdToCacheKey.clear();
+          break;
+        default:
+          (chunk.$kind: empty);
+      }
+    }
+    return this._recordSource;
+  }
+
+  _handleRecordChunk(chunk: RecordChunk) {
+    const cacheKey = chunk.__id;
+    let record = this._recordSource.get(cacheKey);
+    if (record == null) {
+      record = RelayModernRecord.create(cacheKey, chunk.__typename);
+      this._recordSource.set(cacheKey, record);
+    }
+
+    this._streamIdToCacheKey.set(chunk.$streamID, cacheKey);
+    this._populateRecord(record, chunk);
+  }
+
+  _populateRecord(parentRecord: Record, chunk: DataChunk) {
+    for (const [key, value] of Object.entries(chunk)) {
+      switch (key) {
+        case '$streamID':
+        case '$kind':
+        case '__typename':
+          break;
+        default:
+          if (
+            typeof value !== 'object' ||
+            value == null ||
+            Array.isArray(value)
+          ) {
+            RelayModernRecord.setValue(parentRecord, key, value);
+          } else {
+            if (value.hasOwnProperty('__id')) {
+              // Singular
+              const streamID = ((value.__id: any): number);
+              const id = this._lookupCacheKey(streamID);
+              RelayModernRecord.setLinkedRecordID(parentRecord, key, id);
+            } else if (value.hasOwnProperty('__ids')) {
+              // Plural
+              const streamIDs = ((value.__ids: any): Array<number | null>);
+              const ids = streamIDs.map(sID => {
+                return sID == null ? null : this._lookupCacheKey(sID);
+              });
+              RelayModernRecord.setLinkedRecordIDs(parentRecord, key, ids);
+            } else {
+              invariant(false, 'Expected object to have either __id or __ids.');
+            }
+          }
+      }
+    }
+  }
+
+  _lookupCacheKey(streamID: number): string {
+    const cacheKey = this._streamIdToCacheKey.get(streamID);
+    invariant(
+      cacheKey != null,
+      `Expected to have a cacheKey for $streamID ${streamID}`,
+    );
+    return cacheKey;
+  }
+}