relay-runtime 2.0.0-rc.2 → 2.0.0

package/lib/RelayResponseNormalizer.js

@@ -9,6 +9,8 @@
  */
 'use strict';
 
+var _toConsumableArray2 = require("@babel/runtime/helpers/interopRequireDefault")(require("@babel/runtime/helpers/toConsumableArray"));
+
 /**
  * Normalizes the results of a query and standard GraphQL response, writing the
  * normalized records/fields into the given MutableRecordSource.
@@ -39,7 +41,9 @@ function () {
   function RelayResponseNormalizer(recordSource, variables, options) {
     this._handleFieldPayloads = [];
     this._handleStrippedNulls = options.handleStrippedNulls;
+    this._incrementalPayloads = [];
     this._matchFieldPayloads = [];
+    this._path = options.path ? (0, _toConsumableArray2["default"])(options.path) : [];
     this._recordSource = recordSource;
     this._variables = variables;
   }
@@ -54,6 +58,7 @@ function () {
     this._traverseSelections(node, record, data);
 
     return {
+      incrementalPayloads: this._incrementalPayloads,
       fieldPayloads: this._handleFieldPayloads,
       matchPayloads: this._matchFieldPayloads
     };
@@ -105,6 +110,10 @@ function () {
         });
       } else if (selection.kind === require("./RelayConcreteNode").MATCH_FIELD) {
         _this._normalizeMatchField(node, selection, record, data);
+      } else if (selection.kind === require("./RelayConcreteNode").DEFER) {
+        _this._normalizeDefer(selection, record, data);
+      } else if (selection.kind === require("./RelayConcreteNode").STREAM) {
+        _this._normalizeStream(selection, record, data);
       } else if (selection.kind === require("./RelayConcreteNode").FRAGMENT || selection.kind === require("./RelayConcreteNode").FRAGMENT_SPREAD) {
         !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayResponseNormalizer(): Unexpected ast kind `%s`.', selection.kind) : require("fbjs/lib/invariant")(false) : void 0;
       } else {
@@ -114,6 +123,61 @@ function () {
     });
   };
 
+  _proto._normalizeDefer = function _normalizeDefer(defer, record, data) {
+    var isDeferred = defer["if"] === null || this._getVariableValue(defer["if"]);
+
+    if (process.env.NODE_ENV !== "production") {
+      process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(typeof isDeferred === 'boolean', 'RelayResponseNormalizer: Expected value for @defer `if` argument to ' + 'be a boolean, got `%s`.', isDeferred) : void 0;
+    }
+
+    if (isDeferred === false) {
+      // If defer is disabled there will be no additional response chunk:
+      // normalize the data already present.
+      this._traverseSelections(defer, record, data);
+    } else {
+      // Otherwise data *for this selection* should not be present: enqueue
+      // metadata to process the subsequent response chunk.
+      this._incrementalPayloads.push({
+        kind: 'defer',
+        label: defer.label,
+        path: (0, _toConsumableArray2["default"])(this._path),
+        selector: {
+          dataID: require("./RelayModernRecord").getDataID(record),
+          node: defer,
+          variables: this._variables
+        }
+      });
+    }
+  };
+
+  _proto._normalizeStream = function _normalizeStream(stream, record, data) {
+    // Always normalize regardless of whether streaming is enabled or not,
+    // this populates the initial array value (including any items when
+    // initial_count > 0).
+    this._traverseSelections(stream, record, data);
+
+    var isStreamed = stream["if"] === null || this._getVariableValue(stream["if"]);
+
+    if (process.env.NODE_ENV !== "production") {
+      process.env.NODE_ENV !== "production" ? require("fbjs/lib/warning")(typeof isStreamed === 'boolean', 'RelayResponseNormalizer: Expected value for @stream `if` argument ' + 'to be a boolean, got `%s`.', isStreamed) : void 0;
+    }
+
+    if (isStreamed === true) {
+      // If streaming is enabled, *also* emit metadata to process any
+      // response chunks that may be delivered.
+      this._incrementalPayloads.push({
+        kind: 'stream',
+        label: stream.label,
+        path: (0, _toConsumableArray2["default"])(this._path),
+        selector: {
+          dataID: require("./RelayModernRecord").getDataID(record),
+          node: stream,
+          variables: this._variables
+        }
+      });
+    }
+  };
+
   _proto._normalizeMatchField = function _normalizeMatchField(parent, field, record, data) {
     !(typeof data === 'object' && data) ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'writeField(): Expected data for field `%s` to be an object.', field.name) : require("fbjs/lib/invariant")(false) : void 0;
     var responseKey = field.alias || field.name;
@@ -170,9 +234,10 @@ function () {
 
     if (operationReference != null) {
       this._matchFieldPayloads.push({
-        operationReference: operationReference,
-        dataID: nextID,
         data: fieldValue,
+        dataID: nextID,
+        operationReference: operationReference,
+        path: (0, _toConsumableArray2["default"])(this._path).concat([responseKey]),
         typeName: typeName,
         variables: this._variables
       });
@@ -205,11 +270,15 @@ function () {
     if (selection.kind === require("./RelayConcreteNode").SCALAR_FIELD) {
       require("./RelayModernRecord").setValue(record, storageKey, fieldValue);
     } else if (selection.kind === require("./RelayConcreteNode").LINKED_FIELD) {
+      this._path.push(responseKey);
+
       if (selection.plural) {
         this._normalizePluralLink(selection, record, storageKey, fieldValue);
       } else {
         this._normalizeLink(selection, record, storageKey, fieldValue);
       }
+
+      this._path.pop();
     } else if (selection.kind === require("./RelayConcreteNode").MATCH_FIELD) {
       !false ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayResponseNormalizer(): Unexpected ast kind `%s` during normalization.', selection.kind) : require("fbjs/lib/invariant")(false) : void 0;
     } else {
@@ -258,6 +327,8 @@ function () {
         return;
       }
 
+      _this2._path.push(String(nextIndex));
+
       !(typeof item === 'object') ? process.env.NODE_ENV !== "production" ? require("fbjs/lib/invariant")(false, 'RelayResponseNormalizer: Expected elements for field `%s` to be ' + 'objects.', storageKey) : require("fbjs/lib/invariant")(false) : void 0;
 
       var nextID = item.id || prevIDs && prevIDs[nextIndex] || // Reuse previously generated client IDs
@@ -279,6 +350,8 @@ function () {
       }
 
       _this2._traverseSelections(field, nextRecord, item);
+
+      _this2._path.pop();
     });
 
     require("./RelayModernRecord").setLinkedRecordIDs(record, storageKey, nextIDs);

package/lib/recycleNodesInto.js

@@ -28,10 +28,16 @@ function recycleNodesInto(prevData, nextData) {
       var nextValue = recycleNodesInto(prevValue, nextItem);
 
       if (nextValue !== nextArray[ii]) {
-        nextArray[ii] = nextValue;
+        if (process.env.NODE_ENV !== "production") {
+          if (!Object.isFrozen(nextArray)) {
+            nextArray[ii] = nextValue;
+          }
+        } else {
+          nextArray[ii] = nextValue;
+        }
       }
 
-      return wasEqual && nextArray[ii] === prevArray[ii];
+      return wasEqual && nextValue === prevArray[ii];
     }, true) && prevArray.length === nextArray.length;
   } else if (!prevArray && !nextArray) {
     // Assign local variables to preserve Flow type refinement.
@@ -44,10 +50,16 @@ function recycleNodesInto(prevData, nextData) {
       var nextValue = recycleNodesInto(prevValue, nextObject[key]);
 
       if (nextValue !== nextObject[key]) {
-        nextObject[key] = nextValue;
+        if (process.env.NODE_ENV !== "production") {
+          if (!Object.isFrozen(nextObject)) {
+            nextObject[key] = nextValue;
+          }
+        } else {
+          nextObject[key] = nextValue;
+        }
       }
 
-      return wasEqual && nextObject[key] === prevObject[key];
+      return wasEqual && nextValue === prevObject[key];
     }, true) && prevKeys.length === nextKeys.length;
   }
 

package/lib/requestRelaySubscription.js

@@ -39,7 +39,9 @@ function requestRelaySubscription(environment, config) {
       force: true
     }
   }).map(function () {
-    return environment.lookup(operation.fragment).data;
+    var data = environment.lookup(operation.fragment).data; // $FlowFixMe
+
+    return data;
   }).subscribeLegacy({
     onNext: onNext,
     onError: onError,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "2.0.0-rc.2",
+  "version": "2.0.0",
   "keywords": [
     "graphql",
     "relay"