RLZ on ChromeOS-related polishing.

chrome/browser/rlz/rlz.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.
 //
 // This code glues the RLZ library DLL with Chrome. It allows Chrome to work
 // with or without the DLL being present. If the DLL is not present the
 // functions do nothing and just return false.
 
 #include "chrome/browser/rlz/rlz.h"
 
 #include <algorithm>
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/debug/trace_event.h"
 #include "base/message_loop.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/google/google_util.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/prefs/session_startup_pref.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/browser/search_engines/template_url_service.h"
 #include "chrome/browser/search_engines/template_url_service_factory.h"
 #include "chrome/browser/ui/startup/startup_browser_creator.h"
 #include "chrome/common/chrome_notification_types.h"
+#include "chrome/common/chrome_switches.h"
 #include "chrome/common/pref_names.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/notification_service.h"
 #include "net/http/http_util.h"
 
 #if defined(OS_WIN)
 #include "chrome/installer/util/google_update_settings.h"
 #else
 namespace GoogleUpdateSettings {
@@ skipping 14 matching lines @@
 }  // namespace GoogleUpdateSettings
 #endif
 
 using content::BrowserThread;
 using content::NavigationEntry;
 
 namespace {
 
 // Maximum and minimum delay for financial ping we would allow to be set through
 // master preferences. Somewhat arbitrary, may need to be adjusted in future.
-const int kMaxDelay = 200 * 1000;
-const int kMinDelay = 20 * 1000;
+const base::TimeDelta kMaxInitDelay = base::TimeDelta::FromSeconds(200);
+const base::TimeDelta kMinInitDelay = base::TimeDelta::FromSeconds(20);
 
 bool IsGoogleUrl(const GURL& url) {
   return google_util::IsGoogleHomePageUrl(url.possibly_invalid_spec());
 }
 
 bool IsBrandOrganic(const std::string& brand) {
   return brand.empty() || google_util::IsOrganic(brand);
 }
 
 void RecordProductEvents(bool first_run,
@@ skipping 108 matching lines @@
 RLZTracker::RLZTracker()
     : first_run_(false),
       send_ping_immediately_(false),
       is_google_default_search_(false),
       is_google_homepage_(false),
       is_google_in_startpages_(false),
       worker_pool_token_(BrowserThread::GetBlockingPool()->GetSequenceToken()),
       already_ran_(false),
       omnibox_used_(false),
       homepage_used_(false),
-      min_delay_(kMinDelay) {
+      min_init_delay_(kMinInitDelay) {
 }
 
 RLZTracker::~RLZTracker() {
 }
 
 // static
 bool RLZTracker::InitRlzDelayed(bool first_run,
-                                int delay,
+                                bool send_ping_immediately,
+                                base::TimeDelta delay,
                                 bool is_google_default_search,
                                 bool is_google_homepage,
                                 bool is_google_in_startpages) {
-  return GetInstance()->Init(first_run, delay, is_google_default_search,
-                             is_google_homepage, is_google_in_startpages);
+  return GetInstance()->Init(first_run, send_ping_immediately, delay,
+                             is_google_default_search, is_google_homepage,
+                             is_google_in_startpages);
 }
 
 // static
 bool RLZTracker::InitRlzFromProfileDelayed(Profile* profile,
                                            bool first_run,
-                                           int delay) {
+                                           bool send_ping_immediately,
+                                           base::TimeDelta delay) {
   bool is_google_default_search = false;
   TemplateURLService* template_url_service =
       TemplateURLServiceFactory::GetForProfile(profile);
   if (template_url_service) {
     const TemplateURL* url_template =
         template_url_service->GetDefaultSearchProvider();
     is_google_default_search =
         url_template && url_template->url_ref().HasGoogleBaseURLs();
   }
 
   PrefService* pref_service = profile->GetPrefs();
   bool is_google_homepage = google_util::IsGoogleHomePageUrl(
       pref_service->GetString(prefs::kHomePage));
 
   bool is_google_in_startpages = false;
   SessionStartupPref session_startup_prefs =
       StartupBrowserCreator::GetSessionStartupPref(
           *CommandLine::ForCurrentProcess(), profile);
   if (session_startup_prefs.type == SessionStartupPref::URLS) {
     is_google_in_startpages = std::count_if(session_startup_prefs.urls.begin(),
                                             session_startup_prefs.urls.end(),
                                             IsGoogleUrl) > 0;
   }
 
-  if (!InitRlzDelayed(first_run, delay,
+  if (!InitRlzDelayed(first_run, send_ping_immediately, delay,
                       is_google_default_search, is_google_homepage,
                       is_google_in_startpages)) {
     return false;
   }
 
   // Prime the RLZ cache for the home page access point so that its avaiable
   // for the startup page if needed (i.e., when the startup page is set to
   // the home page).
   GetAccessPointRlz(CHROME_HOME_PAGE, NULL);
 
   return true;
 }
 
 bool RLZTracker::Init(bool first_run,
-                      int delay,
+                      bool send_ping_immediately,
+                      base::TimeDelta delay,
                       bool is_google_default_search,
                       bool is_google_homepage,
                       bool is_google_in_startpages) {
   first_run_ = first_run;
   is_google_default_search_ = is_google_default_search;
   is_google_homepage_ = is_google_homepage;
   is_google_in_startpages_ = is_google_in_startpages;
+  send_ping_immediately_ = send_ping_immediately;
 
-  // A negative delay means that a financial ping should be sent immediately
-  // after a first search is recorded, without waiting for the next restart
-  // of chrome. However, we only want this behaviour on first run.
-  send_ping_immediately_ = false;
-  if (delay < 0) {
-    send_ping_immediately_ = true;
-    delay = -delay;
-  }
+  // Enable zero delays for testing.
+  if (CommandLine::ForCurrentProcess()->HasSwitch(::switches::kTestType))
+    EnableZeroDelayForTesting();
 
-  delay *= 1000;
-  delay = (delay < min_delay_) ? min_delay_ : delay;
-  delay = (delay > kMaxDelay) ? kMaxDelay : delay;
+  delay = std::min(kMaxInitDelay, std::max(min_init_delay_, delay));
 
   if (google_util::GetBrand(&brand_) && !IsBrandOrganic(brand_)) {
     // Register for notifications from the omnibox so that we can record when
     // the user performs a first search.
     registrar_.Add(this, chrome::NOTIFICATION_OMNIBOX_OPENED_URL,
                    content::NotificationService::AllSources());
     // If instant is enabled we'll start searching as soon as the user starts
     // typing in the omnibox (which triggers INSTANT_CONTROLLER_UPDATED).
     registrar_.Add(this, chrome::NOTIFICATION_INSTANT_CONTROLLER_UPDATED,
                    content::NotificationService::AllSources());
 
     // Register for notifications from navigations, to see if the user has used
     // the home page.
     registrar_.Add(this, content::NOTIFICATION_NAV_ENTRY_PENDING,
                    content::NotificationService::AllSources());
   }
   google_util::GetReactivationBrand(&reactivation_brand_);
 
   rlz_lib::SetURLRequestContext(g_browser_process->system_request_context());
   ScheduleDelayedInit(delay);
 
   return true;
 }
 
-void RLZTracker::ScheduleDelayedInit(int delay) {
+void RLZTracker::ScheduleDelayedInit(base::TimeDelta delay) {
   // The RLZTracker is a singleton object that outlives any runnable tasks
   // that will be queued up.
   BrowserThread::GetBlockingPool()->PostDelayedSequencedWorkerTask(
       worker_pool_token_,
       FROM_HERE,
       base::Bind(&RLZTracker::DelayedInit, base::Unretained(this)),
-      base::TimeDelta::FromMilliseconds(delay));
+      delay);
 }
 
 void RLZTracker::DelayedInit() {
   bool schedule_ping = false;
 
   // For organic brandcodes do not use rlz at all. Empty brandcode usually
   // means a chromium install. This is ok.
   if (!IsBrandOrganic(brand_)) {
     RecordProductEvents(first_run_, is_google_default_search_,
                         is_google_homepage_, is_google_in_startpages_,
@@ skipping 136 matching lines @@
     return;
 
   bool* record_used = point == CHROME_OMNIBOX ?
       &omnibox_used_ : &homepage_used_;
 
   // Try to record event now, else set the flag to try later when we
   // attempt the ping.
   if (!RecordProductEvent(rlz_lib::CHROME, point, rlz_lib::FIRST_SEARCH))
     *record_used = true;
   else if (send_ping_immediately_ && point == CHROME_OMNIBOX)
-    ScheduleDelayedInit(0);
+    ScheduleDelayedInit(base::TimeDelta());
 }
 
 bool RLZTracker::ScheduleRecordFirstSearch(rlz_lib::AccessPoint point) {
   if (!BrowserThread::CurrentlyOn(BrowserThread::UI))
     return false;
   BrowserThread::GetBlockingPool()->PostSequencedWorkerTask(
       worker_pool_token_,
       FROM_HERE,
       base::Bind(&RLZTracker::RecordFirstSearch,
                  base::Unretained(this), point));
@@ skipping 95 matching lines @@
 #endif
 
 // static
 void RLZTracker::CleanupRlz() {
   GetInstance()->rlz_cache_.clear();
   GetInstance()->registrar_.RemoveAll();
 }
 
 // static
 void RLZTracker::EnableZeroDelayForTesting() {
-  GetInstance()->min_delay_ = 0;
+  GetInstance()->min_init_delay_ = base::TimeDelta();
 }