Avoid sending notifications when the bitmap data in history has not changed

chrome/browser/history/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 <set>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/bind.h"
@@ skipping 1429 matching lines @@
   favicon_bitmaps.clear();
   EXPECT_TRUE(GetSortedFaviconBitmaps(icon_mappings[1].icon_id,
                                       &favicon_bitmaps));
 
   EXPECT_EQ(2u, favicon_bitmaps.size());
   EXPECT_TRUE(BitmapDataEqual('b', favicon_bitmaps[0].bitmap_data));
   EXPECT_EQ(kSmallSize, favicon_bitmaps[0].pixel_size);
   EXPECT_TRUE(BitmapDataEqual('c', favicon_bitmaps[1].bitmap_data));
   EXPECT_EQ(kLargeSize, favicon_bitmaps[1].pixel_size);
 
+  // Notifications should have been broadcast for each call to SetFavicons().
+  EXPECT_EQ(2, num_broadcasted_notifications());
+
   // Change the sizes for which the favicon at icon_url1 is available at from
   // the web. Verify that all the data remains valid.
   icon_url_sizes[icon_url1] = GetSizesTinySmallAndLarge();
   favicon_bitmap_data.clear();
   backend_->SetFavicons(page_url, FAVICON, favicon_bitmap_data,
                         icon_url_sizes);
 
   icon_mappings.clear();
   EXPECT_TRUE(GetSortedIconMappingsForPageURL(page_url, &icon_mappings));
   EXPECT_EQ(2u, icon_mappings.size());
@@ skipping 15 matching lines @@
       icon_mappings[1].icon_id, &icon_url, &icon_type, &favicon_sizes));
   EXPECT_EQ(icon_url2, icon_url);
   EXPECT_EQ(FAVICON, icon_type);
   EXPECT_EQ(GetSizesSmallAndLarge(), favicon_sizes);
 
   favicon_bitmaps.clear();
   EXPECT_TRUE(backend_->thumbnail_db_->GetFaviconBitmaps(
       icon_mappings[1].icon_id, &favicon_bitmaps));
   EXPECT_EQ(2u, favicon_bitmaps.size());
 
-  // Notifications should have been broadcast for each call to SetFavicons().
-  EXPECT_EQ(3, num_broadcasted_notifications());
+  // No notifications should have been sent because changing the favicon sizes
+  // did not result in deleting any favicon bitmaps.
+  EXPECT_EQ(2, num_broadcasted_notifications());
 }
 
 // Test that changing the sizes that a favicon is available at from the web
 // deletes stale favicons and favicon bitmaps.
 TEST_F(HistoryBackendTest, SetFaviconsDeleteBitmaps) {
   const GURL page_url("http://www.google.com/");
   const GURL icon_url("http://www.google.com/icon");
 
   // Set |page_url| as having one favicon with two different sizes.
   IconURLSizesMap icon_url_sizes;
@@ skipping 66 matching lines @@
 
   FaviconID original_favicon_id =
       backend_->thumbnail_db_->GetFaviconIDForFaviconURL(icon_url, FAVICON,
                                                          NULL);
   EXPECT_NE(0, original_favicon_id);
   FaviconBitmap original_favicon_bitmap;
   EXPECT_TRUE(
       GetOnlyFaviconBitmap(original_favicon_id, &original_favicon_bitmap));
   EXPECT_TRUE(BitmapDataEqual('a', original_favicon_bitmap.bitmap_data));
 
-  // SetFavicons with identical data but a different bitmap.
+  EXPECT_EQ(1, num_broadcasted_notifications());
+
+  // Call SetFavicons() with completely identical data.
   std::vector<unsigned char> updated_data;
-  updated_data.push_back('b');
-  favicon_bitmap_data[0].bitmap_data =
-      base::RefCountedBytes::TakeVector(&updated_data);
+  updated_data.push_back('a');
+  favicon_bitmap_data[0].bitmap_data = new base::RefCountedBytes(updated_data);
   backend_->SetFavicons(page_url, FAVICON, favicon_bitmap_data,
                         icon_url_sizes);
 
   FaviconID updated_favicon_id =
       backend_->thumbnail_db_->GetFaviconIDForFaviconURL(icon_url, FAVICON,
                                                          NULL);
   EXPECT_NE(0, updated_favicon_id);
   FaviconBitmap updated_favicon_bitmap;
   EXPECT_TRUE(
       GetOnlyFaviconBitmap(updated_favicon_id, &updated_favicon_bitmap));
+  EXPECT_TRUE(BitmapDataEqual('a', updated_favicon_bitmap.bitmap_data));
+
+  // Because the bitmap data is byte equivalent, no notifications should have
+  // been broadcasted.
+  EXPECT_EQ(1, num_broadcasted_notifications());
+
+  // Call SetFavicons() with identical data but a different bitmap.
+  updated_data[0] = 'b';
+  favicon_bitmap_data[0].bitmap_data = new base::RefCountedBytes(updated_data);
+  backend_->SetFavicons(page_url, FAVICON, favicon_bitmap_data,
+                        icon_url_sizes);
+
+  updated_favicon_id =
+      backend_->thumbnail_db_->GetFaviconIDForFaviconURL(icon_url, FAVICON,
+                                                         NULL);
+  EXPECT_NE(0, updated_favicon_id);
+  EXPECT_TRUE(
+      GetOnlyFaviconBitmap(updated_favicon_id, &updated_favicon_bitmap));
   EXPECT_TRUE(BitmapDataEqual('b', updated_favicon_bitmap.bitmap_data));
 
-  // There should be no churn in FaviconIDs or FaviconBitmapIds.
+  // There should be no churn in FaviconIDs or FaviconBitmapIds even though
+  // the bitmap data changed.
   EXPECT_EQ(original_favicon_bitmap.icon_id, updated_favicon_bitmap.icon_id);
   EXPECT_EQ(original_favicon_bitmap.bitmap_id,
             updated_favicon_bitmap.bitmap_id);
+
+  // A notification should have been broadcasted as the favicon bitmap data has
+  // changed.
+  EXPECT_EQ(2, num_broadcasted_notifications());
 }
 
 // Test that if two pages share the same FaviconID, changing the favicon for
 // one page does not affect the other.
 TEST_F(HistoryBackendTest, SetFaviconsSameFaviconURLForTwoPages) {
   GURL icon_url("http://www.google.com/favicon.ico");
   GURL icon_url_new("http://www.google.com/favicon2.ico");
   GURL page_url1("http://www.google.com");
   GURL page_url2("http://www.google.ca");
 
@@ skipping 181 matching lines @@
   FaviconSizes favicon_sizes;
   EXPECT_TRUE(backend_->thumbnail_db_->GetFaviconHeader(
       icon_mappings[0].icon_id, NULL, NULL, &favicon_sizes));
   EXPECT_EQ(GetSizesSmallAndLarge(), favicon_sizes);
 
   FaviconBitmap favicon_bitmap;
   EXPECT_TRUE(GetOnlyFaviconBitmap(icon_mappings[0].icon_id, &favicon_bitmap));
   EXPECT_TRUE(BitmapDataEqual('a', favicon_bitmap.bitmap_data));
   EXPECT_EQ(kSmallSize, favicon_bitmap.pixel_size);
 
-  // 1) Merge favicon of the same size.
+  EXPECT_EQ(1, num_broadcasted_notifications());
+
+  // 1) Merge identical favicon bitmap.
   std::vector<unsigned char> data;
-  data.push_back('b');
+  data.push_back('a');
   scoped_refptr<base::RefCountedBytes> bitmap_data(
       new base::RefCountedBytes(data));
   backend_->MergeFavicon(page_url, icon_url1, FAVICON, bitmap_data, kSmallSize);
 
+  // All the data should stay the same and no notifications should have been
+  // sent.
+  icon_mappings.clear();
+  EXPECT_TRUE(backend_->thumbnail_db_->GetIconMappingsForPageURL(page_url,
+      &icon_mappings));
+  EXPECT_EQ(1u, icon_mappings.size());
+  EXPECT_EQ(icon_url1, icon_mappings[0].icon_url);
+
+  favicon_sizes.clear();
+  EXPECT_TRUE(backend_->thumbnail_db_->GetFaviconHeader(
+      icon_mappings[0].icon_id, NULL, NULL, &favicon_sizes));
+  EXPECT_EQ(GetSizesSmallAndLarge(), favicon_sizes);
+
+  EXPECT_TRUE(GetOnlyFaviconBitmap(icon_mappings[0].icon_id, &favicon_bitmap));
+  EXPECT_TRUE(BitmapDataEqual('a', favicon_bitmap.bitmap_data));
+  EXPECT_EQ(kSmallSize, favicon_bitmap.pixel_size);
+
+  EXPECT_EQ(1, num_broadcasted_notifications());
+
+  // 2) Merge favicon bitmap of the same size.
+  data[0] = 'b';
+  bitmap_data = new base::RefCountedBytes(data);
+  backend_->MergeFavicon(page_url, icon_url1, FAVICON, bitmap_data, kSmallSize);
+
   // The small favicon bitmap at |icon_url1| should be overwritten and favicon
   // sizes should remain unchanged.
   icon_mappings.clear();
   EXPECT_TRUE(backend_->thumbnail_db_->GetIconMappingsForPageURL(page_url,
       &icon_mappings));
   EXPECT_EQ(1u, icon_mappings.size());
   EXPECT_EQ(icon_url1, icon_mappings[0].icon_url);
 
   favicon_sizes.clear();
   EXPECT_TRUE(backend_->thumbnail_db_->GetFaviconHeader(
       icon_mappings[0].icon_id, NULL, NULL, &favicon_sizes));
   EXPECT_EQ(GetSizesSmallAndLarge(), favicon_sizes);
 
   EXPECT_TRUE(GetOnlyFaviconBitmap(icon_mappings[0].icon_id, &favicon_bitmap));
   EXPECT_TRUE(BitmapDataEqual('b', favicon_bitmap.bitmap_data));
   EXPECT_EQ(kSmallSize, favicon_bitmap.pixel_size);
 
-  // 2) Merge favicon for the same icon URL, but a pixel size for which there is
+  // 3) Merge favicon for the same icon URL, but a pixel size for which there is
   // no favicon bitmap.
   data[0] = 'c';
   bitmap_data = new base::RefCountedBytes(data);
   backend_->MergeFavicon(page_url, icon_url1, FAVICON, bitmap_data, kTinySize);
 
   // A new favicon bitmap should be created and favicon sizes should be set to
   // the default.
   icon_mappings.clear();
   EXPECT_TRUE(backend_->thumbnail_db_->GetIconMappingsForPageURL(page_url,
       &icon_mappings));
   EXPECT_EQ(1u, icon_mappings.size());
   EXPECT_EQ(icon_url1, icon_mappings[0].icon_url);
 
   favicon_sizes.clear();
   EXPECT_TRUE(backend_->thumbnail_db_->GetFaviconHeader(
       icon_mappings[0].icon_id, NULL, NULL, &favicon_sizes));
   EXPECT_EQ(GetDefaultFaviconSizes(), favicon_sizes);
 
   std::vector<FaviconBitmap> favicon_bitmaps;
   EXPECT_TRUE(GetSortedFaviconBitmaps(icon_mappings[0].icon_id,
                                       &favicon_bitmaps));
   EXPECT_TRUE(BitmapDataEqual('c', favicon_bitmaps[0].bitmap_data));
   EXPECT_EQ(kTinySize, favicon_bitmaps[0].pixel_size);
   EXPECT_TRUE(BitmapDataEqual('b', favicon_bitmaps[1].bitmap_data));
   EXPECT_EQ(kSmallSize, favicon_bitmaps[1].pixel_size);
 
-  // 3) Merge favicon for an icon URL different from the icon URLs already
+  // 4) Merge favicon for an icon URL different from the icon URLs already
   // mapped to page URL.
   data[0] = 'd';
   bitmap_data = new base::RefCountedBytes(data);
   backend_->MergeFavicon(page_url, icon_url2, FAVICON, bitmap_data, kSmallSize);
 
   // The existing favicon bitmaps should be copied over to the newly created
   // favicon at |icon_url2|. |page_url| should solely be mapped to |icon_url2|.
   icon_mappings.clear();
   EXPECT_TRUE(backend_->thumbnail_db_->GetIconMappingsForPageURL(page_url,
       &icon_mappings));
@@ skipping 826 matching lines @@
             backend_->GetFirstRecordedTimeForTest());
 
   EXPECT_FALSE(backend_->GetURL(args[0].url, &row));
   EXPECT_TRUE(backend_->GetURL(args[1].url, &row));
   EXPECT_FALSE(backend_->GetURL(args[2].url, &row));
   EXPECT_TRUE(backend_->GetURL(args[3].url, &row));
   EXPECT_FALSE(backend_->GetURL(args[4].url, &row));
 }
 
 }  // namespace history