Skip to content

support depth parameter for DOM.getDocument #900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 17, 2025
Merged

support depth parameter for DOM.getDocument #900

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f199816
support `depth` parameter for DOM.getDocument
karlseguin Jul 17, 2025
eef5f3f
support null params to CDP DOM.getDocument
karlseguin Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/cdp/Node.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,13 +565,13 @@ test "cdp Node: Writer" {
.localName = "div",
.childNodeCount = 1,
.parentId = 3,
.children = &.{ .{
.children = &.{.{
.nodeId = 6,
.localName = "a",
.childNodeCount = 0,
.parentId = 5,
}}
}
} } }, json);
}},
} },
} }, json);
}
}
14 changes: 8 additions & 6 deletions src/cdp/domains/dom.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,18 @@ pub fn processMessage(cmd: anytype) !void {

// https://chromedevtools.github.io/devtools-protocol/tot/DOM/#method-getDocument
fn getDocument(cmd: anytype) !void {
// const params = (try cmd.params(struct {
// depth: ?u32 = null,
// pierce: ?bool = null,
// })) orelse return error.InvalidParams;
const params = (try cmd.params(struct {
// CDP documentation implies that 0 isn't valid, but it _does_ work in Chrome
depth: ?i32 = null,
pierce: ?bool = null,
})) orelse return error.InvalidParams;

const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded;
const page = bc.session.currentPage() orelse return error.PageNotLoaded;
const doc = parser.documentHTMLToDocument(page.window.document);

const node = try bc.node_registry.register(parser.documentToNode(doc));
return cmd.sendResult(.{ .root = bc.nodeWriter(node, .{}) }, .{});
return cmd.sendResult(.{ .root = bc.nodeWriter(node, .{ .depth = params.depth orelse 3 }) }, .{});
}

// https://chromedevtools.github.io/devtools-protocol/tot/DOM/#method-performSearch
Expand Down Expand Up @@ -451,7 +452,7 @@ fn requestChildNodes(cmd: anytype) !void {

try cmd.sendEvent("DOM.setChildNodes", .{
.parentId = node.id,
.nodes = bc.nodeWriter(node, .{.depth = params.depth, .exclude_root = true}),
.nodes = bc.nodeWriter(node, .{ .depth = params.depth, .exclude_root = true }),
}, .{
.session_id = session_id,
});
Expand Down Expand Up @@ -610,6 +611,7 @@ test "cdp.dom: getBoxModel" {
try ctx.processMessage(.{ // Hacky way to make sure nodeId 0 exists in the registry
.id = 3,
.method = "DOM.getDocument",
.params = .{ .depth = 3 },
});

try ctx.processMessage(.{
Expand Down