relay-runtime 18.1.0 → 19.0.0

package/lib/store/RelayModernStore.js

@@ -28,7 +28,7 @@ var DEFAULT_RELEASE_BUFFER_SIZE = 10;
 var RelayModernStore = /*#__PURE__*/function () {
   function RelayModernStore(source, options) {
     var _this = this;
-    var _options$gcReleaseBuf, _options$gcScheduler, _options$getDataID, _options$log, _options$operationLoa, _options$shouldProces, _options$treatMissing;
+    var _options$gcReleaseBuf, _options$shouldRetain, _options$gcScheduler, _options$getDataID, _options$log, _options$operationLoa, _options$shouldProces, _options$treatMissing;
     (0, _defineProperty2["default"])(this, "_gcStep", function () {
       if (_this._gcRun) {
         if (_this._gcRun.next().done) {
@@ -50,6 +50,7 @@ var RelayModernStore = /*#__PURE__*/function () {
     this._currentWriteEpoch = 0;
     this._gcHoldCounter = 0;
     this._gcReleaseBufferSize = (_options$gcReleaseBuf = options === null || options === void 0 ? void 0 : options.gcReleaseBufferSize) !== null && _options$gcReleaseBuf !== void 0 ? _options$gcReleaseBuf : DEFAULT_RELEASE_BUFFER_SIZE;
+    this._shouldRetainWithinTTL_EXPERIMENTAL = (_options$shouldRetain = options === null || options === void 0 ? void 0 : options.shouldRetainWithinTTL_EXPERIMENTAL) !== null && _options$shouldRetain !== void 0 ? _options$shouldRetain : false;
     this._gcRun = null;
     this._gcScheduler = (_options$gcScheduler = options === null || options === void 0 ? void 0 : options.gcScheduler) !== null && _options$gcScheduler !== void 0 ? _options$gcScheduler : resolveImmediate;
     this._getDataID = (_options$getDataID = options === null || options === void 0 ? void 0 : options.getDataID) !== null && _options$getDataID !== void 0 ? _options$getDataID : defaultGetDataID;
@@ -67,10 +68,10 @@ var RelayModernStore = /*#__PURE__*/function () {
     this._resolverCache = new LiveResolverCache(function () {
       return _this._getMutableRecordSource();
     }, this);
-    this._storeSubscriptions = new RelayStoreSubscriptions(options === null || options === void 0 ? void 0 : options.log, this._resolverCache);
+    this._resolverContext = options === null || options === void 0 ? void 0 : options.resolverContext;
+    this._storeSubscriptions = new RelayStoreSubscriptions(options === null || options === void 0 ? void 0 : options.log, this._resolverCache, this._resolverContext);
     this._updatedRecordIDs = new Set();
     this._shouldProcessClientComponents = (_options$shouldProces = options === null || options === void 0 ? void 0 : options.shouldProcessClientComponents) !== null && _options$shouldProces !== void 0 ? _options$shouldProces : false;
-    this._resolverContext = options === null || options === void 0 ? void 0 : options.resolverContext;
     this._treatMissingFieldsAsNull = (_options$treatMissing = options === null || options === void 0 ? void 0 : options.treatMissingFieldsAsNull) !== null && _options$treatMissing !== void 0 ? _options$treatMissing : false;
     this._actorIdentifier = options === null || options === void 0 ? void 0 : options.actorIdentifier;
     initializeRecordSource(this._recordSource);
@@ -150,13 +151,17 @@ var RelayModernStore = /*#__PURE__*/function () {
         var _queryCacheExpirationTime = _this2._queryCacheExpirationTime;
         var rootEntryIsStale = rootEntry.fetchTime != null && _queryCacheExpirationTime != null && rootEntry.fetchTime <= Date.now() - _queryCacheExpirationTime;
         if (rootEntryIsStale) {
-          _this2._roots["delete"](id);
+          if (!_this2._shouldRetainWithinTTL_EXPERIMENTAL) {
+            _this2._roots["delete"](id);
+          }
           _this2.scheduleGC();
         } else {
           _this2._releaseBuffer.push(id);
           if (_this2._releaseBuffer.length > _this2._gcReleaseBufferSize) {
             var _id = _this2._releaseBuffer.shift();
-            _this2._roots["delete"](_id);
+            if (!_this2._shouldRetainWithinTTL_EXPERIMENTAL) {
+              _this2._roots["delete"](_id);
+            }
             _this2.scheduleGC();
           }
         }
@@ -414,6 +419,9 @@ var RelayModernStore = /*#__PURE__*/function () {
     while (!gcRun.next().done) {}
   };
   _proto._collect = function* _collect() {
+    if (this._shouldRetainWithinTTL_EXPERIMENTAL && this._queryCacheExpirationTime == null) {
+      return;
+    }
     var log = this.__log;
     top: while (true) {
       if (log != null) {
@@ -423,11 +431,25 @@ var RelayModernStore = /*#__PURE__*/function () {
       }
       var startEpoch = this._currentWriteEpoch;
       var references = new Set();
-      var _iterator2 = (0, _createForOfIteratorHelper2["default"])(this._roots.values()),
+      var _iterator2 = (0, _createForOfIteratorHelper2["default"])(this._roots.entries()),
         _step2;
       try {
         for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-          var operation = _step2.value.operation;
+          var _step2$value = _step2.value,
+            _dataID = _step2$value[0],
+            _step2$value$ = _step2$value[1],
+            operation = _step2$value$.operation,
+            refCount = _step2$value$.refCount,
+            fetchTime = _step2$value$.fetchTime;
+          if (this._shouldRetainWithinTTL_EXPERIMENTAL) {
+            var _queryCacheExpirationTime = this._queryCacheExpirationTime;
+            !(_queryCacheExpirationTime != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Query cache expiration time should be non-null if executing GC') : invariant(false) : void 0;
+            var recordHasExpired = fetchTime == null || fetchTime <= Date.now() - _queryCacheExpirationTime;
+            var recordShouldBeCollected = recordHasExpired && refCount === 0 && !this._releaseBuffer.includes(_dataID);
+            if (recordShouldBeCollected) {
+              continue;
+            }
+          }
           var selector = operation.root;
           RelayReferenceMarker.mark(this._recordSource, selector, references, this._operationLoader, this._shouldProcessClientComponents);
           yield;
@@ -445,21 +467,20 @@ var RelayModernStore = /*#__PURE__*/function () {
       } finally {
         _iterator2.f();
       }
-      if (references.size === 0) {
-        this._recordSource.clear();
-      } else {
-        var storeIDs = this._recordSource.getRecordIDs();
-        for (var ii = 0; ii < storeIDs.length; ii++) {
-          var dataID = storeIDs[ii];
-          if (!references.has(dataID)) {
-            var record = this._recordSource.get(dataID);
-            if (record != null) {
-              var maybeResolverSubscription = RelayModernRecord.getValue(record, RELAY_RESOLVER_LIVE_STATE_SUBSCRIPTION_KEY);
-              if (maybeResolverSubscription != null) {
-                maybeResolverSubscription();
-              }
+      var storeIDs = this._recordSource.getRecordIDs();
+      for (var ii = 0; ii < storeIDs.length; ii++) {
+        var dataID = storeIDs[ii];
+        if (!references.has(dataID)) {
+          var record = this._recordSource.get(dataID);
+          if (record != null) {
+            var maybeResolverSubscription = RelayModernRecord.getValue(record, RELAY_RESOLVER_LIVE_STATE_SUBSCRIPTION_KEY);
+            if (maybeResolverSubscription != null) {
+              maybeResolverSubscription();
             }
-            this._recordSource.remove(dataID);
+          }
+          this._recordSource.remove(dataID);
+          if (this._shouldRetainWithinTTL_EXPERIMENTAL) {
+            this._roots["delete"](dataID);
           }
         }
       }
@@ -476,6 +497,7 @@ var RelayModernStore = /*#__PURE__*/function () {
     return {
       path: path,
       getDataID: this._getDataID,
+      log: this.__log,
       treatMissingFieldsAsNull: this._treatMissingFieldsAsNull,
       shouldProcessClientComponents: this._shouldProcessClientComponents,
       actorIdentifier: this._actorIdentifier

package/lib/store/RelayPublishQueue.js

@@ -4,6 +4,7 @@ var _global$ErrorUtils$ap, _global$ErrorUtils;
 var RelayRecordSourceMutator = require('../mutations/RelayRecordSourceMutator');
 var RelayRecordSourceProxy = require('../mutations/RelayRecordSourceProxy');
 var RelayRecordSourceSelectorProxy = require('../mutations/RelayRecordSourceSelectorProxy');
+var RelayFeatureFlags = require('../util/RelayFeatureFlags');
 var RelayReader = require('./RelayReader');
 var RelayRecordSource = require('./RelayRecordSource');
 var invariant = require('invariant');
@@ -13,7 +14,7 @@ var applyWithGuard = (_global$ErrorUtils$ap = _global === null || _global === vo
   return callback.apply(context, args);
 };
 var RelayPublishQueue = /*#__PURE__*/function () {
-  function RelayPublishQueue(store, handlerProvider, getDataID, missingFieldHandlers) {
+  function RelayPublishQueue(store, handlerProvider, getDataID, missingFieldHandlers, log) {
     this._hasStoreSnapshot = false;
     this._handlerProvider = handlerProvider || null;
     this._pendingBackupRebase = false;
@@ -24,6 +25,7 @@ var RelayPublishQueue = /*#__PURE__*/function () {
     this._gcHold = null;
     this._getDataID = getDataID;
     this._missingFieldHandlers = missingFieldHandlers;
+    this._log = log;
   }
   var _proto = RelayPublishQueue.prototype;
   _proto.applyUpdate = function applyUpdate(updater) {
@@ -69,15 +71,11 @@ var RelayPublishQueue = /*#__PURE__*/function () {
   _proto.run = function run(sourceOperation) {
     var runWillClearGcHold = this._appliedOptimisticUpdates === 0 && !!this._gcHold;
     var runIsANoop = !this._pendingBackupRebase && this._pendingOptimisticUpdates.size === 0 && !runWillClearGcHold;
-    if (process.env.NODE_ENV !== "production") {
-      process.env.NODE_ENV !== "production" ? warning(!runIsANoop, 'RelayPublishQueue.run was called, but the call would have been a noop.') : 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;
-    }
+    process.env.NODE_ENV !== "production" ? warning(!runIsANoop, 'RelayPublishQueue.run was called, but the call would have been a noop.') : void 0;
+    RelayFeatureFlags.DISALLOW_NESTED_UPDATES ? !(this._isRunning !== true) ? process.env.NODE_ENV !== "production" ? invariant(false, '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.') : invariant(false) : 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;
     if (runIsANoop) {
-      if (process.env.NODE_ENV !== "production") {
-        this._isRunning = false;
-      }
+      this._isRunning = false;
       return [];
     }
     if (this._pendingBackupRebase) {
@@ -105,9 +103,7 @@ var RelayPublishQueue = /*#__PURE__*/function () {
         this._gcHold = null;
       }
     }
-    if (process.env.NODE_ENV !== "production") {
-      this._isRunning = false;
-    }
+    this._isRunning = false;
     return this._store.notify(sourceOperation, invalidatedStore);
   };
   _proto._publishSourceFromPayload = function _publishSourceFromPayload(pendingPayload) {
@@ -118,7 +114,7 @@ var RelayPublishQueue = /*#__PURE__*/function () {
     var source = payload.source,
       fieldPayloads = payload.fieldPayloads;
     var mutator = new RelayRecordSourceMutator(this._store.getSource(), source);
-    var recordSourceProxy = new RelayRecordSourceProxy(mutator, this._getDataID, this._handlerProvider, this._missingFieldHandlers);
+    var recordSourceProxy = new RelayRecordSourceProxy(mutator, this._getDataID, this._handlerProvider, this._missingFieldHandlers, this._log);
     if (fieldPayloads && fieldPayloads.length) {
       fieldPayloads.forEach(function (fieldPayload) {
         var handler = _this._handlerProvider && _this._handlerProvider(fieldPayload.handle);
@@ -154,7 +150,7 @@ var RelayPublishQueue = /*#__PURE__*/function () {
         var updater = data.updater;
         var sink = RelayRecordSource.create();
         var mutator = new RelayRecordSourceMutator(_this2._store.getSource(), sink);
-        var recordSourceProxy = new RelayRecordSourceProxy(mutator, _this2._getDataID, _this2._handlerProvider, _this2._missingFieldHandlers);
+        var recordSourceProxy = new RelayRecordSourceProxy(mutator, _this2._getDataID, _this2._handlerProvider, _this2._missingFieldHandlers, _this2._log);
         applyWithGuard(updater, null, [recordSourceProxy], null, 'RelayPublishQueue:commitData');
         invalidatedStore = invalidatedStore || recordSourceProxy.isStoreMarkedForInvalidation();
         var idsMarkedForInvalidation = recordSourceProxy.getIDsMarkedForInvalidation();
@@ -168,7 +164,7 @@ var RelayPublishQueue = /*#__PURE__*/function () {
     var _this3 = this;
     var sink = RelayRecordSource.create();
     var mutator = new RelayRecordSourceMutator(this._store.getSource(), sink);
-    var recordSourceProxy = new RelayRecordSourceProxy(mutator, this._getDataID, this._handlerProvider, this._missingFieldHandlers);
+    var recordSourceProxy = new RelayRecordSourceProxy(mutator, this._getDataID, this._handlerProvider, this._missingFieldHandlers, this._log);
     var processUpdate = function processUpdate(optimisticUpdate) {
       if (optimisticUpdate.storeUpdater) {
         var storeUpdater = optimisticUpdate.storeUpdater;