LibWeb/IDB: Implement IDBIndex::getAll

Author: https://github.com/stelar7
Commit: 3fa1d1299c
Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/4727
Reviewed-by: https://github.com/gmta ✅
Reviewed-by: https://github.com/shannonbooth

Libraries/LibWeb/IndexedDB/IDBIndex.cpp

@@ -203,4 +203,35 @@ WebIDL::ExceptionOr<GC::Ref<IDBRequest>> IDBIndex::get_key(JS::Value query)
     return result;
 }
 
+// https://w3c.github.io/IndexedDB/#dom-idbindex-getall
+WebIDL::ExceptionOr<GC::Ref<IDBRequest>> IDBIndex::get_all(Optional<JS::Value> query, Optional<WebIDL::UnsignedLong> count)
+{
+    auto& realm = this->realm();
+
+    // 1. Let transaction be this’s transaction.
+    auto transaction = this->transaction();
+
+    // 2. Let index be this’s index.
+    auto index = this->index();
+
+    // FIXME: 3. If index or index’s object store has been deleted, throw an "InvalidStateError" DOMException.
+
+    // 4. If transaction’s state is not active, then throw a "TransactionInactiveError" DOMException.
+    if (transaction->state() != IDBTransaction::TransactionState::Active)
+        return WebIDL::TransactionInactiveError::create(realm, "Transaction is not active while getting all"_string);
+
+    // 5. Let range be the result of converting a value to a key range with query. Rethrow any exceptions.
+    auto range = TRY(convert_a_value_to_a_key_range(realm, query));
+
+    // 6. Let operation be an algorithm to run retrieve multiple referenced values from an index with the current Realm record, index, range, and count if given.
+    auto operation = GC::Function<WebIDL::ExceptionOr<JS::Value>()>::create(realm.heap(), [&realm, index, range, count] -> WebIDL::ExceptionOr<JS::Value> {
+        return retrieve_multiple_referenced_values_from_an_index(realm, index, range, count);
+    });
+
+    // 7. Return the result (an IDBRequest) of running asynchronously execute a request with this and operation.
+    auto result = asynchronously_execute_a_request(realm, GC::Ref(*this), operation);
+    dbgln_if(IDB_DEBUG, "Executing request for get all with uuid {}", result->uuid());
+    return result;
+}
+
 }

Libraries/LibWeb/IndexedDB/IDBIndex.h

@@ -31,6 +31,7 @@ public:
 
     [[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> get(JS::Value);
     [[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> get_key(JS::Value);
+    [[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> get_all(Optional<JS::Value>, Optional<WebIDL::UnsignedLong>);
     [[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> open_cursor(JS::Value, Bindings::IDBCursorDirection = Bindings::IDBCursorDirection::Next);
 
     // The transaction of an index handle is the transaction of its associated object store handle.

Libraries/LibWeb/IndexedDB/IDBIndex.idl

@@ -9,7 +9,7 @@ interface IDBIndex {
     readonly attribute boolean unique;
     [NewObject] IDBRequest get(any query);
     [NewObject] IDBRequest getKey(any query);
-    [FIXME, NewObject] IDBRequest getAll(optional any query, optional [EnforceRange] unsigned long count);
+    [NewObject] IDBRequest getAll(optional any query, optional [EnforceRange] unsigned long count);
     [FIXME, NewObject] IDBRequest getAllKeys(optional any query, optional [EnforceRange] unsigned long count);
     [FIXME, NewObject] IDBRequest count(optional any query);
     [NewObject] IDBRequest openCursor(optional any query, optional IDBCursorDirection direction = "next");

Libraries/LibWeb/IndexedDB/Internal/Algorithms.cpp

@@ -1960,4 +1960,35 @@ JS::Value retrieve_a_value_from_an_index(JS::Realm& realm, GC::Ref<Index> index,
     return convert_a_key_to_a_value(realm, record->value);
 }
 
+// https://w3c.github.io/IndexedDB/#retrieve-multiple-referenced-values-from-an-index
+GC::Ref<JS::Array> retrieve_multiple_referenced_values_from_an_index(JS::Realm& realm, GC::Ref<Index> index, GC::Ref<IDBKeyRange> range, Optional<WebIDL::UnsignedLong> count)
+{
+    // 1. If count is not given or is 0 (zero), let count be infinity.
+    if (count.has_value() && *count == 0)
+        count = OptionalNone();
+
+    // 2. Let records be a list containing the first count records in index’s list of records whose key is in range.
+    auto records = index->first_n_in_range(range, count);
+
+    // 3. Let list be an empty list.
+    auto list = MUST(JS::Array::create(realm, records.size()));
+
+    // 4. For each record of records:
+    for (u32 i = 0; i < records.size(); ++i) {
+        auto& record = records[i];
+
+        // 1. Let serialized be record’s referenced value.
+        auto serialized = index->referenced_value(record);
+
+        // 2. Let entry be ! StructuredDeserialize(serialized, targetRealm).
+        auto entry = MUST(HTML::structured_deserialize(realm.vm(), serialized, realm));
+
+        // 3. Append entry to list.
+        MUST(list->create_data_property_or_throw(i, entry));
+    }
+
+    // 5. Return list converted to a sequence<any>.
+    return list;
+}
+
 }

Libraries/LibWeb/IndexedDB/Internal/Algorithms.h

@@ -53,5 +53,6 @@ GC::Ref<JS::Array> retrieve_multiple_values_from_an_object_store(JS::Realm&, GC:
 GC::Ref<JS::Array> retrieve_multiple_keys_from_an_object_store(JS::Realm&, GC::Ref<ObjectStore>, GC::Ref<IDBKeyRange>, Optional<WebIDL::UnsignedLong>);
 JS::Value retrieve_a_referenced_value_from_an_index(JS::Realm&, GC::Ref<Index>, GC::Ref<IDBKeyRange>);
 JS::Value retrieve_a_value_from_an_index(JS::Realm&, GC::Ref<Index>, GC::Ref<IDBKeyRange>);
+GC::Ref<JS::Array> retrieve_multiple_referenced_values_from_an_index(JS::Realm&, GC::Ref<Index>, GC::Ref<IDBKeyRange>, Optional<WebIDL::UnsignedLong>);
 
 }

Libraries/LibWeb/IndexedDB/Internal/Index.cpp

@@ -83,4 +83,18 @@ Optional<IndexRecord&> Index::first_in_range(GC::Ref<IDBKeyRange> range)
     });
 }
 
+GC::ConservativeVector<IndexRecord> Index::first_n_in_range(GC::Ref<IDBKeyRange> range, Optional<WebIDL::UnsignedLong> count)
+{
+    GC::ConservativeVector<IndexRecord> records(range->heap());
+    for (auto const& record : m_records) {
+        if (range->is_in_range(record.key))
+            records.append(record);
+
+        if (count.has_value() && records.size() >= *count)
+            break;
+    }
+
+    return records;
+}
+
 }

Libraries/LibWeb/IndexedDB/Internal/Index.h

@@ -42,6 +42,7 @@ public:
     [[nodiscard]] bool has_record_with_key(GC::Ref<Key> key);
     void clear_records();
     Optional<IndexRecord&> first_in_range(GC::Ref<IDBKeyRange> range);
+    GC::ConservativeVector<IndexRecord> first_n_in_range(GC::Ref<IDBKeyRange> range, Optional<WebIDL::UnsignedLong> count);
 
     HTML::SerializationRecord referenced_value(IndexRecord const& index_record) const;