relay-test-utils 20.1.1 → 21.0.0

package/RelayMockPayloadGenerator.js.flow

@@ -60,28 +60,28 @@ type ValueResolver = (
   typeName: ?string,
   context: MockResolverContext,
   plural: ?boolean,
-  defaultValue?: mixed,
-) => mixed;
+  defaultValue?: unknown,
+) => unknown;
 type Traversable = {
-  +selections: $ReadOnlyArray<NormalizationSelection>,
+  +selections: ReadonlyArray<NormalizationSelection>,
   +typeName: ?string,
   +isAbstractType: ?boolean,
   +name: ?string,
   +alias: ?string,
-  +args: ?{[string]: mixed, ...},
+  +args: ?{[string]: unknown, ...},
 };
-type MockData = {[string]: mixed, ...};
+type MockData = {[string]: unknown, ...};
 export type MockResolverContext = {
   +parentType: ?string,
   +name: ?string,
   +alias: ?string,
-  +path: ?$ReadOnlyArray<string>,
-  +args: ?{[string]: mixed, ...},
+  +path: ?ReadonlyArray<string>,
+  +args: ?{[string]: unknown, ...},
 };
 type MockResolver = (
   context: MockResolverContext,
   generateId: () => number,
-) => mixed;
+) => unknown;
 export type MockResolvers = {+[typeName: string]: MockResolver, ...};
 
 type SelectionMetadata = {
@@ -89,7 +89,7 @@ type SelectionMetadata = {
     +type: string,
     +plural: boolean,
     +nullable: boolean,
-    +enumValues: $ReadOnlyArray<string> | null,
+    +enumValues: ReadonlyArray<string> | null,
   },
   ...
 };
@@ -131,9 +131,9 @@ function valueResolver(
   typeName: ?string,
   context: MockResolverContext,
   plural: ?boolean = false,
-  defaultValue?: mixed,
-): mixed {
-  const generateValue = (possibleDefaultValue: mixed) => {
+  defaultValue?: unknown,
+): unknown {
+  const generateValue = (possibleDefaultValue: unknown) => {
     let mockValue;
     const mockResolver =
       typeName != null && mockResolvers != null
@@ -170,9 +170,9 @@ function createValueResolver(mockResolvers: ?MockResolvers): ValueResolver {
 }
 
 function generateMockList<T>(
-  placeholderArray: $ReadOnlyArray<mixed>,
-  generateListItem: (defaultValue: mixed, index?: number) => T,
-): $ReadOnlyArray<T> {
+  placeholderArray: ReadonlyArray<unknown>,
+  generateListItem: (defaultValue: unknown, index?: number) => T,
+): ReadonlyArray<T> {
   return placeholderArray.map((possibleDefaultValue, index) =>
     generateListItem(possibleDefaultValue, index),
   );
@@ -207,7 +207,7 @@ class RelayMockPayloadGenerator {
   }
 
   generate(
-    selections: $ReadOnlyArray<NormalizationSelection>,
+    selections: ReadonlyArray<NormalizationSelection>,
     operationType: string,
   ): Array<GraphQLSingularResponse> {
     const defaultValues = this._getDefaultValuesForObject(
@@ -236,7 +236,7 @@ class RelayMockPayloadGenerator {
 
   _traverse(
     traversable: Traversable,
-    path: $ReadOnlyArray<string>,
+    path: ReadonlyArray<string>,
     prevData: ?MockData,
     defaultValues: ?MockData,
   ): MockData {
@@ -256,10 +256,10 @@ class RelayMockPayloadGenerator {
    * Generate mock values for selection of fields
    */
   _traverseSelections(
-    selections: $ReadOnlyArray<NormalizationSelection>,
+    selections: ReadonlyArray<NormalizationSelection>,
     typeName: ?string,
     isAbstractType: ?boolean,
-    path: $ReadOnlyArray<string>,
+    path: ReadonlyArray<string>,
     prevData: ?MockData,
     defaultValues: ?MockData,
   ): MockData {
@@ -278,6 +278,8 @@ class RelayMockPayloadGenerator {
           break;
         }
         // $FlowFixMe[incompatible-type]
+        /* $FlowFixMe[invalid-compare] Error discovered during Constant
+         * Condition roll out. See https://fburl.com/workplace/4oq3zi07. */
         case CONNECTION: {
           mockData = this._traverseSelections(
             [selection.edges, selection.pageInfo],
@@ -528,7 +530,7 @@ class RelayMockPayloadGenerator {
             );
 
             const splitOperation: NormalizationSplitOperation =
-              (operation: $FlowFixMe);
+              operation as $FlowFixMe;
             const {documentName} = selection;
             if (mockData == null) {
               mockData = {};
@@ -587,7 +589,7 @@ class RelayMockPayloadGenerator {
           );
           break;
         default:
-          (selection: empty);
+          selection as empty;
           invariant(
             false,
             'RelayMockPayloadGenerator(): Unexpected AST kind `%s`.',
@@ -595,7 +597,7 @@ class RelayMockPayloadGenerator {
           );
       }
     });
-    // $FlowFixMe[incompatible-return]
+    // $FlowFixMe[incompatible-type]
     return mockData;
   }
 
@@ -604,9 +606,9 @@ class RelayMockPayloadGenerator {
    * @private
    */
   _getCorrectDefaultEnum(
-    enumValues: $ReadOnlyArray<string>,
-    value: mixed | Array<mixed>,
-    path: $ReadOnlyArray<string>,
+    enumValues: ReadonlyArray<string>,
+    value: unknown | Array<unknown>,
+    path: ReadonlyArray<string>,
     applicationName: string,
   ): ?(string | Array<string>) {
     if (value === undefined) {
@@ -662,17 +664,17 @@ class RelayMockPayloadGenerator {
   _mockScalar(
     field: NormalizationScalarField,
     typeName: ?string,
-    path: $ReadOnlyArray<string>,
+    path: ReadonlyArray<string>,
     mockData: ?MockData,
     defaultValues: ?MockData,
   ): MockData {
-    const data = mockData ?? ({}: {[string]: mixed});
+    const data = mockData ?? ({} as {[string]: unknown});
     const applicationName = field.alias ?? field.name;
     if (data.hasOwnProperty(applicationName) && field.name !== TYPENAME_KEY) {
       return data;
     }
 
-    let value: mixed;
+    let value: unknown;
 
     // For __typename fields we are going to return typeName
     if (field.name === TYPENAME_KEY) {
@@ -740,7 +742,7 @@ class RelayMockPayloadGenerator {
    */
   _mockLink(
     field: NormalizationLinkedField,
-    path: $ReadOnlyArray<string>,
+    path: ReadonlyArray<string>,
     prevData: ?MockData,
     defaultValues: ?MockData,
   ): MockData | null {
@@ -787,7 +789,7 @@ class RelayMockPayloadGenerator {
       field.concreteType == null && typeName === typeFromSelection.type;
 
     const generateDataForField = (
-      possibleDefaultValue: mixed,
+      possibleDefaultValue: unknown,
       index?: number,
     ) => {
       const fieldPath = field.plural
@@ -819,7 +821,7 @@ class RelayMockPayloadGenerator {
           ? // $FlowFixMe[incompatible-variance]
             data[applicationName]
           : null,
-        // $FlowFixMe[incompatible-call]
+        // $FlowFixMe[incompatible-type]
         fieldDefaultValue,
       );
     };
@@ -837,7 +839,7 @@ class RelayMockPayloadGenerator {
   /**
    * Get the value for a variable by name
    */
-  _getVariableValue(name: string): mixed {
+  _getVariableValue(name: string): unknown {
     invariant(
       this._variables.hasOwnProperty(name),
       'RelayMockPayloadGenerator(): Undefined variable `%s`.',
@@ -855,8 +857,8 @@ class RelayMockPayloadGenerator {
     typeName: ?string,
     fieldName: ?string,
     fieldAlias: ?string,
-    path: $ReadOnlyArray<string>,
-    args: ?{[string]: mixed, ...},
+    path: ReadonlyArray<string>,
+    args: ?{[string]: unknown, ...},
   ): ?MockData {
     let data;
     if (typeName != null && this._mockResolvers[typeName] != null) {
@@ -881,8 +883,8 @@ class RelayMockPayloadGenerator {
   /**
    * Get object with variables for field
    */
-  _getFieldArgs(field: NormalizationField): {[string]: mixed, ...} {
-    const args: {[string]: mixed} = {};
+  _getFieldArgs(field: NormalizationField): {[string]: unknown, ...} {
+    const args: {[string]: unknown} = {};
     if (field.args != null) {
       field.args.forEach(arg => {
         args[arg.name] = this._getArgValue(arg);
@@ -891,14 +893,14 @@ class RelayMockPayloadGenerator {
     return args;
   }
 
-  _getArgValue(arg: NormalizationArgument): mixed {
+  _getArgValue(arg: NormalizationArgument): unknown {
     switch (arg.kind) {
       case 'Literal':
         return arg.value;
       case 'Variable':
         return this._getVariableValue(arg.variableName);
       case 'ObjectValue': {
-        const value: {[string]: mixed} = {};
+        const value: {[string]: unknown} = {};
         arg.fields.forEach(field => {
           value[field.name] = this._getArgValue(field);
         });
@@ -920,11 +922,11 @@ class RelayMockPayloadGenerator {
   _getScalarFieldTypeDetails(
     field: NormalizationScalarField,
     typeName: ?string,
-    selectionPath: $ReadOnlyArray<string>,
+    selectionPath: ReadonlyArray<string>,
   ): {
     +type: string,
     +plural: boolean,
-    +enumValues: $ReadOnlyArray<string> | null,
+    +enumValues: ReadonlyArray<string> | null,
     +nullable: boolean,
   } {
     return (
@@ -943,8 +945,8 @@ class RelayMockPayloadGenerator {
    * @private
    */
   _getTypeDetailsForPath(
-    path: $ReadOnlyArray<string>,
-  ): $Values<SelectionMetadata> {
+    path: ReadonlyArray<string>,
+  ): Values<SelectionMetadata> {
     return this._selectionMetadata[
       // When selecting metadata, skip the number on plural fields so that every field in the array
       // gets the same metadata.
@@ -1050,7 +1052,7 @@ function generateWithDefer(
     operation.request.variables,
     mockResolvers ?? null,
     getSelectionMetadataFromOperation(operation),
-    {...otherOptions, generateDeferredPayload: generateDeferredPayload},
+    {...otherOptions, generateDeferredPayload},
   );
 
   if (!generateDeferredPayload) {

package/RelayModernMockEnvironment.js.flow

@@ -113,9 +113,9 @@ type MockFunctions = {
   +complete: (request: ConcreteRequest | OperationDescriptor) => void,
   +resolve: (
     request: ConcreteRequest | OperationDescriptor,
-    payload: $ReadOnlyArray<GraphQLSingularResponse> | GraphQLSingularResponse,
+    payload: ReadonlyArray<GraphQLSingularResponse> | GraphQLSingularResponse,
   ) => void,
-  +getAllOperations: () => $ReadOnlyArray<OperationDescriptor>,
+  +getAllOperations: () => ReadonlyArray<OperationDescriptor>,
   +findOperation: (
     findFn: (operation: OperationDescriptor) => boolean,
   ) => OperationDescriptor,
@@ -187,8 +187,8 @@ function createMockEnvironment(
     ttl: MAX_TTL,
   });
 
-  let pendingRequests: $ReadOnlyArray<PendingRequest> = [];
-  let pendingOperations: $ReadOnlyArray<OperationDescriptor> = [];
+  let pendingRequests: ReadonlyArray<PendingRequest> = [];
+  let pendingOperations: ReadonlyArray<OperationDescriptor> = [];
   const queuePendingOperation = (
     query: GraphQLTaggedNode,
     variables: Variables,
@@ -199,7 +199,7 @@ function createMockEnvironment(
     );
     pendingOperations = pendingOperations.concat([operationDescriptor]);
   };
-  let resolversQueue: $ReadOnlyArray<OperationMockResolver> = [];
+  let resolversQueue: ReadonlyArray<OperationMockResolver> = [];
 
   const queueOperationResolver = (resolver: OperationMockResolver): void => {
     resolversQueue = resolversQueue.concat([resolver]);
@@ -222,7 +222,7 @@ function createMockEnvironment(
       cachedPayload = cache.get(cacheID, variables);
     }
     if (cachedPayload !== null) {
-      // $FlowFixMe[incompatible-call]
+      // $FlowFixMe[incompatible-type]
       return Observable.from<GraphQLSingularResponse>(cachedPayload);
     }
 
@@ -275,10 +275,10 @@ function createMockEnvironment(
     input: ConcreteRequest | OperationDescriptor,
   ): ConcreteRequest {
     if (input.kind === 'Request') {
-      const request: ConcreteRequest = (input: $FlowFixMe);
+      const request: ConcreteRequest = input as $FlowFixMe;
       return request;
     } else {
-      const operationDescriptor: OperationDescriptor = (input: $FlowFixMe);
+      const operationDescriptor: OperationDescriptor = input as $FlowFixMe;
       invariant(
         pendingOperations.includes(operationDescriptor),
         'RelayModernMockEnvironment: Operation "%s" was not found in the list of pending operations',
@@ -291,13 +291,13 @@ function createMockEnvironment(
   // The same request may be made by multiple query renderers
   function getRequests(
     input: ConcreteRequest | OperationDescriptor,
-  ): $ReadOnlyArray<PendingRequest> {
+  ): ReadonlyArray<PendingRequest> {
     let concreteRequest: ConcreteRequest;
     let operationDescriptor: OperationDescriptor;
     if (input.kind === 'Request') {
-      concreteRequest = (input: $FlowFixMe);
+      concreteRequest = input as $FlowFixMe;
     } else {
-      operationDescriptor = (input: $FlowFixMe);
+      operationDescriptor = input as $FlowFixMe;
       concreteRequest = operationDescriptor.request.node;
     }
     const foundRequests = pendingRequests.filter(pending => {
@@ -334,6 +334,8 @@ function createMockEnvironment(
   function ensureValidPayload(payload: GraphQLSingularResponse) {
     invariant(
       typeof payload === 'object' &&
+        /* $FlowFixMe[invalid-compare] Error discovered during Constant
+         * Condition roll out. See https://fburl.com/workplace/5whu3i34. */
         payload !== null &&
         payload.hasOwnProperty('data'),
       'MockEnvironment(): Expected payload to be an object with a `data` key.',
@@ -379,6 +381,8 @@ function createMockEnvironment(
     const rejectError = typeof error === 'string' ? new Error(error) : error;
     getRequests(request).forEach(foundRequest => {
       const {sink} = foundRequest;
+      /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+       * roll out. See https://fburl.com/workplace/5whu3i34. */
       invariant(sink !== null, 'Sink should be defined.');
       sink.error(rejectError);
     });
@@ -390,6 +394,8 @@ function createMockEnvironment(
   ): void => {
     getRequests(request).forEach(foundRequest => {
       const {sink} = foundRequest;
+      /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+       * roll out. See https://fburl.com/workplace/5whu3i34. */
       invariant(sink !== null, 'Sink should be defined.');
       sink.next(ensureValidPayload(payload));
     });
@@ -398,6 +404,8 @@ function createMockEnvironment(
   const complete = (request: ConcreteRequest | OperationDescriptor): void => {
     getRequests(request).forEach(foundRequest => {
       const {sink} = foundRequest;
+      /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+       * roll out. See https://fburl.com/workplace/5whu3i34. */
       invariant(sink !== null, 'Sink should be defined.');
       sink.complete();
     });
@@ -405,10 +413,12 @@ function createMockEnvironment(
 
   const resolve = (
     request: ConcreteRequest | OperationDescriptor,
-    response: $ReadOnlyArray<GraphQLSingularResponse> | GraphQLSingularResponse,
+    response: ReadonlyArray<GraphQLSingularResponse> | GraphQLSingularResponse,
   ): void => {
     getRequests(request).forEach(foundRequest => {
       const {sink} = foundRequest;
+      /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+       * roll out. See https://fburl.com/workplace/5whu3i34. */
       invariant(sink !== null, 'Sink should be defined.');
       const payloads = Array.isArray(response) ? response : [response];
       payloads.forEach(payload => {
@@ -438,7 +448,7 @@ function createMockEnvironment(
     return pendingOperation;
   };
 
-  // $FlowExpectedError[prop-missing]
+  // $FlowExpectedError[incompatible-type]
   const environment: RelayMockEnvironment = new Environment({
     configName: 'RelayModernMockEnvironment',
     network: Network.create(execute, execute),
@@ -487,6 +497,8 @@ function createMockEnvironment(
   );
 
   // $FlowFixMe[incompatible-type]
+  /* $FlowFixMe[invalid-compare] Error discovered during Constant Condition
+   * roll out. See https://fburl.com/workplace/4oq3zi07. */
   if (global?.process?.env?.NODE_ENV === 'test') {
     // Mock all the functions with their original behavior
     mockDisposableMethod(environment, 'applyUpdate');

package/RelayResolverTestUtils.js.flow

@@ -34,18 +34,18 @@ const {
  * expect(actual).toEqual(expectedValue)
  * ```
  **/
-function testResolver<D: ?{+$fragmentType?: mixed, ...}, Ret>(
+function testResolver<D extends ?{+$fragmentType?: unknown, ...}, Ret>(
   resolver: ({$data?: D, $fragmentRefs: any, $fragmentSpreads: any}) => Ret,
   // indexed_access is not yet enabled for this code base. Once it is, this can
   // become: `Key['$data']`
-  fragmentData: NoInfer<Omit<$NonMaybeType<D>, '$fragmentType'>>,
+  fragmentData: NoInfer<Omit<NonNullable<D>, '$fragmentType'>>,
 ): Ret {
   const readFragment = ResolverFragments.readFragment;
-  // $FlowFixMe: a test utility, so... YOLO!!
+  // $FlowFixMe[incompatible-type]: a test utility, so... YOLO!!
   ResolverFragments.readFragment = () => fragmentData;
   const result = resolver(
     // This will be ignored since we mock the function it gets passed to.
-    // $FlowFixMe
+    // $FlowFixMe[incompatible-type]
     null,
   );
   ResolverFragments.readFragment = readFragment;

package/__flowtests__/RelayResolverTestUtilsFlowTest.js.flow

@@ -32,11 +32,11 @@ function myTestResolver(rootKey: RelayResolverTestUtilsFlowTest$key): string {
 
 testResolver(myTestResolver, {name: 'Elizabeth'});
 
-// $FlowExpectedError foo is an unexpected key
+// $FlowExpectedError[incompatible-type]  foo is an unexpected key
 testResolver(myTestResolver, {
   name: 'Elizabeth',
   foo: 'bar',
 });
 
-// $FlowExpectedError Object is not a string
+// $FlowExpectedError[incompatible-type]  Object is not a string
 testResolver(myTestResolver, {name: {}});

package/__flowtests__/__generated__/RelayResolverTestUtilsFlowTest.graphql.js.flow

@@ -6,10 +6,9 @@
  *
  * @oncall relay
  *
- * @generated SignedSource<<b888fe576f9a3c54121666e03d03d374>>
+ * @generated SignedSource<<eff5153dfb25d03ddd6c26d0ff39c34b>>
  * @flow
  * @lightSyntaxTransform
- * @nogrep
  */
 
 /* eslint-disable */
@@ -50,10 +49,10 @@ var node/*: ReaderFragment*/ = {
 };
 
 if (__DEV__) {
-  (node/*: any*/).hash = "f3f6718b7cf618c97293b5882ccc96c0";
+  (node/*:: as any*/).hash = "f3f6718b7cf618c97293b5882ccc96c0";
 }
 
-module.exports = ((node/*: any*/)/*: Fragment<
+module.exports = ((node/*:: as any*/)/*:: as Fragment<
   RelayResolverTestUtilsFlowTest$fragmentType,
   RelayResolverTestUtilsFlowTest$data,
 >*/);

package/index.js

@@ -1,5 +1,5 @@
 /**
- * Relay v20.1.1
+ * Relay v21.0.0
  *
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *

package/index.js.flow

@@ -9,6 +9,10 @@
  * @oncall relay
  */
 
+/**
+ * LLM/AI Agent: Relay documentation is available in node_modules/relay-runtime/llm-docs/
+ */
+
 'use strict';
 
 const RelayMockPayloadGenerator = require('./RelayMockPayloadGenerator');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relay-test-utils",
   "description": "Utilities for testing Relay applications.",
-  "version": "20.1.1",
+  "version": "21.0.0",
   "keywords": [
     "graphql",
     "relay"
@@ -18,7 +18,7 @@
     "@babel/runtime": "^7.25.0",
     "fbjs": "^3.0.2",
     "invariant": "^2.2.4",
-    "relay-runtime": "20.1.1"
+    "relay-runtime": "21.0.0"
   },
   "directories": {
     "": "./"

package/unwrapContainer.js.flow

@@ -23,19 +23,19 @@ const invariant = require('invariant');
 /**
  * Returns original component class wrapped by e.g. createFragmentContainer
  */
-function unwrapContainer<Props: {...}>(
+function unwrapContainer<Props extends {...}>(
   ComponentClass: component(
     ...$RelayProps<Props, RelayProp | RelayPaginationProp | RelayRefetchProp>
   ),
 ): component(...Props) {
-  // $FlowExpectedError
+  // $FlowExpectedError[prop-missing]
   const unwrapped = ComponentClass.__ComponentClass;
   invariant(
     unwrapped != null,
     'Could not find component for %s, is it a Relay container?',
     ComponentClass.displayName || ComponentClass.name,
   );
-  return (unwrapped: any);
+  return unwrapped as any;
 }
 
 module.exports = unwrapContainer;