Skip to content

Lightpanda: the headless browser designed for AI and automation

mem: improve event memory cleanup

Karl Seguine0660e0055e5
diff --git a/src/browser/webapi/Event.zig b/src/browser/webapi/Event.zig
index 807c8a4ad..72d61064e 100644
--- a/src/browser/webapi/Event.zig
+++ b/src/browser/webapi/Event.zig
@@ -172,10 +172,30 @@ pub fn acquireRef(self: *Event) void {
self._rc.acquire();
}
-pub fn deinit(self: *Event, _: *Page) void {
+pub fn deinit(self: *Event, page: *Page) void {
+ deinitSubtypes(self, page);
self._arena.release();
}
+fn deinitSubtypes(value: anytype, page: *Page) void {
+ const T = @typeInfo(@TypeOf(value)).pointer.child;
+ if (T != Event and (@hasDecl(T, "acquireRef") or @hasDecl(T, "releaseRef"))) {
+ @compileError(@typeName(T) ++ " must not define acquireRef/releaseRef: the RC is Event's; put cleanup in deinit");
+ }
+ if (@hasField(T, "_type")) {
+ switch (value._type) {
+ inline else => |child| {
+ if (@typeInfo(@TypeOf(child)) == .pointer) {
+ deinitSubtypes(child, page);
+ }
+ },
+ }
+ }
+ if (T != Event and @hasDecl(T, "deinit")) {
+ value.deinit(page);
+ }
+}
+
pub fn releaseRef(self: *Event, page: *Page) void {
self._rc.release(self, page);
}
@@ -506,3 +526,21 @@ pub const JsApi = struct {
};
// tested in event_target
+
+const testing = @import("../../testing.zig");
+test "WebApi: Event subtype cleanup runs when dispatch drops the last ref" {
+ const page = try testing.pageTest("mcp_actions.html", .{});
+ defer page.close();
+ const frame = page.frame().?;
+
+ var ls: js.Local.Scope = undefined;
+ frame.js.localScope(&ls);
+ defer ls.deinit();
+
+ // onerror gets the ErrorEvent's fields, not the event, so no JS wrapper
+ // ever holds the event: the Zig side drops the last reference.
+ _ = try ls.local.exec("window.onerror = () => true;", null);
+ const before = frame.page.globals.list.items.len;
+ _ = try ls.local.exec("for (let i = 0; i < 10; i++) reportError(new Error('x'));", null);
+ try testing.expectEqual(before, frame.page.globals.list.items.len);
+}
diff --git a/src/browser/webapi/ServiceWorkerGlobalScope.zig b/src/browser/webapi/ServiceWorkerGlobalScope.zig
index 39619a1c3..68941410b 100644
--- a/src/browser/webapi/ServiceWorkerGlobalScope.zig
+++ b/src/browser/webapi/ServiceWorkerGlobalScope.zig
@@ -411,7 +411,7 @@ fn dispatchExtendable(
fn releasePendingEvent(self: *ServiceWorkerGlobalScope) void {
const event = self._pending_event orelse return;
self._pending_event = null;
- event.releaseRef(self._proto.page);
+ event.asEvent().releaseRef(self._proto.page);
}
fn setState(self: *ServiceWorkerGlobalScope, state: ServiceWorker.State) void {
diff --git a/src/browser/webapi/event/CustomEvent.zig b/src/browser/webapi/event/CustomEvent.zig
index 5f1a43e31..080c0e022 100644
--- a/src/browser/webapi/event/CustomEvent.zig
+++ b/src/browser/webapi/event/CustomEvent.zig
@@ -83,19 +83,10 @@ fn initCustomEvent(
self._detail = detail_;
}
-pub fn deinit(self: *CustomEvent, page: *Page) void {
+pub fn deinit(self: *CustomEvent, _: *Page) void {
if (self._detail) |d| {
d.release();
}
- self._proto.deinit(page);
-}
-
-pub fn releaseRef(self: *CustomEvent, page: *Page) void {
- self._proto._rc.release(self, page);
-}
-
-pub fn acquireRef(self: *CustomEvent) void {
- self._proto.acquireRef();
}
pub fn asEvent(self: *CustomEvent) *Event {
diff --git a/src/browser/webapi/event/DragEvent.zig b/src/browser/webapi/event/DragEvent.zig
index def507489..e11d528a0 100644
--- a/src/browser/webapi/event/DragEvent.zig
+++ b/src/browser/webapi/event/DragEvent.zig
@@ -97,15 +97,6 @@ pub fn deinit(self: *DragEvent, page: *Page) void {
if (self._data_transfer) |dt| {
dt.releaseRef(page);
}
- self.asEvent().deinit(page);
-}
-
-pub fn acquireRef(self: *DragEvent) void {
- self.asEvent().acquireRef();
-}
-
-pub fn releaseRef(self: *DragEvent, page: *Page) void {
- self.asEvent()._rc.release(self, page);
}
pub fn asEvent(self: *DragEvent) *Event {
diff --git a/src/browser/webapi/event/ErrorEvent.zig b/src/browser/webapi/event/ErrorEvent.zig
index 53d629a1f..acd4f0dc3 100644
--- a/src/browser/webapi/event/ErrorEvent.zig
+++ b/src/browser/webapi/event/ErrorEvent.zig
@@ -83,19 +83,10 @@ fn initWithTrusted(arena: *lp.Arena, typ: String, opts_: ?Options, trusted: bool
return event;
}
-pub fn deinit(self: *ErrorEvent, page: *Page) void {
+pub fn deinit(self: *ErrorEvent, _: *Page) void {
if (self._error) |e| {
e.release();
}
- self._proto.deinit(page);
-}
-
-pub fn releaseRef(self: *ErrorEvent, page: *Page) void {
- self._proto._rc.release(self, page);
-}
-
-pub fn acquireRef(self: *ErrorEvent) void {
- self._proto.acquireRef();
}
pub fn asEvent(self: *ErrorEvent) *Event {
diff --git a/src/browser/webapi/event/ExtendableEvent.zig b/src/browser/webapi/event/ExtendableEvent.zig
index 290fa29fe..354f0724b 100644
--- a/src/browser/webapi/event/ExtendableEvent.zig
+++ b/src/browser/webapi/event/ExtendableEvent.zig
@@ -69,18 +69,6 @@ pub fn initTrusted(typ: String, opts_: ?Options, page: *Page) !*ExtendableEvent
return event;
}
-pub fn deinit(self: *ExtendableEvent, page: *Page) void {
- self._proto.deinit(page);
-}
-
-pub fn releaseRef(self: *ExtendableEvent, page: *Page) void {
- self._proto._rc.release(self, page);
-}
-
-pub fn acquireRef(self: *ExtendableEvent) void {
- self._proto.acquireRef();
-}
-
pub fn asEvent(self: *ExtendableEvent) *Event {
return self._proto;
}
diff --git a/src/browser/webapi/event/InputEvent.zig b/src/browser/webapi/event/InputEvent.zig
index 83d27e047..ef3b0c565 100644
--- a/src/browser/webapi/event/InputEvent.zig
+++ b/src/browser/webapi/event/InputEvent.zig
@@ -107,15 +107,6 @@ pub fn deinit(self: *InputEvent, page: *Page) void {
if (self._data_transfer) |dt| {
dt.releaseRef(page);
}
- self.asEvent().deinit(page);
-}
-
-pub fn acquireRef(self: *InputEvent) void {
- self.asEvent().acquireRef();
-}
-
-pub fn releaseRef(self: *InputEvent, page: *Page) void {
- self.asEvent()._rc.release(self, page);
}
pub fn asEvent(self: *InputEvent) *Event {
diff --git a/src/browser/webapi/event/MessageEvent.zig b/src/browser/webapi/event/MessageEvent.zig
index 78a9ac2d3..de1c51b95 100644
--- a/src/browser/webapi/event/MessageEvent.zig
+++ b/src/browser/webapi/event/MessageEvent.zig
@@ -102,15 +102,6 @@ pub fn deinit(self: *MessageEvent, page: *Page) void {
.string, .arraybuffer => {},
}
}
- self._proto.deinit(page);
-}
-
-pub fn acquireRef(self: *MessageEvent) void {
- self._proto.acquireRef();
-}
-
-pub fn releaseRef(self: *MessageEvent, page: *Page) void {
- self._proto._rc.release(self, page);
}
pub fn asEvent(self: *MessageEvent) *Event {
diff --git a/src/browser/webapi/event/NavigateEvent.zig b/src/browser/webapi/event/NavigateEvent.zig
index 346b24052..67b0e70ec 100644
--- a/src/browser/webapi/event/NavigateEvent.zig
+++ b/src/browser/webapi/event/NavigateEvent.zig
@@ -117,15 +117,6 @@ pub fn deinit(self: *NavigateEvent, page: *Page) void {
if (self._form_data) |fd| {
fd.releaseRef(page);
}
- self._proto.deinit(page);
-}
-
-pub fn acquireRef(self: *NavigateEvent) void {
- self._proto.acquireRef();
-}
-
-pub fn releaseRef(self: *NavigateEvent, page: *Page) void {
- self._proto._rc.release(self, page);
}
pub fn asEvent(self: *NavigateEvent) *Event {
diff --git a/src/browser/webapi/event/PromiseRejectionEvent.zig b/src/browser/webapi/event/PromiseRejectionEvent.zig
index 3316b54b2..4d92adcb5 100644
--- a/src/browser/webapi/event/PromiseRejectionEvent.zig
+++ b/src/browser/webapi/event/PromiseRejectionEvent.zig
@@ -59,22 +59,13 @@ pub fn init(typ: []const u8, opts_: ?Options, page: *Page) !*PromiseRejectionEve
return event;
}
-pub fn deinit(self: *PromiseRejectionEvent, page: *Page) void {
+pub fn deinit(self: *PromiseRejectionEvent, _: *Page) void {
if (self._reason) |r| {
r.release();
}
if (self._promise) |p| {
p.release();
}
- self._proto.deinit(page);
-}
-
-pub fn releaseRef(self: *PromiseRejectionEvent, page: *Page) void {
- self._proto._rc.release(self, page);
-}
-
-pub fn acquireRef(self: *PromiseRejectionEvent) void {
- self._proto.acquireRef();
}
pub fn asEvent(self: *PromiseRejectionEvent) *Event {
diff --git a/src/browser/webapi/event/Touch.zig b/src/browser/webapi/event/Touch.zig
index 23fd0dcb8..a32788622 100644
--- a/src/browser/webapi/event/Touch.zig
+++ b/src/browser/webapi/event/Touch.zig
@@ -17,17 +17,19 @@
// along with this program. If not, see <https://www.gnu.org/licenses/>.
const std = @import("std");
+const lp = @import("lightpanda");
const js = @import("../../js/js.zig");
+const Page = @import("../../Page.zig");
const Frame = @import("../../Frame.zig");
const EventTarget = @import("../EventTarget.zig");
// https://w3c.github.io/touch-events/#idl-def-touch
//
-// Allocated by the frame's factory, so it lives as long as the frame: a Touch
-// can be shared by any number of TouchLists, of trusted events and of events
-// the page builds, and none of them owns it.
+// Shared by any number of events (trusted or built by the page), so it's
+// reference counted: its JS wrapper and each TouchEvent list it's in hold a ref.
const Touch = @This();
+_rc: lp.RC = .{},
// EventTarget, not Element, per spec, and because dispatch retargets a trusted
// touch's target across shadow boundaries the same way it retargets
// Event.target (see TouchEvent.touchTargetPtr / EventManager's AdjustedTargets).
@@ -104,6 +106,18 @@ pub fn initTrusted(target: *EventTarget, point: Point, frame: *Frame) !*Touch {
});
}
+pub fn deinit(self: *Touch, page: *Page) void {
+ page.factory.destroy(self);
+}
+
+pub fn acquireRef(self: *Touch) void {
+ self._rc.acquire();
+}
+
+pub fn releaseRef(self: *Touch, page: *Page) void {
+ self._rc.release(self, page);
+}
+
fn getIdentifier(self: *const Touch) i32 {
return self._point.id;
}
diff --git a/src/browser/webapi/event/TouchEvent.zig b/src/browser/webapi/event/TouchEvent.zig
index ba90f850f..4b1a2a74d 100644
--- a/src/browser/webapi/event/TouchEvent.zig
+++ b/src/browser/webapi/event/TouchEvent.zig
@@ -20,6 +20,7 @@ const std = @import("std");
const lp = @import("lightpanda");
const js = @import("../../js/js.zig");
+const Page = @import("../../Page.zig");
const Frame = @import("../../Frame.zig");
const Event = @import("../Event.zig");
@@ -43,6 +44,7 @@ _ctrl_key: bool = false,
_shift_key: bool = false,
// The touch input dispatched this event for, whose target dispatch retargets.
_trusted_touch: ?*Touch = null,
+// Each entry holds a ref on its Touch, released in deinit.
_touches: []const *Touch = &.{},
_target_touches: []const *Touch = &.{},
_changed_touches: []const *Touch = &.{},
@@ -77,14 +79,20 @@ pub fn initTrusted(typ: []const u8, _opts: ?Options, frame: *Frame) !*TouchEvent
/// active one unless it's being lifted (touchend, touchcancel).
pub fn initTrustedWithTouch(typ: []const u8, _opts: ?Options, target: *Element, point: Touch.Point, frame: *Frame) !*TouchEvent {
const event = try initWithTrusted(typ, _opts, true, frame);
+ // The lists are replaced below, which would leak refs taken on given ones.
+ std.debug.assert(event._touches.len == 0 and event._target_touches.len == 0 and event._changed_touches.len == 0);
+ const one = try event.asEvent()._arena.allocator().alloc(*Touch, 1);
const touch = try Touch.initTrusted(target.asEventTarget(), point, frame);
- const lifted = std.mem.eql(u8, typ, "touchend") or std.mem.eql(u8, typ, "touchcancel");
- const one = try event.asEvent()._arena.allocator().dupe(*Touch, &.{touch});
+ one[0] = touch;
event._trusted_touch = touch;
event._changed_touches = one;
+ touch.acquireRef();
+ const lifted = std.mem.eql(u8, typ, "touchend") or std.mem.eql(u8, typ, "touchcancel");
if (!lifted) {
event._touches = one;
event._target_touches = one;
+ touch.acquireRef();
+ touch.acquireRef();
}
return event;
}
@@ -110,10 +118,20 @@ fn initWithTrusted(typ: []const u8, _opts: ?Options, trusted: bool, frame: *Fram
},
);
+ for ([_][]const *Touch{ event._touches, event._target_touches, event._changed_touches }) |list| {
+ for (list) |touch| touch.acquireRef();
+ }
+
Event.populatePrototypes(event, opts, trusted);
return event;
}
+pub fn deinit(self: *TouchEvent, page: *Page) void {
+ for ([_][]const *Touch{ self._touches, self._target_touches, self._changed_touches }) |list| {
+ for (list) |touch| touch.releaseRef(page);
+ }
+}
+
pub fn asEvent(self: *TouchEvent) *Event {
return self._proto.asEvent();
}
@@ -206,3 +224,20 @@ test "WebApi: TouchEvent caches its touch lists" {
test "WebApi: TouchEvent" {
try testing.htmlRunner("event/touch.html", .{});
}
+
+test "WebApi: TouchEvent releases its touches" {
+ const page = try testing.pageTest("mcp_actions.html", .{});
+ defer page.close();
+ const frame = page.frame().?;
+ const target = frame.document.getDocumentElement().?;
+
+ const event = try initTrustedWithTouch("touchstart", null, target, .{ .x = 10, .y = 20 }, frame);
+ const touch = event._trusted_touch.?;
+ touch.acquireRef();
+ defer touch.releaseRef(frame.page);
+
+ // One ref per list, plus ours.
+ try testing.expectEqual(4, touch._rc._refs.load(.monotonic));
+ try frame._event_manager.dispatch(target.asEventTarget(), event.asEvent());
+ try testing.expectEqual(1, touch._rc._refs.load(.monotonic));
+}
diff --git a/src/browser/webapi/event/TouchList.zig b/src/browser/webapi/event/TouchList.zig
index 459cc44d6..caec818a2 100644
--- a/src/browser/webapi/event/TouchList.zig
+++ b/src/browser/webapi/event/TouchList.zig
@@ -23,8 +23,7 @@ const Touch = @import("Touch.zig");
const TouchEvent = @import("TouchEvent.zig");
// One of a TouchEvent's touches, targetTouches or changedTouches. It's in the
-// event's arena and keeps the event alive; the touches live as long as their
-// frame (see Touch).
+// event's arena and keeps the event alive, which keeps its touches alive.
const TouchList = @This();
_event: *TouchEvent,
diff --git a/src/browser/webapi/navigation/Navigation.zig b/src/browser/webapi/navigation/Navigation.zig
index 7e0cd1e5a..89824ef7a 100644
--- a/src/browser/webapi/navigation/Navigation.zig
+++ b/src/browser/webapi/navigation/Navigation.zig
@@ -402,8 +402,8 @@ pub fn fireNavigateEvent(self: *Navigation, params: NavigateEventParams, frame:
.info = if (params.info) |info| try info.persist() else null,
.sourceElement = params.source_element,
}, frame);
- event.acquireRef();
- defer event.releaseRef(frame.page);
+ event.asEvent().acquireRef();
+ defer event.asEvent().releaseRef(frame.page);
frame._ongoing_navigate = .{
.signal = signal,
diff --git a/src/browser/webapi/webaudio/OfflineAudioCompletionEvent.zig b/src/browser/webapi/webaudio/OfflineAudioCompletionEvent.zig
index 767613db0..04baba7a7 100644
--- a/src/browser/webapi/webaudio/OfflineAudioCompletionEvent.zig
+++ b/src/browser/webapi/webaudio/OfflineAudioCompletionEvent.zig
@@ -65,15 +65,6 @@ fn initWithTrusted(arena: *lp.Arena, typ: String, options: Options, trusted: boo
pub fn deinit(self: *OfflineAudioCompletionEvent, page: *Page) void {
self._rendered_buffer.releaseRef(page);
- self._proto.deinit(page);
-}
-
-pub fn acquireRef(self: *OfflineAudioCompletionEvent) void {
- self._proto.acquireRef();
-}
-
-pub fn releaseRef(self: *OfflineAudioCompletionEvent, page: *Page) void {
- self._proto._rc.release(self, page);
}
pub fn asEvent(self: *OfflineAudioCompletionEvent) *Event {