IDBObserver: Lifetime Management: Adding Observer

third_party/WebKit/public/platform/modules/indexeddb/WebIDBDatabase.h

 /*
  * Copyright (C) 2010 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
@@ skipping 12 matching lines @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef WebIDBDatabase_h
 #define WebIDBDatabase_h
 
 #include "public/platform/WebBlobInfo.h"
 #include "public/platform/WebCommon.h"
 #include "public/platform/modules/indexeddb/WebIDBCursor.h"
 #include "public/platform/modules/indexeddb/WebIDBMetadata.h"
+#include "public/platform/modules/indexeddb/WebIDBObserver.h"
 #include "public/platform/modules/indexeddb/WebIDBTypes.h"
+#include <set>
+#include <vector>
 
 namespace blink {
 
 class WebData;
 class WebIDBCallbacks;
 class WebIDBDatabaseCallbacks;
 class WebIDBKey;
 class WebIDBKeyPath;
 class WebIDBKeyRange;
+class WebIDBObserver;
 
 class WebIDBDatabase {
 public:
     virtual ~WebIDBDatabase() { }
 
     virtual void createObjectStore(long long transactionId, long long objectStoreId, const WebString& name, const WebIDBKeyPath&, bool autoIncrement) = 0;
     virtual void deleteObjectStore(long long transactionId, long long objectStoreId) = 0;
     virtual void createTransaction(long long id, WebIDBDatabaseCallbacks*, const WebVector<long long>& scope, WebIDBTransactionMode) = 0;
     virtual void close() = 0;
     virtual void versionChangeIgnored() = 0;
 
     virtual void abort(long long transactionId) = 0;
     virtual void commit(long long transactionId) = 0;
 
     virtual void createIndex(long long transactionId, long long objectStoreId, long long indexId, const WebString& name, const WebIDBKeyPath&, bool unique, bool multiEntry) = 0;
     virtual void deleteIndex(long long transactionId, long long objectStoreId, long long indexId) = 0;
 
     static const long long minimumIndexId = 30;
 
     typedef WebVector<WebIDBKey> WebIndexKeys;
 
+    virtual int32_t addObserver(WebIDBObserver*, long long transactionId) = 0;
+    virtual bool removeObserverId(int32_t id) = 0;

[dmurph, 2016/06/27 21:20:51]

I don't like how we expect these methods to be called first and then second,
where the first one removes and the second one forwards the call. Instead, how
about we have:

bool containsObserver(id);

instead of removeObserverId. Then, in removeObservers, that will do the set
removal as well.

[palakj1, 2016/06/27 23:13:08]

Yes, we can do that. It's a bit redundant since, we find and erase each element
separately. But that's cleaner.

+    // rename this.
+    virtual void removeObservers(const std::vector<int32_t>& observerIdsToRemove) = 0;
     virtual void get(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, bool keyOnly, WebIDBCallbacks*) = 0;
     virtual void getAll(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, long long maxCount, bool keyOnly, WebIDBCallbacks*) = 0;
     virtual void put(long long transactionId, long long objectStoreId, const WebData& value, const WebVector<WebBlobInfo>&, const WebIDBKey&, WebIDBPutMode, WebIDBCallbacks*, const WebVector<long long>& indexIds, const WebVector<WebIndexKeys>&) = 0;
     virtual void setIndexKeys(long long transactionId, long long objectStoreId, const WebIDBKey&, const WebVector<long long>& indexIds, const WebVector<WebIndexKeys>&) = 0;
     virtual void setIndexesReady(long long transactionId, long long objectStoreId, const WebVector<long long>& indexIds) = 0;
     virtual void openCursor(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, WebIDBCursorDirection, bool keyOnly, WebIDBTaskType, WebIDBCallbacks*) = 0;
     virtual void count(long long transactionId, long long objectStoreId, long long indexId, const WebIDBKeyRange&, WebIDBCallbacks*) = 0;
     virtual void deleteRange(long long transactionId, long long objectStoreId, const WebIDBKeyRange&, WebIDBCallbacks*) = 0;
     virtual void clear(long long transactionId, long long objectStoreId, WebIDBCallbacks*) = 0;
     virtual void ackReceivedBlobs(const WebVector<WebString>& uuids) = 0;
 
 protected:
     WebIDBDatabase() { }
 };
 
 } // namespace blink
 
 #endif // WebIDBDatabase_h