IDBObserver: Lifetime Management: Adding Observer

content/browser/indexed_db/indexed_db_transaction_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 "content/browser/indexed_db/indexed_db_transaction.h"
 
 #include <stdint.h>
 
 #include "base/bind.h"
 #include "base/logging.h"
 #include "base/macros.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "base/strings/utf_string_conversions.h"
+#include "content/browser/indexed_db/indexed_db_connection.h"
 #include "content/browser/indexed_db/indexed_db_fake_backing_store.h"
 #include "content/browser/indexed_db/mock_indexed_db_database_callbacks.h"
 #include "content/browser/indexed_db/mock_indexed_db_factory.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace content {
 
 class AbortObserver {
  public:
   AbortObserver() : abort_task_called_(false) {}
@@ skipping 55 matching lines @@
   IndexedDBTransactionTestMode() {}
  private:
   DISALLOW_COPY_AND_ASSIGN(IndexedDBTransactionTestMode);
 };
 
 TEST_F(IndexedDBTransactionTest, Timeout) {
   const int64_t id = 0;
   const std::set<int64_t> scope;
   const leveldb::Status commit_success = leveldb::Status::OK();
   scoped_refptr<IndexedDBTransaction> transaction = new IndexedDBTransaction(
-      id,
-      new MockIndexedDBDatabaseCallbacks(),
-      scope,
-      blink::WebIDBTransactionModeReadWrite,
-      db_.get(),
+      id, new IndexedDBConnection(db_, new MockIndexedDBDatabaseCallbacks()),

[Marijn Kruisselbrink, 2016/06/30 00:17:25]

here too I believe you're leaking IndexedDBConnection instances. You need to
make sure that every IndexedDBConnection you create is also actually destroyed
at some point.

[palakj1, 2016/06/30 01:07:04]

Done.

+      scope, blink::WebIDBTransactionModeReadWrite,
       new IndexedDBFakeBackingStore::FakeTransaction(commit_success));
   db_->TransactionCreated(transaction.get());
 
   // No conflicting transactions, so coordinator will start it immediately:
   EXPECT_EQ(IndexedDBTransaction::STARTED, transaction->state());
   EXPECT_FALSE(transaction->IsTimeoutTimerRunning());
   EXPECT_EQ(0, transaction->diagnostics().tasks_scheduled);
   EXPECT_EQ(0, transaction->diagnostics().tasks_completed);
 
   // Schedule a task - timer won't be started until it's processed.
@@ skipping 19 matching lines @@
   EXPECT_FALSE(transaction->IsTimeoutTimerRunning());
   EXPECT_EQ(1, transaction->diagnostics().tasks_scheduled);
   EXPECT_EQ(1, transaction->diagnostics().tasks_completed);
 }
 
 TEST_F(IndexedDBTransactionTest, NoTimeoutReadOnly) {
   const int64_t id = 0;
   const std::set<int64_t> scope;
   const leveldb::Status commit_success = leveldb::Status::OK();
   scoped_refptr<IndexedDBTransaction> transaction = new IndexedDBTransaction(
-      id,
-      new MockIndexedDBDatabaseCallbacks(),
-      scope,
-      blink::WebIDBTransactionModeReadOnly,
-      db_.get(),
+      id, new IndexedDBConnection(db_, new MockIndexedDBDatabaseCallbacks()),
+      scope, blink::WebIDBTransactionModeReadOnly,
       new IndexedDBFakeBackingStore::FakeTransaction(commit_success));
   db_->TransactionCreated(transaction.get());
 
   // No conflicting transactions, so coordinator will start it immediately:
   EXPECT_EQ(IndexedDBTransaction::STARTED, transaction->state());
   EXPECT_FALSE(transaction->IsTimeoutTimerRunning());
 
   // Schedule a task - timer won't be started until it's processed.
   transaction->ScheduleTask(base::Bind(
       &IndexedDBTransactionTest::DummyOperation, base::Unretained(this)));
   EXPECT_FALSE(transaction->IsTimeoutTimerRunning());
 
   // Transaction is read-only, so no need to time it out.
   RunPostedTasks();
   EXPECT_FALSE(transaction->IsTimeoutTimerRunning());
 
   // Clean up to avoid leaks.
   transaction->Abort();
   EXPECT_EQ(IndexedDBTransaction::FINISHED, transaction->state());
   EXPECT_FALSE(transaction->IsTimeoutTimerRunning());
 }
 
 TEST_P(IndexedDBTransactionTestMode, ScheduleNormalTask) {
   const int64_t id = 0;
   const std::set<int64_t> scope;
   const leveldb::Status commit_success = leveldb::Status::OK();
   scoped_refptr<IndexedDBTransaction> transaction = new IndexedDBTransaction(
-      id,
-      new MockIndexedDBDatabaseCallbacks(),
-      scope,
-      GetParam(),
-      db_.get(),
+      id, new IndexedDBConnection(db_, new MockIndexedDBDatabaseCallbacks()),
+      scope, GetParam(),
       new IndexedDBFakeBackingStore::FakeTransaction(commit_success));
 
   EXPECT_FALSE(transaction->HasPendingTasks());
   EXPECT_TRUE(transaction->IsTaskQueueEmpty());
   EXPECT_TRUE(transaction->task_queue_.empty());
   EXPECT_TRUE(transaction->preemptive_task_queue_.empty());
   EXPECT_EQ(0, transaction->diagnostics().tasks_scheduled);
   EXPECT_EQ(0, transaction->diagnostics().tasks_completed);
 
   db_->TransactionCreated(transaction.get());
@@ skipping 37 matching lines @@
   EXPECT_TRUE(transaction->preemptive_task_queue_.empty());
   EXPECT_EQ(1, transaction->diagnostics().tasks_scheduled);
   EXPECT_EQ(1, transaction->diagnostics().tasks_completed);
 }
 
 TEST_F(IndexedDBTransactionTest, SchedulePreemptiveTask) {
   const int64_t id = 0;
   const std::set<int64_t> scope;
   const leveldb::Status commit_failure = leveldb::Status::Corruption("Ouch.");
   scoped_refptr<IndexedDBTransaction> transaction = new IndexedDBTransaction(
-      id,
-      new MockIndexedDBDatabaseCallbacks(),
-      scope,
-      blink::WebIDBTransactionModeVersionChange,
-      db_.get(),
+      id, new IndexedDBConnection(db_, new MockIndexedDBDatabaseCallbacks()),
+      scope, blink::WebIDBTransactionModeVersionChange,
       new IndexedDBFakeBackingStore::FakeTransaction(commit_failure));
 
   EXPECT_FALSE(transaction->HasPendingTasks());
   EXPECT_TRUE(transaction->IsTaskQueueEmpty());
   EXPECT_TRUE(transaction->task_queue_.empty());
   EXPECT_TRUE(transaction->preemptive_task_queue_.empty());
   EXPECT_EQ(0, transaction->diagnostics().tasks_scheduled);
   EXPECT_EQ(0, transaction->diagnostics().tasks_completed);
 
   db_->TransactionCreated(transaction.get());
@@ skipping 36 matching lines @@
   EXPECT_TRUE(transaction->preemptive_task_queue_.empty());
   EXPECT_EQ(0, transaction->diagnostics().tasks_scheduled);
   EXPECT_EQ(0, transaction->diagnostics().tasks_completed);
 }
 
 TEST_P(IndexedDBTransactionTestMode, AbortTasks) {
   const int64_t id = 0;
   const std::set<int64_t> scope;
   const leveldb::Status commit_failure = leveldb::Status::Corruption("Ouch.");
   scoped_refptr<IndexedDBTransaction> transaction = new IndexedDBTransaction(
-      id,
-      new MockIndexedDBDatabaseCallbacks(),
-      scope,
-      GetParam(),
-      db_.get(),
+      id, new IndexedDBConnection(db_, new MockIndexedDBDatabaseCallbacks()),
+      scope, GetParam(),
       new IndexedDBFakeBackingStore::FakeTransaction(commit_failure));
   db_->TransactionCreated(transaction.get());
 
   AbortObserver observer;
   transaction->ScheduleTask(
       base::Bind(&IndexedDBTransactionTest::AbortableOperation,
                  base::Unretained(this),
                  base::Unretained(&observer)));
 
   // Pump the message loop so that the transaction completes all pending tasks,
   // otherwise it will defer the commit.
   base::RunLoop().RunUntilIdle();
 
   EXPECT_FALSE(observer.abort_task_called());
   transaction->Commit();
   EXPECT_TRUE(observer.abort_task_called());
   EXPECT_EQ(IndexedDBTransaction::FINISHED, transaction->state());
   EXPECT_FALSE(transaction->IsTimeoutTimerRunning());
 }
 
 TEST_P(IndexedDBTransactionTestMode, AbortPreemptive) {
   const int64_t id = 0;
   const std::set<int64_t> scope;
   const leveldb::Status commit_success = leveldb::Status::OK();
   scoped_refptr<IndexedDBTransaction> transaction = new IndexedDBTransaction(
-      id,
-      new MockIndexedDBDatabaseCallbacks(),
-      scope,
-      GetParam(),
-      db_.get(),
+      id, new IndexedDBConnection(db_, new MockIndexedDBDatabaseCallbacks()),
+      scope, GetParam(),
       new IndexedDBFakeBackingStore::FakeTransaction(commit_success));
   db_->TransactionCreated(transaction.get());
 
   // No conflicting transactions, so coordinator will start it immediately:
   EXPECT_EQ(IndexedDBTransaction::STARTED, transaction->state());
   EXPECT_FALSE(transaction->IsTimeoutTimerRunning());
 
   transaction->ScheduleTask(
       blink::WebIDBTaskTypePreemptive,
       base::Bind(&IndexedDBTransactionTest::DummyOperation,
@@ skipping 21 matching lines @@
   // This task will be ignored.
   transaction->ScheduleTask(base::Bind(
       &IndexedDBTransactionTest::DummyOperation, base::Unretained(this)));
   EXPECT_EQ(IndexedDBTransaction::FINISHED, transaction->state());
   EXPECT_FALSE(transaction->IsTimeoutTimerRunning());
   EXPECT_FALSE(transaction->HasPendingTasks());
   EXPECT_EQ(transaction->diagnostics().tasks_completed,
             transaction->diagnostics().tasks_scheduled);
 }
 
+TEST_F(IndexedDBTransactionTest, IndexedDBObserver) {
+  const int64_t id = 0;
+  const std::set<int64_t> scope;
+  const leveldb::Status commit_success = leveldb::Status::OK();
+  IndexedDBConnection* connection =

[Marijn Kruisselbrink, 2016/06/30 00:17:25]

probably make this a std::unique_ptr<IndexedDBConnection> to ensure it doesn't
leak.

[palakj1, 2016/06/30 01:07:04]

Done.

+      new IndexedDBConnection(db_, new MockIndexedDBDatabaseCallbacks());
+
+  scoped_refptr<IndexedDBTransaction> transaction = new IndexedDBTransaction(
+      id, connection, scope, blink::WebIDBTransactionModeReadWrite,
+      new IndexedDBFakeBackingStore::FakeTransaction(commit_success));
+  db_->TransactionCreated(transaction.get());
+
+  EXPECT_EQ(0UL, transaction->pending_observers_.size());
+  EXPECT_EQ(0UL, connection->active_observers().size());
+
+  // Add observers to pending observer list.
+  const int32_t observer_id1 = 1, observer_id2 = 2;
+  transaction->AddPendingObserver(observer_id1);
+  transaction->AddPendingObserver(observer_id2);
+  EXPECT_EQ(2UL, transaction->pending_observers_.size());
+  EXPECT_EQ(0UL, connection->active_observers().size());
+
+  // Before commit, observer would be in pending list of transaction.
+  std::vector<int32_t> observer_to_remove1 = {observer_id1};
+  connection->RemoveObservers(observer_to_remove1);
+  EXPECT_EQ(1UL, transaction->pending_observers_.size());
+  EXPECT_EQ(0UL, connection->active_observers().size());
+
+  // After commit, observer moved to connection's active observer.
+  transaction->Commit();
+  EXPECT_EQ(0UL, transaction->pending_observers_.size());
+  EXPECT_EQ(1UL, connection->active_observers().size());
+
+  // Observer does not exist, so no change to active_observers.
+  connection->RemoveObservers(observer_to_remove1);
+  EXPECT_EQ(1UL, connection->active_observers().size());
+
+  // Observer removed from connection's active observer.
+  std::vector<int32_t> observer_to_remove2 = {observer_id2};
+  connection->RemoveObservers(observer_to_remove2);
+  EXPECT_EQ(0UL, connection->active_observers().size());
+}
+
 static const blink::WebIDBTransactionMode kTestModes[] = {
     blink::WebIDBTransactionModeReadOnly, blink::WebIDBTransactionModeReadWrite,
     blink::WebIDBTransactionModeVersionChange};
 
 INSTANTIATE_TEST_CASE_P(IndexedDBTransactions,
                         IndexedDBTransactionTestMode,
                         ::testing::ValuesIn(kTestModes));
 
 }  // namespace content