Cleanup HistoryBackend and ExpireHistoryBackend interface

chrome/browser/history/expire_history_backend_unittest.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.
 
 #include <algorithm>
 #include <string>
 #include <utility>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/files/file_path.h"
 #include "base/files/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/path_service.h"
 #include "base/stl_util.h"
 #include "base/strings/string16.h"
 #include "base/strings/utf_string_conversions.h"
-#include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/history/expire_history_backend.h"
 #include "chrome/browser/history/history_database.h"
-#include "chrome/browser/history/history_notifications.h"
 #include "chrome/browser/history/thumbnail_database.h"
 #include "chrome/browser/history/top_sites.h"
 #include "chrome/test/base/testing_profile.h"
 #include "chrome/tools/profiles/thumbnail-inl.h"
 #include "components/history/core/common/thumbnail_score.h"
 #include "components/history/core/test/history_client_fake_bookmarks.h"
 #include "content/public/test/test_browser_thread.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "third_party/skia/include/core/SkBitmap.h"
 #include "ui/gfx/codec/jpeg_codec.h"
 
 using base::Time;
 using base::TimeDelta;
 using base::TimeTicks;
 using content::BrowserThread;
 
 // Filename constants.
 static const base::FilePath::CharType kHistoryFile[] =
     FILE_PATH_LITERAL("History");
 static const base::FilePath::CharType kThumbnailFile[] =
     FILE_PATH_LITERAL("Thumbnails");
 
 // The test must be in the history namespace for the gtest forward declarations
 // to work. It also eliminates a bunch of ugly "history::".
 namespace history {
 
 // ExpireHistoryTest -----------------------------------------------------------
 
 class ExpireHistoryTest : public testing::Test,
-                          public BroadcastNotificationDelegate {
+                          public ExpireHistoryBackendDelegate {
  public:
   ExpireHistoryTest()
       : ui_thread_(BrowserThread::UI, &message_loop_),
         db_thread_(BrowserThread::DB, &message_loop_),
         expirer_(this, &history_client_),
         now_(Time::Now()) {}
 
  protected:
   // Called by individual tests when they want data populated.
   void AddExampleData(URLID url_ids[3], Time visit_times[4]);
   // Add visits with source information.
   void AddExampleSourceData(const GURL& url, URLID* id);
 
   // Returns true if the given favicon/thumanil has an entry in the DB.
   bool HasFavicon(favicon_base::FaviconID favicon_id);
   bool HasThumbnail(URLID url_id);
 
   favicon_base::FaviconID GetFavicon(const GURL& page_url,
                                      favicon_base::IconType icon_type);
 
   // EXPECTs that each URL-specific history thing (basically, everything but
   // favicons) is gone, the reason being either that it was automatically
   // |expired|, or manually deleted.
   void EnsureURLInfoGone(const URLRow& row, bool expired);
 
-  // Returns whether a NOTIFICATION_HISTORY_URLS_MODIFIED was sent for |url|.
+  // Returns whether ExpireHistoryBackendDelegate::NotifyURLsModified was
+  // called for |url|.
   bool ModifiedNotificationSent(const GURL& url);
 
   // Clears the list of notifications received.
   void ClearLastNotifications() {
     STLDeleteValues(&notifications_);
+    urls_modified_notifications_.clear();
+    urls_deleted_notifications_.clear();
   }
 
   void StarURL(const GURL& url) { history_client_.AddBookmark(url); }
 
   static bool IsStringInFile(const base::FilePath& filename, const char* str);
 
   // Returns the path the db files are created in.
   const base::FilePath& path() const { return tmp_dir_.path(); }
 
   // This must be destroyed last.
@@ skipping 15 matching lines @@
   // Time at the beginning of the test, so everybody agrees what "now" is.
   const Time now_;
 
   // Notifications intended to be broadcast, we can check these values to make
   // sure that the deletor is doing the correct broadcasts. We own the details
   // pointers.
   typedef std::vector< std::pair<int, HistoryDetails*> >
       NotificationList;
   NotificationList notifications_;
 
+  typedef std::vector<URLRows> URLsModifiedNotificationList;
+  URLsModifiedNotificationList urls_modified_notifications_;
+
+  typedef std::vector<std::pair<bool, URLRows>> URLsDeletedNotificationList;
+  URLsDeletedNotificationList urls_deleted_notifications_;
+
  private:
   void SetUp() override {
     ASSERT_TRUE(tmp_dir_.CreateUniqueTempDir());
 
     base::FilePath history_name = path().Append(kHistoryFile);
     main_db_.reset(new HistoryDatabase);
     if (main_db_->Init(history_name) != sql::INIT_OK)
       main_db_.reset();
 
     base::FilePath thumb_name = path().Append(kThumbnailFile);
@@ skipping 11 matching lines @@
     top_sites_ = NULL;
 
     ClearLastNotifications();
 
     expirer_.SetDatabases(NULL, NULL);
 
     main_db_.reset();
     thumb_db_.reset();
   }
 
-  // BroadcastNotificationDelegate:
-  void BroadcastNotifications(int type,
-                              scoped_ptr<HistoryDetails> details) override {
-    // This gets called when there are notifications to broadcast. Instead, we
-    // store them so we can tell that the correct notifications were sent.
-    notifications_.push_back(std::make_pair(type, details.release()));
+  // ExpireHistoryBackendDelegate:
+  void NotifyURLsModified(const URLRows& rows) override {
+    urls_modified_notifications_.push_back(rows);
   }
-  void NotifySyncURLsModified(URLRows* rows) override {}
-  void NotifySyncURLsDeleted(bool all_history,
-                             bool expired,
-                             URLRows* rows) override {}
+
+  void NotifyURLsDeleted(bool all_history,
+                         bool expired,
+                         const URLRows& rows,
+                         const std::set<GURL>& favicon_urls) override {
+    urls_deleted_notifications_.push_back(std::make_pair(expired, rows));
+  }
 };
 
 // The example data consists of 4 visits. The middle two visits are to the
 // same URL, while the first and last are for unique ones. This allows a test
 // for the oldest or newest to include both a URL that should get totally
 // deleted (the one on the end) with one that should only get a visit deleted
 // (with the one in the middle) when it picks the proper threshold time.
 //
 // Each visit has indexed data, each URL has thumbnail. The first two URLs will
 // share the same avicon, while the last one will have a unique favicon. The
@@ skipping 143 matching lines @@
   // There should be no visits.
   VisitVector visits;
   main_db_->GetVisitsForURL(row.id(), &visits);
   EXPECT_EQ(0U, visits.size());
 
   // Thumbnail should be gone.
   // TODO(sky): fix this, see comment in HasThumbnail.
   // EXPECT_FALSE(HasThumbnail(row.id()));
 
   bool found_delete_notification = false;
-  for (size_t i = 0; i < notifications_.size(); i++) {
-    if (notifications_[i].first == chrome::NOTIFICATION_HISTORY_URLS_DELETED) {
-      URLsDeletedDetails* details = reinterpret_cast<URLsDeletedDetails*>(
-          notifications_[i].second);
-      EXPECT_EQ(expired, details->expired);
-      const history::URLRows& rows(details->rows);
-      history::URLRows::const_iterator it_row = std::find_if(
-          rows.begin(), rows.end(), history::URLRow::URLRowHasURL(row.url()));
-      if (it_row != rows.end()) {
-        // Further verify that the ID is set to what had been in effect in the
-        // main database before the deletion. The InMemoryHistoryBackend relies
-        // on this to delete its cached copy of the row.
-        EXPECT_EQ(row.id(), it_row->id());
-        found_delete_notification = true;
-      }
-    } else if (notifications_[i].first ==
-        chrome::NOTIFICATION_HISTORY_URLS_MODIFIED) {
-      const history::URLRows& rows =
-          static_cast<URLsModifiedDetails*>(notifications_[i].second)->
-              changed_urls;
-      EXPECT_TRUE(
-          std::find_if(rows.begin(), rows.end(),
-                        history::URLRow::URLRowHasURL(row.url())) ==
-              rows.end());
+  for (const std::pair<bool, URLRows>& pair : urls_deleted_notifications_) {
+    EXPECT_EQ(expired, pair.first);
+    const history::URLRows& rows(pair.second);
+    history::URLRows::const_iterator it_row = std::find_if(
+        rows.begin(), rows.end(), history::URLRow::URLRowHasURL(row.url()));
+    if (it_row != rows.end()) {
+      // Further verify that the ID is set to what had been in effect in the
+      // main database before the deletion. The InMemoryHistoryBackend relies
+      // on this to delete its cached copy of the row.
+      EXPECT_EQ(row.id(), it_row->id());
+      found_delete_notification = true;
     }
   }
+  for (const auto& rows : urls_modified_notifications_) {
+    EXPECT_TRUE(std::find_if(rows.begin(),
+                             rows.end(),
+                             history::URLRow::URLRowHasURL(row.url())) ==
+                rows.end());
+  }
   EXPECT_TRUE(found_delete_notification);
 }
 
 bool ExpireHistoryTest::ModifiedNotificationSent(const GURL& url) {
-  for (size_t i = 0; i < notifications_.size(); i++) {
-    if (notifications_[i].first == chrome::NOTIFICATION_HISTORY_URLS_MODIFIED) {
-      const history::URLRows& rows =
-          static_cast<URLsModifiedDetails*>(notifications_[i].second)->
-              changed_urls;
-      if (std::find_if(rows.begin(), rows.end(),
-                       history::URLRow::URLRowHasURL(url)) != rows.end())
-        return true;
-    }
+  for (const auto& rows : urls_modified_notifications_) {
+    if (std::find_if(rows.begin(),
+                     rows.end(),
+                     history::URLRow::URLRowHasURL(url)) != rows.end())
+      return true;
   }
   return false;
 }
 
 TEST_F(ExpireHistoryTest, DeleteFaviconsIfPossible) {
   // Add a favicon record.
   const GURL favicon_url("http://www.google.com/favicon.ico");
   favicon_base::FaviconID icon_id =
       thumb_db_->AddFavicon(favicon_url, favicon_base::FAVICON);
   EXPECT_TRUE(icon_id);
@@ skipping 500 matching lines @@
   EXPECT_TRUE(all->Read(now, main_db_.get(), &visits, 1));
   EXPECT_EQ(1U, visits.size());
 }
 
 // TODO(brettw) add some visits with no URL to make sure everything is updated
 // properly. Have the visits also refer to nonexistent FTS rows.
 //
 // Maybe also refer to invalid favicons.
 
 }  // namespace history