relay-runtime 9.0.0 → 10.1.0

package/lib/store/defaultRequiredFieldLogger.js

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ *
+ * 
+ * @format
+ */
+'use strict';
+
+var defaultRequiredFieldLogger = function defaultRequiredFieldLogger(event) {
+  if (process.env.NODE_ENV !== "production" && event.kind === 'missing_field.log') {
+    throw new Error('Relay Environment Configuration Error (dev only): `@required(action: LOG)` requires that the Relay Environment be configured with a `requiredFieldLogger`.');
+  }
+};
+
+module.exports = defaultRequiredFieldLogger;

package/lib/store/normalizeRelayPayload.js

@@ -12,7 +12,11 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread"));
+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 RelayModernRecord = require('./RelayModernRecord');
 
@@ -27,7 +31,7 @@ function normalizeRelayPayload(selector, payload, errors, options) {
   var source = RelayRecordSource.create();
   source.set(selector.dataID, RelayModernRecord.create(selector.dataID, ROOT_TYPE));
   var relayPayload = RelayResponseNormalizer.normalize(source, selector, payload, options);
-  return (0, _objectSpread2["default"])({}, relayPayload, {
+  return _objectSpread(_objectSpread({}, relayPayload), {}, {
     errors: errors
   });
 }

package/lib/store/readInlineData.js

@@ -27,7 +27,7 @@ function readInlineData(fragment, fragmentRef) {
     return fragmentRef;
   }
 
-  !(typeof fragmentRef === 'object') ? process.env.NODE_ENV !== "production" ? invariant(false, 'readInlineData(): Expected an object, got `%s`.', typeof fragmentRef) : invariant(false) : void 0; // $FlowFixMe
+  !(typeof fragmentRef === 'object') ? process.env.NODE_ENV !== "production" ? invariant(false, 'readInlineData(): Expected an object, got `%s`.', typeof fragmentRef) : invariant(false) : void 0; // $FlowFixMe[incompatible-use]
 
   var inlineData = (_fragmentRef$FRAGMENT = fragmentRef[FRAGMENTS_KEY]) === null || _fragmentRef$FRAGMENT === void 0 ? void 0 : _fragmentRef$FRAGMENT[inlineDataFragment.name];
   !(inlineData != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'readInlineData(): Expected fragment `%s` to be spread in the parent ' + 'fragment.', inlineDataFragment.name) : invariant(false) : void 0;

package/lib/subscription/requestSubscription.js

@@ -31,8 +31,9 @@ function requestSubscription(environment, config) {
       onCompleted = config.onCompleted,
       onError = config.onError,
       onNext = config.onNext,
-      variables = config.variables;
-  var operation = createOperationDescriptor(subscription, variables);
+      variables = config.variables,
+      cacheConfig = config.cacheConfig;
+  var operation = createOperationDescriptor(subscription, variables, cacheConfig);
   process.env.NODE_ENV !== "production" ? warning(!(config.updater && configs), 'requestSubscription: Expected only one of `updater` and `configs` to be provided') : void 0;
 
   var _ref = configs ? RelayDeclarativeMutationConfig.convert(configs, subscription, null
@@ -44,7 +45,7 @@ function requestSubscription(environment, config) {
     operation: operation,
     updater: updater
   }).map(function () {
-    var data = environment.lookup(operation.fragment).data; // $FlowFixMe
+    var data = environment.lookup(operation.fragment).data; // $FlowFixMe[incompatible-cast]
 
     return data;
   }).subscribe({

package/lib/util/NormalizationNode.js

@@ -8,8 +8,4 @@
  * @format
  */
 // flowlint ambiguous-object-type:error
-'use strict';
-/**
- * Represents a single operation used to processing and normalize runtime
- * request results.
- */
+'use strict';

package/lib/util/RelayConcreteNode.js

@@ -11,21 +11,24 @@
 'use strict';
 
 /**
- * Represents a common GraphQL request with `text` (or persisted `id`) can be
- * used to execute it, an `operation` containing information to normalize the
- * results, and a `fragment` derived from that operation to read the response
- * data (masking data from child fragments).
+ * Represents a common GraphQL request that can be executed, an `operation`
+ * containing information to normalize the results, and a `fragment` derived
+ * from that operation to read the response data (masking data from child
+ * fragments).
  */
 
 /**
- * Contains the `text` (or persisted `id`) required for executing a common
- * GraphQL request.
+ * Contains the parameters required for executing a GraphQL request.
+ * The operation can either be provided as a persisted `id` or `text`. If given
+ * in `text` format, a `cacheID` as a hash of the text should be set to be used
+ * for local caching.
  */
 var RelayConcreteNode = {
   CONDITION: 'Condition',
   CLIENT_EXTENSION: 'ClientExtension',
   DEFER: 'Defer',
   CONNECTION: 'Connection',
+  FLIGHT_FIELD: 'FlightField',
   FRAGMENT: 'Fragment',
   FRAGMENT_SPREAD: 'FragmentSpread',
   INLINE_DATA_FRAGMENT_SPREAD: 'InlineDataFragmentSpread',
@@ -37,6 +40,7 @@ var RelayConcreteNode = {
   LIST_VALUE: 'ListValue',
   LOCAL_ARGUMENT: 'LocalArgument',
   MODULE_IMPORT: 'ModuleImport',
+  REQUIRED_FIELD: 'RequiredField',
   OBJECT_VALUE: 'ObjectValue',
   OPERATION: 'Operation',
   REQUEST: 'Request',
@@ -45,6 +49,7 @@ var RelayConcreteNode = {
   SCALAR_HANDLE: 'ScalarHandle',
   SPLIT_OPERATION: 'SplitOperation',
   STREAM: 'Stream',
+  TYPE_DISCRIMINATOR: 'TypeDiscriminator',
   VARIABLE: 'Variable'
 };
 module.exports = RelayConcreteNode;

package/lib/util/RelayError.js

@@ -13,19 +13,49 @@
  * @private
  */
 
-function createError(type, name, message) {
-  var error = new Error(message);
-  error.name = name;
-  error.type = type;
-  error.framesToPop = 2;
+function createError(type, name, messageFormat) {
+  for (var _len = arguments.length, messageParams = new Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
+    messageParams[_key - 3] = arguments[_key];
+  }
+
+  var index = 0;
+  var message = messageFormat.replace(/%s/g, function () {
+    return String(messageParams[index++]);
+  });
+  var err = new Error(message);
+  var error = Object.assign(err, {
+    name: name,
+    messageFormat: messageFormat,
+    messageParams: messageParams,
+    type: type,
+    taalOpcodes: [2, 2] // skip frame (code=2) twice
+
+  }); // In V8, Error objects keep the closure scope chain alive until the
+  // err.stack property is accessed.
+
+  if (error.stack === undefined) {
+    // IE sets the stack only if error is thrown
+    try {
+      throw error;
+    } catch (_unused) {}
+  }
+
   return error;
 }
 
 module.exports = {
-  create: function create(name, message) {
-    return createError('error', name, message);
+  create: function create(name, messageFormat) {
+    for (var _len2 = arguments.length, messageParams = new Array(_len2 > 2 ? _len2 - 2 : 0), _key2 = 2; _key2 < _len2; _key2++) {
+      messageParams[_key2 - 2] = arguments[_key2];
+    }
+
+    return createError.apply(void 0, ['error', name, messageFormat].concat(messageParams));
   },
-  createWarning: function createWarning(name, message) {
-    return createError('warn', name, message);
+  createWarning: function createWarning(name, messageFormat) {
+    for (var _len3 = arguments.length, messageParams = new Array(_len3 > 2 ? _len3 - 2 : 0), _key3 = 2; _key3 < _len3; _key3++) {
+      messageParams[_key3 - 2] = arguments[_key3];
+    }
+
+    return createError.apply(void 0, ['warn', name, messageFormat].concat(messageParams));
   }
 };

package/lib/util/RelayFeatureFlags.js

@@ -11,10 +11,13 @@
 'use strict';
 
 var RelayFeatureFlags = {
-  // T45504512: new connection model
   ENABLE_VARIABLE_CONNECTION_KEY: false,
   ENABLE_PARTIAL_RENDERING_DEFAULT: false,
-  ENABLE_RELAY_CONTAINERS_SUSPENSE: true,
-  ENABLE_UNIQUE_MUTATION_ROOT: true
+  ENABLE_RELAY_CONTAINERS_SUSPENSE: false,
+  ENABLE_PRECISE_TYPE_REFINEMENT: false,
+  ENABLE_REACT_FLIGHT_COMPONENT_FIELD: false,
+  ENABLE_REQUIRED_DIRECTIVES: false,
+  ENABLE_GETFRAGMENTIDENTIFIER_OPTIMIZATION: false,
+  ENABLE_FRIENDLY_QUERY_NAME_GQL_URL: false
 };
 module.exports = RelayFeatureFlags;

package/lib/util/RelayReplaySubject.js

@@ -24,9 +24,7 @@ var invariant = require("fbjs/lib/invariant");
  * Records events provided and synchronously plays them back to new subscribers,
  * as well as forwarding new asynchronous events.
  */
-var RelayReplaySubject =
-/*#__PURE__*/
-function () {
+var RelayReplaySubject = /*#__PURE__*/function () {
   function RelayReplaySubject() {
     var _this = this;
 
@@ -130,6 +128,8 @@ function () {
   _proto.unsubscribe = function unsubscribe() {
     if (this._subscription) {
       this._subscription.unsubscribe();
+
+      this._subscription = null;
     }
   };
 

package/lib/util/createPayloadFor3DField.js

@@ -13,14 +13,19 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread"));
+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 _require = require('../store/RelayStoreUtils'),
     getModuleComponentKey = _require.getModuleComponentKey,
     getModuleOperationKey = _require.getModuleOperationKey;
 
 function createPayloadFor3DField(name, operation, component, response) {
-  var data = (0, _objectSpread2["default"])({}, response);
+  var data = _objectSpread({}, response);
+
   data[getModuleComponentKey(name)] = component;
   data[getModuleOperationKey(name)] = operation;
   return data;

package/lib/util/getFragmentIdentifier.js

@@ -11,6 +11,10 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
+var RelayFeatureFlags = require('./RelayFeatureFlags');
+
+var isEmptyObject = require('./isEmptyObject');
+
 var stableCopy = require('./stableCopy');
 
 var _require = require('../store/RelayModernSelector'),
@@ -19,15 +23,20 @@ var _require = require('../store/RelayModernSelector'),
     getSelector = _require.getSelector;
 
 function getFragmentIdentifier(fragmentNode, fragmentRef) {
-  var _JSON$stringify;
-
   var selector = getSelector(fragmentNode, fragmentRef);
   var fragmentOwnerIdentifier = selector == null ? 'null' : selector.kind === 'SingularReaderSelector' ? selector.owner.identifier : '[' + selector.selectors.map(function (sel) {
     return sel.owner.identifier;
   }).join(',') + ']';
   var fragmentVariables = getVariablesFromFragment(fragmentNode, fragmentRef);
   var dataIDs = getDataIDsFromFragment(fragmentNode, fragmentRef);
-  return fragmentOwnerIdentifier + '/' + fragmentNode.name + '/' + JSON.stringify(stableCopy(fragmentVariables)) + '/' + ((_JSON$stringify = JSON.stringify(dataIDs)) !== null && _JSON$stringify !== void 0 ? _JSON$stringify : 'missing');
+
+  if (RelayFeatureFlags.ENABLE_GETFRAGMENTIDENTIFIER_OPTIMIZATION) {
+    return fragmentOwnerIdentifier + '/' + fragmentNode.name + '/' + (fragmentVariables == null || isEmptyObject(fragmentVariables) ? '{}' : JSON.stringify(stableCopy(fragmentVariables))) + '/' + (typeof dataIDs === 'undefined' ? 'missing' : dataIDs == null ? 'null' : Array.isArray(dataIDs) ? '[' + dataIDs.join(',') + ']' : dataIDs);
+  } else {
+    var _JSON$stringify;
+
+    return fragmentOwnerIdentifier + '/' + fragmentNode.name + '/' + JSON.stringify(stableCopy(fragmentVariables)) + '/' + ((_JSON$stringify = JSON.stringify(dataIDs)) !== null && _JSON$stringify !== void 0 ? _JSON$stringify : 'missing');
+  }
 }
 
 module.exports = getFragmentIdentifier;

package/lib/util/getOperation.js

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ *
+ * 
+ * @format
+ * @emails oncall+relay
+ */
+// flowlint ambiguous-object-type:error
+'use strict';
+
+var _require = require('./RelayConcreteNode'),
+    REQUEST = _require.REQUEST,
+    SPLIT_OPERATION = _require.SPLIT_OPERATION;
+
+/**
+ * OperationLoaders can return either a NormalizationSplitOperation or
+ * ConcreteRequest.
+ */
+function getOperation(node) {
+  switch (node.kind) {
+    case REQUEST:
+      return node.operation;
+
+    case SPLIT_OPERATION:
+    default:
+      return node;
+  }
+}
+
+module.exports = getOperation;

package/lib/util/getRequestIdentifier.js

@@ -19,8 +19,8 @@ var stableCopy = require('./stableCopy');
  * variables.
  */
 function getRequestIdentifier(parameters, variables) {
-  var requestID = parameters.id != null ? parameters.id : parameters.text;
-  !(requestID != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'getRequestIdentifier: Expected request `%s` to have either a ' + 'valid `id` or `text` property', parameters.name) : invariant(false) : void 0;
+  var requestID = parameters.cacheID != null ? parameters.cacheID : parameters.id;
+  !(requestID != null) ? process.env.NODE_ENV !== "production" ? invariant(false, 'getRequestIdentifier: Expected request `%s` to have either a ' + 'valid `id` or `cacheID` property', parameters.name) : invariant(false) : void 0;
   return requestID + JSON.stringify(stableCopy(variables));
 }
 

package/lib/util/isEmptyObject.js

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ *
+ * 
+ * @format
+ * @emails oncall+relay
+ */
+'use strict';
+
+var hasOwnProperty = Object.prototype.hasOwnProperty;
+
+function isEmptyObject(obj) {
+  for (var _key in obj) {
+    if (hasOwnProperty.call(obj, _key)) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+module.exports = isEmptyObject;

package/lib/util/recycleNodesInto.js

@@ -9,12 +9,15 @@
  */
 // flowlint ambiguous-object-type:error
 'use strict';
+
+var hasWeakSetDefined = typeof WeakSet !== 'undefined';
+var hasWeakMapDefined = typeof WeakMap !== 'undefined';
 /**
  * Recycles subtrees from `prevData` by replacing equal subtrees in `nextData`.
  */
 
 function recycleNodesInto(prevData, nextData) {
-  if (prevData === nextData || typeof prevData !== 'object' || !prevData || typeof nextData !== 'object' || !nextData) {
+  if (prevData === nextData || typeof prevData !== 'object' || prevData instanceof Set || prevData instanceof Map || hasWeakSetDefined && prevData instanceof WeakSet || hasWeakMapDefined && prevData instanceof WeakMap || !prevData || typeof nextData !== 'object' || nextData instanceof Set || nextData instanceof Map || hasWeakSetDefined && nextData instanceof WeakSet || hasWeakMapDefined && nextData instanceof WeakMap || !nextData) {
     return nextData;
   }
 
@@ -53,15 +56,11 @@ function recycleNodesInto(prevData, nextData) {
       if (nextValue !== nextObject[key]) {
         if (process.env.NODE_ENV !== "production") {
           if (!Object.isFrozen(nextObject)) {
-            /* $FlowFixMe(>=0.98.0 site=www,mobile,react_native_fb,oss) This
-             * comment suppresses an error found when Flow v0.98 was deployed.
-             * To see the error delete this comment and run Flow. */
+            // $FlowFixMe[cannot-write]
             nextObject[key] = nextValue;
           }
         } else {
-          /* $FlowFixMe(>=0.98.0 site=www,mobile,react_native_fb,oss) This comment
-           * suppresses an error found when Flow v0.98 was deployed. To see
-           * the error delete this comment and run Flow. */
+          // $FlowFixMe[cannot-write]
           nextObject[key] = nextValue;
         }
       }

package/lib/util/reportMissingRequiredFields.js

@@ -0,0 +1,48 @@
+/**
+ * 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.
+ *
+ * 
+ * @emails oncall+relay
+ * @format
+ */
+'use strict';
+
+function reportMissingRequiredFields(environment, missingRequiredFields) {
+  switch (missingRequiredFields.action) {
+    case 'THROW':
+      {
+        var _missingRequiredField = missingRequiredFields.field,
+            path = _missingRequiredField.path,
+            owner = _missingRequiredField.owner; // This gives the consumer the chance to throw their own error if they so wish.
+
+        environment.requiredFieldLogger({
+          kind: 'missing_field.throw',
+          owner: owner,
+          fieldPath: path
+        });
+        throw new Error("Relay: Missing @required value at path '".concat(path, "' in '").concat(owner, "'."));
+      }
+
+    case 'LOG':
+      missingRequiredFields.fields.forEach(function (_ref) {
+        var path = _ref.path,
+            owner = _ref.owner;
+        environment.requiredFieldLogger({
+          kind: 'missing_field.log',
+          owner: owner,
+          fieldPath: path
+        });
+      });
+      break;
+
+    default:
+      {
+        missingRequiredFields.action;
+      }
+  }
+}
+
+module.exports = reportMissingRequiredFields;