Lightpanda: the headless browser designed for AI and automation
webapi: wheel/touch testdriver actions; passive-listener cancelability
Francis Bouvier8ff4711c214c
diff --git a/src/browser/webapi/CSS.zig b/src/browser/webapi/CSS.zigindex 00bd1a952..85de30ead 100644--- a/src/browser/webapi/CSS.zig+++ b/src/browser/webapi/CSS.zig@@ -38,6 +38,20 @@ pub fn parseDimension(value: []const u8) ?f64 {return std.fmt.parseFloat(f64, num_str) catch null;}+// parseDimension plus viewport-relative units, which the faux layout+// resolves against the page viewport.+pub fn parseDimensionViewport(value: []const u8, frame: *Frame) ?f64 {+ if (std.mem.endsWith(u8, value, "vh")) {+ const n = std.fmt.parseFloat(f64, value[0 .. value.len - 2]) catch return null;+ return n * @as(f64, @floatFromInt(frame._page.getViewport().height)) / 100.0;+ }+ if (std.mem.endsWith(u8, value, "vw")) {+ const n = std.fmt.parseFloat(f64, value[0 .. value.len - 2]) catch return null;+ return n * @as(f64, @floatFromInt(frame._page.getViewport().width)) / 100.0;+ }+ return parseDimension(value);+}+/// Escapes a CSS identifier string/// https://drafts.csswg.org/cssom/#the-css.escape()-methodpub fn escape(value: []const u8, frame: *Frame) ![]const u8 {diff --git a/src/browser/webapi/Document.zig b/src/browser/webapi/Document.zigindex b2a621c01..c09e01377 100644--- a/src/browser/webapi/Document.zig+++ b/src/browser/webapi/Document.zig@@ -817,6 +817,17 @@ pub fn moveBefore(self: *Document, node: js.Value, child: js.Value, frame: *Fram}pub fn elementFromPoint(self: *Document, x: f64, y: f64, frame: *Frame) !?*Element {+ return self.elementFromPointImpl(x, y, false, frame);+}++// The faux layout gives most elements no useful horizontal extent, so+// viewport-relative hit-testing (WebDriver scroll actions) matches on the+// vertical axis only.+pub fn elementFromVerticalPoint(self: *Document, y: f64, frame: *Frame) !?*Element {+ return self.elementFromPointImpl(0, y, true, frame);+}++fn elementFromPointImpl(self: *Document, x: f64, y: f64, ignore_x: bool, frame: *Frame) !?*Element {// DFS in document order; topmost = last visited element whose rect contains (x, y).//// Faux-layout shortcut: rect.top is calculateDocumentPosition × 5, which is@@ -854,7 +865,8 @@ pub fn elementFromPoint(self: *Document, x: f64, y: f64, frame: *Frame) !?*Elemeconst top = pos;const right = pos + dims.width;const bottom = pos + dims.height;- if (x >= left and x <= right and y >= top and y <= bottom) {+ const x_contained = ignore_x or (x >= left and x <= right);+ if (x_contained and y >= top and y <= bottom) {topmost = element;}}diff --git a/src/browser/webapi/Element.zig b/src/browser/webapi/Element.zigindex b1193459f..26ecce962 100644--- a/src/browser/webapi/Element.zig+++ b/src/browser/webapi/Element.zig@@ -1252,8 +1252,8 @@ pub fn getElementDimensions(self: *Element, frame: *Frame) struct { width: f64,if (self.getStyle(frame)) |style| {const decl = style.asCSSStyleDeclaration();- width = CSS.parseDimension(decl.getPropertyValue("width", frame)) orelse 5.0;- height = CSS.parseDimension(decl.getPropertyValue("height", frame)) orelse 5.0;+ width = CSS.parseDimensionViewport(decl.getPropertyValue("width", frame), frame) orelse 5.0;+ height = CSS.parseDimensionViewport(decl.getPropertyValue("height", frame), frame) orelse 5.0;}if (width == 5.0 or height == 5.0) {diff --git a/src/browser/webapi/WebDriver.zig b/src/browser/webapi/WebDriver.zigindex 140df74ea..bcbe189bf 100644--- a/src/browser/webapi/WebDriver.zig+++ b/src/browser/webapi/WebDriver.zig@@ -30,6 +30,8 @@ const MouseEvent = @import("event/MouseEvent.zig");const PointerEvent = @import("event/PointerEvent.zig");const KeyboardEvent = @import("event/KeyboardEvent.zig");const WheelEvent = @import("event/WheelEvent.zig");+const TouchEvent = @import("event/TouchEvent.zig");+const EventManagerBase = @import("../EventManagerBase.zig");const log = lp.log;const Allocator = std.mem.Allocator;@@ -159,9 +161,19 @@ fn performPointerSource(source: js.Object, frame: *Frame) !void {}const actions = actions_val.toArray();+ // A touch pointer dispatches touch events instead of mouse events.+ var is_touch = false;+ const params = try source.get("parameters");+ if (params.isObject()) {+ if ((try params.toObject().get("pointerType")).toSSO(false)) |pointer_type| {+ is_touch = pointer_type.eql(comptime .wrap("touch"));+ } else |_| {}+ }+// The element the pointer is currently over, set by the last pointerMove// whose origin resolved to an element.var target: ?*Element = null;+ var pressed = false;for (0..actions.len()) |i| {const action_val = try actions.get(@intCast(i));@@ -178,21 +190,37 @@ fn performPointerSource(source: js.Object, frame: *Frame) !void {}const el = target orelse continue;dispatchPointer(el, "pointermove", 0, 0, frame);- dispatchMouse(el, "mousemove", 0, 0, frame);+ if (is_touch) {+ if (pressed) {+ dispatchTouch(el, "touchmove", frame);+ }+ } else {+ dispatchMouse(el, "mousemove", 0, 0, frame);+ }} else if (action_type.eql(comptime .wrap("pointerDown"))) {const el = target orelse continue;const button = readI32(action, "button", 0);+ pressed = true;dispatchPointer(el, "pointerdown", button, 1, frame);- dispatchMouse(el, "mousedown", button, 1, frame);- Frame.user_input.focusEditingHostForMouseDown(frame, el) catch |err| {- log.warn(.app, "webdriver editable focus", .{ .err = err });- };+ if (is_touch) {+ dispatchTouch(el, "touchstart", frame);+ } else {+ dispatchMouse(el, "mousedown", button, 1, frame);+ Frame.user_input.focusEditingHostForMouseDown(frame, el) catch |err| {+ log.warn(.app, "webdriver editable focus", .{ .err = err });+ };+ }} else if (action_type.eql(comptime .wrap("pointerUp"))) {const el = target orelse continue;const button = readI32(action, "button", 0);+ pressed = false;dispatchPointer(el, "pointerup", button, 0, frame);- dispatchMouse(el, "mouseup", button, 0, frame);- dispatchMouse(el, "click", button, 0, frame);+ if (is_touch) {+ dispatchTouch(el, "touchend", frame);+ } else {+ dispatchMouse(el, "mouseup", button, 0, frame);+ dispatchMouse(el, "click", button, 0, frame);+ }}// "pause" carries timing only and is ignored. ("pointerCancel" is not// emitted by the testdriver Actions builder.)@@ -219,14 +247,23 @@ fn performWheelSource(source: js.Object, frame: *Frame) !void {}const origin = try action.get("origin");- if (!origin.isObject()) {- continue;+ var el: ?*Element = null;+ if (origin.isObject()) {+ el = origin.local.jsValueToZig(*Element, origin) catch null;+ } else {+ // "viewport"/"pointer" origins: approximate hit-testing with+ // the faux layout's vertical axis, falling back to the root.+ const y = readI32(action, "y", 0);+ el = frame.document.elementFromVerticalPoint(@floatFromInt(y), frame) catch null;+ if (el == null) {+ el = frame.document.getDocumentElement();+ }}- const el = origin.local.jsValueToZig(*Element, origin) catch continue;+ const target = el orelse continue;const delta_x = readI32(action, "deltaX", 0);const delta_y = readI32(action, "deltaY", 0);- dispatchWheel(el, delta_x, delta_y, frame);+ dispatchWheel(target, delta_x, delta_y, frame);}}@@ -310,9 +347,12 @@ fn dispatchMouse(el: *Element, comptime typ: []const u8, button: i32, buttons: u}fn dispatchWheel(el: *Element, delta_x: i32, delta_y: i32, frame: *Frame) void {+ // The UA dispatches scroll-blocking events as non-cancelable when every+ // listener on the propagation path is passive: it already knows+ // preventDefault can't be called.const event = WheelEvent.initTrusted("wheel", .{.bubbles = true,- .cancelable = true,+ .cancelable = hasNonPassiveListener(el, "wheel", frame),.composed = true,.deltaX = @floatFromInt(delta_x),.deltaY = @floatFromInt(delta_y),@@ -326,7 +366,22 @@ fn dispatchWheel(el: *Element, delta_x: i32, delta_y: i32, frame: *Frame) void {defer _ = event.asEvent().releaseRef(frame._page);dispatch(el.asEventTarget(), event.asEvent(), frame, "wheel");- if (event.asEvent()._prevent_default) {+ // Blink also fires the legacy mousewheel event.+ const legacy = WheelEvent.initTrusted("mousewheel", .{+ .bubbles = true,+ .cancelable = hasNonPassiveListener(el, "mousewheel", frame),+ .composed = true,+ .deltaX = @floatFromInt(delta_x),+ .deltaY = @floatFromInt(delta_y),+ }, frame) catch |err| {+ log.warn(.app, "webdriver mousewheel event", .{ .err = err });+ return;+ };+ legacy.asEvent().acquireRef();+ defer _ = legacy.asEvent().releaseRef(frame._page);+ dispatch(el.asEventTarget(), legacy.asEvent(), frame, "mousewheel");++ if (event.asEvent()._prevent_default or legacy.asEvent()._prevent_default) {return;}@@ -349,6 +404,41 @@ fn dispatch(target: *EventTarget, event: *Event, frame: *Frame, typ: []const u8)};}+fn hasNonPassiveListener(el: *Element, typ: []const u8, frame: *Frame) bool {+ const base = &frame._event_manager.base;+ var current: ?*@import("Node.zig") = el.asNode();+ while (current) |node| : (current = node.parentNode()) {+ if (anyNonPassive(base.getListeners(node.asEventTarget(), .wrap(typ)))) {+ return true;+ }+ }+ return anyNonPassive(base.getListeners(frame.window.asEventTarget(), .wrap(typ)));+}++fn anyNonPassive(list_: ?*std.DoublyLinkedList) bool {+ const list = list_ orelse return false;+ var link = list.first;+ while (link) |l| : (link = l.next) {+ const listener: *align(8) EventManagerBase.Listener = @fieldParentPtr("node", l);+ if (!listener.passive) {+ return true;+ }+ }+ return false;+}++fn dispatchTouch(el: *Element, comptime typ: []const u8, frame: *Frame) void {+ const event = TouchEvent.initTrusted(typ, .{+ .bubbles = true,+ .cancelable = hasNonPassiveListener(el, typ, frame),+ .composed = true,+ }, frame) catch |err| {+ log.warn(.app, "webdriver touch event", .{ .err = err });+ return;+ };+ dispatch(el.asEventTarget(), event.asEvent(), frame, typ);+}+pub const JsApi = struct {pub const bridge = js.Bridge(WebDriver);diff --git a/src/browser/webapi/event/TouchEvent.zig b/src/browser/webapi/event/TouchEvent.zigindex 4956ed0ad..f15da08b7 100644--- a/src/browser/webapi/event/TouchEvent.zig+++ b/src/browser/webapi/event/TouchEvent.zig@@ -51,6 +51,14 @@ pub const Options = Event.inheritOptions();pub fn init(typ: []const u8, _opts: ?Options, frame: *Frame) !*TouchEvent {+ return initWithTrusted(typ, _opts, false, frame);+}++pub fn initTrusted(typ: []const u8, _opts: ?Options, frame: *Frame) !*TouchEvent {+ return initWithTrusted(typ, _opts, true, frame);+}++fn initWithTrusted(typ: []const u8, _opts: ?Options, trusted: bool, frame: *Frame) !*TouchEvent {const arena = try frame.getArena(.tiny, "TouchEvent");errdefer frame.releaseArena(arena);const type_string = try String.init(arena, typ, .{});@@ -68,7 +76,7 @@ pub fn init(typ: []const u8, _opts: ?Options, frame: *Frame) !*TouchEvent {},);- Event.populatePrototypes(event, opts, false);+ Event.populatePrototypes(event, opts, trusted);return event;}