Lightpanda: the headless browser designed for AI and automation
Move EventManagerBase from Frame -> Page
Karl Seguin90e60d46dfab
diff --git a/src/browser/EventManager.zig b/src/browser/EventManager.zigindex 926365a00..805811b8e 100644--- a/src/browser/EventManager.zig+++ b/src/browser/EventManager.zig@@ -36,7 +36,6 @@ const Animation = @import("webapi/animation/Animation.zig");const XMLHttpRequestEventTarget = @import("webapi/net/XMLHttpRequestEventTarget.zig");const log = lp.log;-const Allocator = std.mem.Allocator;// Re-export types from EventManagerBase for API compatibilitypub const RegisterOptions = EventManagerBase.RegisterOptions;@@ -46,27 +45,31 @@ const Listener = EventManagerBase.Listener;pub const EventManager = @This();frame: *Frame,-base: EventManagerBase,++// The Page's listener store (page.event_listeners)+base: *EventManagerBase,// Used as an optimization in Page._documentIsComplete. If we know there are no// 'load' listeners in the document, we can skip dispatching the per-resource// 'load' event (e.g. amazon product page has no listener and ~350 resources)has_dom_load_listener: bool,-pub fn init(arena: Allocator, frame: *Frame) EventManager {+pub fn init(base: *EventManagerBase, frame: *Frame) EventManager {return .{+ .base = base,.frame = frame,.has_dom_load_listener = false,- .base = EventManagerBase.init(arena),};}pub fn register(self: *EventManager, target: *EventTarget, typ: []const u8, callback: Callback, opts: RegisterOptions) !void {const listener = (try self.base.register(target, typ, callback, opts)) orelse return;- // Track load listeners on DOM nodes for optimizationif (target._type == .node and listener.typ.eql(comptime .wrap("load"))) {- self.has_dom_load_listener = true;+ // optimization so that we avoid firing load for things (e.g. images)+ // if there's no load listener regsitered (which is pretty common).+ const owner = target.subtype(Node).ownerFrame(self.frame) orelse return;+ owner._event_manager.has_dom_load_listener = true;}}@@ -493,7 +496,7 @@ fn currentEventForTarget(target: *EventTarget, event: *Event) ?*Event {fn dispatchPhase(self: *EventManager, listeners: TargetListeners, current_target: *EventTarget, event: *Event, was_handled: *bool, local: *const js.Local, comptime capture_only: ?bool) !void {const frame = self.frame;- const base = &self.base;+ const base = self.base;const list = listeners.list;// Listeners registered under a legacy name see the event under that name.diff --git a/src/browser/EventManagerBase.zig b/src/browser/EventManagerBase.zigindex ec4cfce46..fd096d5d3 100644--- a/src/browser/EventManagerBase.zig+++ b/src/browser/EventManagerBase.zig@@ -174,6 +174,25 @@ pub fn removeListener(self: *EventManagerBase, list: *std.DoublyLinkedList, list}}+/// Drops every listener on `target`.+pub fn removeTarget(self: *EventManagerBase, target: *EventTarget) void {+ var kv = self.lookup.fetchRemove(@intFromPtr(target)) orelse return;+ for (kv.value.items) |type_listeners| {+ const list = type_listeners.list;+ var node = list.first;+ while (node) |n| {+ node = n.next;+ self.removeListener(list, @alignCast(@fieldParentPtr("node", n)));+ }+ if (self.dispatch_depth == 0) {+ self.list_pool.destroy(list);+ } else {+ // we leak this until the arena is cleared, no big deal+ }+ }+ kv.value.deinit(self.arena);+}+/// Check if there are any listeners registered for a target/type combination.fn hasListeners(self: *EventManagerBase, target: *EventTarget, typ: []const u8) bool {return self.getListeners(target, .wrap(typ)) != null;diff --git a/src/browser/Frame.zig b/src/browser/Frame.zigindex caebbfc70..8fd12399a 100644--- a/src/browser/Frame.zig+++ b/src/browser/Frame.zig@@ -385,7 +385,7 @@ pub fn init(self: *Frame, frame_id: u32, page: *Page, opts: InitOpts) !void {._style_manager = undefined,._script_manager = undefined,._ce_reactions = .{ .allocator = page_arena },- ._event_manager = EventManager.init(page_arena, self),+ ._event_manager = EventManager.init(&page.event_listeners, self),._http_owner = undefined,};self._queued_events = &self._queued_events_1;@@ -542,6 +542,7 @@ pub fn deinit(self: *Frame) void {// Release our reference to location.self.window._location.releaseRef(page);+ page.event_listeners.removeTarget(self.window.asEventTarget());}const browser = page.session.browser;diff --git a/src/browser/Page.zig b/src/browser/Page.zigindex 53a7e731a..8e63e1076 100644--- a/src/browser/Page.zig+++ b/src/browser/Page.zig@@ -25,6 +25,7 @@ const Frame = @import("Frame.zig");const Session = @import("Session.zig");const Factory = @import("Factory.zig");const Viewport = @import("Viewport.zig");+const EventManagerBase = @import("EventManagerBase.zig");const Blob = @import("webapi/Blob.zig");const Node = @import("webapi/Node.zig");@@ -164,6 +165,11 @@ identity: js.Identity = .{},// weak-callback safety.finalizer_callbacks: std.AutoHashMapUnmanaged(usize, js.FinalizerCallback) = .empty,+// Event listener registration for every Frame in the Page. This used to be+// per-frame, but a listener belongs to the target, e.g. a Node, and the Node+// can be reached and live beyond its Frame.+event_listeners: EventManagerBase,+// 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.@@ -261,6 +267,7 @@ pub fn init(self: *Page, session: *Session, frame_id: u32) !void {.arena = arena.allocator(),.factory = Factory.init(self, arena.allocator(), &session.browser.documents),.globals = .init(session.browser.app.allocator),+ .event_listeners = .init(arena.allocator()),.log_context = .{ .id = log.nextPageId(), .url = &self.frame.url },};self.queued_navigation = &self.queued_navigation_1;diff --git a/src/browser/interactive.zig b/src/browser/interactive.zigindex e2c870685..e1c080dd5 100644--- a/src/browser/interactive.zig+++ b/src/browser/interactive.zig@@ -284,7 +284,7 @@ pub fn buildListenerTargetMap(frame: *Frame, arena: Allocator) !ListenerTargetMavar map = ListenerTargetMap{};// addEventListener registrations- var it = frame._event_manager.base.lookup.iterator();+ var it = frame.page.event_listeners.lookup.iterator();while (it.next()) |entry| {for (entry.value_ptr.items) |*type_listeners| {if (type_listeners.list.first != null) {diff --git a/src/browser/tests/frames/cross_realm_listeners.html b/src/browser/tests/frames/cross_realm_listeners.htmlnew file mode 100644index 000000000..c05ae3153--- /dev/null+++ b/src/browser/tests/frames/cross_realm_listeners.html@@ -0,0 +1,88 @@+<!DOCTYPE html>+<head></head>+<body>+<script src="../testing.js"></script>++<iframe id=f1 src="support/win_a.html"></iframe>++<script id=parent_listener_on_child_node>+ testing.onload(() => {+ const cw = $('#f1').contentWindow;+ const child_body = cw.document.body;++ // The parent's function, dispatched from the child's realm.+ let fired = 0;+ child_body.addEventListener('ping', () => fired += 1);+ cw.EventTarget.prototype.dispatchEvent.call(child_body, new cw.Event('ping'));+ testing.expectEqual(1, fired);+ });+</script>++<script id=child_realm_add_on_parent_node>+ testing.onload(() => {+ const cw = $('#f1').contentWindow;++ // The child realm's addEventListener, on a parent node.+ let fired = 0;+ const listener = () => fired += 1;+ cw.EventTarget.prototype.addEventListener.call(document.body, 'pong', listener);+ document.body.dispatchEvent(new Event('pong'));+ testing.expectEqual(1, fired);++ // And removable from either realm.+ document.body.removeEventListener('pong', listener);+ document.body.dispatchEvent(new Event('pong'));+ testing.expectEqual(1, fired);+ });+</script>++<script id=dispatch_bubbles_to_owner_window>+ testing.onload(() => {+ const cw = $('#f1').contentWindow;+ const child_body = cw.document.body;++ let child_window = 0;+ let parent_window = 0;+ const on_child = () => child_window += 1;+ const on_parent = () => parent_window += 1;+ cw.addEventListener('bubble', on_child);+ window.addEventListener('bubble', on_parent);++ // The parent's dispatchEvent on a child node: the path ends at the+ // child's window.+ child_body.dispatchEvent(new Event('bubble', {bubbles: true}));+ testing.expectEqual(1, child_window);+ testing.expectEqual(0, parent_window);++ cw.removeEventListener('bubble', on_child);+ window.removeEventListener('bubble', on_parent);+ });+</script>++<script id=window_listeners_dropped_on_navigation type=module>+ const state = await testing.async();++ const iframe = document.createElement('iframe');+ const onceLoad = () => new Promise((r) => { iframe.onload = () => r(); });++ let loaded = onceLoad();+ iframe.src = 'support/win_a.html';+ document.body.appendChild(iframe);+ await loaded;++ const w = iframe.contentWindow;+ let fired = 0;+ w.addEventListener('stale', () => fired += 1);++ loaded = onceLoad();+ iframe.src = 'support/win_b.html'; // in-place re-init; Window is reused+ await loaded;++ state.resolve();+ await state.done(() => {+ testing.expectEqual(true, w === iframe.contentWindow);+ w.dispatchEvent(new Event('stale'));+ testing.expectEqual(0, fired);+ });+</script>+</body>diff --git a/src/browser/webapi/EventTarget.zig b/src/browser/webapi/EventTarget.zigindex 3bec233c4..6f0e7279b 100644--- a/src/browser/webapi/EventTarget.zig+++ b/src/browser/webapi/EventTarget.zig@@ -190,7 +190,13 @@ pub fn dispatchEvent(self: *EventTarget, event: *Event, exec: *js.Execution) !boevent._is_trusted = false;switch (exec.js.global) {- .frame => |frame| {+ .frame => |caller| {+ // a Node's event disaptches in its own frame. It doens't matter+ // where dispatchEvent was called.+ const frame = blk: {+ const node = self.is(Node) orelse break :blk caller;+ break :blk node.ownerFrame(caller) orelse caller;+ };event.acquireRef();defer _ = event.releaseRef(frame.page);try frame._event_manager.dispatch(self, event);diff --git a/src/browser/webapi/Worker.zig b/src/browser/webapi/Worker.zigindex fa946eeb1..a785dd31f 100644--- a/src/browser/webapi/Worker.zig+++ b/src/browser/webapi/Worker.zig@@ -144,6 +144,7 @@ pub fn deinit(self: *Worker) void {}self.releaseScriptArena();self._worker_scope.deinit();+ self._frame.page.event_listeners.removeTarget(self.asEventTarget());self._arena.release();}diff --git a/src/browser/webapi/css/FontFaceSet.zig b/src/browser/webapi/css/FontFaceSet.zigindex bf0936cfa..28d58d606 100644--- a/src/browser/webapi/css/FontFaceSet.zig+++ b/src/browser/webapi/css/FontFaceSet.zig@@ -45,7 +45,8 @@ pub fn init(frame: *Frame) !*FontFaceSet {});}-pub fn deinit(self: *FontFaceSet, _: *Page) void {+pub fn deinit(self: *FontFaceSet, page: *Page) void {+ page.event_listeners.removeTarget(self.asEventTarget());self._arena.release();}