[Mac] UMA Metrics for the Default Touch Bar

chrome/browser/ui/cocoa/browser_window_touch_bar.mm

 // Copyright 2017 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "chrome/browser/ui/cocoa/browser_window_touch_bar.h"
 
 #include "base/mac/mac_util.h"
 #import "base/mac/scoped_nsobject.h"
 #import "base/mac/sdk_forward_declarations.h"
+#include "base/metrics/histogram_macros.h"
 #include "base/strings/sys_string_conversions.h"
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/app/vector_icons/vector_icons.h"
 #include "chrome/browser/command_updater.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_command_controller.h"
 #include "chrome/common/chrome_features.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/omnibox/browser/vector_icons.h"
 #include "components/search_engines/util.h"
 #include "components/toolbar/vector_icons.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/gfx/color_palette.h"
 #include "ui/gfx/color_utils.h"
 #include "ui/gfx/image/image.h"
 #include "ui/gfx/image/image_skia_util_mac.h"
 #include "ui/gfx/paint_vector_icon.h"
 #include "ui/gfx/vector_icons_public.h"
 #include "ui/vector_icons/vector_icons.h"
 
 namespace {
 
+// The touch bar actions that are being recorded in a histogram. These values
+// should not be re-ordered or removed.
+enum TouchBarAction {
+  BACK = 0,
+  FORWARD,
+  STOP,
+  RELOAD,
+  SEARCH,
+  STAR,
+  NEW_TAB,
+  TOUCH_BAR_ACTION_COUNT
+};
+
 // The touch bar's identifier.
 const NSTouchBarCustomizationIdentifier kBrowserWindowTouchBarId =
     @"BrowserWindowTouchBarId";
 
 // Touch bar items identifiers.
 const NSTouchBarItemIdentifier kBackForwardTouchId = @"BackForwardTouchId";
 const NSTouchBarItemIdentifier kReloadOrStopTouchId = @"ReloadOrStopTouchId";
 const NSTouchBarItemIdentifier kSearchTouchId = @"SearchTouchId";
 const NSTouchBarItemIdentifier kStarTouchId = @"StarTouchId";
 const NSTouchBarItemIdentifier kNewTabTouchId = @"NewTabTouchId";
@@ skipping 26 matching lines @@
                                int command,
                                SkColor color = kTouchBarDefaultIconColor) {
   NSButton* button =
       [NSButton buttonWithImage:CreateNSImageFromIcon(icon, color)
                          target:owner
                          action:@selector(executeCommand:)];
   button.tag = command;
   return button;
 }
 
+// Logs the sample's UMA metrics into the DefaultTouchBar.Metrics histogram.
+void LogTouchBarUMA(int command) {
+  TouchBarAction action;
+  if (command == IDC_BACK)
+    action = TouchBarAction::BACK;
+  else if (command == IDC_FORWARD)
+    action = TouchBarAction::FORWARD;
+  else if (command == IDC_STOP)
+    action = TouchBarAction::STOP;
+  else if (command == IDC_RELOAD)
+    action = TouchBarAction::RELOAD;
+  else if (command == IDC_FOCUS_LOCATION)
+    action = TouchBarAction::SEARCH;
+  else if (command == IDC_BOOKMARK_PAGE)
+    action = TouchBarAction::STAR;
+  else if (command == IDC_NEW_TAB)
+    action = TouchBarAction::NEW_TAB;
+  else
+    action = TouchBarAction::TOUCH_BAR_ACTION_COUNT;
+
+  DCHECK_NE(action, TouchBarAction::TOUCH_BAR_ACTION_COUNT);
+  UMA_HISTOGRAM_ENUMERATION("DefaultTouchBar.Metrics", action,

[Robert Sesek, 2017/03/09 18:11:55]

Since we may have multiple touch bars, how about something like:

TouchBar.Default.Metrics or OSX.TouchBar.Metrics ?

[Ilya Sherman, 2017/03/09 20:13:44]

+1 -- let's choose a fairly general top-level category.  Either of Robert's
suggestions seems reasonable.

[spqchan, 2017/03/13 20:58:05]

Sure thing

+                            TOUCH_BAR_ACTION_COUNT);
+}
+
 }  // namespace
 
 @interface BrowserWindowTouchBar () {
   // Used to execute commands such as navigating back and forward.
   CommandUpdater* commandUpdater_;  // Weak, owned by Browser.
 
   // The browser associated with the touch bar.
   Browser* browser_;  // Weak.
 }
 
@@ skipping 119 matching lines @@
   searchButton.imageHugsTitle = YES;
   searchButton.tag = IDC_FOCUS_LOCATION;
   [searchButton.widthAnchor
       constraintEqualToConstant:kTouchBarSearchButtonWidth]
       .active = YES;
   return searchButton;
 }
 
 - (void)backOrForward:(id)sender {
   NSSegmentedControl* control = sender;
-  if ([control selectedSegment] == kBackSegmentIndex)
+  if ([control selectedSegment] == kBackSegmentIndex) {
     commandUpdater_->ExecuteCommand(IDC_BACK);
-  else
+    LogTouchBarUMA(IDC_BACK);
+  } else {
     commandUpdater_->ExecuteCommand(IDC_FORWARD);
+    LogTouchBarUMA(IDC_FORWARD);
+  }
 }
 
 - (void)executeCommand:(id)sender {
-  commandUpdater_->ExecuteCommand([sender tag]);
+  int command = [sender tag];
+  LogTouchBarUMA(command);

[Robert Sesek, 2017/03/09 18:11:55]

In -backOrForward, the UMA is logged before the ExecuteCommand call, and here
it's done after. Does the order matter? (IIRC, ExecuteCommand also records an
UMA). Regardless, the order should probably match.

[spqchan, 2017/03/13 20:58:05]

Done.

+  commandUpdater_->ExecuteCommand(command);
 }
 
 @end