relay-runtime 18.2.0 → 20.0.0

package/lib/store/RelayModernEnvironment.js

@@ -14,13 +14,14 @@ var defaultGetDataID = require('./defaultGetDataID');
 var defaultRelayFieldLogger = require('./defaultRelayFieldLogger');
 var normalizeResponse = require('./normalizeResponse');
 var OperationExecutor = require('./OperationExecutor');
+var RelayModernStore = require('./RelayModernStore');
 var RelayPublishQueue = require('./RelayPublishQueue');
 var RelayRecordSource = require('./RelayRecordSource');
 var invariant = require('invariant');
 var RelayModernEnvironment = /*#__PURE__*/function () {
   function RelayModernEnvironment(config) {
     var _this = this;
-    var _config$log, _config$relayFieldLog, _config$UNSTABLE_defa, _config$getDataID, _config$missingFieldH, _config$handlerProvid, _config$scheduler, _config$isServer, _config$normalizeResp, _config$operationTrac;
+    var _config$store, _config$log, _config$relayFieldLog, _config$UNSTABLE_defa, _config$getDataID, _config$missingFieldH, _config$handlerProvid, _config$scheduler, _config$isServer, _config$normalizeResp, _config$operationTrac;
     this.configName = config.configName;
     this._treatMissingFieldsAsNull = config.treatMissingFieldsAsNull === true;
     var operationLoader = config.operationLoader;
@@ -29,6 +30,12 @@ var RelayModernEnvironment = /*#__PURE__*/function () {
         !(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;
       }
     }
+    var store = (_config$store = config.store) !== null && _config$store !== void 0 ? _config$store : new RelayModernStore(new RelayRecordSource(), {
+      log: config.log,
+      operationLoader: config.operationLoader,
+      getDataID: config.getDataID,
+      shouldProcessClientComponents: config.shouldProcessClientComponents
+    });
     this.__log = (_config$log = config.log) !== null && _config$log !== void 0 ? _config$log : emptyFunction;
     this.relayFieldLogger = (_config$relayFieldLog = config.relayFieldLogger) !== null && _config$relayFieldLog !== void 0 ? _config$relayFieldLog : defaultRelayFieldLogger;
     this._defaultRenderPolicy = (_config$UNSTABLE_defa = config.UNSTABLE_defaultRenderPolicy) !== null && _config$UNSTABLE_defa !== void 0 ? _config$UNSTABLE_defa : 'partial';
@@ -37,9 +44,9 @@ var RelayModernEnvironment = /*#__PURE__*/function () {
     this._network = wrapNetworkWithLogObserver(this, config.network);
     this._getDataID = (_config$getDataID = config.getDataID) !== null && _config$getDataID !== void 0 ? _config$getDataID : defaultGetDataID;
     this._missingFieldHandlers = (_config$missingFieldH = config.missingFieldHandlers) !== null && _config$missingFieldH !== void 0 ? _config$missingFieldH : [];
-    this._publishQueue = new RelayPublishQueue(config.store, (_config$handlerProvid = config.handlerProvider) !== null && _config$handlerProvid !== void 0 ? _config$handlerProvid : RelayDefaultHandlerProvider, this._getDataID, this._missingFieldHandlers);
+    this._publishQueue = new RelayPublishQueue(store, (_config$handlerProvid = config.handlerProvider) !== null && _config$handlerProvid !== void 0 ? _config$handlerProvid : RelayDefaultHandlerProvider, this._getDataID, this._missingFieldHandlers, this.__log);
     this._scheduler = (_config$scheduler = config.scheduler) !== null && _config$scheduler !== void 0 ? _config$scheduler : null;
-    this._store = config.store;
+    this._store = store;
     this.options = config.options;
     this._isServer = (_config$isServer = config.isServer) !== null && _config$isServer !== void 0 ? _config$isServer : false;
     this._normalizeResponse = (_config$normalizeResp = config.normalizeResponse) !== null && _config$normalizeResp !== void 0 ? _config$normalizeResp : normalizeResponse;
@@ -199,7 +206,9 @@ var RelayModernEnvironment = /*#__PURE__*/function () {
     var operation = _ref.operation;
     return this._execute({
       createSource: function createSource() {
-        return _this7.getNetwork().execute(operation.request.node.params, operation.request.variables, operation.request.cacheConfig || {}, null);
+        return _this7.getNetwork().execute(operation.request.node.params, operation.request.variables, operation.request.cacheConfig || {}, null, undefined, undefined, undefined, function () {
+          return _this7.check(operation);
+        });
       },
       isClientPayload: false,
       operation: operation,

package/lib/store/RelayModernFragmentSpecResolver.js

@@ -132,14 +132,14 @@ var SelectorResolver = /*#__PURE__*/function () {
     (0, _defineProperty2["default"])(this, "_onChange", function (snapshot) {
       _this2._data = snapshot.data;
       _this2._isMissingData = snapshot.isMissingData;
-      _this2._errorResponseFields = snapshot.errorResponseFields;
+      _this2._fieldErrors = snapshot.fieldErrors;
       _this2._callback();
     });
     var _snapshot = environment.lookup(selector);
     this._callback = callback;
     this._data = _snapshot.data;
     this._isMissingData = _snapshot.isMissingData;
-    this._errorResponseFields = _snapshot.errorResponseFields;
+    this._fieldErrors = _snapshot.fieldErrors;
     this._environment = environment;
     this._rootIsQueryRenderer = rootIsQueryRenderer;
     this._selector = selector;
@@ -182,7 +182,7 @@ var SelectorResolver = /*#__PURE__*/function () {
         }
       }
     }
-    handlePotentialSnapshotErrors(this._environment, this._errorResponseFields);
+    handlePotentialSnapshotErrors(this._environment, this._fieldErrors);
     return this._data;
   };
   _proto2.setSelector = function setSelector(selector) {
@@ -193,7 +193,7 @@ var SelectorResolver = /*#__PURE__*/function () {
     var snapshot = this._environment.lookup(selector);
     this._data = recycleNodesInto(this._data, snapshot.data);
     this._isMissingData = snapshot.isMissingData;
-    this._errorResponseFields = snapshot.errorResponseFields;
+    this._fieldErrors = snapshot.fieldErrors;
     this._selector = selector;
     this._subscription = this._environment.subscribe(snapshot, this._onChange);
   };

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);
@@ -107,10 +108,11 @@ var RelayModernStore = /*#__PURE__*/function () {
     }
   };
   _proto.check = function check(operation, options) {
-    var _options$handlers, _options$getSourceFor, _options$getTargetFor, _options$defaultActor;
+    var _ref, _operation$request$no, _operation$request$no2, _options$handlers, _options$getSourceFor, _options$getTargetFor, _options$defaultActor;
     var selector = operation.root;
     var source = this._getMutableRecordSource();
     var globalInvalidationEpoch = this._globalInvalidationEpoch;
+    var useExecTimeResolvers = (_ref = (_operation$request$no = operation.request.node.operation.use_exec_time_resolvers) !== null && _operation$request$no !== void 0 ? _operation$request$no : ((_operation$request$no2 = operation.request.node.operation.exec_time_resolvers_enabled_provider) === null || _operation$request$no2 === void 0 ? void 0 : _operation$request$no2.get()) === true) !== null && _ref !== void 0 ? _ref : false;
     var rootEntry = this._roots.get(operation.request.identifier);
     var operationLastWrittenAt = rootEntry != null ? rootEntry.epoch : null;
     if (globalInvalidationEpoch != null) {
@@ -129,7 +131,7 @@ var RelayModernStore = /*#__PURE__*/function () {
       assertInternalActorIdentifier(actorIdentifier);
       return source;
     };
-    var operationAvailability = DataChecker.check(getSourceForActor, getTargetForActor, (_options$defaultActor = options === null || options === void 0 ? void 0 : options.defaultActorIdentifier) !== null && _options$defaultActor !== void 0 ? _options$defaultActor : INTERNAL_ACTOR_IDENTIFIER_DO_NOT_USE, selector, handlers, this._operationLoader, this._getDataID, this._shouldProcessClientComponents, this.__log);
+    var operationAvailability = DataChecker.check(getSourceForActor, getTargetForActor, (_options$defaultActor = options === null || options === void 0 ? void 0 : options.defaultActorIdentifier) !== null && _options$defaultActor !== void 0 ? _options$defaultActor : INTERNAL_ACTOR_IDENTIFIER_DO_NOT_USE, selector, handlers, this._operationLoader, this._getDataID, this._shouldProcessClientComponents, this.__log, useExecTimeResolvers);
     return getAvailabilityStatus(operationAvailability, operationLastWrittenAt, rootEntry === null || rootEntry === void 0 ? void 0 : rootEntry.fetchTime, this._queryCacheExpirationTime);
   };
   _proto.retain = function retain(operation) {
@@ -150,13 +152,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 +420,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,13 +432,29 @@ 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 _ref2, _operation$request$no3, _operation$request$no4;
+          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);
+          var useExecTimeResolvers = (_ref2 = (_operation$request$no3 = operation.request.node.operation.use_exec_time_resolvers) !== null && _operation$request$no3 !== void 0 ? _operation$request$no3 : ((_operation$request$no4 = operation.request.node.operation.exec_time_resolvers_enabled_provider) === null || _operation$request$no4 === void 0 ? void 0 : _operation$request$no4.get()) === true) !== null && _ref2 !== void 0 ? _ref2 : false;
+          RelayReferenceMarker.mark(this._recordSource, selector, references, this._operationLoader, this._shouldProcessClientComponents, useExecTimeResolvers);
           yield;
           if (startEpoch !== this._currentWriteEpoch) {
             if (log != null) {
@@ -445,21 +470,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 +500,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;