relay-runtime 11.0.2 → 13.0.0-rc.2

package/multi-actor-environment/MultiActorEnvironment.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,93 +11,136 @@
 
 'use strict';
 
-const ActorSpecificEnvironment = require('./ActorSpecificEnvironment');
-const OperationExecutor = require('../store/OperationExecutor');
-const RelayDefaultHandlerProvider = require('../handlers/RelayDefaultHandlerProvider');
-const RelayModernStore = require('../store/RelayModernStore');
-const RelayObservable = require('../network/RelayObservable');
-const RelayPublishQueue = require('../store/RelayPublishQueue');
-const RelayRecordSource = require('../store/RelayRecordSource');
-
-const defaultGetDataID = require('../store/defaultGetDataID');
-
 import type {HandlerProvider} from '../handlers/RelayDefaultHandlerProvider';
 import type {GraphQLResponse, PayloadData} from '../network/RelayNetworkTypes';
 import type {INetwork} from '../network/RelayNetworkTypes';
-import type {ActiveState} from '../store/OperationExecutor';
+import type {ActiveState, TaskScheduler} from '../store/OperationExecutor';
 import type {GetDataID} from '../store/RelayResponseNormalizer';
 import type {
-  IEnvironment,
+  ExecuteMutationConfig,
+  LogFunction,
+  MissingFieldHandler,
+  MutableRecordSource,
+  MutationParameters,
+  OperationAvailability,
+  OperationDescriptor,
+  OperationLoader,
   OptimisticResponseConfig,
   OptimisticUpdateFunction,
-  OperationDescriptor,
-  OperationAvailability,
-  Snapshot,
+  ReactFlightPayloadDeserializer,
+  ReactFlightServerErrorHandler,
+  RequiredFieldLogger,
   SelectorStoreUpdater,
   SingularReaderSelector,
+  Snapshot,
+  Store,
   StoreUpdater,
-  RequiredFieldLogger,
-  ExecuteMutationConfig,
-  LogFunction,
 } from '../store/RelayStoreTypes';
 import type {Disposable} from '../util/RelayRuntimeTypes';
+import type {RenderPolicy} from '../util/RelayRuntimeTypes';
 import type {ActorIdentifier} from './ActorIdentifier';
 import type {
   IActorEnvironment,
   IMultiActorEnvironment,
+  MultiActorStoreUpdater,
 } from './MultiActorEnvironmentTypes';
 
-function todo(what: string) {
-  throw new Error(`Not implementd: ${what}`);
-}
+const RelayDefaultHandlerProvider = require('../handlers/RelayDefaultHandlerProvider');
+const RelayObservable = require('../network/RelayObservable');
+const defaultGetDataID = require('../store/defaultGetDataID');
+const defaultRequiredFieldLogger = require('../store/defaultRequiredFieldLogger');
+const OperationExecutor = require('../store/OperationExecutor');
+const RelayModernStore = require('../store/RelayModernStore');
+const RelayRecordSource = require('../store/RelayRecordSource');
+const ActorSpecificEnvironment = require('./ActorSpecificEnvironment');
 
 export type MultiActorEnvironmentConfig = $ReadOnly<{
+  createConfigNameForActor?: ?(actorIdentifier: ActorIdentifier) => string,
   createNetworkForActor: (actorIdentifier: ActorIdentifier) => INetwork,
+  createStoreForActor?: ?(actorIdentifier: ActorIdentifier) => Store,
+  defaultRenderPolicy?: ?RenderPolicy,
   getDataID?: GetDataID,
   handlerProvider?: HandlerProvider,
-  logFn: LogFunction,
-  requiredFieldLogger: RequiredFieldLogger,
+  isServer?: ?boolean,
+  logFn?: ?LogFunction,
+  missingFieldHandlers?: ?$ReadOnlyArray<MissingFieldHandler>,
+  operationLoader?: ?OperationLoader,
+  reactFlightPayloadDeserializer?: ?ReactFlightPayloadDeserializer,
+  reactFlightServerErrorHandler?: ?ReactFlightServerErrorHandler,
+  requiredFieldLogger?: ?RequiredFieldLogger,
+  scheduler?: ?TaskScheduler,
+  shouldProcessClientComponents?: ?boolean,
   treatMissingFieldsAsNull?: boolean,
 }>;
 
 class MultiActorEnvironment implements IMultiActorEnvironment {
   +_actorEnvironments: Map<ActorIdentifier, IActorEnvironment>;
+  +_createConfigNameForActor: ?(actorIdentifier: ActorIdentifier) => string;
   +_createNetworkForActor: (actorIdentifier: ActorIdentifier) => INetwork;
+  +_createStoreForActor: ?(actorIdentifier: ActorIdentifier) => Store;
+  +_defaultRenderPolicy: RenderPolicy;
   +_getDataID: GetDataID;
   +_handlerProvider: HandlerProvider;
+  +_isServer: boolean;
   +_logFn: LogFunction;
+  +_missingFieldHandlers: ?$ReadOnlyArray<MissingFieldHandler>;
   +_operationExecutions: Map<string, ActiveState>;
+  +_operationLoader: ?OperationLoader;
+  +_reactFlightPayloadDeserializer: ?ReactFlightPayloadDeserializer;
+  +_reactFlightServerErrorHandler: ?ReactFlightServerErrorHandler;
   +_requiredFieldLogger: RequiredFieldLogger;
+  +_scheduler: ?TaskScheduler;
+  +_shouldProcessClientComponents: ?boolean;
   +_treatMissingFieldsAsNull: boolean;
 
   constructor(config: MultiActorEnvironmentConfig) {
     this._actorEnvironments = new Map();
+    this._operationLoader = config.operationLoader;
     this._createNetworkForActor = config.createNetworkForActor;
+    this._scheduler = config.scheduler;
     this._getDataID = config.getDataID ?? defaultGetDataID;
     this._handlerProvider = config.handlerProvider
       ? config.handlerProvider
       : RelayDefaultHandlerProvider;
-    this._logFn = config.logFn;
+    this._logFn = config.logFn ?? emptyFunction;
     this._operationExecutions = new Map();
-    this._requiredFieldLogger = config.requiredFieldLogger;
+    this._requiredFieldLogger =
+      config.requiredFieldLogger ?? defaultRequiredFieldLogger;
+    this._shouldProcessClientComponents = config.shouldProcessClientComponents;
     this._treatMissingFieldsAsNull = config.treatMissingFieldsAsNull ?? false;
+    this._isServer = config.isServer ?? false;
+    this._missingFieldHandlers = config.missingFieldHandlers;
+    this._createStoreForActor = config.createStoreForActor;
+    this._reactFlightPayloadDeserializer =
+      config.reactFlightPayloadDeserializer;
+    this._reactFlightServerErrorHandler = config.reactFlightServerErrorHandler;
+    this._createConfigNameForActor = config.createConfigNameForActor;
+    this._defaultRenderPolicy = config.defaultRenderPolicy ?? 'partial';
   }
 
   /**
-   * This method will create an actor specfic environment. It will create a new instance
-   * and store it in the internal maps. If will return a memozied version
+   * This method will create an actor specific environment. It will create a new instance
+   * and store it in the internal maps. If will return a memoized version
    * of the environment if we already created one for actor.
    */
-  forActor(actorIdentifier: ActorIdentifier): IEnvironment & IActorEnvironment {
+  forActor(actorIdentifier: ActorIdentifier): IActorEnvironment {
     const environment = this._actorEnvironments.get(actorIdentifier);
     if (environment == null) {
       const newEnvironment = new ActorSpecificEnvironment({
+        configName: this._createConfigNameForActor
+          ? this._createConfigNameForActor(actorIdentifier)
+          : null,
         actorIdentifier,
         multiActorEnvironment: this,
         logFn: this._logFn,
         requiredFieldLogger: this._requiredFieldLogger,
-        store: new RelayModernStore(RelayRecordSource.create()),
+        store:
+          this._createStoreForActor != null
+            ? this._createStoreForActor(actorIdentifier)
+            : new RelayModernStore(RelayRecordSource.create()),
         network: this._createNetworkForActor(actorIdentifier),
+        handlerProvider: this._handlerProvider,
+        defaultRenderPolicy: this._defaultRenderPolicy,
       });
       this._actorEnvironments.set(actorIdentifier, newEnvironment);
       return newEnvironment;
@@ -107,127 +150,357 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
   }
 
   check(
-    actorIdentifier: ActorIdentifier,
+    actorEnvironment: IActorEnvironment,
     operation: OperationDescriptor,
   ): OperationAvailability {
-    return todo('check');
+    if (
+      this._missingFieldHandlers == null ||
+      this._missingFieldHandlers.length === 0
+    ) {
+      return actorEnvironment.getStore().check(operation, {
+        handlers: [],
+        defaultActorIdentifier: actorEnvironment.actorIdentifier,
+        getSourceForActor: actorIdentifier => {
+          return this.forActor(actorIdentifier).getStore().getSource();
+        },
+        getTargetForActor: () => {
+          return RelayRecordSource.create();
+        },
+      });
+    }
+    return this._checkSelectorAndHandleMissingFields(
+      actorEnvironment,
+      operation,
+      this._missingFieldHandlers,
+    );
+  }
+
+  _checkSelectorAndHandleMissingFields(
+    actorEnvironment: IActorEnvironment,
+    operation: OperationDescriptor,
+    handlers: $ReadOnlyArray<MissingFieldHandler>,
+  ): OperationAvailability {
+    const targets: Map<ActorIdentifier, MutableRecordSource> = new Map([
+      [actorEnvironment.actorIdentifier, RelayRecordSource.create()],
+    ]);
+    const result = actorEnvironment.getStore().check(operation, {
+      handlers,
+      defaultActorIdentifier: actorEnvironment.actorIdentifier,
+      getSourceForActor: actorIdentifier => {
+        return this.forActor(actorIdentifier).getStore().getSource();
+      },
+      getTargetForActor: actorIdentifier => {
+        let target = targets.get(actorIdentifier);
+        if (target == null) {
+          target = RelayRecordSource.create();
+          targets.set(actorIdentifier, target);
+        }
+        return target;
+      },
+    });
+    for (const [actorIdentifier, target] of targets) {
+      if (target.size() > 0) {
+        this._scheduleUpdates(() => {
+          const publishQueue = this.forActor(actorIdentifier).getPublishQueue();
+          publishQueue.commitSource(target);
+          publishQueue.run();
+        });
+      }
+    }
+
+    return result;
   }
 
   subscribe(
-    actorIdentifier: ActorIdentifier,
+    actorEnvironment: IActorEnvironment,
     snapshot: Snapshot,
     callback: (snapshot: Snapshot) => void,
   ): Disposable {
-    return todo('subscribe');
+    // TODO: make actor aware
+    return actorEnvironment.getStore().subscribe(snapshot, callback);
   }
 
   retain(
-    actorIdentifier: ActorIdentifier,
+    actorEnvironment: IActorEnvironment,
     operation: OperationDescriptor,
   ): Disposable {
-    return todo('retain');
+    // TODO: make actor aware
+    return actorEnvironment.getStore().retain(operation);
   }
 
   applyUpdate(
-    actorIdentifier: ActorIdentifier,
+    actorEnvironment: IActorEnvironment,
     optimisticUpdate: OptimisticUpdateFunction,
   ): Disposable {
-    return todo('applyUpdate');
+    const publishQueue = actorEnvironment.getPublishQueue();
+    const dispose = () => {
+      this._scheduleUpdates(() => {
+        publishQueue.revertUpdate(optimisticUpdate);
+        publishQueue.run();
+      });
+    };
+    this._scheduleUpdates(() => {
+      publishQueue.applyUpdate(optimisticUpdate);
+      publishQueue.run();
+    });
+    return {dispose};
+  }
+
+  revertUpdate(
+    actorEnvironment: IActorEnvironment,
+    update: OptimisticUpdateFunction,
+  ): void {
+    const publishQueue = actorEnvironment.getPublishQueue();
+    this._scheduleUpdates(() => {
+      publishQueue.revertUpdate(update);
+      publishQueue.run();
+    });
+  }
+
+  replaceUpdate(
+    actorEnvironment: IActorEnvironment,
+    update: OptimisticUpdateFunction,
+    replacement: OptimisticUpdateFunction,
+  ): void {
+    const publishQueue = actorEnvironment.getPublishQueue();
+    this._scheduleUpdates(() => {
+      publishQueue.revertUpdate(update);
+      publishQueue.applyUpdate(replacement);
+      publishQueue.run();
+    });
   }
 
-  applyMutation(
-    actorIdentifier: ActorIdentifier,
-    optimisticConfig: OptimisticResponseConfig,
+  applyMutation<TMutation: MutationParameters>(
+    actorEnvironment: IActorEnvironment,
+    optimisticConfig: OptimisticResponseConfig<TMutation>,
   ): Disposable {
-    return todo('applyMutation');
+    const subscription = this._execute(actorEnvironment, {
+      createSource: () => RelayObservable.create(_sink => {}),
+      isClientPayload: false,
+      operation: optimisticConfig.operation,
+      optimisticConfig,
+      updater: null,
+    }).subscribe({});
+    return {
+      dispose: () => subscription.unsubscribe(),
+    };
   }
 
-  commitUpdate(actorIdentifier: ActorIdentifier, updater: StoreUpdater): void {
-    return todo('commitUpdate');
+  commitUpdate(
+    actorEnvironment: IActorEnvironment,
+    updater: StoreUpdater,
+  ): void {
+    const publishQueue = actorEnvironment.getPublishQueue();
+    this._scheduleUpdates(() => {
+      publishQueue.commitUpdate(updater);
+      publishQueue.run();
+    });
   }
 
   commitPayload(
-    actorIdentifier: ActorIdentifier,
+    actorEnvironment: IActorEnvironment,
     operationDescriptor: OperationDescriptor,
     payload: PayloadData,
   ): void {
-    return todo('commitPayload');
+    this._execute(actorEnvironment, {
+      createSource: () => RelayObservable.from({data: payload}),
+      isClientPayload: true,
+      operation: operationDescriptor,
+      optimisticConfig: null,
+      updater: null,
+    }).subscribe({});
   }
 
   lookup(
-    actorIdentifier: ActorIdentifier,
+    actorEnvironment: IActorEnvironment,
     selector: SingularReaderSelector,
   ): Snapshot {
-    return todo('lookup');
+    // TODO: make actor aware
+    return actorEnvironment.getStore().lookup(selector);
   }
 
   execute(
-    actorIdentifier: ActorIdentifier,
-    config: {
+    actorEnvironment: IActorEnvironment,
+    {
+      operation,
+    }: {
       operation: OperationDescriptor,
-      updater?: ?SelectorStoreUpdater,
     },
   ): RelayObservable<GraphQLResponse> {
-    const {operation, updater} = config;
-    return RelayObservable.create(sink => {
-      const actorEnvironemnt = this.forActor(actorIdentifier);
-      const source = actorEnvironemnt
-        .getNetwork()
-        .execute(
-          operation.request.node.params,
-          operation.request.variables,
-          operation.request.cacheConfig || {},
-          null,
-        );
-      const executor = OperationExecutor.execute({
-        operation,
-        operationExecutions: this._operationExecutions,
-        operationLoader: null,
-        optimisticConfig: null,
-        publishQueue: new RelayPublishQueue(
-          actorEnvironemnt.getStore(),
-          this._handlerProvider,
-          this._getDataID,
-        ),
-        reactFlightPayloadDeserializer: null,
-        reactFlightServerErrorHandler: null,
-        scheduler: null,
-        sink,
-        source,
-        store: actorEnvironemnt.getStore(),
-        updater,
-        operationTracker: actorEnvironemnt.getOperationTracker(),
-        getDataID: this._getDataID,
-        treatMissingFieldsAsNull: this._treatMissingFieldsAsNull,
-        shouldProcessClientComponents: false,
-      });
-      return () => executor.cancel();
+    return this._execute(actorEnvironment, {
+      createSource: () =>
+        actorEnvironment
+          .getNetwork()
+          .execute(
+            operation.request.node.params,
+            operation.request.variables,
+            operation.request.cacheConfig || {},
+            null,
+          ),
+      isClientPayload: false,
+      operation,
+      optimisticConfig: null,
+      updater: null,
     });
   }
 
-  executeMutation(
-    actorIdentifier: ActorIdentifier,
-    config: ExecuteMutationConfig,
+  executeSubscription<TMutation: MutationParameters>(
+    actorEnvironment: IActorEnvironment,
+    {
+      operation,
+      updater,
+    }: {
+      operation: OperationDescriptor,
+      updater?: ?SelectorStoreUpdater<TMutation['response']>,
+    },
   ): RelayObservable<GraphQLResponse> {
-    return todo('executeMutation');
+    return this._execute(actorEnvironment, {
+      createSource: () =>
+        actorEnvironment
+          .getNetwork()
+          .execute(
+            operation.request.node.params,
+            operation.request.variables,
+            operation.request.cacheConfig || {},
+            null,
+          ),
+      isClientPayload: false,
+      operation,
+      optimisticConfig: null,
+      updater,
+    });
+  }
+
+  executeMutation<TMutation: MutationParameters>(
+    actorEnvironment: IActorEnvironment,
+    {
+      operation,
+      optimisticResponse,
+      optimisticUpdater,
+      updater,
+      uploadables,
+    }: ExecuteMutationConfig<TMutation>,
+  ): RelayObservable<GraphQLResponse> {
+    let optimisticConfig;
+    if (optimisticResponse || optimisticUpdater) {
+      optimisticConfig = {
+        operation: operation,
+        response: optimisticResponse,
+        updater: optimisticUpdater,
+      };
+    }
+    return this._execute(actorEnvironment, {
+      createSource: () =>
+        actorEnvironment.getNetwork().execute(
+          operation.request.node.params,
+          operation.request.variables,
+          {
+            ...operation.request.cacheConfig,
+            force: true,
+          },
+          uploadables,
+        ),
+      isClientPayload: false,
+      operation,
+      optimisticConfig,
+      updater,
+    });
   }
 
   executeWithSource(
-    actorIdentifier: ActorIdentifier,
+    actorEnvironment: IActorEnvironment,
     config: {
       operation: OperationDescriptor,
       source: RelayObservable<GraphQLResponse>,
     },
   ): RelayObservable<GraphQLResponse> {
-    return todo('executeWithSource');
+    return this._execute(actorEnvironment, {
+      createSource: () => config.source,
+      isClientPayload: false,
+      operation: config.operation,
+      optimisticConfig: null,
+      updater: null,
+    });
   }
 
   isRequestActive(
-    actorIdentifier: ActorIdentifier,
+    _actorEnvironment: IActorEnvironment,
     requestIdentifier: string,
   ): boolean {
-    return todo('isRequestActive');
+    const activeState = this._operationExecutions.get(requestIdentifier);
+    return activeState === 'active';
+  }
+
+  isServer(): boolean {
+    return this._isServer;
+  }
+
+  _execute<TMutation: MutationParameters>(
+    actorEnvironment: IActorEnvironment,
+    {
+      createSource,
+      isClientPayload,
+      operation,
+      optimisticConfig,
+      updater,
+    }: {|
+      createSource: () => RelayObservable<GraphQLResponse>,
+      isClientPayload: boolean,
+      operation: OperationDescriptor,
+      optimisticConfig: ?OptimisticResponseConfig<TMutation>,
+      updater: ?SelectorStoreUpdater<TMutation['response']>,
+    |},
+  ): RelayObservable<GraphQLResponse> {
+    return RelayObservable.create(sink => {
+      const executor = OperationExecutor.execute({
+        actorIdentifier: actorEnvironment.actorIdentifier,
+        getDataID: this._getDataID,
+        isClientPayload,
+        operation,
+        operationExecutions: this._operationExecutions,
+        operationLoader: this._operationLoader,
+        operationTracker: actorEnvironment.getOperationTracker(),
+        optimisticConfig,
+        getPublishQueue: (actorIdentifier: ActorIdentifier) => {
+          return this.forActor(actorIdentifier).getPublishQueue();
+        },
+        reactFlightPayloadDeserializer: this._reactFlightPayloadDeserializer,
+        reactFlightServerErrorHandler: this._reactFlightServerErrorHandler,
+        scheduler: this._scheduler,
+        shouldProcessClientComponents: this._shouldProcessClientComponents,
+        sink,
+        // NOTE: Some product tests expect `Network.execute` to be called only
+        //       when the Observable is executed.
+        source: createSource(),
+        getStore: (actorIdentifier: ActorIdentifier) => {
+          return this.forActor(actorIdentifier).getStore();
+        },
+        treatMissingFieldsAsNull: this._treatMissingFieldsAsNull,
+        updater,
+        log: this._logFn,
+      });
+      return () => executor.cancel();
+    });
+  }
+
+  _scheduleUpdates(task: () => void) {
+    const scheduler = this._scheduler;
+    if (scheduler != null) {
+      scheduler.schedule(task);
+    } else {
+      task();
+    }
+  }
+
+  commitMultiActorUpdate(updater: MultiActorStoreUpdater): void {
+    for (const [actorIdentifier, environment] of this._actorEnvironments) {
+      environment.commitUpdate(storeProxy => {
+        updater(actorIdentifier, environment, storeProxy);
+      });
+    }
   }
 }
 
+function emptyFunction() {}
+
 module.exports = MultiActorEnvironment;