relay-runtime 0.0.0-main-2499f53f → 0.0.0-main-47d9d202

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v0.0.0-main-2499f53f
+ * Relay v0.0.0-main-47d9d202
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/index.js.flow

@@ -59,6 +59,7 @@ const getRefetchMetadata = require('./util/getRefetchMetadata');
 const getRelayHandleKey = require('./util/getRelayHandleKey');
 const getRequestIdentifier = require('./util/getRequestIdentifier');
 const getValueAtPath = require('./util/getValueAtPath');
+const handlePotentialSnapshotErrors = require('./util/handlePotentialSnapshotErrors');
 const isPromise = require('./util/isPromise');
 const isScalarAndEqual = require('./util/isScalarAndEqual');
 const recycleNodesInto = require('./util/recycleNodesInto');
@@ -68,7 +69,6 @@ const RelayError = require('./util/RelayError');
 const RelayFeatureFlags = require('./util/RelayFeatureFlags');
 const RelayProfiler = require('./util/RelayProfiler');
 const RelayReplaySubject = require('./util/RelayReplaySubject');
-const reportMissingRequiredFields = require('./util/reportMissingRequiredFields');
 const stableCopy = require('./util/stableCopy');
 const withProvidedVariables = require('./util/withProvidedVariables');
 
@@ -291,7 +291,7 @@ module.exports = {
     RelayModernSelector.getVariablesFromPluralFragment,
   getVariablesFromSingularFragment:
     RelayModernSelector.getVariablesFromSingularFragment,
-  reportMissingRequiredFields,
+  handlePotentialSnapshotErrors,
   graphql: GraphQLTag.graphql,
   isFragment: GraphQLTag.isFragment,
   isInlineDataFragment: GraphQLTag.isInlineDataFragment,

package/lib/index.js

@@ -99,6 +99,8 @@ var getRequestIdentifier = require('./util/getRequestIdentifier');
 
 var getValueAtPath = require('./util/getValueAtPath');
 
+var handlePotentialSnapshotErrors = require('./util/handlePotentialSnapshotErrors');
+
 var isPromise = require('./util/isPromise');
 
 var isScalarAndEqual = require('./util/isScalarAndEqual');
@@ -117,8 +119,6 @@ var RelayProfiler = require('./util/RelayProfiler');
 
 var RelayReplaySubject = require('./util/RelayReplaySubject');
 
-var reportMissingRequiredFields = require('./util/reportMissingRequiredFields');
-
 var stableCopy = require('./util/stableCopy');
 
 var withProvidedVariables = require('./util/withProvidedVariables');
@@ -176,7 +176,7 @@ module.exports = {
   getVariablesFromObject: RelayModernSelector.getVariablesFromObject,
   getVariablesFromPluralFragment: RelayModernSelector.getVariablesFromPluralFragment,
   getVariablesFromSingularFragment: RelayModernSelector.getVariablesFromSingularFragment,
-  reportMissingRequiredFields: reportMissingRequiredFields,
+  handlePotentialSnapshotErrors: handlePotentialSnapshotErrors,
   graphql: GraphQLTag.graphql,
   isFragment: GraphQLTag.isFragment,
   isInlineDataFragment: GraphQLTag.isInlineDataFragment,

package/lib/query/fetchQuery.js

@@ -20,7 +20,7 @@ var RelayObservable = require('../network/RelayObservable');
 var _require = require('../store/RelayModernOperationDescriptor'),
     createOperationDescriptor = _require.createOperationDescriptor;
 
-var reportMissingRequiredFields = require('../util/reportMissingRequiredFields');
+var handlePotentialSnapshotErrors = require('../util/handlePotentialSnapshotErrors');
 
 var fetchQueryInternal = require('./fetchQueryInternal');
 
@@ -119,13 +119,10 @@ function fetchQuery(environment, query, variables, options) {
   var fetchPolicy = (_options$fetchPolicy = options === null || options === void 0 ? void 0 : options.fetchPolicy) !== null && _options$fetchPolicy !== void 0 ? _options$fetchPolicy : 'network-only';
 
   function readData(snapshot) {
-    if (snapshot.missingRequiredFields != null) {
-      reportMissingRequiredFields(environment, snapshot.missingRequiredFields);
-    }
+    handlePotentialSnapshotErrors(environment, snapshot.missingRequiredFields, snapshot.relayResolverErrors);
     /* $FlowFixMe[incompatible-return] we assume readData returns the right
      * data just having written it from network or checked availability. */
 
-
     return snapshot.data;
   }
 

package/lib/store/RelayModernFragmentSpecResolver.js

@@ -18,14 +18,14 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 
 var getPendingOperationsForFragment = require('../util/getPendingOperationsForFragment');
 
+var handlePotentialSnapshotErrors = require('../util/handlePotentialSnapshotErrors');
+
 var isScalarAndEqual = require('../util/isScalarAndEqual');
 
 var recycleNodesInto = require('../util/recycleNodesInto');
 
 var RelayFeatureFlags = require('../util/RelayFeatureFlags');
 
-var reportMissingRequiredFields = require('../util/reportMissingRequiredFields');
-
 var _require = require('./RelayModernOperationDescriptor'),
     createRequestDescriptor = _require.createRequestDescriptor;
 
@@ -206,6 +206,7 @@ var SelectorResolver = /*#__PURE__*/function () {
       _this2._data = snapshot.data;
       _this2._isMissingData = snapshot.isMissingData;
       _this2._missingRequiredFields = snapshot.missingRequiredFields;
+      _this2._relayResolverErrors = snapshot.relayResolverErrors;
 
       _this2._callback();
     });
@@ -216,6 +217,7 @@ var SelectorResolver = /*#__PURE__*/function () {
     this._data = _snapshot.data;
     this._isMissingData = _snapshot.isMissingData;
     this._missingRequiredFields = _snapshot.missingRequiredFields;
+    this._relayResolverErrors = _snapshot.relayResolverErrors;
     this._environment = environment;
     this._rootIsQueryRenderer = rootIsQueryRenderer;
     this._selector = selector;
@@ -289,10 +291,7 @@ var SelectorResolver = /*#__PURE__*/function () {
       }
     }
 
-    if (this._missingRequiredFields != null) {
-      reportMissingRequiredFields(this._environment, this._missingRequiredFields);
-    }
-
+    handlePotentialSnapshotErrors(this._environment, this._missingRequiredFields, this._relayResolverErrors);
     return this._data;
   };
 
@@ -308,6 +307,7 @@ var SelectorResolver = /*#__PURE__*/function () {
     this._data = recycleNodesInto(this._data, snapshot.data);
     this._isMissingData = snapshot.isMissingData;
     this._missingRequiredFields = snapshot.missingRequiredFields;
+    this._relayResolverErrors = snapshot.relayResolverErrors;
     this._selector = selector;
     this._subscription = this._environment.subscribe(snapshot, this._onChange);
   };

package/lib/store/RelayReader.js

@@ -12,6 +12,8 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
+var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
+
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
@@ -90,6 +92,7 @@ var RelayReader = /*#__PURE__*/function () {
     this._selector = selector;
     this._variables = selector.variables;
     this._resolverCache = resolverCache;
+    this._resolverErrors = [];
     this._fragmentName = selector.node.name;
   }
 
@@ -164,7 +167,8 @@ var RelayReader = /*#__PURE__*/function () {
       missingClientEdges: RelayFeatureFlags.ENABLE_CLIENT_EDGES && this._missingClientEdges.length ? this._missingClientEdges : null,
       seenRecords: this._seenRecords,
       selector: this._selector,
-      missingRequiredFields: this._missingRequiredFields
+      missingRequiredFields: this._missingRequiredFields,
+      relayResolverErrors: this._resolverErrors
     };
   };
 
@@ -497,6 +501,8 @@ var RelayReader = /*#__PURE__*/function () {
     var fragmentReaderSelector;
     var fragmentMissingRequiredFields;
     var previousMissingRequriedFields;
+    var currentResolverErrors;
+    var previousResolverErrors;
     var fragmentSeenRecordIDs = new Set();
 
     var getDataForResolverFragment = function getDataForResolverFragment(singularReaderSelector) {
@@ -517,16 +523,20 @@ var RelayReader = /*#__PURE__*/function () {
         var resolverFragmentData = {};
         previousMissingRequriedFields = _this._missingRequiredFields;
         _this._missingRequiredFields = null;
+        previousResolverErrors = _this._resolverErrors;
+        _this._resolverErrors = [];
 
         _this._createInlineDataOrResolverFragmentPointer(singularReaderSelector.node, record, resolverFragmentData);
 
         fragmentMissingRequiredFields = _this._missingRequiredFields;
+        currentResolverErrors = _this._resolverErrors;
         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;
+        _this._resolverErrors = previousResolverErrors;
       }
     };
 
@@ -534,17 +544,35 @@ var RelayReader = /*#__PURE__*/function () {
       getDataForResolverFragment: getDataForResolverFragment
     };
 
-    var _this$_resolverCache$ = this._resolverCache.readFromCacheOrEvaluate(record, field, this._variables, function () {
+    var evaluate = function evaluate() {
       var key = {
         __id: RelayModernRecord.getDataID(record),
         __fragmentOwner: _this._owner,
         __fragments: (0, _defineProperty2["default"])({}, fragment.name, {})
       };
       return withResolverContext(resolverContext, function () {
-        // $FlowFixMe[prop-missing] - resolver module's type signature is a lie
-        var resolverResult = resolverModule(key);
+        var resolverResult = null;
+
+        try {
+          // $FlowFixMe[prop-missing] - resolver module's type signature is a lie
+          resolverResult = resolverModule(key);
+        } catch (e) {
+          var _field$path;
+
+          // `field.path` is typed as nullable while we rollout compiler changes.
+          var path = (_field$path = field.path) !== null && _field$path !== void 0 ? _field$path : '[UNKNOWN]';
+          currentResolverErrors.push({
+            field: {
+              path: path,
+              owner: _this._fragmentName
+            },
+            error: e
+          });
+        }
+
         return {
           resolverResult: resolverResult,
+          errors: currentResolverErrors,
           fragmentValue: fragmentValue,
           resolverID: resolverID,
           seenRecordIDs: fragmentSeenRecordIDs,
@@ -552,10 +580,28 @@ var RelayReader = /*#__PURE__*/function () {
           missingRequiredFields: fragmentMissingRequiredFields
         };
       });
-    }, getDataForResolverFragment),
+    };
+
+    var _this$_resolverCache$ = this._resolverCache.readFromCacheOrEvaluate(record, field, this._variables, evaluate, getDataForResolverFragment),
         result = _this$_resolverCache$[0],
         seenRecord = _this$_resolverCache$[1],
-        missingRequiredFields = _this$_resolverCache$[2];
+        resolverErrors = _this$_resolverCache$[2],
+        missingRequiredFields = _this$_resolverCache$[3];
+
+    var _iterator = (0, _createForOfIteratorHelper2["default"])(resolverErrors),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var resolverError = _step.value;
+
+        this._resolverErrors.push(resolverError);
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
 
     if (missingRequiredFields != null) {
       this._addMissingRequiredFields(missingRequiredFields);

package/lib/store/RelayStoreSubscriptions.js

@@ -96,7 +96,8 @@ var RelayStoreSubscriptions = /*#__PURE__*/function () {
           missingClientEdges: backup.missingClientEdges,
           seenRecords: backup.seenRecords,
           selector: backup.selector,
-          missingRequiredFields: backup.missingRequiredFields
+          missingRequiredFields: backup.missingRequiredFields,
+          relayResolverErrors: backup.relayResolverErrors
         };
       } else {
         subscription.stale = true;
@@ -146,7 +147,8 @@ var RelayStoreSubscriptions = /*#__PURE__*/function () {
       missingClientEdges: nextSnapshot.missingClientEdges,
       seenRecords: nextSnapshot.seenRecords,
       selector: nextSnapshot.selector,
-      missingRequiredFields: nextSnapshot.missingRequiredFields
+      missingRequiredFields: nextSnapshot.missingRequiredFields,
+      relayResolverErrors: nextSnapshot.relayResolverErrors
     };
 
     if (process.env.NODE_ENV !== "production") {

package/lib/store/RelayStoreUtils.js

@@ -212,6 +212,7 @@ var RelayStoreUtils = {
   RELAY_RESOLVER_INPUTS_KEY: '__resolverInputValues',
   RELAY_RESOLVER_READER_SELECTOR_KEY: '__resolverReaderSelector',
   RELAY_RESOLVER_MISSING_REQUIRED_FIELDS_KEY: '__resolverMissingRequiredFields',
+  RELAY_RESOLVER_ERROR_KEY: '__resolverError',
   formatStorageKey: formatStorageKey,
   getArgumentValue: getArgumentValue,
   getArgumentValues: getArgumentValues,

package/lib/store/ResolverCache.js

@@ -22,6 +22,7 @@ var _require = require('./ClientID'),
 var RelayModernRecord = require('./RelayModernRecord');
 
 var _require2 = require('./RelayStoreUtils'),
+    RELAY_RESOLVER_ERROR_KEY = _require2.RELAY_RESOLVER_ERROR_KEY,
     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,
@@ -42,9 +43,10 @@ var NoopResolverCache = /*#__PURE__*/function () {
   _proto.readFromCacheOrEvaluate = function readFromCacheOrEvaluate(record, field, variables, evaluate, getDataForResolverFragment) {
     var _evaluate = evaluate(),
         resolverResult = _evaluate.resolverResult,
-        missingRequiredFields = _evaluate.missingRequiredFields;
+        missingRequiredFields = _evaluate.missingRequiredFields,
+        errors = _evaluate.errors;
 
-    return [resolverResult, undefined, missingRequiredFields];
+    return [resolverResult, undefined, errors, missingRequiredFields];
   };
 
   _proto.invalidateDataIDs = function invalidateDataIDs(updatedDataIDs) {};
@@ -91,6 +93,7 @@ var RecordResolverCache = /*#__PURE__*/function () {
       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);
+      RelayModernRecord.setValue(linkedRecord, RELAY_RESOLVER_ERROR_KEY, evaluationResult.errors);
       recordSource.set(linkedID, linkedRecord); // Link the resolver value record to the resolver field of the record being read:
 
       var nextRecord = RelayModernRecord.clone(record);
@@ -119,8 +122,10 @@ var RecordResolverCache = /*#__PURE__*/function () {
 
     var answer = linkedRecord[RELAY_RESOLVER_VALUE_KEY];
     var missingRequiredFields = // $FlowFixMe[incompatible-type] - casting mixed
-    linkedRecord[RELAY_RESOLVER_MISSING_REQUIRED_FIELDS_KEY];
-    return [answer, linkedID, missingRequiredFields];
+    linkedRecord[RELAY_RESOLVER_MISSING_REQUIRED_FIELDS_KEY]; // $FlowFixMe[incompatible-type] - casting mixed
+
+    var errors = linkedRecord[RELAY_RESOLVER_ERROR_KEY];
+    return [answer, linkedID, errors, missingRequiredFields];
   };
 
   _proto2.invalidateDataIDs = function invalidateDataIDs(updatedDataIDs) {

package/lib/util/handlePotentialSnapshotErrors.js

@@ -0,0 +1,73 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and 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';
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _createForOfIteratorHelper2 = _interopRequireDefault(require("@babel/runtime/helpers/createForOfIteratorHelper"));
+
+function handlePotentialSnapshotErrors(environment, missingRequiredFields, relayResolverErrors) {
+  var _iterator = (0, _createForOfIteratorHelper2["default"])(relayResolverErrors),
+      _step;
+
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var resolverError = _step.value;
+      environment.requiredFieldLogger({
+        kind: 'relay_resolver.error',
+        owner: resolverError.field.owner,
+        fieldPath: resolverError.field.path,
+        error: resolverError.error
+      });
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+
+  if (missingRequiredFields != null) {
+    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 = handlePotentialSnapshotErrors;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-runtime",
   "description": "A core runtime for building GraphQL-driven applications.",
-  "version": "0.0.0-main-2499f53f",
+  "version": "0.0.0-main-47d9d202",
   "keywords": [
     "graphql",
     "relay"

package/query/fetchQuery.js.flow

@@ -30,7 +30,7 @@ const RelayObservable = require('../network/RelayObservable');
 const {
   createOperationDescriptor,
 } = require('../store/RelayModernOperationDescriptor');
-const reportMissingRequiredFields = require('../util/reportMissingRequiredFields');
+const handlePotentialSnapshotErrors = require('../util/handlePotentialSnapshotErrors');
 const fetchQueryInternal = require('./fetchQueryInternal');
 const {getRequest} = require('./GraphQLTag');
 const invariant = require('invariant');
@@ -138,9 +138,11 @@ function fetchQuery<TVariables: Variables, TData, TRawResponse>(
   const fetchPolicy = options?.fetchPolicy ?? 'network-only';
 
   function readData(snapshot: Snapshot): TData {
-    if (snapshot.missingRequiredFields != null) {
-      reportMissingRequiredFields(environment, snapshot.missingRequiredFields);
-    }
+    handlePotentialSnapshotErrors(
+      environment,
+      snapshot.missingRequiredFields,
+      snapshot.relayResolverErrors,
+    );
     /* $FlowFixMe[incompatible-return] we assume readData returns the right
      * data just having written it from network or checked availability. */
     return snapshot.data;