Add a mechanism to change the summary strategy and store it in the UR…

…L (PR firefox-devtools#2156)

src/actions/profile-view.js

@@ -40,6 +40,7 @@ import { objectShallowEquals } from '../utils/index';
 import type {
   PreviewSelection,
   ImplementationFilter,
+  CallTreeSummaryStrategy,
   TrackReference,
   TimelineType,
   DataSource,
@@ -939,6 +940,27 @@ export function changeImplementationFilter(
   };
 }
 
+/**
+ * This action changes the strategy used to build and display the call tree. This could
+ * use sample data, or build a new call tree based off of allocation information stored
+ * in markers.
+ */
+export function changeCallTreeSummaryStrategy(
+  strategy: CallTreeSummaryStrategy
+): Action {
+  sendAnalytics({
+    hitType: 'event',
+    eventCategory: 'profile',
+    eventAction: 'change call tree summary strategy',
+    eventLabel: strategy,
+  });
+
+  return {
+    type: 'CHANGE_CALL_TREE_SUMMARY_STRATEGY',
+    strategy,
+  };
+}
+
 export function changeInvertCallstack(
   invertCallstack: boolean
 ): ThunkAction<void> {

src/app-logic/url-handling.js

@@ -17,6 +17,7 @@ import {
   toValidTabSlug,
   ensureExists,
 } from '../utils/flow';
+import { toValidCallTreeSummaryStrategy } from '../profile-logic/profile-data';
 import { oneLine } from 'common-tags';
 import type { UrlState } from '../types/state';
 import type { DataSource } from '../types/actions';
@@ -105,6 +106,7 @@ type CallTreeQuery = {|
   search: string, // "js::RunScript"
   invertCallstack: null | void,
   implementation: string,
+  ctSummary: string,
 |};
 
 type MarkersQuery = {|
@@ -122,6 +124,7 @@ type StackChartQuery = {|
   search: string, // "js::RunScript"
   invertCallstack: null | void,
   implementation: string,
+  ctSummary: string,
 |};
 
 type JsTracerQuery = {|
@@ -242,6 +245,10 @@ export function urlStateToUrlObject(urlState: UrlState): UrlObject {
             urlState.profileSpecific.transforms[selectedThread]
           ) || undefined;
       }
+      query.ctSummary =
+        urlState.profileSpecific.callTreeSummaryStrategy === 'timing'
+          ? undefined
+          : urlState.profileSpecific.callTreeSummaryStrategy;
       break;
     }
     case 'marker-table':
@@ -359,6 +366,7 @@ export function stateFromLocation(
     profileName: query.profileName,
     profileSpecific: {
       implementation,
+      callTreeSummaryStrategy: toValidCallTreeSummaryStrategy(query.ctSummary),
       invertCallstack: query.invertCallstack !== undefined,
       showJsTracerSummary: query.summary !== undefined,
       committedRanges: query.range ? parseCommittedRanges(query.range) : [],

src/profile-logic/profile-data.js

@@ -35,7 +35,10 @@ import { assertExhaustiveCheck } from '../utils/flow';
 import type { Milliseconds, StartEndRange } from '../types/units';
 import { timeCode } from '../utils/time-code';
 import { hashPath } from '../utils/path';
-import type { ImplementationFilter } from '../types/actions';
+import type {
+  ImplementationFilter,
+  CallTreeSummaryStrategy,
+} from '../types/actions';
 import bisection from 'bisection';
 import type { UniqueStringArray } from '../utils/unique-string-array';
 
@@ -685,6 +688,24 @@ export function toValidImplementationFilter(
   }
 }
 
+export function toValidCallTreeSummaryStrategy(
+  strategy: mixed
+): CallTreeSummaryStrategy {
+  switch (strategy) {
+    case 'timing':
+    case 'js-allocations':
+    case 'native-allocations':
+      return strategy;
+    default:
+      // Default to "timing" if the strategy is not recognized. This value can come
+      // from a user-generated URL.
+      // e.g. `profiler.firefox.com/public/hash/ctSummary=tiiming` (note the typo.)
+      // This default branch will ensure we don't send values we don't understand to
+      // the store.
+      return 'timing';
+  }
+}
+
 export function filterThreadByImplementation(
   thread: Thread,
   implementation: string,

src/reducers/url-state.js

@@ -14,6 +14,7 @@ import type { TransformStacksPerThread } from '../types/transforms';
 import type {
   DataSource,
   ImplementationFilter,
+  CallTreeSummaryStrategy,
   TimelineType,
 } from '../types/actions';
 import type { UrlState, Reducer } from '../types/state';
@@ -228,6 +229,22 @@ const implementation: Reducer<ImplementationFilter> = (
   }
 };
 
+/**
+ * Represents the current strategy used to summarize numeric information in the call
+ * call tree.
+ */
+const callTreeSummaryStrategy: Reducer<CallTreeSummaryStrategy> = (
+  state = 'timing',
+  action
+) => {
+  switch (action.type) {
+    case 'CHANGE_CALL_TREE_SUMMARY_STRATEGY':
+      return action.strategy;
+    default:
+      return state;
+  }
+};
+
 const invertCallstack: Reducer<boolean> = (state = false, action) => {
   switch (action.type) {
     case 'CHANGE_INVERT_CALLSTACK':
@@ -381,6 +398,7 @@ const profileSpecific = combineReducers({
   hiddenLocalTracksByPid,
   localTrackOrderByPid,
   implementation,
+  callTreeSummaryStrategy,
   invertCallstack,
   showJsTracerSummary,
   committedRanges,

src/selectors/url-state.js

@@ -16,6 +16,7 @@ import type {
   TimelineType,
   DataSource,
   ImplementationFilter,
+  CallTreeSummaryStrategy,
 } from '../types/actions';
 import type { TabSlug } from '../app-logic/tabs-handling';
 import type { UrlState } from '../types/state';
@@ -45,6 +46,8 @@ export const getAllCommittedRanges: Selector<StartEndRange[]> = state =>
   getProfileSpecificState(state).committedRanges;
 export const getImplementationFilter: Selector<ImplementationFilter> = state =>
   getProfileSpecificState(state).implementation;
+export const getCallTreeSummaryStrategy: Selector<CallTreeSummaryStrategy> = state =>
+  getProfileSpecificState(state).callTreeSummaryStrategy;
 export const getInvertCallstack: Selector<boolean> = state =>
   getProfileSpecificState(state).invertCallstack;
 export const getShowJsTracerSummary: Selector<boolean> = state =>

src/test/store/profile-view.test.js

@@ -1544,3 +1544,16 @@ describe('counter selectors', function() {
     });
   });
 });
+
+describe('call tree summary strategy', function() {
+  it('can change the call tree strategy', function() {
+    const { dispatch, getState } = storeWithProfile();
+    expect(UrlStateSelectors.getCallTreeSummaryStrategy(getState())).toEqual(
+      'timing'
+    );
+    dispatch(ProfileView.changeCallTreeSummaryStrategy('js-allocations'));
+    expect(UrlStateSelectors.getCallTreeSummaryStrategy(getState())).toEqual(
+      'js-allocations'
+    );
+  });
+});

src/test/url-handling.test.js

@@ -843,3 +843,35 @@ describe('compare', function() {
     expect(resultingUrl).toMatch(`profiles[]=${encodeURIComponent(url2)}`);
   });
 });
+
+describe('call tree summary strategy', function() {
+  const { getCallTreeSummaryStrategy } = urlStateReducers;
+
+  it('defaults to timing', function() {
+    const { getState } = _getStoreWithURL();
+    expect(getCallTreeSummaryStrategy(getState())).toEqual('timing');
+  });
+
+  it('can be js allocations', function() {
+    const { getState } = _getStoreWithURL({
+      search: '?ctSummary=js-allocations',
+    });
+    expect(getCallTreeSummaryStrategy(getState())).toEqual('js-allocations');
+  });
+
+  it('can be native allocations', function() {
+    const { getState } = _getStoreWithURL({
+      search: '?ctSummary=native-allocations',
+    });
+    expect(getCallTreeSummaryStrategy(getState())).toEqual(
+      'native-allocations'
+    );
+  });
+
+  it('will use the default "timing" when an unknown value is received', function() {
+    const { getState } = _getStoreWithURL({
+      search: '?ctSummary=unknown-value',
+    });
+    expect(getCallTreeSummaryStrategy(getState())).toEqual('timing');
+  });
+});

src/types/actions.js

@@ -82,6 +82,11 @@ export type RequestedLib = {|
   +breakpadId: string,
 |};
 export type ImplementationFilter = 'combined' | 'js' | 'cpp';
+// Change the strategy for computing the summarizing information for the call tree.
+export type CallTreeSummaryStrategy =
+  | 'timing'
+  | 'js-allocations'
+  | 'native-allocations';
 
 /**
  * This type determines what kind of information gets sanitized from published profiles.
@@ -306,6 +311,10 @@ type UrlStateAction =
       +previousImplementation: ImplementationFilter,
       +implementation: ImplementationFilter,
     |}
+  | {|
+      type: 'CHANGE_CALL_TREE_SUMMARY_STRATEGY',
+      strategy: CallTreeSummaryStrategy,
+    |}
   | {|
       +type: 'CHANGE_INVERT_CALLSTACK',
       +invertCallstack: boolean,

src/types/state.js

@@ -9,6 +9,7 @@ import type {
   DataSource,
   PreviewSelection,
   ImplementationFilter,
+  CallTreeSummaryStrategy,
   RequestedLib,
   TrackReference,
   TimelineType,
@@ -173,6 +174,7 @@ export type UrlState = {|
     hiddenLocalTracksByPid: Map<Pid, Set<TrackIndex>>,
     localTrackOrderByPid: Map<Pid, TrackIndex[]>,
     implementation: ImplementationFilter,
+    callTreeSummaryStrategy: CallTreeSummaryStrategy,
     invertCallstack: boolean,
     showJsTracerSummary: boolean,
     committedRanges: StartEndRange[],