Make profile statistics tasks inspectable by tests

chrome/browser/profiles/profile_statistics_aggregator.h

+// Copyright 2016 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 CHROME_BROWSER_PROFILES_PROFILE_STATISTICS_AGGREGATOR_H_
+#define CHROME_BROWSER_PROFILES_PROFILE_STATISTICS_AGGREGATOR_H_
+
+#include <stddef.h>
+
+#include <set>
+#include <vector>
+
+#include "base/callback_forward.h"
+#include "base/files/file_path.h"
+#include "base/memory/ref_counted.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/task_runner.h"
+#include "chrome/browser/profiles/profile_statistics.h"
+#include "chrome/browser/profiles/profile_statistics_types.h"
+#include "components/bookmarks/browser/bookmark_model_observer.h"
+#include "components/history/core/browser/history_types.h"
+#include "components/password_manager/core/browser/password_store_consumer.h"
+
+namespace bookmarks {
+class BookMarkModel;
+class BookMarkNode;
+}
+
+class Profile;
+
+class ProfileStatisticsAggregator
+    : public base::RefCountedThreadSafe<ProfileStatisticsAggregator> {
+  // This class is used internally by GetProfileStatistics and
+  // StoreProfileStatisticsToCache.
+  //
+  // The class collects statistical information about the profile and returns
+  // the information via a callback function. Currently bookmarks, history,
+  // logins and preferences are counted.
+  //
+  // The class is RefCounted because this is needed for CancelableTaskTracker
+  // to function properly. Once all tasks are run (or cancelled) the instance is
+  // automatically destructed.
+
+ public:
+  ProfileStatisticsAggregator(Profile* profile,
+      const profiles::ProfileStatisticsCallback& stats_callback,
+      const base::Closure& destruct_callback);
+
+  void AddCallbackAndStartAggregator(
+      const profiles::ProfileStatisticsCallback& stats_callback);
+
+  // The method below is used for testing.
+  size_t GetCallbackCount();
+
+ private:
+  friend class base::RefCountedThreadSafe<ProfileStatisticsAggregator>;
+
+  struct ProfileStatValue {
+    int count;
+    bool success;  // false means the statistics failed to load
+  };
+
+  ~ProfileStatisticsAggregator();
+
+  // Start gathering statistics. Also cancels existing statistics tasks.
+  void StartAggregator();
+
+  // Callback functions
+  // Normal callback. Appends result to |profile_category_stats_|, and then call
+  // the external callback. All other callbacks call this function.
+  void StatisticsCallback(const char* category, ProfileStatValue result);
+  // Callback for reporting success.
+  void StatisticsCallbackSuccess(const char* category, int count);
+  // Callback for reporting failure.
+  void StatisticsCallbackFailure(const char* category);
+  // Callback for history.
+  void StatisticsCallbackHistory(history::HistoryCountResult result);
+
+  // Bookmark counting.
+  void WaitOrCountBookmarks();
+  void CountBookmarks(bookmarks::BookmarkModel* bookmark_model);
+
+  class BookmarkModelHelper
+      : public bookmarks::BookmarkModelObserver {
+   public:
+    explicit BookmarkModelHelper(ProfileStatisticsAggregator* parent)
+        : parent_(parent) {}
+
+    void BookmarkModelLoaded(bookmarks::BookmarkModel* model,
+                             bool ids_reassigned) override;
+
+    void BookmarkNodeMoved(bookmarks::BookmarkModel* model,
+                           const bookmarks::BookmarkNode* old_parent,
+                           int old_index,
+                           const bookmarks::BookmarkNode* new_parent,
+                           int new_index) override {}
+
+    void BookmarkNodeAdded(bookmarks::BookmarkModel* model,
+                           const bookmarks::BookmarkNode* parent,
+                           int index) override {}
+
+    void BookmarkNodeRemoved(bookmarks::BookmarkModel* model,
+        const bookmarks::BookmarkNode* parent,
+        int old_index, const bookmarks::BookmarkNode* node,
+        const std::set<GURL>& no_longer_bookmarked) override {}
+
+    void BookmarkNodeChanged(bookmarks::BookmarkModel* model,
+        const bookmarks::BookmarkNode* node) override {}
+
+    void BookmarkNodeFaviconChanged(bookmarks::BookmarkModel* model,
+        const bookmarks::BookmarkNode* node) override {}
+
+    void BookmarkNodeChildrenReordered(bookmarks::BookmarkModel* model,
+        const bookmarks::BookmarkNode* node) override {}
+
+    void BookmarkAllUserNodesRemoved(bookmarks::BookmarkModel* model,
+        const std::set<GURL>& removed_urls) override {}
+
+   private:
+    ProfileStatisticsAggregator* parent_ = nullptr;
+  };
+
+  // Password counting
+  class PasswordStoreConsumerHelper
+      : public password_manager::PasswordStoreConsumer {
+   public:
+    explicit PasswordStoreConsumerHelper(ProfileStatisticsAggregator* parent)
+        : parent_(parent) {}
+
+    void OnGetPasswordStoreResults(
+        ScopedVector<autofill::PasswordForm> results) override;
+
+   private:
+    ProfileStatisticsAggregator* parent_ = nullptr;
+
+    DISALLOW_COPY_AND_ASSIGN(PasswordStoreConsumerHelper);
+  };
+
+  // Preference counting.
+  ProfileStatValue CountPrefs() const;
+
+  Profile* profile_;
+  base::FilePath profile_path_;
+  profiles::ProfileCategoryStats profile_category_stats_;
+
+  // Callback function to be called when results arrive. Will be called
+  // multiple times (once for each statistics).
+  std::vector<profiles::ProfileStatisticsCallback> stats_callbacks_;
+
+  // Callback function to be called when the aggregator destructs. Used for
+  // removing expiring references to this aggregator.
+  base::Closure destruct_callback_;
+
+  base::CancelableTaskTracker tracker_;
+
+  // Bookmark counting
+  scoped_ptr<BookmarkModelHelper> bookmark_model_helper_;
+
+  // Password counting.
+  PasswordStoreConsumerHelper password_store_consumer_helper_;
+
+  DISALLOW_COPY_AND_ASSIGN(ProfileStatisticsAggregator);
+};
+
+#endif  // CHROME_BROWSER_PROFILES_PROFILE_STATISTICS_AGGREGATOR_H_