add id collision logging in RelayResponseNormalizer with typename metadata

Reviewed By: captbaritone

Differential Revision: D71346432

fbshipit-source-id: 29bfb713161c28776a75c69ac62280cdcc176dfb

Author: monicatang

packages/relay-runtime/store/OperationExecutor.js

@@ -612,6 +612,7 @@ class Executor<TMutation: MutationParameters> {
         {
           actorIdentifier: this._actorIdentifier,
           getDataID: this._getDataID,
+          log: this._log,
           path: [],
           shouldProcessClientComponents: this._shouldProcessClientComponents,
           treatMissingFieldsAsNull,
@@ -721,6 +722,7 @@ class Executor<TMutation: MutationParameters> {
       {
         actorIdentifier: this._actorIdentifier,
         getDataID: this._getDataID,
+        log: this._log,
         path: followupPayload.path,
         treatMissingFieldsAsNull: this._treatMissingFieldsAsNull,
         shouldProcessClientComponents: this._shouldProcessClientComponents,
@@ -803,6 +805,7 @@ class Executor<TMutation: MutationParameters> {
         {
           actorIdentifier: this._actorIdentifier,
           getDataID: this._getDataID,
+          log: this._log,
           path: [],
           treatMissingFieldsAsNull: this._treatMissingFieldsAsNull,
           shouldProcessClientComponents: this._shouldProcessClientComponents,
@@ -1259,6 +1262,7 @@ class Executor<TMutation: MutationParameters> {
       {
         actorIdentifier: this._actorIdentifier,
         getDataID: this._getDataID,
+        log: this._log,
         path: placeholder.path,
         treatMissingFieldsAsNull: this._treatMissingFieldsAsNull,
         shouldProcessClientComponents: this._shouldProcessClientComponents,
@@ -1486,6 +1490,7 @@ class Executor<TMutation: MutationParameters> {
     const relayPayload = this._normalizeResponse(response, selector, typeName, {
       actorIdentifier: this._actorIdentifier,
       getDataID: this._getDataID,
+      log: this._log,
       path: [...normalizationPath, responseKey, String(itemIndex)],
       treatMissingFieldsAsNull: this._treatMissingFieldsAsNull,
       shouldProcessClientComponents: this._shouldProcessClientComponents,

packages/relay-runtime/store/RelayModernStore.js

@@ -811,6 +811,7 @@ class RelayModernStore implements Store {
     return {
       path,
       getDataID: this._getDataID,
+      log: this.__log,
       treatMissingFieldsAsNull: this._treatMissingFieldsAsNull,
       shouldProcessClientComponents: this._shouldProcessClientComponents,
       actorIdentifier: this._actorIdentifier,

packages/relay-runtime/store/RelayResponseNormalizer.js

@@ -30,6 +30,7 @@ import type {
   FollowupPayload,
   HandleFieldPayload,
   IncrementalDataPlaceholder,
+  LogFunction,
   MutableRecordSource,
   NormalizationSelector,
   Record,
@@ -72,6 +73,7 @@ export type GetDataID = (
 export type NormalizationOptions = {
   +getDataID: GetDataID,
   +treatMissingFieldsAsNull: boolean,
+  +log: ?LogFunction,
   +path?: $ReadOnlyArray<string>,
   +shouldProcessClientComponents?: ?boolean,
   +actorIdentifier?: ?ActorIdentifier,
@@ -116,6 +118,7 @@ class RelayResponseNormalizer {
   _variables: Variables;
   _shouldProcessClientComponents: ?boolean;
   _errorTrie: RelayErrorTrie | null;
+  _log: ?LogFunction;
 
   constructor(
     recordSource: MutableRecordSource,
@@ -134,6 +137,7 @@ class RelayResponseNormalizer {
     this._recordSource = recordSource;
     this._variables = variables;
     this._shouldProcessClientComponents = options.shouldProcessClientComponents;
+    this._log = options.log;
   }
 
   normalizeResponse(
@@ -792,19 +796,22 @@ class RelayResponseNormalizer {
     field: NormalizationLinkedField,
     payload: Object,
   ): void {
-    const log = RelayFeatureFlags.LOG_STORE_ID_COLLISION;
+    const log = RelayFeatureFlags.ENABLE_STORE_ID_COLLISION_LOGGING;
     if (log) {
       const typeName = field.concreteType ?? this._getRecordType(payload);
       const dataID = RelayModernRecord.getDataID(record);
       const shouldLogWarning =
         (isClientID(dataID) && dataID !== ROOT_ID) ||
         RelayModernRecord.getType(record) === typeName;
       if (shouldLogWarning) {
-        log({
+        const logEvent = {
           name: 'idCollision.typename',
           previous_typename: RelayModernRecord.getType(record),
           new_typename: typeName,
-        });
+        };
+        if (this._log != null) {
+          this._log(logEvent);
+        }
       }
     }
     // NOTE: Only emit a warning in DEV
@@ -836,17 +843,6 @@ class RelayResponseNormalizer {
     storageKey: string,
     fieldValue: mixed,
   ): void {
-    const log = RelayFeatureFlags.LOG_STORE_ID_COLLISION;
-    if (log) {
-      const previousValue = RelayModernRecord.getValue(record, storageKey);
-      const shouldLogWarning =
-        storageKey === TYPENAME_KEY ||
-        previousValue === undefined ||
-        areEqual(previousValue, fieldValue);
-      if (shouldLogWarning) {
-        log({name: 'idCollision.field'});
-      }
-    }
     // NOTE: Only emit a warning in DEV
     if (__DEV__) {
       const previousValue = RelayModernRecord.getValue(record, storageKey);
@@ -877,13 +873,6 @@ class RelayResponseNormalizer {
     nextID: DataID,
     storageKey: string,
   ): void {
-    const log = RelayFeatureFlags.LOG_STORE_ID_COLLISION;
-    if (log) {
-      const shouldLogWarning = prevID === undefined || prevID === nextID;
-      if (shouldLogWarning) {
-        log({name: 'idCollision.field'});
-      }
-    }
     // NOTE: Only emit a warning in DEV
     if (__DEV__) {
       const shouldLogWarning = prevID === undefined || prevID === nextID;

packages/relay-runtime/store/RelayStoreTypes.js

@@ -796,23 +796,13 @@ export type IdCollisionTypenameLogEvent = {
   +new_typename: string,
 };
 
-/**
- * This event is logged when a response contains fields with different
- * values but which have the same corresponding id, resulting in a
- * collision in the store.
- */
-export type IdCollisionFieldLogEvent = {
-  +name: 'idCollision.field',
-};
-
 export type LogEvent =
   | SuspenseFragmentLogEvent
   | SuspenseQueryLogEvent
   | QueryResourceFetchLogEvent
   | QueryResourceRetainLogEvent
   | FragmentResourceMissingDataLogEvent
   | IdCollisionTypenameLogEvent
-  | IdCollisionFieldLogEvent
   | PendingOperationFoundLogEvent
   | NetworkInfoLogEvent
   | NetworkStartLogEvent

packages/relay-runtime/store/__tests__/RelayExperimentalGraphResponseHandler-test.js

@@ -30,6 +30,7 @@ const {getRequest} = require('relay-runtime/query/GraphQLTag');
 const defaultOptions = {
   getDataID: defaultGetDataID,
   treatMissingFieldsAsNull: false,
+  log: null,
 };
 
 function applyTransform(

packages/relay-runtime/store/__tests__/RelayExperimentalGraphResponseTransform-test.js

@@ -32,6 +32,7 @@ const {ROOT_ID} = require('relay-runtime/store/RelayStoreUtils');
 const defaultOptions = {
   getDataID: defaultGetDataID,
   treatMissingFieldsAsNull: false,
+  log: null,
 };
 
 function applyTransform(