IndexedDB: Make DOMException messages more useful.

Source/modules/indexeddb/IDBIndex.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 42 matching lines @@
 }
 
 IDBIndex::~IDBIndex()
 {
 }
 
 PassRefPtr<IDBRequest> IDBIndex::openCursor(ScriptExecutionContext* context, PassRefPtr<IDBKeyRange> keyRange, const String& directionString, ExceptionState& es)
 {
     IDB_TRACE("IDBIndex::openCursor");
     if (isDeleted()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, IDBDatabase::indexDeletedErrorMessage);
+        return 0;
+    }
+    if (m_transaction->isFinished()) {
+        es.throwDOMException(TransactionInactiveError, IDBDatabase::transactionFinishedErrorMessage);
         return 0;
     }
     if (!m_transaction->isActive()) {
         es.throwDOMException(TransactionInactiveError);

[dgrogan, 2013/07/12 17:58:17]

I see, that last one probably was skipped intentionally. I suppose there's not
much that a message could add. Which is unfortunate, because I feel like this is
one of the things that will confuse developers when they try to do something
like open a cursor on a transaction from a setTimeout function.

So, if you do think of something helpful, the developer in me would be grateful.
But no worries if you can't, as this CL as-is is a big improvement over the
current state.

[arv (Not doing code reviews), 2013/07/12 18:07:29]

It falls back on the default message as defined in DOMException.cpp

         return 0;
     }
     IndexedDB::CursorDirection direction = IDBCursor::stringToDirection(directionString, es);
     if (es.hadException())
         return 0;
 
     RefPtr<IDBRequest> request = IDBRequest::create(context, IDBAny::create(this), m_transaction.get());
     request->setCursorDetails(IndexedDB::CursorKeyAndValue, direction);
     backendDB()->openCursor(m_transaction->id(), m_objectStore->id(), m_metadata.id, keyRange, direction, false, IDBDatabaseBackendInterface::NormalTask, request);
     return request;
 }
 
 PassRefPtr<IDBRequest> IDBIndex::openCursor(ScriptExecutionContext* context, const ScriptValue& key, const String& direction, ExceptionState& es)
 {
     IDB_TRACE("IDBIndex::openCursor");
     RefPtr<IDBKeyRange> keyRange = IDBKeyRange::only(context, key, es);
     if (es.hadException())
         return 0;
     return openCursor(context, keyRange.release(), direction, es);
 }
 
 PassRefPtr<IDBRequest> IDBIndex::count(ScriptExecutionContext* context, PassRefPtr<IDBKeyRange> keyRange, ExceptionState& es)
 {
     IDB_TRACE("IDBIndex::count");
     if (isDeleted()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, IDBDatabase::indexDeletedErrorMessage);
+        return 0;
+    }
+    if (m_transaction->isFinished()) {
+        es.throwDOMException(TransactionInactiveError, IDBDatabase::transactionFinishedErrorMessage);
         return 0;
     }
     if (!m_transaction->isActive()) {
         es.throwDOMException(TransactionInactiveError);
         return 0;
     }
     RefPtr<IDBRequest> request = IDBRequest::create(context, IDBAny::create(this), m_transaction.get());
     backendDB()->count(m_transaction->id(), m_objectStore->id(), m_metadata.id, keyRange, request);
     return request;
 }
 
 PassRefPtr<IDBRequest> IDBIndex::count(ScriptExecutionContext* context, const ScriptValue& key, ExceptionState& es)
 {
     IDB_TRACE("IDBIndex::count");
     RefPtr<IDBKeyRange> keyRange = IDBKeyRange::only(context, key, es);
     if (es.hadException())
         return 0;
     return count(context, keyRange.release(), es);
 }
 
 PassRefPtr<IDBRequest> IDBIndex::openKeyCursor(ScriptExecutionContext* context, PassRefPtr<IDBKeyRange> keyRange, const String& directionString, ExceptionState& es)
 {
     IDB_TRACE("IDBIndex::openKeyCursor");
     if (isDeleted()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, IDBDatabase::indexDeletedErrorMessage);
+        return 0;
+    }
+    if (m_transaction->isFinished()) {
+        es.throwDOMException(TransactionInactiveError, IDBDatabase::transactionFinishedErrorMessage);
         return 0;
     }
     if (!m_transaction->isActive()) {
         es.throwDOMException(TransactionInactiveError);
         return 0;
     }
     IndexedDB::CursorDirection direction = IDBCursor::stringToDirection(directionString, es);
     if (es.hadException())
         return 0;
 
@@ skipping 18 matching lines @@
     RefPtr<IDBKeyRange> keyRange = IDBKeyRange::only(context, key, es);
     if (es.hadException())
         return 0;
     return get(context, keyRange.release(), es);
 }
 
 PassRefPtr<IDBRequest> IDBIndex::get(ScriptExecutionContext* context, PassRefPtr<IDBKeyRange> keyRange, ExceptionState& es)
 {
     IDB_TRACE("IDBIndex::get");
     if (isDeleted()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, IDBDatabase::indexDeletedErrorMessage);
+        return 0;
+    }
+    if (m_transaction->isFinished()) {
+        es.throwDOMException(TransactionInactiveError, IDBDatabase::transactionFinishedErrorMessage);
         return 0;
     }
     if (!m_transaction->isActive()) {
         es.throwDOMException(TransactionInactiveError);
         return 0;
     }
     if (!keyRange) {
-        es.throwDOMException(DataError);
+        es.throwDOMException(DataError, IDBDatabase::noKeyOrKeyRangeErrorMessage);
         return 0;
     }
 
     RefPtr<IDBRequest> request = IDBRequest::create(context, IDBAny::create(this), m_transaction.get());
     backendDB()->get(m_transaction->id(), m_objectStore->id(), m_metadata.id, keyRange, false, request);
     return request;
 }
 
 PassRefPtr<IDBRequest> IDBIndex::getKey(ScriptExecutionContext* context, const ScriptValue& key, ExceptionState& es)
 {
     IDB_TRACE("IDBIndex::getKey");
     RefPtr<IDBKeyRange> keyRange = IDBKeyRange::only(context, key, es);
     if (es.hadException())
         return 0;
 
     return getKey(context, keyRange.release(), es);
 }
 
 PassRefPtr<IDBRequest> IDBIndex::getKey(ScriptExecutionContext* context, PassRefPtr<IDBKeyRange> keyRange, ExceptionState& es)
 {
     IDB_TRACE("IDBIndex::getKey");
     if (isDeleted()) {
-        es.throwDOMException(InvalidStateError);
+        es.throwDOMException(InvalidStateError, IDBDatabase::indexDeletedErrorMessage);
+        return 0;
+    }
+    if (m_transaction->isFinished()) {
+        es.throwDOMException(TransactionInactiveError, IDBDatabase::transactionFinishedErrorMessage);
         return 0;
     }
     if (!m_transaction->isActive()) {
         es.throwDOMException(TransactionInactiveError);
         return 0;
     }
     if (!keyRange) {
-        es.throwDOMException(DataError);
+        es.throwDOMException(DataError, IDBDatabase::noKeyOrKeyRangeErrorMessage);
         return 0;
     }
 
     RefPtr<IDBRequest> request = IDBRequest::create(context, IDBAny::create(this), m_transaction.get());
     backendDB()->get(m_transaction->id(), m_objectStore->id(), m_metadata.id, keyRange, true, request);
     return request;
 }
 
 IDBDatabaseBackendInterface* IDBIndex::backendDB() const
 {
     return m_transaction->backendDB();
 }
 
 bool IDBIndex::isDeleted() const
 {
     return m_deleted || m_objectStore->isDeleted();
 }
 
 } // namespace WebCore