relay-runtime 10.0.1 → 10.1.3

package/lib/store/RelayReader.js

@@ -20,28 +20,33 @@ var _require = require('../util/RelayConcreteNode'),
     CLIENT_EXTENSION = _require.CLIENT_EXTENSION,
     CONDITION = _require.CONDITION,
     DEFER = _require.DEFER,
+    FLIGHT_FIELD = _require.FLIGHT_FIELD,
     FRAGMENT_SPREAD = _require.FRAGMENT_SPREAD,
     INLINE_DATA_FRAGMENT_SPREAD = _require.INLINE_DATA_FRAGMENT_SPREAD,
     INLINE_FRAGMENT = _require.INLINE_FRAGMENT,
     LINKED_FIELD = _require.LINKED_FIELD,
     MODULE_IMPORT = _require.MODULE_IMPORT,
+    REQUIRED_FIELD = _require.REQUIRED_FIELD,
     SCALAR_FIELD = _require.SCALAR_FIELD,
     STREAM = _require.STREAM;
 
-var _require2 = require('./RelayStoreUtils'),
-    FRAGMENTS_KEY = _require2.FRAGMENTS_KEY,
-    FRAGMENT_OWNER_KEY = _require2.FRAGMENT_OWNER_KEY,
-    FRAGMENT_PROP_NAME_KEY = _require2.FRAGMENT_PROP_NAME_KEY,
-    ID_KEY = _require2.ID_KEY,
-    IS_WITHIN_UNMATCHED_TYPE_REFINEMENT = _require2.IS_WITHIN_UNMATCHED_TYPE_REFINEMENT,
-    MODULE_COMPONENT_KEY = _require2.MODULE_COMPONENT_KEY,
-    ROOT_ID = _require2.ROOT_ID,
-    getArgumentValues = _require2.getArgumentValues,
-    getStorageKey = _require2.getStorageKey,
-    getModuleComponentKey = _require2.getModuleComponentKey;
-
-var _require3 = require('./TypeID'),
-    generateTypeID = _require3.generateTypeID;
+var _require2 = require('./RelayStoreReactFlightUtils'),
+    getReactFlightClientResponse = _require2.getReactFlightClientResponse;
+
+var _require3 = require('./RelayStoreUtils'),
+    FRAGMENTS_KEY = _require3.FRAGMENTS_KEY,
+    FRAGMENT_OWNER_KEY = _require3.FRAGMENT_OWNER_KEY,
+    FRAGMENT_PROP_NAME_KEY = _require3.FRAGMENT_PROP_NAME_KEY,
+    ID_KEY = _require3.ID_KEY,
+    IS_WITHIN_UNMATCHED_TYPE_REFINEMENT = _require3.IS_WITHIN_UNMATCHED_TYPE_REFINEMENT,
+    MODULE_COMPONENT_KEY = _require3.MODULE_COMPONENT_KEY,
+    ROOT_ID = _require3.ROOT_ID,
+    getArgumentValues = _require3.getArgumentValues,
+    getStorageKey = _require3.getStorageKey,
+    getModuleComponentKey = _require3.getModuleComponentKey;
+
+var _require4 = require('./TypeID'),
+    generateTypeID = _require4.generateTypeID;
 
 function read(recordSource, selector) {
   var reader = new RelayReader(recordSource, selector);
@@ -56,6 +61,7 @@ var RelayReader = /*#__PURE__*/function () {
   function RelayReader(recordSource, selector) {
     this._isMissingData = false;
     this._isWithinUnmatchedTypeRefinement = false;
+    this._missingRequiredFields = null;
     this._owner = selector.owner;
     this._recordSource = recordSource;
     this._seenRecords = {};
@@ -124,7 +130,8 @@ var RelayReader = /*#__PURE__*/function () {
       data: data,
       isMissingData: this._isMissingData && isDataExpectedToBePresent,
       seenRecords: this._seenRecords,
-      selector: this._selector
+      selector: this._selector,
+      missingRequiredFields: this._missingRequiredFields
     };
   };
 
@@ -143,9 +150,9 @@ var RelayReader = /*#__PURE__*/function () {
 
     var data = prevData || {};
 
-    this._traverseSelections(node.selections, record, data);
+    var hadRequiredData = this._traverseSelections(node.selections, record, data);
 
-    return data;
+    return hadRequiredData ? data : null;
   };
 
   _proto._getVariableValue = function _getVariableValue(name) {
@@ -153,11 +160,76 @@ var RelayReader = /*#__PURE__*/function () {
     return this._variables[name];
   };
 
-  _proto._traverseSelections = function _traverseSelections(selections, record, data) {
+  _proto._maybeReportUnexpectedNull = function _maybeReportUnexpectedNull(fieldPath, action, record) {
+    var _this$_missingRequire;
+
+    if (((_this$_missingRequire = this._missingRequiredFields) === null || _this$_missingRequire === void 0 ? void 0 : _this$_missingRequire.action) === 'THROW') {
+      // Chained @required directives may cause a parent `@required(action:
+      // THROW)` field to become null, so the first missing field we
+      // encounter is likely to be the root cause of the error.
+      return;
+    }
+
+    var owner = this._selector.node.name;
+
+    switch (action) {
+      case 'THROW':
+        this._missingRequiredFields = {
+          action: action,
+          field: {
+            path: fieldPath,
+            owner: owner
+          }
+        };
+        return;
+
+      case 'LOG':
+        if (this._missingRequiredFields == null) {
+          this._missingRequiredFields = {
+            action: action,
+            fields: []
+          };
+        }
+
+        this._missingRequiredFields.fields.push({
+          path: fieldPath,
+          owner: owner
+        });
+
+        return;
+
+      default:
+        action;
+    }
+  };
+
+  _proto._traverseSelections = function _traverseSelections(selections, record, data)
+  /* had all expected data */
+  {
     for (var i = 0; i < selections.length; i++) {
       var selection = selections[i];
 
       switch (selection.kind) {
+        case REQUIRED_FIELD:
+          !RelayFeatureFlags.ENABLE_REQUIRED_DIRECTIVES ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Encountered a `@required` directive at path "%s" in `%s` without the `ENABLE_REQUIRED_DIRECTIVES` feature flag enabled.', selection.path, this._selector.node.name) : invariant(false) : void 0;
+
+          var fieldValue = this._readRequiredField(selection, record, data);
+
+          if (fieldValue == null) {
+            var action = selection.action;
+
+            if (action !== 'NONE') {
+              this._maybeReportUnexpectedNull(selection.path, action, record);
+            } // We are going to throw, or our parent is going to get nulled out.
+            // Either way, sibling values are going to be ignored, so we can
+            // bail early here as an optimization.
+
+
+            return false;
+          }
+
+          break;
+
         case SCALAR_FIELD:
           this._readScalar(selection, record, data);
 
@@ -176,7 +248,11 @@ var RelayReader = /*#__PURE__*/function () {
           var conditionValue = this._getVariableValue(selection.condition);
 
           if (conditionValue === selection.passingValue) {
-            this._traverseSelections(selection.selections, record, data);
+            var hasExpectedData = this._traverseSelections(selection.selections, record, data);
+
+            if (!hasExpectedData) {
+              return false;
+            }
           }
 
           break;
@@ -190,7 +266,11 @@ var RelayReader = /*#__PURE__*/function () {
               var typeName = RelayModernRecord.getType(record);
 
               if (typeName != null && typeName === selection.type) {
-                this._traverseSelections(selection.selections, record, data);
+                var _hasExpectedData = this._traverseSelections(selection.selections, record, data);
+
+                if (!_hasExpectedData) {
+                  return false;
+                }
               }
             } else if (RelayFeatureFlags.ENABLE_PRECISE_TYPE_REFINEMENT) {
               // Similar to the logic in read(): data is only expected to be present
@@ -246,15 +326,37 @@ var RelayReader = /*#__PURE__*/function () {
 
         case DEFER:
         case CLIENT_EXTENSION:
-          var isMissingData = this._isMissingData;
+          {
+            var isMissingData = this._isMissingData;
 
-          this._traverseSelections(selection.selections, record, data);
+            var _hasExpectedData2 = this._traverseSelections(selection.selections, record, data);
 
-          this._isMissingData = isMissingData;
-          break;
+            this._isMissingData = isMissingData;
+
+            if (!_hasExpectedData2) {
+              return false;
+            }
+
+            break;
+          }
 
         case STREAM:
-          this._traverseSelections(selection.selections, record, data);
+          {
+            var _hasExpectedData3 = this._traverseSelections(selection.selections, record, data);
+
+            if (!_hasExpectedData3) {
+              return false;
+            }
+
+            break;
+          }
+
+        case FLIGHT_FIELD:
+          if (RelayFeatureFlags.ENABLE_REACT_FLIGHT_COMPONENT_FIELD) {
+            this._readFlightField(selection, record, data);
+          } else {
+            throw new Error('Flight fields are not yet supported.');
+          }
 
           break;
 
@@ -263,13 +365,69 @@ var RelayReader = /*#__PURE__*/function () {
           !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Unexpected ast kind `%s`.', selection.kind) : invariant(false) : void 0;
       }
     }
+
+    return true;
   };
 
-  _proto._readScalar = function _readScalar(field, record, data) {
+  _proto._readRequiredField = function _readRequiredField(selection, record, data) {
+    switch (selection.field.kind) {
+      case SCALAR_FIELD:
+        return this._readScalar(selection.field, record, data);
+
+      case LINKED_FIELD:
+        if (selection.field.plural) {
+          return this._readPluralLink(selection.field, record, data);
+        } else {
+          return this._readLink(selection.field, record, data);
+        }
+
+      default:
+        selection.field.kind;
+        !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Unexpected ast kind `%s`.', selection.kind) : invariant(false) : void 0;
+    }
+  };
+
+  _proto._readFlightField = function _readFlightField(field, record, data) {
     var _field$alias;
 
     var applicationName = (_field$alias = field.alias) !== null && _field$alias !== void 0 ? _field$alias : field.name;
     var storageKey = getStorageKey(field, this._variables);
+    var reactFlightClientResponseRecordID = RelayModernRecord.getLinkedRecordID(record, storageKey);
+
+    if (reactFlightClientResponseRecordID == null) {
+      data[applicationName] = reactFlightClientResponseRecordID;
+
+      if (reactFlightClientResponseRecordID === undefined) {
+        this._isMissingData = true;
+      }
+
+      return reactFlightClientResponseRecordID;
+    }
+
+    var reactFlightClientResponseRecord = this._recordSource.get(reactFlightClientResponseRecordID);
+
+    this._seenRecords[reactFlightClientResponseRecordID] = reactFlightClientResponseRecord;
+
+    if (reactFlightClientResponseRecord == null) {
+      data[applicationName] = reactFlightClientResponseRecord;
+
+      if (reactFlightClientResponseRecord === undefined) {
+        this._isMissingData = true;
+      }
+
+      return reactFlightClientResponseRecord;
+    }
+
+    var clientResponse = getReactFlightClientResponse(reactFlightClientResponseRecord);
+    data[applicationName] = clientResponse;
+    return clientResponse;
+  };
+
+  _proto._readScalar = function _readScalar(field, record, data) {
+    var _field$alias2;
+
+    var applicationName = (_field$alias2 = field.alias) !== null && _field$alias2 !== void 0 ? _field$alias2 : field.name;
+    var storageKey = getStorageKey(field, this._variables);
     var value = RelayModernRecord.getValue(record, storageKey);
 
     if (value === undefined) {
@@ -277,12 +435,13 @@ var RelayReader = /*#__PURE__*/function () {
     }
 
     data[applicationName] = value;
+    return value;
   };
 
   _proto._readLink = function _readLink(field, record, data) {
-    var _field$alias2;
+    var _field$alias3;
 
-    var applicationName = (_field$alias2 = field.alias) !== null && _field$alias2 !== void 0 ? _field$alias2 : field.name;
+    var applicationName = (_field$alias3 = field.alias) !== null && _field$alias3 !== void 0 ? _field$alias3 : field.name;
     var storageKey = getStorageKey(field, this._variables);
     var linkedID = RelayModernRecord.getLinkedRecordID(record, storageKey);
 
@@ -293,21 +452,24 @@ var RelayReader = /*#__PURE__*/function () {
         this._isMissingData = true;
       }
 
-      return;
+      return linkedID;
     }
 
     var prevData = data[applicationName];
     !(prevData == null || typeof prevData === 'object') ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReader(): Expected data for field `%s` on record `%s` ' + 'to be an object, got `%s`.', applicationName, RelayModernRecord.getDataID(record), prevData) : invariant(false) : void 0; // $FlowFixMe[incompatible-variance]
 
-    data[applicationName] = this._traverse(field, linkedID, prevData);
+    var value = this._traverse(field, linkedID, prevData);
+
+    data[applicationName] = value;
+    return value;
   };
 
   _proto._readPluralLink = function _readPluralLink(field, record, data) {
     var _this = this;
 
-    var _field$alias3;
+    var _field$alias4;
 
-    var applicationName = (_field$alias3 = field.alias) !== null && _field$alias3 !== void 0 ? _field$alias3 : field.name;
+    var applicationName = (_field$alias4 = field.alias) !== null && _field$alias4 !== void 0 ? _field$alias4 : field.name;
     var storageKey = getStorageKey(field, this._variables);
     var linkedIDs = RelayModernRecord.getLinkedRecordIDs(record, storageKey);
 
@@ -318,7 +480,7 @@ var RelayReader = /*#__PURE__*/function () {
         this._isMissingData = true;
       }
 
-      return;
+      return linkedIDs;
     }
 
     var prevData = data[applicationName];
@@ -342,6 +504,7 @@ var RelayReader = /*#__PURE__*/function () {
       linkedArray[nextIndex] = _this._traverse(field, linkedID, prevItem);
     });
     data[applicationName] = linkedArray;
+    return linkedArray;
   }
   /**
    * Reads a ReaderModuleImport, which was generated from using the @module

package/lib/store/RelayRecordSourceMapImpl.js

@@ -10,11 +10,9 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-function _createForOfIteratorHelper(o) { if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (o = _unsupportedIterableToArray(o))) { var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var it, normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(n); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
 
 var RelayRecordState = require('./RelayRecordState');
 
@@ -84,7 +82,7 @@ var RelayMapRecordSourceMapImpl = /*#__PURE__*/function () {
   _proto.toJSON = function toJSON() {
     var obj = {};
 
-    var _iterator = _createForOfIteratorHelper(this._records),
+    var _iterator = (0, _createForOfIteratorHelper2["default"])(this._records),
         _step;
 
     try {

package/lib/store/RelayReferenceMarker.js

@@ -10,16 +10,24 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
+
 var RelayConcreteNode = require('../util/RelayConcreteNode');
 
 var RelayFeatureFlags = require('../util/RelayFeatureFlags');
 
 var RelayModernRecord = require('./RelayModernRecord');
 
+var RelayStoreReactFlightUtils = require('./RelayStoreReactFlightUtils');
+
 var RelayStoreUtils = require('./RelayStoreUtils');
 
 var cloneRelayHandleSourceField = require('./cloneRelayHandleSourceField');
 
+var getOperation = require('../util/getOperation');
+
 var invariant = require("fbjs/lib/invariant");
 
 var _require = require('./TypeID'),
@@ -28,6 +36,7 @@ var _require = require('./TypeID'),
 var CONDITION = RelayConcreteNode.CONDITION,
     CLIENT_EXTENSION = RelayConcreteNode.CLIENT_EXTENSION,
     DEFER = RelayConcreteNode.DEFER,
+    FLIGHT_FIELD = RelayConcreteNode.FLIGHT_FIELD,
     FRAGMENT_SPREAD = RelayConcreteNode.FRAGMENT_SPREAD,
     INLINE_FRAGMENT = RelayConcreteNode.INLINE_FRAGMENT,
     LINKED_FIELD = RelayConcreteNode.LINKED_FIELD,
@@ -37,7 +46,8 @@ var CONDITION = RelayConcreteNode.CONDITION,
     SCALAR_HANDLE = RelayConcreteNode.SCALAR_HANDLE,
     STREAM = RelayConcreteNode.STREAM,
     TYPE_DISCRIMINATOR = RelayConcreteNode.TYPE_DISCRIMINATOR;
-var getStorageKey = RelayStoreUtils.getStorageKey,
+var ROOT_ID = RelayStoreUtils.ROOT_ID,
+    getStorageKey = RelayStoreUtils.getStorageKey,
     getModuleOperationKey = RelayStoreUtils.getModuleOperationKey;
 
 function mark(recordSource, selector, references, operationLoader) {
@@ -55,6 +65,7 @@ function mark(recordSource, selector, references, operationLoader) {
 var RelayReferenceMarker = /*#__PURE__*/function () {
   function RelayReferenceMarker(recordSource, variables, references, operationLoader) {
     this._operationLoader = operationLoader !== null && operationLoader !== void 0 ? operationLoader : null;
+    this._operationName = null;
     this._recordSource = recordSource;
     this._references = references;
     this._variables = variables;
@@ -63,6 +74,10 @@ var RelayReferenceMarker = /*#__PURE__*/function () {
   var _proto = RelayReferenceMarker.prototype;
 
   _proto.mark = function mark(node, dataID) {
+    if (node.kind === 'Operation' || node.kind === 'SplitOperation') {
+      this._operationName = node.name;
+    }
+
     this._traverse(node, dataID);
   };
 
@@ -127,6 +142,7 @@ var RelayReferenceMarker = /*#__PURE__*/function () {
           }
 
           break;
+        // $FlowFixMe[incompatible-type]
 
         case FRAGMENT_SPREAD:
           !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReferenceMarker(): Unexpected fragment spread `...%s`, ' + 'expected all fragments to be inlined.', selection.name) : invariant(false) : void 0;
@@ -184,6 +200,15 @@ var RelayReferenceMarker = /*#__PURE__*/function () {
 
           break;
 
+        case FLIGHT_FIELD:
+          if (RelayFeatureFlags.ENABLE_REACT_FLIGHT_COMPONENT_FIELD) {
+            _this._traverseFlightField(selection, record);
+          } else {
+            throw new Error('Flight fields are not yet supported.');
+          }
+
+          break;
+
         default:
           selection;
           !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReferenceMarker: Unknown AST node `%s`.', selection) : invariant(false) : void 0;
@@ -192,8 +217,10 @@ var RelayReferenceMarker = /*#__PURE__*/function () {
   };
 
   _proto._traverseModuleImport = function _traverseModuleImport(moduleImport, record) {
+    var _this$_operationName;
+
     var operationLoader = this._operationLoader;
-    !(operationLoader !== null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReferenceMarker: Expected an operationLoader to be configured when using `@module`.') : invariant(false) : void 0;
+    !(operationLoader !== null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayReferenceMarker: Expected an operationLoader to be configured when using `@module`. ' + 'Could not load fragment `%s` in operation `%s`.', moduleImport.fragmentName, (_this$_operationName = this._operationName) !== null && _this$_operationName !== void 0 ? _this$_operationName : '(unknown)') : invariant(false) : void 0;
     var operationKey = getModuleOperationKey(moduleImport.documentName);
     var operationReference = RelayModernRecord.getValue(record, operationKey);
 
@@ -201,10 +228,12 @@ var RelayReferenceMarker = /*#__PURE__*/function () {
       return;
     }
 
-    var operation = operationLoader.get(operationReference);
+    var normalizationRootNode = operationLoader.get(operationReference);
+
+    if (normalizationRootNode != null) {
+      var selections = getOperation(normalizationRootNode).selections;
 
-    if (operation != null) {
-      this._traverseSelections(operation.selections, record);
+      this._traverseSelections(selections, record);
     } // Otherwise, if the operation is not available, we assume that the data
     // cannot have been processed yet and therefore isn't in the store to
     // begin with.
@@ -239,6 +268,59 @@ var RelayReferenceMarker = /*#__PURE__*/function () {
     });
   };
 
+  _proto._traverseFlightField = function _traverseFlightField(field, record) {
+    var storageKey = getStorageKey(field, this._variables);
+    var linkedID = RelayModernRecord.getLinkedRecordID(record, storageKey);
+
+    if (linkedID == null) {
+      return;
+    }
+
+    this._references.add(linkedID);
+
+    var reactFlightClientResponseRecord = this._recordSource.get(linkedID);
+
+    if (reactFlightClientResponseRecord == null) {
+      return;
+    }
+
+    var reachableQueries = RelayModernRecord.getValue(reactFlightClientResponseRecord, RelayStoreReactFlightUtils.REACT_FLIGHT_QUERIES_STORAGE_KEY);
+
+    if (!Array.isArray(reachableQueries)) {
+      return;
+    }
+
+    var operationLoader = this._operationLoader;
+    !(operationLoader !== null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'DataChecker: Expected an operationLoader to be configured when using ' + 'React Flight') : invariant(false) : void 0; // In Flight, the variables that are in scope for reachable queries aren't
+    // the same as what's in scope for the outer query.
+
+    var prevVariables = this._variables; // $FlowFixMe[incompatible-cast]
+
+    var _iterator = (0, _createForOfIteratorHelper2["default"])(reachableQueries),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var query = _step.value;
+        this._variables = query.variables;
+        var operationReference = query.module;
+        var normalizationRootNode = operationLoader.get(operationReference);
+
+        if (normalizationRootNode != null) {
+          var operation = getOperation(normalizationRootNode);
+
+          this._traverse(operation, ROOT_ID);
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+
+    this._variables = prevVariables;
+  };
+
   return RelayReferenceMarker;
 }();