relay-runtime 10.0.0 → 10.1.2

package/lib/store/RelayModernStore.js

@@ -12,16 +12,14 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-function _createForOfIteratorHelper(o) { if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (o = _unsupportedIterableToArray(o))) { var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var it, normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
 
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(n); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 var DataChecker = require('./DataChecker');
 
+var RelayFeatureFlags = require('../util/RelayFeatureFlags');
+
 var RelayModernRecord = require('./RelayModernRecord');
 
 var RelayOptimisticRecordSource = require('./RelayOptimisticRecordSource');
@@ -32,18 +30,20 @@ var RelayReader = require('./RelayReader');
 
 var RelayReferenceMarker = require('./RelayReferenceMarker');
 
+var RelayStoreReactFlightUtils = require('./RelayStoreReactFlightUtils');
+
+var RelayStoreSubscriptions = require('./RelayStoreSubscriptions');
+
+var RelayStoreSubscriptionsUsingMapByID = require('./RelayStoreSubscriptionsUsingMapByID');
+
 var RelayStoreUtils = require('./RelayStoreUtils');
 
 var deepFreeze = require('../util/deepFreeze');
 
 var defaultGetDataID = require('./defaultGetDataID');
 
-var hasOverlappingIDs = require('./hasOverlappingIDs');
-
 var invariant = require("fbjs/lib/invariant");
 
-var recycleNodesInto = require('../util/recycleNodesInto');
-
 var resolveImmediate = require('../util/resolveImmediate');
 
 var _require = require('./RelayStoreUtils'),
@@ -102,7 +102,7 @@ var RelayModernStore = /*#__PURE__*/function () {
     this._globalInvalidationEpoch = null;
     this._invalidationSubscriptions = new Set();
     this._invalidatedRecordIDs = new Set();
-    this._log = (_options$log = options === null || options === void 0 ? void 0 : options.log) !== null && _options$log !== void 0 ? _options$log : null;
+    this.__log = (_options$log = options === null || options === void 0 ? void 0 : options.log) !== null && _options$log !== void 0 ? _options$log : null;
     this._queryCacheExpirationTime = options === null || options === void 0 ? void 0 : options.queryCacheExpirationTime;
     this._operationLoader = (_options$operationLoa = options === null || options === void 0 ? void 0 : options.operationLoader) !== null && _options$operationLoa !== void 0 ? _options$operationLoa : null;
     this._optimisticSource = null;
@@ -110,7 +110,7 @@ var RelayModernStore = /*#__PURE__*/function () {
     this._releaseBuffer = [];
     this._roots = new Map();
     this._shouldScheduleGC = false;
-    this._subscriptions = new Set();
+    this._storeSubscriptions = RelayFeatureFlags.ENABLE_STORE_SUBSCRIPTIONS_REFACTOR === true ? new RelayStoreSubscriptionsUsingMapByID() : new RelayStoreSubscriptions();
     this._updatedRecordIDs = {};
     initializeRecordSource(this._recordSource);
   }
@@ -186,7 +186,7 @@ var RelayModernStore = /*#__PURE__*/function () {
         if (rootEntryIsStale) {
           _this2._roots["delete"](id);
 
-          _this2._scheduleGC();
+          _this2.scheduleGC();
         } else {
           _this2._releaseBuffer.push(id); // If the release buffer is now over-full, remove the least-recently
           // added entry and schedule a GC. Note that all items in the release
@@ -198,7 +198,7 @@ var RelayModernStore = /*#__PURE__*/function () {
 
             _this2._roots["delete"](_id);
 
-            _this2._scheduleGC();
+            _this2.scheduleGC();
           }
         }
       }
@@ -248,7 +248,7 @@ var RelayModernStore = /*#__PURE__*/function () {
   _proto.notify = function notify(sourceOperation, invalidateStore) {
     var _this3 = this;
 
-    var log = this._log;
+    var log = this.__log;
 
     if (log != null) {
       log({
@@ -267,13 +267,7 @@ var RelayModernStore = /*#__PURE__*/function () {
     var source = this.getSource();
     var updatedOwners = [];
 
-    this._subscriptions.forEach(function (subscription) {
-      var owner = _this3._updateSubscription(source, subscription);
-
-      if (owner != null) {
-        updatedOwners.push(owner);
-      }
-    });
+    this._storeSubscriptions.updateSubscriptions(source, this._updatedRecordIDs, updatedOwners);
 
     this._invalidationSubscriptions.forEach(function (subscription) {
       _this3._updateInvalidationSubscription(subscription, invalidateStore === true);
@@ -336,7 +330,7 @@ var RelayModernStore = /*#__PURE__*/function () {
     this._currentWriteEpoch + 1, idsMarkedForInvalidation, this._updatedRecordIDs, this._invalidatedRecordIDs); // NOTE: log *after* processing the source so that even if a bad log function
     // mutates the source, it doesn't affect Relay processing of it.
 
-    var log = this._log;
+    var log = this.__log;
 
     if (log != null) {
       log({
@@ -348,28 +342,11 @@ var RelayModernStore = /*#__PURE__*/function () {
   };
 
   _proto.subscribe = function subscribe(snapshot, callback) {
-    var _this4 = this;
-
-    var subscription = {
-      backup: null,
-      callback: callback,
-      snapshot: snapshot,
-      stale: false
-    };
-
-    var dispose = function dispose() {
-      _this4._subscriptions["delete"](subscription);
-    };
-
-    this._subscriptions.add(subscription);
-
-    return {
-      dispose: dispose
-    };
+    return this._storeSubscriptions.subscribe(snapshot, callback);
   };
 
   _proto.holdGC = function holdGC() {
-    var _this5 = this;
+    var _this4 = this;
 
     if (this._gcRun) {
       this._gcRun = null;
@@ -379,13 +356,13 @@ var RelayModernStore = /*#__PURE__*/function () {
     this._gcHoldCounter++;
 
     var dispose = function dispose() {
-      if (_this5._gcHoldCounter > 0) {
-        _this5._gcHoldCounter--;
+      if (_this4._gcHoldCounter > 0) {
+        _this4._gcHoldCounter--;
 
-        if (_this5._gcHoldCounter === 0 && _this5._shouldScheduleGC) {
-          _this5._scheduleGC();
+        if (_this4._gcHoldCounter === 0 && _this4._shouldScheduleGC) {
+          _this4.scheduleGC();
 
-          _this5._shouldScheduleGC = false;
+          _this4._shouldScheduleGC = false;
         }
       }
     };
@@ -402,51 +379,16 @@ var RelayModernStore = /*#__PURE__*/function () {
 
   _proto.__getUpdatedRecordIDs = function __getUpdatedRecordIDs() {
     return this._updatedRecordIDs;
-  } // Returns the owner (RequestDescriptor) if the subscription was affected by the
-  // latest update, or null if it was not affected.
-  ;
-
-  _proto._updateSubscription = function _updateSubscription(source, subscription) {
-    var backup = subscription.backup,
-        callback = subscription.callback,
-        snapshot = subscription.snapshot,
-        stale = subscription.stale;
-    var hasOverlappingUpdates = hasOverlappingIDs(snapshot.seenRecords, this._updatedRecordIDs);
-
-    if (!stale && !hasOverlappingUpdates) {
-      return;
-    }
-
-    var nextSnapshot = hasOverlappingUpdates || !backup ? RelayReader.read(source, snapshot.selector) : backup;
-    var nextData = recycleNodesInto(snapshot.data, nextSnapshot.data);
-    nextSnapshot = {
-      data: nextData,
-      isMissingData: nextSnapshot.isMissingData,
-      seenRecords: nextSnapshot.seenRecords,
-      selector: nextSnapshot.selector
-    };
-
-    if (process.env.NODE_ENV !== "production") {
-      deepFreeze(nextSnapshot);
-    }
-
-    subscription.snapshot = nextSnapshot;
-    subscription.stale = false;
-
-    if (nextSnapshot.data !== snapshot.data) {
-      callback(nextSnapshot);
-      return snapshot.selector.owner;
-    }
   };
 
   _proto.lookupInvalidationState = function lookupInvalidationState(dataIDs) {
-    var _this6 = this;
+    var _this5 = this;
 
     var invalidations = new Map();
     dataIDs.forEach(function (dataID) {
       var _RelayModernRecord$ge;
 
-      var record = _this6.getSource().get(dataID);
+      var record = _this5.getSource().get(dataID);
 
       invalidations.set(dataID, (_RelayModernRecord$ge = RelayModernRecord.getInvalidationEpoch(record)) !== null && _RelayModernRecord$ge !== void 0 ? _RelayModernRecord$ge : null);
     });
@@ -467,7 +409,7 @@ var RelayModernStore = /*#__PURE__*/function () {
     } // Check if the invalidation state for any of the ids has changed.
 
 
-    var _iterator = _createForOfIteratorHelper(prevInvalidationState.dataIDs),
+    var _iterator = (0, _createForOfIteratorHelper2["default"])(prevInvalidationState.dataIDs),
         _step;
 
     try {
@@ -488,7 +430,7 @@ var RelayModernStore = /*#__PURE__*/function () {
   };
 
   _proto.subscribeToInvalidationState = function subscribeToInvalidationState(invalidationState, callback) {
-    var _this7 = this;
+    var _this6 = this;
 
     var subscription = {
       callback: callback,
@@ -496,7 +438,7 @@ var RelayModernStore = /*#__PURE__*/function () {
     };
 
     var dispose = function dispose() {
-      _this7._invalidationSubscriptions["delete"](subscription);
+      _this6._invalidationSubscriptions["delete"](subscription);
     };
 
     this._invalidationSubscriptions.add(subscription);
@@ -507,13 +449,13 @@ var RelayModernStore = /*#__PURE__*/function () {
   };
 
   _proto._updateInvalidationSubscription = function _updateInvalidationSubscription(subscription, invalidatedStore) {
-    var _this8 = this;
+    var _this7 = this;
 
     var callback = subscription.callback,
         invalidationState = subscription.invalidationState;
     var dataIDs = invalidationState.dataIDs;
     var isSubscribedToInvalidatedIDs = invalidatedStore || dataIDs.some(function (dataID) {
-      return _this8._invalidatedRecordIDs.has(dataID);
+      return _this7._invalidatedRecordIDs.has(dataID);
     });
 
     if (!isSubscribedToInvalidatedIDs) {
@@ -524,10 +466,8 @@ var RelayModernStore = /*#__PURE__*/function () {
   };
 
   _proto.snapshot = function snapshot() {
-    var _this9 = this;
-
     !(this._optimisticSource == null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayModernStore: Unexpected call to snapshot() while a previous ' + 'snapshot exists.') : invariant(false) : void 0;
-    var log = this._log;
+    var log = this.__log;
 
     if (log != null) {
       log({
@@ -535,31 +475,7 @@ var RelayModernStore = /*#__PURE__*/function () {
       });
     }
 
-    this._subscriptions.forEach(function (subscription) {
-      // Backup occurs after writing a new "final" payload(s) and before (re)applying
-      // optimistic changes. Each subscription's `snapshot` represents what was *last
-      // published to the subscriber*, which notably may include previous optimistic
-      // updates. Therefore a subscription can be in any of the following states:
-      // - stale=true: This subscription was restored to a different value than
-      //   `snapshot`. That means this subscription has changes relative to its base,
-      //   but its base has changed (we just applied a final payload): recompute
-      //   a backup so that we can later restore to the state the subscription
-      //   should be in.
-      // - stale=false: This subscription was restored to the same value than
-      //   `snapshot`. That means this subscription does *not* have changes relative
-      //   to its base, so the current `snapshot` is valid to use as a backup.
-      if (!subscription.stale) {
-        subscription.backup = subscription.snapshot;
-        return;
-      }
-
-      var snapshot = subscription.snapshot;
-      var backup = RelayReader.read(_this9.getSource(), snapshot.selector);
-      var nextData = recycleNodesInto(snapshot.data, backup.data);
-      backup.data = nextData; // backup owns the snapshot and can safely mutate
-
-      subscription.backup = backup;
-    });
+    this._storeSubscriptions.snapshotSubscriptions(this.getSource());
 
     if (this._gcRun) {
       this._gcRun = null;
@@ -571,7 +487,7 @@ var RelayModernStore = /*#__PURE__*/function () {
 
   _proto.restore = function restore() {
     !(this._optimisticSource != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayModernStore: Unexpected call to restore(), expected a snapshot ' + 'to exist (make sure to call snapshot()).') : invariant(false) : void 0;
-    var log = this._log;
+    var log = this.__log;
 
     if (log != null) {
       log({
@@ -582,31 +498,13 @@ var RelayModernStore = /*#__PURE__*/function () {
     this._optimisticSource = null;
 
     if (this._shouldScheduleGC) {
-      this._scheduleGC();
+      this.scheduleGC();
     }
 
-    this._subscriptions.forEach(function (subscription) {
-      var backup = subscription.backup;
-      subscription.backup = null;
-
-      if (backup) {
-        if (backup.data !== subscription.snapshot.data) {
-          subscription.stale = true;
-        }
-
-        subscription.snapshot = {
-          data: subscription.snapshot.data,
-          isMissingData: backup.isMissingData,
-          seenRecords: backup.seenRecords,
-          selector: backup.selector
-        };
-      } else {
-        subscription.stale = true;
-      }
-    });
+    this._storeSubscriptions.restoreSubscriptions();
   };
 
-  _proto._scheduleGC = function _scheduleGC() {
+  _proto.scheduleGC = function scheduleGC() {
     if (this._gcHoldCounter > 0) {
       this._shouldScheduleGC = true;
       return;
@@ -642,7 +540,7 @@ var RelayModernStore = /*#__PURE__*/function () {
       var startEpoch = this._currentWriteEpoch;
       var references = new Set(); // Mark all records that are traversable from a root
 
-      var _iterator2 = _createForOfIteratorHelper(this._roots.values()),
+      var _iterator2 = (0, _createForOfIteratorHelper2["default"])(this._roots.values()),
           _step2;
 
       try {
@@ -663,7 +561,7 @@ var RelayModernStore = /*#__PURE__*/function () {
         _iterator2.f();
       }
 
-      var log = this._log;
+      var log = this.__log;
 
       if (log != null) {
         log({
@@ -705,7 +603,7 @@ function initializeRecordSource(target) {
 /**
  * Updates the target with information from source, also updating a mapping of
  * which records in the target were changed as a result.
- * Additionally, will marc records as invalidated at the current write epoch
+ * Additionally, will mark records as invalidated at the current write epoch
  * given the set of record ids marked as stale in this update.
  */
 
@@ -767,7 +665,11 @@ function updateTargetFromSource(target, source, currentWriteEpoch, idsMarkedForI
     }
 
     if (sourceRecord && targetRecord) {
-      var nextRecord = RelayModernRecord.update(targetRecord, sourceRecord);
+      // ReactFlightClientResponses are lazy and only materialize when readRoot
+      // is called when we read the field, so if the record is a Flight field
+      // we always use the new record's data regardless of whether
+      // it actually changed. Let React take care of reconciliation instead.
+      var nextRecord = RelayModernRecord.getType(targetRecord) === RelayStoreReactFlightUtils.REACT_FLIGHT_TYPE_NAME ? sourceRecord : RelayModernRecord.update(targetRecord, sourceRecord);
 
       if (nextRecord !== targetRecord) {
         // Prevent mutation of a record from outside the store.

package/lib/store/RelayOperationTracker.js

@@ -10,11 +10,9 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-function _createForOfIteratorHelper(o) { if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (o = _unsupportedIterableToArray(o))) { var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var it, normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(n); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
 
 var invariant = require("fbjs/lib/invariant");
 
@@ -39,7 +37,7 @@ var RelayOperationTracker = /*#__PURE__*/function () {
 
     var newlyAffectedOwners = new Set();
 
-    var _iterator = _createForOfIteratorHelper(affectedOwners),
+    var _iterator = (0, _createForOfIteratorHelper2["default"])(affectedOwners),
         _step;
 
     try {
@@ -78,7 +76,7 @@ var RelayOperationTracker = /*#__PURE__*/function () {
 
     var ownersAffectedByOperation = this._pendingOperationsToOwners.get(pendingOperation) || new Set();
 
-    var _iterator2 = _createForOfIteratorHelper(newlyAffectedOwners),
+    var _iterator2 = (0, _createForOfIteratorHelper2["default"])(newlyAffectedOwners),
         _step2;
 
     try {
@@ -116,7 +114,7 @@ var RelayOperationTracker = /*#__PURE__*/function () {
 
     var updatedOwners = new Set();
 
-    var _iterator3 = _createForOfIteratorHelper(affectedOwners),
+    var _iterator3 = (0, _createForOfIteratorHelper2["default"])(affectedOwners),
         _step3;
 
     try {
@@ -144,7 +142,7 @@ var RelayOperationTracker = /*#__PURE__*/function () {
       _iterator3.f();
     }
 
-    var _iterator4 = _createForOfIteratorHelper(completedOwners),
+    var _iterator4 = (0, _createForOfIteratorHelper2["default"])(completedOwners),
         _step4;
 
     try {
@@ -163,7 +161,7 @@ var RelayOperationTracker = /*#__PURE__*/function () {
       _iterator4.f();
     }
 
-    var _iterator5 = _createForOfIteratorHelper(updatedOwners),
+    var _iterator5 = (0, _createForOfIteratorHelper2["default"])(updatedOwners),
         _step5;
 
     try {

package/lib/store/RelayOptimisticRecordSource.js

@@ -12,11 +12,7 @@
 
 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 _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
 var RelayRecordSource = require('./RelayRecordSource');
 
@@ -102,7 +98,7 @@ var RelayOptimisticRecordSource = /*#__PURE__*/function () {
   _proto.toJSON = function toJSON() {
     var _this = this;
 
-    var merged = _objectSpread({}, this._base.toJSON());
+    var merged = (0, _objectSpread2["default"])({}, this._base.toJSON());
 
     this._sink.getRecordIDs().forEach(function (dataID) {
       var record = _this.get(dataID);

package/lib/store/RelayPublishQueue.js

@@ -146,7 +146,7 @@ var RelayPublishQueue = /*#__PURE__*/function () {
 
   _proto.run = function run(sourceOperation) {
     if (process.env.NODE_ENV !== "production") {
-      process.env.NODE_ENV !== "production" ? warning(this._isRunning !== true, 'A store update was detected within another store update. Please ' + 'make sure new store updates aren’t being executed within an ' + 'updater function for a different update.') : void 0;
+      process.env.NODE_ENV !== "production" ? warning(this._isRunning !== true, 'A store update was detected within another store update. Please ' + "make sure new store updates aren't being executed within an " + 'updater function for a different update.') : void 0;
       this._isRunning = true;
     }