relay-runtime 10.0.1 → 10.1.3

package/lib/store/StoreInspector.js

@@ -13,14 +13,10 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/objectSpread2"));
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
-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 inspect = function inspect() {};
 
 if (process.env.NODE_ENV !== "production") {
@@ -138,7 +134,7 @@ if (process.env.NODE_ENV !== "production") {
       return record;
     }
 
-    return new Proxy(_objectSpread({}, record), {
+    return new Proxy((0, _objectSpread2["default"])({}, record), {
       get: function get(target, prop) {
         var value = target[prop];
 

package/lib/store/createRelayContext.js

@@ -18,6 +18,11 @@ var firstReact;
 function createRelayContext(react) {
   if (!relayContext) {
     relayContext = react.createContext(null);
+
+    if (process.env.NODE_ENV !== "production") {
+      relayContext.displayName = 'RelayContext';
+    }
+
     firstReact = react;
   }
 

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,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 RelayModernRecord = require('./RelayModernRecord');
 
@@ -31,7 +27,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 _objectSpread({}, relayPayload, {
+  return (0, _objectSpread2["default"])((0, _objectSpread2["default"])({}, relayPayload), {}, {
     errors: errors
   });
 }

package/lib/subscription/requestSubscription.js

@@ -33,7 +33,7 @@ function requestSubscription(environment, config) {
       onNext = config.onNext,
       variables = config.variables,
       cacheConfig = config.cacheConfig;
-  var operation = createOperationDescriptor(subscription, variables);
+  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
@@ -43,8 +43,7 @@ function requestSubscription(environment, config) {
 
   var sub = environment.execute({
     operation: operation,
-    updater: updater,
-    cacheConfig: cacheConfig
+    updater: updater
   }).map(function () {
     var data = environment.lookup(operation.fragment).data; // $FlowFixMe[incompatible-cast]
 

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

@@ -28,6 +28,7 @@ var RelayConcreteNode = {
   CLIENT_EXTENSION: 'ClientExtension',
   DEFER: 'Defer',
   CONNECTION: 'Connection',
+  FLIGHT_FIELD: 'FlightField',
   FRAGMENT: 'Fragment',
   FRAGMENT_SPREAD: 'FragmentSpread',
   INLINE_DATA_FRAGMENT_SPREAD: 'InlineDataFragmentSpread',
@@ -39,6 +40,7 @@ var RelayConcreteNode = {
   LIST_VALUE: 'ListValue',
   LOCAL_ARGUMENT: 'LocalArgument',
   MODULE_IMPORT: 'ModuleImport',
+  REQUIRED_FIELD: 'RequiredField',
   OBJECT_VALUE: 'ObjectValue',
   OPERATION: 'Operation',
   REQUEST: 'Request',

package/lib/util/RelayFeatureFlags.js

@@ -11,10 +11,15 @@
 'use strict';
 
 var RelayFeatureFlags = {
-  // T45504512: new connection model
   ENABLE_VARIABLE_CONNECTION_KEY: false,
   ENABLE_PARTIAL_RENDERING_DEFAULT: false,
   ENABLE_RELAY_CONTAINERS_SUSPENSE: false,
-  ENABLE_PRECISE_TYPE_REFINEMENT: 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,
+  ENABLE_STORE_SUBSCRIPTIONS_REFACTOR: false,
+  ENABLE_LOAD_QUERY_REQUEST_DEDUPING: true
 };
 module.exports = RelayFeatureFlags;

package/lib/util/createPayloadFor3DField.js

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

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;

package/mutations/commitMutation.js.flow

@@ -13,7 +13,6 @@
 'use strict';
 
 const RelayDeclarativeMutationConfig = require('./RelayDeclarativeMutationConfig');
-const RelayFeatureFlags = require('../util/RelayFeatureFlags');
 
 const invariant = require('invariant');
 const isRelayModernEnvironment = require('../store/isRelayModernEnvironment');
@@ -115,6 +114,7 @@ function commitMutation<T: MutationParameters>(
   const operation = createOperationDescriptor(
     mutation,
     variables,
+    cacheConfig,
     generateUniqueClientID(),
   );
   // TODO: remove this check after we fix flow.
@@ -142,7 +142,6 @@ function commitMutation<T: MutationParameters>(
   const errors = [];
   const subscription = environment
     .executeMutation({
-      cacheConfig,
       operation,
       optimisticResponse,
       optimisticUpdater,

package/mutations/validateMutation.js.flow

@@ -19,16 +19,19 @@ import type {
 import type {ConcreteRequest} from '../util/RelayConcreteNode';
 import type {Variables} from '../util/RelayRuntimeTypes';
 
-type ValidationContext = {
+type ValidationContext = {|
   visitedPaths: Set<string>,
   path: string,
   variables: Variables,
   missingDiff: Object,
   extraDiff: Object,
-  ...
-};
+  moduleImportPaths: Set<string>,
+|};
+
 const warning = require('warning');
 
+const hasOwnProperty = Object.prototype.hasOwnProperty;
+
 let validateMutation = () => {};
 if (__DEV__) {
   const addFieldToDiff = (path: string, diff: Object, isScalar) => {
@@ -55,6 +58,7 @@ if (__DEV__) {
       variables: variables || {},
       missingDiff: {},
       extraDiff: {},
+      moduleImportPaths: new Set(),
     };
     validateSelections(
       optimisticResponse,
@@ -97,6 +101,7 @@ if (__DEV__) {
         return;
       case 'ScalarField':
       case 'LinkedField':
+      case 'FlightField':
         return validateField(optimisticResponse, selection, context);
       case 'InlineFragment':
         const type = selection.type;
@@ -114,6 +119,7 @@ if (__DEV__) {
         });
         return;
       case 'ModuleImport':
+        return validateModuleImport(context);
       case 'LinkedHandle':
       case 'ScalarHandle':
       case 'Defer':
@@ -128,6 +134,10 @@ if (__DEV__) {
     }
   };
 
+  const validateModuleImport = (context: ValidationContext) => {
+    context.moduleImportPaths.add(context.path);
+  };
+
   const validateField = (
     optimisticResponse: Object,
     field: NormalizationField,
@@ -138,7 +148,7 @@ if (__DEV__) {
     context.visitedPaths.add(path);
     switch (field.kind) {
       case 'ScalarField':
-        if (optimisticResponse.hasOwnProperty(fieldName) === false) {
+        if (hasOwnProperty.call(optimisticResponse, fieldName) === false) {
           addFieldToDiff(path, context.missingDiff, true);
         }
         return;
@@ -146,7 +156,7 @@ if (__DEV__) {
         const selections = field.selections;
         if (
           optimisticResponse[fieldName] === null ||
-          (Object.hasOwnProperty(fieldName) &&
+          (hasOwnProperty.call(optimisticResponse, fieldName) &&
             optimisticResponse[fieldName] === undefined)
         ) {
           return;
@@ -178,6 +188,21 @@ if (__DEV__) {
             return;
           }
         }
+      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.',
+        );
     }
   };
 
@@ -196,6 +221,10 @@ if (__DEV__) {
     Object.keys(optimisticResponse).forEach((key: string) => {
       const value = optimisticResponse[key];
       const path = `${context.path}.${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);
         return;

package/network/RelayNetworkTypes.js.flow

@@ -121,3 +121,25 @@ export type SubscribeFunction = (
 
 export type Uploadable = File | Blob;
 export type UploadableMap = {[key: string]: Uploadable, ...};
+
+/**
+ * React Flight tree created on the server.
+ */
+export type ReactFlightServerTree = mixed;
+export type ReactFlightPayloadQuery = {|
+  +id: mixed,
+  +module: mixed,
+  +response: GraphQLSingularResponse,
+  +variables: Variables,
+|};
+/**
+ * Data that is returned by a Flight compliant GraphQL server.
+ *
+ * - tree: an array of values that will be iterated and fed into
+ *     ReactFlightDOMRelayClient.
+ * - queries: an array of queries that the server preloaded for the client.
+ */
+export type ReactFlightPayloadData = {|
+  +tree: Array<ReactFlightServerTree>,
+  +queries: Array<ReactFlightPayloadQuery>,
+|};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "10.0.1",
+  "version": "10.1.3",
   "keywords": [
     "graphql",
     "relay"
@@ -12,7 +12,7 @@
   "repository": "facebook/relay",
   "dependencies": {
     "@babel/runtime": "^7.0.0",
-    "fbjs": "^1.0.0"
+    "fbjs": "^3.0.0"
   },
   "directories": {
     "": "./"

package/query/GraphQLTag.js.flow

@@ -44,7 +44,8 @@ function graphql(strings: Array<string>): GraphQLTaggedNode {
     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`.',
+      'is being used verbatim as `graphql`. Note also that there cannot be ' +
+      'a space between graphql and the backtick that follows.',
   );
 }
 
@@ -155,6 +156,7 @@ function getInlineDataFragment(
 
 module.exports = {
   getFragment,
+  getNode,
   getPaginationFragment,
   getRefetchableFragment,
   getRequest,

package/query/fetchQuery.js.flow

@@ -37,9 +37,9 @@ function fetchQuery<T: OperationType>(
   if (query.params.operationKind !== 'query') {
     throw new Error('fetchQuery: Expected query operation');
   }
-  const operation = createOperationDescriptor(query, variables);
+  const operation = createOperationDescriptor(query, variables, cacheConfig);
   return environment
-    .execute({operation, cacheConfig})
+    .execute({operation})
     .map(() => environment.lookup(operation.fragment).data)
     .toPromise();
 }

package/query/fetchQueryInternal.js.flow

@@ -24,7 +24,6 @@ import type {
   OperationDescriptor,
   RequestDescriptor,
 } from '../store/RelayStoreTypes';
-import type {CacheConfig} from '../util/RelayRuntimeTypes';
 import type {RequestIdentifier} from '../util/getRequestIdentifier';
 
 type RequestCacheEntry = {|
@@ -106,14 +105,10 @@ const requestCachesByEnvironment = WEAKMAP_SUPPORTED
 function fetchQuery(
   environment: IEnvironment,
   operation: OperationDescriptor,
-  options?: {|
-    networkCacheConfig?: CacheConfig,
-  |},
 ): Observable<GraphQLResponse> {
   return fetchQueryDeduped(environment, operation.request.identifier, () =>
     environment.execute({
       operation,
-      cacheConfig: options?.networkCacheConfig,
     }),
   );
 }