mirrors/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-04-20 19:45:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

LibWeb/WebSockets: Implement the garbage collection rules

Browse source
This commit is contained in:
Luke Wilde 2025-02-25 12:36:53 +00:00 • committed by Andreas Kling
parent b8f234719d
commit 3224f8acb5
Notes: github-actions[bot] 2025-02-26 10:48:34 +00:00
2 changed files with 60 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
Libraries/LibWeb/WebSockets/WebSocket.cpp
View file

@ -112,6 +112,7 @@ WebIDL::ExceptionOr<GC::Ref<WebSocket>> WebSocket::construct_impl(JS::Realm& rea
WebSocket::WebSocket(JS::Realm& realm)
: EventTarget(realm)
{
set_overrides_must_survive_garbage_collection(true);
}
WebSocket::~WebSocket() = default;
@ -122,6 +123,63 @@ void WebSocket::initialize(JS::Realm& realm)
WEB_SET_PROTOTYPE_FOR_INTERFACE(WebSocket);
}
// https://html.spec.whatwg.org/multipage/server-sent-events.html#garbage-collection
void WebSocket::finalize()
{
auto ready_state = this->ready_state();
// If a WebSocket object is garbage collected while its connection is still open, the user agent must start the
// WebSocket closing handshake, with no status code for the Close message. [WSP]
if (ready_state != Requests::WebSocket::ReadyState::Closing && ready_state != Requests::WebSocket::ReadyState::Closed) {
// FIXME: LibProtocol does not yet support sending empty Close messages, so we use default values for now
m_websocket->close(1000);
}
}
// https://html.spec.whatwg.org/multipage/server-sent-events.html#garbage-collection
bool WebSocket::must_survive_garbage_collection() const
{
auto ready_state = this->ready_state();
// FIXME: "as of the last time the event loop reached step 1"
// A WebSocket object whose ready state was set to CONNECTING (0) as of the last time the event loop reached step 1
// must not be garbage collected if there are any event listeners registered for open events, message events, error
// events, or close events.
if (ready_state == Requests::WebSocket::ReadyState::Connecting) {
if (has_event_listener(HTML::EventNames::open))
return true;
if (has_event_listener(HTML::EventNames::message))
return true;
if (has_event_listener(HTML::EventNames::error))
return true;
if (has_event_listener(HTML::EventNames::close))
return true;
}
// A WebSocket object whose ready state was set to OPEN (1) as of the last time the event loop reached step 1 must
// not be garbage collected if there are any event listeners registered for message events, error, or close events.
if (ready_state == Requests::WebSocket::ReadyState::Open) {
if (has_event_listener(HTML::EventNames::message))
return true;
if (has_event_listener(HTML::EventNames::error))
return true;
if (has_event_listener(HTML::EventNames::close))
return true;
}
// A WebSocket object whose ready state was set to CLOSING (2) as of the last time the event loop reached step 1
// must not be garbage collected if there are any event listeners registered for error or close events.
if (ready_state == Requests::WebSocket::ReadyState::Closing) {
if (has_event_listener(HTML::EventNames::error))
return true;
if (has_event_listener(HTML::EventNames::close))
return true;
}
return false;
}
ErrorOr<void> WebSocket::establish_web_socket_connection(URL::URL const& url_record, Vector<String> const& protocols, HTML::EnvironmentSettingsObject& client)
{
// FIXME: Integrate properly with FETCH as per https://fetch.spec.whatwg.org/#websocket-opening-handshake

2
Libraries/LibWeb/WebSockets/WebSocket.h
View file

@ -64,6 +64,8 @@ private:
WebSocket(JS::Realm&);
virtual void initialize(JS::Realm&) override;
virtual void finalize() override;
virtual bool must_survive_garbage_collection() const override;
ErrorOr<void> establish_web_socket_connection(URL::URL const& url_record, Vector<String> const& protocols, HTML::EnvironmentSettingsObject& client);