relay-runtime 7.0.0 → 9.1.0

package/lib/store/RelayConcreteVariables.js

@@ -7,11 +7,16 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 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 invariant = require("fbjs/lib/invariant");
 
@@ -29,7 +34,7 @@ function getFragmentVariables(fragment, rootVariables, argumentVariables) {
       return;
     }
 
-    variables = variables || (0, _objectSpread2["default"])({}, argumentVariables);
+    variables = variables || _objectSpread({}, argumentVariables);
 
     switch (definition.kind) {
       case 'LocalArgument':

package/lib/store/RelayModernEnvironment.js

@@ -8,13 +8,20 @@
  * @emails oncall+relay
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
-var DataChecker = require('./DataChecker');
+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 RelayDefaultMissingFieldHandlers = require('../handlers/RelayDefaultMissingFieldHandlers');
+var RelayFeatureFlags = require('../util/RelayFeatureFlags');
 
 var RelayModernQueryExecutor = require('./RelayModernQueryExecutor');
 
@@ -32,16 +39,15 @@ 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_DO_N, _config$scheduler, _config$missingFieldH, _config$operationTrac;
+    var _config$log, _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;
 
     if (process.env.NODE_ENV !== "production") {
@@ -51,12 +57,16 @@ function () {
     }
 
     this.__log = (_config$log = config.log) !== null && _config$log !== void 0 ? _config$log : emptyFunction;
+    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();
     this._network = config.network;
     this._getDataID = (_config$UNSTABLE_DO_N = config.UNSTABLE_DO_NOT_USE_getDataID) !== null && _config$UNSTABLE_DO_N !== void 0 ? _config$UNSTABLE_DO_N : defaultGetDataID;
     this._publishQueue = new RelayPublishQueue(config.store, handlerProvider, this._getDataID);
     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;
@@ -81,7 +91,7 @@ function () {
       devToolsHook.registerEnvironment(this);
     }
 
-    this._missingFieldHandlers = (_config$missingFieldH = config.missingFieldHandlers) !== null && _config$missingFieldH !== void 0 ? _config$missingFieldH : RelayDefaultMissingFieldHandlers;
+    this._missingFieldHandlers = config.missingFieldHandlers;
     this._operationTracker = (_config$operationTrac = config.operationTracker) !== null && _config$operationTrac !== void 0 ? _config$operationTrac : new RelayOperationTracker();
   }
 
@@ -99,6 +109,16 @@ function () {
     return this._operationTracker;
   };
 
+  _proto.isRequestActive = function isRequestActive(requestIdentifier) {
+    var activeState = this._operationExecutions.get(requestIdentifier);
+
+    return activeState === 'active';
+  };
+
+  _proto.UNSTABLE_getDefaultRenderPolicy = function UNSTABLE_getDefaultRenderPolicy() {
+    return this._defaultRenderPolicy;
+  };
+
   _proto.applyUpdate = function applyUpdate(optimisticUpdate) {
     var _this2 = this;
 
@@ -138,15 +158,18 @@ function () {
       var source = RelayObservable.create(function (_sink) {});
       var executor = RelayModernQueryExecutor.execute({
         operation: optimisticConfig.operation,
+        operationExecutions: _this3._operationExecutions,
         operationLoader: _this3._operationLoader,
         optimisticConfig: optimisticConfig,
         publishQueue: _this3._publishQueue,
         scheduler: _this3._scheduler,
         sink: sink,
         source: source,
+        store: _this3._store,
         updater: null,
         operationTracker: _this3._operationTracker,
-        getDataID: _this3._getDataID
+        getDataID: _this3._getDataID,
+        treatMissingFieldsAsNull: _this3._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();
@@ -159,12 +182,12 @@ function () {
     };
   };
 
-  _proto.check = function check(readSelector) {
-    if (this._missingFieldHandlers == null) {
-      return this._store.check(readSelector);
+  _proto.check = function check(operation) {
+    if (this._missingFieldHandlers == null || this._missingFieldHandlers.length === 0) {
+      return this._store.check(operation);
     }
 
-    return this._checkSelectorAndHandleMissingFields(readSelector, this._missingFieldHandlers);
+    return this._checkSelectorAndHandleMissingFields(operation, this._missingFieldHandlers);
   };
 
   _proto.commitPayload = function commitPayload(operation, payload) {
@@ -173,6 +196,7 @@ function () {
     RelayObservable.create(function (sink) {
       var executor = RelayModernQueryExecutor.execute({
         operation: operation,
+        operationExecutions: _this4._operationExecutions,
         operationLoader: _this4._operationLoader,
         optimisticConfig: null,
         publishQueue: _this4._publishQueue,
@@ -182,9 +206,12 @@ function () {
         source: RelayObservable.from({
           data: payload
         }),
+        store: _this4._store,
         updater: null,
         operationTracker: _this4._operationTracker,
-        getDataID: _this4._getDataID
+        getDataID: _this4._getDataID,
+        isClientPayload: true,
+        treatMissingFieldsAsNull: _this4._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();
@@ -206,16 +233,20 @@ function () {
     return this._store.subscribe(snapshot, callback);
   };
 
-  _proto.retain = function retain(selector) {
-    return this._store.retain(selector);
+  _proto.retain = function retain(operation) {
+    return this._store.retain(operation);
   };
 
-  _proto._checkSelectorAndHandleMissingFields = function _checkSelectorAndHandleMissingFields(selector, handlers) {
-    var _this5 = this;
+  _proto.isServer = function isServer() {
+    return this._isServer;
+  };
 
+  _proto._checkSelectorAndHandleMissingFields = function _checkSelectorAndHandleMissingFields(operation, handlers) {
     var target = RelayRecordSource.create();
-    var result = DataChecker.check(this._store.getSource(), target, selector, handlers, this._operationLoader, this._getDataID, function (id) {
-      return _this5._store.getConnectionEvents_UNSTABLE(id);
+
+    var result = this._store.check(operation, {
+      target: target,
+      handlers: handlers
     });
 
     if (target.size() > 0) {
@@ -237,7 +268,7 @@ function () {
   ;
 
   _proto.execute = function execute(_ref) {
-    var _this6 = this;
+    var _this5 = this;
 
     var operation = _ref.operation,
         cacheConfig = _ref.cacheConfig,
@@ -248,19 +279,22 @@ function () {
         logRequestInfo = _this$__createLogObse[1];
 
     return RelayObservable.create(function (sink) {
-      var source = _this6._network.execute(operation.request.node.params, operation.request.variables, cacheConfig || {}, null, logRequestInfo);
+      var source = _this5._network.execute(operation.request.node.params, operation.request.variables, cacheConfig || {}, null, logRequestInfo);
 
       var executor = RelayModernQueryExecutor.execute({
         operation: operation,
-        operationLoader: _this6._operationLoader,
+        operationExecutions: _this5._operationExecutions,
+        operationLoader: _this5._operationLoader,
         optimisticConfig: null,
-        publishQueue: _this6._publishQueue,
-        scheduler: _this6._scheduler,
+        publishQueue: _this5._publishQueue,
+        scheduler: _this5._scheduler,
         sink: sink,
         source: source,
+        store: _this5._store,
         updater: updater,
-        operationTracker: _this6._operationTracker,
-        getDataID: _this6._getDataID
+        operationTracker: _this5._operationTracker,
+        getDataID: _this5._getDataID,
+        treatMissingFieldsAsNull: _this5._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();
@@ -280,9 +314,10 @@ function () {
   ;
 
   _proto.executeMutation = function executeMutation(_ref2) {
-    var _this7 = this;
+    var _this6 = this;
 
-    var operation = _ref2.operation,
+    var cacheConfig = _ref2.cacheConfig,
+        operation = _ref2.operation,
         optimisticResponse = _ref2.optimisticResponse,
         optimisticUpdater = _ref2.optimisticUpdater,
         updater = _ref2.updater,
@@ -303,21 +338,24 @@ function () {
         };
       }
 
-      var source = _this7._network.execute(operation.request.node.params, operation.request.variables, {
+      var source = _this6._network.execute(operation.request.node.params, operation.request.variables, _objectSpread({}, cacheConfig, {
         force: true
-      }, uploadables, logRequestInfo);
+      }), uploadables, logRequestInfo);
 
       var executor = RelayModernQueryExecutor.execute({
         operation: operation,
-        operationLoader: _this7._operationLoader,
+        operationExecutions: _this6._operationExecutions,
+        operationLoader: _this6._operationLoader,
         optimisticConfig: optimisticConfig,
-        publishQueue: _this7._publishQueue,
-        scheduler: _this7._scheduler,
+        publishQueue: _this6._publishQueue,
+        scheduler: _this6._scheduler,
         sink: sink,
         source: source,
+        store: _this6._store,
         updater: updater,
-        operationTracker: _this7._operationTracker,
-        getDataID: _this7._getDataID
+        operationTracker: _this6._operationTracker,
+        getDataID: _this6._getDataID,
+        treatMissingFieldsAsNull: _this6._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();
@@ -336,21 +374,24 @@ function () {
   ;
 
   _proto.executeWithSource = function executeWithSource(_ref3) {
-    var _this8 = this;
+    var _this7 = this;
 
     var operation = _ref3.operation,
         source = _ref3.source;
     return RelayObservable.create(function (sink) {
       var executor = RelayModernQueryExecutor.execute({
         operation: operation,
-        operationLoader: _this8._operationLoader,
-        operationTracker: _this8._operationTracker,
+        operationExecutions: _this7._operationExecutions,
+        operationLoader: _this7._operationLoader,
+        operationTracker: _this7._operationTracker,
         optimisticConfig: null,
-        publishQueue: _this8._publishQueue,
-        scheduler: _this8._scheduler,
+        publishQueue: _this7._publishQueue,
+        scheduler: _this7._scheduler,
         sink: sink,
         source: source,
-        getDataID: _this8._getDataID
+        store: _this7._store,
+        getDataID: _this7._getDataID,
+        treatMissingFieldsAsNull: _this7._treatMissingFieldsAsNull
       });
       return function () {
         return executor.cancel();

package/lib/store/RelayModernFragmentSpecResolver.js

@@ -7,27 +7,37 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 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");
 
 var invariant = require("fbjs/lib/invariant");
 
 var isScalarAndEqual = require('../util/isScalarAndEqual');
 
-var _require = require('./RelayModernOperationDescriptor'),
-    createRequestDescriptor = _require.createRequestDescriptor;
+var warning = require("fbjs/lib/warning");
+
+var _require = require('../query/fetchQueryInternal'),
+    getPromiseForActiveRequest = _require.getPromiseForActiveRequest;
 
-var _require2 = require('./RelayModernSelector'),
-    areEqualSelectors = _require2.areEqualSelectors,
-    createReaderSelector = _require2.createReaderSelector,
-    getSelectorsFromObject = _require2.getSelectorsFromObject;
+var _require2 = require('./RelayModernOperationDescriptor'),
+    createRequestDescriptor = _require2.createRequestDescriptor;
+
+var _require3 = require('./RelayModernSelector'),
+    areEqualSelectors = _require3.areEqualSelectors,
+    createReaderSelector = _require3.createReaderSelector,
+    getSelectorsFromObject = _require3.getSelectorsFromObject;
 
 /**
  * A utility for resolving and subscribing to the results of a fragment spec
@@ -48,9 +58,7 @@ var _require2 = 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;
 
@@ -65,7 +73,7 @@ function () {
     this._context = context;
     this._data = {};
     this._fragments = fragments;
-    this._props = props;
+    this._props = {};
     this._resolvers = {};
     this._stale = false;
     this.setProps(props);
@@ -97,7 +105,7 @@ function () {
             var nextItem = resolver.resolve();
 
             if (nextData || nextItem !== prevItem) {
-              nextData = nextData || (0, _objectSpread2["default"])({}, prevData);
+              nextData = nextData || _objectSpread({}, prevData);
               nextData[_key2] = nextItem;
             }
           } else {
@@ -106,7 +114,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;
             }
           }
@@ -126,6 +134,7 @@ function () {
 
   _proto.setProps = function setProps(props) {
     var ownedSelectors = getSelectorsFromObject(this._fragments, props);
+    this._props = {};
 
     for (var _key3 in ownedSelectors) {
       if (ownedSelectors.hasOwnProperty(_key3)) {
@@ -154,11 +163,11 @@ function () {
           }
         }
 
+        this._props[_key3] = props[_key3];
         this._resolvers[_key3] = resolver;
       }
     }
 
-    this._props = props;
     this._stale = true;
   };
 
@@ -183,14 +192,13 @@ 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._callback();
     });
@@ -199,6 +207,7 @@ function () {
 
     this._callback = callback;
     this._data = _snapshot.data;
+    this._isMissingData = _snapshot.isMissingData;
     this._environment = environment;
     this._selector = selector;
     this._subscription = environment.subscribe(_snapshot, this._onChange);
@@ -215,6 +224,38 @@ function () {
   };
 
   _proto2.resolve = function resolve() {
+    if (RelayFeatureFlags.ENABLE_RELAY_CONTAINERS_SUSPENSE === true && this._isMissingData === true) {
+      var _getPromiseForActiveR;
+
+      // NOTE: This branch exists to handle the case in which:
+      // - A RelayModern container is rendered as a descendant of a Relay Hook
+      //   root using a "partial" renderPolicy (this means that eargerly
+      //   reading any cached data that is available instead of blocking
+      //   at the root until the whole query is fetched).
+      // - A parent Relay Hook didnt' suspend earlier on data being fetched,
+      //   either because the fragment data for the parent was available, or
+      //   the parent fragment didn't have any data dependencies.
+      // Even though our Flow types reflect the possiblity of null data, there
+      // might still be cases where it's not handled at runtime becuase the
+      // Flow types are being ignored, or simply not being used (for example,
+      // the case reported here: https://fburl.com/srnbucf8, was due to
+      // misuse of Flow types here: https://fburl.com/g3m0mqqh).
+      // Additionally, even though the null data might be handled without a
+      // runtime error, we might not suspend when we intended to if a parent
+      // Relay Hook (e.g. that is using @defer) decided not to suspend becuase
+      // it's immediate data was already available (even if it was deferred),
+      // or it didn't actually need any data (was just spreading other fragments).
+      // This should eventually go away with something like @optional, where we only
+      // suspend at specific boundaries depending on whether the boundary
+      // can be fulfilled or not.
+      var promise = (_getPromiseForActiveR = getPromiseForActiveRequest(this._environment, this._selector.owner)) !== null && _getPromiseForActiveR !== void 0 ? _getPromiseForActiveR : this._environment.getOperationTracker().getPromiseForPendingOperationsAffectingOwner(this._selector.owner);
+
+      if (promise != null) {
+        process.env.NODE_ENV !== "production" ? warning(false, 'Relay: Relay Container for fragment `%s` suspended. When using ' + 'features such as @defer or @module, use `useFragment` instead ' + 'of a Relay Container.', this._selector.node.name) : void 0;
+        throw promise;
+      }
+    }
+
     return this._data;
   };
 
@@ -228,6 +269,7 @@ function () {
     var snapshot = this._environment.lookup(selector);
 
     this._data = snapshot.data;
+    this._isMissingData = snapshot.isMissingData;
     this._selector = selector;
     this._subscription = this._environment.subscribe(snapshot, this._onChange);
   };
@@ -263,9 +305,7 @@ function () {
  */
 
 
-var SelectorListResolver =
-/*#__PURE__*/
-function () {
+var SelectorListResolver = /*#__PURE__*/function () {
   function SelectorListResolver(environment, selector, callback) {
     var _this3 = this;
 

package/lib/store/RelayModernOperationDescriptor.js

@@ -7,6 +7,7 @@
  * 
  * @format
  */
+// flowlint ambiguous-object-type:error
 'use strict';
 
 var deepFreeze = require('../util/deepFreeze');
@@ -30,9 +31,9 @@ var _require3 = require('./RelayStoreUtils'),
  * 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;
   var operation = request.operation;
   var operationVariables = getOperationVariables(operation, variables);
-  var dataID = ROOT_ID;
   var requestDescriptor = createRequestDescriptor(request, operationVariables);
   var operationDescriptor = {
     fragment: createReaderSelector(request.fragment, dataID, operationVariables, requestDescriptor),