relay-runtime 10.1.3 → 11.0.2

package/handlers/connection/ConnectionHandler.js.flow

@@ -19,6 +19,7 @@ const invariant = require('invariant');
 const warning = require('warning');
 
 const {generateClientID} = require('../../store/ClientID');
+const {getStableStorageKey} = require('../../store/RelayStoreUtils');
 
 import type {
   HandleFieldPayload,
@@ -145,10 +146,12 @@ function update(store: RecordSourceProxy, payload: HandleFieldPayload): void {
     let nextEdges = [];
     const args = payload.args;
     if (prevEdges && serverEdges) {
+      // $FlowFixMe[prop-missing]
       if (args.after != null) {
         // Forward pagination from the end of the connection: append edges
         if (
           clientPageInfo &&
+          // $FlowFixMe[prop-missing]
           args.after === clientPageInfo.getValue(END_CURSOR)
         ) {
           const nodeIDs = new Set();
@@ -164,10 +167,12 @@ function update(store: RecordSourceProxy, payload: HandleFieldPayload): void {
           );
           return;
         }
+        // $FlowFixMe[prop-missing]
       } else if (args.before != null) {
         // Backward pagination from the start of the connection: prepend edges
         if (
           clientPageInfo &&
+          // $FlowFixMe[prop-missing]
           args.before === clientPageInfo.getValue(START_CURSOR)
         ) {
           const nodeIDs = new Set();
@@ -199,10 +204,12 @@ function update(store: RecordSourceProxy, payload: HandleFieldPayload): void {
     }
     // Page info should be updated even if no new edge were returned.
     if (clientPageInfo && serverPageInfo) {
+      // $FlowFixMe[prop-missing]
       if (args.after == null && args.before == null) {
         // The connection was refetched from the beginning/end: replace
         // page_info
         clientPageInfo.copyFieldsFrom(serverPageInfo);
+        // $FlowFixMe[prop-missing]
       } else if (args.before != null || (args.after == null && args.last)) {
         clientPageInfo.setValue(
           !!serverPageInfo.getValue(HAS_PREV_PAGE),
@@ -212,6 +219,7 @@ function update(store: RecordSourceProxy, payload: HandleFieldPayload): void {
         if (typeof startCursor === 'string') {
           clientPageInfo.setValue(startCursor, START_CURSOR);
         }
+        // $FlowFixMe[prop-missing]
       } else if (args.after != null || (args.before == null && args.first)) {
         clientPageInfo.setValue(
           !!serverPageInfo.getValue(HAS_NEXT_PAGE),
@@ -273,6 +281,47 @@ function getConnection(
   return record.getLinkedRecord(handleKey, filters);
 }
 
+/**
+ * @public
+ *
+ * Given a record ID, the key of a connection field, and optional filters used
+ * to identify the connection, returns the connection ID.
+ *
+ * Example:
+ *
+ * Given that data has already been fetched on some user `<user-id>` on the `friends`
+ * field:
+ *
+ * ```
+ * fragment FriendsFragment on User {
+ *   friends(first: 10) @connection(key: "FriendsFragment_friends") {
+ *     edges {
+ *       node {
+ *         id
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The ID of the `friends` connection record can be accessed with:
+ *
+ * ```
+ * store => {
+ *   const connectionID = ConnectionHandler.getConnectionID('<user-id>', 'FriendsFragment_friends');
+ * }
+ * ```
+ */
+function getConnectionID(
+  recordID: DataID,
+  key: string,
+  filters?: ?Variables,
+): DataID {
+  const handleKey = getRelayHandleKey(CONNECTION, key, null);
+  const storageKey = getStableStorageKey(handleKey, filters);
+  return generateClientID(recordID, storageKey);
+}
+
 /**
  * @public
  *
@@ -369,6 +418,11 @@ function createEdge(
     edge = store.create(edgeID, edgeType);
   }
   edge.setLinkedRecord(node, NODE);
+  if (edge.getValue('cursor') == null) {
+    // Always use null instead of undefined value for cursor
+    // to avoid considering it as missing data
+    edge.setValue(null, 'cursor');
+  }
   return edge;
 }
 
@@ -504,6 +558,11 @@ function buildConnectionEdge(
   const edgeID = generateClientID(connection.getDataID(), EDGES, edgeIndex);
   const connectionEdge = store.create(edgeID, edge.getType());
   connectionEdge.copyFieldsFrom(edge);
+  if (connectionEdge.getValue('cursor') == null) {
+    // Always use null instead of undefined value for cursor
+    // to avoid considering it as missing data
+    connectionEdge.setValue(null, 'cursor');
+  }
   connection.setValue(edgeIndex + 1, NEXT_EDGE_INDEX);
   return connectionEdge;
 }
@@ -543,6 +602,7 @@ module.exports = {
   createEdge,
   deleteNode,
   getConnection,
+  getConnectionID,
   insertEdgeAfter,
   insertEdgeBefore,
   update,

package/handlers/connection/MutationHandlers.js.flow

@@ -13,6 +13,7 @@
 'use strict';
 
 const ConnectionHandler = require('./ConnectionHandler');
+const ConnectionInterface = require('./ConnectionInterface');
 
 const invariant = require('invariant');
 const warning = require('warning');
@@ -50,6 +51,7 @@ const DeleteEdgeHandler = {
     if (record == null) {
       return;
     }
+    // $FlowFixMe[prop-missing]
     const {connections} = payload.handleArgs;
     invariant(
       connections != null,
@@ -99,6 +101,7 @@ function edgeUpdater(
     if (record == null) {
       return;
     }
+    // $FlowFixMe[prop-missing]
     const {connections} = payload.handleArgs;
     invariant(
       connections != null,
@@ -120,11 +123,17 @@ function edgeUpdater(
       );
       return;
     }
+    const {NODE, EDGES} = ConnectionInterface.get();
     const serverEdgeList = serverEdges ?? [singleServerEdge];
     for (const serverEdge of serverEdgeList) {
       if (serverEdge == null) {
         continue;
       }
+      const serverNode = serverEdge.getLinkedRecord('node');
+      if (!serverNode) {
+        continue;
+      }
+      const serverNodeId = serverNode.getDataID();
       for (const connectionID of connections) {
         const connection = store.get(connectionID);
         if (connection == null) {
@@ -134,6 +143,14 @@ function edgeUpdater(
           );
           continue;
         }
+        const nodeAlreadyExistsInConnection = connection
+          .getLinkedRecords(EDGES)
+          ?.some(
+            edge => edge?.getLinkedRecord(NODE)?.getDataID() === serverNodeId,
+          );
+        if (nodeAlreadyExistsInConnection) {
+          continue;
+        }
         const clientEdge = ConnectionHandler.buildConnectionEdge(
           store,
           connection,
@@ -157,6 +174,7 @@ function nodeUpdater(
     if (record == null) {
       return;
     }
+    // $FlowFixMe[prop-missing]
     const {connections, edgeTypeName} = payload.handleArgs;
     invariant(
       connections != null,
@@ -180,11 +198,13 @@ function nodeUpdater(
       warning(false, 'MutationHandlers: Expected target node to exist.');
       return;
     }
+    const {NODE, EDGES} = ConnectionInterface.get();
     const serverNodeList = serverNodes ?? [singleServerNode];
     for (const serverNode of serverNodeList) {
       if (serverNode == null) {
         continue;
       }
+      const serverNodeId = serverNode.getDataID();
       for (const connectionID of connections) {
         const connection = store.get(connectionID);
         if (connection == null) {
@@ -194,6 +214,14 @@ function nodeUpdater(
           );
           continue;
         }
+        const nodeAlreadyExistsInConnection = connection
+          .getLinkedRecords(EDGES)
+          ?.some(
+            edge => edge?.getLinkedRecord(NODE)?.getDataID() === serverNodeId,
+          );
+        if (nodeAlreadyExistsInConnection) {
+          continue;
+        }
         const clientEdge = ConnectionHandler.createEdge(
           store,
           connection,

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v10.1.3
+ * Relay v11.0.2
  *
  * Copyright (c) Facebook, Inc. and its affiliates.
  *

package/index.js.flow

@@ -48,6 +48,7 @@ const createRelayContext = require('./store/createRelayContext');
 const deepFreeze = require('./util/deepFreeze');
 const fetchQuery = require('./query/fetchQuery');
 const fetchQueryInternal = require('./query/fetchQueryInternal');
+const fetchQuery_DEPRECATED = require('./query/fetchQuery_DEPRECATED');
 const getFragmentIdentifier = require('./util/getFragmentIdentifier');
 const getRelayHandleKey = require('./util/getRelayHandleKey');
 const getRequestIdentifier = require('./util/getRequestIdentifier');
@@ -97,6 +98,7 @@ export type {
   ReactFlightPayloadData,
   ReactFlightPayloadQuery,
   ReactFlightServerTree,
+  ReactFlightServerError,
   SubscribeFunction,
   Uploadable,
   UploadableMap,
@@ -108,10 +110,11 @@ export type {
   Subscription,
 } from './network/RelayObservable';
 export type {GraphQLTaggedNode} from './query/GraphQLTag';
+export type {TaskScheduler} from './store/OperationExecutor';
 export type {EnvironmentConfig} from './store/RelayModernEnvironment';
-export type {TaskScheduler} from './store/RelayModernQueryExecutor';
 export type {RecordState} from './store/RelayRecordState';
 export type {
+  ExecuteMutationConfig,
   FragmentMap,
   FragmentReference,
   FragmentSpecResolver,
@@ -134,8 +137,9 @@ export type {
   PluralReaderSelector,
   Props,
   PublishQueue,
-  ReactFlightPayloadDeserializer,
   ReactFlightClientResponse,
+  ReactFlightPayloadDeserializer,
+  ReactFlightServerErrorHandler,
   ReaderSelector,
   ReadOnlyRecordProxy,
   RecordProxy,
@@ -143,6 +147,7 @@ export type {
   RecordSourceSelectorProxy,
   RelayContext,
   RequestDescriptor,
+  RequiredFieldLogger,
   SelectorData,
   SelectorStoreUpdater,
   SingularReaderSelector,
@@ -287,7 +292,8 @@ module.exports = {
   applyOptimisticMutation,
   commitLocalUpdate,
   commitMutation,
-  fetchQuery,
+  fetchQuery: fetchQuery,
+  fetchQuery_DEPRECATED,
   isRelayModernEnvironment,
   requestSubscription,
 

package/lib/handlers/RelayDefaultHandlerProvider.js

@@ -14,7 +14,7 @@ var ConnectionHandler = require('./connection/ConnectionHandler');
 
 var MutationHandlers = require('./connection/MutationHandlers');
 
-var invariant = require("fbjs/lib/invariant");
+var invariant = require('invariant');
 
 function RelayDefaultHandlerProvider(handle) {
   switch (handle) {

package/lib/handlers/connection/ConnectionHandler.js

@@ -14,13 +14,16 @@ var ConnectionInterface = require('./ConnectionInterface');
 
 var getRelayHandleKey = require('../../util/getRelayHandleKey');
 
-var invariant = require("fbjs/lib/invariant");
+var invariant = require('invariant');
 
 var warning = require("fbjs/lib/warning");
 
 var _require = require('../../store/ClientID'),
     generateClientID = _require.generateClientID;
 
+var _require2 = require('../../store/RelayStoreUtils'),
+    getStableStorageKey = _require2.getStableStorageKey;
+
 var CONNECTION = 'connection'; // Per-instance incrementing index used to generate unique edge IDs
 
 var NEXT_EDGE_INDEX = '__connection_next_edge_index';
@@ -130,19 +133,23 @@ function update(store, payload) {
     var args = payload.args;
 
     if (prevEdges && _serverEdges) {
+      // $FlowFixMe[prop-missing]
       if (args.after != null) {
         // Forward pagination from the end of the connection: append edges
-        if (clientPageInfo && args.after === clientPageInfo.getValue(END_CURSOR)) {
+        if (clientPageInfo && // $FlowFixMe[prop-missing]
+        args.after === clientPageInfo.getValue(END_CURSOR)) {
           var nodeIDs = new Set();
           mergeEdges(prevEdges, nextEdges, nodeIDs);
           mergeEdges(_serverEdges, nextEdges, nodeIDs);
         } else {
           process.env.NODE_ENV !== "production" ? warning(false, 'Relay: Unexpected after cursor `%s`, edges must ' + 'be fetched from the end of the list (`%s`).', args.after, clientPageInfo && clientPageInfo.getValue(END_CURSOR)) : void 0;
           return;
-        }
+        } // $FlowFixMe[prop-missing]
+
       } else if (args.before != null) {
         // Backward pagination from the start of the connection: prepend edges
-        if (clientPageInfo && args.before === clientPageInfo.getValue(START_CURSOR)) {
+        if (clientPageInfo && // $FlowFixMe[prop-missing]
+        args.before === clientPageInfo.getValue(START_CURSOR)) {
           var _nodeIDs = new Set();
 
           mergeEdges(_serverEdges, nextEdges, _nodeIDs);
@@ -169,17 +176,19 @@ function update(store, payload) {
 
 
     if (clientPageInfo && serverPageInfo) {
+      // $FlowFixMe[prop-missing]
       if (args.after == null && args.before == null) {
         // The connection was refetched from the beginning/end: replace
         // page_info
-        clientPageInfo.copyFieldsFrom(serverPageInfo);
+        clientPageInfo.copyFieldsFrom(serverPageInfo); // $FlowFixMe[prop-missing]
       } else if (args.before != null || args.after == null && args.last) {
         clientPageInfo.setValue(!!serverPageInfo.getValue(HAS_PREV_PAGE), HAS_PREV_PAGE);
         var startCursor = serverPageInfo.getValue(START_CURSOR);
 
         if (typeof startCursor === 'string') {
           clientPageInfo.setValue(startCursor, START_CURSOR);
-        }
+        } // $FlowFixMe[prop-missing]
+
       } else if (args.after != null || args.before == null && args.first) {
         clientPageInfo.setValue(!!serverPageInfo.getValue(HAS_NEXT_PAGE), HAS_NEXT_PAGE);
         var endCursor = serverPageInfo.getValue(END_CURSOR);
@@ -235,6 +244,44 @@ function getConnection(record, key, filters) {
   var handleKey = getRelayHandleKey(CONNECTION, key, null);
   return record.getLinkedRecord(handleKey, filters);
 }
+/**
+ * @public
+ *
+ * Given a record ID, the key of a connection field, and optional filters used
+ * to identify the connection, returns the connection ID.
+ *
+ * Example:
+ *
+ * Given that data has already been fetched on some user `<user-id>` on the `friends`
+ * field:
+ *
+ * ```
+ * fragment FriendsFragment on User {
+ *   friends(first: 10) @connection(key: "FriendsFragment_friends") {
+ *     edges {
+ *       node {
+ *         id
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The ID of the `friends` connection record can be accessed with:
+ *
+ * ```
+ * store => {
+ *   const connectionID = ConnectionHandler.getConnectionID('<user-id>', 'FriendsFragment_friends');
+ * }
+ * ```
+ */
+
+
+function getConnectionID(recordID, key, filters) {
+  var handleKey = getRelayHandleKey(CONNECTION, key, null);
+  var storageKey = getStableStorageKey(handleKey, filters);
+  return generateClientID(recordID, storageKey);
+}
 /**
  * @public
  *
@@ -339,6 +386,13 @@ function createEdge(store, record, node, edgeType) {
   }
 
   edge.setLinkedRecord(node, NODE);
+
+  if (edge.getValue('cursor') == null) {
+    // Always use null instead of undefined value for cursor
+    // to avoid considering it as missing data
+    edge.setValue(null, 'cursor');
+  }
+
   return edge;
 }
 /**
@@ -484,6 +538,13 @@ function buildConnectionEdge(store, connection, edge) {
   var edgeID = generateClientID(connection.getDataID(), EDGES, edgeIndex);
   var connectionEdge = store.create(edgeID, edge.getType());
   connectionEdge.copyFieldsFrom(edge);
+
+  if (connectionEdge.getValue('cursor') == null) {
+    // Always use null instead of undefined value for cursor
+    // to avoid considering it as missing data
+    connectionEdge.setValue(null, 'cursor');
+  }
+
   connection.setValue(edgeIndex + 1, NEXT_EDGE_INDEX);
   return connectionEdge;
 }
@@ -526,6 +587,7 @@ module.exports = {
   createEdge: createEdge,
   deleteNode: deleteNode,
   getConnection: getConnection,
+  getConnectionID: getConnectionID,
   insertEdgeAfter: insertEdgeAfter,
   insertEdgeBefore: insertEdgeBefore,
   update: update

package/lib/handlers/connection/MutationHandlers.js

@@ -16,7 +16,9 @@ var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime
 
 var ConnectionHandler = require('./ConnectionHandler');
 
-var invariant = require("fbjs/lib/invariant");
+var ConnectionInterface = require('./ConnectionInterface');
+
+var invariant = require('invariant');
 
 var warning = require("fbjs/lib/warning");
 
@@ -45,7 +47,8 @@ var DeleteEdgeHandler = {
 
     if (record == null) {
       return;
-    }
+    } // $FlowFixMe[prop-missing]
+
 
     var connections = payload.handleArgs.connections;
     !(connections != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'MutationHandlers: Expected connection IDs to be specified.') : invariant(false) : void 0;
@@ -98,7 +101,8 @@ function edgeUpdater(insertFn) {
 
     if (record == null) {
       return;
-    }
+    } // $FlowFixMe[prop-missing]
+
 
     var connections = payload.handleArgs.connections;
     !(connections != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'MutationHandlers: Expected connection IDs to be specified.') : invariant(false) : void 0;
@@ -119,19 +123,31 @@ function edgeUpdater(insertFn) {
       return;
     }
 
+    var _ConnectionInterface$ = ConnectionInterface.get(),
+        NODE = _ConnectionInterface$.NODE,
+        EDGES = _ConnectionInterface$.EDGES;
+
     var serverEdgeList = (_serverEdges = serverEdges) !== null && _serverEdges !== void 0 ? _serverEdges : [singleServerEdge];
 
     var _iterator2 = (0, _createForOfIteratorHelper2["default"])(serverEdgeList),
         _step2;
 
     try {
-      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+      var _loop = function _loop() {
         var serverEdge = _step2.value;
 
         if (serverEdge == null) {
-          continue;
+          return "continue";
         }
 
+        var serverNode = serverEdge.getLinkedRecord('node');
+
+        if (!serverNode) {
+          return "continue";
+        }
+
+        var serverNodeId = serverNode.getDataID();
+
         var _iterator3 = (0, _createForOfIteratorHelper2["default"])(connections),
             _step3;
 
@@ -145,6 +161,16 @@ function edgeUpdater(insertFn) {
               continue;
             }
 
+            var nodeAlreadyExistsInConnection = (_connection$getLinked = connection.getLinkedRecords(EDGES)) === null || _connection$getLinked === void 0 ? void 0 : _connection$getLinked.some(function (edge) {
+              var _edge$getLinkedRecord;
+
+              return (edge === null || edge === void 0 ? void 0 : (_edge$getLinkedRecord = edge.getLinkedRecord(NODE)) === null || _edge$getLinkedRecord === void 0 ? void 0 : _edge$getLinkedRecord.getDataID()) === serverNodeId;
+            });
+
+            if (nodeAlreadyExistsInConnection) {
+              continue;
+            }
+
             var clientEdge = ConnectionHandler.buildConnectionEdge(store, connection, serverEdge);
             !(clientEdge != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'MutationHandlers: Failed to build the edge.') : invariant(false) : void 0;
             insertFn(connection, clientEdge);
@@ -154,6 +180,14 @@ function edgeUpdater(insertFn) {
         } finally {
           _iterator3.f();
         }
+      };
+
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        var _connection$getLinked;
+
+        var _ret = _loop();
+
+        if (_ret === "continue") continue;
       }
     } catch (err) {
       _iterator2.e(err);
@@ -171,7 +205,8 @@ function nodeUpdater(insertFn) {
 
     if (record == null) {
       return;
-    }
+    } // $FlowFixMe[prop-missing]
+
 
     var _payload$handleArgs = payload.handleArgs,
         connections = _payload$handleArgs.connections,
@@ -196,19 +231,25 @@ function nodeUpdater(insertFn) {
       return;
     }
 
+    var _ConnectionInterface$2 = ConnectionInterface.get(),
+        NODE = _ConnectionInterface$2.NODE,
+        EDGES = _ConnectionInterface$2.EDGES;
+
     var serverNodeList = (_serverNodes = serverNodes) !== null && _serverNodes !== void 0 ? _serverNodes : [singleServerNode];
 
     var _iterator4 = (0, _createForOfIteratorHelper2["default"])(serverNodeList),
         _step4;
 
     try {
-      for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+      var _loop2 = function _loop2() {
         var serverNode = _step4.value;
 
         if (serverNode == null) {
-          continue;
+          return "continue";
         }
 
+        var serverNodeId = serverNode.getDataID();
+
         var _iterator5 = (0, _createForOfIteratorHelper2["default"])(connections),
             _step5;
 
@@ -222,6 +263,16 @@ function nodeUpdater(insertFn) {
               continue;
             }
 
+            var nodeAlreadyExistsInConnection = (_connection$getLinked2 = connection.getLinkedRecords(EDGES)) === null || _connection$getLinked2 === void 0 ? void 0 : _connection$getLinked2.some(function (edge) {
+              var _edge$getLinkedRecord2;
+
+              return (edge === null || edge === void 0 ? void 0 : (_edge$getLinkedRecord2 = edge.getLinkedRecord(NODE)) === null || _edge$getLinkedRecord2 === void 0 ? void 0 : _edge$getLinkedRecord2.getDataID()) === serverNodeId;
+            });
+
+            if (nodeAlreadyExistsInConnection) {
+              continue;
+            }
+
             var clientEdge = ConnectionHandler.createEdge(store, connection, serverNode, edgeTypeName);
             !(clientEdge != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'MutationHandlers: Failed to build the edge.') : invariant(false) : void 0;
             insertFn(connection, clientEdge);
@@ -231,6 +282,14 @@ function nodeUpdater(insertFn) {
         } finally {
           _iterator5.f();
         }
+      };
+
+      for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+        var _connection$getLinked2;
+
+        var _ret2 = _loop2();
+
+        if (_ret2 === "continue") continue;
       }
     } catch (err) {
       _iterator4.e(err);

package/lib/index.js

@@ -80,6 +80,8 @@ var fetchQuery = require('./query/fetchQuery');
 
 var fetchQueryInternal = require('./query/fetchQueryInternal');
 
+var fetchQuery_DEPRECATED = require('./query/fetchQuery_DEPRECATED');
+
 var getFragmentIdentifier = require('./util/getFragmentIdentifier');
 
 var getRelayHandleKey = require('./util/getRelayHandleKey');
@@ -180,6 +182,7 @@ module.exports = {
   commitLocalUpdate: commitLocalUpdate,
   commitMutation: commitMutation,
   fetchQuery: fetchQuery,
+  fetchQuery_DEPRECATED: fetchQuery_DEPRECATED,
   isRelayModernEnvironment: isRelayModernEnvironment,
   requestSubscription: requestSubscription,
   // Configuration interface for legacy or special uses

package/lib/multi-actor-environment/ActorIdentifier.js

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+relay
+ * 
+ * @format
+ */
+'use strict';
+/**
+ * A unique identifier of the current actor.
+ */
+
+module.exports = {
+  getActorIdentifier: function getActorIdentifier(actorID) {
+    return actorID;
+  },
+  getDefaultActorIdentifier: function getDefaultActorIdentifier() {
+    throw new Error('Not Implemented');
+  }
+};