relay-runtime 13.0.1 → 13.0.2

package/README.md

@@ -1,5 +1,4 @@
-Relay Runtime
----
+## Relay Runtime
 
 A set of Relay APIs responsible for data fetching, reading and normalization of
 the GraphQL data.
@@ -7,7 +6,6 @@ the GraphQL data.
 Example:
 
 ```js
-
 // @flow strict-local
 
 import type {FetchFunction} from 'relay-runtime';
@@ -61,7 +59,6 @@ fetchQuery(
     console.log(data);
   },
 });
-
 ```
 
 For complete API reference, visit https://relay.dev/.

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v13.0.1
+ * Relay v13.0.2
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/lib/mutations/readUpdatableQuery_EXPERIMENTAL.js

@@ -21,7 +21,7 @@ var _require = require('../query/GraphQLTag'),
 var _require2 = require('../store/RelayStoreUtils'),
     getArgumentValues = _require2.getArgumentValues;
 
-var nonUpdatableKeys = ['id', '__id', '__typename'];
+var nonUpdatableKeys = ['id', '__id', '__typename', 'js'];
 
 function readUpdatableQuery_EXPERIMENTAL(query, variables, proxy) {
   // TODO assert that the concrete request is an updatable query
@@ -163,7 +163,7 @@ function createSetterForSingularLinkedField(selection, queryVariables, recordPro
 
     if (newValue == null) {
       // $FlowFixMe[unclear-type] No good way to type these variables
-      recordProxy.setValue(null, selection.name, variables);
+      recordProxy.setValue(newValue, selection.name, variables);
     } else {
       var __id = newValue.__id;
 

package/lib/network/RelayNetwork.js

@@ -27,7 +27,7 @@ function create(fetchFn, subscribe) {
   var observeFetch = convertFetch(fetchFn);
 
   function execute(request, variables, cacheConfig, uploadables, logRequestInfo) {
-    var operationVariables = withProvidedVariables(variables, request);
+    var operationVariables = withProvidedVariables(variables, request.providedVariables);
 
     if (request.operationKind === 'subscription') {
       !subscribe ? process.env.NODE_ENV !== "production" ? invariant(false, 'RelayNetwork: This network layer does not support Subscriptions. ' + 'To use Subscriptions, provide a custom network layer.') : invariant(false) : void 0;

package/lib/store/RelayConcreteVariables.js

@@ -76,7 +76,7 @@ function getFragmentVariables(fragment, rootVariables, argumentVariables) {
  */
 
 
-function getOperationVariables(operation, parameters, variables) {
+function getOperationVariables(operation, providedVariables, variables) {
   var operationVariables = {};
   operation.argumentDefinitions.forEach(function (def) {
     var value = def.defaultValue;
@@ -87,7 +87,6 @@ function getOperationVariables(operation, parameters, variables) {
 
     operationVariables[def.name] = value;
   });
-  var providedVariables = parameters.providedVariables;
 
   if (providedVariables != null) {
     Object.keys(providedVariables).forEach(function (varName) {

package/lib/store/RelayExperimentalGraphResponseTransform.js

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.normalizeResponse = normalizeResponse;
+exports.normalizeResponseWithMetadata = normalizeResponseWithMetadata;
+exports.GraphModeNormalizer = void 0;
 
 var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
 
@@ -30,7 +32,9 @@ var _require = require('../util/RelayConcreteNode'),
     FRAGMENT_SPREAD = _require.FRAGMENT_SPREAD,
     INLINE_FRAGMENT = _require.INLINE_FRAGMENT,
     LINKED_FIELD = _require.LINKED_FIELD,
-    SCALAR_FIELD = _require.SCALAR_FIELD;
+    LINKED_HANDLE = _require.LINKED_HANDLE,
+    SCALAR_FIELD = _require.SCALAR_FIELD,
+    SCALAR_HANDLE = _require.SCALAR_HANDLE;
 
 var _require2 = require('./RelayConcreteVariables'),
     getLocalVariables = _require2.getLocalVariables;
@@ -96,6 +100,17 @@ function normalizeResponse(response, selector, options) {
   return normalizer.normalizeResponse(node, dataID, response);
 }
 
+function normalizeResponseWithMetadata(response, selector, options) {
+  var node = selector.node,
+      variables = selector.variables,
+      dataID = selector.dataID;
+  var normalizer = new GraphModeNormalizer(variables, options);
+  var chunks = Array.from(normalizer.normalizeResponse(node, dataID, response));
+  return [chunks, {
+    duplicateFieldsAvoided: normalizer.duplicateFieldsAvoided
+  }];
+}
+
 var GraphModeNormalizer = /*#__PURE__*/function () {
   function GraphModeNormalizer(variables, options) {
     this._actorIdentifier = options.actorIdentifier;
@@ -105,6 +120,7 @@ var GraphModeNormalizer = /*#__PURE__*/function () {
     this._sentFields = new Map();
     this._nextStreamID = 0;
     this._variables = variables;
+    this.duplicateFieldsAvoided = 0;
   }
 
   var _proto = GraphModeNormalizer.prototype;
@@ -218,6 +234,7 @@ var GraphModeNormalizer = /*#__PURE__*/function () {
 
 
               if (sentFields.has(storageKey)) {
+                this.duplicateFieldsAvoided++;
                 break;
               }
 
@@ -237,6 +254,7 @@ var GraphModeNormalizer = /*#__PURE__*/function () {
 
 
               if (sentFields.has(_storageKey)) {
+                this.duplicateFieldsAvoided++;
                 break;
               }
 
@@ -310,6 +328,18 @@ var GraphModeNormalizer = /*#__PURE__*/function () {
             // over client extensions.
             break;
 
+          case SCALAR_HANDLE:
+          case LINKED_HANDLE:
+            // Handles allow us to record information that will be needed to
+            // perform additional process when we insert data into the store. For
+            // example, connection edges need to be prepended/appended to the
+            // pre-existing values.
+            //
+            // GraphMode will eventually need some replacement for this, but it is
+            // not nessesary in order to measure things like response size, so we
+            // can ignore these for now.
+            break;
+
           default:
             throw new Error("Unexpected selection type: ".concat(selection.kind));
         }
@@ -388,4 +418,6 @@ var GraphModeNormalizer = /*#__PURE__*/function () {
   };
 
   return GraphModeNormalizer;
-}();
+}();
+
+exports.GraphModeNormalizer = GraphModeNormalizer;

package/lib/store/RelayModernOperationDescriptor.js

@@ -34,7 +34,7 @@ var _require3 = require('./RelayStoreUtils'),
 function createOperationDescriptor(request, variables, cacheConfig) {
   var dataID = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : ROOT_ID;
   var operation = request.operation;
-  var operationVariables = getOperationVariables(operation, request.params, variables);
+  var operationVariables = getOperationVariables(operation, request.params.providedVariables, variables);
   var requestDescriptor = createRequestDescriptor(request, operationVariables, cacheConfig);
   var operationDescriptor = {
     fragment: createReaderSelector(request.fragment, dataID, operationVariables, requestDescriptor),

package/lib/store/RelayPublishQueue.js

@@ -10,7 +10,7 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-var _global$ErrorUtils$ap, _global, _global$ErrorUtils;
+var _global$ErrorUtils$ap, _global$ErrorUtils;
 
 var RelayRecordSourceMutator = require('../mutations/RelayRecordSourceMutator');
 
@@ -26,7 +26,9 @@ var invariant = require('invariant');
 
 var warning = require("fbjs/lib/warning");
 
-var applyWithGuard = (_global$ErrorUtils$ap = (_global = global) === null || _global === void 0 ? void 0 : (_global$ErrorUtils = _global.ErrorUtils) === null || _global$ErrorUtils === void 0 ? void 0 : _global$ErrorUtils.applyWithGuard) !== null && _global$ErrorUtils$ap !== void 0 ? _global$ErrorUtils$ap : function (callback, context, args, onError, name) {
+var _global = typeof global !== 'undefined' ? global : typeof window !== 'undefined' ? window : undefined;
+
+var applyWithGuard = (_global$ErrorUtils$ap = _global === null || _global === void 0 ? void 0 : (_global$ErrorUtils = _global.ErrorUtils) === null || _global$ErrorUtils === void 0 ? void 0 : _global$ErrorUtils.applyWithGuard) !== null && _global$ErrorUtils$ap !== void 0 ? _global$ErrorUtils$ap : function (callback, context, args, onError, name) {
   return callback.apply(context, args);
 };
 /**

package/lib/store/RelayReader.js

@@ -90,6 +90,7 @@ var RelayReader = /*#__PURE__*/function () {
     this._selector = selector;
     this._variables = selector.variables;
     this._resolverCache = resolverCache;
+    this._fragmentName = selector.node.name;
   }
 
   var _proto = RelayReader.prototype;
@@ -219,7 +220,7 @@ var RelayReader = /*#__PURE__*/function () {
       return;
     }
 
-    var owner = this._selector.node.name;
+    var owner = this._fragmentName;
 
     switch (action) {
       case 'THROW':
@@ -236,15 +237,21 @@ var RelayReader = /*#__PURE__*/function () {
         if (this._missingRequiredFields == null) {
           this._missingRequiredFields = {
             action: action,
-            fields: []
+            fields: [{
+              path: fieldPath,
+              owner: owner
+            }]
+          };
+        } else {
+          this._missingRequiredFields = {
+            action: action,
+            fields: [].concat((0, _toConsumableArray2["default"])(this._missingRequiredFields.fields), [{
+              path: fieldPath,
+              owner: owner
+            }])
           };
         }
 
-        this._missingRequiredFields.fields.push({
-          path: fieldPath,
-          owner: owner
-        });
-
         return;
 
       default:
@@ -466,9 +473,7 @@ var RelayReader = /*#__PURE__*/function () {
           throw new Error('Relay Resolver fields are not yet supported.');
         }
 
-        this._readResolverField(selection.field, record, data);
-
-        break;
+        return this._readResolverField(selection.field, record, data);
 
       default:
         selection.field.kind;
@@ -490,6 +495,8 @@ var RelayReader = /*#__PURE__*/function () {
 
     var fragmentValue;
     var fragmentReaderSelector;
+    var fragmentMissingRequiredFields;
+    var previousMissingRequriedFields;
     var fragmentSeenRecordIDs = new Set();
 
     var getDataForResolverFragment = function getDataForResolverFragment(singularReaderSelector) {
@@ -508,14 +515,18 @@ var RelayReader = /*#__PURE__*/function () {
 
         _this._seenRecords = fragmentSeenRecordIDs;
         var resolverFragmentData = {};
+        previousMissingRequriedFields = _this._missingRequiredFields;
+        _this._missingRequiredFields = null;
 
         _this._createInlineDataOrResolverFragmentPointer(singularReaderSelector.node, record, resolverFragmentData);
 
+        fragmentMissingRequiredFields = _this._missingRequiredFields;
         fragmentValue = (_resolverFragmentData = resolverFragmentData[FRAGMENTS_KEY]) === null || _resolverFragmentData === void 0 ? void 0 : _resolverFragmentData[fragment.name];
         !(typeof fragmentValue === 'object' && fragmentValue !== null) ? process.env.NODE_ENV !== "production" ? invariant(false, "Expected reader data to contain a __fragments property with a property for the fragment named ".concat(fragment.name, ", but it is missing.")) : invariant(false) : void 0;
         return fragmentValue;
       } finally {
         _this._seenRecords = existingSeenRecords;
+        _this._missingRequiredFields = previousMissingRequriedFields;
       }
     };
 
@@ -537,12 +548,18 @@ var RelayReader = /*#__PURE__*/function () {
           fragmentValue: fragmentValue,
           resolverID: resolverID,
           seenRecordIDs: fragmentSeenRecordIDs,
-          readerSelector: fragmentReaderSelector
+          readerSelector: fragmentReaderSelector,
+          missingRequiredFields: fragmentMissingRequiredFields
         };
       });
     }, getDataForResolverFragment),
         result = _this$_resolverCache$[0],
-        seenRecord = _this$_resolverCache$[1];
+        seenRecord = _this$_resolverCache$[1],
+        missingRequiredFields = _this$_resolverCache$[2];
+
+    if (missingRequiredFields != null) {
+      this._addMissingRequiredFields(missingRequiredFields);
+    }
 
     if (seenRecord != null) {
       this._seenRecords.add(seenRecord);
@@ -550,6 +567,7 @@ var RelayReader = /*#__PURE__*/function () {
 
     var applicationName = (_field$alias = field.alias) !== null && _field$alias !== void 0 ? _field$alias : field.name;
     data[applicationName] = result;
+    return result;
   };
 
   _proto._readClientEdge = function _readClientEdge(field, record, data) {
@@ -816,13 +834,37 @@ var RelayReader = /*#__PURE__*/function () {
     }
 
     var inlineData = {};
+    var parentFragmentName = this._fragmentName;
+    this._fragmentName = fragmentSpreadOrFragment.name;
 
-    this._traverseSelections(fragmentSpreadOrFragment.selections, record, inlineData); // $FlowFixMe[cannot-write] - writing into read-only field
+    this._traverseSelections(fragmentSpreadOrFragment.selections, record, inlineData);
 
+    this._fragmentName = parentFragmentName; // $FlowFixMe[cannot-write] - writing into read-only field
 
     fragmentPointers[fragmentSpreadOrFragment.name] = inlineData;
   };
 
+  _proto._addMissingRequiredFields = function _addMissingRequiredFields(additional) {
+    if (this._missingRequiredFields == null) {
+      this._missingRequiredFields = additional;
+      return;
+    }
+
+    if (this._missingRequiredFields.action === 'THROW') {
+      return;
+    }
+
+    if (additional.action === 'THROW') {
+      this._missingRequiredFields = additional;
+      return;
+    }
+
+    this._missingRequiredFields = {
+      action: 'LOG',
+      fields: [].concat((0, _toConsumableArray2["default"])(this._missingRequiredFields.fields), (0, _toConsumableArray2["default"])(additional.fields))
+    };
+  };
+
   return RelayReader;
 }();
 

package/lib/store/RelayStoreUtils.js

@@ -211,6 +211,7 @@ var RelayStoreUtils = {
   RELAY_RESOLVER_INVALIDATION_KEY: '__resolverValueMayBeInvalid',
   RELAY_RESOLVER_INPUTS_KEY: '__resolverInputValues',
   RELAY_RESOLVER_READER_SELECTOR_KEY: '__resolverReaderSelector',
+  RELAY_RESOLVER_MISSING_REQUIRED_FIELDS_KEY: '__resolverMissingRequiredFields',
   formatStorageKey: formatStorageKey,
   getArgumentValue: getArgumentValue,
   getArgumentValues: getArgumentValues,

package/lib/store/ResolverCache.js

@@ -24,6 +24,7 @@ var RelayModernRecord = require('./RelayModernRecord');
 var _require2 = require('./RelayStoreUtils'),
     RELAY_RESOLVER_INPUTS_KEY = _require2.RELAY_RESOLVER_INPUTS_KEY,
     RELAY_RESOLVER_INVALIDATION_KEY = _require2.RELAY_RESOLVER_INVALIDATION_KEY,
+    RELAY_RESOLVER_MISSING_REQUIRED_FIELDS_KEY = _require2.RELAY_RESOLVER_MISSING_REQUIRED_FIELDS_KEY,
     RELAY_RESOLVER_READER_SELECTOR_KEY = _require2.RELAY_RESOLVER_READER_SELECTOR_KEY,
     RELAY_RESOLVER_VALUE_KEY = _require2.RELAY_RESOLVER_VALUE_KEY,
     getStorageKey = _require2.getStorageKey;
@@ -39,7 +40,11 @@ var NoopResolverCache = /*#__PURE__*/function () {
   var _proto = NoopResolverCache.prototype;
 
   _proto.readFromCacheOrEvaluate = function readFromCacheOrEvaluate(record, field, variables, evaluate, getDataForResolverFragment) {
-    return [evaluate().resolverResult, undefined];
+    var _evaluate = evaluate(),
+        resolverResult = _evaluate.resolverResult,
+        missingRequiredFields = _evaluate.missingRequiredFields;
+
+    return [resolverResult, undefined, missingRequiredFields];
   };
 
   _proto.invalidateDataIDs = function invalidateDataIDs(updatedDataIDs) {};
@@ -85,6 +90,7 @@ var RecordResolverCache = /*#__PURE__*/function () {
       RelayModernRecord.setValue(linkedRecord, RELAY_RESOLVER_VALUE_KEY, evaluationResult.resolverResult);
       RelayModernRecord.setValue(linkedRecord, RELAY_RESOLVER_INPUTS_KEY, evaluationResult.fragmentValue);
       RelayModernRecord.setValue(linkedRecord, RELAY_RESOLVER_READER_SELECTOR_KEY, evaluationResult.readerSelector);
+      RelayModernRecord.setValue(linkedRecord, RELAY_RESOLVER_MISSING_REQUIRED_FIELDS_KEY, evaluationResult.missingRequiredFields);
       recordSource.set(linkedID, linkedRecord); // Link the resolver value record to the resolver field of the record being read:
 
       var nextRecord = RelayModernRecord.clone(record);
@@ -112,7 +118,9 @@ var RecordResolverCache = /*#__PURE__*/function () {
 
 
     var answer = linkedRecord[RELAY_RESOLVER_VALUE_KEY];
-    return [answer, linkedID];
+    var missingRequiredFields = // $FlowFixMe[incompatible-type] - casting mixed
+    linkedRecord[RELAY_RESOLVER_MISSING_REQUIRED_FIELDS_KEY];
+    return [answer, linkedID, missingRequiredFields];
   };
 
   _proto2.invalidateDataIDs = function invalidateDataIDs(updatedDataIDs) {

package/lib/util/withProvidedVariables.js

@@ -11,14 +11,34 @@
 // flowlint ambiguous-object-type:error
 'use strict';
 
-function withProvidedVariables(userSuppliedVariables, parameters) {
-  var providedVariables = parameters.providedVariables;
+var areEqual = require("fbjs/lib/areEqual");
 
+var warning = require("fbjs/lib/warning");
+
+var WEAKMAP_SUPPORTED = typeof WeakMap === 'function';
+var debugCache = WEAKMAP_SUPPORTED ? new WeakMap() : new Map();
+
+function withProvidedVariables(userSuppliedVariables, providedVariables) {
   if (providedVariables != null) {
     var operationVariables = {};
     Object.assign(operationVariables, userSuppliedVariables);
     Object.keys(providedVariables).forEach(function (varName) {
-      operationVariables[varName] = providedVariables[varName].get();
+      var providerFunction = providedVariables[varName].get;
+      var providerResult = providerFunction(); // people like to ignore these warnings, so use the cache to
+      // enforce that we only compute the value the first time
+
+      if (!debugCache.has(providerFunction)) {
+        debugCache.set(providerFunction, providerResult);
+        operationVariables[varName] = providerResult;
+      } else {
+        var cachedResult = debugCache.get(providerFunction);
+
+        if (process.env.NODE_ENV !== "production") {
+          process.env.NODE_ENV !== "production" ? warning(areEqual(providerResult, cachedResult), 'Relay: Expected function `%s` for provider `%s` to be a pure function, ' + 'but got conflicting return values `%s` and `%s`', providerFunction.name, varName, providerResult, cachedResult) : void 0;
+        }
+
+        operationVariables[varName] = cachedResult;
+      }
     });
     return operationVariables;
   } else {

package/mutations/commitMutation.js.flow

@@ -37,32 +37,15 @@ const validateMutation = require('./validateMutation');
 const invariant = require('invariant');
 const warning = require('warning');
 
-export type DEPRECATED_MutationConfig<TMutationResponse> = {|
-  configs?: Array<DeclarativeMutationConfig>,
-  cacheConfig?: CacheConfig,
-  mutation: GraphQLTaggedNode,
-  variables: Variables,
-  uploadables?: UploadableMap,
-  onCompleted?: ?(
-    response: TMutationResponse,
-    errors: ?Array<PayloadError>,
-  ) => void,
-  onError?: ?(error: Error) => void,
-  onUnsubscribe?: ?() => void,
-  optimisticUpdater?: ?SelectorStoreUpdater<TMutationResponse>,
-  optimisticResponse?: Object,
-  updater?: ?SelectorStoreUpdater<TMutationResponse>,
-|};
-
 export type MutationConfig<TMutation: MutationParameters> = {|
-  configs?: Array<DeclarativeMutationConfig>,
   cacheConfig?: CacheConfig,
+  configs?: Array<DeclarativeMutationConfig>,
   mutation: GraphQLTaggedNode,
-  onError?: ?(error: Error) => void,
   onCompleted?: ?(
     response: TMutation['response'],
     errors: ?Array<PayloadError>,
   ) => void,
+  onError?: ?(error: Error) => void,
   onNext?: ?() => void,
   onUnsubscribe?: ?() => void,
   optimisticResponse?: {
@@ -76,6 +59,12 @@ export type MutationConfig<TMutation: MutationParameters> = {|
   variables: TMutation['variables'],
 |};
 
+export type DEPRECATED_MutationConfig<TMutationResponse> = MutationConfig<{|
+  response: TMutationResponse,
+  rawResponse: any,
+  variables: Variables,
+|}>;
+
 /**
  * Higher-level helper function to execute a mutation against a specific
  * environment.

package/mutations/readUpdatableQuery_EXPERIMENTAL.js.flow

@@ -21,7 +21,7 @@ import type {OperationType} from '../util/RelayRuntimeTypes';
 const {getRequest} = require('../query/GraphQLTag');
 const {getArgumentValues} = require('../store/RelayStoreUtils');
 
-const nonUpdatableKeys = ['id', '__id', '__typename'];
+const nonUpdatableKeys = ['id', '__id', '__typename', 'js'];
 
 function readUpdatableQuery_EXPERIMENTAL<TQuery: OperationType>(
   query: GraphQLTaggedNode,
@@ -214,7 +214,7 @@ function createSetterForSingularLinkedField<TQuery: OperationType>(
     const variables = getArgumentValues(selection.args ?? [], queryVariables);
     if (newValue == null) {
       // $FlowFixMe[unclear-type] No good way to type these variables
-      recordProxy.setValue(null, selection.name, (variables: any));
+      recordProxy.setValue(newValue, selection.name, (variables: any));
     } else {
       const {__id} = newValue;
       if (__id == null) {

package/network/RelayNetwork.js.flow

@@ -46,7 +46,10 @@ function create(
     uploadables?: ?UploadableMap,
     logRequestInfo: ?LogRequestInfoFunction,
   ): RelayObservable<GraphQLResponse> {
-    const operationVariables = withProvidedVariables(variables, request);
+    const operationVariables = withProvidedVariables(
+      variables,
+      request.providedVariables,
+    );
     if (request.operationKind === 'subscription') {
       invariant(
         subscribe,

package/network/RelayNetworkTypes.js.flow

@@ -26,7 +26,7 @@ export interface INetwork {
 
 export type LogRequestInfoFunction = mixed => void;
 
-export type PayloadData = interface {[key: string]: mixed};
+export type PayloadData = {[key: string]: mixed};
 
 export type PayloadError = interface {
   message: string,

package/package.json

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