PrintPreview: Added new histograms for print preview.

chrome/browser/ui/webui/print_preview_handler.cc

 // Copyright (c) 2011 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 "chrome/browser/ui/webui/print_preview_handler.h"
 
 #include <string>
 
 #include "base/i18n/file_util_icu.h"
 #include "base/json/json_reader.h"
+#include "base/metrics/histogram.h"
 #include "base/path_service.h"
 #include "base/threading/thread.h"
 #include "base/threading/thread_restrictions.h"
 #include "base/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/platform_util.h"
 #include "chrome/browser/printing/background_printing_manager.h"
 #include "chrome/browser/printing/printer_manager_dialog.h"
 #include "chrome/browser/printing/print_preview_tab_controller.h"
@@ skipping 70 matching lines @@
       : handler_(handler),
         print_backend_(print_backend) {
   }
 
   void EnumeratePrinters() {
     ListValue* printers = new ListValue;
     int default_printer_index = -1;
 
     printing::PrinterList printer_list;
     print_backend_->EnumeratePrinters(&printer_list);
     int i = 0;

[Lei Zhang, 2011/05/13 22:56:20]

This is part of the for loop below. Don't separate it from the for loop.

[kmadhusu, 2011/05/13 23:37:12]

Done.

+
+    // Record the total number of printers.
+    UMA_HISTOGRAM_COUNTS("PrintPreview.TotalNumberOfPrinters",

[Lei Zhang, 2011/05/13 22:56:20]

Can you just name this "NumberOfPrinters" ?

[Lei Zhang, 2011/05/13 22:56:20]

jar: does this record "a user has N printers"? Or will it increment the counter
by N every time - thus if this gets called M times, it'll report the user has M
x N printers.

[kmadhusu, 2011/05/13 23:37:12]

Done.

+                         printer_list.size());
+
     for (printing::PrinterList::iterator index = printer_list.begin();
          index != printer_list.end(); ++index, ++i) {
       DictionaryValue* printer_info = new DictionaryValue;
       std::string printerName;
   #if defined(OS_MACOSX)
       // On Mac, |index->printer_description| specifies the printer name and
       // |index->printer_name| specifies the device name / printer queue name.
       printerName = index->printer_description;
   #else
       printerName = index->printer_name;
@@ skipping 117 matching lines @@
   scoped_ptr<printing::Metafile> metafile_;
 
   // The absolute path where the file will be saved.
   FilePath path_;
 };
 
 // static
 FilePath* PrintPreviewHandler::last_saved_path_ = NULL;
 
 PrintPreviewHandler::PrintPreviewHandler()
-    : print_backend_(printing::PrintBackend::CreateInstance(NULL)) {
+    : print_backend_(printing::PrintBackend::CreateInstance(NULL)),
+      regenerate_preview_request_count_(0),
+      manage_printers_dialog_request_count_(0),
+      print_preview_failed_count_(0) {
 }
 
 PrintPreviewHandler::~PrintPreviewHandler() {
   if (select_file_dialog_.get())
     select_file_dialog_->ListenerDestroyed();
 }
 
 void PrintPreviewHandler::RegisterMessages() {
   web_ui_->RegisterMessageCallback("getPrinters",
       NewCallback(this, &PrintPreviewHandler::HandleGetPrinters));
@@ skipping 18 matching lines @@
 void PrintPreviewHandler::HandleGetPrinters(const ListValue*) {
   scoped_refptr<PrintSystemTaskProxy> task =
       new PrintSystemTaskProxy(AsWeakPtr(), print_backend_.get());
   BrowserThread::PostTask(
       BrowserThread::FILE, FROM_HERE,
       NewRunnableMethod(task.get(),
                         &PrintSystemTaskProxy::EnumeratePrinters));
 }
 
 void PrintPreviewHandler::HandleGetPreview(const ListValue* args) {
+  // Increment request count.
+  ++regenerate_preview_request_count_;
+
   TabContents* initiator_tab = GetInitiatorTab();
   if (!initiator_tab) {
+    print_preview_failed_count_++;
     web_ui_->CallJavascriptFunction("printPreviewFailed");
     return;
   }
   scoped_ptr<DictionaryValue> settings(GetSettingsDictionary(args));
   if (!settings.get())
     return;
 
   RenderViewHost* rvh = initiator_tab->render_view_host();
   rvh->Send(new PrintMsg_PrintPreview(rvh->routing_id(), *settings));
 }
 
 void PrintPreviewHandler::HandlePrint(const ListValue* args) {
+  ReportStats();
+  UMA_HISTOGRAM_COUNTS("PrintPreview.Print", 1);
+
+  // Record the number of times the user requests to regenerate preview data
+  // before printing.
+  UMA_HISTOGRAM_COUNTS(
+      "PrintPreview.RegeneratePreviewRequestCount.BeforePrint",

[Lei Zhang, 2011/05/13 22:56:20]

I don't think we need Count in the name.

[kmadhusu, 2011/05/13 23:37:12]

Done.

+      regenerate_preview_request_count_);
+
   TabContents* initiator_tab = GetInitiatorTab();
   if (initiator_tab) {
     RenderViewHost* rvh = initiator_tab->render_view_host();
     rvh->Send(new PrintMsg_ResetScriptedPrintCount(rvh->routing_id()));
   }
 
   scoped_ptr<DictionaryValue> settings(GetSettingsDictionary(args));
   if (!settings.get())
     return;
 
   bool print_to_pdf = false;
   settings->GetBoolean(printing::kSettingPrintToPDF, &print_to_pdf);
 
   TabContentsWrapper* preview_tab_wrapper =
       TabContentsWrapper::GetCurrentWrapperForContents(preview_tab());
 
   if (print_to_pdf) {
+    UMA_HISTOGRAM_COUNTS("PrintPreview.PrintToPDF", 1);
+
     // Pre-populating select file dialog with print job title.
     string16 print_job_title_utf16 =
         preview_tab_wrapper->print_view_manager()->RenderSourceName();
 
 #if defined(OS_WIN)
     FilePath::StringType print_job_title(print_job_title_utf16);
 #elif defined(OS_POSIX)
     FilePath::StringType print_job_title = UTF16ToUTF8(print_job_title_utf16);
 #endif
 
@@ skipping 26 matching lines @@
       new PrintSystemTaskProxy(AsWeakPtr(), print_backend_.get());
 
   BrowserThread::PostTask(
       BrowserThread::FILE, FROM_HERE,
       NewRunnableMethod(task.get(),
                         &PrintSystemTaskProxy::GetPrinterCapabilities,
                         printer_name));
 }
 
 void PrintPreviewHandler::HandleShowSystemDialog(const ListValue* args) {
+  ReportStats();
+  UMA_HISTOGRAM_COUNTS("PrintPreview.ShowAdvanceSettings", 1);
   TabContents* initiator_tab = GetInitiatorTab();
   if (!initiator_tab)
     return;
   initiator_tab->Activate();
 
   TabContentsWrapper* wrapper =
       TabContentsWrapper::GetCurrentWrapperForContents(initiator_tab);
   wrapper->print_view_manager()->PrintNow();
 
   ClosePrintPreviewTab();
 }
 
 void PrintPreviewHandler::HandleManagePrinters(const ListValue* args) {
+  manage_printers_dialog_request_count_++;

[Lei Zhang, 2011/05/13 22:56:20]

nit: can we be consistent about ++i vs i++?

[kmadhusu, 2011/05/13 23:37:12]

Done.

   printing::PrinterManagerDialog::ShowPrinterManagerDialog();
 }
 
 void PrintPreviewHandler::HandleClosePreviewTab(const ListValue* args) {
+  ReportStats();
+  UMA_HISTOGRAM_COUNTS("PrintPreview.Cancel", 1);
+
+  // Record the number of times the user requests to regenerate preview data
+  // before cancelling.
+  UMA_HISTOGRAM_COUNTS(

[Lei Zhang, 2011/05/13 22:56:20]

Do you need to check and see if the count is greater than 0 here and in other
spots? If so, add the if statement, otherwise remove it from ReportStats().

[kmadhusu, 2011/05/13 23:37:12]

(repeating our in-person conversation) I have added the if statement only in the
places where we don't want to track the '0' values.

+      "PrintPreview.RegeneratePreviewRequestCount.BeforeCancel",
+      regenerate_preview_request_count_);
+
   ActivateInitiatorTabAndClosePreviewTab();
 }
 
+void PrintPreviewHandler::ReportStats() {
+  if (print_preview_failed_count_ > 0) {
+    UMA_HISTOGRAM_COUNTS("PrintPreview.Failed.InitiatorTabDoesNotExist",
+                         print_preview_failed_count_);
+  }
+
+  if (manage_printers_dialog_request_count_ > 0) {
+    UMA_HISTOGRAM_COUNTS("PrintPreview.ManagePrinters",
+                         manage_printers_dialog_request_count_);
+  }
+}
+
 void PrintPreviewHandler::ActivateInitiatorTabAndClosePreviewTab() {
   TabContents* initiator_tab = GetInitiatorTab();
   if (initiator_tab)
     initiator_tab->Activate();
   ClosePrintPreviewTab();
 }
 
 void PrintPreviewHandler::SendPrinterCapabilities(
     const DictionaryValue& settings_info) {
   web_ui_->CallJavascriptFunction("updateWithPrinterCapabilities",
@@ skipping 68 matching lines @@
   metafile->InitFromData(data.first->memory(), data.second);
 
   // Updating last_saved_path_ to the newly selected folder.
   *last_saved_path_ = path.DirName();
 
   PrintToPdfTask* task = new PrintToPdfTask(metafile, path);
   BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE, task);
 
   ActivateInitiatorTabAndClosePreviewTab();
 }