react-relay 12.0.0 → 13.0.0

package/lib/relay-hooks/FragmentResource.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -15,19 +15,32 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
 var LRUCache = require('./LRUCache');
 
+var _require = require('./QueryResource'),
+    getQueryResourceForEnvironment = _require.getQueryResourceForEnvironment;
+
+var SuspenseResource = require('./SuspenseResource');
+
 var invariant = require('invariant');
 
-var _require = require('relay-runtime'),
-    getFragmentIdentifier = _require.getFragmentIdentifier,
-    getPendingOperationsForFragment = _require.getPendingOperationsForFragment,
-    getSelector = _require.getSelector,
-    isPromise = _require.isPromise,
-    recycleNodesInto = _require.recycleNodesInto,
-    reportMissingRequiredFields = _require.reportMissingRequiredFields;
+var _require2 = require('relay-runtime'),
+    RelayFeatureFlags = _require2.RelayFeatureFlags,
+    _require2$__internal = _require2.__internal,
+    fetchQuery = _require2$__internal.fetchQuery,
+    getPromiseForActiveRequest = _require2$__internal.getPromiseForActiveRequest,
+    createOperationDescriptor = _require2.createOperationDescriptor,
+    getFragmentIdentifier = _require2.getFragmentIdentifier,
+    getPendingOperationsForFragment = _require2.getPendingOperationsForFragment,
+    getSelector = _require2.getSelector,
+    getVariablesFromFragment = _require2.getVariablesFromFragment,
+    isPromise = _require2.isPromise,
+    recycleNodesInto = _require2.recycleNodesInto,
+    reportMissingRequiredFields = _require2.reportMissingRequiredFields;
 
 var WEAKMAP_SUPPORTED = typeof WeakMap === 'function';
 // TODO: Fix to not rely on LRU. If the number of active fragments exceeds this
@@ -47,6 +60,28 @@ function isMissingData(snapshot) {
   return snapshot.isMissingData;
 }
 
+function hasMissingClientEdges(snapshot) {
+  var _snapshot$missingClie, _snapshot$missingClie2;
+
+  if (Array.isArray(snapshot)) {
+    return snapshot.some(function (s) {
+      var _s$missingClientEdges, _s$missingClientEdges2;
+
+      return ((_s$missingClientEdges = (_s$missingClientEdges2 = s.missingClientEdges) === null || _s$missingClientEdges2 === void 0 ? void 0 : _s$missingClientEdges2.length) !== null && _s$missingClientEdges !== void 0 ? _s$missingClientEdges : 0) > 0;
+    });
+  }
+
+  return ((_snapshot$missingClie = (_snapshot$missingClie2 = snapshot.missingClientEdges) === null || _snapshot$missingClie2 === void 0 ? void 0 : _snapshot$missingClie2.length) !== null && _snapshot$missingClie !== void 0 ? _snapshot$missingClie : 0) > 0;
+}
+
+function singularOrPluralForEach(snapshot, f) {
+  if (Array.isArray(snapshot)) {
+    snapshot.forEach(f);
+  } else {
+    f(snapshot);
+  }
+}
+
 function getFragmentResult(cacheKey, snapshot, storeEpoch) {
   if (Array.isArray(snapshot)) {
     return {
@@ -68,11 +103,90 @@ function getFragmentResult(cacheKey, snapshot, storeEpoch) {
     storeEpoch: storeEpoch
   };
 }
+/**
+ * The purpose of this cache is to allow information to be passed from an
+ * initial read which suspends through to the commit that follows a subsequent
+ * successful read. Specifically, the QueryResource result for the data fetch
+ * is passed through so that that query can be retained on commit.
+ */
+
+
+var ClientEdgeQueryResultsCache = /*#__PURE__*/function () {
+  function ClientEdgeQueryResultsCache(environment) {
+    (0, _defineProperty2["default"])(this, "_cache", new Map());
+    (0, _defineProperty2["default"])(this, "_retainCounts", new Map());
+    this._environment = environment;
+  }
+
+  var _proto = ClientEdgeQueryResultsCache.prototype;
+
+  _proto.get = function get(fragmentIdentifier) {
+    var _this$_cache$get$, _this$_cache$get;
+
+    return (_this$_cache$get$ = (_this$_cache$get = this._cache.get(fragmentIdentifier)) === null || _this$_cache$get === void 0 ? void 0 : _this$_cache$get[0]) !== null && _this$_cache$get$ !== void 0 ? _this$_cache$get$ : undefined;
+  };
+
+  _proto.recordQueryResults = function recordQueryResults(fragmentIdentifier, value) {
+    var _this = this;
+
+    var existing = this._cache.get(fragmentIdentifier);
+
+    if (!existing) {
+      var suspenseResource = new SuspenseResource(function () {
+        return _this._retain(fragmentIdentifier);
+      });
+
+      this._cache.set(fragmentIdentifier, [value, suspenseResource]);
+
+      suspenseResource.temporaryRetain(this._environment);
+    } else {
+      var existingResults = existing[0],
+          _suspenseResource = existing[1];
+      value.forEach(function (queryResult) {
+        existingResults.push(queryResult);
+      });
+
+      _suspenseResource.temporaryRetain(this._environment);
+    }
+  };
+
+  _proto._retain = function _retain(id) {
+    var _this2 = this;
+
+    var _this$_retainCounts$g;
+
+    var retainCount = ((_this$_retainCounts$g = this._retainCounts.get(id)) !== null && _this$_retainCounts$g !== void 0 ? _this$_retainCounts$g : 0) + 1;
+
+    this._retainCounts.set(id, retainCount);
+
+    return {
+      dispose: function dispose() {
+        var _this$_retainCounts$g2;
+
+        var newRetainCount = ((_this$_retainCounts$g2 = _this2._retainCounts.get(id)) !== null && _this$_retainCounts$g2 !== void 0 ? _this$_retainCounts$g2 : 0) - 1;
+
+        if (newRetainCount > 0) {
+          _this2._retainCounts.set(id, newRetainCount);
+        } else {
+          _this2._retainCounts["delete"](id);
+
+          _this2._cache["delete"](id);
+        }
+      }
+    };
+  };
+
+  return ClientEdgeQueryResultsCache;
+}();
 
 var FragmentResourceImpl = /*#__PURE__*/function () {
   function FragmentResourceImpl(environment) {
     this._environment = environment;
     this._cache = LRUCache.create(CACHE_CAPACITY);
+
+    if (RelayFeatureFlags.ENABLE_CLIENT_EDGES) {
+      this._clientEdgeQueryResultsCache = new ClientEdgeQueryResultsCache(environment);
+    }
   }
   /**
    * This function should be called during a Component's render function,
@@ -81,9 +195,9 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
    */
 
 
-  var _proto = FragmentResourceImpl.prototype;
+  var _proto2 = FragmentResourceImpl.prototype;
 
-  _proto.read = function read(fragmentNode, fragmentRef, componentDisplayName, fragmentKey) {
+  _proto2.read = function read(fragmentNode, fragmentRef, componentDisplayName, fragmentKey) {
     return this.readWithIdentifier(fragmentNode, fragmentRef, getFragmentIdentifier(fragmentNode, fragmentRef), componentDisplayName, fragmentKey);
   }
   /**
@@ -93,8 +207,10 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
    */
   ;
 
-  _proto.readWithIdentifier = function readWithIdentifier(fragmentNode, fragmentRef, fragmentIdentifier, componentDisplayName, fragmentKey) {
-    var _fragmentNode$metadat;
+  _proto2.readWithIdentifier = function readWithIdentifier(fragmentNode, fragmentRef, fragmentIdentifier, componentDisplayName, fragmentKey) {
+    var _this3 = this;
+
+    var _fragmentNode$metadat, _clientEdgePromises;
 
     var environment = this._environment; // If fragmentRef is null or undefined, pass it directly through.
     // This is a convenience when consuming fragments via a HOC API, when the
@@ -171,18 +287,67 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
       });
 
       return fragmentResult;
-    } // 3. If we don't have data in the store, check if a request is in
-    // flight for the fragment's parent query, or for another operation
-    // that may affect the parent's query data, such as a mutation
-    // or subscription. If a promise exists, cache the promise and use it
-    // to suspend.
+    } // 3. If we don't have data in the store, there's two cases where we should
+    // suspend to await the data: First if any client edges were traversed where
+    // the destination record was missing data; in that case we initiate a query
+    // here to fetch the missing data. Second, there may already be a request
+    // in flight for the fragment's parent query, or for another operation that
+    //  may affect the parent's query data, such as a mutation or subscription.
+    // For any of these cases we can get a promise, which we will cache and
+    // suspend on.
+    // First, initiate a query for any client edges that were missing data:
+
+
+    var clientEdgeRequests = null;
+
+    if (RelayFeatureFlags.ENABLE_CLIENT_EDGES && hasMissingClientEdges(snapshot)) {
+      clientEdgeRequests = [];
+      var queryResource = getQueryResourceForEnvironment(this._environment);
+      var queryResults = [];
+      singularOrPluralForEach(snapshot, function (snap) {
+        var _snap$missingClientEd;
+
+        (_snap$missingClientEd = snap.missingClientEdges) === null || _snap$missingClientEd === void 0 ? void 0 : _snap$missingClientEd.forEach(function (_ref) {
+          var _clientEdgeRequests;
+
+          var request = _ref.request,
+              clientEdgeDestinationID = _ref.clientEdgeDestinationID;
+
+          var _this3$_performClient = _this3._performClientEdgeQuery(queryResource, fragmentNode, fragmentRef, request, clientEdgeDestinationID),
+              queryResult = _this3$_performClient.queryResult,
+              requestDescriptor = _this3$_performClient.requestDescriptor;
+
+          queryResults.push(queryResult);
+          (_clientEdgeRequests = clientEdgeRequests) === null || _clientEdgeRequests === void 0 ? void 0 : _clientEdgeRequests.push(requestDescriptor);
+        });
+      }); // Store the query so that it can be retained when our own fragment is
+      // subscribed to. This merges with any existing query results:
+
+      !(this._clientEdgeQueryResultsCache != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Client edge query result cache should exist when ENABLE_CLIENT_EDGES is on.') : invariant(false) : void 0;
+
+      this._clientEdgeQueryResultsCache.recordQueryResults(fragmentIdentifier, queryResults);
+    }
+
+    var clientEdgePromises = null;
+
+    if (RelayFeatureFlags.ENABLE_CLIENT_EDGES && clientEdgeRequests) {
+      clientEdgePromises = clientEdgeRequests.map(function (request) {
+        return getPromiseForActiveRequest(_this3._environment, request);
+      }).filter(function (p) {
+        return p != null;
+      });
+    } // Finally look for operations in flight for our parent query:
 
 
     var fragmentOwner = fragmentSelector.kind === 'PluralReaderSelector' ? fragmentSelector.selectors[0].owner : fragmentSelector.owner;
 
-    var networkPromiseResult = this._getAndSavePromiseForFragmentRequestInFlight(fragmentIdentifier, fragmentNode, fragmentOwner, fragmentResult);
+    var parentQueryPromiseResult = this._getAndSavePromiseForFragmentRequestInFlight(fragmentIdentifier, fragmentNode, fragmentOwner, fragmentResult);
+
+    var parentQueryPromiseResultPromise = parentQueryPromiseResult === null || parentQueryPromiseResult === void 0 ? void 0 : parentQueryPromiseResult.promise; // for refinement
+
+    if (((_clientEdgePromises = clientEdgePromises) === null || _clientEdgePromises === void 0 ? void 0 : _clientEdgePromises.length) || isPromise(parentQueryPromiseResultPromise)) {
+      var _parentQueryPromiseRe, _clientEdgeRequests2, _clientEdgePromises2;
 
-    if (networkPromiseResult != null && isPromise(networkPromiseResult.promise)) {
       environment.__log({
         name: 'suspense.fragment',
         data: fragmentResult.data,
@@ -190,10 +355,10 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
         isRelayHooks: true,
         isPromiseCached: false,
         isMissingData: fragmentResult.isMissingData,
-        pendingOperations: networkPromiseResult.pendingOperations
+        pendingOperations: [].concat((0, _toConsumableArray2["default"])((_parentQueryPromiseRe = parentQueryPromiseResult === null || parentQueryPromiseResult === void 0 ? void 0 : parentQueryPromiseResult.pendingOperations) !== null && _parentQueryPromiseRe !== void 0 ? _parentQueryPromiseRe : []), (0, _toConsumableArray2["default"])((_clientEdgeRequests2 = clientEdgeRequests) !== null && _clientEdgeRequests2 !== void 0 ? _clientEdgeRequests2 : []))
       });
 
-      throw networkPromiseResult.promise;
+      throw ((_clientEdgePromises2 = clientEdgePromises) === null || _clientEdgePromises2 === void 0 ? void 0 : _clientEdgePromises2.length) ? Promise.all([parentQueryPromiseResultPromise].concat((0, _toConsumableArray2["default"])(clientEdgePromises))) : parentQueryPromiseResultPromise;
     }
 
     this._reportMissingRequiredFieldsInSnapshot(snapshot);
@@ -201,13 +366,30 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     return getFragmentResult(fragmentIdentifier, snapshot, storeEpoch);
   };
 
-  _proto._reportMissingRequiredFieldsInSnapshot = function _reportMissingRequiredFieldsInSnapshot(snapshot) {
-    var _this = this;
+  _proto2._performClientEdgeQuery = function _performClientEdgeQuery(queryResource, fragmentNode, fragmentRef, request, clientEdgeDestinationID) {
+    var originalVariables = getVariablesFromFragment(fragmentNode, fragmentRef);
+    var variables = (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, originalVariables), {}, {
+      id: clientEdgeDestinationID // TODO should be a reserved name
+
+    });
+    var operation = createOperationDescriptor(request, variables, {} //  TODO cacheConfig should probably inherent from parent operation
+    );
+    var fetchObservable = fetchQuery(this._environment, operation);
+    var queryResult = queryResource.prepare(operation, fetchObservable // TODO should inherent render policy etc. from parent operation
+    );
+    return {
+      requestDescriptor: operation.request,
+      queryResult: queryResult
+    };
+  };
+
+  _proto2._reportMissingRequiredFieldsInSnapshot = function _reportMissingRequiredFieldsInSnapshot(snapshot) {
+    var _this4 = this;
 
     if (Array.isArray(snapshot)) {
       snapshot.forEach(function (s) {
         if (s.missingRequiredFields != null) {
-          reportMissingRequiredFields(_this._environment, s.missingRequiredFields);
+          reportMissingRequiredFields(_this4._environment, s.missingRequiredFields);
         }
       });
     } else {
@@ -217,7 +399,7 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     }
   };
 
-  _proto.readSpec = function readSpec(fragmentNodes, fragmentRefs, componentDisplayName) {
+  _proto2.readSpec = function readSpec(fragmentNodes, fragmentRefs, componentDisplayName) {
     var result = {};
 
     for (var _key in fragmentNodes) {
@@ -227,8 +409,8 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     return result;
   };
 
-  _proto.subscribe = function subscribe(fragmentResult, callback) {
-    var _this2 = this;
+  _proto2.subscribe = function subscribe(fragmentResult, callback) {
+    var _this5 = this;
 
     var environment = this._environment;
     var cacheKey = fragmentResult.cacheKey;
@@ -253,25 +435,25 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     } // 3. Establish subscriptions on the snapshot(s)
 
 
-    var dataSubscriptions = [];
+    var disposables = [];
 
     if (Array.isArray(renderedSnapshot)) {
       !Array.isArray(currentSnapshot) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected snapshots to be plural. ' + "If you're seeing this, this is likely a bug in Relay.") : invariant(false) : void 0;
       currentSnapshot.forEach(function (snapshot, idx) {
-        dataSubscriptions.push(environment.subscribe(snapshot, function (latestSnapshot) {
+        disposables.push(environment.subscribe(snapshot, function (latestSnapshot) {
           var storeEpoch = environment.getStore().getEpoch();
 
-          _this2._updatePluralSnapshot(cacheKey, currentSnapshot, latestSnapshot, idx, storeEpoch);
+          _this5._updatePluralSnapshot(cacheKey, currentSnapshot, latestSnapshot, idx, storeEpoch);
 
           callback();
         }));
       });
     } else {
       !(currentSnapshot != null && !Array.isArray(currentSnapshot)) ? process.env.NODE_ENV !== "production" ? invariant(false, 'Relay: Expected snapshot to be singular. ' + "If you're seeing this, this is likely a bug in Relay.") : invariant(false) : void 0;
-      dataSubscriptions.push(environment.subscribe(currentSnapshot, function (latestSnapshot) {
+      disposables.push(environment.subscribe(currentSnapshot, function (latestSnapshot) {
         var storeEpoch = environment.getStore().getEpoch();
 
-        _this2._cache.set(cacheKey, {
+        _this5._cache.set(cacheKey, {
           kind: 'done',
           result: getFragmentResult(cacheKey, latestSnapshot, storeEpoch)
         });
@@ -280,22 +462,35 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
       }));
     }
 
+    if (RelayFeatureFlags.ENABLE_CLIENT_EDGES) {
+      var _this$_clientEdgeQuer, _this$_clientEdgeQuer2;
+
+      var clientEdgeQueryResults = (_this$_clientEdgeQuer = (_this$_clientEdgeQuer2 = this._clientEdgeQueryResultsCache) === null || _this$_clientEdgeQuer2 === void 0 ? void 0 : _this$_clientEdgeQuer2.get(cacheKey)) !== null && _this$_clientEdgeQuer !== void 0 ? _this$_clientEdgeQuer : undefined;
+
+      if (clientEdgeQueryResults === null || clientEdgeQueryResults === void 0 ? void 0 : clientEdgeQueryResults.length) {
+        var queryResource = getQueryResourceForEnvironment(this._environment);
+        clientEdgeQueryResults.forEach(function (queryResult) {
+          disposables.push(queryResource.retain(queryResult));
+        });
+      }
+    }
+
     return {
       dispose: function dispose() {
-        dataSubscriptions.map(function (s) {
+        disposables.forEach(function (s) {
           return s.dispose();
         });
 
-        _this2._cache["delete"](cacheKey);
+        _this5._cache["delete"](cacheKey);
       }
     };
   };
 
-  _proto.subscribeSpec = function subscribeSpec(fragmentResults, callback) {
-    var _this3 = this;
+  _proto2.subscribeSpec = function subscribeSpec(fragmentResults, callback) {
+    var _this6 = this;
 
     var disposables = Object.keys(fragmentResults).map(function (key) {
-      return _this3.subscribe(fragmentResults[key], callback);
+      return _this6.subscribe(fragmentResults[key], callback);
     });
     return {
       dispose: function dispose() {
@@ -306,7 +501,7 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     };
   };
 
-  _proto.checkMissedUpdates = function checkMissedUpdates(fragmentResult) {
+  _proto2.checkMissedUpdates = function checkMissedUpdates(fragmentResult) {
     var environment = this._environment;
     var renderedSnapshot = fragmentResult.snapshot;
 
@@ -361,6 +556,7 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     var updatedCurrentSnapshot = {
       data: updatedData,
       isMissingData: currentSnapshot.isMissingData,
+      missingClientEdges: currentSnapshot.missingClientEdges,
       seenRecords: currentSnapshot.seenRecords,
       selector: currentSnapshot.selector,
       missingRequiredFields: currentSnapshot.missingRequiredFields
@@ -376,16 +572,16 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     return [updatedData !== renderData, updatedCurrentSnapshot];
   };
 
-  _proto.checkMissedUpdatesSpec = function checkMissedUpdatesSpec(fragmentResults) {
-    var _this4 = this;
+  _proto2.checkMissedUpdatesSpec = function checkMissedUpdatesSpec(fragmentResults) {
+    var _this7 = this;
 
     return Object.keys(fragmentResults).some(function (key) {
-      return _this4.checkMissedUpdates(fragmentResults[key])[0];
+      return _this7.checkMissedUpdates(fragmentResults[key])[0];
     });
   };
 
-  _proto._getAndSavePromiseForFragmentRequestInFlight = function _getAndSavePromiseForFragmentRequestInFlight(cacheKey, fragmentNode, fragmentOwner, fragmentResult) {
-    var _this5 = this;
+  _proto2._getAndSavePromiseForFragmentRequestInFlight = function _getAndSavePromiseForFragmentRequestInFlight(cacheKey, fragmentNode, fragmentOwner, fragmentResult) {
+    var _this8 = this;
 
     var pendingOperationsResult = getPendingOperationsForFragment(this._environment, fragmentNode, fragmentOwner);
 
@@ -399,9 +595,9 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     var networkPromise = pendingOperationsResult.promise;
     var pendingOperations = pendingOperationsResult.pendingOperations;
     var promise = networkPromise.then(function () {
-      _this5._cache["delete"](cacheKey);
+      _this8._cache["delete"](cacheKey);
     })["catch"](function (error) {
-      _this5._cache["delete"](cacheKey);
+      _this8._cache["delete"](cacheKey);
     }); // $FlowExpectedError[prop-missing] Expando to annotate Promises.
 
     promise.displayName = networkPromise.displayName;
@@ -419,7 +615,7 @@ var FragmentResourceImpl = /*#__PURE__*/function () {
     };
   };
 
-  _proto._updatePluralSnapshot = function _updatePluralSnapshot(cacheKey, baseSnapshots, latestSnapshot, idx, storeEpoch) {
+  _proto2._updatePluralSnapshot = function _updatePluralSnapshot(cacheKey, baseSnapshots, latestSnapshot, idx, storeEpoch) {
     var _currentFragmentResul;
 
     var currentFragmentResult = this._cache.get(cacheKey);

package/lib/relay-hooks/InternalLogger.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/lib/relay-hooks/LRUCache.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/lib/relay-hooks/LazyLoadEntryPointContainer_DEPRECATED.react.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -11,14 +11,14 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var ProfilerContext = require('./ProfilerContext');
-
-var React = require('react');
-
 var preloadQuery_DEPRECATED = require('./preloadQuery_DEPRECATED');
 
+var ProfilerContext = require('./ProfilerContext');
+
 var useRelayEnvironment = require('./useRelayEnvironment');
 
+var React = require('react');
+
 var _require = require('react'),
     useContext = _require.useContext,
     useEffect = _require.useEffect,

package/lib/relay-hooks/MatchContainer.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -98,7 +98,7 @@ function MatchContainer(_ref2) {
 
   if (match != null && typeof match !== 'object') {
     throw new Error('MatchContainer: Expected `match` value to be an object or null/undefined.');
-  } // NOTE: the MatchPointer type has a $fragmentRefs field to ensure that only
+  } // NOTE: the MatchPointer type has a $fragmentSpreads field to ensure that only
   // an object that contains a FragmentSpread can be passed. If the fragment
   // spread matches, then the metadata fields below (__id, __fragments, etc.)
   // will be present. But they can be missing if all the fragment spreads use

package/lib/relay-hooks/ProfilerContext.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/lib/relay-hooks/QueryResource.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
@@ -19,16 +19,18 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 
 var LRUCache = require('./LRUCache');
 
-var invariant = require('invariant');
+var SuspenseResource = require('./SuspenseResource');
 
-var warning = require("fbjs/lib/warning");
+var invariant = require('invariant');
 
 var _require = require('relay-runtime'),
+    RelayFeatureFlags = _require.RelayFeatureFlags,
     isPromise = _require.isPromise;
 
+var warning = require("fbjs/lib/warning");
+
 var CACHE_CAPACITY = 1000;
 var DEFAULT_FETCH_POLICY = 'store-or-network';
-var DATA_RETENTION_TIMEOUT = 5 * 60 * 1000;
 var WEAKMAP_SUPPORTED = typeof WeakMap === 'function';
 
 function operationIsLiveQuery(operation) {
@@ -64,6 +66,77 @@ function getQueryResult(operation, cacheIdentifier) {
 var nextID = 200000;
 
 function createCacheEntry(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose) {
+  // There should be no behavior difference between createCacheEntry_new and
+  // createCacheEntry_old, and it doesn't directly relate to Client Edges.
+  // It was just a refactoring that was needed for Client Edges but that
+  // is behind the feature flag just in case there is any accidental breakage.
+  if (RelayFeatureFlags.REFACTOR_SUSPENSE_RESOURCE) {
+    return createCacheEntry_new(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose);
+  } else {
+    return createCacheEntry_old(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose);
+  }
+}
+
+function createCacheEntry_new(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose) {
+  var isLiveQuery = operationIsLiveQuery(operation);
+  var currentValue = value;
+  var currentNetworkSubscription = networkSubscription;
+  var suspenseResource = new SuspenseResource(function (environment) {
+    var retention = environment.retain(operation);
+    return {
+      dispose: function dispose() {
+        // Normally if this entry never commits, the request would've ended by the
+        // time this timeout expires and the temporary retain is released. However,
+        // we need to do this for live queries which remain open indefinitely.
+        if (isLiveQuery && currentNetworkSubscription != null) {
+          currentNetworkSubscription.unsubscribe();
+        }
+
+        retention.dispose();
+        onDispose(cacheEntry);
+      }
+    };
+  });
+  var cacheEntry = {
+    cacheIdentifier: cacheIdentifier,
+    id: nextID++,
+    processedPayloadsCount: 0,
+    operationAvailability: operationAvailability,
+    getValue: function getValue() {
+      return currentValue;
+    },
+    setValue: function setValue(val) {
+      currentValue = val;
+    },
+    getRetainCount: function getRetainCount() {
+      return suspenseResource.getRetainCount();
+    },
+    getNetworkSubscription: function getNetworkSubscription() {
+      return currentNetworkSubscription;
+    },
+    setNetworkSubscription: function setNetworkSubscription(subscription) {
+      if (isLiveQuery && currentNetworkSubscription != null) {
+        currentNetworkSubscription.unsubscribe();
+      }
+
+      currentNetworkSubscription = subscription;
+    },
+    temporaryRetain: function temporaryRetain(environment) {
+      return suspenseResource.temporaryRetain(environment);
+    },
+    permanentRetain: function permanentRetain(environment) {
+      return suspenseResource.permanentRetain(environment);
+    },
+    releaseTemporaryRetain: function releaseTemporaryRetain() {
+      suspenseResource.releaseTemporaryRetain();
+    }
+  };
+  return cacheEntry;
+}
+
+var DATA_RETENTION_TIMEOUT = 5 * 60 * 1000;
+
+function createCacheEntry_old(cacheIdentifier, operation, operationAvailability, value, networkSubscription, onDispose) {
   var isLiveQuery = operationIsLiveQuery(operation);
   var currentValue = value;
   var retainCount = 0;
@@ -202,8 +275,14 @@ var QueryResourceImpl = /*#__PURE__*/function () {
     var _this = this;
 
     (0, _defineProperty2["default"])(this, "_clearCacheEntry", function (cacheEntry) {
-      if (cacheEntry.getRetainCount() <= 0) {
+      // The new code does this retainCount <= 0 check within SuspenseResource
+      // before calling _clearCacheEntry, whereas with the old code we do it here.
+      if (RelayFeatureFlags.REFACTOR_SUSPENSE_RESOURCE) {
         _this._cache["delete"](cacheEntry.cacheIdentifier);
+      } else {
+        if (cacheEntry.getRetainCount() <= 0) {
+          _this._cache["delete"](cacheEntry.cacheIdentifier);
+        }
       }
     });
     this._environment = environment;

package/lib/relay-hooks/RelayEnvironmentProvider.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) Facebook, Inc. and its affiliates.
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.