Ladybird/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-06-09 09:34:57 +09:00
Code Activity

LibWeb: Close WebSockets when document is unloaded

Browse source 
Previously, they would stay open for the entire WebContent lifetime,
or until the server closed the connection. This was particularly
noticeable on collaborative websites/games such as
https://jigsawpuzzles.io/, where the user using Ladybird would stick
around even after they had navigated away.
This commit is contained in:
Luke Wilde 2025-02-25 12:41:52 +00:00 • committed by Andreas Kling
parent 3224f8acb5
commit 12a07b4fad
Notes: github-actions[bot] 2025-02-26 10:48:29 +00:00
5 changed files with 66 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -121,6 +121,9 @@ void WebSocket::initialize(JS::Realm& realm)
{
Base::initialize(realm);
WEB_SET_PROTOTYPE_FOR_INTERFACE(WebSocket);
auto& relevant_global = as<HTML::WindowOrWorkerGlobalScopeMixin>(HTML::relevant_global_object(*this));
relevant_global.register_web_socket({}, *this);
}
// https://html.spec.whatwg.org/multipage/server-sent-events.html#garbage-collection
@ -134,6 +137,9 @@ void WebSocket::finalize()
// FIXME: LibProtocol does not yet support sending empty Close messages, so we use default values for now
m_websocket->close(1000);
}
auto& relevant_global = as<HTML::WindowOrWorkerGlobalScopeMixin>(HTML::relevant_global_object(*this));
relevant_global.unregister_web_socket({}, *this);
}
// https://html.spec.whatwg.org/multipage/server-sent-events.html#garbage-collection
@ -395,6 +401,19 @@ void WebSocket::on_message(ByteBuffer message, bool is_text)
}));
}
// https://websockets.spec.whatwg.org/#make-disappear
void WebSocket::make_disappear()
{
// -> If the WebSocket connection is not yet established [WSP]
// - Fail the WebSocket connection. [WSP]
// -> If the WebSocket closing handshake has not yet been started [WSP]
// - Start the WebSocket closing handshake, with the status code to use in the WebSocket Close message being 1001. [WSP]
// -> Otherwise
// - Do nothing.
// NOTE: All of these are handled by the WebSocket Protocol when calling close()
m_websocket->close(1001);
}
#undef __ENUMERATE
#define __ENUMERATE(attribute_name, event_name) \
void WebSocket::set_##attribute_name(WebIDL::CallbackType* value) \

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

@ -15,7 +15,6 @@
#include <LibWeb/Bindings/PlatformObject.h>
#include <LibWeb/DOM/EventTarget.h>
#include <LibWeb/Forward.h>
#include <LibWeb/HTML/Window.h>
#include <LibWeb/WebIDL/ExceptionOr.h>
#define ENUMERATE_WEBSOCKET_EVENT_HANDLERS(E) \
@ -55,6 +54,8 @@ public:
WebIDL::ExceptionOr<void> close(Optional<u16> code, Optional<String> reason);
WebIDL::ExceptionOr<void> send(Variant<GC::Root<WebIDL::BufferSource>, GC::Root<FileAPI::Blob>, String> const& data);
void make_disappear();
private:
void on_open();
void on_message(ByteBuffer message, bool is_text);
@ -72,6 +73,11 @@ private:
URL::URL m_url;
String m_binary_type { "blob"_string };
RefPtr<Requests::WebSocket> m_websocket;
IntrusiveListNode<WebSocket> m_list_node;
public:
using List = IntrusiveList<&WebSocket::m_list_node>;
};
}