relay-runtime 13.0.3 → 13.2.0

package/lib/store/hasOverlappingIDs.js

@@ -13,7 +13,7 @@
 var ITERATOR_KEY = Symbol.iterator;
 
 function hasOverlappingIDs(seenRecords, updatedRecordIDs) {
-  // $FlowFixMe: Set is an iterable type, accessing its iterator is allowed.
+  // $FlowFixMe[incompatible-use]: Set is an iterable type, accessing its iterator is allowed.
   var iterator = seenRecords[ITERATOR_KEY]();
   var next = iterator.next();
 

package/lib/util/RelayConcreteNode.js

@@ -44,6 +44,7 @@ var RelayConcreteNode = {
   LOCAL_ARGUMENT: 'LocalArgument',
   MODULE_IMPORT: 'ModuleImport',
   RELAY_RESOLVER: 'RelayResolver',
+  RELAY_LIVE_RESOLVER: 'RelayLiveResolver',
   REQUIRED_FIELD: 'RequiredField',
   OBJECT_VALUE: 'ObjectValue',
   OPERATION: 'Operation',
@@ -54,6 +55,7 @@ var RelayConcreteNode = {
   SPLIT_OPERATION: 'SplitOperation',
   STREAM: 'Stream',
   TYPE_DISCRIMINATOR: 'TypeDiscriminator',
+  UPDATABLE_QUERY: 'UpdatableQuery',
   VARIABLE: 'Variable'
 };
 module.exports = RelayConcreteNode;

package/lib/util/RelayFeatureFlags.js

@@ -11,7 +11,6 @@
 'use strict';
 
 var RelayFeatureFlags = {
-  DELAY_CLEANUP_OF_PENDING_PRELOAD_QUERIES: false,
   ENABLE_CLIENT_EDGES: false,
   ENABLE_VARIABLE_CONNECTION_KEY: false,
   ENABLE_PARTIAL_RENDERING_DEFAULT: true,
@@ -24,9 +23,7 @@ var RelayFeatureFlags = {
   ENABLE_NOTIFY_SUBSCRIPTION: false,
   BATCH_ASYNC_MODULE_UPDATES_FN: null,
   ENABLE_CONTAINERS_SUBSCRIBE_ON_COMMIT: false,
-  ENABLE_QUERY_RENDERER_OFFSCREEN_SUPPORT: false,
   MAX_DATA_ID_LENGTH: null,
-  REFACTOR_SUSPENSE_RESOURCE: true,
   STRING_INTERN_LEVEL: 0,
   USE_REACT_CACHE: false
 };

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/mutations/RelayRecordSourceProxy.js.flow

@@ -22,7 +22,11 @@ import type {
   RecordSource,
   RecordSourceProxy,
 } from '../store/RelayStoreTypes';
-import type {DataID, OperationType} from '../util/RelayRuntimeTypes';
+import type {
+  DataID,
+  UpdatableQuery,
+  UpdatableQueryType,
+} from '../util/RelayRuntimeTypes';
 import type RelayRecordSourceMutator from './RelayRecordSourceMutator';
 
 const RelayModernRecord = require('../store/RelayModernRecord');
@@ -163,8 +167,8 @@ class RelayRecordSourceProxy implements RecordSourceProxy {
     return this._idsMarkedForInvalidation;
   }
 
-  readUpdatableQuery_EXPERIMENTAL<TQuery: OperationType>(
-    query: GraphQLTaggedNode,
+  readUpdatableQuery_EXPERIMENTAL<TQuery: UpdatableQueryType>(
+    query: UpdatableQuery<TQuery['variables'], TQuery['response']>,
     variables: TQuery['variables'],
   ): TQuery['response'] {
     return readUpdatableQuery_EXPERIMENTAL(query, variables, this);

package/mutations/RelayRecordSourceSelectorProxy.js.flow

@@ -20,7 +20,11 @@ import type {
   SingularReaderSelector,
 } from '../store/RelayStoreTypes';
 import type {ReaderLinkedField} from '../util/ReaderNode';
-import type {DataID, OperationType} from '../util/RelayRuntimeTypes';
+import type {
+  DataID,
+  UpdatableQuery,
+  UpdatableQueryType,
+} from '../util/RelayRuntimeTypes';
 import type RelayRecordSourceMutator from './RelayRecordSourceMutator';
 
 const {ROOT_TYPE, getStorageKey} = require('../store/RelayStoreUtils');
@@ -123,8 +127,8 @@ class RelayRecordSourceSelectorProxy implements RecordSourceSelectorProxy {
     this.__recordSource.invalidateStore();
   }
 
-  readUpdatableQuery_EXPERIMENTAL<TQuery: OperationType>(
-    query: GraphQLTaggedNode,
+  readUpdatableQuery_EXPERIMENTAL<TQuery: UpdatableQueryType>(
+    query: UpdatableQuery<TQuery['variables'], TQuery['response']>,
     variables: TQuery['variables'],
   ): TQuery['response'] {
     return readUpdatableQuery_EXPERIMENTAL(query, variables, this);

package/mutations/readUpdatableQuery_EXPERIMENTAL.js.flow

@@ -16,27 +16,29 @@
 import type {GraphQLTaggedNode} from '../query/GraphQLTag';
 import type {RecordProxy, RecordSourceProxy} from '../store/RelayStoreTypes';
 import type {ReaderLinkedField, ReaderSelection} from '../util/ReaderNode';
-import type {OperationType} from '../util/RelayRuntimeTypes';
+import type {
+  UpdatableQuery,
+  UpdatableQueryType,
+} from '../util/RelayRuntimeTypes';
 
-const {getRequest} = require('../query/GraphQLTag');
+const {getUpdatableQuery} = require('../query/GraphQLTag');
 const {getArgumentValues} = require('../store/RelayStoreUtils');
 
 const nonUpdatableKeys = ['id', '__id', '__typename', 'js'];
 
-function readUpdatableQuery_EXPERIMENTAL<TQuery: OperationType>(
-  query: GraphQLTaggedNode,
+function readUpdatableQuery_EXPERIMENTAL<TQuery: UpdatableQueryType>(
+  query: UpdatableQuery<TQuery['variables'], TQuery['response']>,
   variables: TQuery['variables'],
   proxy: RecordSourceProxy,
 ): TQuery['response'] {
-  // TODO assert that the concrete request is an updatable query
-  const request = getRequest(query);
+  const updatableQuery = getUpdatableQuery(query);
 
   const updatableProxy = {};
   updateProxyFromSelections(
     updatableProxy,
     proxy.getRoot(),
     variables,
-    request.fragment.selections,
+    updatableQuery.fragment.selections,
     proxy,
   );
   if (__DEV__) {
@@ -45,7 +47,7 @@ function readUpdatableQuery_EXPERIMENTAL<TQuery: OperationType>(
   return updatableProxy;
 }
 
-function updateProxyFromSelections<TQuery: OperationType>(
+function updateProxyFromSelections<TQuery: UpdatableQueryType>(
   mutableUpdatableProxy: TQuery['response'],
   recordProxy: RecordProxy,
   queryVariables: TQuery['variables'],
@@ -161,7 +163,7 @@ function updateProxyFromSelections<TQuery: OperationType>(
   }
 }
 
-function createSetterForPluralLinkedField<TQuery: OperationType>(
+function createSetterForPluralLinkedField<TQuery: UpdatableQueryType>(
   selection: ReaderLinkedField,
   queryVariables: TQuery['variables'],
   recordProxy: RecordProxy,
@@ -204,7 +206,7 @@ function createSetterForPluralLinkedField<TQuery: OperationType>(
   };
 }
 
-function createSetterForSingularLinkedField<TQuery: OperationType>(
+function createSetterForSingularLinkedField<TQuery: UpdatableQueryType>(
   selection: ReaderLinkedField,
   queryVariables: TQuery['variables'],
   recordProxy: RecordProxy,
@@ -236,7 +238,7 @@ function createSetterForSingularLinkedField<TQuery: OperationType>(
   };
 }
 
-function createGetterForPluralLinkedField<TQuery: OperationType>(
+function createGetterForPluralLinkedField<TQuery: UpdatableQueryType>(
   selection: ReaderLinkedField,
   queryVariables: TQuery['variables'],
   recordProxy: RecordProxy,
@@ -278,7 +280,7 @@ function createGetterForPluralLinkedField<TQuery: OperationType>(
   };
 }
 
-function createGetterForSingularLinkedField<TQuery: OperationType>(
+function createGetterForSingularLinkedField<TQuery: UpdatableQueryType>(
   selection: ReaderLinkedField,
   queryVariables: TQuery['variables'],
   recordProxy: RecordProxy,

package/network/RelayNetworkTypes.js.flow

@@ -120,7 +120,7 @@ export type SubscribeFunction = (
 ) => RelayObservable<GraphQLResponse>;
 
 export type Uploadable = File | Blob;
-export type UploadableMap = interface {[key: string]: Uploadable};
+export type UploadableMap = {[key: string]: Uploadable};
 
 /**
  * React Flight tree created on the server.

package/package.json

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

package/query/GraphQLTag.js.flow

@@ -18,7 +18,10 @@ import type {
   ReaderPaginationFragment,
   ReaderRefetchableFragment,
 } from '../util/ReaderNode';
-import type {ConcreteRequest} from '../util/RelayConcreteNode';
+import type {
+  ConcreteRequest,
+  ConcreteUpdatableQuery,
+} from '../util/RelayConcreteNode';
 
 const RelayConcreteNode = require('../util/RelayConcreteNode');
 const invariant = require('invariant');
@@ -29,9 +32,14 @@ export type GraphQLTaggedNode =
   | ReaderFragment
   | ReaderInlineDataFragment
   | ConcreteRequest
+  | ConcreteUpdatableQuery
   | {
       // This is this case when we `require()` a generated ES6 module
-      default: ReaderFragment | ReaderInlineDataFragment | ConcreteRequest,
+      default:
+        | ReaderFragment
+        | ReaderInlineDataFragment
+        | ConcreteRequest
+        | ConcreteUpdatableQuery,
       ...
     };
 
@@ -51,7 +59,11 @@ function graphql(strings: Array<string>): any {
 
 function getNode(
   taggedNode: GraphQLTaggedNode,
-): ReaderFragment | ReaderInlineDataFragment | ConcreteRequest {
+):
+  | ReaderFragment
+  | ReaderInlineDataFragment
+  | ConcreteRequest
+  | ConcreteUpdatableQuery {
   let node = taggedNode;
   if (typeof node === 'function') {
     node = (node(): ReaderFragment | ConcreteRequest);
@@ -85,6 +97,15 @@ function isRequest(node: GraphQLTaggedNode): boolean {
   );
 }
 
+function isUpdatableQuery(node: GraphQLTaggedNode): boolean {
+  const updatableQuery = getNode(node);
+  return (
+    typeof updatableQuery === 'object' &&
+    updatableQuery !== null &&
+    updatableQuery.kind === RelayConcreteNode.UPDATABLE_QUERY
+  );
+}
+
 function isInlineDataFragment(node: GraphQLTaggedNode): boolean {
   const fragment = getNode(node);
   return (
@@ -142,6 +163,18 @@ function getRequest(taggedNode: GraphQLTaggedNode): ConcreteRequest {
   return (request: any);
 }
 
+function getUpdatableQuery(
+  taggedNode: GraphQLTaggedNode,
+): ConcreteUpdatableQuery {
+  const updatableQuery = getNode(taggedNode);
+  invariant(
+    isUpdatableQuery(updatableQuery),
+    'GraphQLTag: Expected a request, got `%s`.',
+    JSON.stringify(updatableQuery),
+  );
+  return (updatableQuery: any);
+}
+
 function getInlineDataFragment(
   taggedNode: GraphQLTaggedNode,
 ): ReaderInlineDataFragment {
@@ -160,9 +193,11 @@ module.exports = {
   getPaginationFragment,
   getRefetchableFragment,
   getRequest,
+  getUpdatableQuery,
   getInlineDataFragment,
   graphql,
   isFragment,
   isRequest,
+  isUpdatableQuery,
   isInlineDataFragment,
 };

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;