relay-runtime 10.0.1 → 10.1.3

package/lib/mutations/commitMutation.js

@@ -16,8 +16,6 @@ var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers
 
 var RelayDeclarativeMutationConfig = require('./RelayDeclarativeMutationConfig');
 
-var RelayFeatureFlags = require('../util/RelayFeatureFlags');
-
 var invariant = require("fbjs/lib/invariant");
 
 var isRelayModernEnvironment = require('../store/isRelayModernEnvironment');
@@ -60,7 +58,7 @@ function commitMutation(environment, config) {
       onUnsubscribe = config.onUnsubscribe,
       variables = config.variables,
       uploadables = config.uploadables;
-  var operation = createOperationDescriptor(mutation, variables, generateUniqueClientID()); // TODO: remove this check after we fix flow.
+  var operation = createOperationDescriptor(mutation, variables, cacheConfig, generateUniqueClientID()); // TODO: remove this check after we fix flow.
 
   if (typeof optimisticResponse === 'function') {
     optimisticResponse = optimisticResponse();
@@ -82,7 +80,6 @@ function commitMutation(environment, config) {
 
   var errors = [];
   var subscription = environment.executeMutation({
-    cacheConfig: cacheConfig,
     operation: operation,
     optimisticResponse: optimisticResponse,
     optimisticUpdater: optimisticUpdater,

package/lib/mutations/validateMutation.js

@@ -12,14 +12,12 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
 var warning = require("fbjs/lib/warning");
 
+var hasOwnProperty = Object.prototype.hasOwnProperty;
+
 var validateMutation = function validateMutation() {};
 
 if (process.env.NODE_ENV !== "production") {
@@ -45,7 +43,8 @@ if (process.env.NODE_ENV !== "production") {
       visitedPaths: new Set(),
       variables: variables || {},
       missingDiff: {},
-      extraDiff: {}
+      extraDiff: {},
+      moduleImportPaths: new Set()
     };
     validateSelections(optimisticResponse, mutation.operation.selections, context);
     validateOptimisticResponse(optimisticResponse, context);
@@ -67,6 +66,7 @@ if (process.env.NODE_ENV !== "production") {
 
       case 'ScalarField':
       case 'LinkedField':
+      case 'FlightField':
         return validateField(optimisticResponse, selection, context);
 
       case 'InlineFragment':
@@ -88,6 +88,8 @@ if (process.env.NODE_ENV !== "production") {
         return;
 
       case 'ModuleImport':
+        return validateModuleImport(context);
+
       case 'LinkedHandle':
       case 'ScalarHandle':
       case 'Defer':
@@ -104,6 +106,10 @@ if (process.env.NODE_ENV !== "production") {
     }
   };
 
+  var validateModuleImport = function validateModuleImport(context) {
+    context.moduleImportPaths.add(context.path);
+  };
+
   var validateField = function validateField(optimisticResponse, field, context) {
     var fieldName = field.alias || field.name;
     var path = "".concat(context.path, ".").concat(fieldName);
@@ -111,7 +117,7 @@ if (process.env.NODE_ENV !== "production") {
 
     switch (field.kind) {
       case 'ScalarField':
-        if (optimisticResponse.hasOwnProperty(fieldName) === false) {
+        if (hasOwnProperty.call(optimisticResponse, fieldName) === false) {
           addFieldToDiff(path, context.missingDiff, true);
         }
 
@@ -120,7 +126,7 @@ if (process.env.NODE_ENV !== "production") {
       case 'LinkedField':
         var selections = field.selections;
 
-        if (optimisticResponse[fieldName] === null || Object.hasOwnProperty(fieldName) && optimisticResponse[fieldName] === undefined) {
+        if (optimisticResponse[fieldName] === null || hasOwnProperty.call(optimisticResponse, fieldName) && optimisticResponse[fieldName] === undefined) {
           return;
         }
 
@@ -128,7 +134,7 @@ if (process.env.NODE_ENV !== "production") {
           if (Array.isArray(optimisticResponse[fieldName])) {
             optimisticResponse[fieldName].forEach(function (r) {
               if (r !== null) {
-                validateSelections(r, selections, _objectSpread({}, context, {
+                validateSelections(r, selections, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, context), {}, {
                   path: path
                 }));
               }
@@ -140,7 +146,7 @@ if (process.env.NODE_ENV !== "production") {
           }
         } else {
           if (optimisticResponse[fieldName] instanceof Object) {
-            validateSelections(optimisticResponse[fieldName], selections, _objectSpread({}, context, {
+            validateSelections(optimisticResponse[fieldName], selections, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, context), {}, {
               path: path
             }));
             return;
@@ -150,6 +156,12 @@ if (process.env.NODE_ENV !== "production") {
           }
         }
 
+      case 'FlightField':
+        if (optimisticResponse[fieldName] === null || hasOwnProperty.call(optimisticResponse, fieldName) && optimisticResponse[fieldName] === undefined) {
+          return;
+        }
+
+        throw new Error('validateMutation: Flight fields are not compatible with ' + 'optimistic updates, as React does not have the component code ' + 'necessary to process new data on the client. Instead, you ' + 'should update your code to require a full refetch of the Flight ' + 'field so your UI can be updated.');
     }
   };
 
@@ -165,7 +177,11 @@ if (process.env.NODE_ENV !== "production") {
 
     Object.keys(optimisticResponse).forEach(function (key) {
       var value = optimisticResponse[key];
-      var path = "".concat(context.path, ".").concat(key);
+      var path = "".concat(context.path, ".").concat(key); // if it's a module import path we don't have an ast so we cannot validate it
+
+      if (context.moduleImportPaths.has(path)) {
+        return;
+      }
 
       if (!context.visitedPaths.has(path)) {
         addFieldToDiff(path, context.extraDiff);
@@ -173,7 +189,7 @@ if (process.env.NODE_ENV !== "production") {
       }
 
       if (value instanceof Object) {
-        validateOptimisticResponse(value, _objectSpread({}, context, {
+        validateOptimisticResponse(value, (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, context), {}, {
           path: path
         }));
       }

package/lib/network/RelayQueryResponseCache.js

@@ -12,11 +12,7 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
 var invariant = require("fbjs/lib/invariant");
 
@@ -57,8 +53,8 @@ var RelayQueryResponseCache = /*#__PURE__*/function () {
 
     var response = this._responses.get(cacheKey);
 
-    return response != null ? _objectSpread({}, response.payload, {
-      extensions: _objectSpread({}, response.payload.extensions, {
+    return response != null ? (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, response.payload), {}, {
+      extensions: (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, response.payload.extensions), {}, {
         cacheTimestamp: response.fetchTime
       })
     }) : null;

package/lib/query/GraphQLTag.js

@@ -21,7 +21,7 @@ var warning = require("fbjs/lib/warning");
  * All calls to this function should be transformed by the plugin.
  */
 function graphql(strings) {
-  !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'graphql: Unexpected invocation at runtime. Either the Babel transform ' + 'was not set up, or it failed to identify this call site. Make sure it ' + 'is being used verbatim as `graphql`.') : invariant(false) : void 0;
+  !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'graphql: Unexpected invocation at runtime. Either the Babel transform ' + 'was not set up, or it failed to identify this call site. Make sure it ' + 'is being used verbatim as `graphql`. Note also that there cannot be ' + 'a space between graphql and the backtick that follows.') : invariant(false) : void 0;
 }
 
 function getNode(taggedNode) {
@@ -100,6 +100,7 @@ function getInlineDataFragment(taggedNode) {
 
 module.exports = {
   getFragment: getFragment,
+  getNode: getNode,
   getPaginationFragment: getPaginationFragment,
   getRefetchableFragment: getRefetchableFragment,
   getRequest: getRequest,

package/lib/query/fetchQuery.js

@@ -28,10 +28,9 @@ function fetchQuery(environment, taggedNode, variables, cacheConfig) {
     throw new Error('fetchQuery: Expected query operation');
   }
 
-  var operation = createOperationDescriptor(query, variables);
+  var operation = createOperationDescriptor(query, variables, cacheConfig);
   return environment.execute({
-    operation: operation,
-    cacheConfig: cacheConfig
+    operation: operation
   }).map(function () {
     return environment.lookup(operation.fragment).data;
   }).toPromise();

package/lib/query/fetchQueryInternal.js

@@ -82,11 +82,10 @@ var requestCachesByEnvironment = WEAKMAP_SUPPORTED ? new WeakMap() : new Map();
  * ```
  */
 
-function fetchQuery(environment, operation, options) {
+function fetchQuery(environment, operation) {
   return fetchQueryDeduped(environment, operation.request.identifier, function () {
     return environment.execute({
-      operation: operation,
-      cacheConfig: options === null || options === void 0 ? void 0 : options.networkCacheConfig
+      operation: operation
     });
   });
 }

package/lib/store/DataChecker.js

@@ -11,11 +11,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 RelayConcreteNode = require('../util/RelayConcreteNode');
 
@@ -27,12 +25,16 @@ var RelayRecordSourceMutator = require('../mutations/RelayRecordSourceMutator');
 
 var RelayRecordSourceProxy = require('../mutations/RelayRecordSourceProxy');
 
+var RelayStoreReactFlightUtils = require('./RelayStoreReactFlightUtils');
+
 var RelayStoreUtils = require('./RelayStoreUtils');
 
 var cloneRelayHandleSourceField = require('./cloneRelayHandleSourceField');
 
 var cloneRelayScalarHandleSourceField = require('./cloneRelayScalarHandleSourceField');
 
+var getOperation = require('../util/getOperation');
+
 var invariant = require("fbjs/lib/invariant");
 
 var _require = require('./ClientID'),
@@ -48,6 +50,7 @@ var _require3 = 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,
@@ -57,7 +60,8 @@ var CONDITION = RelayConcreteNode.CONDITION,
     SCALAR_HANDLE = RelayConcreteNode.SCALAR_HANDLE,
     STREAM = RelayConcreteNode.STREAM,
     TYPE_DISCRIMINATOR = RelayConcreteNode.TYPE_DISCRIMINATOR;
-var getModuleOperationKey = RelayStoreUtils.getModuleOperationKey,
+var ROOT_ID = RelayStoreUtils.ROOT_ID,
+    getModuleOperationKey = RelayStoreUtils.getModuleOperationKey,
     getStorageKey = RelayStoreUtils.getStorageKey,
     getArgumentValues = RelayStoreUtils.getArgumentValues;
 /**
@@ -141,7 +145,7 @@ var DataChecker = /*#__PURE__*/function () {
         args = _this$_getDataForHand.args,
         record = _this$_getDataForHand.record;
 
-    var _iterator = _createForOfIteratorHelper(this._handlers),
+    var _iterator = (0, _createForOfIteratorHelper2["default"])(this._handlers),
         _step;
 
     try {
@@ -170,7 +174,7 @@ var DataChecker = /*#__PURE__*/function () {
         args = _this$_getDataForHand2.args,
         record = _this$_getDataForHand2.record;
 
-    var _iterator2 = _createForOfIteratorHelper(this._handlers),
+    var _iterator2 = (0, _createForOfIteratorHelper2["default"])(this._handlers),
         _step2;
 
     try {
@@ -201,7 +205,7 @@ var DataChecker = /*#__PURE__*/function () {
         args = _this$_getDataForHand3.args,
         record = _this$_getDataForHand3.record;
 
-    var _iterator3 = _createForOfIteratorHelper(this._handlers),
+    var _iterator3 = (0, _createForOfIteratorHelper2["default"])(this._handlers),
         _step3;
 
     try {
@@ -358,6 +362,7 @@ var DataChecker = /*#__PURE__*/function () {
           _this2._traverseSelections(selection.selections, dataID);
 
           break;
+        // $FlowFixMe[incompatible-type]
 
         case FRAGMENT_SPREAD:
           !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayAsyncLoader(): Unexpected ast kind `%s`.', selection.kind) : invariant(false) : void 0; // $FlowExpectedError[unreachable-code] - we need the break; for OSS linter
@@ -394,6 +399,15 @@ var DataChecker = /*#__PURE__*/function () {
 
           break;
 
+        case FLIGHT_FIELD:
+          if (RelayFeatureFlags.ENABLE_REACT_FLIGHT_COMPONENT_FIELD) {
+            _this2._checkFlightField(selection, dataID);
+          } else {
+            throw new Error('Flight fields are not yet supported.');
+          }
+
+          break;
+
         default:
           selection;
           !false ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayAsyncLoader(): Unexpected ast kind `%s`.', selection.kind) : invariant(false) : void 0;
@@ -416,9 +430,11 @@ var DataChecker = /*#__PURE__*/function () {
       return;
     }
 
-    var operation = operationLoader.get(operationReference);
+    var normalizationRootNode = operationLoader.get(operationReference);
+
+    if (normalizationRootNode != null) {
+      var operation = getOperation(normalizationRootNode);
 
-    if (operation != null) {
       this._traverse(operation, dataID);
     } else {
       // If the fragment is not available, we assume that the data cannot have been
@@ -487,6 +503,65 @@ var DataChecker = /*#__PURE__*/function () {
     }
   };
 
+  _proto._checkFlightField = function _checkFlightField(field, dataID) {
+    var storageKey = getStorageKey(field, this._variables);
+
+    var linkedID = this._mutator.getLinkedRecordID(dataID, storageKey);
+
+    if (linkedID == null) {
+      if (linkedID === undefined) {
+        this._handleMissing();
+
+        return;
+      }
+
+      return;
+    }
+
+    var tree = this._mutator.getValue(linkedID, RelayStoreReactFlightUtils.REACT_FLIGHT_TREE_STORAGE_KEY);
+
+    var reachableQueries = this._mutator.getValue(linkedID, RelayStoreReactFlightUtils.REACT_FLIGHT_QUERIES_STORAGE_KEY);
+
+    if (tree == null || !Array.isArray(reachableQueries)) {
+      this._handleMissing();
+
+      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 _iterator4 = (0, _createForOfIteratorHelper2["default"])(reachableQueries),
+        _step4;
+
+    try {
+      for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
+        var query = _step4.value;
+        this._variables = query.variables;
+        var normalizationRootNode = operationLoader.get(query.module);
+
+        if (normalizationRootNode != null) {
+          var operation = getOperation(normalizationRootNode);
+
+          this._traverseSelections(operation.selections, ROOT_ID);
+        } else {
+          // If the fragment is not available, we assume that the data cannot have
+          // been processed yet and must therefore be missing.
+          this._handleMissing();
+        }
+      }
+    } catch (err) {
+      _iterator4.e(err);
+    } finally {
+      _iterator4.f();
+    }
+
+    this._variables = prevVariables;
+  };
+
   return DataChecker;
 }();
 

package/lib/store/RelayConcreteVariables.js

@@ -12,11 +12,7 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
 var invariant = require("fbjs/lib/invariant");
 
@@ -34,7 +30,7 @@ function getFragmentVariables(fragment, rootVariables, argumentVariables) {
       return;
     }
 
-    variables = variables || _objectSpread({}, argumentVariables);
+    variables = variables || (0, _objectSpread2["default"])({}, argumentVariables);
 
     switch (definition.kind) {
       case 'LocalArgument':