Skip to content

Lightpanda: the headless browser designed for AI and automation

cdp: honor runImmediately, screenWidth/screenHeight and browserContextId

Adrià Arrufat94381d4d71e3
diff --git a/src/browser/Viewport.zig b/src/browser/Viewport.zig
index 34e19ba28..06c220975 100644
--- a/src/browser/Viewport.zig
+++ b/src/browser/Viewport.zig
@@ -21,6 +21,9 @@ const Viewport = @This();
width: u32,
height: u32,
scale: f32 = 1.0, // for screenshot raster
+// window.screen dimensions; null means the same as the viewport.
+screen_width: ?u32 = null,
+screen_height: ?u32 = null,
pub const default = Viewport{
.width = 1920,
diff --git a/src/browser/webapi/Screen.zig b/src/browser/webapi/Screen.zig
index 8b266b0c5..27a7f8b06 100644
--- a/src/browser/webapi/Screen.zig
+++ b/src/browser/webapi/Screen.zig
@@ -48,11 +48,13 @@ pub fn getOrientation(self: *Screen, frame: *Frame) !*Orientation {
}
pub fn getWidth(_: *const Screen, frame: *Frame) u32 {
- return frame._page.getViewport().width;
+ const viewport = frame._page.getViewport();
+ return viewport.screen_width orelse viewport.width;
}
pub fn getHeight(_: *const Screen, frame: *Frame) u32 {
- return frame._page.getViewport().height;
+ const viewport = frame._page.getViewport();
+ return viewport.screen_height orelse viewport.height;
}
pub const JsApi = struct {
diff --git a/src/server/cdp/domains/browser.zig b/src/server/cdp/domains/browser.zig
index cd39bb2d8..4ebc03408 100644
--- a/src/server/cdp/domains/browser.zig
+++ b/src/server/cdp/domains/browser.zig
@@ -86,8 +86,11 @@ fn setDownloadBehavior(cmd: *CDP.Command) !void {
eventsEnabled: ?bool = null,
})) orelse return error.InvalidParams;
- if (params.browserContextId != null) {
- log.warn(.not_implemented, "Browser.setDownloadBehavior", .{ .param = "browserContextId" });
+ if (params.browserContextId) |browser_context_id| {
+ const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded;
+ if (std.mem.eql(u8, browser_context_id, bc.id) == false) {
+ return error.UnknownBrowserContextId;
+ }
}
// `default` defers the choice to the browser; we map it to `deny` (no
@@ -333,6 +336,29 @@ test "cdp.browser: setDownloadBehavior stores config on the session" {
try testing.expect(bc.session.download_events_enabled == false);
}
+test "cdp.browser: setDownloadBehavior checks browserContextId" {
+ var ctx = try testing.context();
+ defer ctx.deinit();
+
+ const bc = try ctx.loadBrowserContext(.{ .id = "BID-DL", .session_id = "SID-DL" });
+
+ try ctx.processMessage(.{
+ .id = 40,
+ .method = "Browser.setDownloadBehavior",
+ .params = .{ .behavior = "allow", .downloadPath = "/tmp/lp-downloads", .browserContextId = "BID-DL" },
+ });
+ try ctx.expectSentResult(null, .{ .id = 40, .session_id = null });
+ try testing.expectEqual(.allow, bc.session.download_behavior);
+
+ try ctx.processMessage(.{
+ .id = 41,
+ .method = "Browser.setDownloadBehavior",
+ .params = .{ .behavior = "deny", .browserContextId = "BID-OTHER" },
+ });
+ try ctx.expectSentError(-31998, "UnknownBrowserContextId", .{ .id = 41 });
+ try testing.expectEqual(.allow, bc.session.download_behavior);
+}
+
test "cdp.browser: setDownloadBehavior is a no-op when no context is loaded" {
// Drivers (e.g. Playwright) send this at the browser level during
// connection setup, before any target/context exists. It must succeed
diff --git a/src/server/cdp/domains/emulation.zig b/src/server/cdp/domains/emulation.zig
index a92a095f9..a12510a60 100644
--- a/src/server/cdp/domains/emulation.zig
+++ b/src/server/cdp/domains/emulation.zig
@@ -107,20 +107,6 @@ fn setDeviceMetricsOverride(cmd: *CDP.Command) !void {
.value = v,
});
}
- if (params.screenWidth) |v| {
- if (v != 0) log.warn(.not_implemented, "setDeviceMetricsOverride", .{
- .cdp_cmd = "Emulation.setDeviceMetricsOverride",
- .param = "screenWidth",
- .value = v,
- });
- }
- if (params.screenHeight) |v| {
- if (v != 0) log.warn(.not_implemented, "setDeviceMetricsOverride", .{
- .cdp_cmd = "Emulation.setDeviceMetricsOverride",
- .param = "screenHeight",
- .value = v,
- });
- }
// The override is stored on the Browser so it persists across page
// navigations for the whole CDP connection.
@@ -135,6 +121,8 @@ fn setDeviceMetricsOverride(cmd: *CDP.Command) !void {
.width = if (params.width > 0) params.width else current.width,
.height = if (params.height > 0) params.height else current.height,
.scale = if (dsf > 0) dsf else current.scale,
+ .screen_width = if (params.screenWidth orelse 0 > 0) params.screenWidth else current.screen_width,
+ .screen_height = if (params.screenHeight orelse 0 > 0) params.screenHeight else current.screen_height,
});
return cmd.sendResult(null, .{});
@@ -309,6 +297,39 @@ test "cdp.Emulation: viewport override fires matchMedia change events" {
try testing.expect(v.toBool());
}
+test "cdp.Emulation: setDeviceMetricsOverride screenWidth/screenHeight reach window.screen" {
+ var ctx = try testing.context();
+ defer ctx.deinit();
+ const bc = try ctx.loadBrowserContext(.{ .id = "BID-SCR", .url = "hi.html" });
+ const frame = bc.mainFrame().?;
+
+ var ls: js.Local.Scope = undefined;
+ frame.js.localScope(&ls);
+ defer ls.deinit();
+
+ try ctx.processMessage(.{
+ .id = 1,
+ .method = "Emulation.setDeviceMetricsOverride",
+ .params = .{ .width = 1280, .height = 720, .deviceScaleFactor = 1, .mobile = false, .screenWidth = 2560, .screenHeight = 1440 },
+ });
+ try ctx.expectSentResult(null, .{ .id = 1 });
+ var v = try ls.local.exec("screen.width === 2560 && screen.height === 1440 && innerWidth === 1280 && innerHeight === 720", null);
+ try testing.expect(v.toBool());
+
+ // 0 keeps the current value, as for width/height.
+ try ctx.processMessage(.{
+ .id = 2,
+ .method = "Emulation.setDeviceMetricsOverride",
+ .params = .{ .width = 1024, .height = 0, .deviceScaleFactor = 0, .mobile = false, .screenWidth = 0, .screenHeight = 0 },
+ });
+ v = try ls.local.exec("screen.width === 2560 && screen.height === 1440 && innerWidth === 1024 && innerHeight === 720", null);
+ try testing.expect(v.toBool());
+
+ try ctx.processMessage(.{ .id = 3, .method = "Emulation.clearDeviceMetricsOverride" });
+ v = try ls.local.exec("screen.width === innerWidth && screen.height === innerHeight", null);
+ try testing.expect(v.toBool());
+}
+
test "cdp.Emulation: setUserAgentOverride with valid user agent" {
var ctx = try testing.context();
defer ctx.deinit();
diff --git a/src/server/cdp/domains/page.zig b/src/server/cdp/domains/page.zig
index 9025876ce..509449da8 100644
--- a/src/server/cdp/domains/page.zig
+++ b/src/server/cdp/domains/page.zig
@@ -154,10 +154,6 @@ fn addScriptToEvaluateOnNewDocument(cmd: *CDP.Command) !void {
const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded;
- if (params.runImmediately) {
- log.warn(.not_implemented, "addScriptOnNewDocument", .{ .param = "runImmediately" });
- }
-
// A worldName registers the world itself.
var world_name: ?[]const u8 = null;
if (params.worldName) |name| {
@@ -177,6 +173,30 @@ fn addScriptToEvaluateOnNewDocument(cmd: *CDP.Command) !void {
.world_name = world_name,
});
+ // runImmediately: also evaluate in the current document, in the requested world.
+ if (params.runImmediately) {
+ if (bc.mainFrame()) |frame| {
+ const js_context = if (world_name) |name| blk: {
+ const world = bc.findIsolatedWorld(name) orelse break :blk null;
+ break :blk world.contextFor(frame);
+ } else frame.js;
+ if (js_context) |context| {
+ var ls: js.Local.Scope = undefined;
+ context.localScope(&ls);
+ defer ls.deinit();
+
+ var try_catch: lp.js.TryCatch = undefined;
+ try_catch.init(&ls.local);
+ defer try_catch.deinit();
+
+ ls.local.eval(source_dupe, null) catch |err| {
+ const caught = try_catch.caughtOrError(cmd.arena, err);
+ log.warn(.cdp, "script on new doc", .{ .caught = caught });
+ };
+ }
+ }
+ }
+
var id_buf: [16]u8 = undefined;
const id_str = std.fmt.bufPrint(&id_buf, "{d}", .{script_id}) catch "1";
return cmd.sendResult(.{
@@ -2446,6 +2466,35 @@ test "cdp.frame: address-bar Page.navigate sends no Referer" {
}
}
+test "cdp.frame: addScriptToEvaluateOnNewDocument runImmediately evaluates in the current document" {
+ var ctx = try testing.context();
+ defer ctx.deinit();
+
+ const bc = try ctx.loadBrowserContext(.{ .id = "BID-RI", .url = "hi.html", .target_id = "FID-00000000RI".* });
+
+ try ctx.processMessage(.{
+ .id = 30,
+ .method = "Page.addScriptToEvaluateOnNewDocument",
+ .params = .{ .source = "window.__now = 1", .runImmediately = true },
+ });
+ try ctx.expectSentResult(.{ .identifier = "1" }, .{ .id = 30 });
+
+ // Without the flag the script only runs on the next document.
+ try ctx.processMessage(.{
+ .id = 31,
+ .method = "Page.addScriptToEvaluateOnNewDocument",
+ .params = .{ .source = "window.__later = 1" },
+ });
+ try ctx.expectSentResult(.{ .identifier = "2" }, .{ .id = 31 });
+
+ const f = bc.mainFrame() orelse unreachable;
+ var ls: js.Local.Scope = undefined;
+ f.js.localScope(&ls);
+ defer ls.deinit();
+ const v = try ls.local.exec("window.__now === 1 && window.__later === undefined", null);
+ try testing.expect(v.toBool());
+}
+
test "cdp.frame: addScriptToEvaluateOnNewDocument" {
var ctx = try testing.context();
defer ctx.deinit();