react-relay 2.0.0-rc.2 → 5.0.0

package/lib/writeRelayUpdatePayload.js

@@ -1,513 +0,0 @@
-/**
- * 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.
- *
- * 
- * @format
- */
-'use strict';
-
-var _objectSpread2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/objectSpread"));
-
-var APPEND = require("relay-runtime").RangeOperations.APPEND,
-    IGNORE = require("relay-runtime").RangeOperations.IGNORE,
-    PREPEND = require("relay-runtime").RangeOperations.PREPEND,
-    REFETCH = require("relay-runtime").RangeOperations.REFETCH,
-    REMOVE = require("relay-runtime").RangeOperations.REMOVE;
-
-var _edgesField;
-
-function getEdgesField() {
-  if (!_edgesField) {
-    _edgesField = require("./RelayQuery").Field.build({
-      fieldName: require("relay-runtime").ConnectionInterface.get().EDGES,
-      type: require("./RelayNodeInterface").ANY_TYPE,
-      metadata: {
-        canHaveSubselections: true,
-        isPlural: true
-      }
-    });
-  }
-
-  return _edgesField;
-}
-
-var STUB_CURSOR_ID = 'client:cursor';
-/**
- * @internal
- *
- * Applies the results of an update operation (mutation/subscription) to the
- * store.
- */
-
-function writeRelayUpdatePayload(writer, operation, payload, _ref) {
-  var configs = _ref.configs,
-      isOptimisticUpdate = _ref.isOptimisticUpdate;
-  configs.forEach(function (config) {
-    switch (config.type) {
-      case require("relay-runtime").MutationTypes.NODE_DELETE:
-        handleNodeDelete(writer, payload, config);
-        break;
-
-      case require("relay-runtime").MutationTypes.RANGE_ADD:
-        handleRangeAdd(writer, payload, operation, config, isOptimisticUpdate);
-        break;
-
-      case require("relay-runtime").MutationTypes.RANGE_DELETE:
-        handleRangeDelete(writer, payload, config);
-        break;
-
-      case require("relay-runtime").MutationTypes.FIELDS_CHANGE:
-      case require("relay-runtime").MutationTypes.REQUIRED_CHILDREN:
-        break;
-
-      default:
-        console.error('Expected a valid mutation handler type, got `%s`.', config.type);
-    }
-  });
-  handleMerge(writer, payload, operation);
-}
-/**
- * Handles the payload for a node deletion mutation, reading the ID of the node
- * to delete from the payload based on the config and then deleting references
- * to the node.
- */
-
-
-function handleNodeDelete(writer, payload, config) {
-  var recordIDs = payload[config.deletedIDFieldName];
-
-  if (!recordIDs) {
-    // for some mutations, deletions don't always occur so if there's no field
-    // in the payload, carry on
-    return;
-  }
-
-  if (Array.isArray(recordIDs)) {
-    recordIDs.forEach(function (id) {
-      /* $FlowFixMe(>=0.36.0) Flow error detected during
-       * the deploy of Flow v0.36.0. To see the error, remove this comment and
-       * run Flow */
-      deleteRecord(writer, id);
-    });
-  } else {
-    // $FlowFixMe(>=0.33.0)
-    deleteRecord(writer, recordIDs);
-  }
-}
-/**
- * Deletes the record from the store, also removing any references to the node
- * from any ranges that contain it (along with the containing edges).
- */
-
-
-function deleteRecord(writer, recordID) {
-  var store = writer.getRecordStore();
-  var recordWriter = writer.getRecordWriter(); // skip if already deleted
-
-  var status = store.getRecordState(recordID);
-
-  if (status === require("./RelayClassicRecordState").NONEXISTENT) {
-    return;
-  } // Delete the node from any ranges it may be a part of
-
-
-  var connectionIDs = store.getConnectionIDsForRecord(recordID);
-
-  if (connectionIDs) {
-    connectionIDs.forEach(function (connectionID) {
-      var edgeID = require("./generateClientEdgeID")(connectionID, recordID);
-
-      recordWriter.applyRangeUpdate(connectionID, edgeID, REMOVE);
-      writer.recordUpdate(edgeID);
-      writer.recordUpdate(connectionID); // edges are never nodes, so this will not infinitely recurse
-
-      deleteRecord(writer, edgeID);
-    });
-  } // delete the node
-
-
-  recordWriter.deleteRecord(recordID);
-  writer.recordUpdate(recordID);
-}
-/**
- * Handles merging the results of the mutation/subscription into the store,
- * updating each top-level field in the data according the fetched
- * fields/fragments.
- */
-
-
-function handleMerge(writer, payload, operation) {
-  var store = writer.getRecordStore(); // because optimistic payloads may not contain all fields, we loop over
-  // the data that is present and then have to recurse the query to find
-  // the matching fields.
-  //
-  // TODO #7167718: more efficient mutation/subscription writes
-
-  for (var fieldName in payload) {
-    if (!Object.prototype.hasOwnProperty.call(payload, fieldName)) {
-      continue;
-    }
-
-    var payloadData = payload[fieldName]; // #9357395
-
-    if (typeof payloadData !== 'object' || payloadData == null) {
-      continue;
-    } // check for valid data (has an ID or is an array) and write the field
-
-
-    if (require("./RelayNodeInterface").ID in payloadData || // if the field is an argument-less root call, determine the corresponding
-    // root record ID
-    store.getDataID(fieldName) || Array.isArray(payloadData)) {
-      mergeField(writer, fieldName, payloadData, operation);
-    }
-  }
-}
-/**
- * Merges the results of a single top-level field into the store.
- */
-
-
-function mergeField(writer, fieldName, payload, operation) {
-  // don't write mutation/subscription metadata fields
-  var _ConnectionInterface$ = require("relay-runtime").ConnectionInterface.get(),
-      CLIENT_MUTATION_ID = _ConnectionInterface$.CLIENT_MUTATION_ID;
-
-  if (fieldName === 'error' || fieldName === CLIENT_MUTATION_ID) {
-    return;
-  }
-
-  if (Array.isArray(payload)) {
-    payload.forEach(function (item) {
-      if (typeof item === 'object' && item != null && !Array.isArray(item)) {
-        if (getString(item, require("./RelayNodeInterface").ID)) {
-          mergeField(writer, fieldName, item, operation);
-        }
-      }
-    });
-    return;
-  } // reassign to preserve type information in below closure
-
-
-  var payloadData = payload;
-  var store = writer.getRecordStore();
-  var recordID = getString(payloadData, require("./RelayNodeInterface").ID);
-  var path;
-
-  if (recordID != null) {
-    path = require("./RelayQueryPath").createForID(recordID, 'writeRelayUpdatePayload');
-  } else {
-    recordID = store.getDataID(fieldName);
-
-    if (!recordID) {
-      !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Expected a record ID in the response ' + 'payload supplied to update the store for field `%s`, ' + 'payload keys [%s], operation name `%s`.', fieldName, Object.keys(payload).join(', '), operation.getName()) : require("fbjs/lib/invariant")(false) : void 0;
-    } // Root fields that do not accept arguments
-
-
-    path = require("./RelayQueryPath").create(require("./RelayQuery").Root.build('writeRelayUpdatePayload', fieldName, null, null, {
-      identifyingArgName: null,
-      identifyingArgType: null,
-      isAbstract: true,
-      isDeferred: false,
-      isPlural: false
-    }, require("./RelayNodeInterface").ANY_TYPE));
-  } // write the results for only the current field, for every instance of that
-  // field in any subfield/fragment in the query.
-
-
-  var handleNode = function handleNode(node) {
-    node.getChildren().forEach(function (child) {
-      if (child instanceof require("./RelayQuery").Fragment) {
-        handleNode(child);
-      } else if (child instanceof require("./RelayQuery").Field && child.getSerializationKey() === fieldName) {
-        // for flow: types are lost in closures
-        if (path && recordID) {
-          // ensure the record exists and then update it
-          writer.createRecordIfMissing(child, recordID, path, payloadData);
-          writer.writePayload(child, recordID, payloadData, path);
-        }
-      }
-    });
-  };
-
-  handleNode(operation);
-}
-/**
- * Handles the payload for a range addition. The configuration specifies:
- * - which field in the payload contains data for the new edge
- * - the list of fetched ranges to which the edge should be added
- * - whether to append/prepend to each of those ranges
- */
-
-
-function handleRangeAdd(writer, payload, operation, config, isOptimisticUpdate) {
-  var _ConnectionInterface$2 = require("relay-runtime").ConnectionInterface.get(),
-      CLIENT_MUTATION_ID = _ConnectionInterface$2.CLIENT_MUTATION_ID;
-
-  var clientMutationID = getString(payload, CLIENT_MUTATION_ID);
-  !clientMutationID ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Expected operation `%s` to have a `%s`.', operation.getName(), CLIENT_MUTATION_ID) : require("fbjs/lib/invariant")(false) : void 0;
-  var store = writer.getRecordStore(); // Extracts the new edge from the payload
-
-  var edge = getObject(payload, config.edgeName);
-  var edgeNode = edge && getObject(edge, require("./RelayNodeInterface").NODE);
-
-  if (!edge || !edgeNode) {
-    return;
-  } // Extract the id of the node with the connection that we are adding to.
-
-
-  var connectionParentID = config.parentID;
-
-  if (!connectionParentID) {
-    var edgeSource = getObject(edge, 'source');
-
-    if (edgeSource) {
-      connectionParentID = getString(edgeSource, require("./RelayNodeInterface").ID);
-    }
-  }
-
-  !connectionParentID ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Cannot insert edge without a configured ' + '`parentID` or a `%s.source.id` field.', config.edgeName) : require("fbjs/lib/invariant")(false) : void 0;
-
-  var nodeID = getString(edgeNode, require("./RelayNodeInterface").ID) || require("./generateClientID")();
-
-  var cursor = edge.cursor || STUB_CURSOR_ID;
-  var edgeData = (0, _objectSpread2["default"])({}, edge, {
-    cursor: cursor,
-    node: (0, _objectSpread2["default"])({}, edgeNode, {
-      id: nodeID
-    })
-  }); // add the node to every connection for this field
-
-  var connectionIDs = store.getConnectionIDsForField(connectionParentID, config.connectionName);
-
-  if (connectionIDs) {
-    connectionIDs.forEach(function (connectionID) {
-      return addRangeNode(writer, operation, config, connectionID, nodeID, edgeData);
-    });
-  }
-
-  if (isOptimisticUpdate) {
-    // optimistic updates need to record the generated client ID for
-    // a to-be-created node
-    require("./RelayMutationTracker").putClientIDForMutation(nodeID, clientMutationID);
-  } else {
-    // non-optimistic updates check for the existence of a generated client
-    // ID (from the above `if` clause) and link the client ID to the actual
-    // server ID.
-    var clientNodeID = require("./RelayMutationTracker").getClientIDForMutation(clientMutationID);
-
-    if (clientNodeID) {
-      require("./RelayMutationTracker").updateClientServerIDMap(clientNodeID, nodeID);
-
-      require("./RelayMutationTracker").deleteClientIDForMutation(clientMutationID);
-    }
-  }
-}
-/**
- * Writes the node data for the given field to the store and prepends/appends
- * the node to the given connection.
- */
-
-
-function addRangeNode(writer, operation, config, connectionID, nodeID, edgeData) {
-  var store = writer.getRecordStore();
-  var recordWriter = writer.getRecordWriter();
-  var filterCalls = store.getRangeFilterCalls(connectionID);
-  var rangeBehavior = filterCalls ? require("./getRangeBehavior")(config.rangeBehaviors, filterCalls) : null; // no range behavior specified for this combination of filter calls
-
-  if (!rangeBehavior) {
-    process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(rangeBehavior, 'Using `null` as a rangeBehavior value is deprecated. Use `ignore` to avoid ' + 'refetching a range.') : void 0;
-    return;
-  }
-
-  if (rangeBehavior === IGNORE) {
-    return;
-  }
-
-  var edgeID = require("./generateClientEdgeID")(connectionID, nodeID);
-
-  var path = store.getPathToRecord(connectionID);
-  !path ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Expected a path for connection record, `%s`.', connectionID) : require("fbjs/lib/invariant")(false) : void 0;
-  var edgesField = getEdgesField();
-  path = require("./RelayQueryPath").getPath(path, edgesField, edgeID); // create the edge record
-
-  writer.createRecordIfMissing(edgesField, edgeID, path, edgeData); // write data for all `edges` fields
-  // TODO #7167718: more efficient mutation/subscription writes
-
-  var hasEdgeField = false;
-
-  var handleNode = function handleNode(node) {
-    node.getChildren().forEach(function (child) {
-      if (child instanceof require("./RelayQuery").Fragment) {
-        handleNode(child);
-      } else if (child instanceof require("./RelayQuery").Field && child.getSchemaName() === config.edgeName) {
-        hasEdgeField = true;
-
-        if (path) {
-          writer.writePayload(child, edgeID, edgeData, path);
-        }
-      }
-    });
-  };
-
-  handleNode(operation);
-  !hasEdgeField ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Expected mutation query to include the ' + 'relevant edge field, `%s`.', config.edgeName) : require("fbjs/lib/invariant")(false) : void 0; // append/prepend the item to the range.
-
-  if (rangeBehavior === APPEND || rangeBehavior === IGNORE || rangeBehavior === PREPEND || rangeBehavior === REFETCH || rangeBehavior === REMOVE) {
-    recordWriter.applyRangeUpdate(connectionID, edgeID, rangeBehavior);
-    writer.recordUpdate(connectionID);
-  } else {
-    console.error('writeRelayUpdatePayload(): invalid range operation `%s`, valid ' + 'options are `%s`, `%s`, `%s`, `%s`, or `%s`.', rangeBehavior, APPEND, PREPEND, IGNORE, REMOVE, REFETCH);
-  }
-}
-/**
- * Handles the payload for a range edge deletion, which removes the edge from
- * a specified range but does not delete the node for that edge. The config
- * specifies the path within the payload that contains the connection ID.
- */
-
-
-function handleRangeDelete(writer, payload, config) {
-  var store = writer.getRecordStore();
-  var recordIDs = null;
-
-  if (Array.isArray(config.deletedIDFieldName)) {
-    recordIDs = getIDsFromPath(store, config.deletedIDFieldName, payload);
-  } else {
-    recordIDs = payload[config.deletedIDFieldName]; // Coerce numbers to strings for backwards compatibility.
-
-    if (typeof recordIDs === 'number') {
-      process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(false, 'writeRelayUpdatePayload(): Expected `%s` to be a string, got the ' + 'number `%s`.', config.deletedIDFieldName, recordIDs) : void 0;
-      recordIDs = '' + recordIDs;
-    }
-
-    !(recordIDs == null || !Array.isArray(recordIDs) || typeof recordIDs !== 'string') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Expected `%s` to be an array/string, got `%s`.', config.deletedIDFieldName, JSON.stringify(recordIDs)) : require("fbjs/lib/invariant")(false) : void 0;
-
-    if (!Array.isArray(recordIDs)) {
-      recordIDs = [recordIDs];
-    }
-  }
-
-  !(recordIDs != null) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Missing ID(s) for deleted record at field `%s`.', config.deletedIDFieldName) : require("fbjs/lib/invariant")(false) : void 0; // Extract the id of the node with the connection that we are deleting from.
-
-  var connectionName = config.pathToConnection.pop();
-  var connectionParentIDs = getIDsFromPath(store, config.pathToConnection, payload); // Restore pathToConnection to its original state
-
-  config.pathToConnection.push(connectionName);
-
-  if (!connectionParentIDs) {
-    return;
-  }
-
-  var connectionParentID = connectionParentIDs[0];
-  var connectionIDs = store.getConnectionIDsForField(connectionParentID, connectionName);
-
-  if (connectionIDs) {
-    connectionIDs.forEach(function (connectionID) {
-      if (recordIDs) {
-        recordIDs.forEach(function (recordID) {
-          deleteRangeEdge(writer, connectionID, recordID);
-        });
-      }
-    });
-  }
-}
-/**
- * Removes an edge from a connection without modifying the node data.
- */
-
-
-function deleteRangeEdge(writer, connectionID, nodeID) {
-  var recordWriter = writer.getRecordWriter();
-
-  var edgeID = require("./generateClientEdgeID")(connectionID, nodeID);
-
-  recordWriter.applyRangeUpdate(connectionID, edgeID, REMOVE);
-  deleteRecord(writer, edgeID);
-  writer.recordUpdate(connectionID);
-}
-/**
- * Given a payload of data and a path of fields, extracts the `id` of the node(s)
- * specified by the path.
- *
- * Examples:
- * path: ['root', 'field']
- * data: {root: {field: {id: 'xyz'}}}
- *
- * path: ['root', 'field']
- * data: {root: {field: [{id: 'abc'}, {id: 'def'}]}}
- *
- * Returns:
- * ['xyz']
- *
- * ['abc', 'def']
- */
-
-
-function getIDsFromPath(store, path, payload) {
-  // We have a special case for the path for root nodes without ids like
-  // ['viewer']. We try to match it up with something in the root call mapping
-  // first.
-  if (path.length === 1) {
-    var rootCallID = store.getDataID(path[0]);
-
-    if (rootCallID) {
-      return [rootCallID];
-    }
-  }
-
-  var payloadItems = payload;
-  path.forEach(function (step, idx) {
-    if (!payloadItems || Array.isArray(payloadItems)) {
-      return;
-    }
-
-    if (idx === path.length - 1) {
-      payloadItems = getObjectOrArray(payloadItems, step);
-    } else {
-      payloadItems = getObject(payloadItems, step);
-    }
-  });
-
-  if (payloadItems) {
-    if (!Array.isArray(payloadItems)) {
-      payloadItems = [payloadItems];
-    }
-
-    return payloadItems.map(function (item) {
-      var id = getString(item, require("./RelayNodeInterface").ID);
-      !(id != null) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Expected `%s.id` to be a string.', path.join('.')) : require("fbjs/lib/invariant")(false) : void 0;
-      return id;
-    });
-  }
-
-  return null;
-}
-
-function getString(payload, field) {
-  var value = payload[field]; // Coerce numbers to strings for backwards compatibility.
-
-  if (typeof value === 'number') {
-    process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(false, 'writeRelayUpdatePayload(): Expected `%s` to be a string, got the ' + 'number `%s`.', field, value) : void 0;
-    value = '' + value;
-  }
-
-  !(value == null || typeof value === 'string') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Expected `%s` to be a string, got `%s`.', field, JSON.stringify(value)) : require("fbjs/lib/invariant")(false) : void 0;
-  return value;
-}
-
-function getObject(payload, field) {
-  var value = payload[field];
-  !(value == null || typeof value === 'object' && !Array.isArray(value)) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Expected `%s` to be an object, got `%s`.', field, JSON.stringify(value)) : require("fbjs/lib/invariant")(false) : void 0;
-  return value;
-}
-
-function getObjectOrArray(payload, field) {
-  var value = payload[field];
-  !(value == null || typeof value === 'object') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeRelayUpdatePayload(): Expected `%s` to be an object/array, got `%s`.', field, JSON.stringify(value)) : require("fbjs/lib/invariant")(false) : void 0;
-  return value;
-}
-
-module.exports = require("relay-runtime").RelayProfiler.instrument('writeRelayUpdatePayload', writeRelayUpdatePayload);