Skip to content

Lightpanda: the headless browser designed for AI and automation

worker: Worker EventTargets clean up after themselves.

Karl Seguin846e69ef218f
diff --git a/src/browser/Page.zig b/src/browser/Page.zig
index 6a912f116..257aa3e70 100644
--- a/src/browser/Page.zig
+++ b/src/browser/Page.zig
@@ -30,6 +30,8 @@ const EventManagerBase = @import("EventManagerBase.zig");
const Blob = @import("webapi/Blob.zig");
const Node = @import("webapi/Node.zig");
const Element = @import("webapi/Element.zig");
+const EventTarget = @import("webapi/EventTarget.zig");
+const WorkerGlobalScope = @import("webapi/WorkerGlobalScope.zig");
const SharedWorkerGlobalScope = @import("webapi/SharedWorkerGlobalScope.zig");
const PointList = @import("webapi/svg/PointList.zig");
const StringList = @import("webapi/svg/StringList.zig");
@@ -170,6 +172,9 @@ finalizer_callbacks: std.AutoHashMapUnmanaged(usize, js.FinalizerCallback) = .em
// can be reached and live beyond its Frame.
event_listeners: EventManagerBase,
+// Every live WorkerGlobalScope of this page
+worker_scopes: std.DoublyLinkedList = .{},
+
// Persisted v8 handles owned by this Page. Handles that outlive the Page are
// reset on teardown; handles that can be released early are dropped
// individually. See js.GlobalTracker.
@@ -510,6 +515,17 @@ fn findPopupBy(self: *Page, comptime field: []const u8, id: u32) ?*Frame {
return null;
}
+// Called when an EventTarget is eagerly freed. Any listener it installed need
+// to be freed.
+pub fn removeTarget(self: *Page, target: *EventTarget) void {
+ self.event_listeners.removeTarget(target);
+ var node = self.worker_scopes.first;
+ while (node) |n| : (node = n.next) {
+ const wgs: *WorkerGlobalScope = @alignCast(@fieldParentPtr("_page_node", n));
+ wgs._event_manager.removeTarget(target);
+ }
+}
+
// Snapshots the Execution of every same-origin global in this Page — the root
// frame, descendant iframes, popups (and their descendants), and each frame's
// worker scopes — into `arena`.
diff --git a/src/browser/webapi/FileReader.zig b/src/browser/webapi/FileReader.zig
index 415689123..6858ef967 100644
--- a/src/browser/webapi/FileReader.zig
+++ b/src/browser/webapi/FileReader.zig
@@ -72,7 +72,7 @@ pub fn init(exec: *Execution) !*FileReader {
}
pub fn deinit(self: *FileReader, page: *Page) void {
- page.event_listeners.removeTarget(self.asEventTarget());
+ page.removeTarget(self.asEventTarget());
self._arena.release();
}
diff --git a/src/browser/webapi/Notification.zig b/src/browser/webapi/Notification.zig
index 5f3de9677..765b083b4 100644
--- a/src/browser/webapi/Notification.zig
+++ b/src/browser/webapi/Notification.zig
@@ -80,7 +80,7 @@ pub fn init(title: []const u8, options_: ?Options, exec: *const Execution) !*Not
}
pub fn deinit(self: *Notification, page: *Page) void {
- page.event_listeners.removeTarget(self._proto);
+ page.removeTarget(self._proto);
self._arena.release();
}
diff --git a/src/browser/webapi/WorkerGlobalScope.zig b/src/browser/webapi/WorkerGlobalScope.zig
index 0ae6d3d79..e0b9d3f29 100644
--- a/src/browser/webapi/WorkerGlobalScope.zig
+++ b/src/browser/webapi/WorkerGlobalScope.zig
@@ -96,6 +96,9 @@ _loader_id: u32,
// Event management for non-DOM targets in worker context
_event_manager: EventManagerBase,
+// Links in page.worker_scopes
+_page_node: std.DoublyLinkedList.Node = .{},
+
// Handles module imports (static + dynamic). No parser integration since
// workers don't have <script> tags.
_script_manager: ScriptManagerBase,
@@ -202,6 +205,7 @@ pub fn init(
// features like BroadcastChannel can reach across the page/worker boundary.
try self.js.setOrigin(self.origin);
+ self.page.worker_scopes.append(&self._page_node);
return leaf;
}
@@ -210,6 +214,7 @@ pub fn deinit(self: *WorkerGlobalScope) void {
const session = page.session;
const browser = session.browser;
+ page.worker_scopes.remove(&self._page_node);
browser.http_client.abortOwner(&self._http_owner);
// Close this worker's MessagePorts before the context dies: this severs
diff --git a/src/browser/webapi/net/EventSource.zig b/src/browser/webapi/net/EventSource.zig
index 8b13a2e87..c33d51c16 100644
--- a/src/browser/webapi/net/EventSource.zig
+++ b/src/browser/webapi/net/EventSource.zig
@@ -131,7 +131,7 @@ pub fn deinit(self: *EventSource, page: *Page) void {
transfer.cancel();
}
- page.event_listeners.removeTarget(self.asEventTarget());
+ page.removeTarget(self.asEventTarget());
self._arena.release();
}
diff --git a/src/browser/webapi/net/WebSocket.zig b/src/browser/webapi/net/WebSocket.zig
index f1084831f..91008c3c9 100644
--- a/src/browser/webapi/net/WebSocket.zig
+++ b/src/browser/webapi/net/WebSocket.zig
@@ -292,7 +292,7 @@ pub fn deinit(self: *WebSocket, page: *Page) void {
arena.release();
}
- page.event_listeners.removeTarget(self.asEventTarget());
+ page.removeTarget(self.asEventTarget());
self._arena.release();
}
diff --git a/src/browser/webapi/net/XMLHttpRequest.zig b/src/browser/webapi/net/XMLHttpRequest.zig
index e8c7e28c7..849d6c111 100644
--- a/src/browser/webapi/net/XMLHttpRequest.zig
+++ b/src/browser/webapi/net/XMLHttpRequest.zig
@@ -145,9 +145,9 @@ pub fn deinit(self: *XMLHttpRequest, page: *Page) void {
self.clearResponse(page);
if (self._upload) |upload| {
- page.event_listeners.removeTarget(upload.asEventTarget());
+ page.removeTarget(upload.asEventTarget());
}
- page.event_listeners.removeTarget(self.asEventTarget());
+ page.removeTarget(self.asEventTarget());
self._arena.release();
}
@@ -959,3 +959,51 @@ test "WebApi: XHR listeners are dropped when the XHR is freed" {
, null);
try testing.expectEqual(0, try fired.toF64());
}
+
+test "WebApi: worker XHR listeners are dropped when the XHR is freed" {
+ // Same as above, but in a worker, whose listeners live in its own store.
+ const frame = try testing.createFrame();
+ defer testing.test_session.closeAllPages();
+
+ // Navigate the frame first to avoid CORS blocking request for the worker.
+ try frame.navigate("http://localhost:9582/", .{});
+ try testing.waitForFrame();
+
+ const worker = try @import("../Worker.zig").init("http://localhost:9582/src/browser/tests/testing.js", null, frame);
+ const ctx = worker._worker_scope._proto.js;
+
+ {
+ var ls: js.Local.Scope = undefined;
+ ctx.localScope(&ls);
+ defer ls.deinit();
+ _ = try ls.local.exec(
+ \\globalThis.fired = 0;
+ \\for (let i = 0; i < 200; i++) {
+ \\ new XMLHttpRequest().addEventListener('foo', () => fired++);
+ \\ new XMLHttpRequest().upload.addEventListener('foo', () => fired++);
+ \\ new XMLHttpRequest().onload = () => fired++;
+ \\ new XMLHttpRequest().upload.onload = () => fired++;
+ \\}
+ , null);
+ }
+
+ // Not env.memoryPressureNotification: it skips small heaps.
+ const isolate = testing.test_session.browser.env.isolate;
+ for (0..3) |_| {
+ isolate.memoryPressureNotification(.critical);
+ }
+
+ var ls: js.Local.Scope = undefined;
+ ctx.localScope(&ls);
+ defer ls.deinit();
+ const fired = try ls.local.exec(
+ \\for (let i = 0; i < 200; i++) {
+ \\ new XMLHttpRequest().dispatchEvent(new Event('foo'));
+ \\ new XMLHttpRequest().upload.dispatchEvent(new Event('foo'));
+ \\ new XMLHttpRequest().dispatchEvent(new Event('load'));
+ \\ new XMLHttpRequest().upload.dispatchEvent(new Event('load'));
+ \\}
+ \\fired;
+ , null);
+ try testing.expectEqual(0, try fired.toF64());
+}
diff --git a/src/browser/webapi/storage/idb/IDBTransaction.zig b/src/browser/webapi/storage/idb/IDBTransaction.zig
index e522064e4..92e39dc6d 100644
--- a/src/browser/webapi/storage/idb/IDBTransaction.zig
+++ b/src/browser/webapi/storage/idb/IDBTransaction.zig
@@ -196,9 +196,9 @@ pub fn deinit(self: *IDBTransaction, page: *Page) void {
slot.release();
}
for (self._requests.items) |request| {
- page.event_listeners.removeTarget(request.asEventTarget());
+ page.removeTarget(request.asEventTarget());
}
- page.event_listeners.removeTarget(self.asEventTarget());
+ page.removeTarget(self.asEventTarget());
self._arena.release();
}