2/n - Rename requiredFieldLogger to relayFieldLogger

Reviewed By: tyao1 Differential Revision: D51944688 fbshipit-source-id: 033583caabf32469820140136ba05b346de6cd5a
facebook · Jan 10, 2024 · 914794c · 914794c
1 parent af4afbd
commit 914794c
Show file tree

Hide file tree

Showing 22 changed files with 72 additions and 74 deletions.
diff --git a/packages/react-relay/__tests__/LiveResolvers-test.js b/packages/react-relay/__tests__/LiveResolvers-test.js
@@ -12,7 +12,7 @@
 'use strict';
 
 import type {IEnvironment} from 'relay-runtime';
-import type {RequiredFieldLoggerEvent} from 'relay-runtime/store/RelayStoreTypes';
+import type {RelayFieldLoggerEvent} from 'relay-runtime/store/RelayStoreTypes';
 import type {MutableRecordSource} from 'relay-runtime/store/RelayStoreTypes';
 
 const React = require('react');
@@ -909,15 +909,15 @@ describe.each([
         </RelayEnvironmentProvider>
       );
     }
-    const requiredFieldLogger = jest.fn<
-      $FlowFixMe | [RequiredFieldLoggerEvent],
+    const relayFieldLogger = jest.fn<
+      $FlowFixMe | [RelayFieldLoggerEvent],
       void,
     >();
     function createEnvironment(source: MutableRecordSource) {
       return new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
         store: new LiveResolverStore(source),
-        requiredFieldLogger,
+        relayFieldLogger,
       });
     }
 
@@ -951,7 +951,7 @@ describe.each([
     }).toThrow(
       "Relay: Missing @required value at path 'username' in 'ResolverThatThrows'.",
     );
-    expect(requiredFieldLogger.mock.calls).toEqual([
+    expect(relayFieldLogger.mock.calls).toEqual([
       [
         {
           kind: 'missing_field.throw',
@@ -960,7 +960,7 @@ describe.each([
         },
       ],
     ]);
-    requiredFieldLogger.mockReset();
+    relayFieldLogger.mockReset();
 
     // Render with complete data
     let renderer;
@@ -974,7 +974,7 @@ describe.each([
       throw new Error('Renderer is expected to be defined.');
     }
 
-    expect(requiredFieldLogger.mock.calls).toEqual([
+    expect(relayFieldLogger.mock.calls).toEqual([
       [
         {
           error: new Error(

diff --git a/packages/react-relay/multi-actor/__tests__/ActorChange-test.js b/packages/react-relay/multi-actor/__tests__/ActorChange-test.js
@@ -172,7 +172,7 @@ describe('ActorChange', () => {
       createNetworkForActor: actorIdentifier =>
         Network.create((...args) => fetchFnForActor(actorIdentifier, ...args)),
       logFn: jest.fn(),
-      requiredFieldLogger: jest.fn(),
+      relayFieldLogger: jest.fn(),
     });
     environment = multiActorEnvironment.forActor(
       getActorIdentifier('actor:1234'),

diff --git a/packages/react-relay/multi-actor/__tests__/ActorChangeWithDefer-test.js b/packages/react-relay/multi-actor/__tests__/ActorChangeWithDefer-test.js
@@ -152,7 +152,7 @@ describe('ActorChange with @defer', () => {
       createNetworkForActor: actorIdentifier =>
         Network.create((...args) => fetchFnForActor(...args)),
       logFn: jest.fn(),
-      requiredFieldLogger: jest.fn(),
+      relayFieldLogger: jest.fn(),
     });
     environment = multiActorEnvironment.forActor(
       getActorIdentifier('actor:1234'),

diff --git a/packages/react-relay/multi-actor/__tests__/ActorChangeWithMutation-test.js b/packages/react-relay/multi-actor/__tests__/ActorChangeWithMutation-test.js
@@ -199,7 +199,7 @@ describe('ActorChange', () => {
       createNetworkForActor: actorIdentifier =>
         Network.create((...args) => fetchFnForActor(actorIdentifier, ...args)),
       logFn: jest.fn(),
-      requiredFieldLogger: jest.fn(),
+      relayFieldLogger: jest.fn(),
     });
     environment = multiActorEnvironment.forActor(
       getActorIdentifier('actor:1234'),

diff --git a/packages/react-relay/multi-actor/__tests__/ActorChangeWithStream-test.js b/packages/react-relay/multi-actor/__tests__/ActorChangeWithStream-test.js
@@ -141,7 +141,7 @@ describe('ActorChange with @stream', () => {
       createNetworkForActor: actorIdentifier =>
         Network.create((...args) => fetchFnForActor(...args)),
       logFn: jest.fn(),
-      requiredFieldLogger: jest.fn(),
+      relayFieldLogger: jest.fn(),
     });
     environment = multiActorEnvironment.forActor(
       getActorIdentifier('actor:1234'),

diff --git a/packages/react-relay/relay-hooks/__tests__/FragmentResource-Resolver-test.js b/packages/react-relay/relay-hooks/__tests__/FragmentResource-Resolver-test.js
@@ -11,7 +11,7 @@
 
 'use strict';
 
-import type {RequiredFieldLoggerEvent} from 'relay-runtime/store/RelayStoreTypes';
+import type {RelayFieldLoggerEvent} from 'relay-runtime/store/RelayStoreTypes';
 
 const {
   getFragmentResourceForEnvironment,
@@ -59,12 +59,12 @@ describe('FragmentResource RelayResolver behavior', () => {
   let query;
   let fragmentNode;
   let fragmentRef;
-  let mockRequiredFieldLogger;
+  let mockRelayFieldLogger;
 
   beforeEach(() => {
-    mockRequiredFieldLogger = jest.fn<[RequiredFieldLoggerEvent], void>();
+    mockRelayFieldLogger = jest.fn<[RelayFieldLoggerEvent], void>();
     environment = createMockEnvironment({
-      requiredFieldLogger: mockRequiredFieldLogger,
+      relayFieldLogger: mockRelayFieldLogger,
     });
     FragmentResource = getFragmentResourceForEnvironment(environment);
     query = createOperationDescriptor(BASIC_QUERY, {id: '1'});
@@ -87,9 +87,9 @@ describe('FragmentResource RelayResolver behavior', () => {
 
   it('Reports an error to the logger when a resolver field throws an error.', async () => {
     FragmentResource.read(fragmentNode, fragmentRef, 'componentDisplayName');
-    expect(environment.requiredFieldLogger).toHaveBeenCalledTimes(1);
+    expect(environment.relayFieldLogger).toHaveBeenCalledTimes(1);
 
-    const event = mockRequiredFieldLogger.mock.calls[0][0];
+    const event = mockRelayFieldLogger.mock.calls[0][0];
     if (event.kind !== 'relay_resolver.error') {
       throw new Error(
         "Expected log event to be of kind 'relay_resolver.error'",

diff --git a/packages/react-relay/relay-hooks/__tests__/FragmentResourceRequiredField-test.js b/packages/react-relay/relay-hooks/__tests__/FragmentResourceRequiredField-test.js
@@ -12,7 +12,7 @@
 'use strict';
 import type {
   LogEvent,
-  RequiredFieldLoggerEvent,
+  RelayFieldLoggerEvent,
 } from 'relay-runtime/store/RelayStoreTypes';
 
 const {getFragmentResourceForEnvironment} = require('../FragmentResource');
@@ -36,15 +36,15 @@ let environment;
 let query;
 let FragmentResource;
 let logger;
-let requiredFieldLogger;
+let relayFieldLogger;
 
 beforeEach(() => {
   logger = jest.fn<[LogEvent], void>();
-  requiredFieldLogger = jest.fn<[RequiredFieldLoggerEvent], void>();
+  relayFieldLogger = jest.fn<[RelayFieldLoggerEvent], void>();
 
   environment = createMockEnvironment({
     log: logger,
-    requiredFieldLogger,
+    relayFieldLogger,
   });
   FragmentResource = getFragmentResourceForEnvironment(environment);
 
@@ -107,7 +107,7 @@ test('Logs if a @required(action: LOG) field is null', () => {
     },
     componentDisplayName,
   );
-  expect(requiredFieldLogger).toHaveBeenCalledWith({
+  expect(relayFieldLogger).toHaveBeenCalledWith({
     fieldPath: 'alternate_name',
     kind: 'missing_field.log',
     owner: 'FragmentResourceRequiredFieldTestUserFragment',
@@ -170,7 +170,7 @@ test('Throws if a @required(action: THROW) field is present and then goes missin
     "Relay: Missing @required value at path 'name' in 'FragmentResourceRequiredFieldTestUserFragment'.",
   );
 
-  expect(requiredFieldLogger).toHaveBeenCalledWith({
+  expect(relayFieldLogger).toHaveBeenCalledWith({
     fieldPath: 'name',
     kind: 'missing_field.throw',
     owner: 'FragmentResourceRequiredFieldTestUserFragment',

diff --git a/packages/react-relay/relay-hooks/__tests__/useFragment-with-required-test.js b/packages/react-relay/relay-hooks/__tests__/useFragment-with-required-test.js
@@ -11,7 +11,7 @@
 
 'use strict';
 import type {MutableRecordSource} from 'relay-runtime/store/RelayStoreTypes';
-import type {RequiredFieldLoggerEvent} from 'relay-runtime/store/RelayStoreTypes';
+import type {RelayFieldLoggerEvent} from 'relay-runtime/store/RelayStoreTypes';
 
 const useFragmentOriginal_EXPERIMENTAL = require('../experimental/useFragment_EXPERIMENTAL');
 const RelayEnvironmentProvider = require('../RelayEnvironmentProvider');
@@ -77,15 +77,15 @@ describe.each([
         </RelayEnvironmentProvider>
       );
     }
-    const requiredFieldLogger = jest.fn<
-      $FlowFixMe | [RequiredFieldLoggerEvent],
+    const relayFieldLogger = jest.fn<
+      $FlowFixMe | [RelayFieldLoggerEvent],
       void,
     >();
     function createEnvironment(source: MutableRecordSource) {
       return new RelayModernEnvironment({
         network: RelayNetwork.create(jest.fn()),
         store: new LiveResolverStore(source),
-        requiredFieldLogger,
+        relayFieldLogger,
       });
     }
 
@@ -108,7 +108,7 @@ describe.each([
     );
 
     // Validate that the missing required field was logged.
-    expect(requiredFieldLogger.mock.calls).toEqual([
+    expect(relayFieldLogger.mock.calls).toEqual([
       [
         {
           fieldPath: 'name',

diff --git a/packages/relay-runtime/index.js b/packages/relay-runtime/index.js
@@ -157,7 +157,7 @@ export type {
   RecordSourceSelectorProxy,
   RelayContext,
   RequestDescriptor,
-  RequiredFieldLogger,
+  RelayFieldLogger,
   SelectorData,
   SelectorStoreUpdater,
   SingularReaderSelector,

diff --git a/packages/relay-runtime/multi-actor-environment/ActorSpecificEnvironment.js b/packages/relay-runtime/multi-actor-environment/ActorSpecificEnvironment.js
@@ -25,7 +25,7 @@ import type {
   OperationTracker,
   OptimisticResponseConfig,
   OptimisticUpdateFunction,
-  RequiredFieldLogger,
+  RelayFieldLogger,
   SelectorStoreUpdater,
   SingularReaderSelector,
   Snapshot,
@@ -54,7 +54,7 @@ export type ActorSpecificEnvironmentConfig = $ReadOnly<{
   logFn: LogFunction,
   multiActorEnvironment: IMultiActorEnvironment,
   network: INetwork,
-  requiredFieldLogger: RequiredFieldLogger,
+  relayFieldLogger: RelayFieldLogger,
   store: Store,
   missingFieldHandlers: $ReadOnlyArray<MissingFieldHandler>,
 }>;
@@ -70,15 +70,15 @@ class ActorSpecificEnvironment implements IActorEnvironment {
   +configName: ?string;
   +multiActorEnvironment: IMultiActorEnvironment;
   +options: mixed;
-  requiredFieldLogger: RequiredFieldLogger;
+  relayFieldLogger: RelayFieldLogger;
 
   constructor(config: ActorSpecificEnvironmentConfig) {
     this.configName = config.configName;
     this.actorIdentifier = config.actorIdentifier;
     this.multiActorEnvironment = config.multiActorEnvironment;
 
     this.__log = config.logFn;
-    this.requiredFieldLogger = config.requiredFieldLogger;
+    this.relayFieldLogger = config.relayFieldLogger;
     this._operationTracker = new RelayOperationTracker();
     this._store = config.store;
     this._network = wrapNetworkWithLogObserver(this, config.network);

diff --git a/packages/relay-runtime/multi-actor-environment/MultiActorEnvironment.js b/packages/relay-runtime/multi-actor-environment/MultiActorEnvironment.js
@@ -28,7 +28,7 @@ import type {
   OperationLoader,
   OptimisticResponseConfig,
   OptimisticUpdateFunction,
-  RequiredFieldLogger,
+  RelayFieldLogger,
   SelectorStoreUpdater,
   SingularReaderSelector,
   Snapshot,
@@ -48,7 +48,7 @@ import type {
 const RelayDefaultHandlerProvider = require('../handlers/RelayDefaultHandlerProvider');
 const RelayObservable = require('../network/RelayObservable');
 const defaultGetDataID = require('../store/defaultGetDataID');
-const defaultRequiredFieldLogger = require('../store/defaultRequiredFieldLogger');
+const defaultRelayFieldLogger = require('../store/defaultRelayFieldLogger');
 const normalizeResponse = require('../store/normalizeResponse');
 const OperationExecutor = require('../store/OperationExecutor');
 const RelayModernStore = require('../store/RelayModernStore');
@@ -67,7 +67,7 @@ export type MultiActorEnvironmentConfig = $ReadOnly<{
   missingFieldHandlers?: ?$ReadOnlyArray<MissingFieldHandler>,
   normalizeResponse?: NormalizeResponseFunction,
   operationLoader?: ?OperationLoader,
-  requiredFieldLogger?: ?RequiredFieldLogger,
+  relayFieldLogger?: ?RelayFieldLogger,
   scheduler?: ?TaskScheduler,
   shouldProcessClientComponents?: ?boolean,
   treatMissingFieldsAsNull?: boolean,
@@ -87,7 +87,7 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
   +_normalizeResponse: NormalizeResponseFunction;
   +_operationExecutions: Map<string, ActiveState>;
   +_operationLoader: ?OperationLoader;
-  +_requiredFieldLogger: RequiredFieldLogger;
+  +_relayFieldLogger: RelayFieldLogger;
   +_scheduler: ?TaskScheduler;
   +_shouldProcessClientComponents: ?boolean;
   +_treatMissingFieldsAsNull: boolean;
@@ -103,8 +103,7 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
       : RelayDefaultHandlerProvider;
     this._logFn = config.logFn ?? emptyFunction;
     this._operationExecutions = new Map();
-    this._requiredFieldLogger =
-      config.requiredFieldLogger ?? defaultRequiredFieldLogger;
+    this._relayFieldLogger = config.relayFieldLogger ?? defaultRelayFieldLogger;
     this._shouldProcessClientComponents = config.shouldProcessClientComponents;
     this._treatMissingFieldsAsNull = config.treatMissingFieldsAsNull ?? false;
     this._isServer = config.isServer ?? false;
@@ -130,7 +129,7 @@ class MultiActorEnvironment implements IMultiActorEnvironment {
         actorIdentifier,
         multiActorEnvironment: this,
         logFn: this._logFn,
-        requiredFieldLogger: this._requiredFieldLogger,
+        relayFieldLogger: this._relayFieldLogger,
         store:
           this._createStoreForActor != null
             ? this._createStoreForActor(actorIdentifier)

diff --git a/packages/relay-runtime/multi-actor-environment/__tests__/actorEnvironment_execute-test.js b/packages/relay-runtime/multi-actor-environment/__tests__/actorEnvironment_execute-test.js
@@ -32,7 +32,7 @@ test('send a network request with actor specific params', () => {
     // $FlowFixMe[incompatible-call] error found when enabling Flow LTI mode
     createNetworkForActor: () => create(fetchFn),
     logFn: jest.fn(),
-    requiredFieldLogger: jest.fn(),
+    relayFieldLogger: jest.fn(),
   });
   const actorEnvironment = multiActorEnvironment.forActor(actorIdentifier);
 

diff --git a/packages/relay-runtime/multi-actor-environment/__tests__/forActor-test.js b/packages/relay-runtime/multi-actor-environment/__tests__/forActor-test.js
@@ -38,7 +38,7 @@ test('forActor: creates an environment', () => {
   const multiActorEnvironment = new MultiActorEnvironment({
     createNetworkForActor: () => create(fetchFn),
     logFn: jest.fn(),
-    requiredFieldLogger: jest.fn(),
+    relayFieldLogger: jest.fn(),
   });
   const actorEnvironment = multiActorEnvironment.forActor(actorIdentifer);
 
@@ -61,7 +61,7 @@ test('forActor: memoize an environment', () => {
   const multiActorEnvironment = new MultiActorEnvironment({
     createNetworkForActor: () => create(fetchFn),
     logFn: jest.fn(),
-    requiredFieldLogger: jest.fn(),
+    relayFieldLogger: jest.fn(),
   });
   const actorEnvironment = multiActorEnvironment.forActor(actorIdentifer);
 

diff --git a/packages/relay-runtime/query/__tests__/fetchQuery-test.js b/packages/relay-runtime/query/__tests__/fetchQuery-test.js
@@ -11,7 +11,7 @@
 
 'use strict';
 
-import type {RequiredFieldLoggerEvent} from '../../store/RelayStoreTypes';
+import type {RelayFieldLoggerEvent} from '../../store/RelayStoreTypes';
 import type {fetchQueryTest1Query$data} from './__generated__/fetchQueryTest1Query.graphql';
 import type {RequestParameters} from 'relay-runtime';
 
@@ -240,9 +240,9 @@ describe('fetchQuery', () => {
 
 describe('fetchQuery with missing @required value', () => {
   it('provides data snapshot on next', () => {
-    const requiredFieldLogger = jest.fn<[RequiredFieldLoggerEvent], void>();
+    const relayFieldLogger = jest.fn<[RelayFieldLoggerEvent], void>();
     const environment = createMockEnvironment({
-      requiredFieldLogger,
+      relayFieldLogger,
     });
     const query = graphql`
       query fetchQueryTest2Query {
@@ -267,16 +267,16 @@ describe('fetchQuery with missing @required value', () => {
     });
     subscription.unsubscribe();
     expect(observer.next).toHaveBeenCalledWith({me: null});
-    expect(requiredFieldLogger).toHaveBeenCalledWith({
+    expect(relayFieldLogger).toHaveBeenCalledWith({
       fieldPath: 'me.name',
       kind: 'missing_field.log',
       owner: 'fetchQueryTest2Query',
     });
   });
 
   it('throws on resolution', () => {
-    const requiredFieldLogger = jest.fn<[RequiredFieldLoggerEvent], void>();
-    const environment = createMockEnvironment({requiredFieldLogger});
+    const relayFieldLogger = jest.fn<[RelayFieldLoggerEvent], void>();
+    const environment = createMockEnvironment({relayFieldLogger});
     const query = graphql`
       query fetchQueryTest3Query {
         me {
@@ -299,7 +299,7 @@ describe('fetchQuery with missing @required value', () => {
       data: {me: {id: 'ID-1', name: null}},
     });
     subscription.unsubscribe();
-    expect(requiredFieldLogger).toHaveBeenCalledWith({
+    expect(relayFieldLogger).toHaveBeenCalledWith({
       fieldPath: 'me.name',
       kind: 'missing_field.throw',
       owner: 'fetchQueryTest3Query',