From 7f916f8a7b318c0b5dd18c0930486ad8c78f030f Mon Sep 17 00:00:00 2001
From: Michel Weststrate <mweststrate@fb.com>
Date: Thu, 5 Dec 2019 09:29:15 -0800
Subject: [PATCH] Gather plugin stats to improve performance

Summary: This diff makes it possible to gather stats of plugin usage, and print them from the console by issuing `window.flipperPrintPluginBackgroundStats()`.

Reviewed By: jknoxville

Differential Revision: D18811590

fbshipit-source-id: 4219923f7fd90187c7ec50a9aa68d7b817e3db8f
---
 src/Client.tsx | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/src/Client.tsx b/src/Client.tsx
index 2dfce3c38..663a74bee 100644
--- a/src/Client.tsx
+++ b/src/Client.tsx
@@ -24,6 +24,48 @@ import createTableNativePlugin from './plugins/TableNativePlugin';
 import EventEmitter from 'events';
 import invariant from 'invariant';
 
+const MAX_BACKGROUND_TASK_TIME = 25;
+
+const pluginBackgroundStats = new Map<
+  string,
+  {
+    cpuTime: number; // Total time spend in persisted Reducer
+    messages: number; // amount of message received for this plugin
+    maxTime: number; // maximum time spend in a single reducer call
+  }
+>();
+
+if (window) {
+  // @ts-ignore
+  window.flipperPrintPluginBackgroundStats = () => {
+    console.table(
+      Array.from(pluginBackgroundStats.entries()).map(
+        ([plugin, {cpuTime, messages, maxTime}]) => ({
+          plugin,
+          cpuTime,
+          messages,
+          maxTime,
+        }),
+      ),
+    );
+  };
+}
+
+function addBackgroundStat(plugin: string, cpuTime: number) {
+  if (!pluginBackgroundStats.has(plugin)) {
+    pluginBackgroundStats.set(plugin, {cpuTime: 0, messages: 0, maxTime: 0});
+  }
+  const stat = pluginBackgroundStats.get(plugin)!;
+  stat.cpuTime += cpuTime;
+  stat.messages += 1;
+  stat.maxTime = Math.max(stat.maxTime, cpuTime);
+  if (cpuTime > MAX_BACKGROUND_TASK_TIME) {
+    console.warn(
+      `Plugin ${plugin} took too much time while doing background: ${cpuTime}ms. Handling background messages should take less than ${MAX_BACKGROUND_TASK_TIME}ms.`,
+    );
+  }
+}
+
 type Plugins = Array<string>;
 
 export type ClientQuery = {
@@ -333,6 +375,7 @@ export default class Client extends EventEmitter {
         const params: Params = data.params as Params;
         invariant(params, 'expected params');
 
+        const statName = `${params.api}.${params.method}`;
         const persistingPlugin:
           | typeof FlipperPlugin
           | typeof FlipperDevicePlugin
@@ -351,11 +394,13 @@ export default class Client extends EventEmitter {
             ...persistingPlugin.defaultPersistedState,
             ...this.store.getState().pluginStates[pluginKey],
           };
+          const reducerStartTime = Date.now();
           const newPluginState = persistingPlugin.persistedStateReducer(
             persistedState,
             params.method,
             params.params,
           );
+          addBackgroundStat(statName, Date.now() - reducerStartTime);
           if (persistedState !== newPluginState) {
             this.store.dispatch(
               setPluginState({