add log to mac translate bubble implementation

chrome/browser/ui/cocoa/translate/translate_bubble_controller.mm

 // Copyright 2014 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/translate/translate_bubble_controller.h"
 
 #include <utility>
 
 #include "base/mac/foundation_util.h"
 #include "base/mac/scoped_nsobject.h"
 #include "base/macros.h"
+#include "base/metrics/histogram_macros.h"
 #include "base/strings/sys_string_conversions.h"
 #import "chrome/browser/ui/cocoa/browser_window_controller.h"
 #import "chrome/browser/ui/cocoa/bubble_combobox.h"
 #import "chrome/browser/ui/cocoa/info_bubble_view.h"
 #import "chrome/browser/ui/cocoa/info_bubble_window.h"
 #import "chrome/browser/ui/cocoa/toolbar/toolbar_controller.h"
 #include "chrome/browser/ui/translate/language_combobox_model.h"
 #include "chrome/browser/ui/translate/translate_bubble_model_impl.h"
+#include "chrome/browser/ui/translate/translate_bubble_view_state_transition.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/translate/core/browser/translate_ui_delegate.h"
 #include "content/public/browser/browser_context.h"
 #include "grit/components_strings.h"
 #include "ui/base/cocoa/cocoa_base_utils.h"
 #import "ui/base/cocoa/controls/hyperlink_button_cell.h"
 #import "ui/base/cocoa/window_size_constants.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/models/combobox_model.h"
 
@@ skipping 54 matching lines @@
 - (void)updateAdvancedView;
 - (NSTextField*)addText:(NSString*)text
                  toView:(NSView*)view;
 - (NSButton*)addLinkButtonWithText:(NSString*)text
                             action:(SEL)action
                             toView:(NSView*)view;
 - (NSButton*)addButton:(NSString*)title
                 action:(SEL)action
                 toView:(NSView*)view;
 - (NSButton*)addCheckbox:(NSString*)title
+                  action:(SEL)action
                   toView:(NSView*)view;
 - (NSPopUpButton*)addPopUpButton:(ui::ComboboxModel*)model
                           action:(SEL)action
                           toView:(NSView*)view;
-- (void)handleNopeButtonPressed;
+- (void)handleAlwaysTranslateCheckboxPressed;
 - (void)handleDoneButtonPressed;
 - (void)handleCancelButtonPressed;
 - (void)handleShowOriginalButtonPressed;
 - (void)handleAdvancedLinkButtonPressed;
 - (void)handleDenialPopUpButtonNopeSelected;
 - (void)handleDenialPopUpButtonNeverTranslateLanguageSelected;
 - (void)handleDenialPopUpButtonNeverTranslateSiteSelected;
 - (void)handleSourceLanguagePopUpButtonSelectedItemChanged:(id)sender;
 - (void)handleTargetLanguagePopUpButtonSelectedItemChanged:(id)sender;
+- (void)reportUiAction:(translate::TranslateBubbleUiEvent)action;
 
 @end
 
 @implementation TranslateBubbleController
 
 @synthesize webContents = webContents_;
 
 - (id)initWithParentWindow:(BrowserWindowController*)controller
                      model:(std::unique_ptr<TranslateBubbleModel>)model
                webContents:(content::WebContents*)webContents {
@@ skipping 297 matching lines @@
       [self addPopUpButton:targetLanguageComboboxModel_.get()
                     action:action
                     toView:view];
 
   // 'Always translate' checkbox
   BOOL isIncognitoWindow = webContents_ ?
       webContents_->GetBrowserContext()->IsOffTheRecord() : NO;
   if (!isIncognitoWindow) {
     NSString* title =
         l10n_util::GetNSStringWithFixup(IDS_TRANSLATE_BUBBLE_ALWAYS);
+    action = @selector(handleAlwaysTranslateCheckboxPressed);
     alwaysTranslateCheckbox_ = [self addCheckbox:title
+                                          action:action
                                           toView:view];
   }
 
   // Buttons
   advancedDoneButton_ =
       [self addButton:l10n_util::GetNSStringWithFixup(IDS_DONE)
                action:@selector(handleDoneButtonPressed)
                toView:view];
   advancedCancelButton_ =
       [self addButton:l10n_util::GetNSStringWithFixup(IDS_CANCEL)
@@ skipping 120 matching lines @@
   [button sizeToFit];
   [button setTarget:self];
   [button setAction:action];
 
   [view addSubview:button.get()];
 
   return button.get();
 }
 
 - (NSButton*)addCheckbox:(NSString*)title
+                  action:(SEL)action
                   toView:(NSView*)view {
   base::scoped_nsobject<NSButton> button(
       [[NSButton alloc] initWithFrame:NSZeroRect]);
   [button setFont:[NSFont systemFontOfSize:[NSFont smallSystemFontSize]]];
   [button setTitle:title];
   [[button cell] setControlSize:NSSmallControlSize];
   [button setButtonType:NSSwitchButton];
   [button sizeToFit];
+  [button setTarget:self];
+  [button setAction:action];
 
   [view addSubview:button.get()];
 
   return button.get();
 }
 
 - (NSPopUpButton*)addPopUpButton:(ui::ComboboxModel*)model
                           action:(SEL)action
                           toView:(NSView*)view {
   base::scoped_nsobject<NSPopUpButton> button(
       [[BubbleCombobox alloc] initWithFrame:NSZeroRect
                                   pullsDown:NO
                                       model:model]);
   [button setTarget:self];
   [button setAction:action];
   [button sizeToFit];
   [view addSubview:button.get()];
   return button.get();
 }
 
 - (void)handleTranslateButtonPressed {
+  [self reportUiAction:translate::TRANSLATE_BUTTON_CLICKED];
   translateExecuted_ = YES;
   model_->Translate();
 }
 
-- (void)handleNopeButtonPressed {
-  model_->DeclineTranslation();
-  [self close];
+- (void)handleAlwaysTranslateCheckboxPressed {
+  [self reportUiAction:[alwaysTranslateCheckbox_ state] == NSOnState
+                           ? translate::ALWAYS_TRANSLATE_CHECKED

[groby-ooo-7-16, 2016/05/11 20:32:45]

Does that match views semantics? (I.e. are we recording every state change there
as well? Or do we record when leaving the bubble?)

In general, I'd love to move those actions up to the model (or in a separate
controller) - we're duplicating work between Views and OSX

[ftang, 2016/05/14 04:50:24]

yes, this record the user's action, not their final decision. It is the same in
the window/linux bubble.

+                           : translate::ALWAYS_TRANSLATE_UNCHECKED];
 }
 
 - (void)handleDoneButtonPressed {
+  [self reportUiAction:translate::DONE_BUTTON_CLICKED];
   if (alwaysTranslateCheckbox_) {
     model_->SetAlwaysTranslate(
         [alwaysTranslateCheckbox_ state] == NSOnState);
   }
   if (model_->IsPageTranslatedInCurrentLanguages()) {
     model_->GoBackFromAdvanced();
     [self performLayout];
   } else {
     translateExecuted_ = true;
     model_->Translate();
     [self switchView:TranslateBubbleModel::VIEW_STATE_TRANSLATING];
   }
 }
 
 - (void)handleCancelButtonPressed {
+  [self reportUiAction:translate::CANCEL_BUTTON_CLICKED];
   model_->GoBackFromAdvanced();
   [self performLayout];
 }
 
 - (void)handleShowOriginalButtonPressed {
+  [self reportUiAction:translate::SHOW_ORIGINAL_BUTTON_CLICKED];
   model_->RevertTranslation();
   [self close];
 }
 
 - (void)handleAdvancedLinkButtonPressed {
+  [self reportUiAction:translate::ADVANCED_LINK_CLICKED];
   [self switchView:TranslateBubbleModel::VIEW_STATE_ADVANCED];
 }
 
 - (void)handleDenialPopUpButtonNopeSelected {
+  [self reportUiAction:translate::NOPE_MENU_CLICKED];
   model_->DeclineTranslation();
   [self close];
 }
 
 - (void)handleDenialPopUpButtonNeverTranslateLanguageSelected {
+  [self reportUiAction:translate::NEVER_TRANSLATE_LANGUAGE_MENU_CLICKED];
   model_->DeclineTranslation();
   model_->SetNeverTranslateLanguage(true);
   [self close];
 }
 
 - (void)handleDenialPopUpButtonNeverTranslateSiteSelected {
+  [self reportUiAction:translate::NEVER_TRANSLATE_SITE_MENU_CLICKED];
   model_->DeclineTranslation();
   model_->SetNeverTranslateSite(true);
   [self close];
 }
 
 - (void)handleSourceLanguagePopUpButtonSelectedItemChanged:(id)sender {
+  [self reportUiAction:translate::SOURCE_LANGUAGE_MENU_CLICKED];
   NSPopUpButton* button = base::mac::ObjCCastStrict<NSPopUpButton>(sender);
   model_->UpdateOriginalLanguageIndex([button indexOfSelectedItem]);
   [self updateAdvancedView];
 }
 
 - (void)handleTargetLanguagePopUpButtonSelectedItemChanged:(id)sender {
+  [self reportUiAction:translate::TARGET_LANGUAGE_MENU_CLICKED];
   NSPopUpButton* button = base::mac::ObjCCastStrict<NSPopUpButton>(sender);
   model_->UpdateTargetLanguageIndex([button indexOfSelectedItem]);
   [self updateAdvancedView];
 }
 
+- (void)reportUiAction:(translate::TranslateBubbleUiEvent)action {

[groby-ooo-7-16, 2016/05/11 20:32:45]

Please make this shared between Views and OSX - no reason to duplicate.

[ftang, 2016/05/14 04:50:24]

Done.

+  UMA_HISTOGRAM_ENUMERATION("Translate.BubbleUiEvent", action,
+                            translate::TRANSLATE_BUBBLE_UI_EVENT_MAX);
+}
+
 @end