relay-runtime 1.7.0-rc.1 → 2.0.0

package/lib/RelayModernQueryExecutor.js

@@ -0,0 +1,172 @@
+/**
+ * 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.
+ *
+ *  strict-local
+ * @format
+ * @emails oncall+relay
+ */
+'use strict';
+
+/**
+ * Coordinates the execution of a query, handling network callbacks
+ * including optimistic payloads, standard payloads, resolution of match
+ * dependencies, etc.
+ */
+function execute(_ref) {
+  var network = _ref.network,
+      publishQueue = _ref.publishQueue,
+      operation = _ref.operation,
+      operationLoader = _ref.operationLoader,
+      cacheConfig = _ref.cacheConfig,
+      updater = _ref.updater;
+  return require("./RelayObservable").create(function (sink) {
+    var optimisticResponse = null;
+    var subscriptions = new Set();
+
+    function start(subscription) {
+      // NOTE: store the subscription object on the observer so that it
+      // can be cleaned up in complete() or the dispose function.
+      this._subscription = subscription;
+      subscriptions.add(subscription);
+    }
+
+    function complete() {
+      subscriptions["delete"](this._subscription);
+
+      if (subscriptions.size === 0) {
+        sink.complete();
+      }
+    } // Convert each GraphQLResponse from the network to a RelayResponsePayload
+    // and process it
+
+
+    function next(response) {
+      var _response$extensions;
+
+      var payload = require("./normalizePayload")(operation, response);
+
+      var isOptimistic = ((_response$extensions = response.extensions) === null || _response$extensions === void 0 ? void 0 : _response$extensions.isOptimistic) === true;
+      processRelayPayload(payload, operation, updater, isOptimistic);
+      sink.next(response);
+    } // Each RelayResponsePayload contains both data to publish to the store
+    // immediately, but may also contain matchPayloads that need to be
+    // asynchronously normalized into RelayResponsePayloads, which may
+    // themselves have matchPayloads: this function is recursive and relies
+    // on GraphQL queries *disallowing* recursion to ensure termination.
+
+
+    var processRelayPayload = function processRelayPayload(payload) {
+      var operationDescriptor = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
+      var payloadUpdater = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+      var isOptimistic = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
+      var matchPayloads = payload.matchPayloads;
+
+      if (matchPayloads && matchPayloads.length) {
+        !operationLoader ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayModernEnvironment: Expected an operationLoader to be ' + 'configured when using `@match`.') : require("fbjs/lib/invariant")(false) : void 0;
+        matchPayloads.forEach(function (matchPayload) {
+          processMatchPayload(processRelayPayload, operationLoader, matchPayload).subscribe({
+            complete: complete,
+            error: sink.error,
+            start: start
+          });
+        });
+      }
+
+      if (isOptimistic) {
+        !(optimisticResponse === null) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'environment.execute: only support one optimistic response per ' + 'execute.') : require("fbjs/lib/invariant")(false) : void 0;
+        optimisticResponse = {
+          source: payload.source,
+          fieldPayloads: payload.fieldPayloads
+        };
+        publishQueue.applyUpdate(optimisticResponse);
+        publishQueue.run();
+      } else {
+        if (optimisticResponse !== null) {
+          publishQueue.revertUpdate(optimisticResponse);
+          optimisticResponse = null;
+        }
+
+        if (operationDescriptor && payloadUpdater) {
+          publishQueue.commitPayload(operationDescriptor, payload, payloadUpdater);
+        } else {
+          publishQueue.commitRelayPayload(payload);
+        }
+
+        publishQueue.run();
+      }
+    };
+
+    var node = operation.node;
+    network.execute(node.params, operation.variables, cacheConfig || {}).subscribe({
+      complete: complete,
+      next: next,
+      error: sink.error,
+      start: start
+    });
+    return function () {
+      if (subscriptions.size !== 0) {
+        subscriptions.forEach(function (sub) {
+          return sub.unsubscribe();
+        });
+        subscriptions.clear();
+      }
+
+      if (optimisticResponse !== null) {
+        publishQueue.revertUpdate(optimisticResponse);
+        optimisticResponse = null;
+        publishQueue.run();
+      }
+    };
+  });
+}
+/**
+ * Processes a MatchFieldPayload, asynchronously resolving the fragment,
+ * using it to normalize the field data into a RelayResponsePayload.
+ * Because @match fields may contain other @match fields, the result of
+ * normalizing `matchPayload` may contain *other* MatchFieldPayloads:
+ * the processRelayPayload() callback is responsible for publishing
+ * both the normalize payload's source as well as recursively calling
+ * this function for any matchPayloads it contains.
+ *
+ * @private
+ */
+
+
+function processMatchPayload(processRelayPayload, operationLoader, matchPayload) {
+  return require("./RelayObservable").from(new Promise(function (resolve, reject) {
+    operationLoader.load(matchPayload.operationReference).then(resolve, reject);
+  })).map(function (operation) {
+    if (operation == null) {
+      return;
+    }
+
+    var selector = {
+      dataID: matchPayload.dataID,
+      variables: matchPayload.variables,
+      node: operation
+    };
+    var source = new (require("./RelayInMemoryRecordSource"))();
+
+    var matchRecord = require("./RelayModernRecord").create(matchPayload.dataID, matchPayload.typeName);
+
+    source.set(matchPayload.dataID, matchRecord);
+
+    var normalizeResult = require("./RelayResponseNormalizer").normalize(source, selector, matchPayload.data);
+
+    var relayPayload = {
+      errors: null,
+      // Errors are handled as part of the parent GraphQLResponse
+      fieldPayloads: normalizeResult.fieldPayloads,
+      matchPayloads: normalizeResult.matchPayloads,
+      source: source
+    };
+    processRelayPayload(relayPayload);
+  });
+}
+
+module.exports = {
+  execute: execute
+};

package/lib/RelayModernRecord.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2013-present, Facebook, Inc.
+ * 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.
@@ -7,12 +7,9 @@
  * 
  * @format
  */
-
 'use strict';
 
-var _extends3 = _interopRequireDefault(require('babel-runtime/helpers/extends'));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
+var _objectSpread2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/objectSpread"));
 
 /**
  * @public
@@ -64,9 +61,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'd
  * Clone a record.
  */
 function clone(record) {
-  return (0, _extends3['default'])({}, record);
+  return (0, _objectSpread2["default"])({}, record);
 }
-
 /**
  * @public
  *
@@ -77,91 +73,104 @@ function clone(record) {
  * copied by reference and not value; callers should ensure that values are
  * copied on write.
  */
+
+
 function copyFields(source, sink) {
   for (var key in source) {
     if (source.hasOwnProperty(key)) {
-      if (key !== require('./RelayStoreUtils').ID_KEY && key !== require('./RelayStoreUtils').TYPENAME_KEY) {
+      if (key !== require("./RelayStoreUtils").ID_KEY && key !== require("./RelayStoreUtils").TYPENAME_KEY) {
         sink[key] = source[key];
       }
     }
   }
 }
-
 /**
  * @public
  *
  * Create a new record.
  */
+
+
 function create(dataID, typeName) {
   // See perf note above for why we aren't using computed property access.
   var record = {};
-  record[require('./RelayStoreUtils').ID_KEY] = dataID;
-  record[require('./RelayStoreUtils').TYPENAME_KEY] = typeName;
+  record[require("./RelayStoreUtils").ID_KEY] = dataID;
+  record[require("./RelayStoreUtils").TYPENAME_KEY] = typeName;
   return record;
 }
-
 /**
  * @public
  *
  * Get the record's `id` if available or the client-generated identifier.
  */
+
+
 function getDataID(record) {
-  return record[require('./RelayStoreUtils').ID_KEY];
+  return record[require("./RelayStoreUtils").ID_KEY];
 }
-
 /**
  * @public
  *
  * Get the concrete type of the record.
  */
+
+
 function getType(record) {
-  return record[require('./RelayStoreUtils').TYPENAME_KEY];
+  return record[require("./RelayStoreUtils").TYPENAME_KEY];
 }
-
 /**
  * @public
  *
  * Get a scalar (non-link) field value.
  */
+
+
 function getValue(record, storageKey) {
   var value = record[storageKey];
+
   if (value && typeof value === 'object') {
-    !(!value.hasOwnProperty(require('./RelayStoreUtils').REF_KEY) && !value.hasOwnProperty(require('./RelayStoreUtils').REFS_KEY)) ? process.env.NODE_ENV !== 'production' ? require('fbjs/lib/invariant')(false, 'RelayModernRecord.getValue(): Expected a scalar (non-link) value for `%s.%s` ' + 'but found %s.', record[require('./RelayStoreUtils').ID_KEY], storageKey, value.hasOwnProperty(require('./RelayStoreUtils').REF_KEY) ? 'a linked record' : 'plural linked records') : require('fbjs/lib/invariant')(false) : void 0;
+    !(!value.hasOwnProperty(require("./RelayStoreUtils").REF_KEY) && !value.hasOwnProperty(require("./RelayStoreUtils").REFS_KEY)) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayModernRecord.getValue(): Expected a scalar (non-link) value for `%s.%s` ' + 'but found %s.', record[require("./RelayStoreUtils").ID_KEY], storageKey, value.hasOwnProperty(require("./RelayStoreUtils").REF_KEY) ? 'a linked record' : 'plural linked records') : require("fbjs/lib/invariant")(false) : void 0;
   }
+
   return value;
 }
-
 /**
  * @public
  *
  * Get the value of a field as a reference to another record. Throws if the
  * field has a different type.
  */
+
+
 function getLinkedRecordID(record, storageKey) {
   var link = record[storageKey];
+
   if (link == null) {
     return link;
   }
-  !(typeof link === 'object' && link && typeof link[require('./RelayStoreUtils').REF_KEY] === 'string') ? process.env.NODE_ENV !== 'production' ? require('fbjs/lib/invariant')(false, 'RelayModernRecord.getLinkedRecordID(): Expected `%s.%s` to be a linked ID, ' + 'was `%s`.', record[require('./RelayStoreUtils').ID_KEY], storageKey, link) : require('fbjs/lib/invariant')(false) : void 0;
-  return link[require('./RelayStoreUtils').REF_KEY];
-}
 
+  !(typeof link === 'object' && link && typeof link[require("./RelayStoreUtils").REF_KEY] === 'string') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayModernRecord.getLinkedRecordID(): Expected `%s.%s` to be a linked ID, ' + 'was `%s`.', record[require("./RelayStoreUtils").ID_KEY], storageKey, JSON.stringify(link)) : require("fbjs/lib/invariant")(false) : void 0;
+  return link[require("./RelayStoreUtils").REF_KEY];
+}
 /**
  * @public
  *
  * Get the value of a field as a list of references to other records. Throws if
  * the field has a different type.
  */
+
+
 function getLinkedRecordIDs(record, storageKey) {
   var links = record[storageKey];
+
   if (links == null) {
     return links;
   }
-  !(typeof links === 'object' && Array.isArray(links[require('./RelayStoreUtils').REFS_KEY])) ? process.env.NODE_ENV !== 'production' ? require('fbjs/lib/invariant')(false, 'RelayModernRecord.getLinkedRecordIDs(): Expected `%s.%s` to contain an array ' + 'of linked IDs, got `%s`.', record[require('./RelayStoreUtils').ID_KEY], storageKey, JSON.stringify(links)) : require('fbjs/lib/invariant')(false) : void 0;
-  // assume items of the array are ids
-  return links[require('./RelayStoreUtils').REFS_KEY];
-}
 
+  !(typeof links === 'object' && Array.isArray(links[require("./RelayStoreUtils").REFS_KEY])) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayModernRecord.getLinkedRecordIDs(): Expected `%s.%s` to contain an array ' + 'of linked IDs, got `%s`.', record[require("./RelayStoreUtils").ID_KEY], storageKey, JSON.stringify(links)) : require("fbjs/lib/invariant")(false) : void 0; // assume items of the array are ids
+
+  return links[require("./RelayStoreUtils").REFS_KEY];
+}
 /**
  * @public
  *
@@ -169,73 +178,123 @@ function getLinkedRecordIDs(record, storageKey) {
  * previous record if all fields are equal or a new record (with merged fields)
  * if any fields have changed.
  */
+
+
 function update(prevRecord, nextRecord) {
-  var updated = void 0;
+  if (process.env.NODE_ENV !== "production") {
+    var _getType, _getType2;
+
+    var prevID = getDataID(prevRecord);
+    var nextID = getDataID(nextRecord);
+    process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(prevID === nextID, 'RelayModernRecord: Invalid record update, expected both versions of ' + 'the record to have the same id, got `%s` and `%s`.', prevID, nextID) : void 0; // note: coalesce null/undefined to null
+
+    var prevType = (_getType = getType(prevRecord)) !== null && _getType !== void 0 ? _getType : null;
+    var nextType = (_getType2 = getType(nextRecord)) !== null && _getType2 !== void 0 ? _getType2 : null;
+    process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(prevType === nextType, 'RelayModernRecord: Invalid record update, expected both versions of ' + 'record `%s` to have the same `%s` but got conflicting types `%s` ' + 'and `%s`. The GraphQL server likely violated the globally unique ' + 'id requirement by returning the same id for different objects.', prevID, require("./RelayStoreUtils").TYPENAME_KEY, prevType, nextType) : void 0;
+  }
+
+  var updated = null;
   var keys = Object.keys(nextRecord);
+
   for (var ii = 0; ii < keys.length; ii++) {
     var key = keys[ii];
-    if (updated || !require('fbjs/lib/areEqual')(prevRecord[key], nextRecord[key])) {
-      updated = updated || (0, _extends3['default'])({}, prevRecord);
-      if (nextRecord[key] !== require('./RelayStoreUtils').UNPUBLISH_FIELD_SENTINEL) {
+
+    if (updated || !require("fbjs/lib/areEqual")(prevRecord[key], nextRecord[key])) {
+      updated = updated !== null ? updated : (0, _objectSpread2["default"])({}, prevRecord);
+
+      if (nextRecord[key] !== require("./RelayStoreUtils").UNPUBLISH_FIELD_SENTINEL) {
         updated[key] = nextRecord[key];
       } else {
         delete updated[key];
       }
     }
   }
-  return updated || prevRecord;
-}
 
+  return updated !== null ? updated : prevRecord;
+}
 /**
  * @public
  *
  * Returns a new record with the contents of the given records. Fields in the
  * second record will overwrite identical fields in the first record.
  */
+
+
 function merge(record1, record2) {
+  if (process.env.NODE_ENV !== "production") {
+    var _getType3, _getType4;
+
+    var prevID = getDataID(record1);
+    var nextID = getDataID(record2);
+    process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(prevID === nextID, 'RelayModernRecord: Invalid record merge, expected both versions of ' + 'the record to have the same id, got `%s` and `%s`.', prevID, nextID) : void 0; // note: coalesce null/undefined to null
+
+    var prevType = (_getType3 = getType(record1)) !== null && _getType3 !== void 0 ? _getType3 : null;
+    var nextType = (_getType4 = getType(record2)) !== null && _getType4 !== void 0 ? _getType4 : null;
+    process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(prevType === nextType, 'RelayModernRecord: Invalid record merge, expected both versions of ' + 'record `%s` to have the same `%s` but got conflicting types `%s` ' + 'and `%s`. The GraphQL server likely violated the globally unique ' + 'id requirement by returning the same id for different objects.', prevID, require("./RelayStoreUtils").TYPENAME_KEY, prevType, nextType) : void 0;
+  }
+
   return Object.assign({}, record1, record2);
 }
-
 /**
  * @public
  *
  * Prevent modifications to the record. Attempts to call `set*` functions on a
  * frozen record will fatal at runtime.
  */
+
+
 function freeze(record) {
-  require('./deepFreeze')(record);
+  require("./deepFreeze")(record);
 }
-
 /**
  * @public
  *
  * Set the value of a storageKey to a scalar.
  */
+
+
 function setValue(record, storageKey, value) {
+  if (process.env.NODE_ENV !== "production") {
+    var prevID = getDataID(record);
+
+    if (storageKey === require("./RelayStoreUtils").ID_KEY) {
+      process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(prevID === value, 'RelayModernRecord: Invalid field update, expected both versions of ' + 'the record to have the same id, got `%s` and `%s`.', prevID, value) : void 0;
+    } else if (storageKey === require("./RelayStoreUtils").TYPENAME_KEY) {
+      var _getType5, _value;
+
+      // note: coalesce null/undefined to null
+      var prevType = (_getType5 = getType(record)) !== null && _getType5 !== void 0 ? _getType5 : null;
+      var nextType = (_value = value) !== null && _value !== void 0 ? _value : null;
+      process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(prevType === nextType, 'RelayModernRecord: Invalid field update, expected both versions of ' + 'record `%s` to have the same `%s` but got conflicting types `%s` ' + 'and `%s`. The GraphQL server likely violated the globally unique ' + 'id requirement by returning the same id for different objects.', prevID, require("./RelayStoreUtils").TYPENAME_KEY, prevType, nextType) : void 0;
+    }
+  }
+
   record[storageKey] = value;
 }
-
 /**
  * @public
  *
  * Set the value of a field to a reference to another record.
  */
+
+
 function setLinkedRecordID(record, storageKey, linkedID) {
   // See perf note above for why we aren't using computed property access.
   var link = {};
-  link[require('./RelayStoreUtils').REF_KEY] = linkedID;
+  link[require("./RelayStoreUtils").REF_KEY] = linkedID;
   record[storageKey] = link;
 }
-
 /**
  * @public
  *
  * Set the value of a field to a list of references other records.
  */
+
+
 function setLinkedRecordIDs(record, storageKey, linkedIDs) {
   // See perf note above for why we aren't using computed property access.
   var links = {};
-  links[require('./RelayStoreUtils').REFS_KEY] = linkedIDs;
+  links[require("./RelayStoreUtils").REFS_KEY] = linkedIDs;
   record[storageKey] = links;
 }