UMA for Windows 8 Secondary Tile pinning/unpinning user actions

chrome/browser/ui/metro_pin_tab_helper_win.cc

 // Copyright (c) 2012 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/metro_pin_tab_helper_win.h"
 
 #include <set>
 
 #include "base/base_paths.h"
 #include "base/bind.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/logging.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/ref_counted_memory.h"
+#include "base/metrics/histogram.h"
 #include "base/path_service.h"
 #include "base/string_number_conversions.h"
 #include "base/utf_string_conversions.h"
 #include "base/win/metro.h"
 #include "chrome/browser/favicon/favicon_download_helper.h"
 #include "chrome/browser/favicon/favicon_tab_helper.h"
 #include "chrome/browser/favicon/favicon_util.h"
 #include "chrome/browser/ui/tab_contents/tab_contents.h"
 #include "chrome/common/chrome_paths.h"
 #include "chrome/common/icon_messages.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/web_contents.h"
 #include "crypto/sha2.h"
 #include "third_party/skia/include/core/SkCanvas.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/codec/png_codec.h"
 #include "ui/gfx/color_analysis.h"
 #include "ui/gfx/color_utils.h"
 #include "ui/gfx/image/image.h"
 #include "ui/gfx/rect.h"
 #include "ui/gfx/size.h"
 
 DEFINE_WEB_CONTENTS_USER_DATA_KEY(MetroPinTabHelper)
 
 namespace {
 
+// Histogram name for site-specific tile pinning metrics.
+const char kMetroPinMetric[] = "Metro.SecondaryTilePin";
+
 // Generate an ID for the tile based on |url_str|. The ID is simply a hash of
 // the URL.
 string16 GenerateTileId(const string16& url_str) {
   uint8 hash[crypto::kSHA256Length];
   crypto::SHA256HashString(UTF16ToUTF8(url_str), hash, sizeof(hash));
   std::string hash_str = base::HexEncode(hash, sizeof(hash));
   return UTF8ToUTF16(hash_str);
 }
 
 // Get the path of the directory to store the tile logos in.
@@ skipping 98 matching lines @@
     return true;
 
   FilePath default_logo_path;
   if (!PathService::Get(base::DIR_MODULE, &default_logo_path))
     return false;
 
   default_logo_path = default_logo_path.Append(kDefaultLogoFileName);
   return file_util::CopyFile(default_logo_path, *logo_path);
 }
 
+// UMA reporting callback for site-specific secondary tile creation.
+void PinPageReportUMACallback(void* callback_data,

[benwells, 2012/11/27 08:56:39]

callback_data doesn't seem to serve any purpose. Why plumb it all the way
through?

[tapted, 2012/11/28 00:33:43]

I think my fingers just balked at making a callback API with no way to pass
through user data ;-). Since, that limits a callback to accessing static/global
data only. Which, for UMA, it is. So, I didn't end up using it, even though the
caller -- MetroPinTabHelper -- is per-tab.

I'll cut it out. [Done.]

[benwells, 2012/11/29 04:19:46]

If you really want to pass callback data through you can always curry it in with
base::bind later on. That's the way we roll.

+                              base::win::MetroSecondaryTilePinState result) {
+  UMA_HISTOGRAM_ENUMERATION(kMetroPinMetric,
+                            result,
+                            base::win::METRO_PIN_STATE_LIMIT);
+}
+
 // The PinPageTaskRunner class performs the necessary FILE thread actions to
 // pin a page, such as generating or copying the tile image file. When it
 // has performed these actions it will send the tile creation request to the
 // metro driver.
 class PinPageTaskRunner : public base::RefCountedThreadSafe<PinPageTaskRunner> {
  public:
   // Creates a task runner for the pinning operation with the given details.
   // |favicon| can be a null image (i.e. favicon.isNull() can be true), in
   // which case the backup tile image will be used.
   PinPageTaskRunner(const string16& title,
@@ skipping 40 matching lines @@
     LOG(ERROR) << "Could not create directory to store tile image.";
     return;
   }
 
   FilePath logo_path;
   if (!CreateSiteSpecificLogo(favicon_, tile_id, logo_dir, &logo_path) &&
       !GetPathToBackupLogo(logo_dir, &logo_path)) {
     LOG(ERROR) << "Count not get path to logo tile.";
     return;
   }
+  UMA_HISTOGRAM_ENUMERATION(kMetroPinMetric,
+                            base::win::METRO_PIN_LOGO_READY,
+                            base::win::METRO_PIN_STATE_LIMIT);
 
   HMODULE metro_module = base::win::GetMetroModule();
   if (!metro_module)
     return;
 
-  typedef void (*MetroPinToStartScreen)(const string16&, const string16&,
-      const string16&, const FilePath&);
-  MetroPinToStartScreen metro_pin_to_start_screen =
-      reinterpret_cast<MetroPinToStartScreen>(
+  base::win::MetroPinToStartScreen metro_pin_to_start_screen =
+      reinterpret_cast<base::win::MetroPinToStartScreen>(
           ::GetProcAddress(metro_module, "MetroPinToStartScreen"));
   if (!metro_pin_to_start_screen) {
     NOTREACHED();
     return;
   }
 
-  metro_pin_to_start_screen(tile_id, title_, url_, logo_path);
+  metro_pin_to_start_screen(tile_id,
+                            title_,
+                            url_,
+                            logo_path,
+                            &PinPageReportUMACallback,
+                            NULL);
 }
 
 }  // namespace
 
 class MetroPinTabHelper::FaviconChooser {
  public:
   FaviconChooser(MetroPinTabHelper* helper,
                  const string16& title,
                  const string16& url,
                  const gfx::ImageSkia& history_image);
@@ skipping 124 matching lines @@
     return false;
   }
 
   GURL url = web_contents()->GetURL();
   string16 tile_id = GenerateTileId(UTF8ToUTF16(url.spec()));
   return metro_is_pinned_to_start_screen(tile_id) != 0;
 }
 
 void MetroPinTabHelper::TogglePinnedToStartScreen() {
   if (IsPinned()) {
+    UMA_HISTOGRAM_ENUMERATION(kMetroPinMetric,
+                              base::win::METRO_UNPIN_INITIATED,
+                              base::win::METRO_PIN_STATE_LIMIT);
     UnPinPageFromStartScreen();
     return;
   }
 
+  UMA_HISTOGRAM_ENUMERATION(kMetroPinMetric,
+                            base::win::METRO_PIN_INITIATED,
+                            base::win::METRO_PIN_STATE_LIMIT);
   GURL url = web_contents()->GetURL();
   string16 url_str = UTF8ToUTF16(url.spec());
   string16 title = web_contents()->GetTitle();
   // TODO(oshima): Use scoped_ptr::Pass to pass it to other thread.
   gfx::ImageSkia favicon;
   FaviconTabHelper* favicon_tab_helper = FaviconTabHelper::FromWebContents(
       web_contents());
   if (favicon_tab_helper->FaviconIsValid())
     favicon = *favicon_tab_helper->GetFavicon().AsImageSkia().DeepCopy().get();
 
@@ skipping 43 matching lines @@
     favicon_chooser_->UpdateCandidate(id, image_url, errored,
                                       requested_size, bitmaps);
   }
 }
 
 void MetroPinTabHelper::UnPinPageFromStartScreen() {
   HMODULE metro_module = base::win::GetMetroModule();
   if (!metro_module)
     return;
 
-  typedef void (*MetroUnPinFromStartScreen)(const string16&);
-  MetroUnPinFromStartScreen metro_un_pin_from_start_screen =
-      reinterpret_cast<MetroUnPinFromStartScreen>(
+  base::win::MetroUnPinFromStartScreen metro_un_pin_from_start_screen =
+      reinterpret_cast<base::win::MetroUnPinFromStartScreen>(
           ::GetProcAddress(metro_module, "MetroUnPinFromStartScreen"));
   if (!metro_un_pin_from_start_screen) {
     NOTREACHED();
     return;
   }
 
   GURL url = web_contents()->GetURL();
   string16 tile_id = GenerateTileId(UTF8ToUTF16(url.spec()));
-  metro_un_pin_from_start_screen(tile_id);
+  metro_un_pin_from_start_screen(tile_id, &PinPageReportUMACallback, NULL);
 }
 
 void MetroPinTabHelper::FaviconDownloaderFinished() {
   favicon_chooser_.reset();
 }