relay-runtime 9.0.0 → 10.1.0

package/lib/store/RelayModernEnvironment.js

@@ -11,6 +11,14 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
 var RelayDefaultHandlerProvider = require('../handlers/RelayDefaultHandlerProvider');
 
 var RelayFeatureFlags = require('../util/RelayFeatureFlags');
@@ -27,29 +35,36 @@ var RelayRecordSource = require('./RelayRecordSource');
 
 var defaultGetDataID = require('./defaultGetDataID');
 
+var defaultRequiredFieldLogger = require('./defaultRequiredFieldLogger');
+
 var generateID = require('../util/generateID');
 
 var invariant = require("fbjs/lib/invariant");
 
-var RelayModernEnvironment =
-/*#__PURE__*/
-function () {
+var RelayModernEnvironment = /*#__PURE__*/function () {
   function RelayModernEnvironment(config) {
     var _this = this;
 
-    var _config$log, _config$UNSTABLE_defa, _config$UNSTABLE_DO_N, _config$scheduler, _config$operationTrac;
+    var _config$log, _config$requiredField, _config$UNSTABLE_defa, _config$UNSTABLE_DO_N, _config$scheduler, _config$isServer, _config$operationTrac;
 
     this.configName = config.configName;
     var handlerProvider = config.handlerProvider ? config.handlerProvider : RelayDefaultHandlerProvider;
+    this._treatMissingFieldsAsNull = config.treatMissingFieldsAsNull === true;
     var operationLoader = config.operationLoader;
+    var reactFlightPayloadDeserializer = config.reactFlightPayloadDeserializer;
 
     if (process.env.NODE_ENV !== "production") {
       if (operationLoader != null) {
         !(typeof operationLoader === 'object' && typeof operationLoader.get === 'function' && typeof operationLoader.load === 'function') ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayModernEnvironment: Expected `operationLoader` to be an object ' + 'with get() and load() functions, got `%s`.', operationLoader) : invariant(false) : void 0;
       }
+
+      if (reactFlightPayloadDeserializer != null) {
+        !(typeof reactFlightPayloadDeserializer === 'function') ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayModernEnvironment: Expected `reactFlightPayloadDeserializer` ' + ' to be a function, got `%s`.', reactFlightPayloadDeserializer) : invariant(false) : void 0;
+      }
     }
 
     this.__log = (_config$log = config.log) !== null && _config$log !== void 0 ? _config$log : emptyFunction;
+    this.requiredFieldLogger = (_config$requiredField = config.requiredFieldLogger) !== null && _config$requiredField !== void 0 ? _config$requiredField : defaultRequiredFieldLogger;
     this._defaultRenderPolicy = ((_config$UNSTABLE_defa = config.UNSTABLE_defaultRenderPolicy) !== null && _config$UNSTABLE_defa !== void 0 ? _config$UNSTABLE_defa : RelayFeatureFlags.ENABLE_PARTIAL_RENDERING_DEFAULT === true) ? 'partial' : 'full';
     this._operationLoader = operationLoader;
     this._operationExecutions = new Map();
@@ -59,6 +74,7 @@ function () {
     this._scheduler = (_config$scheduler = config.scheduler) !== null && _config$scheduler !== void 0 ? _config$scheduler : null;
     this._store = config.store;
     this.options = config.options;
+    this._isServer = (_config$isServer = config.isServer) !== null && _config$isServer !== void 0 ? _config$isServer : false;
 
     this.__setNet = function (newNet) {
       return _this._network = newNet;
@@ -85,6 +101,7 @@ function () {
 
     this._missingFieldHandlers = config.missingFieldHandlers;
     this._operationTracker = (_config$operationTrac = config.operationTracker) !== null && _config$operationTrac !== void 0 ? _config$operationTrac : new RelayOperationTracker();
+    this._reactFlightPayloadDeserializer = reactFlightPayloadDeserializer;
   }
 
   var _proto = RelayModernEnvironment.prototype;
@@ -115,14 +132,18 @@ function () {
     var _this2 = this;
 
     var dispose = function dispose() {
-      _this2._publishQueue.revertUpdate(optimisticUpdate);
+      _this2._scheduleUpdates(function () {
+        _this2._publishQueue.revertUpdate(optimisticUpdate);
 
-      _this2._publishQueue.run();
+        _this2._publishQueue.run();
+      });
     };
 
-    this._publishQueue.applyUpdate(optimisticUpdate);
+    this._scheduleUpdates(function () {
+      _this2._publishQueue.applyUpdate(optimisticUpdate);
 
-    this._publishQueue.run();
+      _this2._publishQueue.run();
+    });
 
     return {
       dispose: dispose
@@ -130,37 +151,47 @@ function () {
   };
 
   _proto.revertUpdate = function revertUpdate(update) {
-    this._publishQueue.revertUpdate(update);
+    var _this3 = this;
 
-    this._publishQueue.run();
+    this._scheduleUpdates(function () {
+      _this3._publishQueue.revertUpdate(update);
+
+      _this3._publishQueue.run();
+    });
   };
 
   _proto.replaceUpdate = function replaceUpdate(update, newUpdate) {
-    this._publishQueue.revertUpdate(update);
+    var _this4 = this;
+
+    this._scheduleUpdates(function () {
+      _this4._publishQueue.revertUpdate(update);
 
-    this._publishQueue.applyUpdate(newUpdate);
+      _this4._publishQueue.applyUpdate(newUpdate);
 
-    this._publishQueue.run();
+      _this4._publishQueue.run();
+    });
   };
 
   _proto.applyMutation = function applyMutation(optimisticConfig) {
-    var _this3 = this;
+    var _this5 = this;
 
     var subscription = RelayObservable.create(function (sink) {
       var source = RelayObservable.create(function (_sink) {});
       var executor = RelayModernQueryExecutor.execute({
         operation: optimisticConfig.operation,
-        operationExecutions: _this3._operationExecutions,
-        operationLoader: _this3._operationLoader,
+        operationExecutions: _this5._operationExecutions,
+        operationLoader: _this5._operationLoader,
         optimisticConfig: optimisticConfig,
-        publishQueue: _this3._publishQueue,
-        scheduler: _this3._scheduler,
+        publishQueue: _this5._publishQueue,
+        reactFlightPayloadDeserializer: _this5._reactFlightPayloadDeserializer,
+        scheduler: _this5._scheduler,
         sink: sink,
         source: source,
-        store: _this3._store,
+        store: _this5._store,
         updater: null,
-        operationTracker: _this3._operationTracker,
-        getDataID: _this3._getDataID
+        operationTracker: _this5._operationTracker,
+        getDataID: _this5._getDataID,
+        treatMissingFieldsAsNull: _this5._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();
@@ -182,26 +213,27 @@ function () {
   };
 
   _proto.commitPayload = function commitPayload(operation, payload) {
-    var _this4 = this;
+    var _this6 = this;
 
     RelayObservable.create(function (sink) {
       var executor = RelayModernQueryExecutor.execute({
         operation: operation,
-        operationExecutions: _this4._operationExecutions,
-        operationLoader: _this4._operationLoader,
+        operationExecutions: _this6._operationExecutions,
+        operationLoader: _this6._operationLoader,
         optimisticConfig: null,
-        publishQueue: _this4._publishQueue,
-        scheduler: null,
-        // make sure the first payload is sync
+        publishQueue: _this6._publishQueue,
+        reactFlightPayloadDeserializer: _this6._reactFlightPayloadDeserializer,
+        scheduler: _this6._scheduler,
         sink: sink,
         source: RelayObservable.from({
           data: payload
         }),
-        store: _this4._store,
+        store: _this6._store,
         updater: null,
-        operationTracker: _this4._operationTracker,
-        getDataID: _this4._getDataID,
-        isClientPayload: true
+        operationTracker: _this6._operationTracker,
+        getDataID: _this6._getDataID,
+        isClientPayload: true,
+        treatMissingFieldsAsNull: _this6._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();
@@ -210,9 +242,13 @@ function () {
   };
 
   _proto.commitUpdate = function commitUpdate(updater) {
-    this._publishQueue.commitUpdate(updater);
+    var _this7 = this;
+
+    this._scheduleUpdates(function () {
+      _this7._publishQueue.commitUpdate(updater);
 
-    this._publishQueue.run();
+      _this7._publishQueue.run();
+    });
   };
 
   _proto.lookup = function lookup(readSelector) {
@@ -227,7 +263,13 @@ function () {
     return this._store.retain(operation);
   };
 
+  _proto.isServer = function isServer() {
+    return this._isServer;
+  };
+
   _proto._checkSelectorAndHandleMissingFields = function _checkSelectorAndHandleMissingFields(operation, handlers) {
+    var _this8 = this;
+
     var target = RelayRecordSource.create();
 
     var result = this._store.check(operation, {
@@ -236,12 +278,24 @@ function () {
     });
 
     if (target.size() > 0) {
-      this._publishQueue.commitSource(target);
+      this._scheduleUpdates(function () {
+        _this8._publishQueue.commitSource(target);
 
-      this._publishQueue.run();
+        _this8._publishQueue.run();
+      });
     }
 
     return result;
+  };
+
+  _proto._scheduleUpdates = function _scheduleUpdates(task) {
+    var scheduler = this._scheduler;
+
+    if (scheduler != null) {
+      scheduler.schedule(task);
+    } else {
+      task();
+    }
   }
   /**
    * Returns an Observable of GraphQLResponse resulting from executing the
@@ -254,10 +308,9 @@ function () {
   ;
 
   _proto.execute = function execute(_ref) {
-    var _this5 = this;
+    var _this9 = this;
 
     var operation = _ref.operation,
-        cacheConfig = _ref.cacheConfig,
         updater = _ref.updater;
 
     var _this$__createLogObse = this.__createLogObserver(operation.request.node.params, operation.request.variables),
@@ -265,26 +318,28 @@ function () {
         logRequestInfo = _this$__createLogObse[1];
 
     return RelayObservable.create(function (sink) {
-      var source = _this5._network.execute(operation.request.node.params, operation.request.variables, cacheConfig || {}, null, logRequestInfo);
+      var source = _this9._network.execute(operation.request.node.params, operation.request.variables, operation.request.cacheConfig || {}, null, logRequestInfo)["do"](logObserver);
 
       var executor = RelayModernQueryExecutor.execute({
         operation: operation,
-        operationExecutions: _this5._operationExecutions,
-        operationLoader: _this5._operationLoader,
+        operationExecutions: _this9._operationExecutions,
+        operationLoader: _this9._operationLoader,
         optimisticConfig: null,
-        publishQueue: _this5._publishQueue,
-        scheduler: _this5._scheduler,
+        publishQueue: _this9._publishQueue,
+        reactFlightPayloadDeserializer: _this9._reactFlightPayloadDeserializer,
+        scheduler: _this9._scheduler,
         sink: sink,
         source: source,
-        store: _this5._store,
+        store: _this9._store,
         updater: updater,
-        operationTracker: _this5._operationTracker,
-        getDataID: _this5._getDataID
+        operationTracker: _this9._operationTracker,
+        getDataID: _this9._getDataID,
+        treatMissingFieldsAsNull: _this9._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();
       };
-    })["do"](logObserver);
+    });
   }
   /**
    * Returns an Observable of GraphQLResponse resulting from executing the
@@ -299,7 +354,7 @@ function () {
   ;
 
   _proto.executeMutation = function executeMutation(_ref2) {
-    var _this6 = this;
+    var _this10 = this;
 
     var operation = _ref2.operation,
         optimisticResponse = _ref2.optimisticResponse,
@@ -322,28 +377,30 @@ function () {
         };
       }
 
-      var source = _this6._network.execute(operation.request.node.params, operation.request.variables, {
+      var source = _this10._network.execute(operation.request.node.params, operation.request.variables, _objectSpread(_objectSpread({}, operation.request.cacheConfig), {}, {
         force: true
-      }, uploadables, logRequestInfo);
+      }), uploadables, logRequestInfo)["do"](logObserver);
 
       var executor = RelayModernQueryExecutor.execute({
         operation: operation,
-        operationExecutions: _this6._operationExecutions,
-        operationLoader: _this6._operationLoader,
+        operationExecutions: _this10._operationExecutions,
+        operationLoader: _this10._operationLoader,
         optimisticConfig: optimisticConfig,
-        publishQueue: _this6._publishQueue,
-        scheduler: _this6._scheduler,
+        publishQueue: _this10._publishQueue,
+        reactFlightPayloadDeserializer: _this10._reactFlightPayloadDeserializer,
+        scheduler: _this10._scheduler,
         sink: sink,
         source: source,
-        store: _this6._store,
+        store: _this10._store,
         updater: updater,
-        operationTracker: _this6._operationTracker,
-        getDataID: _this6._getDataID
+        operationTracker: _this10._operationTracker,
+        getDataID: _this10._getDataID,
+        treatMissingFieldsAsNull: _this10._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();
       };
-    })["do"](logObserver);
+    });
   }
   /**
    * Returns an Observable of GraphQLResponse resulting from executing the
@@ -357,23 +414,25 @@ function () {
   ;
 
   _proto.executeWithSource = function executeWithSource(_ref3) {
-    var _this7 = this;
+    var _this11 = this;
 
     var operation = _ref3.operation,
         source = _ref3.source;
     return RelayObservable.create(function (sink) {
       var executor = RelayModernQueryExecutor.execute({
         operation: operation,
-        operationExecutions: _this7._operationExecutions,
-        operationLoader: _this7._operationLoader,
-        operationTracker: _this7._operationTracker,
+        operationExecutions: _this11._operationExecutions,
+        operationLoader: _this11._operationLoader,
+        operationTracker: _this11._operationTracker,
         optimisticConfig: null,
-        publishQueue: _this7._publishQueue,
-        scheduler: _this7._scheduler,
+        publishQueue: _this11._publishQueue,
+        reactFlightPayloadDeserializer: _this11._reactFlightPayloadDeserializer,
+        scheduler: _this11._scheduler,
         sink: sink,
         source: source,
-        store: _this7._store,
-        getDataID: _this7._getDataID
+        store: _this11._store,
+        getDataID: _this11._getDataID,
+        treatMissingFieldsAsNull: _this11._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();

package/lib/store/RelayModernFragmentSpecResolver.js

@@ -12,10 +12,12 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
 var RelayFeatureFlags = require('../util/RelayFeatureFlags');
 
 var areEqual = require("fbjs/lib/areEqual");
@@ -24,6 +26,8 @@ var invariant = require("fbjs/lib/invariant");
 
 var isScalarAndEqual = require('../util/isScalarAndEqual');
 
+var reportMissingRequiredFields = require('../util/reportMissingRequiredFields');
+
 var warning = require("fbjs/lib/warning");
 
 var _require = require('../query/fetchQueryInternal'),
@@ -56,9 +60,7 @@ var _require3 = require('./RelayModernSelector'),
  * the resolver as stale and notify the caller, and the actual results are
  * recomputed the first time `resolve()` is called.
  */
-var RelayModernFragmentSpecResolver =
-/*#__PURE__*/
-function () {
+var RelayModernFragmentSpecResolver = /*#__PURE__*/function () {
   function RelayModernFragmentSpecResolver(context, fragments, props, callback) {
     var _this = this;
 
@@ -105,7 +107,7 @@ function () {
             var nextItem = resolver.resolve();
 
             if (nextData || nextItem !== prevItem) {
-              nextData = nextData || (0, _objectSpread2["default"])({}, prevData);
+              nextData = nextData || _objectSpread({}, prevData);
               nextData[_key2] = nextItem;
             }
           } else {
@@ -114,7 +116,7 @@ function () {
             var _nextItem = prop !== undefined ? prop : null;
 
             if (nextData || !isScalarAndEqual(_nextItem, prevItem)) {
-              nextData = nextData || (0, _objectSpread2["default"])({}, prevData);
+              nextData = nextData || _objectSpread({}, prevData);
               nextData[_key2] = _nextItem;
             }
           }
@@ -192,15 +194,14 @@ function () {
  */
 
 
-var SelectorResolver =
-/*#__PURE__*/
-function () {
+var SelectorResolver = /*#__PURE__*/function () {
   function SelectorResolver(environment, selector, callback) {
     var _this2 = this;
 
     (0, _defineProperty2["default"])(this, "_onChange", function (snapshot) {
       _this2._data = snapshot.data;
       _this2._isMissingData = snapshot.isMissingData;
+      _this2._missingRequiredFields = snapshot.missingRequiredFields;
 
       _this2._callback();
     });
@@ -210,6 +211,7 @@ function () {
     this._callback = callback;
     this._data = _snapshot.data;
     this._isMissingData = _snapshot.isMissingData;
+    this._missingRequiredFields = _snapshot.missingRequiredFields;
     this._environment = environment;
     this._selector = selector;
     this._subscription = environment.subscribe(_snapshot, this._onChange);
@@ -258,6 +260,10 @@ function () {
       }
     }
 
+    if (this._missingRequiredFields != null) {
+      reportMissingRequiredFields(this._environment, this._missingRequiredFields);
+    }
+
     return this._data;
   };
 
@@ -272,6 +278,7 @@ function () {
 
     this._data = snapshot.data;
     this._isMissingData = snapshot.isMissingData;
+    this._missingRequiredFields = snapshot.missingRequiredFields;
     this._selector = selector;
     this._subscription = this._environment.subscribe(snapshot, this._onChange);
   };
@@ -289,7 +296,7 @@ function () {
     } // NOTE: We manually create the request descriptor here instead of
     // calling createOperationDescriptor() because we want to set a
     // descriptor with *unaltered* variables as the fragment owner.
-    // This is a hack that allows us to preserve exisiting (broken)
+    // This is a hack that allows us to preserve existing (broken)
     // behavior of RelayModern containers while using fragment ownership
     // to propagate variables instead of Context.
     // For more details, see the summary of D13999308
@@ -307,9 +314,7 @@ function () {
  */
 
 
-var SelectorListResolver =
-/*#__PURE__*/
-function () {
+var SelectorListResolver = /*#__PURE__*/function () {
   function SelectorListResolver(environment, selector, callback) {
     var _this3 = this;
 

package/lib/store/RelayModernOperationDescriptor.js

@@ -30,11 +30,11 @@ var _require3 = require('./RelayStoreUtils'),
  * are filtered to exclude variables that do not match defined arguments on the
  * operation, and default values are populated for null values.
  */
-function createOperationDescriptor(request, variables) {
-  var dataID = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : ROOT_ID;
+function createOperationDescriptor(request, variables, cacheConfig) {
+  var dataID = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : ROOT_ID;
   var operation = request.operation;
   var operationVariables = getOperationVariables(operation, variables);
-  var requestDescriptor = createRequestDescriptor(request, operationVariables);
+  var requestDescriptor = createRequestDescriptor(request, operationVariables, cacheConfig);
   var operationDescriptor = {
     fragment: createReaderSelector(request.fragment, dataID, operationVariables, requestDescriptor),
     request: requestDescriptor,
@@ -53,11 +53,12 @@ function createOperationDescriptor(request, variables) {
   return operationDescriptor;
 }
 
-function createRequestDescriptor(request, variables) {
+function createRequestDescriptor(request, variables, cacheConfig) {
   var requestDescriptor = {
     identifier: getRequestIdentifier(request.params, variables),
     node: request,
-    variables: variables
+    variables: variables,
+    cacheConfig: cacheConfig
   };
 
   if (process.env.NODE_ENV !== "production") {