Align IndexedDB metadata rollback on transaction abort to spec.

third_party/WebKit/Source/modules/indexeddb/IDBObjectStore.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 21 matching lines @@
 #include "modules/indexeddb/IDBIndex.h"
 #include "modules/indexeddb/IDBIndexParameters.h"
 #include "modules/indexeddb/IDBKey.h"
 #include "modules/indexeddb/IDBKeyRange.h"
 #include "modules/indexeddb/IDBMetadata.h"
 #include "modules/indexeddb/IDBRequest.h"
 #include "modules/indexeddb/IDBTransaction.h"
 #include "public/platform/modules/indexeddb/WebIDBCursor.h"
 #include "public/platform/modules/indexeddb/WebIDBDatabase.h"
 #include "public/platform/modules/indexeddb/WebIDBTypes.h"
-#include "wtf/PassRefPtr.h"
 #include "wtf/RefPtr.h"
 #include "wtf/text/WTFString.h"
 
 namespace blink {
 
 class DOMStringList;
 class IDBAny;
 class ExceptionState;
 
 class IDBObjectStore final : public GarbageCollectedFinalized<IDBObjectStore>, public ScriptWrappable {
     DEFINE_WRAPPERTYPEINFO();
 public:
-    static IDBObjectStore* create(const IDBObjectStoreMetadata& metadata, IDBTransaction* transaction)
+    static IDBObjectStore* create(RefPtr<IDBObjectStoreMetadata> metadata, IDBTransaction* transaction)
     {
-        return new IDBObjectStore(metadata, transaction);
+        return new IDBObjectStore(std::move(metadata), transaction);
     }
     ~IDBObjectStore() { }
     DECLARE_TRACE();
 
+    const IDBObjectStoreMetadata& metadata() const { return *m_metadata; }
+
     // Implement the IDBObjectStore IDL
-    int64_t id() const { return m_metadata.id; }
-    const String& name() const { return m_metadata.name; }
+    int64_t id() const { return metadata().own.id; }
+    const String& name() const { return metadata().own.name; }
     void setName(const String& name, ExceptionState&);
     ScriptValue keyPath(ScriptState*) const;
     DOMStringList* indexNames() const;
     IDBTransaction* transaction() const { return m_transaction.get(); }
-    bool autoIncrement() const { return m_metadata.autoIncrement; }
+    bool autoIncrement() const { return metadata().own.autoIncrement; }
 
     IDBRequest* openCursor(ScriptState*, const ScriptValue& range, const String& direction, ExceptionState&);
     IDBRequest* openKeyCursor(ScriptState*, const ScriptValue& range, const String& direction, ExceptionState&);
     IDBRequest* get(ScriptState*, const ScriptValue& key, ExceptionState&);
     IDBRequest* getKey(ScriptState*, const ScriptValue& key, ExceptionState&);
     IDBRequest* getAll(ScriptState*, const ScriptValue& range, unsigned long maxCount, ExceptionState&);
     IDBRequest* getAll(ScriptState*, const ScriptValue& range, ExceptionState&);
     IDBRequest* getAllKeys(ScriptState*, const ScriptValue& range, unsigned long maxCount, ExceptionState&);
     IDBRequest* getAllKeys(ScriptState*, const ScriptValue& range, ExceptionState&);
     IDBRequest* add(ScriptState*, const ScriptValue&, const ScriptValue& key, ExceptionState&);
     IDBRequest* put(ScriptState*, const ScriptValue&, const ScriptValue& key, ExceptionState&);
     IDBRequest* deleteFunction(ScriptState*, const ScriptValue& key, ExceptionState&);
     IDBRequest* clear(ScriptState*, ExceptionState&);
 
     IDBIndex* createIndex(ScriptState* scriptState, const String& name, const StringOrStringSequence& keyPath, const IDBIndexParameters& options, ExceptionState& exceptionState)
     {
         return createIndex(scriptState, name, IDBKeyPath(keyPath), options, exceptionState);
     }
     IDBIndex* index(const String& name, ExceptionState&);
     void deleteIndex(const String& name, ExceptionState&);
 
     IDBRequest* count(ScriptState*, const ScriptValue& range, ExceptionState&);
 
     // Used by IDBCursor::update():
     IDBRequest* put(ScriptState*, WebIDBPutMode, IDBAny* source, const ScriptValue&, IDBKey*, ExceptionState&);
 
     // Used internally and by InspectorIndexedDBAgent:
     IDBRequest* openCursor(ScriptState*, IDBKeyRange*, WebIDBCursorDirection, WebIDBTaskType = WebIDBTaskTypeNormal);
 
-    void markDeleted() { m_deleted = true; }
+    void markDeleted();
     bool isDeleted() const { return m_deleted; }
-    void abort();
     void transactionFinished();
 
-    const IDBObjectStoreMetadata& metadata() const { return m_metadata; }
-    void setMetadata(const IDBObjectStoreMetadata& metadata) { m_metadata = metadata; }
-
-    typedef HeapVector<Member<IDBKey>> IndexKeys;
+    // Sets the object store's metadata to a previous version.
+    //
+    // The reverting process includes reverting the metadata for the IDBIndex
+    // instances that are still tracked by the store. It does not revert the
+    // IDBIndex metadata for indexes that were deleted in this transaction.
+    //
+    // Used when a versionchange transaction is aborted.
+    void revertMetadata(RefPtr<IDBObjectStoreMetadata> previousMetadata);
+    // This relies on the changes made by revertMetadata().
+    void revertDeletedIndexMetadata(IDBIndex& deletedIndex);
 
     // Used by IDBIndex::setName:
     bool containsIndex(const String& name) const
     {
         return findIndexId(name) != IDBIndexMetadata::InvalidId;
     }
-    void indexRenamed(int64_t indexId, const String& newName);
+    void renameIndex(int64_t indexId, const String& newName);
 
     WebIDBDatabase* backendDB() const;
 
 private:
-    IDBObjectStore(const IDBObjectStoreMetadata&, IDBTransaction*);
+    IDBObjectStore(RefPtr<IDBObjectStoreMetadata>, IDBTransaction*);
 
     IDBIndex* createIndex(ScriptState*, const String& name, const IDBKeyPath&, const IDBIndexParameters&, ExceptionState&);
     IDBRequest* put(ScriptState*, WebIDBPutMode, IDBAny* source, const ScriptValue&, const ScriptValue& key, ExceptionState&);
 
     int64_t findIndexId(const String& name) const;
 
-    IDBObjectStoreMetadata m_metadata;
+    // The IDBObjectStoreMetadata is shared with the object store map in the
+    // database's metadata.
+    RefPtr<IDBObjectStoreMetadata> m_metadata;
     Member<IDBTransaction> m_transaction;
     bool m_deleted = false;
 
-    typedef HeapHashMap<String, Member<IDBIndex>> IDBIndexMap;
-    IDBIndexMap m_indexMap;
-
-    // Used to mark indexes created in an aborted upgrade transaction as
-    // deleted.
-    HeapHashSet<Member<IDBIndex>> m_createdIndexes;
+    // Caches the IDBIndex instances returned by the index() method.
+    //
+    // The spec requires that an object store's index() returns the same
+    // IDBIndex instance for a specific index, so this cache is necessary
+    // for correctness.
+    //
+    // The cache may be in an inconsistent state after a transaction is aborted.
+    // index() throws for inactive transactions, which makes the cache not
+    // observable, so reverting the cache would be a waste of resources.
+    using IndexMap = HeapHashMap<String, Member<IDBIndex>>;
+    IndexMap m_indexMap;
 };
 
 } // namespace blink
 
 #endif // IDBObjectStore_h