Log NTP hovers in 1993 clients

chrome/browser/ui/search/instant_controller.cc

 // Copyright 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/search/instant_controller.h"
 
 #include <iterator>
 
 #include "base/metrics/histogram.h"
 #include "base/prefs/pref_service.h"
@@ skipping 25 matching lines @@
 #include "chrome/common/content_settings_types.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/common/url_constants.h"
 #include "components/sessions/serialized_navigation_entry.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_widget_host_view.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/browser/web_contents.h"
+#include "content/public/browser/web_contents_user_data.h"
 #include "content/public/browser/web_contents_view.h"
 #include "net/base/escape.h"
 #include "net/base/network_change_notifier.h"
 #include "third_party/icu/public/common/unicode/normalizer2.h"
 
 #if defined(TOOLKIT_VIEWS)
 #include "ui/views/widget/widget.h"
 #endif
 
 namespace {
@@ skipping 187 matching lines @@
 template <typename T>
 void DeletePageSoon(scoped_ptr<T> page) {
   if (page->contents()) {
     base::MessageLoop::current()->DeleteSoon(
         FROM_HERE, page->ReleaseContents().release());
   }
 
   base::MessageLoop::current()->DeleteSoon(FROM_HERE, page.release());
 }
 
+class NtpLoggingUserData

[beaudoin, 2013/06/22 01:14:53]

Please document the class.

[annark1, 2013/06/25 16:01:38]

Done.

+    : public content::WebContentsUserData<NtpLoggingUserData> {
+  public:
+    virtual ~NtpLoggingUserData() {}

[beaudoin, 2013/06/22 01:14:53]

Indentation is wrong in the class:
one space before "public:" or "private:"
two spaces before methods/members.

[annark1, 2013/06/25 16:01:38]

Done.

+
+    // Called each time the mouse hovers over an iframe or title.
+    void increment_iframe_hovers(int iframe_pos) {
+      ntp_logging_data_[iframe_pos] += 1;

[beaudoin, 2013/06/22 01:14:53]

++

[annark1, 2013/06/25 16:01:38]

Done.

+    }
+
+    // Sums the values in the |ntp_logging_data_| map and logs to histogram.

[beaudoin, 2013/06/22 01:14:53]

Clarify to indicate that you are summing over every iframe.

[annark1, 2013/06/25 16:01:38]

changed to just an int.
On 2013/06/22 01:14:53, beaudoin wrote:

+    // Called when a tab is about to be deactivated.
+    void sum_values_and_log() {
+      int result = 0;
+      for (size_t i = 0; i < ntp_logging_data_.size(); ++i) {
+        result += ntp_logging_data_[i];
+      }
+      if (result > 0) {
+        HISTOGRAM_COUNTS_10000("NewTabPage.NumberOfMouseOvers", result);
+        ntp_logging_data_.clear();
+      }

[beaudoin, 2013/06/22 01:14:53]

Please check with asvitkine@ that you're using this correctly. In particular,
should you manually clamp result to 10000?

[annark1, 2013/06/25 16:01:38]

Alexei suggested just using the default UMA_HISTOGRAM_COUNTS macro.
On 2013/06/22 01:14:53, beaudoin wrote:

+    }
+
+  private:
+    explicit NtpLoggingUserData(content::WebContents* contents) {}
+    friend class content::WebContentsUserData<NtpLoggingUserData>;
+
+    // Map in which to log user data.
+    std::map<int, int> ntp_logging_data_;
+};
+
 }  // namespace
 
+DEFINE_WEB_CONTENTS_USER_DATA_KEY(NtpLoggingUserData);
+
 InstantController::InstantController(BrowserInstantController* browser,
                                      bool extended_enabled)
     : browser_(browser),
       extended_enabled_(extended_enabled),
       instant_enabled_(false),
       use_local_page_only_(true),
       preload_ntp_(true),
       model_(this),
       use_tab_for_suggestions_(false),
       last_omnibox_text_has_inline_autocompletion_(false),
@@ skipping 779 matching lines @@
     ResetInstantTab();
 }
 
 void InstantController::TabDeactivated(content::WebContents* contents) {
   LOG_INSTANT_DEBUG_EVENT(this, "TabDeactivated");
   if (extended_enabled() && !contents->IsBeingDestroyed())
     CommitIfPossible(INSTANT_COMMIT_FOCUS_LOST);
 
   if (GetOverlayContents())
     HideOverlay();
+
+  NtpLoggingUserData* data =
+      NtpLoggingUserData::FromWebContents(contents);
+  if (data) {
+    data->sum_values_and_log();
+  }

[beaudoin, 2013/06/22 01:14:53]

Nit: No {}

[annark1, 2013/06/25 16:01:38]

Done.

 }
 
 void InstantController::SetInstantEnabled(bool instant_enabled,
                                           bool use_local_page_only) {
   LOG_INSTANT_DEBUG_EVENT(this, base::StringPrintf(
       "SetInstantEnabled: instant_enabled=%d, use_local_page_only=%d",
       instant_enabled, use_local_page_only));
 
   // Non extended mode does not care about |use_local_page_only|.
   if (instant_enabled == instant_enabled_ &&
@@ skipping 529 matching lines @@
   if (!chrome::ShouldShowInstantNTP())
     return;
 
   // Instant NTP is only used in extended mode so we should always have a
   // non-empty URL to use.
   DCHECK(!instant_url.empty());
   ntp_.reset(new InstantNTP(this, instant_url));
   ntp_->InitContents(profile(), browser_->GetActiveWebContents(),
                      base::Bind(&InstantController::ReloadStaleNTP,
                                 base::Unretained(this)));
+
+  if (ntp_->contents()) {
+    NtpLoggingUserData::CreateForWebContents(ntp_->contents());
+  }

[beaudoin, 2013/06/22 01:14:53]

Nit: no {}

[annark1, 2013/06/25 16:01:38]

Done.

+
   LOG_INSTANT_DEBUG_EVENT(this, base::StringPrintf(
       "ResetNTP: instant_url='%s'", instant_url.c_str()));
 }
 
 void InstantController::ReloadStaleNTP() {
   ResetNTP(GetInstantURL());
 }
 
 bool InstantController::ShouldSwitchToLocalNTP() const {
   if (!ntp())
@@ skipping 280 matching lines @@
   result->relevance = match.relevance;
   result->autocomplete_match_index = autocomplete_match_index;
 
   DVLOG(1) << "    " << result->relevance << " "
       << UTF8ToUTF16(AutocompleteMatchType::ToString(result->type)) << " "
       << result->provider << " " << result->destination_url << " '"
       << result->description << "' '" << result->search_query << "' "
       << result->transition <<  " " << result->autocomplete_match_index;
 }
 
+void InstantController::LogIframeHover(int pos) {
+  if (!browser_ || !browser_->GetActiveWebContents())
+    return;
+
+  NtpLoggingUserData* data =
+      NtpLoggingUserData::FromWebContents(browser_->GetActiveWebContents());
+  if (data) {
+    data->increment_iframe_hovers(pos);

[beaudoin, 2013/06/22 01:14:53]

Do you really have to keep the "pos" here? If you're only interested in total
number of hovers, you could keep a single int and keep a running sum in it.
There is not really a point in keeping it in an array...

[annark1, 2013/06/25 16:01:38]

Yes, I agree that only an int is needed to just log total number of hovers. This
setup had stemmed from a discussion with Mathieu that further down the line we
may want to know more information on a per tile basis, hence logging by
position. However, as that isn't used/implemented in this patch, I've removed
the position variable.

On 2013/06/22 01:14:53, beaudoin wrote:

+  }
+}
+
 bool InstantController::IsJavascriptEnabled() const {
   GURL instant_url(GetInstantURL());
   GURL origin(instant_url.GetOrigin());
   ContentSetting js_setting = profile()->GetHostContentSettingsMap()->
       GetContentSetting(origin, origin, CONTENT_SETTINGS_TYPE_JAVASCRIPT,
                         NO_RESOURCE_IDENTIFIER);
   // Javascript can be disabled either in content settings or via a WebKit
   // preference, so check both. Disabling it through the Settings page affects
   // content settings. I'm not sure how to disable the WebKit preference, but
   // it's theoretically possible some users have it off.
   bool js_content_enabled =
       js_setting == CONTENT_SETTING_DEFAULT ||
       js_setting == CONTENT_SETTING_ALLOW;
   bool js_webkit_enabled = profile()->GetPrefs()->GetBoolean(
       prefs::kWebKitJavascriptEnabled);
   return js_content_enabled && js_webkit_enabled;
 }
 
 bool InstantController::InStartup() const {
   // TODO(shishir): This is not completely reliable. Find a better way to detect
   // startup time.
   return !browser_->GetActiveWebContents();
 }