relay-runtime 13.0.3 → 13.2.0

package/store/hasOverlappingIDs.js.flow

@@ -20,7 +20,7 @@ function hasOverlappingIDs(
   seenRecords: DataIDSet,
   updatedRecordIDs: DataIDSet,
 ): boolean {
-  // $FlowFixMe: Set is an iterable type, accessing its iterator is allowed.
+  // $FlowFixMe[incompatible-use]: Set is an iterable type, accessing its iterator is allowed.
   const iterator = seenRecords[ITERATOR_KEY]();
   let next = iterator.next();
   while (!next.done) {

package/util/ReaderNode.js.flow

@@ -111,7 +111,8 @@ export type ReaderClientExtension = {|
 export type ReaderField =
   | ReaderScalarField
   | ReaderLinkedField
-  | ReaderRelayResolver;
+  | ReaderRelayResolver
+  | ReaderRelayLiveResolver;
 
 export type ReaderRootArgument = {|
   +kind: 'RootArgument',
@@ -224,6 +225,21 @@ export type ReaderRelayResolver = {|
   +alias: ?string,
   +name: string,
   +fragment: ReaderFragmentSpread,
+  +path: string,
+  +resolverModule: (rootKey: {
+    +$data?: any, // flowlint-line unclear-type:off
+    +$fragmentSpreads: any, // flowlint-line unclear-type:off
+    +$fragmentRefs: any, // flowlint-line unclear-type:off
+    ...
+  }) => mixed,
+|};
+
+export type ReaderRelayLiveResolver = {|
+  +kind: 'RelayLiveResolver',
+  +alias: ?string,
+  +name: string,
+  +fragment: ReaderFragmentSpread,
+  +path: string,
   +resolverModule: (rootKey: {
     +$data?: any, // flowlint-line unclear-type:off
     +$fragmentSpreads: any, // flowlint-line unclear-type:off

package/util/RelayConcreteNode.js.flow

@@ -31,6 +31,11 @@ export type ConcreteRequest = {|
   +params: RequestParameters,
 |};
 
+export type ConcreteUpdatableQuery = {|
+  +kind: 'UpdatableQuery',
+  +fragment: ReaderFragment,
+|};
+
 export type NormalizationRootNode =
   | ConcreteRequest
   | NormalizationSplitOperation;
@@ -68,7 +73,8 @@ export type GeneratedNode =
   | ConcreteRequest
   | ReaderFragment
   | ReaderInlineDataFragment
-  | NormalizationSplitOperation;
+  | NormalizationSplitOperation
+  | ConcreteUpdatableQuery;
 
 const RelayConcreteNode = {
   ACTOR_CHANGE: 'ActorChange',
@@ -91,6 +97,7 @@ const RelayConcreteNode = {
   LOCAL_ARGUMENT: 'LocalArgument',
   MODULE_IMPORT: 'ModuleImport',
   RELAY_RESOLVER: 'RelayResolver',
+  RELAY_LIVE_RESOLVER: 'RelayLiveResolver',
   REQUIRED_FIELD: 'RequiredField',
   OBJECT_VALUE: 'ObjectValue',
   OPERATION: 'Operation',
@@ -101,6 +108,7 @@ const RelayConcreteNode = {
   SPLIT_OPERATION: 'SplitOperation',
   STREAM: 'Stream',
   TYPE_DISCRIMINATOR: 'TypeDiscriminator',
+  UPDATABLE_QUERY: 'UpdatableQuery',
   VARIABLE: 'Variable',
 };
 

package/util/RelayFeatureFlags.js.flow

@@ -15,7 +15,6 @@
 import type {Disposable} from '../util/RelayRuntimeTypes';
 
 export type FeatureFlags = {|
-  DELAY_CLEANUP_OF_PENDING_PRELOAD_QUERIES: boolean,
   ENABLE_CLIENT_EDGES: boolean,
   ENABLE_VARIABLE_CONNECTION_KEY: boolean,
   ENABLE_PARTIAL_RENDERING_DEFAULT: boolean,
@@ -28,15 +27,12 @@ export type FeatureFlags = {|
   ENABLE_NOTIFY_SUBSCRIPTION: boolean,
   BATCH_ASYNC_MODULE_UPDATES_FN: ?(() => void) => Disposable,
   ENABLE_CONTAINERS_SUBSCRIBE_ON_COMMIT: boolean,
-  ENABLE_QUERY_RENDERER_OFFSCREEN_SUPPORT: boolean,
   MAX_DATA_ID_LENGTH: ?number,
-  REFACTOR_SUSPENSE_RESOURCE: boolean,
   STRING_INTERN_LEVEL: number,
   USE_REACT_CACHE: boolean,
 |};
 
 const RelayFeatureFlags: FeatureFlags = {
-  DELAY_CLEANUP_OF_PENDING_PRELOAD_QUERIES: false,
   ENABLE_CLIENT_EDGES: false,
   ENABLE_VARIABLE_CONNECTION_KEY: false,
   ENABLE_PARTIAL_RENDERING_DEFAULT: true,
@@ -49,9 +45,7 @@ const RelayFeatureFlags: FeatureFlags = {
   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/util/RelayRuntimeTypes.js.flow

@@ -17,7 +17,10 @@
  */
 
 import type {ReaderFragment, ReaderInlineDataFragment} from './ReaderNode';
-import type {ConcreteRequest} from './RelayConcreteNode';
+import type {
+  ConcreteRequest,
+  ConcreteUpdatableQuery,
+} from './RelayConcreteNode';
 
 /**
  * Represents any resource that must be explicitly disposed of. The most common
@@ -41,6 +44,14 @@ export type OperationType = {|
   +rawResponse?: {...},
 |};
 
+/**
+ * Generated updatable query flow types are subtypes of this.
+ */
+export type UpdatableQueryType = {|
+  +variables: Variables,
+  +response: mixed,
+|};
+
 export type VariablesOf<T: OperationType> = T['variables'];
 
 /**
@@ -84,6 +95,14 @@ declare export opaque type Operation<
   TRawResponse,
 >: ConcreteRequest;
 
+/**
+ * Return type of graphql tag literals for updatable queries.
+ */
+declare export opaque type UpdatableQuery<
+  -TVariables: Variables,
+  +TData,
+>: ConcreteUpdatableQuery;
+
 /**
  * Return type of graphql tag literals for queries.
  */

package/util/deepFreeze.js.flow

@@ -18,7 +18,7 @@
  * For convenience, and for consistency with the behavior of `Object.freeze`,
  * returns the now-frozen original object.
  */
-function deepFreeze<T: interface {}>(object: T): T {
+function deepFreeze<T: {...}>(object: T): T {
   Object.freeze(object);
   Object.getOwnPropertyNames(object).forEach(name => {
     // $FlowFixMe[prop-missing]

package/util/handlePotentialSnapshotErrors.js.flow

@@ -0,0 +1,63 @@
+/**
+ * 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.
+ *
+ * @flow
+ * @emails oncall+relay
+ * @format
+ */
+
+'use strict';
+
+import type {
+  IEnvironment,
+  MissingRequiredFields,
+  RelayResolverErrors,
+} from '../store/RelayStoreTypes';
+
+function handlePotentialSnapshotErrors(
+  environment: IEnvironment,
+  missingRequiredFields: ?MissingRequiredFields,
+  relayResolverErrors: RelayResolverErrors,
+) {
+  for (const resolverError of relayResolverErrors) {
+    environment.requiredFieldLogger({
+      kind: 'relay_resolver.error',
+      owner: resolverError.field.owner,
+      fieldPath: resolverError.field.path,
+      error: resolverError.error,
+    });
+  }
+  if (missingRequiredFields != null) {
+    switch (missingRequiredFields.action) {
+      case 'THROW': {
+        const {path, owner} = missingRequiredFields.field;
+        // This gives the consumer the chance to throw their own error if they so wish.
+        environment.requiredFieldLogger({
+          kind: 'missing_field.throw',
+          owner,
+          fieldPath: path,
+        });
+        throw new Error(
+          `Relay: Missing @required value at path '${path}' in '${owner}'.`,
+        );
+      }
+      case 'LOG':
+        missingRequiredFields.fields.forEach(({path, owner}) => {
+          environment.requiredFieldLogger({
+            kind: 'missing_field.log',
+            owner,
+            fieldPath: path,
+          });
+        });
+        break;
+      default: {
+        (missingRequiredFields.action: empty);
+      }
+    }
+  }
+}
+
+module.exports = handlePotentialSnapshotErrors;

package/util/isEmptyObject.js.flow

@@ -14,7 +14,7 @@
 // $FlowFixMe[method-unbinding] added when improving typing for this parameters
 const hasOwnProperty = Object.prototype.hasOwnProperty;
 
-function isEmptyObject(obj: interface {+[key: string]: mixed}): boolean {
+function isEmptyObject(obj: {+[key: string]: mixed}): boolean {
   for (const key in obj) {
     if (hasOwnProperty.call(obj, key)) {
       return false;

package/lib/util/reportMissingRequiredFields.js

@@ -1,48 +0,0 @@
-/**
- * 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';
-
-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/util/reportMissingRequiredFields.js.flow

@@ -1,51 +0,0 @@
-/**
- * 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.
- *
- * @flow
- * @emails oncall+relay
- * @format
- */
-
-'use strict';
-
-import type {
-  IEnvironment,
-  MissingRequiredFields,
-} from '../store/RelayStoreTypes';
-
-function reportMissingRequiredFields(
-  environment: IEnvironment,
-  missingRequiredFields: MissingRequiredFields,
-) {
-  switch (missingRequiredFields.action) {
-    case 'THROW': {
-      const {path, owner} = missingRequiredFields.field;
-      // This gives the consumer the chance to throw their own error if they so wish.
-      environment.requiredFieldLogger({
-        kind: 'missing_field.throw',
-        owner,
-        fieldPath: path,
-      });
-      throw new Error(
-        `Relay: Missing @required value at path '${path}' in '${owner}'.`,
-      );
-    }
-    case 'LOG':
-      missingRequiredFields.fields.forEach(({path, owner}) => {
-        environment.requiredFieldLogger({
-          kind: 'missing_field.log',
-          owner,
-          fieldPath: path,
-        });
-      });
-      break;
-    default: {
-      (missingRequiredFields.action: empty);
-    }
-  }
-}
-
-module.exports = reportMissingRequiredFields;