Add UMA stats for pen palette

ash/common/system/chromeos/palette/palette_tray.cc

 // Copyright 2016 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.
 
 #include "ash/common/system/chromeos/palette/palette_tray.h"
 
 #include "ash/common/shelf/shelf_constants.h"
 #include "ash/common/shelf/wm_shelf.h"
 #include "ash/common/shelf/wm_shelf_util.h"
 #include "ash/common/shell_window_ids.h"
 #include "ash/common/system/chromeos/palette/palette_tool_manager.h"
 #include "ash/common/system/chromeos/palette/palette_utils.h"
 #include "ash/common/system/tray/system_tray_delegate.h"
 #include "ash/common/system/tray/tray_bubble_wrapper.h"
 #include "ash/common/system/tray/tray_constants.h"
 #include "ash/common/system/tray/tray_popup_header_button.h"
 #include "ash/common/wm_lookup.h"
 #include "ash/common/wm_root_window_controller.h"
 #include "ash/common/wm_shell.h"
 #include "ash/common/wm_window.h"
+#include "base/metrics/histogram.h"

[Ilya Sherman, 2016/09/02 21:39:30]

nit: histogram_macros

[xiaoyinh(OOO Sep 11-29), 2016/09/06 17:40:05]

Done.

 #include "grit/ash_resources.h"
 #include "grit/ash_strings.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/events/devices/stylus_state.h"
 #include "ui/gfx/color_palette.h"
 #include "ui/gfx/paint_vector_icon.h"
 #include "ui/gfx/vector_icons_public.h"
 #include "ui/views/controls/image_view.h"
 #include "ui/views/controls/label.h"
@@ skipping 70 matching lines @@
         l10n_util::GetStringUTF16(IDS_ASH_STATUS_TRAY_SETTINGS));
     AddChildView(settings_button_);
   }
 
   ~TitleView() override {}
 
  private:
   // views::ButtonListener:
   void ButtonPressed(views::Button* sender, const ui::Event& event) override {
     if (sender == settings_button_) {
+      palette_tray_->RecordPaletteMetrics(
+          ash::PaletteTrayOptions::PALETTE_SETTINGS_BUTTON);
       WmShell::Get()->system_tray_delegate()->ShowPaletteSettings();

[jdufault, 2016/09/02 21:54:30]

ShowPaletteSettings should already be recording a metric ("ShowPaletteOptions"
to be precise).

[xiaoyinh(OOO Sep 11-29), 2016/09/06 17:40:05]

Should I remove mine if that's case? It might still be useful as
"ShowPaletteOptions" is recorded as user-action, and here we can compare 
PALETTE_SETTINGS_BUTTON with all other options side by side?

       palette_tray_->HidePalette();
     } else if (sender == help_button_) {
+      palette_tray_->RecordPaletteMetrics(
+          ash::PaletteTrayOptions::PALETTE_HELP_BUTTON);
       WmShell::Get()->system_tray_delegate()->ShowPaletteHelp();
       palette_tray_->HidePalette();
     } else {
       NOTREACHED();
     }
   }
 
   // Unowned pointers to button views so we can determine which button was
   // clicked.
   ash::TrayPopupHeaderButton* settings_button_;
@@ skipping 42 matching lines @@
 PaletteTray::~PaletteTray() {
   if (bubble_)
     bubble_->bubble_view()->reset_delegate();
 
   WmShell::Get()->RemoveShellObserver(this);
   WmShell::Get()->GetSessionStateDelegate()->RemoveSessionStateObserver(this);
 }
 
 bool PaletteTray::PerformAction(const ui::Event& event) {
   if (bubble_) {
-    bubble_.reset();
+    if (num_actions_in_palette == 0) {
+      RecordPaletteMetrics(ash::PaletteTrayOptions::PALETTE_CLOSED_NO_ACTION);
+    }
+    HidePalette();
     return true;
   }
 
   return ShowPalette();
 }
 
 bool PaletteTray::ShowPalette() {
   if (bubble_)
     return false;
 
@@ skipping 42 matching lines @@
 void PaletteTray::SessionStateChanged(
     SessionStateDelegate::SessionState state) {
   UpdateIconVisibility();
 }
 
 void PaletteTray::OnLockStateChanged(bool locked) {
   UpdateIconVisibility();
 }
 
 void PaletteTray::ClickedOutsideBubble() {
-  bubble_.reset();
+  if (num_actions_in_palette == 0)
+    RecordPaletteMetrics(ash::PaletteTrayOptions::PALETTE_CLOSED_NO_ACTION);
+  HidePalette();
 }
 
 base::string16 PaletteTray::GetAccessibleNameForTray() {
   return l10n_util::GetStringUTF16(IDS_ASH_STYLUS_TOOLS_TITLE);
 }
 
 void PaletteTray::HideBubbleWithView(const views::TrayBubbleView* bubble_view) {
   if (bubble_->bubble_view() == bubble_view)
-    bubble_.reset();
+    HidePalette();
 }
 
 void PaletteTray::BubbleViewDestroyed() {
   palette_tool_manager_->NotifyViewsDestroyed();
   SetDrawBackgroundAsActive(false);
 }
 
 void PaletteTray::OnMouseEnteredView() {}
 
 void PaletteTray::OnMouseExitedView() {}
@@ skipping 37 matching lines @@
       ->GetRootWindowController()
       ->ConfigureWidgetInitParamsForContainer(
           bubble_widget, kShellWindowId_SettingBubbleContainer, params);
 }
 
 void PaletteTray::HideBubble(const views::TrayBubbleView* bubble_view) {
   HideBubbleWithView(bubble_view);
 }
 
 void PaletteTray::HidePalette() {
+  is_palette_auto_opened = false;
+  num_actions_in_palette = 0;
   bubble_.reset();
 }
 
+void PaletteTray::RecordPaletteMetrics(ash::PaletteTrayOptions option) {
+  if (option == ash::PaletteTrayOptions::PALETTE_OPTIONS_COUNT)

[jdufault, 2016/09/02 21:54:30]

Do we want to DCHECK on this?

[xiaoyinh(OOO Sep 11-29), 2016/09/06 17:40:05]

Added. Thanks

+    return;
+
+  if (is_palette_auto_opened)

[Ilya Sherman, 2016/09/02 21:39:30]

nit: Please use curly braces, since the body spans multiple lines of text

[jdufault, 2016/09/02 21:54:30]

nit: add {} for both if/else

[xiaoyinh(OOO Sep 11-29), 2016/09/06 17:40:05]

Done.

[xiaoyinh(OOO Sep 11-29), 2016/09/06 17:40:05]

Done.

+    UMA_HISTOGRAM_ENUMERATION("Ash.Shelf.PaletteUsage.AutoOpened", option,
+                              ash::PaletteTrayOptions::PALETTE_OPTIONS_COUNT);
+  else
+    UMA_HISTOGRAM_ENUMERATION("Ash.Shelf.PaletteUsage", option,
+                              ash::PaletteTrayOptions::PALETTE_OPTIONS_COUNT);
+}
+
 bool PaletteTray::ShouldBlockShelfAutoHide() const {
   return !!bubble_;
 }
 
 void PaletteTray::OnActiveToolChanged() {
+  ++num_actions_in_palette;
   UpdateTrayIcon();
 }
 
 WmWindow* PaletteTray::GetWindow() {
   return shelf()->GetWindow();
 }
 
 void PaletteTray::SetShelfAlignment(ShelfAlignment alignment) {
   if (alignment == shelf_alignment())
     return;
@@ skipping 22 matching lines @@
 void PaletteTray::UpdateTrayIcon() {
   gfx::VectorIconId icon = palette_tool_manager_->GetActiveTrayIcon(
       palette_tool_manager_->GetActiveTool(ash::PaletteGroup::MODE));
   icon_->SetImage(CreateVectorIcon(icon, kShelfIconSize, kShelfIconColor));
 }
 
 void PaletteTray::OnStylusStateChanged(ui::StylusState stylus_state) {
   if (!WmShell::Get()->palette_delegate()->ShouldAutoOpenPalette())
     return;
 
-  if (stylus_state == ui::StylusState::REMOVED && !bubble_)
+  if (stylus_state == ui::StylusState::REMOVED && !bubble_) {
+    is_palette_auto_opened = true;
     ShowPalette();
-  else if (stylus_state == ui::StylusState::INSERTED && bubble_)
-    bubble_.reset();
+  } else if (stylus_state == ui::StylusState::INSERTED && bubble_) {
+    HidePalette();
+  }
 }
 
 void PaletteTray::OnPaletteEnabledPrefChanged(bool enabled) {
   if (!enabled)
     SetVisible(false);
   else
     UpdateIconVisibility();
 }
 
 void PaletteTray::UpdateIconVisibility() {
   SessionStateDelegate* session_state_delegate =
       WmShell::Get()->GetSessionStateDelegate();
 
   SetVisible(!session_state_delegate->IsScreenLocked() &&
              session_state_delegate->GetSessionState() ==
                  SessionStateDelegate::SESSION_STATE_ACTIVE &&
              WmShell::Get()->system_tray_delegate()->GetUserLoginStatus() !=
                  LoginStatus::KIOSK_APP);
 }
 
 }  // namespace ash