Log NTP hovers in 1993 clients

chrome/browser/ui/search/instant_ntp.cc

 // Copyright 2013 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/search/instant_ntp.h"
 
+#include "base/metrics/histogram.h"
+#include "chrome/browser/search/search.h"
 #include "chrome/browser/ui/search/search_tab_helper.h"
+#include "content/public/browser/navigation_details.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/web_contents.h"
+#include "content/public/browser/web_contents_observer.h"
+#include "content/public/browser/web_contents_user_data.h"
+
+
+namespace {
+// Helper class for logging data from the NTP. Attached to each InstantNTP
+// instance.
+class NTPLoggingUserData
+    : public content::WebContentsObserver,
+      public content::WebContentsUserData<NTPLoggingUserData> {
+ public:
+  virtual ~NTPLoggingUserData() {}
+
+  // Called each time the mouse hovers over an iframe or title.
+  void increment_number_of_mouseovers() {
+    number_of_mouseovers_++;
+  }
+
+  // Logs total number of mouseovers per NTP session to UMA histogram. Called
+  // when an NTP tab is about to be deactivated (be it by switching tabs, losing
+  // focus or closing the tab/shutting down Chrome) or when the user navigates
+  // to a URL.
+  void log_number_of_mouseovers() {
+    UMA_HISTOGRAM_COUNTS("NewTabPage.NumberOfMouseOvers",
+                         number_of_mouseovers_);
+    number_of_mouseovers_ = 0;
+  }
+
+  void set_instant_url(const std::string& url) {
+    instant_url_ = url;
+  }
+
+  // content::WebContentsObserver override
+  virtual void  NavigationEntryCommitted OVERRIDE(

[Jered, 2013/06/28 16:24:17]

Remove extra space after "void".

[annark1, 2013/06/28 18:38:22]

Done.

+      const content::LoadCommittedDetails& load_details) {
+    if (chrome::MatchesOriginAndPath(
+        GURL(instant_url_), load_details.previous_url))

[Jered, 2013/06/28 16:24:17]

Indent 4 more spaces.

[annark1, 2013/06/28 18:38:22]

Done.

+      log_number_of_mouseovers();
+  }
+
+ private:
+  explicit NTPLoggingUserData(content::WebContents* contents)
+      : content::WebContentsObserver(contents),
+        number_of_mouseovers_(0),
+        instant_url_("Needs To Be Set") {}

[Jered, 2013/06/28 16:24:17]

Omit this default value.

[annark1, 2013/06/28 18:38:22]

The reason this is here is because on start up the NavigationEntryCommitted
function seems to get fired twice, and in those cases the load_details'
previous_url is blank. Is there some dummy value I can put in for these types of
cases, so there's no chance of it seeming like there is a match when in fact
there isn't?

On 2013/06/28 16:24:17, Jered wrote:

[Jered, 2013/06/28 18:43:09]

How about not emitting the count when previous_url is blank? You don't want to
count 0 hovers when the ntp is initially committed, after all.

+  friend class content::WebContentsUserData<NTPLoggingUserData>;
+
+  int number_of_mouseovers_;
+  std::string instant_url_;
+
+  DISALLOW_COPY_AND_ASSIGN(NTPLoggingUserData);
+};
+
+}  // namespace
+
+DEFINE_WEB_CONTENTS_USER_DATA_KEY(NTPLoggingUserData);
 
 InstantNTP::InstantNTP(InstantPage::Delegate* delegate,
                        const std::string& instant_url,
                        bool is_incognito)
     : InstantPage(delegate, instant_url, is_incognito),
       loader_(this) {
 }
 
 InstantNTP::~InstantNTP() {
 }
 
 void InstantNTP::InitContents(Profile* profile,
                               const content::WebContents* active_tab,
                               const base::Closure& on_stale_callback) {
   loader_.Init(GURL(instant_url()), profile, active_tab, on_stale_callback);
   SetContents(loader_.contents());
   SearchTabHelper::FromWebContents(contents())->InitForPreloadedNTP();
+
+  NTPLoggingUserData::CreateForWebContents(contents());
+  NTPLoggingUserData::FromWebContents(
+      contents())->set_instant_url(instant_url());
+
   loader_.Load();
 }
 
 scoped_ptr<content::WebContents> InstantNTP::ReleaseContents() {
   SetContents(NULL);
   return loader_.ReleaseContents();
 }
 
+void InstantNTP::LogIframeHover(content::WebContents* contents) {
+  if (NTPLoggingUserData::FromWebContents(contents)) {
+    NTPLoggingUserData::FromWebContents(contents)->
+      increment_number_of_mouseovers();
+  }
+}
+
+void InstantNTP::LogTotalMouseovers(content::WebContents* contents) {
+  if (NTPLoggingUserData::FromWebContents(contents)) {
+    NTPLoggingUserData::FromWebContents(contents)->log_number_of_mouseovers();
+  }
+}
+
 void InstantNTP::OnSwappedContents() {
   SetContents(loader_.contents());
 }
 
 void InstantNTP::OnFocus() {
   NOTREACHED();
 }
 
 void InstantNTP::OnMouseDown() {
   NOTREACHED();
@@ skipping 12 matching lines @@
 void InstantNTP::LoadCompletedMainFrame() {
 }
 
 bool InstantNTP::ShouldProcessRenderViewCreated() {
   return true;
 }
 
 bool InstantNTP::ShouldProcessRenderViewGone() {
   return true;
 }