Fix the issue that client id is not saved when upgrading the offline metadata store

components/offline_pages/offline_page_metadata_store_impl_unittest.cc

 // Copyright 2015 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 "components/offline_pages/offline_page_metadata_store_impl.h"
 
 #include <stdint.h>
 
 #include "base/bind.h"
 #include "base/files/file_path.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/test/test_simple_task_runner.h"
 #include "base/thread_task_runner_handle.h"
 #include "components/leveldb_proto/proto_database_impl.h"
 #include "components/offline_pages/offline_page_item.h"
 #include "components/offline_pages/offline_page_model.h"
 #include "components/offline_pages/proto/offline_pages.pb.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using leveldb_proto::ProtoDatabaseImpl;
 
 namespace offline_pages {
 
 namespace {
 
 const char kTestURL[] = "https://example.com";
 const ClientId kTestBookmarkId(BOOKMARK_NAMESPACE, "1234");
 const ClientId kTestBookmarkId2(BOOKMARK_NAMESPACE, "5678");
 const base::FilePath::CharType kFilePath[] =
     FILE_PATH_LITERAL("/offline_pages/example_com.mhtml");
 int64_t kFileSize = 234567;
 
+}  // namespace
+
 class OfflinePageMetadataStoreImplTest : public testing::Test {
  public:
   enum CalledCallback { NONE, LOAD, ADD, REMOVE, DESTROY };
   enum Status { STATUS_NONE, STATUS_TRUE, STATUS_FALSE };
 
   OfflinePageMetadataStoreImplTest();
   ~OfflinePageMetadataStoreImplTest() override;
 
   void TearDown() override {
     // Wait for all the pieces of the store to delete itself properly.
     PumpLoop();
   }
 
   scoped_ptr<OfflinePageMetadataStoreImpl> BuildStore();
   void PumpLoop();
 
   void LoadCallback(OfflinePageMetadataStore::LoadStatus load_status,
                     const std::vector<OfflinePageItem>& offline_pages);
   void UpdateCallback(CalledCallback called_callback, bool success);
 
   void ClearResults();
 
+  void UpdateStoreEntries(
+      OfflinePageMetadataStoreImpl* store,
+      scoped_ptr<leveldb_proto::ProtoDatabase<OfflinePageEntry>::KeyEntryVector>
+          entries_to_save);
+
  protected:
   CalledCallback last_called_callback_;
   Status last_status_;
   std::vector<OfflinePageItem> offline_pages_;
 
   base::ScopedTempDir temp_directory_;
   scoped_refptr<base::TestSimpleTaskRunner> task_runner_;
   base::ThreadTaskRunnerHandle task_runner_handle_;
 };
 
@@ skipping 38 matching lines @@
   last_called_callback_ = called_callback;
   last_status_ = status ? STATUS_TRUE : STATUS_FALSE;
 }
 
 void OfflinePageMetadataStoreImplTest::ClearResults() {
   last_called_callback_ = NONE;
   last_status_ = STATUS_NONE;
   offline_pages_.clear();
 }
 
+void OfflinePageMetadataStoreImplTest::UpdateStoreEntries(
+    OfflinePageMetadataStoreImpl* store,
+    scoped_ptr<leveldb_proto::ProtoDatabase<OfflinePageEntry>::KeyEntryVector>
+        entries_to_save) {
+  scoped_ptr<std::vector<std::string>> keys_to_remove(
+      new std::vector<std::string>());
+  store->UpdateEntries(
+      std::move(entries_to_save), std::move(keys_to_remove),
+      base::Bind(&OfflinePageMetadataStoreImplTest::UpdateCallback,
+                 base::Unretained(this), ADD));
+}
+
 // Loads empty store and makes sure that there are no offline pages stored in
 // it.
 TEST_F(OfflinePageMetadataStoreImplTest, LoadEmptyStore) {
   scoped_ptr<OfflinePageMetadataStoreImpl> store(BuildStore());
   EXPECT_EQ(LOAD, last_called_callback_);
   EXPECT_EQ(STATUS_TRUE, last_status_);
   EXPECT_EQ(0U, offline_pages_.size());
 }
 
 // Adds metadata of an offline page into a store and then opens the store
@@ skipping 220 matching lines @@
   EXPECT_EQ(offline_page.offline_id, offline_pages_[0].offline_id);
   EXPECT_EQ(offline_page.version, offline_pages_[0].version);
   EXPECT_EQ(offline_page.file_path, offline_pages_[0].file_path);
   EXPECT_EQ(offline_page.file_size, offline_pages_[0].file_size);
   EXPECT_EQ(offline_page.creation_time, offline_pages_[0].creation_time);
   EXPECT_EQ(offline_page.last_access_time, offline_pages_[0].last_access_time);
   EXPECT_EQ(offline_page.access_count, offline_pages_[0].access_count);
   EXPECT_EQ(offline_page.client_id, offline_pages_[0].client_id);
 }
 
-}  // namespace
-
 // Test that loading a store with a bad value still loads.
 // Needs to be outside of the anonymous namespace in order for FRIEND_TEST
 // to work.
 TEST_F(OfflinePageMetadataStoreImplTest, LoadCorruptedStore) {
   scoped_ptr<OfflinePageMetadataStoreImpl> store(BuildStore());
 
   // Write one ok page.
   OfflinePageItem offline_page(GURL(kTestURL), 1234LL, kTestBookmarkId,
                                base::FilePath(kFilePath), kFileSize);
   store->AddOrUpdateOfflinePage(
       offline_page,
       base::Bind(&OfflinePageMetadataStoreImplTest::UpdateCallback,
                  base::Unretained(this), ADD));
   PumpLoop();
   EXPECT_EQ(ADD, last_called_callback_);
   EXPECT_EQ(STATUS_TRUE, last_status_);
 
   // Manually write one broken page (no id)
   scoped_ptr<leveldb_proto::ProtoDatabase<OfflinePageEntry>::KeyEntryVector>
       entries_to_save(
           new leveldb_proto::ProtoDatabase<OfflinePageEntry>::KeyEntryVector());
-  scoped_ptr<std::vector<std::string>> keys_to_remove(
-      new std::vector<std::string>());
 
   OfflinePageEntry offline_page_proto;
   entries_to_save->push_back(std::make_pair("0", offline_page_proto));
 
-  store->UpdateEntries(
-      std::move(entries_to_save), std::move(keys_to_remove),
-      base::Bind(&OfflinePageMetadataStoreImplTest::UpdateCallback,
-                 base::Unretained(this), ADD));
+  UpdateStoreEntries(store.get(), std::move(entries_to_save));
   PumpLoop();
 
   EXPECT_EQ(ADD, last_called_callback_);
   EXPECT_EQ(STATUS_TRUE, last_status_);
 
   ClearResults();
 
   // Close the store first to ensure file lock is removed.
   store.reset();
   store = BuildStore();
@@ skipping 16 matching lines @@
 // Test that loading a store with nothing but bad values errors.
 // Needs to be outside of the anonymous namespace in order for FRIEND_TEST
 // to work.
 TEST_F(OfflinePageMetadataStoreImplTest, LoadTotallyCorruptedStore) {
   scoped_ptr<OfflinePageMetadataStoreImpl> store(BuildStore());
 
   // Manually write two broken pages (no id)
   scoped_ptr<leveldb_proto::ProtoDatabase<OfflinePageEntry>::KeyEntryVector>
       entries_to_save(
           new leveldb_proto::ProtoDatabase<OfflinePageEntry>::KeyEntryVector());
-  scoped_ptr<std::vector<std::string>> keys_to_remove(
-      new std::vector<std::string>());
 
   OfflinePageEntry offline_page_proto;
   entries_to_save->push_back(std::make_pair("0", offline_page_proto));
   entries_to_save->push_back(std::make_pair("1", offline_page_proto));
 
-  store->UpdateEntries(
-      std::move(entries_to_save), std::move(keys_to_remove),
-      base::Bind(&OfflinePageMetadataStoreImplTest::UpdateCallback,
-                 base::Unretained(this), ADD));
+  UpdateStoreEntries(store.get(), std::move(entries_to_save));;
   PumpLoop();
 
   EXPECT_EQ(ADD, last_called_callback_);
   EXPECT_EQ(STATUS_TRUE, last_status_);
 
   ClearResults();
 
   // Close the store first to ensure file lock is removed.
   store.reset();
   store = BuildStore();
   PumpLoop();
 
   // One of the pages was busted, so only expect one page.
   EXPECT_EQ(LOAD, last_called_callback_);
   EXPECT_EQ(STATUS_FALSE, last_status_);
 }
 
+TEST_F(OfflinePageMetadataStoreImplTest, UpgradeStoreFromBookmarkIdToClientId) {
+  scoped_ptr<OfflinePageMetadataStoreImpl> store(BuildStore());
+
+  // Manually write a page referring to legacy bookmark id.
+  scoped_ptr<leveldb_proto::ProtoDatabase<OfflinePageEntry>::KeyEntryVector>
+      entries_to_save(
+          new leveldb_proto::ProtoDatabase<OfflinePageEntry>::KeyEntryVector());
+
+  OfflinePageEntry offline_page_proto;
+  offline_page_proto.set_deprecated_bookmark_id(1LL);
+  offline_page_proto.set_version(1);
+  offline_page_proto.set_url(kTestURL);
+  offline_page_proto.set_file_path("/foo/bar");
+  entries_to_save->push_back(std::make_pair("1", offline_page_proto));
+
+  UpdateStoreEntries(store.get(), std::move(entries_to_save));
+  PumpLoop();
+
+  EXPECT_EQ(ADD, last_called_callback_);
+  EXPECT_EQ(STATUS_TRUE, last_status_);
+
+  ClearResults();
+
+  // Close the store first to ensure file lock is removed.
+  store.reset();
+  store = BuildStore();
+  PumpLoop();
+
+  // The page should be upgraded with new Client ID format.
+  EXPECT_EQ(LOAD, last_called_callback_);
+  EXPECT_EQ(STATUS_TRUE, last_status_);
+  EXPECT_EQ(1U, offline_pages_.size());
+  EXPECT_TRUE(offline_pages_[0].offline_id != 0);
+  EXPECT_EQ(offline_pages::BOOKMARK_NAMESPACE,
+            offline_pages_[0].client_id.name_space);
+  EXPECT_EQ(base::Int64ToString(offline_page_proto.deprecated_bookmark_id()),
+            offline_pages_[0].client_id.id);
+  EXPECT_EQ(GURL(kTestURL), offline_pages_[0].url);
+  EXPECT_EQ(offline_page_proto.version(), offline_pages_[0].version);
+  EXPECT_EQ(offline_page_proto.file_path(),
+            offline_pages_[0].file_path.MaybeAsASCII());
+}
+
 }  // namespace offline_pages