Use a two-part data format version in IndexedDB metadata.

content/browser/indexed_db/indexed_db_factory_unittest.cc

 // 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.
 
 #include <stdint.h>
 #include <utility>
 
 #include "base/files/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/logging.h"
@@ skipping 25 matching lines @@
 class MockIDBFactory : public IndexedDBFactoryImpl {
  public:
   explicit MockIDBFactory(IndexedDBContextImpl* context)
       : IndexedDBFactoryImpl(context) {}
   scoped_refptr<IndexedDBBackingStore> TestOpenBackingStore(
       const Origin& origin,
       const base::FilePath& data_directory) {
     IndexedDBDataLossInfo data_loss_info;
     bool disk_full;
     leveldb::Status s;
-    scoped_refptr<IndexedDBBackingStore> backing_store =
-        OpenBackingStore(origin, data_directory, nullptr /* request_context */,
-                         &data_loss_info, &disk_full, &s);
+    scoped_refptr<IndexedDBBackingStore> backing_store = OpenBackingStore(
+        origin, data_directory, IndexedDBDataFormatVersion(),
+        nullptr /* request_context */, &data_loss_info, &disk_full, &s);
     EXPECT_EQ(blink::WebIDBDataLossNone, data_loss_info.status);
     return backing_store;
   }
 
   void TestCloseBackingStore(IndexedDBBackingStore* backing_store) {
     CloseBackingStore(backing_store->origin());
   }
 
   void TestReleaseBackingStore(IndexedDBBackingStore* backing_store,
                                bool immediate) {
     ReleaseBackingStore(backing_store->origin(), immediate);
   }
 
  private:
   ~MockIDBFactory() override {}
 
   DISALLOW_COPY_AND_ASSIGN(MockIDBFactory);
 };
 
 }  // namespace
 
 class IndexedDBFactoryTest : public testing::Test {
  public:
-  IndexedDBFactoryTest() {
+  void SetUp() override {
+    ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
     task_runner_ = new base::TestSimpleTaskRunner();
     quota_manager_proxy_ = new MockQuotaManagerProxy(nullptr, nullptr);
     context_ = new IndexedDBContextImpl(
-        base::FilePath(), nullptr /* special_storage_policy */,
+        temp_dir_.GetPath(), nullptr /* special_storage_policy */,
         quota_manager_proxy_.get(), task_runner_.get());
     idb_factory_ = new MockIDBFactory(context_.get());
   }
-  ~IndexedDBFactoryTest() override {
+
+  void TearDown() override {
     quota_manager_proxy_->SimulateQuotaManagerDestroyed();
   }
 
  protected:
+  IndexedDBFactoryTest() {}
   MockIDBFactory* factory() const { return idb_factory_.get(); }
   void clear_factory() { idb_factory_ = nullptr; }
   IndexedDBContextImpl* context() const { return context_.get(); }
 
  private:
+  base::ScopedTempDir temp_dir_;
   scoped_refptr<base::TestSimpleTaskRunner> task_runner_;
   scoped_refptr<IndexedDBContextImpl> context_;
   scoped_refptr<MockIDBFactory> idb_factory_;
   scoped_refptr<MockQuotaManagerProxy> quota_manager_proxy_;
   TestBrowserThreadBundle thread_bundle_;
 
   DISALLOW_COPY_AND_ASSIGN(IndexedDBFactoryTest);
 };
 
 TEST_F(IndexedDBFactoryTest, BackingStoreLifetime) {
@@ skipping 106 matching lines @@
 class DiskFullFactory : public IndexedDBFactoryImpl {
  public:
   explicit DiskFullFactory(IndexedDBContextImpl* context)
       : IndexedDBFactoryImpl(context) {}
 
  private:
   ~DiskFullFactory() override {}
   scoped_refptr<IndexedDBBackingStore> OpenBackingStore(
       const Origin& origin,
       const base::FilePath& data_directory,
+      const IndexedDBDataFormatVersion& data_format_version,
       scoped_refptr<net::URLRequestContextGetter> request_context_getter,
       IndexedDBDataLossInfo* data_loss_info,
       bool* disk_full,
       leveldb::Status* s) override {
     *disk_full = true;
     *s = leveldb::Status::IOError("Disk is full");
     return scoped_refptr<IndexedDBBackingStore>();
   }
 
   DISALLOW_COPY_AND_ASSIGN(DiskFullFactory);
@@ skipping 26 matching lines @@
   scoped_refptr<LookingForQuotaErrorMockCallbacks> callbacks =
       new LookingForQuotaErrorMockCallbacks;
   scoped_refptr<IndexedDBDatabaseCallbacks> dummy_database_callbacks =
       new IndexedDBDatabaseCallbacks(nullptr, nullptr);
   const base::string16 name(ASCIIToUTF16("name"));
   std::unique_ptr<IndexedDBPendingConnection> connection(
       base::MakeUnique<IndexedDBPendingConnection>(
           callbacks, dummy_database_callbacks, 0 /* child_process_id */,
           2 /* transaction_id */, 1 /* version */));
   factory->Open(name, std::move(connection), nullptr /* request_context */,
-                origin, temp_directory.GetPath());
+                origin, temp_directory.GetPath(), IndexedDBDataFormatVersion());
   EXPECT_TRUE(callbacks->error_called());
 }
 
 TEST_F(IndexedDBFactoryTest, BackingStoreReleasedOnForcedClose) {
   const Origin origin(GURL("http://localhost:81"));
 
   base::ScopedTempDir temp_directory;
   ASSERT_TRUE(temp_directory.CreateUniqueTempDir());
 
   scoped_refptr<MockIndexedDBCallbacks> callbacks(new MockIndexedDBCallbacks());
   scoped_refptr<MockIndexedDBDatabaseCallbacks> db_callbacks(
       new MockIndexedDBDatabaseCallbacks());
   const int64_t transaction_id = 1;
   std::unique_ptr<IndexedDBPendingConnection> connection(
       base::MakeUnique<IndexedDBPendingConnection>(
           callbacks, db_callbacks, 0 /* child_process_id */, transaction_id,
           IndexedDBDatabaseMetadata::DEFAULT_VERSION));
   factory()->Open(ASCIIToUTF16("db"), std::move(connection),
                   nullptr /* request_context */, origin,
-                  temp_directory.GetPath());
+                  temp_directory.GetPath(), IndexedDBDataFormatVersion());
 
   EXPECT_TRUE(callbacks->connection());
 
   EXPECT_TRUE(factory()->IsBackingStoreOpen(origin));
   EXPECT_FALSE(factory()->IsBackingStorePendingClose(origin));
 
   callbacks->connection()->ForceClose();
 
   EXPECT_FALSE(factory()->IsBackingStoreOpen(origin));
   EXPECT_FALSE(factory()->IsBackingStorePendingClose(origin));
 }
 
 TEST_F(IndexedDBFactoryTest, BackingStoreReleaseDelayedOnClose) {
   const Origin origin(GURL("http://localhost:81"));
 
   base::ScopedTempDir temp_directory;
   ASSERT_TRUE(temp_directory.CreateUniqueTempDir());
 
   scoped_refptr<MockIndexedDBCallbacks> callbacks(new MockIndexedDBCallbacks());
   scoped_refptr<MockIndexedDBDatabaseCallbacks> db_callbacks(
       new MockIndexedDBDatabaseCallbacks());
   const int64_t transaction_id = 1;
   std::unique_ptr<IndexedDBPendingConnection> connection(
       base::MakeUnique<IndexedDBPendingConnection>(
           callbacks, db_callbacks, 0 /* child_process_id */, transaction_id,
           IndexedDBDatabaseMetadata::DEFAULT_VERSION));
   factory()->Open(ASCIIToUTF16("db"), std::move(connection),
                   nullptr /* request_context */, origin,
-                  temp_directory.GetPath());
+                  temp_directory.GetPath(), IndexedDBDataFormatVersion());
 
   EXPECT_TRUE(callbacks->connection());
   IndexedDBBackingStore* store =
       callbacks->connection()->database()->backing_store();
   EXPECT_FALSE(store->HasOneRef());  // Factory and database.
 
   EXPECT_TRUE(factory()->IsBackingStoreOpen(origin));
   callbacks->connection()->Close();
   EXPECT_TRUE(store->HasOneRef());  // Factory.
   EXPECT_TRUE(factory()->IsBackingStoreOpen(origin));
@@ skipping 16 matching lines @@
   base::ScopedTempDir temp_directory;
   ASSERT_TRUE(temp_directory.CreateUniqueTempDir());
 
   EXPECT_FALSE(factory()->IsBackingStoreOpen(origin));
 
   const bool expect_connection = false;
   scoped_refptr<MockIndexedDBCallbacks> callbacks(
       new MockIndexedDBCallbacks(expect_connection));
   factory()->DeleteDatabase(ASCIIToUTF16("db"), nullptr /* request_context */,
                             callbacks, origin, temp_directory.GetPath(),
+                            IndexedDBDataFormatVersion(),
                             false /* force_close */);
 
   EXPECT_TRUE(factory()->IsBackingStoreOpen(origin));
   EXPECT_TRUE(factory()->IsBackingStorePendingClose(origin));
 
   // Now simulate shutdown, which should stop the timer.
   factory()->ContextDestroyed();
 
   EXPECT_FALSE(factory()->IsBackingStoreOpen(origin));
   EXPECT_FALSE(factory()->IsBackingStorePendingClose(origin));
 }
 
 TEST_F(IndexedDBFactoryTest, GetDatabaseNamesClosesBackingStore) {
   const Origin origin(GURL("http://localhost:81"));
 
   base::ScopedTempDir temp_directory;
   ASSERT_TRUE(temp_directory.CreateUniqueTempDir());
 
   EXPECT_FALSE(factory()->IsBackingStoreOpen(origin));
 
   const bool expect_connection = false;
   scoped_refptr<MockIndexedDBCallbacks> callbacks(
       new MockIndexedDBCallbacks(expect_connection));
   factory()->GetDatabaseNames(callbacks, origin, temp_directory.GetPath(),
+                              IndexedDBDataFormatVersion(),
                               nullptr /* request_context */);
 
   EXPECT_TRUE(factory()->IsBackingStoreOpen(origin));
   EXPECT_TRUE(factory()->IsBackingStorePendingClose(origin));
 
   // Now simulate shutdown, which should stop the timer.
   factory()->ContextDestroyed();
 
   EXPECT_FALSE(factory()->IsBackingStoreOpen(origin));
   EXPECT_FALSE(factory()->IsBackingStorePendingClose(origin));
 }
 
 TEST_F(IndexedDBFactoryTest, ForceCloseReleasesBackingStore) {
   const Origin origin(GURL("http://localhost:81"));
 
   base::ScopedTempDir temp_directory;
   ASSERT_TRUE(temp_directory.CreateUniqueTempDir());
 
   scoped_refptr<MockIndexedDBCallbacks> callbacks(new MockIndexedDBCallbacks());
   scoped_refptr<MockIndexedDBDatabaseCallbacks> db_callbacks(
       new MockIndexedDBDatabaseCallbacks());
   const int64_t transaction_id = 1;
   std::unique_ptr<IndexedDBPendingConnection> connection(
       base::MakeUnique<IndexedDBPendingConnection>(
           callbacks, db_callbacks, 0 /* child_process_id */, transaction_id,
           IndexedDBDatabaseMetadata::DEFAULT_VERSION));
   factory()->Open(ASCIIToUTF16("db"), std::move(connection),
                   nullptr /* request_context */, origin,
-                  temp_directory.GetPath());
+                  temp_directory.GetPath(), IndexedDBDataFormatVersion());
 
   EXPECT_TRUE(callbacks->connection());
   EXPECT_TRUE(factory()->IsBackingStoreOpen(origin));
   EXPECT_FALSE(factory()->IsBackingStorePendingClose(origin));
 
   callbacks->connection()->Close();
 
   EXPECT_TRUE(factory()->IsBackingStoreOpen(origin));
   EXPECT_TRUE(factory()->IsBackingStorePendingClose(origin));
 
@@ skipping 61 matching lines @@
   // Open at version 2, then close.
   {
     scoped_refptr<UpgradeNeededCallbacks> callbacks(
         new UpgradeNeededCallbacks());
     std::unique_ptr<IndexedDBPendingConnection> connection(
         base::MakeUnique<IndexedDBPendingConnection>(
             callbacks, db_callbacks, 0 /* child_process_id */, transaction_id,
             db_version));
     factory()->Open(db_name, std::move(connection),
                     nullptr /* request_context */, origin,
-                    temp_directory.GetPath());
+                    temp_directory.GetPath(), IndexedDBDataFormatVersion());
     EXPECT_TRUE(factory()->IsDatabaseOpen(origin, db_name));
 
     // Pump the message loop so the upgrade transaction can run.
     base::RunLoop().RunUntilIdle();
     EXPECT_TRUE(callbacks->connection());
     callbacks->connection()->database()->Commit(
         callbacks->connection()->GetTransaction(transaction_id));
 
     callbacks->connection()->Close();
     EXPECT_FALSE(factory()->IsDatabaseOpen(origin, db_name));
   }
 
   // Open at version < 2, which will fail; ensure factory doesn't retain
   // the database object.
   {
     scoped_refptr<ErrorCallbacks> callbacks(new ErrorCallbacks());
     std::unique_ptr<IndexedDBPendingConnection> connection(
         base::MakeUnique<IndexedDBPendingConnection>(
             callbacks, db_callbacks, 0 /* child_process_id */, transaction_id,
             db_version - 1));
     factory()->Open(db_name, std::move(connection),
                     nullptr /* request_context */, origin,
-                    temp_directory.GetPath());
+                    temp_directory.GetPath(), IndexedDBDataFormatVersion());
     EXPECT_TRUE(callbacks->saw_error());
     EXPECT_FALSE(factory()->IsDatabaseOpen(origin, db_name));
   }
 
   // Terminate all pending-close timers.
   factory()->ForceClose(origin);
 }
+namespace {
+
+class DataLossCallbacks final : public MockIndexedDBCallbacks {
+ public:
+  blink::WebIDBDataLoss data_loss() const { return data_loss_; }
+  void OnSuccess(std::unique_ptr<IndexedDBConnection> connection,
+                 const IndexedDBDatabaseMetadata& metadata) override {
+    if (!connection_)
+      connection_ = std::move(connection);
+  }
+  void OnError(const IndexedDBDatabaseError& error) final {
+    ADD_FAILURE() << "Unexpected IDB error: " << error.message();
+  }
+  void OnUpgradeNeeded(int64_t old_version,
+                       std::unique_ptr<IndexedDBConnection> connection,
+                       const content::IndexedDBDatabaseMetadata& metadata,
+                       const IndexedDBDataLossInfo& data_loss) final {
+    connection_ = std::move(connection);
+    data_loss_ = data_loss.status;
+  }
+
+ private:
+  ~DataLossCallbacks() final {}
+  blink::WebIDBDataLoss data_loss_ = blink::WebIDBDataLossNone;
+};
+
+TEST_F(IndexedDBFactoryTest, DataFormatVersion) {
+  auto try_open = [this](const Origin& origin,
+                         const IndexedDBDataFormatVersion& version) {
+    auto db_callbacks = make_scoped_refptr(new MockIndexedDBDatabaseCallbacks);
+    auto callbacks = make_scoped_refptr(new DataLossCallbacks);
+    const int64_t transaction_id = 1;
+    factory()->Open(ASCIIToUTF16("test_db"),
+                    base::MakeUnique<IndexedDBPendingConnection>(
+                        callbacks, db_callbacks, 0 /* child_process_id */,
+                        transaction_id, 1 /* version */),
+                    nullptr /* request_context */, origin,
+                    context()->data_path(), version);
+    base::RunLoop().RunUntilIdle();
+    auto* connection = callbacks->connection();
+    EXPECT_TRUE(connection);
+    connection->database()->Commit(connection->GetTransaction(transaction_id));
+    connection->Close();
+    factory()->ForceClose(origin);
+    return callbacks->data_loss();
+  };
+
+  using blink::WebIDBDataLossNone;
+  using blink::WebIDBDataLossTotal;
+  const struct {
+    const char* origin;
+    IndexedDBDataFormatVersion open_version_1;
+    IndexedDBDataFormatVersion open_version_2;
+    blink::WebIDBDataLoss expected_data_loss;
+  } kTestCases[] = {
+      {"http://same-version.com/", {3, 4}, {3, 4}, WebIDBDataLossNone},
+      {"http://blink-upgrade.com/", {3, 4}, {3, 5}, WebIDBDataLossNone},
+      {"http://v8-upgrade.com/", {3, 4}, {4, 4}, WebIDBDataLossNone},
+      {"http://both-upgrade.com/", {3, 4}, {4, 5}, WebIDBDataLossNone},
+      {"http://blink-downgrade.com/", {3, 4}, {3, 3}, WebIDBDataLossTotal},
+      {"http://v8-downgrade.com/", {3, 4}, {2, 4}, WebIDBDataLossTotal},
+      {"http://both-downgrade.com/", {3, 4}, {2, 3}, WebIDBDataLossTotal},
+      {"http://v8-up-blink-down.com/", {3, 4}, {4, 2}, WebIDBDataLossTotal},
+      {"http://v8-down-blink-up.com/", {3, 4}, {2, 5}, WebIDBDataLossTotal},
+  };
+  for (const auto& test : kTestCases) {
+    SCOPED_TRACE(test.origin);
+    const Origin origin(GURL(test.origin));
+    ASSERT_EQ(WebIDBDataLossNone, try_open(origin, test.open_version_1));
+    EXPECT_EQ(test.expected_data_loss, try_open(origin, test.open_version_2));
+  }
+}
+
+}  // namespace
 
 }  // namespace content