IndexedDB: Recycle cursor objects when calling continue().

content/renderer/indexed_db_dispatcher.cc

 // Copyright (c) 2011 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/renderer/indexed_db_dispatcher.h"
 
 #include "content/common/indexed_db_messages.h"
 #include "content/renderer/render_thread_impl.h"
 #include "content/renderer/render_view_impl.h"
 #include "content/renderer/renderer_webidbcursor_impl.h"
@@ skipping 24 matching lines @@
 }
 
 IndexedDBDispatcher::~IndexedDBDispatcher() {
 }
 
 bool IndexedDBDispatcher::OnMessageReceived(const IPC::Message& msg) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(IndexedDBDispatcher, msg)
     IPC_MESSAGE_HANDLER(IndexedDBMsg_CallbacksSuccessIDBCursor,
                         OnSuccessOpenCursor)
+    IPC_MESSAGE_HANDLER(IndexedDBMsg_CallbacksSuccessCursorContinue,
+                        OnSuccessCursorContinue)
     IPC_MESSAGE_HANDLER(IndexedDBMsg_CallbacksSuccessIDBDatabase,
                         OnSuccessIDBDatabase)
     IPC_MESSAGE_HANDLER(IndexedDBMsg_CallbacksSuccessIndexedDBKey,
                         OnSuccessIndexedDBKey)
     IPC_MESSAGE_HANDLER(IndexedDBMsg_CallbacksSuccessIDBTransaction,
                         OnSuccessIDBTransaction)
     IPC_MESSAGE_HANDLER(IndexedDBMsg_CallbacksSuccessStringList,
                         OnSuccessStringList)
     IPC_MESSAGE_HANDLER(IndexedDBMsg_CallbacksSuccessSerializedScriptValue,
                         OnSuccessSerializedScriptValue)
@@ skipping 23 matching lines @@
 }
 
 void IndexedDBDispatcher::RequestIDBCursorContinue(
     const IndexedDBKey& key,
     WebIDBCallbacks* callbacks_ptr,
     int32 idb_cursor_id,
     WebExceptionCode* ec) {
   scoped_ptr<WebIDBCallbacks> callbacks(callbacks_ptr);
 
   int32 response_id = pending_callbacks_.Add(callbacks.release());
+  pending_cursor_continues_[response_id] = idb_cursor_id;
   RenderThreadImpl::current()->Send(
       new IndexedDBHostMsg_CursorContinue(idb_cursor_id, response_id, key, ec));
-  if (*ec)
+  if (*ec) {
     pending_callbacks_.Remove(response_id);
+    pending_cursor_continues_.erase(idb_cursor_id);
+  }
 }
 
 void IndexedDBDispatcher::RequestIDBCursorDelete(
     WebIDBCallbacks* callbacks_ptr,
     int32 idb_cursor_id,
     WebExceptionCode* ec) {
   scoped_ptr<WebIDBCallbacks> callbacks(callbacks_ptr);
 
   int32 response_id = pending_callbacks_.Add(callbacks.release());
   RenderThreadImpl::current()->Send(
@@ skipping 322 matching lines @@
   callbacks->onSuccess(value);
   pending_callbacks_.Remove(response_id);
 }
 
 void IndexedDBDispatcher::OnSuccessOpenCursor(int32 repsonse_id,
     int32 object_id, const IndexedDBKey& key, const IndexedDBKey& primaryKey,
     const content::SerializedScriptValue& value) {
   WebIDBCallbacks* callbacks =
       pending_callbacks_.Lookup(repsonse_id);
   callbacks->onSuccess(new RendererWebIDBCursorImpl(object_id, key,
                        primaryKey, value));

[dgrogan, 2011/10/29 00:54:28]

You can remove the non-object_id parameters.

[hans, 2011/10/31 16:11:52]

Done.

+
+  cursor_key_[object_id] = key;

[dgrogan, 2011/10/29 00:54:28]

If the onSuccess call is synchronous, shouldn't these be before it?  I don't
know if it is.

[hans, 2011/10/31 16:11:52]

It's not synchronous, but it certainly looks weird. Fixed.

+  cursor_primary_key_[object_id] = primaryKey;
+  cursor_value_[object_id] = value;
+
   pending_callbacks_.Remove(repsonse_id);
 }
 
+void IndexedDBDispatcher::OnSuccessCursorContinue(
+    int32 response_id,

[michaeln, 2011/10/30 21:54:06]

cursor_id could be a useful here, i think you wouldn't need the
pending_cursor_continues_ map

[hans, 2011/10/31 16:11:52]

Done.

+    const IndexedDBKey& key,
+    const IndexedDBKey& primary_key,
+    const content::SerializedScriptValue& value) {
+  int32 cursor_id = pending_cursor_continues_[response_id];
+

[michaeln, 2011/10/30 21:54:06]

Is there any chance the cursor was deleted prior to this completion callback?

[hans, 2011/10/31 16:11:52]

No, according to the comment in ~RendererWebIDBCursorImpl, the callback object
holds a reference to the cursor.

+  cursor_key_[cursor_id] = key;
+  cursor_primary_key_[cursor_id] = primary_key;
+  cursor_value_[cursor_id] = value;

[michaeln, 2011/10/30 21:54:06]

The RendererWebIDBCursorImpl has data members for each of these things. It might
be cleaner to keep these values in an instance of that object instead of in
these maps.

I think what's missing is a way to lookup a RendererWebIDBCursorImpl by id.

std::map<int32, RendererWebIDBCursorImpl*> cursors_; 

[hans, 2011/10/31 16:11:52]

Yes, doing that.
Doing that.

+
+  WebIDBCallbacks* callbacks = pending_callbacks_.Lookup(response_id);
+  callbacks->onSuccessCursorContinue();
+
+  pending_callbacks_.Remove(response_id);
+  pending_cursor_continues_.erase(response_id);
+}
+
 void IndexedDBDispatcher::OnBlocked(int32 response_id) {
   WebIDBCallbacks* callbacks = pending_callbacks_.Lookup(response_id);
   callbacks->onBlocked();
 }
 
 void IndexedDBDispatcher::OnError(int32 response_id, int code,
                                   const string16& message) {
   WebIDBCallbacks* callbacks = pending_callbacks_.Lookup(response_id);
   callbacks->onError(WebIDBDatabaseError(code, message));
   pending_callbacks_.Remove(response_id);
@@ skipping 15 matching lines @@
 
 void IndexedDBDispatcher::OnVersionChange(int32 database_id,
                                           const string16& newVersion) {
   WebIDBDatabaseCallbacks* callbacks =
       pending_database_callbacks_.Lookup(database_id);
   // callbacks would be NULL if a versionchange event is received after close
   // has been called.
   if (callbacks)
     callbacks->onVersionChange(newVersion);
 }
+
+IndexedDBKey IndexedDBDispatcher::getCursorKey(int32 cursor_id) {
+  return cursor_key_[cursor_id];
+}
+
+IndexedDBKey IndexedDBDispatcher::getCursorPrimaryKey(int32 cursor_id) {
+  return cursor_primary_key_[cursor_id];
+}
+
+content::SerializedScriptValue IndexedDBDispatcher::getCursorValue(
+    int32 cursor_id) {
+  return cursor_value_[cursor_id];
+}
+
+void IndexedDBDispatcher::CursorDestroyed(int32 cursor_id) {
+  cursor_key_.erase(cursor_id);
+  cursor_primary_key_.erase(cursor_id);
+  cursor_value_.erase(cursor_id);
+}