Minor IndexedDB refactorings.

third_party/WebKit/Source/modules/indexeddb/IDBObjectStore.cpp

 /*
  * 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 39 matching lines @@
 #include <v8.h>
 
 using blink::WebBlobInfo;
 using blink::WebIDBCallbacks;
 using blink::WebIDBCursor;
 using blink::WebIDBDatabase;
 using blink::WebVector;
 
 namespace blink {
 
+namespace {
+
+using IndexKeys = HeapVector<Member<IDBKey>>;
+
+}
+
 IDBObjectStore::IDBObjectStore(const IDBObjectStoreMetadata& metadata, IDBTransaction* transaction)
     : m_metadata(metadata)
     , m_transaction(transaction)
 {
-    ASSERT(m_transaction);
+    DCHECK(m_transaction);
 }
 
 DEFINE_TRACE(IDBObjectStore)
 {
     visitor->trace(m_transaction);
     visitor->trace(m_indexMap);
     visitor->trace(m_createdIndexes);
 }
 
 void IDBObjectStore::setName(const String& name, ExceptionState& exceptionState)
@@ skipping 12 matching lines @@
     }
     if (m_transaction->isFinished() || m_transaction->isFinishing()) {
         exceptionState.throwDOMException(TransactionInactiveError, IDBDatabase::transactionFinishedErrorMessage);
         return;
     }
     if (!m_transaction->isActive()) {
         exceptionState.throwDOMException(TransactionInactiveError, IDBDatabase::transactionInactiveErrorMessage);
         return;
     }
 
-    if (m_metadata.name == name)
+    if (this->name() == name)
         return;
     if (m_transaction->db()->containsObjectStore(name)) {
         exceptionState.throwDOMException(ConstraintError, IDBDatabase::objectStoreNameTakenErrorMessage);
         return;
     }
     if (!backendDB()) {
         exceptionState.throwDOMException(InvalidStateError, IDBDatabase::databaseClosedErrorMessage);
         return;
     }
 
     backendDB()->renameObjectStore(m_transaction->id(), id(), name);
     m_transaction->objectStoreRenamed(m_metadata.name, name);
     m_metadata.name = name;
 
     // The name inside the database's version of the object store metadata is used by IDBDatabase.objectStoreNames().
     // If the transaction is aborted, this name will be reverted when the metadata is overwritten with the previousMetadata in IDBTransaction.
     m_transaction->db()->objectStoreRenamed(id(), name);
 }
 
 ScriptValue IDBObjectStore::keyPath(ScriptState* scriptState) const
 {
-    return ScriptValue::from(scriptState, m_metadata.keyPath);
+    return ScriptValue::from(scriptState, metadata().keyPath);
 }
 
 DOMStringList* IDBObjectStore::indexNames() const
 {
     IDB_TRACE("IDBObjectStore::indexNames");
     DOMStringList* indexNames = DOMStringList::create(DOMStringList::IndexedDB);
-    for (const auto& it : m_metadata.indexes)
+    for (const auto& it : metadata().indexes)
         indexNames->append(it.value.name);
     indexNames->sort();
     return indexNames;
 }
 
 IDBRequest* IDBObjectStore::get(ScriptState* scriptState, const ScriptValue& key, ExceptionState& exceptionState)
 {
     IDB_TRACE("IDBObjectStore::get");
     if (isDeleted()) {
         exceptionState.throwDOMException(InvalidStateError, IDBDatabase::objectStoreDeletedErrorMessage);
@@ skipping 121 matching lines @@
     if (!backendDB()) {
         exceptionState.throwDOMException(InvalidStateError, IDBDatabase::databaseClosedErrorMessage);
         return nullptr;
     }
 
     IDBRequest* request = IDBRequest::create(scriptState, IDBAny::create(this), m_transaction.get());
     backendDB()->getAll(m_transaction->id(), id(), IDBIndexMetadata::InvalidId, range, maxCount, true, WebIDBCallbacksImpl::create(request).release());
     return request;
 }
 
-static void generateIndexKeysForValue(v8::Isolate* isolate, const IDBIndexMetadata& indexMetadata, const ScriptValue& objectValue, IDBObjectStore::IndexKeys* indexKeys)
+static void generateIndexKeysForValue(v8::Isolate* isolate, const IDBIndexMetadata& indexMetadata, const ScriptValue& objectValue, IndexKeys* indexKeys)
 {
-    ASSERT(indexKeys);
+    DCHECK(indexKeys);
     NonThrowableExceptionState exceptionState;
     IDBKey* indexKey = ScriptValue::to<IDBKey*>(isolate, objectValue, exceptionState, indexMetadata.keyPath);
 
     if (!indexKey)
         return;
 
     if (!indexMetadata.multiEntry || indexKey->getType() != IDBKey::ArrayType) {
         if (!indexKey->isValid())
             return;
 
         indexKeys->append(indexKey);
     } else {
-        ASSERT(indexMetadata.multiEntry);
-        ASSERT(indexKey->getType() == IDBKey::ArrayType);
+        DCHECK(indexMetadata.multiEntry);
+        DCHECK_EQ(indexKey->getType(), IDBKey::ArrayType);
         indexKey = IDBKey::createMultiEntryArray(indexKey->array());
 
         for (size_t i = 0; i < indexKey->array().size(); ++i)
             indexKeys->append(indexKey->array()[i]);
     }
 }
 
 IDBRequest* IDBObjectStore::add(ScriptState* scriptState, const ScriptValue& value, const ScriptValue& key, ExceptionState& exceptionState)
 {
     IDB_TRACE("IDBObjectStore::add");
@@ skipping 38 matching lines @@
     Vector<WebBlobInfo> blobInfo;
     RefPtr<SerializedScriptValue> serializedValue = SerializedScriptValue::serialize(isolate, value.v8Value(), nullptr, &blobInfo, exceptionState);
     if (exceptionState.hadException())
         return nullptr;
 
     // Keys that need to be extracted must be taken from a clone so that
     // side effects (i.e. getters) are not triggered. Construct the
     // clone lazily since the operation may be expensive.
     ScriptValue clone;
 
-    const IDBKeyPath& keyPath = m_metadata.keyPath;
+    const IDBKeyPath& keyPath = idbKeyPath();
     const bool usesInLineKeys = !keyPath.isNull();
     const bool hasKeyGenerator = autoIncrement();
 
     if (putMode != WebIDBPutModeCursorUpdate && usesInLineKeys && key) {
         exceptionState.throwDOMException(DataError, "The object store uses in-line keys and the key parameter was provided.");
         return nullptr;
     }
 
     // This test logically belongs in IDBCursor, but must operate on the cloned value.
     if (putMode == WebIDBPutModeCursorUpdate && usesInLineKeys) {
-        ASSERT(key);
+        DCHECK(key);
         if (clone.isEmpty())
             clone = deserializeScriptValue(scriptState, serializedValue.get(), &blobInfo);
         IDBKey* keyPathKey = ScriptValue::to<IDBKey*>(scriptState->isolate(), clone, exceptionState, keyPath);
         if (exceptionState.hadException())
             return nullptr;
         if (!keyPathKey || !keyPathKey->isEqual(key)) {
             exceptionState.throwDOMException(DataError, "The effective object store of this cursor uses in-line keys and evaluating the key path of the value parameter results in a different value than the cursor's effective key.");
             return nullptr;
         }
     }
@@ skipping 30 matching lines @@
         return nullptr;
     }
 
     if (!backendDB()) {
         exceptionState.throwDOMException(InvalidStateError, IDBDatabase::databaseClosedErrorMessage);
         return nullptr;
     }
 
     Vector<int64_t> indexIds;
     HeapVector<IndexKeys> indexKeys;
-    for (const auto& it : m_metadata.indexes) {
+    for (const auto& it : metadata().indexes) {
         if (clone.isEmpty())
             clone = deserializeScriptValue(scriptState, serializedValue.get(), &blobInfo);
         IndexKeys keys;
         generateIndexKeysForValue(scriptState->isolate(), it.value, clone, &keys);
         indexIds.append(it.key);
         indexKeys.append(keys);
     }
 
     IDBRequest* request = IDBRequest::create(scriptState, source, m_transaction.get());
     Vector<char> wireBytes;
@@ skipping 98 matching lines @@
     IndexPopulator(ScriptState* scriptState, IDBDatabase* database, int64_t transactionId, int64_t objectStoreId, const IDBIndexMetadata& indexMetadata)
         : EventListener(CPPEventListenerType)
         , m_scriptState(scriptState)
         , m_database(database)
         , m_transactionId(transactionId)
         , m_objectStoreId(objectStoreId)
         , m_indexMetadata(indexMetadata)
     {
     }
 
+    const IDBIndexMetadata& indexMetadata() const { return m_indexMetadata; }
+
     void handleEvent(ExecutionContext* executionContext, Event* event) override
     {
-        ASSERT(m_scriptState->getExecutionContext() == executionContext);
-        ASSERT(event->type() == EventTypeNames::success);
+        DCHECK_EQ(m_scriptState->getExecutionContext(), executionContext);
+        DCHECK_EQ(event->type(), EventTypeNames::success);
         EventTarget* target = event->target();
         IDBRequest* request = static_cast<IDBRequest*>(target);
 
         if (!m_database->backend()) // If database is stopped?
             return;
 
         IDBAny* cursorAny = request->resultAsAny();
         IDBCursorWithValue* cursor = nullptr;
         if (cursorAny->getType() == IDBAny::IDBCursorWithValueType)
             cursor = cursorAny->idbCursorWithValue();
 
         Vector<int64_t> indexIds;
-        indexIds.append(m_indexMetadata.id);
+        indexIds.append(indexMetadata().id);
         if (cursor && !cursor->isDeleted()) {
             cursor->continueFunction(nullptr, nullptr, ASSERT_NO_EXCEPTION);
 
             IDBKey* primaryKey = cursor->idbPrimaryKey();
             ScriptValue value = cursor->value(m_scriptState.get());
 
-            IDBObjectStore::IndexKeys indexKeys;
-            generateIndexKeysForValue(m_scriptState->isolate(), m_indexMetadata, value, &indexKeys);
+            IndexKeys indexKeys;
+            generateIndexKeysForValue(m_scriptState->isolate(), indexMetadata(), value, &indexKeys);
 
-            HeapVector<IDBObjectStore::IndexKeys> indexKeysList;
+            HeapVector<IndexKeys> indexKeysList;
             indexKeysList.append(indexKeys);
 
             m_database->backend()->setIndexKeys(m_transactionId, m_objectStoreId, primaryKey, indexIds, indexKeysList);
         } else {
             // Now that we are done indexing, tell the backend to go
             // back to processing tasks of type NormalTask.
             m_database->backend()->setIndexesReady(m_transactionId, m_objectStoreId, indexIds);
             m_database.clear();
         }
 
@@ skipping 37 matching lines @@
     if (keyPath.getType() == IDBKeyPath::ArrayType && options.multiEntry()) {
         exceptionState.throwDOMException(InvalidAccessError, "The keyPath argument was an array and the multiEntry option is true.");
         return nullptr;
     }
     if (!backendDB()) {
         exceptionState.throwDOMException(InvalidStateError, IDBDatabase::databaseClosedErrorMessage);
         return nullptr;
     }
 
     int64_t indexId = m_metadata.maxIndexId + 1;
+    DCHECK_NE(indexId, IDBIndexMetadata::InvalidId);
     backendDB()->createIndex(m_transaction->id(), id(), indexId, name, keyPath, options.unique(), options.multiEntry());
 
     ++m_metadata.maxIndexId;
 
-    IDBIndexMetadata metadata(name, indexId, keyPath, options.unique(), options.multiEntry());
-    IDBIndex* index = IDBIndex::create(metadata, this, m_transaction.get());
+    IDBIndexMetadata indexMetadata(name, indexId, keyPath, options.unique(), options.multiEntry());
+    IDBIndex* index = IDBIndex::create(indexMetadata, this, m_transaction.get());
     m_indexMap.set(name, index);
     m_createdIndexes.add(index);
-    m_metadata.indexes.set(indexId, metadata);
-    m_transaction->db()->indexCreated(id(), metadata);
+    m_metadata.indexes.set(indexId, indexMetadata);
+    m_transaction->db()->indexCreated(id(), indexMetadata);
 
-    ASSERT(!exceptionState.hadException());
+    DCHECK(!exceptionState.hadException());
     if (exceptionState.hadException())
         return nullptr;
 
     IDBRequest* indexRequest = openCursor(scriptState, nullptr, WebIDBCursorDirectionNext, WebIDBTaskTypePreemptive);
     indexRequest->preventPropagation();
 
     // This is kept alive by being the success handler of the request, which is in turn kept alive by the owning transaction.
-    IndexPopulator* indexPopulator = IndexPopulator::create(scriptState, transaction()->db(), m_transaction->id(), id(), metadata);
+    IndexPopulator* indexPopulator = IndexPopulator::create(scriptState, transaction()->db(), m_transaction->id(), id(), indexMetadata);
     indexRequest->setOnsuccess(indexPopulator);
     return index;
 }
 
 IDBIndex* IDBObjectStore::index(const String& name, ExceptionState& exceptionState)
 {
     IDB_TRACE("IDBObjectStore::index");
     if (isDeleted()) {
         exceptionState.throwDOMException(InvalidStateError, IDBDatabase::objectStoreDeletedErrorMessage);
         return nullptr;
     }
     if (m_transaction->isFinished() || m_transaction->isFinishing()) {
         exceptionState.throwDOMException(InvalidStateError, IDBDatabase::transactionFinishedErrorMessage);
         return nullptr;
     }
 
     IDBIndexMap::iterator it = m_indexMap.find(name);
     if (it != m_indexMap.end())
         return it->value;
 
     int64_t indexId = findIndexId(name);
     if (indexId == IDBIndexMetadata::InvalidId) {
         exceptionState.throwDOMException(NotFoundError, IDBDatabase::noSuchIndexErrorMessage);
         return nullptr;
     }
 
-    const IDBIndexMetadata* indexMetadata(nullptr);
-    for (const auto& it : m_metadata.indexes) {
-        if (it.value.name == name) {
-            indexMetadata = &it.value;
-            break;
-        }
-    }
-    ASSERT(indexMetadata);
-    ASSERT(indexMetadata->id != IDBIndexMetadata::InvalidId);
-
-    IDBIndex* index = IDBIndex::create(*indexMetadata, this, m_transaction.get());
+    DCHECK(metadata().indexes.contains(indexId));
+    const IDBIndexMetadata& indexMetadata = metadata().indexes.get(indexId);
+    IDBIndex* index = IDBIndex::create(indexMetadata, this, m_transaction.get());
     m_indexMap.set(name, index);
     return index;
 }
 
 void IDBObjectStore::deleteIndex(const String& name, ExceptionState& exceptionState)
 {
     IDB_TRACE("IDBObjectStore::deleteIndex");
     if (!m_transaction->isVersionChange()) {
         exceptionState.throwDOMException(InvalidStateError, IDBDatabase::notVersionChangeTransactionErrorMessage);
         return;
@@ skipping 125 matching lines @@
     if (!backendDB()) {
         exceptionState.throwDOMException(InvalidStateError, IDBDatabase::databaseClosedErrorMessage);
         return nullptr;
     }
 
     IDBRequest* request = IDBRequest::create(scriptState, IDBAny::create(this), m_transaction.get());
     backendDB()->count(m_transaction->id(), id(), IDBIndexMetadata::InvalidId, keyRange, WebIDBCallbacksImpl::create(request).release());
     return request;
 }
 
+void IDBObjectStore::markDeleted()
+{
+    DCHECK(m_transaction->isVersionChange()) << " an object store got deleted outside a versionchange transaction";

[cmumford, 2016/09/23 22:21:11]

I guess you don't need this leading space now - :-)

[pwnall, 2016/09/23 22:33:04]

Sweet, thank you for catching that!

+    m_deleted = true;
+}
+
 void IDBObjectStore::abort()
 {
     for (auto& index : m_createdIndexes)
         index->markDeleted();
 }
 
 void IDBObjectStore::transactionFinished()
 {
-    ASSERT(m_transaction->isFinished());
+    DCHECK(!m_transaction->isActive());
 
     // Break reference cycles.
     // TODO(jsbell): This can be removed c/o Oilpan.
     m_indexMap.clear();
     m_createdIndexes.clear();
 }
 
 void IDBObjectStore::indexRenamed(int64_t indexId, const String& newName)
 {
     DCHECK(m_transaction->isVersionChange());
     DCHECK(m_transaction->isActive());
 
-    IDBObjectStoreMetadata::IndexMap::iterator metadataIterator = m_metadata.indexes.find(indexId);
-    DCHECK(metadataIterator != m_metadata.indexes.end()) << "Invalid indexId";
+    auto metadataIterator = m_metadata.indexes.find(indexId);
+    DCHECK_NE(metadataIterator, m_metadata.indexes.end()) << "Invalid indexId";
     const String& oldName = metadataIterator->value.name;
 
     DCHECK(m_indexMap.contains(oldName)) << "The index had to be accessed in order to be renamed.";
     DCHECK(!m_indexMap.contains(newName));
-    IDBIndexMap::iterator it = m_indexMap.find(oldName);
-    m_indexMap.set(newName, it->value);
-    m_indexMap.remove(oldName);
+    m_indexMap.set(newName, m_indexMap.take(oldName));
 
     metadataIterator->value.name = newName;
 }
 
 int64_t IDBObjectStore::findIndexId(const String& name) const
 {
-    for (const auto& it : m_metadata.indexes) {
+    for (const auto& it : metadata().indexes) {
         if (it.value.name == name) {
-            ASSERT(it.key != IDBIndexMetadata::InvalidId);
+            DCHECK_NE(it.key, IDBIndexMetadata::InvalidId);
             return it.key;
         }
     }
     return IDBIndexMetadata::InvalidId;
 }
 
 WebIDBDatabase* IDBObjectStore::backendDB() const
 {
     return m_transaction->backendDB();
 }
 
 } // namespace blink