LibWeb: Make History GC-allocated

Author: https://github.com/awesomekling
Commit: https://github.com/SerenityOS/serenity/commit/16fbb91aa1
Pull-request: https://github.com/SerenityOS/serenity/pull/14816
Reviewed-by: https://github.com/ADKaster
Reviewed-by: https://github.com/linusg ✅

Userland/Libraries/LibWeb/DOM/Document.cpp

@@ -281,7 +281,6 @@ Document::Document(HTML::Window& window, const AK::URL& url)
     , m_style_computer(make<CSS::StyleComputer>(*this))
     , m_url(url)
     , m_window(window)
-    , m_history(HTML::History::create(*this))
 {
     set_prototype(&window.ensure_web_prototype<Bindings::DocumentPrototype>("Document"));
 
@@ -315,6 +314,7 @@ void Document::visit_edges(Cell::Visitor& visitor)
     visitor.visit(m_current_script.ptr());
     visitor.visit(m_associated_inert_template_document.ptr());
     visitor.visit(m_pending_parsing_blocking_script.ptr());
+    visitor.visit(m_history.ptr());
 
     for (auto& script : m_scripts_to_execute_when_parsing_has_finished)
         visitor.visit(script.ptr());
@@ -1812,4 +1812,11 @@ CSS::StyleSheetList const& Document::style_sheets() const
     return const_cast<Document*>(this)->style_sheets();
 }
 
+JS::NonnullGCPtr<HTML::History> Document::history()
+{
+    if (!m_history)
+        m_history = HTML::History::create(window(), *this);
+    return *m_history;
+}
+
 }

Userland/Libraries/LibWeb/DOM/Document.h

@@ -298,7 +298,7 @@ public:
     bool is_fully_active() const;
     bool is_active() const;
 
-    NonnullRefPtr<HTML::History> history() const { return m_history; }
+    JS::NonnullGCPtr<HTML::History> history();
 
     Bindings::LocationObject* location();
 
@@ -433,7 +433,7 @@ private:
     // https://html.spec.whatwg.org/multipage/semantics.html#script-blocking-style-sheet-counter
     u32 m_script_blocking_style_sheet_counter { 0 };
 
-    NonnullRefPtr<HTML::History> m_history;
+    JS::GCPtr<HTML::History> m_history;
 
     size_t m_number_of_things_delaying_the_load_event { 0 };
 

Userland/Libraries/LibWeb/Forward.h

@@ -462,7 +462,6 @@ class DOMRectWrapper;
 class FileWrapper;
 class HeadersWrapper;
 class HeadersIteratorWrapper;
-class HistoryWrapper;
 class IdleDeadlineWrapper;
 class ImageDataWrapper;
 class IntersectionObserverWrapper;

Userland/Libraries/LibWeb/HTML/History.cpp

@@ -4,18 +4,32 @@
  * SPDX-License-Identifier: BSD-2-Clause
  */
 
+#include <LibWeb/Bindings/HistoryPrototype.h>
 #include <LibWeb/DOM/Document.h>
 #include <LibWeb/HTML/History.h>
 
 namespace Web::HTML {
 
-History::History(DOM::Document& document)
-    : m_associated_document(document)
+JS::NonnullGCPtr<History> History::create(HTML::Window& window, DOM::Document& document)
 {
+    return *window.heap().allocate<History>(window.realm(), window, document);
+}
+
+History::History(HTML::Window& window, DOM::Document& document)
+    : PlatformObject(window.realm())
+    , m_associated_document(document)
+{
+    set_prototype(&window.ensure_web_prototype<Bindings::HistoryPrototype>("History"));
 }
 
 History::~History() = default;
 
+void History::visit_edges(Cell::Visitor& visitor)
+{
+    Base::visit_edges(visitor);
+    visitor.visit(m_associated_document.ptr());
+}
+
 // https://html.spec.whatwg.org/multipage/history.html#dom-history-pushstate
 DOM::ExceptionOr<void> History::push_state(JS::Value data, String const&, String const& url)
 {
@@ -36,7 +50,7 @@ DOM::ExceptionOr<void> History::shared_history_push_replace_state(JS::Value, Str
     // 1. Let document be history's associated Document. (NOTE: Not necessary)
 
     // 2. If document is not fully active, then throw a "SecurityError" DOMException.
-    if (!m_associated_document.is_fully_active())
+    if (!m_associated_document->is_fully_active())
         return DOM::SecurityError::create("Cannot perform pushState or replaceState on a document that isn't fully active.");
 
     // 3. Optionally, return. (For example, the user agent might disallow calls to these methods that are invoked on a timer,

Userland/Libraries/LibWeb/HTML/History.h

@@ -1,31 +1,23 @@
 /*
  * Copyright (c) 2021, Luke Wilde <lukew@serenityos.org>
+ * Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
  *
  * SPDX-License-Identifier: BSD-2-Clause
  */
 
 #pragma once
 
-#include <AK/RefCounted.h>
-#include <AK/Weakable.h>
 #include <LibJS/Heap/Handle.h>
-#include <LibWeb/Bindings/Wrappable.h>
+#include <LibWeb/Bindings/PlatformObject.h>
 #include <LibWeb/DOM/ExceptionOr.h>
-#include <LibWeb/Forward.h>
 
 namespace Web::HTML {
 
-class History final
-    : public RefCounted<History>
-    , public Weakable<History>
-    , public Bindings::Wrappable {
-public:
-    using WrapperType = Bindings::HistoryWrapper;
+class History final : public Bindings::PlatformObject {
+    WEB_PLATFORM_OBJECT(History, Bindings::PlatformObject);
 
-    static NonnullRefPtr<History> create(DOM::Document& document)
-    {
-        return adopt_ref(*new History(document));
-    }
+public:
+    static JS::NonnullGCPtr<History> create(HTML::Window&, DOM::Document&);
 
     virtual ~History() override;
 
@@ -33,7 +25,9 @@ public:
     DOM::ExceptionOr<void> replace_state(JS::Value data, String const& unused, String const& url);
 
 private:
-    explicit History(DOM::Document&);
+    explicit History(HTML::Window&, DOM::Document&);
+
+    virtual void visit_edges(Cell::Visitor&) override;
 
     enum class IsPush {
         No,
@@ -41,7 +35,9 @@ private:
     };
     DOM::ExceptionOr<void> shared_history_push_replace_state(JS::Value data, String const& url, IsPush is_push);
 
-    DOM::Document& m_associated_document;
+    JS::NonnullGCPtr<DOM::Document> m_associated_document;
 };
 
 }
+
+WRAPPER_HACK(History, Web::HTML)

Userland/Libraries/LibWeb/HTML/Window.cpp

@@ -19,7 +19,6 @@
 #include <LibWeb/Bindings/EventTargetConstructor.h>
 #include <LibWeb/Bindings/EventTargetPrototype.h>
 #include <LibWeb/Bindings/ExceptionOrUtils.h>
-#include <LibWeb/Bindings/HistoryWrapper.h>
 #include <LibWeb/Bindings/IDLAbstractOperations.h>
 #include <LibWeb/Bindings/IdleDeadlineWrapper.h>
 #include <LibWeb/Bindings/LocationObject.h>

Userland/Libraries/LibWeb/idl_files.cmake

@@ -67,7 +67,7 @@ libweb_js_wrapper(HTML/CloseEvent NO_INSTANCE)
 libweb_js_wrapper(HTML/DOMParser NO_INSTANCE)
 libweb_js_wrapper(HTML/DOMStringMap NO_INSTANCE)
 libweb_js_wrapper(HTML/ErrorEvent NO_INSTANCE)
-libweb_js_wrapper(HTML/History)
+libweb_js_wrapper(HTML/History NO_INSTANCE)
 libweb_js_wrapper(HTML/HTMLAnchorElement NO_INSTANCE)
 libweb_js_wrapper(HTML/HTMLAreaElement NO_INSTANCE)
 libweb_js_wrapper(HTML/HTMLAudioElement NO_INSTANCE)