IDBObserver: Lifetime Management: Adding Observer

content/child/indexed_db/indexed_db_dispatcher.h

 // 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.
 
 #ifndef CONTENT_CHILD_INDEXED_DB_INDEXED_DB_DISPATCHER_H_
 #define CONTENT_CHILD_INDEXED_DB_INDEXED_DB_DISPATCHER_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/gtest_prod_util.h"
 #include "base/id_map.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/strings/nullable_string16.h"
 #include "content/common/content_export.h"
 #include "content/common/indexed_db/indexed_db_constants.h"
 #include "content/public/child/worker_thread.h"
 #include "ipc/ipc_sync_message_filter.h"
 #include "third_party/WebKit/public/platform/WebBlobInfo.h"
 #include "third_party/WebKit/public/platform/modules/indexeddb/WebIDBCallbacks.h"
 #include "third_party/WebKit/public/platform/modules/indexeddb/WebIDBDatabaseCallbacks.h"
+#include "third_party/WebKit/public/platform/modules/indexeddb/WebIDBObserver.h"
 #include "third_party/WebKit/public/platform/modules/indexeddb/WebIDBTypes.h"
 #include "url/origin.h"
 
 struct IndexedDBDatabaseMetadata;
 struct IndexedDBMsg_CallbacksSuccessCursorContinue_Params;
 struct IndexedDBMsg_CallbacksSuccessCursorPrefetch_Params;
 struct IndexedDBMsg_CallbacksSuccessIDBCursor_Params;
 struct IndexedDBMsg_CallbacksSuccessArray_Params;
 struct IndexedDBMsg_CallbacksSuccessValue_Params;
 struct IndexedDBMsg_CallbacksUpgradeNeeded_Params;
@@ skipping 30 matching lines @@
   void WillStopCurrentWorkerThread() override;
 
   static blink::WebIDBMetadata ConvertMetadata(
       const IndexedDBDatabaseMetadata& idb_metadata);
 
   void OnMessageReceived(const IPC::Message& msg);
 
   // This method is virtual so it can be overridden in unit tests.
   virtual bool Send(IPC::Message* msg);
 
+  int32_t AddIDBObserver(int32_t ipc_database_id,
+                         int64_t transaction_id,
+                         blink::WebIDBObserver* observer);
+
+  /* The |observer_ids_to_remove| are observing the |ipc_database_id|.

[dmurph, 2016/06/28 18:53:50]

Can you change this to all single-line comments to match the rest of the file?

[palakj1, 2016/06/29 23:02:41]

Done.

+  We remove our references to these observer object, and send an IPC to remove
+  the observers in the backend. */
+  void RemoveIDBObserversFromDatabase(
+      int32_t ipc_database_id,
+      const std::vector<int32_t>& observer_ids_to_remove);
+
+  // Removes observers from our local map observers_ . No IPC message generated.
+  void RemoveIDBObservers(const std::set<int32_t>& observer_ids_to_remove);
+
   void RequestIDBFactoryGetDatabaseNames(blink::WebIDBCallbacks* callbacks,
                                          const url::Origin& origin);
 
   void RequestIDBFactoryOpen(const base::string16& name,
                              int64_t version,
                              int64_t transaction_id,
                              blink::WebIDBCallbacks* callbacks,
                              blink::WebIDBDatabaseCallbacks* database_callbacks,
                              const url::Origin& origin);
 
@@ skipping 164 matching lines @@
   void ResetCursorPrefetchCaches(int64_t transaction_id,
                                  int32_t ipc_exception_cursor_id);
 
   scoped_refptr<ThreadSafeSender> thread_safe_sender_;
 
   // Maximum size (in bytes) of value/key pair allowed for put requests. Any
   // requests larger than this size will be rejected.
   // Used by unit tests to exercise behavior without allocating huge chunks
   // of memory.
   size_t max_put_value_size_ = kMaxIDBMessageSizeInBytes;
-

[Marijn Kruisselbrink, 2016/06/28 18:58:31]

nit: don't remove empty line

[palakj1, 2016/06/29 23:02:41]

Done.

   // Careful! WebIDBCallbacks wraps non-threadsafe data types. It must be
   // destroyed and used on the same thread it was created on.
   IDMap<blink::WebIDBCallbacks, IDMapOwnPointer> pending_callbacks_;
   IDMap<blink::WebIDBDatabaseCallbacks, IDMapOwnPointer>
       pending_database_callbacks_;
+  IDMap<blink::WebIDBObserver, IDMapOwnPointer> observers_;
 
   // Maps the ipc_callback_id from an open cursor request to the request's
   // transaction_id. Used to assign the transaction_id to the WebIDBCursorImpl
   // when it is created.
   std::map<int32_t, int64_t> cursor_transaction_ids_;
 
   // Map from cursor id to WebIDBCursorImpl.
   std::map<int32_t, WebIDBCursorImpl*> cursors_;
-

[Marijn Kruisselbrink, 2016/06/28 18:58:31]

nit: don't remove empty line

[palakj1, 2016/06/29 23:02:41]

Done.

   std::map<int32_t, WebIDBDatabaseImpl*> databases_;
 
   DISALLOW_COPY_AND_ASSIGN(IndexedDBDispatcher);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_CHILD_INDEXED_DB_INDEXED_DB_DISPATCHER_H_