Add Relay log event for when an EntryPointContainer uses an entrypoint component resource

Reviewed By: jstejada

Differential Revision: D23402346

fbshipit-source-id: 51befac08ae41495ec55d78ea8c740d3bf0ca029

Author: James Friend

packages/relay-experimental/EntryPointContainer.react.js

@@ -13,10 +13,14 @@
 
 'use strict';
 
+const ProfilerContext = require('./ProfilerContext');
 const React = require('react');
 
+const useRelayEnvironment = require('./useRelayEnvironment');
 const warning = require('warning');
 
+const {useContext, useEffect} = require('react');
+
 import type {
   EntryPointComponent,
   PreloadedEntryPoint,
@@ -47,8 +51,23 @@ function EntryPointContainer<
       'collection, and as such may no longer be present in the Relay store. ' +
       'In the future, this will become a hard error.',
   );
-  const {getComponent, queries, entryPoints, extraProps} = entryPointReference;
+  const {
+    getComponent,
+    queries,
+    entryPoints,
+    extraProps,
+    rootModuleReference,
+  } = entryPointReference;
   const Component = getComponent();
+  const profilerContext = useContext(ProfilerContext);
+  const environment = useRelayEnvironment();
+  useEffect(() => {
+    environment.__log({
+      name: 'entrypoint.root.consume',
+      profilerContext,
+      rootModuleID: rootModuleReference.getModuleId(),
+    });
+  }, [environment, profilerContext, rootModuleReference]);
   return (
     <Component
       entryPoints={entryPoints}

packages/relay-experimental/EntryPointTypes.flow.js

@@ -207,6 +207,7 @@ export type PreloadedEntryPoint<TEntryPointComponent> = $ReadOnly<{|
   getComponent: () => TEntryPointComponent,
   isDisposed: boolean,
   queries: $PropertyType<ElementConfig<TEntryPointComponent>, 'queries'>,
+  rootModuleReference: JSResourceReference<TEntryPointComponent>,
 |}>;
 
 export type ThinQueryParams<

packages/relay-experimental/LazyLoadEntryPointContainer_DEPRECATED.react.js

@@ -13,14 +13,17 @@
 
 'use strict';
 
+const ProfilerContext = require('./ProfilerContext');
 const React = require('react');
 
 const preloadQuery_DEPRECATED = require('./preloadQuery_DEPRECATED');
 const useRelayEnvironment = require('./useRelayEnvironment');
 
-const {useMemo} = require('react');
+const {useContext, useEffect, useMemo} = require('react');
 const {stableCopy} = require('relay-runtime');
 
+import type {JSResourceReference} from 'JSResourceReference';
+
 type PreloadedEntryPoint<TEntryPointComponent> = $ReadOnly<{|
   entryPoints: $PropertyType<
     React.ElementConfig<TEntryPointComponent>,
@@ -32,6 +35,7 @@ type PreloadedEntryPoint<TEntryPointComponent> = $ReadOnly<{|
   >,
   getComponent: () => TEntryPointComponent,
   queries: $PropertyType<React.ElementConfig<TEntryPointComponent>, 'queries'>,
+  rootModuleReference: JSResourceReference<TEntryPointComponent>,
 |}>;
 
 import type {
@@ -150,6 +154,8 @@ function prepareEntryPoint<
       return (component: TEntryPointComponent);
     },
     queries: (preloadedQueries: TPreloadedQueries),
+    // $FlowFixMe[incompatible-cast] - trust me Flow, its entryPoint component
+    rootModuleReference: (entryPoint.root: JSResourceReference<TEntryPointComponent>),
   };
 }
 
@@ -177,7 +183,13 @@ function LazyLoadEntryPointContainer_DEPRECATED<
   // *must* be computed first to fetch the component's data-dependencies in
   // parallel with the component itself (the code).
   const entryPointParamsHash = stableStringify(entryPointParams);
-  const {getComponent, queries, entryPoints, extraProps} = useMemo(() => {
+  const {
+    getComponent,
+    queries,
+    entryPoints,
+    extraProps,
+    rootModuleReference,
+  } = useMemo(() => {
     return prepareEntryPoint(
       environmentProvider ?? {
         getEnvironment: () => environment,
@@ -191,6 +203,15 @@ function LazyLoadEntryPointContainer_DEPRECATED<
   const Component = useMemo(() => {
     return getComponent();
   }, [getComponent]);
+
+  const profilerContext = useContext(ProfilerContext);
+  useEffect(() => {
+    environment.__log({
+      name: 'entrypoint.root.consume',
+      profilerContext,
+      rootModuleID: rootModuleReference.getModuleId(),
+    });
+  }, [environment, profilerContext, rootModuleReference]);
   return (
     <Component
       entryPoints={entryPoints}

packages/relay-experimental/__tests__/EntryPointContainer-test.js

@@ -77,6 +77,7 @@ let nestedEntryPointResource;
 class FakeJSResource<T> {
   _resolve: (T => mixed) | null;
   _resource: T | null;
+  getModuleId: () => string;
   getModuleIfRequired: () => T | null;
   load: () => Promise<T>;
   resolve: T => void;
@@ -85,6 +86,7 @@ class FakeJSResource<T> {
     this._resolve = null;
     this._resource = resource;
 
+    this.getModuleId = jest.fn(() => 'TheModuleID');
     this.getModuleIfRequired = jest.fn(() => this._resource);
     this.load = jest.fn(() => {
       return new Promise(resolve => {

packages/relay-experimental/__tests__/LazyLoadEntryPointContainer_DEEPRECATED-test.js

@@ -69,6 +69,7 @@ let params;
 class FakeJSResource<T> {
   _resolve: (T => mixed) | null;
   _resource: T | null;
+  getModuleId: () => string;
   getModuleIfRequired: () => T | null;
   load: () => Promise<T>;
   resolve: T => void;
@@ -77,6 +78,7 @@ class FakeJSResource<T> {
     this._resolve = null;
     this._resource = resource;
 
+    this.getModuleId = jest.fn(() => 'TheModuleID');
     this.getModuleIfRequired = jest.fn(() => this._resource);
     this.load = jest.fn(() => {
       return new Promise(resolve => {

packages/relay-experimental/loadEntryPoint.js

@@ -13,6 +13,7 @@
 
 const {loadQuery} = require('./loadQuery');
 
+import type {JSResourceReference} from 'JSResourceReference';
 import type {
   EntryPoint,
   EntryPointComponent,
@@ -132,6 +133,8 @@ function loadEntryPoint<
       return isDisposed;
     },
     queries: (preloadedQueries: TPreloadedQueries),
+    // $FlowFixMe[incompatible-cast] - trust me Flow, its entryPoint component
+    rootModuleReference: (entryPoint.root: JSResourceReference<TEntryPointComponent>),
   };
 }
 

packages/relay-runtime/store/RelayStoreTypes.js

@@ -489,6 +489,11 @@ export type LogEvent =
       +name: 'read.missing_required_field',
       +owner: string,
       +fieldPath: string,
+    |}
+  | {|
+      +name: 'entrypoint.root.consume',
+      +profilerContext: mixed,
+      +rootModuleID: string,
     |};
 
 export type LogFunction = LogEvent => void;