Merge pull request #6046 from gaearon/new-perf

Add new ReactPerf (cherry picked from commit 98a8f49)
facebook · May 10, 2016 · 78aa706 · 78aa706
1 parent f50d542
commit 78aa706
Show file tree

Hide file tree

Showing 12 changed files with 792 additions and 39 deletions.
diff --git a/grunt/tasks/npm-react-addons.js b/grunt/tasks/npm-react-addons.js
@@ -16,7 +16,7 @@ var addons = {
     docs: 'two-way-binding-helpers',
   },
   Perf: {
-    module: 'ReactDefaultPerf',
+    module: 'ReactPerfAnalysis',
     name: 'perf',
     docs: 'perf',
   },

diff --git a/src/addons/ReactWithAddons.js b/src/addons/ReactWithAddons.js
@@ -34,7 +34,7 @@ React.addons = {
 };
 
 if (__DEV__) {
-  React.addons.Perf = require('ReactDefaultPerf');
+  React.addons.Perf = require('ReactPerfAnalysis');
   React.addons.TestUtils = require('ReactTestUtils');
 }
 

diff --git a/src/isomorphic/ReactDebugTool.js b/src/isomorphic/ReactDebugTool.js
@@ -11,7 +11,9 @@
 
 'use strict';
 
-var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
+var ExecutionEnvironment = require('ExecutionEnvironment');
+
+var performanceNow = require('performanceNow');
 var warning = require('warning');
 
 var eventHandlers = [];
@@ -37,6 +39,56 @@ function emitEvent(handlerFunctionName, arg1, arg2, arg3, arg4, arg5) {
   }
 }
 
+var isProfiling = false;
+var flushHistory = [];
+var currentFlushNesting = 0;
+var currentFlushMeasurements = null;
+var currentFlushStartTime = null;
+var currentTimerDebugID = null;
+var currentTimerStartTime = null;
+var currentTimerType = null;
+
+function resetMeasurements() {
+  if (__DEV__) {
+    if (!isProfiling || currentFlushNesting === 0) {
+      currentFlushStartTime = null;
+      currentFlushMeasurements = null;
+      return;
+    }
+
+    var previousStartTime = currentFlushStartTime;
+    var previousMeasurements = currentFlushMeasurements || [];
+    var previousOperations = ReactNativeOperationHistoryDevtool.getHistory();
+
+    if (previousMeasurements.length || previousOperations.length) {
+      var registeredIDs = ReactComponentTreeDevtool.getRegisteredIDs();
+      flushHistory.push({
+        duration: performanceNow() - previousStartTime,
+        measurements: previousMeasurements || [],
+        operations: previousOperations || [],
+        treeSnapshot: registeredIDs.reduce((tree, id) => {
+          var ownerID = ReactComponentTreeDevtool.getOwnerID(id);
+          var parentID = ReactComponentTreeDevtool.getParentID(id);
+          tree[id] = {
+            displayName: ReactComponentTreeDevtool.getDisplayName(id),
+            text: ReactComponentTreeDevtool.getText(id),
+            childIDs: ReactComponentTreeDevtool.getChildIDs(id),
+            // Text nodes don't have owners but this is close enough.
+            ownerID: ownerID || ReactComponentTreeDevtool.getOwnerID(parentID),
+            parentID,
+          };
+          return tree;
+        }, {}),
+      });
+    }
+
+    currentFlushStartTime = performanceNow();
+    currentFlushMeasurements = [];
+    ReactComponentTreeDevtool.purgeUnmountedComponents();
+    ReactNativeOperationHistoryDevtool.clearHistory();
+  }
+}
+
 var ReactDebugTool = {
   addDevtool(devtool) {
     eventHandlers.push(devtool);
@@ -49,6 +101,95 @@ var ReactDebugTool = {
       }
     }
   },
+  beginProfiling() {
+    if (__DEV__) {
+      if (isProfiling) {
+        return;
+      }
+
+      isProfiling = true;
+      flushHistory.length = 0;
+      resetMeasurements();
+    }
+  },
+  endProfiling() {
+    if (__DEV__) {
+      if (!isProfiling) {
+        return;
+      }
+
+      isProfiling = false;
+      resetMeasurements();
+    }
+  },
+  getFlushHistory() {
+    if (__DEV__) {
+      return flushHistory;
+    }
+  },
+  onBeginFlush() {
+    if (__DEV__) {
+      currentFlushNesting++;
+      resetMeasurements();
+    }
+    emitEvent('onBeginFlush');
+  },
+  onEndFlush() {
+    if (__DEV__) {
+      resetMeasurements();
+      currentFlushNesting--;
+    }
+    emitEvent('onEndFlush');
+  },
+  onBeginLifeCycleTimer(debugID, timerType) {
+    emitEvent('onBeginLifeCycleTimer', debugID, timerType);
+    if (__DEV__) {
+      if (isProfiling) {
+        warning(
+          !currentTimerType,
+          'There is an internal error in the React performance measurement code. ' +
+          'Did not expect %s timer to start while %s timer is still in ' +
+          'progress for %s instance.',
+          timerType,
+          currentTimerType || 'no',
+          (debugID === currentTimerDebugID) ? 'the same' : 'another'
+        );
+        currentTimerStartTime = performanceNow();
+        currentTimerDebugID = debugID;
+        currentTimerType = timerType;
+      }
+    }
+  },
+  onEndLifeCycleTimer(debugID, timerType) {
+    if (__DEV__) {
+      if (isProfiling) {
+        warning(
+          currentTimerType === timerType,
+          'There is an internal error in the React performance measurement code. ' +
+          'We did not expect %s timer to stop while %s timer is still in ' +
+          'progress for %s instance. Please report this as a bug in React.',
+          timerType,
+          currentTimerType || 'no',
+          (debugID === currentTimerDebugID) ? 'the same' : 'another'
+        );
+        currentFlushMeasurements.push({
+          timerType,
+          instanceID: debugID,
+          duration: performance.now() - currentTimerStartTime,
+        });
+        currentTimerStartTime = null;
+        currentTimerDebugID = null;
+        currentTimerType = null;
+      }
+    }
+    emitEvent('onEndLifeCycleTimer', debugID, timerType);
+  },
+  onBeginReconcilerTimer(debugID, timerType) {
+    emitEvent('onBeginReconcilerTimer', debugID, timerType);
+  },
+  onEndReconcilerTimer(debugID, timerType) {
+    emitEvent('onEndReconcilerTimer', debugID, timerType);
+  },
   onBeginProcessingChildContext() {
     emitEvent('onBeginProcessingChildContext');
   },
@@ -87,6 +228,17 @@ var ReactDebugTool = {
   },
 };
 
-ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
+if (__DEV__) {
+  var ReactInvalidSetStateWarningDevTool = require('ReactInvalidSetStateWarningDevTool');
+  var ReactNativeOperationHistoryDevtool = require('ReactNativeOperationHistoryDevtool');
+  var ReactComponentTreeDevtool = require('ReactComponentTreeDevtool');
+  ReactDebugTool.addDevtool(ReactInvalidSetStateWarningDevTool);
+  ReactDebugTool.addDevtool(ReactComponentTreeDevtool);
+  ReactDebugTool.addDevtool(ReactNativeOperationHistoryDevtool);
+  var url = (ExecutionEnvironment.canUseDOM && window.location.href) || '';
+  if ((/[?&]react_perf\b/).test(url)) {
+    ReactDebugTool.beginProfiling();
+  }
+}
 
 module.exports = ReactDebugTool;