LibWeb: Close WebSockets when document is unloaded

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
commit 12a07b4fad
Notes: github-actions[bot] 2025-02-26 10:48:29 +00:00
5 changed files with 66 additions and 3 deletions

View file

@ -44,6 +44,7 @@
#include <LibWeb/WebIDL/DOMException.h>
#include <LibWeb/WebIDL/ExceptionOr.h>
#include <LibWeb/WebIDL/Types.h>
#include <LibWeb/WebSockets/WebSocket.h>
namespace Web::HTML {
@ -638,6 +639,28 @@ void WindowOrWorkerGlobalScopeMixin::forcibly_close_all_event_sources()
event_source->forcibly_close();
}
void WindowOrWorkerGlobalScopeMixin::register_web_socket(Badge<WebSockets::WebSocket>, GC::Ref<WebSockets::WebSocket> web_socket)
{
m_registered_web_sockets.append(web_socket);
}
void WindowOrWorkerGlobalScopeMixin::unregister_web_socket(Badge<WebSockets::WebSocket>, GC::Ref<WebSockets::WebSocket> web_socket)
{
m_registered_web_sockets.remove(web_socket);
}
WindowOrWorkerGlobalScopeMixin::AffectedAnyWebSockets WindowOrWorkerGlobalScopeMixin::make_disappear_all_web_sockets()
{
auto affected_any_web_sockets = AffectedAnyWebSockets::No;
for (auto& web_socket : m_registered_web_sockets) {
web_socket.make_disappear();
affected_any_web_sockets = AffectedAnyWebSockets::Yes;
}
return affected_any_web_sockets;
}
// https://html.spec.whatwg.org/multipage/timers-and-user-prompts.html#run-steps-after-a-timeout
void WindowOrWorkerGlobalScopeMixin::run_steps_after_a_timeout(i32 timeout, Function<void()> completion_step)
{

View file

@ -18,6 +18,7 @@
#include <LibWeb/HTML/ImageBitmap.h>
#include <LibWeb/PerformanceTimeline/PerformanceEntry.h>
#include <LibWeb/PerformanceTimeline/PerformanceEntryTuple.h>
#include <LibWeb/WebSockets/WebSocket.h>
namespace Web::HTML {
@ -63,6 +64,15 @@ public:
void unregister_event_source(Badge<EventSource>, GC::Ref<EventSource>);
void forcibly_close_all_event_sources();
void register_web_socket(Badge<WebSockets::WebSocket>, GC::Ref<WebSockets::WebSocket>);
void unregister_web_socket(Badge<WebSockets::WebSocket>, GC::Ref<WebSockets::WebSocket>);
enum class AffectedAnyWebSockets {
No,
Yes,
};
AffectedAnyWebSockets make_disappear_all_web_sockets();
void run_steps_after_a_timeout(i32 timeout, Function<void()> completion_step);
[[nodiscard]] GC::Ref<HighResolutionTime::Performance> performance();
@ -123,6 +133,8 @@ private:
GC::Ptr<Crypto::Crypto> m_crypto;
bool m_error_reporting_mode { false };
WebSockets::WebSocket::List m_registered_web_sockets;
};
}