Pass "start time" and "commit time" to Profiler callback (facebook#12852)

bvaughn · web-flow · commit 13003654e79f · 2018-05-21T09:49:22.000-07:00
* Added start time parameter to Profiler onRender callback
* Profiler also captures commit time
* Only init Profiler stateNode if enableProfilerTimer feature flag enabled
diff --git a/packages/react-reconciler/src/ReactFiber.js b/packages/react-reconciler/src/ReactFiber.js
@@ -460,10 +460,13 @@ export function createFiberFromProfiler(
   const fiber = createFiber(Profiler, pendingProps, key, mode | ProfileMode);
   fiber.type = REACT_PROFILER_TYPE;
   fiber.expirationTime = expirationTime;
-  fiber.stateNode = {
-    duration: 0,
-    startTime: 0,
-  };
+  if (enableProfilerTimer) {
+    fiber.stateNode = {
+      elapsedPauseTimeAtStart: 0,
+      duration: 0,
+      startTime: 0,
+    };
+  }
 
   return fiber;
 }
diff --git a/packages/react-reconciler/src/ReactFiberCommitWork.js b/packages/react-reconciler/src/ReactFiberCommitWork.js
@@ -20,6 +20,7 @@ import type {ExpirationTime} from './ReactFiberExpirationTime';
 import type {CapturedValue, CapturedError} from './ReactCapturedValue';
 
 import {enableProfilerTimer} from 'shared/ReactFeatureFlags';
+import {getCommitTime} from './ReactProfilerTimer';
 import {
   ClassComponent,
   HostRoot,
@@ -807,6 +808,8 @@ function commitWork(current: Fiber | null, finishedWork: Fiber): void {
           current === null ? 'mount' : 'update',
           finishedWork.stateNode.duration,
           finishedWork.treeBaseTime,
+          finishedWork.stateNode.startTime,
+          getCommitTime(),
         );
 
         // Reset actualTime after successful commit.
diff --git a/packages/react-reconciler/src/ReactFiberScheduler.js b/packages/react-reconciler/src/ReactFiberScheduler.js
@@ -104,6 +104,7 @@ import {popHostContext, popHostContainer} from './ReactFiberHostContext';
 import {
   checkActualRenderTimeStackEmpty,
   pauseActualRenderTimerIfRunning,
+  recordCommitTime,
   recordElapsedBaseRenderTimeIfRunning,
   resetActualRenderTimer,
   resumeActualRenderTimerIfPaused,
@@ -566,6 +567,10 @@ function commitRoot(finishedWork: Fiber): ExpirationTime {
   }
   stopCommitSnapshotEffectsTimer();
 
+  if (enableProfilerTimer) {
+    recordCommitTime();
+  }
+
   // Commit all the side-effects within a tree. We'll do this in two passes.
   // The first pass performs all the host insertions, updates, deletions and
   // ref unmounts.
diff --git a/packages/react-reconciler/src/ReactProfilerTimer.js b/packages/react-reconciler/src/ReactProfilerTimer.js
@@ -14,25 +14,40 @@ import {enableProfilerTimer} from 'shared/ReactFeatureFlags';
 import warning from 'fbjs/lib/warning';
 import {now} from './ReactFiberHostConfig';
 
-/**
- * The "actual" render time is total time required to render the descendants of a Profiler component.
- * This time is stored as a stack, since Profilers can be nested.
- * This time is started during the "begin" phase and stopped during the "complete" phase.
- * It is paused (and accumulated) in the event of an interruption or an aborted render.
- */
-
 export type ProfilerTimer = {
   checkActualRenderTimeStackEmpty(): void,
+  getCommitTime(): number,
   markActualRenderTimeStarted(fiber: Fiber): void,
   pauseActualRenderTimerIfRunning(): void,
   recordElapsedActualRenderTime(fiber: Fiber): void,
   resetActualRenderTimer(): void,
   resumeActualRenderTimerIfPaused(): void,
+  recordCommitTime(): void,
   recordElapsedBaseRenderTimeIfRunning(fiber: Fiber): void,
   startBaseRenderTimer(): void,
   stopBaseRenderTimerIfRunning(): void,
 };
 
+let commitTime: number = 0;
+
+function getCommitTime(): number {
+  return commitTime;
+}
+
+function recordCommitTime(): void {
+  if (!enableProfilerTimer) {
+    return;
+  }
+  commitTime = now();
+}
+
+/**
+ * The "actual" render time is total time required to render the descendants of a Profiler component.
+ * This time is stored as a stack, since Profilers can be nested.
+ * This time is started during the "begin" phase and stopped during the "complete" phase.
+ * It is paused (and accumulated) in the event of an interruption or an aborted render.
+ */
+
 let fiberStack: Array<Fiber | null>;
 
 if (__DEV__) {
@@ -61,7 +76,9 @@ function markActualRenderTimeStarted(fiber: Fiber): void {
   if (__DEV__) {
     fiberStack.push(fiber);
   }
-  fiber.stateNode.startTime = now() - totalElapsedPauseTime;
+  const stateNode = fiber.stateNode;
+  stateNode.elapsedPauseTimeAtStart = totalElapsedPauseTime;
+  stateNode.startTime = now();
 }
 
 function pauseActualRenderTimerIfRunning(): void {
@@ -80,8 +97,11 @@ function recordElapsedActualRenderTime(fiber: Fiber): void {
   if (__DEV__) {
     warning(fiber === fiberStack.pop(), 'Unexpected Fiber popped.');
   }
-  fiber.stateNode.duration +=
-    now() - totalElapsedPauseTime - fiber.stateNode.startTime;
+  const stateNode = fiber.stateNode;
+  stateNode.duration +=
+    now() -
+    (totalElapsedPauseTime - stateNode.elapsedPauseTimeAtStart) -
+    stateNode.startTime;
 }
 
 function resetActualRenderTimer(): void {
@@ -145,8 +165,10 @@ function stopBaseRenderTimerIfRunning(): void {
 
 export {
   checkActualRenderTimeStackEmpty,
+  getCommitTime,
   markActualRenderTimeStarted,
   pauseActualRenderTimerIfRunning,
+  recordCommitTime,
   recordElapsedActualRenderTime,
   resetActualRenderTimer,
   resumeActualRenderTimerIfPaused,
diff --git a/packages/react/src/__tests__/ReactProfiler-test.internal.js b/packages/react/src/__tests__/ReactProfiler-test.internal.js
