Precache should cancel when there is user traffic

components/precache/content/precache_manager.h

 // 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.
 
 #ifndef COMPONENTS_PRECACHE_CONTENT_PRECACHE_MANAGER_H_
 #define COMPONENTS_PRECACHE_CONTENT_PRECACHE_MANAGER_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
 #include <list>
 #include <memory>
 #include <string>
 #include <utility>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/compiler_specific.h"
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "components/history/core/browser/history_types.h"
 #include "components/keyed_service/core/keyed_service.h"
 #include "components/precache/core/precache_fetcher.h"
 #include "url/gurl.h"
 
 namespace base {
 class FilePath;
 class Time;
+class TimeDelta;
 }
 
 namespace content {
 class BrowserContext;
 }
 
 namespace history {
 class HistoryService;
 }
 
@@ skipping 50 matching lines @@
   // preconditions, but will not be run if precaching is canceled.
   void StartPrecaching(
       const PrecacheCompletionCallback& precache_completion_callback);
 
   // Cancels precaching if it is in progress.
   void CancelPrecaching();
 
   // Returns true if precaching is currently in progress, or false otherwise.
   bool IsPrecaching() const;
 
-  // Update precache-related metrics in response to a URL being fetched.
-  void RecordStatsForFetch(const GURL& url,
-                           const GURL& referrer,
-                           const base::TimeDelta& latency,
-                           const base::Time& fetch_time,
-                           int64_t size,
-                           bool was_cached);
-
   // Posts a task to the DB thread to delete all history entries from the
   // database. Does not wait for completion of this task.
   void ClearHistory();
 
+  // Update precache about an URL being fetched. Metrics related to precache are
+  // updated and any ongoing precache will be cancelled if this is an user
+  // initiated request. Should be called on UI thread.
+  void UpdatePrecacheMetricsAndState(const GURL& url,
+                                     const GURL& referrer,
+                                     const base::TimeDelta& latency,
+                                     const base::Time& fetch_time,
+                                     int64_t size,
+                                     bool was_cached,
+                                     bool is_user_traffic);
+
  private:
+  FRIEND_TEST_ALL_PREFIXES(PrecacheManagerTest, DeleteExpiredPrecacheHistory);
+  FRIEND_TEST_ALL_PREFIXES(PrecacheManagerTest,
+                           RecordStatsForFetchDuringPrecaching);
+  FRIEND_TEST_ALL_PREFIXES(PrecacheManagerTest, RecordStatsForFetchHTTP);
+  FRIEND_TEST_ALL_PREFIXES(PrecacheManagerTest, RecordStatsForFetchHTTPS);
+  FRIEND_TEST_ALL_PREFIXES(PrecacheManagerTest, RecordStatsForFetchInTopHosts);
+  FRIEND_TEST_ALL_PREFIXES(PrecacheManagerTest,
+                           RecordStatsForFetchWithEmptyURL);
+  FRIEND_TEST_ALL_PREFIXES(PrecacheManagerTest, RecordStatsForFetchWithNonHTTP);
+  FRIEND_TEST_ALL_PREFIXES(PrecacheManagerTest,
+                           RecordStatsForFetchWithSizeZero);
+
   enum class AllowedType {
     ALLOWED,
     DISALLOWED,
     PENDING
   };
 
   // From KeyedService.
   void Shutdown() override;
 
   // From PrecacheFetcher::PrecacheDelegate.
   void OnDone() override;
 
   // Callback when fetching unfinished work from storage is done.
   void OnGetUnfinishedWorkDone(
       std::unique_ptr<PrecacheUnfinishedWork> unfinished_work);
 
   // From history::HistoryService::TopHosts.
   void OnHostsReceived(const history::TopHostsList& host_counts);
 
   // Initializes and Starts a PrecacheFetcher with unfinished work.
   void InitializeAndStartFetcher();
 
   // From history::HistoryService::TopHosts. Used for the control group, which
   // gets the list of TopHosts for metrics purposes, but otherwise does nothing.
   void OnHostsReceivedThenDone(const history::TopHostsList& host_counts);
 
   // Returns true if precaching is allowed for the browser context.
   AllowedType PrecachingAllowed() const;
 
+  // Update precache-related metrics in response to a URL being fetched.
+  void RecordStatsForFetch(const GURL& url,
+                           const GURL& referrer,
+                           const base::TimeDelta& latency,
+                           const base::Time& fetch_time,
+                           int64_t size,
+                           bool was_cached);
+
   // Update precache-related metrics in response to a URL being fetched. Called
   // by RecordStatsForFetch() by way of an asynchronous HistoryService callback.
   void RecordStatsForFetchInternal(const GURL& url,
                                    const base::TimeDelta& latency,
                                    const base::Time& fetch_time,
                                    int64_t size,
                                    bool was_cached,
                                    int host_rank);
 
   // The browser context that owns this PrecacheManager.
@@ skipping 24 matching lines @@
 
   // Work that hasn't yet finished.
   std::unique_ptr<PrecacheUnfinishedWork> unfinished_work_;
 
   DISALLOW_COPY_AND_ASSIGN(PrecacheManager);
 };
 
 }  // namespace precache
 
 #endif  // COMPONENTS_PRECACHE_CONTENT_PRECACHE_MANAGER_H_