relay-runtime 11.0.2 → 13.0.0-rc.2

package/lib/multi-actor-environment/MultiActorEnvironment.js

@@ -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.
@@ -10,42 +10,54 @@
  */
 'use strict';
 
-var ActorSpecificEnvironment = require('./ActorSpecificEnvironment');
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var OperationExecutor = require('../store/OperationExecutor');
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
-var RelayDefaultHandlerProvider = require('../handlers/RelayDefaultHandlerProvider');
+var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
 
-var RelayModernStore = require('../store/RelayModernStore');
+var RelayDefaultHandlerProvider = require('../handlers/RelayDefaultHandlerProvider');
 
 var RelayObservable = require('../network/RelayObservable');
 
-var RelayPublishQueue = require('../store/RelayPublishQueue');
+var defaultGetDataID = require('../store/defaultGetDataID');
 
-var RelayRecordSource = require('../store/RelayRecordSource');
+var defaultRequiredFieldLogger = require('../store/defaultRequiredFieldLogger');
 
-var defaultGetDataID = require('../store/defaultGetDataID');
+var OperationExecutor = require('../store/OperationExecutor');
+
+var RelayModernStore = require('../store/RelayModernStore');
 
-function todo(what) {
-  throw new Error("Not implementd: ".concat(what));
-}
+var RelayRecordSource = require('../store/RelayRecordSource');
+
+var ActorSpecificEnvironment = require('./ActorSpecificEnvironment');
 
 var MultiActorEnvironment = /*#__PURE__*/function () {
   function MultiActorEnvironment(config) {
-    var _config$getDataID, _config$treatMissingF;
+    var _config$getDataID, _config$logFn, _config$requiredField, _config$treatMissingF, _config$isServer, _config$defaultRender;
 
     this._actorEnvironments = new Map();
+    this._operationLoader = config.operationLoader;
     this._createNetworkForActor = config.createNetworkForActor;
+    this._scheduler = config.scheduler;
     this._getDataID = (_config$getDataID = config.getDataID) !== null && _config$getDataID !== void 0 ? _config$getDataID : defaultGetDataID;
     this._handlerProvider = config.handlerProvider ? config.handlerProvider : RelayDefaultHandlerProvider;
-    this._logFn = config.logFn;
+    this._logFn = (_config$logFn = config.logFn) !== null && _config$logFn !== void 0 ? _config$logFn : emptyFunction;
     this._operationExecutions = new Map();
-    this._requiredFieldLogger = config.requiredFieldLogger;
+    this._requiredFieldLogger = (_config$requiredField = config.requiredFieldLogger) !== null && _config$requiredField !== void 0 ? _config$requiredField : defaultRequiredFieldLogger;
+    this._shouldProcessClientComponents = config.shouldProcessClientComponents;
     this._treatMissingFieldsAsNull = (_config$treatMissingF = config.treatMissingFieldsAsNull) !== null && _config$treatMissingF !== void 0 ? _config$treatMissingF : false;
+    this._isServer = (_config$isServer = config.isServer) !== null && _config$isServer !== void 0 ? _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$defaultRender = config.defaultRenderPolicy) !== null && _config$defaultRender !== void 0 ? _config$defaultRender : '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.
    */
 
@@ -57,12 +69,15 @@ var MultiActorEnvironment = /*#__PURE__*/function () {
 
     if (environment == null) {
       var newEnvironment = new ActorSpecificEnvironment({
+        configName: this._createConfigNameForActor ? this._createConfigNameForActor(actorIdentifier) : null,
         actorIdentifier: actorIdentifier,
         multiActorEnvironment: this,
         logFn: this._logFn,
         requiredFieldLogger: this._requiredFieldLogger,
-        store: new RelayModernStore(RelayRecordSource.create()),
-        network: this._createNetworkForActor(actorIdentifier)
+        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);
@@ -73,64 +88,288 @@ var MultiActorEnvironment = /*#__PURE__*/function () {
     }
   };
 
-  _proto.check = function check(actorIdentifier, operation) {
-    return todo('check');
+  _proto.check = function check(actorEnvironment, operation) {
+    var _this = this;
+
+    if (this._missingFieldHandlers == null || this._missingFieldHandlers.length === 0) {
+      return actorEnvironment.getStore().check(operation, {
+        handlers: [],
+        defaultActorIdentifier: actorEnvironment.actorIdentifier,
+        getSourceForActor: function getSourceForActor(actorIdentifier) {
+          return _this.forActor(actorIdentifier).getStore().getSource();
+        },
+        getTargetForActor: function getTargetForActor() {
+          return RelayRecordSource.create();
+        }
+      });
+    }
+
+    return this._checkSelectorAndHandleMissingFields(actorEnvironment, operation, this._missingFieldHandlers);
   };
 
-  _proto.subscribe = function subscribe(actorIdentifier, snapshot, callback) {
-    return todo('subscribe');
+  _proto._checkSelectorAndHandleMissingFields = function _checkSelectorAndHandleMissingFields(actorEnvironment, operation, handlers) {
+    var _this2 = this;
+
+    var targets = new Map([[actorEnvironment.actorIdentifier, RelayRecordSource.create()]]);
+    var result = actorEnvironment.getStore().check(operation, {
+      handlers: handlers,
+      defaultActorIdentifier: actorEnvironment.actorIdentifier,
+      getSourceForActor: function getSourceForActor(actorIdentifier) {
+        return _this2.forActor(actorIdentifier).getStore().getSource();
+      },
+      getTargetForActor: function getTargetForActor(actorIdentifier) {
+        var target = targets.get(actorIdentifier);
+
+        if (target == null) {
+          target = RelayRecordSource.create();
+          targets.set(actorIdentifier, target);
+        }
+
+        return target;
+      }
+    });
+
+    var _iterator = (0, _createForOfIteratorHelper2["default"])(targets),
+        _step;
+
+    try {
+      var _loop = function _loop() {
+        var _step$value = _step.value,
+            actorIdentifier = _step$value[0],
+            target = _step$value[1];
+
+        if (target.size() > 0) {
+          _this2._scheduleUpdates(function () {
+            var publishQueue = _this2.forActor(actorIdentifier).getPublishQueue();
+
+            publishQueue.commitSource(target);
+            publishQueue.run();
+          });
+        }
+      };
+
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        _loop();
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+
+    return result;
   };
 
-  _proto.retain = function retain(actorIdentifier, operation) {
-    return todo('retain');
+  _proto.subscribe = function subscribe(actorEnvironment, snapshot, callback) {
+    // TODO: make actor aware
+    return actorEnvironment.getStore().subscribe(snapshot, callback);
   };
 
-  _proto.applyUpdate = function applyUpdate(actorIdentifier, optimisticUpdate) {
-    return todo('applyUpdate');
+  _proto.retain = function retain(actorEnvironment, operation) {
+    // TODO: make actor aware
+    return actorEnvironment.getStore().retain(operation);
   };
 
-  _proto.applyMutation = function applyMutation(actorIdentifier, optimisticConfig) {
-    return todo('applyMutation');
+  _proto.applyUpdate = function applyUpdate(actorEnvironment, optimisticUpdate) {
+    var _this3 = this;
+
+    var publishQueue = actorEnvironment.getPublishQueue();
+
+    var dispose = function dispose() {
+      _this3._scheduleUpdates(function () {
+        publishQueue.revertUpdate(optimisticUpdate);
+        publishQueue.run();
+      });
+    };
+
+    this._scheduleUpdates(function () {
+      publishQueue.applyUpdate(optimisticUpdate);
+      publishQueue.run();
+    });
+
+    return {
+      dispose: dispose
+    };
   };
 
-  _proto.commitUpdate = function commitUpdate(actorIdentifier, updater) {
-    return todo('commitUpdate');
+  _proto.revertUpdate = function revertUpdate(actorEnvironment, update) {
+    var publishQueue = actorEnvironment.getPublishQueue();
+
+    this._scheduleUpdates(function () {
+      publishQueue.revertUpdate(update);
+      publishQueue.run();
+    });
   };
 
-  _proto.commitPayload = function commitPayload(actorIdentifier, operationDescriptor, payload) {
-    return todo('commitPayload');
+  _proto.replaceUpdate = function replaceUpdate(actorEnvironment, update, replacement) {
+    var publishQueue = actorEnvironment.getPublishQueue();
+
+    this._scheduleUpdates(function () {
+      publishQueue.revertUpdate(update);
+      publishQueue.applyUpdate(replacement);
+      publishQueue.run();
+    });
   };
 
-  _proto.lookup = function lookup(actorIdentifier, selector) {
-    return todo('lookup');
+  _proto.applyMutation = function applyMutation(actorEnvironment, optimisticConfig) {
+    var subscription = this._execute(actorEnvironment, {
+      createSource: function createSource() {
+        return RelayObservable.create(function (_sink) {});
+      },
+      isClientPayload: false,
+      operation: optimisticConfig.operation,
+      optimisticConfig: optimisticConfig,
+      updater: null
+    }).subscribe({});
+
+    return {
+      dispose: function dispose() {
+        return subscription.unsubscribe();
+      }
+    };
   };
 
-  _proto.execute = function execute(actorIdentifier, config) {
-    var _this = this;
+  _proto.commitUpdate = function commitUpdate(actorEnvironment, updater) {
+    var publishQueue = actorEnvironment.getPublishQueue();
 
-    var operation = config.operation,
-        updater = config.updater;
-    return RelayObservable.create(function (sink) {
-      var actorEnvironemnt = _this.forActor(actorIdentifier);
+    this._scheduleUpdates(function () {
+      publishQueue.commitUpdate(updater);
+      publishQueue.run();
+    });
+  };
+
+  _proto.commitPayload = function commitPayload(actorEnvironment, operationDescriptor, payload) {
+    this._execute(actorEnvironment, {
+      createSource: function createSource() {
+        return RelayObservable.from({
+          data: payload
+        });
+      },
+      isClientPayload: true,
+      operation: operationDescriptor,
+      optimisticConfig: null,
+      updater: null
+    }).subscribe({});
+  };
+
+  _proto.lookup = function lookup(actorEnvironment, selector) {
+    // TODO: make actor aware
+    return actorEnvironment.getStore().lookup(selector);
+  };
+
+  _proto.execute = function execute(actorEnvironment, _ref) {
+    var operation = _ref.operation;
+    return this._execute(actorEnvironment, {
+      createSource: function createSource() {
+        return actorEnvironment.getNetwork().execute(operation.request.node.params, operation.request.variables, operation.request.cacheConfig || {}, null);
+      },
+      isClientPayload: false,
+      operation: operation,
+      optimisticConfig: null,
+      updater: null
+    });
+  };
+
+  _proto.executeSubscription = function executeSubscription(actorEnvironment, _ref2) {
+    var operation = _ref2.operation,
+        updater = _ref2.updater;
+    return this._execute(actorEnvironment, {
+      createSource: function createSource() {
+        return actorEnvironment.getNetwork().execute(operation.request.node.params, operation.request.variables, operation.request.cacheConfig || {}, null);
+      },
+      isClientPayload: false,
+      operation: operation,
+      optimisticConfig: null,
+      updater: updater
+    });
+  };
+
+  _proto.executeMutation = function executeMutation(actorEnvironment, _ref3) {
+    var operation = _ref3.operation,
+        optimisticResponse = _ref3.optimisticResponse,
+        optimisticUpdater = _ref3.optimisticUpdater,
+        updater = _ref3.updater,
+        uploadables = _ref3.uploadables;
+    var optimisticConfig;
+
+    if (optimisticResponse || optimisticUpdater) {
+      optimisticConfig = {
+        operation: operation,
+        response: optimisticResponse,
+        updater: optimisticUpdater
+      };
+    }
+
+    return this._execute(actorEnvironment, {
+      createSource: function createSource() {
+        return actorEnvironment.getNetwork().execute(operation.request.node.params, operation.request.variables, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, operation.request.cacheConfig), {}, {
+          force: true
+        }), uploadables);
+      },
+      isClientPayload: false,
+      operation: operation,
+      optimisticConfig: optimisticConfig,
+      updater: updater
+    });
+  };
+
+  _proto.executeWithSource = function executeWithSource(actorEnvironment, config) {
+    return this._execute(actorEnvironment, {
+      createSource: function createSource() {
+        return config.source;
+      },
+      isClientPayload: false,
+      operation: config.operation,
+      optimisticConfig: null,
+      updater: null
+    });
+  };
+
+  _proto.isRequestActive = function isRequestActive(_actorEnvironment, requestIdentifier) {
+    var activeState = this._operationExecutions.get(requestIdentifier);
+
+    return activeState === 'active';
+  };
+
+  _proto.isServer = function isServer() {
+    return this._isServer;
+  };
 
-      var source = actorEnvironemnt.getNetwork().execute(operation.request.node.params, operation.request.variables, operation.request.cacheConfig || {}, null);
+  _proto._execute = function _execute(actorEnvironment, _ref4) {
+    var _this4 = this;
+
+    var createSource = _ref4.createSource,
+        isClientPayload = _ref4.isClientPayload,
+        operation = _ref4.operation,
+        optimisticConfig = _ref4.optimisticConfig,
+        updater = _ref4.updater;
+    return RelayObservable.create(function (sink) {
       var executor = OperationExecutor.execute({
+        actorIdentifier: actorEnvironment.actorIdentifier,
+        getDataID: _this4._getDataID,
+        isClientPayload: isClientPayload,
         operation: operation,
-        operationExecutions: _this._operationExecutions,
-        operationLoader: null,
-        optimisticConfig: null,
-        publishQueue: new RelayPublishQueue(actorEnvironemnt.getStore(), _this._handlerProvider, _this._getDataID),
-        reactFlightPayloadDeserializer: null,
-        reactFlightServerErrorHandler: null,
-        scheduler: null,
+        operationExecutions: _this4._operationExecutions,
+        operationLoader: _this4._operationLoader,
+        operationTracker: actorEnvironment.getOperationTracker(),
+        optimisticConfig: optimisticConfig,
+        getPublishQueue: function getPublishQueue(actorIdentifier) {
+          return _this4.forActor(actorIdentifier).getPublishQueue();
+        },
+        reactFlightPayloadDeserializer: _this4._reactFlightPayloadDeserializer,
+        reactFlightServerErrorHandler: _this4._reactFlightServerErrorHandler,
+        scheduler: _this4._scheduler,
+        shouldProcessClientComponents: _this4._shouldProcessClientComponents,
         sink: sink,
-        source: source,
-        store: actorEnvironemnt.getStore(),
+        // NOTE: Some product tests expect `Network.execute` to be called only
+        //       when the Observable is executed.
+        source: createSource(),
+        getStore: function getStore(actorIdentifier) {
+          return _this4.forActor(actorIdentifier).getStore();
+        },
+        treatMissingFieldsAsNull: _this4._treatMissingFieldsAsNull,
         updater: updater,
-        operationTracker: actorEnvironemnt.getOperationTracker(),
-        getDataID: _this._getDataID,
-        treatMissingFieldsAsNull: _this._treatMissingFieldsAsNull,
-        shouldProcessClientComponents: false
+        log: _this4._logFn
       });
       return function () {
         return executor.cancel();
@@ -138,19 +377,43 @@ var MultiActorEnvironment = /*#__PURE__*/function () {
     });
   };
 
-  _proto.executeMutation = function executeMutation(actorIdentifier, config) {
-    return todo('executeMutation');
-  };
+  _proto._scheduleUpdates = function _scheduleUpdates(task) {
+    var scheduler = this._scheduler;
 
-  _proto.executeWithSource = function executeWithSource(actorIdentifier, config) {
-    return todo('executeWithSource');
+    if (scheduler != null) {
+      scheduler.schedule(task);
+    } else {
+      task();
+    }
   };
 
-  _proto.isRequestActive = function isRequestActive(actorIdentifier, requestIdentifier) {
-    return todo('isRequestActive');
+  _proto.commitMultiActorUpdate = function commitMultiActorUpdate(updater) {
+    var _iterator2 = (0, _createForOfIteratorHelper2["default"])(this._actorEnvironments),
+        _step2;
+
+    try {
+      var _loop2 = function _loop2() {
+        var _step2$value = _step2.value,
+            actorIdentifier = _step2$value[0],
+            environment = _step2$value[1];
+        environment.commitUpdate(function (storeProxy) {
+          updater(actorIdentifier, environment, storeProxy);
+        });
+      };
+
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        _loop2();
+      }
+    } catch (err) {
+      _iterator2.e(err);
+    } finally {
+      _iterator2.f();
+    }
   };
 
   return MultiActorEnvironment;
 }();
 
+function emptyFunction() {}
+
 module.exports = MultiActorEnvironment;

package/lib/multi-actor-environment/MultiActorEnvironmentTypes.js

@@ -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.

package/lib/multi-actor-environment/index.js

@@ -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.
@@ -10,8 +10,12 @@
  */
 'use strict';
 
+var _require = require('./ActorIdentifier'),
+    getActorIdentifier = _require.getActorIdentifier;
+
 var MultiActorEnvironment = require('./MultiActorEnvironment');
 
 module.exports = {
-  MultiActorEnvironment: MultiActorEnvironment
+  MultiActorEnvironment: MultiActorEnvironment,
+  getActorIdentifier: getActorIdentifier
 };

package/lib/mutations/RelayDeclarativeMutationConfig.js

@@ -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.
@@ -201,7 +201,10 @@ function rangeDelete(config, request) {
       return;
     }
 
-    var deleteIDs = [];
+    var deleteIDs = []; // the type of data should come from a type parameter associated with ConcreteRequest,
+    // but ConcreteRequest does not contain a type parameter. Hence, we use a FlowFixMe.
+    // $FlowFixMe[incompatible-use] see above
+
     var deletedIDField = data[rootField];
 
     if (deletedIDField && Array.isArray(deletedIDFieldName)) {

package/lib/mutations/RelayRecordProxy.js

@@ -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.
@@ -10,20 +10,21 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var invariant = require('invariant');
-
 var _require = require('../store/ClientID'),
     generateClientID = _require.generateClientID;
 
 var _require2 = require('../store/RelayStoreUtils'),
     getStableStorageKey = _require2.getStableStorageKey;
 
+var invariant = require('invariant');
 /**
  * @internal
  *
  * A helper class for manipulating a given record from a record source via an
  * imperative/OO-style API.
  */
+
+
 var RelayRecordProxy = /*#__PURE__*/function () {
   function RelayRecordProxy(source, mutator, dataID) {
     this._dataID = dataID;

package/lib/mutations/RelayRecordSourceMutator.js

@@ -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,11 +12,10 @@
 
 var RelayModernRecord = require('../store/RelayModernRecord');
 
-var invariant = require('invariant');
-
 var _require = require('../store/RelayRecordState'),
     EXISTENT = _require.EXISTENT;
 
+var invariant = require('invariant');
 /**
  * @internal
  *
@@ -29,6 +28,8 @@ var _require = require('../store/RelayRecordState'),
  * - Modifications cause a fresh version of a record to be created in `sink`.
  *   These sink records contain only modified fields.
  */
+
+
 var RelayRecordSourceMutator = /*#__PURE__*/function () {
   function RelayRecordSourceMutator(base, sink) {
     this.__sources = [sink, base];

package/lib/mutations/RelayRecordSourceProxy.js

@@ -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,10 +12,6 @@
 
 var RelayModernRecord = require('../store/RelayModernRecord');
 
-var RelayRecordProxy = require('./RelayRecordProxy');
-
-var invariant = require('invariant');
-
 var _require = require('../store/RelayRecordState'),
     EXISTENT = _require.EXISTENT,
     NONEXISTENT = _require.NONEXISTENT;
@@ -24,11 +20,19 @@ var _require2 = require('../store/RelayStoreUtils'),
     ROOT_ID = _require2.ROOT_ID,
     ROOT_TYPE = _require2.ROOT_TYPE;
 
+var _require3 = require('./readUpdatableQuery_EXPERIMENTAL'),
+    _readUpdatableQuery_EXPERIMENTAL = _require3.readUpdatableQuery_EXPERIMENTAL;
+
+var RelayRecordProxy = require('./RelayRecordProxy');
+
+var invariant = require('invariant');
 /**
  * @internal
  *
  * A helper for manipulating a `RecordSource` via an imperative/OO-style API.
  */
+
+
 var RelayRecordSourceProxy = /*#__PURE__*/function () {
   function RelayRecordSourceProxy(mutator, getDataID, handlerProvider) {
     this.__mutator = mutator;
@@ -131,6 +135,10 @@ var RelayRecordSourceProxy = /*#__PURE__*/function () {
     return this._idsMarkedForInvalidation;
   };
 
+  _proto.readUpdatableQuery_EXPERIMENTAL = function readUpdatableQuery_EXPERIMENTAL(query, variables) {
+    return _readUpdatableQuery_EXPERIMENTAL(query, variables, this);
+  };
+
   return RelayRecordSourceProxy;
 }();