relay-runtime 2.0.0-rc.2 → 2.0.0

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v2.0.0-rc.2
+ * Relay v2.0.0
  *
  * Copyright (c) 2013-present, Facebook, Inc.
  *

package/lib/DataChecker.js

@@ -265,6 +265,12 @@ function () {
 
           break;
 
+        case require("./RelayConcreteNode").DEFER:
+        case require("./RelayConcreteNode").STREAM:
+          _this2._traverseSelections(selection.selections, dataID);
+
+          break;
+
         case require("./RelayConcreteNode").SCALAR_HANDLE:
         case require("./RelayConcreteNode").FRAGMENT_SPREAD:
           !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayAsyncLoader(): Unexpected ast kind `%s`.', selection.kind) : require("fbjs/lib/invariant")(false) : void 0; // $FlowExpectedError - we need the break; for OSS linter

package/lib/RelayConcreteNode.js

@@ -22,6 +22,7 @@
  */
 var RelayConcreteNode = {
   CONDITION: 'Condition',
+  DEFER: 'Defer',
   FRAGMENT: 'Fragment',
   FRAGMENT_SPREAD: 'FragmentSpread',
   INLINE_FRAGMENT: 'InlineFragment',
@@ -36,6 +37,7 @@ var RelayConcreteNode = {
   SCALAR_FIELD: 'ScalarField',
   SCALAR_HANDLE: 'ScalarHandle',
   SPLIT_OPERATION: 'SplitOperation',
+  STREAM: 'Stream',
   VARIABLE: 'Variable'
 };
 module.exports = RelayConcreteNode;

package/lib/RelayModernEnvironment.js

@@ -163,117 +163,16 @@ function () {
 
 
   _proto.execute = function execute(_ref2) {
-    var _this3 = this;
-
     var operation = _ref2.operation,
         cacheConfig = _ref2.cacheConfig,
         updater = _ref2.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) {
-          var operationLoader = _this3._operationLoader;
-          !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
-          };
-
-          _this3._publishQueue.applyUpdate(optimisticResponse);
-
-          _this3._publishQueue.run();
-        } else {
-          if (optimisticResponse !== null) {
-            _this3._publishQueue.revertUpdate(optimisticResponse);
-
-            optimisticResponse = null;
-          }
-
-          if (operationDescriptor && payloadUpdater) {
-            _this3._publishQueue.commitPayload(operationDescriptor, payload, payloadUpdater);
-          } else {
-            _this3._publishQueue.commitRelayPayload(payload);
-          }
-
-          _this3._publishQueue.run();
-        }
-      };
-
-      var node = operation.node;
-
-      _this3._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) {
-          _this3._publishQueue.revertUpdate(optimisticResponse);
-
-          optimisticResponse = null;
-
-          _this3._publishQueue.run();
-        }
-      };
+    return require("./RelayModernQueryExecutor").execute({
+      operation: operation,
+      cacheConfig: cacheConfig,
+      updater: updater,
+      network: this._network,
+      operationLoader: this._operationLoader,
+      publishQueue: this._publishQueue
     });
   };
   /**
@@ -289,7 +188,7 @@ function () {
 
 
   _proto.executeMutation = function executeMutation(_ref3) {
-    var _this4 = this;
+    var _this3 = this;
 
     var operation = _ref3.operation,
         optimisticResponse = _ref3.optimisticResponse,
@@ -312,21 +211,21 @@ function () {
     }, uploadables)["do"]({
       start: function start() {
         if (optimisticUpdate) {
-          _this4._publishQueue.applyUpdate(optimisticUpdate);
+          _this3._publishQueue.applyUpdate(optimisticUpdate);
 
-          _this4._publishQueue.run();
+          _this3._publishQueue.run();
         }
       },
       next: function next(payload) {
         if (optimisticUpdate) {
-          _this4._publishQueue.revertUpdate(optimisticUpdate);
+          _this3._publishQueue.revertUpdate(optimisticUpdate);
 
           optimisticUpdate = undefined;
         }
 
-        _this4._publishQueue.commitPayload(operation, require("./normalizePayload")(operation, payload), updater);
+        _this3._publishQueue.commitPayload(operation, require("./normalizePayload")(operation, payload), updater);
 
-        _this4._publishQueue.run();
+        _this3._publishQueue.run();
       },
       error: function (_error) {
         function error(_x) {
@@ -340,20 +239,20 @@ function () {
         return error;
       }(function (error) {
         if (optimisticUpdate) {
-          _this4._publishQueue.revertUpdate(optimisticUpdate);
+          _this3._publishQueue.revertUpdate(optimisticUpdate);
 
           optimisticUpdate = undefined;
 
-          _this4._publishQueue.run();
+          _this3._publishQueue.run();
         }
       }),
       unsubscribe: function unsubscribe() {
         if (optimisticUpdate) {
-          _this4._publishQueue.revertUpdate(optimisticUpdate);
+          _this3._publishQueue.revertUpdate(optimisticUpdate);
 
           optimisticUpdate = undefined;
 
-          _this4._publishQueue.run();
+          _this3._publishQueue.run();
         }
       }
     });
@@ -418,51 +317,7 @@ function () {
   };
 
   return RelayModernEnvironment;
-}();
-/**
- * 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);
-  });
-} // Add a sigil for detection by `isRelayModernEnvironment()` to avoid a
+}(); // Add a sigil for detection by `isRelayModernEnvironment()` to avoid a
 // realm-specific instanceof check, and to aid in module tree-shaking to
 // avoid requiring all of RelayRuntime just to detect its environment.
 

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/RelayModernStore.js

@@ -165,7 +165,7 @@ function () {
       return;
     }
 
-    var _RelayReader$read = require("./RelayReader").read(this._recordSource, snapshot),
+    var _RelayReader$read = require("./RelayReader").read(this._recordSource, snapshot, snapshot.owner),
         data = _RelayReader$read.data,
         seenRecords = _RelayReader$read.seenRecords;
 

package/lib/RelayPublishQueue.js

@@ -98,7 +98,7 @@ function () {
       kind: 'payload',
       payload: {
         fieldPayloads: fieldPayloads,
-        selector: operation.fragment,
+        operation: operation,
         source: source,
         updater: updater
       }
@@ -114,7 +114,7 @@ function () {
       kind: 'payload',
       payload: {
         fieldPayloads: fieldPayloads,
-        selector: null,
+        operation: null,
         source: source,
         updater: null
       }
@@ -185,7 +185,7 @@ function () {
     var _this = this;
 
     var fieldPayloads = payload.fieldPayloads,
-        selector = payload.selector,
+        operation = payload.operation,
         source = payload.source,
         updater = payload.updater;
     var mutator = new (require("./RelayRecordSourceMutator"))(this._store.getSource(), source);
@@ -201,9 +201,10 @@ function () {
     }
 
     if (updater) {
+      var selector = operation === null || operation === void 0 ? void 0 : operation.fragment;
       !(selector != null) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayModernEnvironment: Expected a selector to be provided with updater function.') : require("fbjs/lib/invariant")(false) : void 0;
       var selectorStore = new (require("./RelayRecordSourceSelectorProxy"))(store, selector);
-      var selectorData = lookupSelector(source, selector);
+      var selectorData = lookupSelector(source, selector, operation);
       updater(selectorStore, selectorData);
     }
 
@@ -275,7 +276,7 @@ function () {
               var _normalizeRelayPayloa = require("./normalizeRelayPayload")(operation.root, response);
 
               source = _normalizeRelayPayloa.source;
-              selectorData = lookupSelector(source, operation.fragment);
+              selectorData = lookupSelector(source, operation.fragment, operation);
             }
 
             selectorStoreUpdater && require("fbjs/lib/ErrorUtils").applyWithGuard(selectorStoreUpdater, null, [selectorStore, selectorData], null, 'RelayPublishQueue:applyUpdates');
@@ -306,7 +307,7 @@ function () {
               var _normalizeRelayPayloa2 = require("./normalizeRelayPayload")(operation.root, response);
 
               source = _normalizeRelayPayloa2.source;
-              selectorData = lookupSelector(source, operation.fragment);
+              selectorData = lookupSelector(source, operation.fragment, operation);
             }
 
             selectorStoreUpdater && require("fbjs/lib/ErrorUtils").applyWithGuard(selectorStoreUpdater, null, [selectorStore, selectorData], null, 'RelayPublishQueue:applyUpdates');
@@ -333,8 +334,8 @@ function () {
   return RelayPublishQueue;
 }();
 
-function lookupSelector(source, selector) {
-  var selectorData = require("./RelayReader").read(source, selector).data;
+function lookupSelector(source, selector, owner) {
+  var selectorData = require("./RelayReader").read(source, selector, owner).data;
 
   if (process.env.NODE_ENV !== "production") {
     var deepFreeze = require("./deepFreeze");

package/lib/RelayReader.js

@@ -45,7 +45,8 @@ function () {
       node: node,
       seenRecords: this._seenRecords,
       variables: this._variables,
-      isMissingData: this._isMissingData
+      isMissingData: this._isMissingData,
+      owner: this._owner
     };
   };
 
@@ -279,8 +280,6 @@ function () {
   };
 
   _proto._createFragmentPointer = function _createFragmentPointer(fragmentSpread, record, data, variables) {
-    var _data$ID_KEY;
-
     var fragmentPointers = data[require("./RelayStoreUtils").FRAGMENTS_KEY];
 
     if (fragmentPointers == null) {
@@ -288,7 +287,11 @@ function () {
     }
 
     !(typeof fragmentPointers === 'object' && fragmentPointers) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayReader: Expected fragment spread data to be an object, got `%s`.', fragmentPointers) : require("fbjs/lib/invariant")(false) : void 0;
-    data[require("./RelayStoreUtils").ID_KEY] = (_data$ID_KEY = data[require("./RelayStoreUtils").ID_KEY]) !== null && _data$ID_KEY !== void 0 ? _data$ID_KEY : require("./RelayModernRecord").getDataID(record);
+
+    if (data[require("./RelayStoreUtils").ID_KEY] == null) {
+      data[require("./RelayStoreUtils").ID_KEY] = require("./RelayModernRecord").getDataID(record);
+    }
+
     fragmentPointers[fragmentSpread.name] = fragmentSpread.args ? require("./RelayStoreUtils").getArgumentValues(fragmentSpread.args, variables) : {};
     data[require("./RelayStoreUtils").FRAGMENT_OWNER_KEY] = this._owner;
   };

package/lib/RelayReferenceMarker.js

@@ -112,6 +112,12 @@ function () {
 
           break;
 
+        case require("./RelayConcreteNode").DEFER:
+        case require("./RelayConcreteNode").STREAM:
+          _this._traverseSelections(selection.selections, record);
+
+          break;
+
         case require("./RelayConcreteNode").SCALAR_FIELD:
         case require("./RelayConcreteNode").SCALAR_HANDLE:
           break;