LibWeb/IDB: Implement more of IDBCursor

Author: https://github.com/stelar7
Commit: 551969de30
Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/4317
Reviewed-by: https://github.com/ADKaster ✅
Reviewed-by: https://github.com/kennethmyhra ✅

Libraries/LibWeb/IndexedDB/IDBCursor.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, stelar7 <dudedbz@gmail.com>
+ * Copyright (c) 2024-2025, stelar7 <dudedbz@gmail.com>
  *
  * SPDX-License-Identifier: BSD-2-Clause
  */
@@ -8,6 +8,7 @@
 #include <LibWeb/Bindings/Intrinsics.h>
 #include <LibWeb/HTML/EventNames.h>
 #include <LibWeb/IndexedDB/IDBCursor.h>
+#include <LibWeb/IndexedDB/Internal/Algorithms.h>
 
 namespace Web::IndexedDB {
 
@@ -15,14 +16,23 @@ GC_DEFINE_ALLOCATOR(IDBCursor);
 
 IDBCursor::~IDBCursor() = default;
 
-IDBCursor::IDBCursor(JS::Realm& realm)
+IDBCursor::IDBCursor(JS::Realm& realm, GC::Ref<IDBTransaction> transaction, GC::Ptr<Key> position, Bindings::IDBCursorDirection direction, bool got_value, GC::Ptr<Key> key, JS::Value value, CursorSource source, GC::Ref<IDBKeyRange> range, bool key_only)
     : PlatformObject(realm)
+    , m_transaction(transaction)
+    , m_position(position)
+    , m_direction(direction)
+    , m_got_value(got_value)
+    , m_key(key)
+    , m_value(value)
+    , m_source(source)
+    , m_range(range)
+    , m_key_only(key_only)
 {
 }
 
-GC::Ref<IDBCursor> IDBCursor::create(JS::Realm& realm)
+GC::Ref<IDBCursor> IDBCursor::create(JS::Realm& realm, GC::Ref<IDBTransaction> transaction, GC::Ptr<Key> position, Bindings::IDBCursorDirection direction, bool got_value, GC::Ptr<Key> key, JS::Value value, CursorSource source, GC::Ref<IDBKeyRange> range, bool key_only)
 {
-    return realm.create<IDBCursor>(realm);
+    return realm.create<IDBCursor>(realm, transaction, position, direction, got_value, key, value, source, range, key_only);
 }
 
 void IDBCursor::initialize(JS::Realm& realm)
@@ -31,4 +41,29 @@ void IDBCursor::initialize(JS::Realm& realm)
     Base::initialize(realm);
 }
 
+void IDBCursor::visit_edges(Visitor& visitor)
+{
+    Base::visit_edges(visitor);
+    visitor.visit(m_transaction);
+    visitor.visit(m_position);
+    visitor.visit(m_object_store_position);
+    visitor.visit(m_key);
+    visitor.visit(m_range);
+    visitor.visit(m_request);
+
+    m_source.visit([&](auto& source) {
+        visitor.visit(source);
+    });
+}
+
+// https://w3c.github.io/IndexedDB/#dom-idbcursor-key
+JS::Value IDBCursor::key()
+{
+    // The key getter steps are to return the result of converting a key to a value with the cursor’s current key.
+    if (!m_key)
+        return JS::js_undefined();
+
+    return convert_a_key_to_a_value(realm(), *m_key);
+}
+
 }

Libraries/LibWeb/IndexedDB/IDBCursor.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024, stelar7 <dudedbz@gmail.com>
+ * Copyright (c) 2024-2025, stelar7 <dudedbz@gmail.com>
  *
  * SPDX-License-Identifier: BSD-2-Clause
  */
@@ -7,10 +7,18 @@
 #pragma once
 
 #include <LibGC/Heap.h>
+#include <LibWeb/Bindings/IDBCursorPrototype.h>
 #include <LibWeb/Bindings/PlatformObject.h>
+#include <LibWeb/IndexedDB/IDBIndex.h>
+#include <LibWeb/IndexedDB/IDBKeyRange.h>
+#include <LibWeb/IndexedDB/IDBObjectStore.h>
+#include <LibWeb/IndexedDB/IDBTransaction.h>
+#include <LibWeb/IndexedDB/Internal/Key.h>
 
 namespace Web::IndexedDB {
 
+using CursorSource = Variant<GC::Ref<IDBObjectStore>, GC::Ref<IDBIndex>>;
+
 // https://w3c.github.io/IndexedDB/#cursor-interface
 class IDBCursor : public Bindings::PlatformObject {
     WEB_PLATFORM_OBJECT(IDBCursor, Bindings::PlatformObject);
@@ -18,10 +26,55 @@ class IDBCursor : public Bindings::PlatformObject {
 
 public:
     virtual ~IDBCursor() override;
-    [[nodiscard]] static GC::Ref<IDBCursor> create(JS::Realm&);
+    [[nodiscard]] static GC::Ref<IDBCursor> create(JS::Realm&, GC::Ref<IDBTransaction>, GC::Ptr<Key>, Bindings::IDBCursorDirection, bool, GC::Ptr<Key>, JS::Value, CursorSource, GC::Ref<IDBKeyRange>, bool);
+
+    [[nodiscard]] CursorSource source() { return m_source; }
+    [[nodiscard]] Bindings::IDBCursorDirection direction() { return m_direction; }
+    [[nodiscard]] JS::Value key();
+    [[nodiscard]] JS::Value value() { return m_value.value_or(JS::js_undefined()); }
+    [[nodiscard]] GC::Ptr<IDBRequest> request() { return m_request; }
+    [[nodiscard]] GC::Ref<IDBTransaction> transaction() { return m_transaction; }
+    [[nodiscard]] GC::Ref<IDBKeyRange> range() { return m_range; }
+    [[nodiscard]] GC::Ptr<Key> position() { return m_position; }
+    [[nodiscard]] GC::Ptr<Key> object_store_position() { return m_object_store_position; }
+    [[nodiscard]] bool key_only() const { return m_key_only; }
+    [[nodiscard]] bool got_value() const { return m_got_value; }
 
 protected:
-    explicit IDBCursor(JS::Realm&);
+    explicit IDBCursor(JS::Realm&, GC::Ref<IDBTransaction>, GC::Ptr<Key>, Bindings::IDBCursorDirection, bool, GC::Ptr<Key>, JS::Value, CursorSource, GC::Ref<IDBKeyRange>, bool);
     virtual void initialize(JS::Realm&) override;
+    virtual void visit_edges(Visitor& visitor) override;
+
+private:
+    // A cursor has a transaction, the transaction that was active when the cursor was created.
+    GC::Ref<IDBTransaction> m_transaction;
+
+    // A cursor has a position within its range.
+    GC::Ptr<Key> m_position;
+
+    // When iterating indexes the cursor also has an object store position
+    GC::Ptr<Key> m_object_store_position;
+
+    // A cursor has a direction that determines whether it moves in monotonically increasing or decreasing order of the record keys when iterated, and if it skips duplicated values when iterating indexes.
+    Bindings::IDBCursorDirection m_direction;
+
+    // A cursor has a got value flag.
+    bool m_got_value { false };
+
+    // A cursor has a key and a value which represent the key and the value of the last iterated record.
+    GC::Ptr<Key> m_key;
+    Optional<JS::Value> m_value;
+
+    // A cursor has a source that indicates which index or an object store is associated with the records over which the cursor is iterating.
+    CursorSource m_source;
+
+    // A cursor has a range of records in either an index or an object store.
+    GC::Ref<IDBKeyRange> m_range;
+
+    // A cursor has a request, which is the request used to open the cursor.
+    GC::Ptr<IDBRequest> m_request;
+
+    // A cursor also has a key only flag, that indicates whether the cursor’s value is exposed via the API.
+    bool m_key_only { false };
 };
 }

Libraries/LibWeb/IndexedDB/IDBCursor.idl

@@ -2,11 +2,11 @@
 
 [Exposed=(Window,Worker)]
 interface IDBCursor {
-    [FIXME] readonly attribute (IDBObjectStore or IDBIndex) source;
+    readonly attribute (IDBObjectStore or IDBIndex) source;
-    [FIXME] readonly attribute IDBCursorDirection direction;
+    readonly attribute IDBCursorDirection direction;
-    [FIXME] readonly attribute any key;
+    readonly attribute any key;
     [FIXME] readonly attribute any primaryKey;
-    [FIXME, SameObject] readonly attribute IDBRequest request;
+    [SameObject] readonly attribute IDBRequest request;
     [FIXME] undefined advance([EnforceRange] unsigned long count);
     [FIXME] undefined continue(optional any key);
     [FIXME] undefined continuePrimaryKey(any key, any primaryKey);