Cleaned up event and method names

Author: Brian Vaughn

packages/react-devtools-shared/src/backend/agent.js

@@ -23,7 +23,7 @@ import {
 import setupHighlighter from './views/Highlighter';
 import {
   initialize as setupTraceUpdates,
-  toggleEnabled as toggleTraceUpdatesEnabled,
+  toggleEnabled as setTraceUpdatesEnabled,
 } from './views/TraceUpdates';
 import {patch as patchConsole, unpatch as unpatchConsole} from './console';
 
@@ -126,6 +126,7 @@ export default class Agent extends EventEmitter<{|
 
     this._bridge = bridge;
 
+    bridge.addListener('enableTraceUpdates', this.enableTraceUpdates);
     bridge.addListener('getProfilingData', this.getProfilingData);
     bridge.addListener('getProfilingStatus', this.getProfilingStatus);
     bridge.addListener('getOwnersList', this.getOwnersList);
@@ -149,7 +150,6 @@ export default class Agent extends EventEmitter<{|
       this.updateAppendComponentStack,
     );
     bridge.addListener('updateComponentFilters', this.updateComponentFilters);
-    bridge.addListener('updateTraceUpdates', this.updateTraceUpdates);
     bridge.addListener('viewElementSource', this.viewElementSource);
 
     if (this._isProfiling) {
@@ -204,6 +204,19 @@ export default class Agent extends EventEmitter<{|
     return null;
   }
 
+  enableTraceUpdates = (isEnabled: boolean) => {
+    this._traceUpdatesEnabled = isEnabled;
+
+    setTraceUpdatesEnabled(isEnabled);
+
+    for (let rendererID in this._rendererInterfaces) {
+      const renderer = ((this._rendererInterfaces[
+        (rendererID: any)
+      ]: any): RendererInterface);
+      renderer.setTraceUpdatesEnabled(isEnabled);
+    }
+  };
+
   getProfilingData = ({rendererID}: {|rendererID: RendererID|}) => {
     const renderer = this._rendererInterfaces[rendererID];
     if (renderer == null) {
@@ -348,7 +361,7 @@ export default class Agent extends EventEmitter<{|
       rendererInterface.startProfiling(this._recordChangeDescriptions);
     }
 
-    rendererInterface.toggleTraceUpdatesEnabled(this._traceUpdatesEnabled);
+    rendererInterface.setTraceUpdatesEnabled(this._traceUpdatesEnabled);
 
     // When the renderer is attached, we need to tell it whether
     // we remember the previous selection that we'd like to restore.
@@ -417,19 +430,6 @@ export default class Agent extends EventEmitter<{|
     }
   };
 
-  updateTraceUpdates = (isEnabled: boolean) => {
-    this._traceUpdatesEnabled = isEnabled;
-
-    toggleTraceUpdatesEnabled(isEnabled);
-
-    for (let rendererID in this._rendererInterfaces) {
-      const renderer = ((this._rendererInterfaces[
-        (rendererID: any)
-      ]: any): RendererInterface);
-      renderer.toggleTraceUpdatesEnabled(isEnabled);
-    }
-  };
-
   viewElementSource = ({id, rendererID}: ElementAndRendererID) => {
     const renderer = this._rendererInterfaces[rendererID];
     if (renderer == null) {

packages/react-devtools-shared/src/backend/legacy/renderer.js

@@ -912,7 +912,7 @@ export function attach(
     // Not implemented.
   }
 
-  function toggleTraceUpdatesEnabled(enabled: boolean) {
+  function setTraceUpdatesEnabled(enabled: boolean) {
     // Not implemented.
   }
 
@@ -949,10 +949,10 @@ export function attach(
     setInHook,
     setInProps,
     setInState,
+    setTraceUpdatesEnabled,
     setTrackedPath,
     startProfiling,
     stopProfiling,
     updateComponentFilters,
-    toggleTraceUpdatesEnabled,
   };
 }

packages/react-devtools-shared/src/backend/renderer.js

@@ -3104,7 +3104,7 @@ export function attach(
     }
   };
 
-  function toggleTraceUpdatesEnabled(isEnabled: boolean): void {
+  function setTraceUpdatesEnabled(isEnabled: boolean): void {
     traceUpdatesEnabled = isEnabled;
   }
 
@@ -3129,10 +3129,10 @@ export function attach(
     setInHook,
     setInProps,
     setInState,
+    setTraceUpdatesEnabled,
     setTrackedPath,
     startProfiling,
     stopProfiling,
     updateComponentFilters,
-    toggleTraceUpdatesEnabled,
   };
 }

packages/react-devtools-shared/src/backend/types.js

@@ -252,11 +252,11 @@ export type RendererInterface = {
   ) => void,
   setInProps: (id: number, path: Array<string | number>, value: any) => void,
   setInState: (id: number, path: Array<string | number>, value: any) => void,
+  setTraceUpdatesEnabled: (enabled: boolean) => void,
   setTrackedPath: (path: Array<PathFrame> | null) => void,
   startProfiling: (recordChangeDescriptions: boolean) => void,
   stopProfiling: () => void,
   updateComponentFilters: (componentFilters: Array<ComponentFilter>) => void,
-  toggleTraceUpdatesEnabled: (enabled: boolean) => void,
 };
 
 export type Handler = (data: any) => void;

packages/react-devtools-shared/src/bridge.js

@@ -94,6 +94,7 @@ type BackendEvents = {|
 
 type FrontendEvents = {|
   clearNativeElementHighlight: [],
+  enableTraceUpdates: [boolean],
   getOwnersList: [ElementAndRendererID],
   getProfilingData: [{|rendererID: RendererID|}],
   getProfilingStatus: [],
@@ -115,7 +116,6 @@ type FrontendEvents = {|
   stopProfiling: [],
   updateAppendComponentStack: [boolean],
   updateComponentFilters: [Array<ComponentFilter>],
-  updateTraceUpdates: [boolean],
   viewElementSource: [ElementAndRendererID],
 
   // React Native style editor plug-in.

packages/react-devtools-shared/src/devtools/views/Settings/GeneralSettings.js

@@ -18,12 +18,12 @@ export default function GeneralSettings(_: {||}) {
   const {
     appendComponentStack,
     displayDensity,
-    traceUpdates,
     setAppendComponentStack,
-    setTraceUpdates,
     setDisplayDensity,
     setTheme,
+    setTraceUpdatesEnabled,
     theme,
+    traceUpdatesEnabled,
   } = useContext(SettingsContext);
 
   const {supportsTraceUpdates} = useContext(StoreContext);
@@ -60,9 +60,9 @@ export default function GeneralSettings(_: {||}) {
           <label>
             <input
               type="checkbox"
-              checked={traceUpdates}
+              checked={traceUpdatesEnabled}
               onChange={({currentTarget}) =>
-                setTraceUpdates(currentTarget.checked)
+                setTraceUpdatesEnabled(currentTarget.checked)
               }
             />{' '}
             Highlight updates when components render.

packages/react-devtools-shared/src/devtools/views/Settings/SettingsContext.js

@@ -41,8 +41,8 @@ type Context = {|
   theme: Theme,
   setTheme(value: Theme): void,
 
-  traceUpdates: boolean,
-  setTraceUpdates: (value: boolean) => void,
+  traceUpdatesEnabled: boolean,
+  setTraceUpdatesEnabled: (value: boolean) => void,
 |};
 
 const SettingsContext = createContext<Context>(((null: any): Context));
@@ -76,10 +76,9 @@ function SettingsContextController({
   const [appendComponentStack, setAppendComponentStack] = useLocalStorage<
     boolean,
   >(LOCAL_STORAGE_SHOULD_PATCH_CONSOLE_KEY, true);
-  const [traceUpdates, setTraceUpdates] = useLocalStorage<boolean>(
-    'React::DevTools::traceUpdates',
-    false,
-  );
+  const [traceUpdatesEnabled, setTraceUpdatesEnabled] = useLocalStorage<
+    boolean,
+  >('React::DevTools::traceUpdatesEnabled', false);
 
   const documentElements = useMemo<DocumentElements>(
     () => {
@@ -147,35 +146,35 @@ function SettingsContextController({
 
   useEffect(
     () => {
-      bridge.send('updateTraceUpdates', traceUpdates);
+      bridge.send('enableTraceUpdates', traceUpdatesEnabled);
     },
-    [bridge, traceUpdates],
+    [bridge, traceUpdatesEnabled],
   );
 
   const value = useMemo(
     () => ({
-      displayDensity,
-      setDisplayDensity,
-      theme,
-      setTheme,
       appendComponentStack,
-      setAppendComponentStack,
-      traceUpdates,
-      setTraceUpdates,
+      displayDensity,
       lineHeight:
         displayDensity === 'compact'
           ? COMPACT_LINE_HEIGHT
           : COMFORTABLE_LINE_HEIGHT,
+      setAppendComponentStack,
+      setDisplayDensity,
+      setTheme,
+      setTraceUpdatesEnabled,
+      theme,
+      traceUpdatesEnabled,
     }),
     [
+      appendComponentStack,
       displayDensity,
+      setAppendComponentStack,
       setDisplayDensity,
       setTheme,
-      appendComponentStack,
-      setAppendComponentStack,
-      traceUpdates,
-      setTraceUpdates,
+      setTraceUpdatesEnabled,
       theme,
+      traceUpdatesEnabled,
     ],
   );