Skip to content

Lightpanda: the headless browser designed for AI and automation

tie MediaQueryList to the frame, not the page

Karl Seguin6b1f77981fdc
diff --git a/src/browser/EventManager.zig b/src/browser/EventManager.zig
index cd49a8649..142c1e23a 100644
--- a/src/browser/EventManager.zig
+++ b/src/browser/EventManager.zig
@@ -30,6 +30,7 @@ const EventTarget = @import("webapi/EventTarget.zig");
const Element = @import("webapi/Element.zig");
const ShadowRoot = @import("webapi/ShadowRoot.zig");
const XMLHttpRequestEventTarget = @import("webapi/net/XMLHttpRequestEventTarget.zig");
+const MediaQueryList = @import("webapi/css/MediaQueryList.zig");
const log = lp.log;
const Allocator = std.mem.Allocator;
@@ -87,6 +88,7 @@ pub fn dispatch(self: *EventManager, target: *EventTarget, event: *Event) Dispat
switch (target._type) {
.node => try self.dispatchNode(target.subtype(Node), event),
.xhr => try self.dispatchDirect(target, event, target.subtype(XMLHttpRequestEventTarget).inlineHandler(event._type_string), .{ .context = "dispatch" }),
+ .media_query_list => try self.dispatchDirect(target, event, target.subtype(MediaQueryList).inlineHandler(event._type_string), .{ .context = "dispatch" }),
.window => try self.dispatchDirect(target, event, windowInlineHandler(target.subtype(Window), event._type_string), .{ .context = "dispatch" }),
else => try self.dispatchDirect(target, event, null, .{ .context = "dispatch" }),
}
diff --git a/src/browser/Frame.zig b/src/browser/Frame.zig
index e6b25894d..0a5abbba8 100644
--- a/src/browser/Frame.zig
+++ b/src/browser/Frame.zig
@@ -37,6 +37,7 @@ const URL = @import("URL.zig");
const referrer = @import("referrer.zig");
const Blob = @import("webapi/Blob.zig");
const FileList = @import("webapi/FileList.zig");
+const MediaQueryList = @import("webapi/css/MediaQueryList.zig");
const Node = @import("webapi/Node.zig");
const Event = @import("webapi/Event.zig");
const EventTarget = @import("webapi/EventTarget.zig");
@@ -188,6 +189,10 @@ _event_target_attr_listeners: GlobalEventHandlersLookup = .empty,
// File objects (reference counted via their Blob proto); released at teardown.
_file_lists: std.ArrayList(*FileList) = .empty,
+// Every matchMedia() result of this document, so a viewport change can fire
+// their `change`.
+_media_query_lists: std.ArrayList(*MediaQueryList) = .empty,
+
/// Element `load`/`error` events queued to fire on the next scheduler tick,
/// and flushed before window's `load` event.
/// A call to `documentIsComplete` (which calls `_documentIsComplete`) resets it.
@@ -581,6 +586,17 @@ pub fn deinit(self: *Frame) void {
self._local_arena.release();
}
+pub fn viewportChanged(self: *Frame) void {
+ var i: usize = 0;
+ while (i < self._media_query_lists.items.len) : (i += 1) {
+ self._media_query_lists.items[i].viewportChanged();
+ }
+ i = 0;
+ while (i < self.child_frames.items.len) : (i += 1) {
+ self.child_frames.items[i].viewportChanged();
+ }
+}
+
pub fn trackWorker(self: *Frame, worker: *Worker) !void {
try self.workers.append(self.arena, worker);
}
diff --git a/src/browser/Page.zig b/src/browser/Page.zig
index 9952eeff4..8f6a7190f 100644
--- a/src/browser/Page.zig
+++ b/src/browser/Page.zig
@@ -22,7 +22,6 @@ const lp = @import("lightpanda");
const js = @import("js/js.zig");
const Frame = @import("Frame.zig");
-const MediaQueryList = @import("webapi/css/MediaQueryList.zig");
const Session = @import("Session.zig");
const Factory = @import("Factory.zig");
const Viewport = @import("Viewport.zig");
@@ -131,9 +130,6 @@ popups: std.ArrayList(*Frame) = .empty,
// ideal from a memory point of view).
closed_frames: std.ArrayList(*Frame) = .empty,
-// Every matchMedia() result, so a viewport change can fire their `change`.
-media_query_lists: std.ArrayList(*MediaQueryList) = .empty,
-
// SharedWorkerGlobalScopes created by this Page's frames (also registered in
// session.shared_workers so other pages can connect).
shared_workers: std.ArrayList(*SharedWorkerGlobalScope) = .empty,
@@ -164,7 +160,11 @@ pub fn getViewport(self: *const Page) Viewport {
}
pub fn viewportChanged(self: *Page) void {
- for (self.media_query_lists.items) |mql| mql.viewportChanged();
+ self.frame.viewportChanged();
+ var i: usize = 0;
+ while (i < self.popups.items.len) : (i += 1) {
+ self.popups.items[i].viewportChanged();
+ }
}
// Initialize a Page and its root Frame.
diff --git a/src/browser/webapi/Window.zig b/src/browser/webapi/Window.zig
index 63ed85407..d2f8e59c5 100644
--- a/src/browser/webapi/Window.zig
+++ b/src/browser/webapi/Window.zig
@@ -654,8 +654,8 @@ pub fn reportError(self: *Window, err: js.Value, frame: *Frame) !void {
}
}
-pub fn matchMedia(_: *const Window, query: []const u8, exec: *const js.Execution) !*MediaQueryList {
- return MediaQueryList.init(query, exec);
+pub fn matchMedia(_: *const Window, query: []const u8, frame: *Frame) !*MediaQueryList {
+ return MediaQueryList.init(query, frame);
}
pub fn getComputedStyle(_: *const Window, element: *Element, pseudo_element: ?[]const u8, frame: *Frame) !*CSSStyleProperties {
diff --git a/src/browser/webapi/css/MediaQueryList.zig b/src/browser/webapi/css/MediaQueryList.zig
index 392c81ce6..dcd68931a 100644
--- a/src/browser/webapi/css/MediaQueryList.zig
+++ b/src/browser/webapi/css/MediaQueryList.zig
@@ -31,34 +31,24 @@ const MediaQueryList = @This();
pub const Proto = EventTarget;
_proto: *EventTarget,
-_media: []const u8,
_frame: *Frame,
-_exec: *const js.Execution,
+_media: []const u8,
// What listeners last observed; `change` fires when the viewport flips it.
_matches: bool,
_on_change: ?js.Function.Global = null,
-pub fn init(query: []const u8, exec: *const js.Execution) !*MediaQueryList {
- const frame = switch (exec.js.global) {
- .frame => |f| f,
- .worker => unreachable,
- };
+pub fn init(query: []const u8, frame: *Frame) !*MediaQueryList {
const media = try frame.dupeString(query);
- const self = try exec._factory.eventTarget(MediaQueryList{
+ const self = try frame._factory.eventTarget(MediaQueryList{
._proto = undefined,
._media = media,
._frame = frame,
- ._exec = exec,
._matches = MediaQuery.matches(media, frame._page.getViewport()),
});
- try frame._page.media_query_lists.append(frame._page.frame_arena, self);
+ try frame._media_query_lists.append(frame.arena, self);
return self;
}
-pub fn deinit(self: *MediaQueryList) void {
- if (self._on_change) |f| f.release();
-}
-
pub fn asEventTarget(self: *MediaQueryList) *EventTarget {
return self._proto;
}
@@ -80,19 +70,26 @@ pub fn viewportChanged(self: *MediaQueryList) void {
if (matches == self._matches) return;
self._matches = matches;
- const target = self.asEventTarget();
- if (!self._exec.hasDirectListeners(target, "change", @as(?js.Function.Global, null))) return;
+ const frame = self._frame;
+ if (!frame.hasDirectListeners(self.asEventTarget(), "change", self._on_change)) return;
self.dispatchChange(matches) catch |err| {
log.warn(.browser, "matchMedia change", .{ .err = err, .media = self._media });
};
}
fn dispatchChange(self: *MediaQueryList, matches: bool) !void {
+ const frame = self._frame;
const event = try MediaQueryListEvent.initTrusted(comptime .wrap("change"), .{
.matches = matches,
.media = self._media,
- }, self._frame);
- try self._exec.dispatch(self.asEventTarget(), event.asEvent(), @as(?js.Function.Global, null), .{ .context = "MediaQueryList change" });
+ }, frame);
+ try frame.dispatch(self.asEventTarget(), event.asEvent(), self._on_change, .{ .context = "MediaQueryList change" });
+}
+
+// The property handler for a JS-side dispatchEvent (see EventManager.dispatch).
+pub fn inlineHandler(self: *const MediaQueryList, typ: lp.String) ?js.Function.Global {
+ if (typ.eql(comptime .wrap("change"))) return self._on_change;
+ return null;
}
pub fn addListener(self: *MediaQueryList, cb_: ?js.Function, exec: *js.Execution) !void {
@@ -109,16 +106,8 @@ pub fn getOnChange(self: *const MediaQueryList) ?js.Function.Global {
return self._on_change;
}
-// Registered as a listener so JS-side dispatchEvent reaches it too.
-pub fn setOnChange(self: *MediaQueryList, cb_: ?js.Function, exec: *js.Execution) !void {
- if (self._on_change) |old| {
- try self._proto.removeEventListener("change", .{ .value = .{ .function = old.local(exec.js.local.?) } }, null, exec);
- old.release();
- self._on_change = null;
- }
- const cb = cb_ orelse return;
- try self._proto.addEventListener("change", .{ .value = .{ .function = cb } }, null, exec);
- self._on_change = try cb.persist();
+pub fn setOnChange(self: *MediaQueryList, cb: ?js.Function.Global) void {
+ self._on_change = cb;
}
pub const JsApi = struct {
@@ -145,3 +134,92 @@ test "WebApi: MediaQueryList" {
test "WebApi: media @-rule cascade" {
try testing.htmlRunner("css/media_at_rule_cascade.html", .{});
}
+
+test "WebApi: MediaQueryList change survives iframe renavigation" {
+ const page = try testing.pageTest("runner/iframe_idle.html", .{});
+ defer page.close();
+
+ var runner = page.session.runner(.{});
+ const frame = page.frame().?;
+ const child = frame.child_frames.items[1];
+ {
+ var ls: js.Local.Scope = undefined;
+ child.js.localScope(&ls);
+ defer ls.deinit();
+ _ = try ls.local.exec("matchMedia('(max-width: 500px)').addListener(() => {});", null);
+ }
+ try testing.expectEqual(1, child._media_query_lists.items.len);
+
+ // Re-navigating the iframe re-inits the Frame in place and destroys its
+ // JS context; the old document's lists must go with it.
+ {
+ var ls: js.Local.Scope = undefined;
+ frame.js.localScope(&ls);
+ defer ls.deinit();
+ _ = try ls.local.exec("document.querySelectorAll('iframe')[1].src = 'runner1.html';", null);
+ }
+ try runner.waitForFrame(page.frame_id, 2000, .{ .until = .done });
+ try testing.expectEqual(true, child == frame.child_frames.items[1]);
+ try testing.expectEqual(0, child._media_query_lists.items.len);
+
+ {
+ var ls: js.Local.Scope = undefined;
+ child.js.localScope(&ls);
+ defer ls.deinit();
+ _ = try ls.local.exec(
+ \\window.fired = [];
+ \\matchMedia('(max-width: 500px)').addListener(e => fired.push(e.matches));
+ , null);
+ }
+ page.session.browser.setViewportOverride(.{ .width = 400, .height = 800, .scale = 1 });
+ defer page.session.browser.setViewportOverride(null);
+
+ var ls: js.Local.Scope = undefined;
+ child.js.localScope(&ls);
+ defer ls.deinit();
+ const v = try ls.local.exec("fired.join() === 'true'", null);
+ try testing.expect(v.toBool());
+}
+
+test "WebApi: MediaQueryList created during a change listener waits for the next change" {
+ const page = try testing.pageTest("hi.html", .{});
+ defer page.close();
+
+ const frame = page.frame().?;
+ {
+ var ls: js.Local.Scope = undefined;
+ frame.js.localScope(&ls);
+ defer ls.deinit();
+ _ = try ls.local.exec(
+ \\window.fired = [];
+ \\matchMedia('(max-width: 500px)').addListener(e => {
+ \\ fired.push('outer:' + e.matches);
+ \\ matchMedia('(max-width: 600px)').addListener(e => fired.push('inner:' + e.matches));
+ \\});
+ , null);
+ }
+
+ const browser = page.session.browser;
+ defer browser.setViewportOverride(null);
+
+ // The inner list is created at 400px, where it already matches.
+ browser.setViewportOverride(.{ .width = 400, .height = 800, .scale = 1 });
+ try testing.expectEqual(2, frame._media_query_lists.items.len);
+ {
+ var ls: js.Local.Scope = undefined;
+ frame.js.localScope(&ls);
+ defer ls.deinit();
+ const v = try ls.local.exec("fired.join() === 'outer:true'", null);
+ try testing.expect(v.toBool());
+ }
+
+ // Both flip at 700px. The outer listener creates a third list which,
+ // again, has nothing to report.
+ browser.setViewportOverride(.{ .width = 700, .height = 800, .scale = 1 });
+ try testing.expectEqual(3, frame._media_query_lists.items.len);
+ var ls: js.Local.Scope = undefined;
+ frame.js.localScope(&ls);
+ defer ls.deinit();
+ const v = try ls.local.exec("fired.join() === 'outer:true,outer:false,inner:false'", null);
+ try testing.expect(v.toBool());
+}
diff --git a/src/server/cdp/domains/emulation.zig b/src/server/cdp/domains/emulation.zig
index 57f04bac7..37f3aae93 100644
--- a/src/server/cdp/domains/emulation.zig
+++ b/src/server/cdp/domains/emulation.zig
@@ -293,7 +293,7 @@ test "cdp.Emulation: viewport override fires matchMedia change events" {
var ls: js.Local.Scope = undefined;
frame.js.localScope(&ls);
defer ls.deinit();
- const v = try ls.local.exec("events.join() === 'listener:true,onchange:(max-width: 500px),listener:false,onchange:(max-width: 500px)'", null);
+ const v = try ls.local.exec("events.join() === 'onchange:(max-width: 500px),listener:true,onchange:(max-width: 500px),listener:false'", null);
try testing.expect(v.toBool());
}