Skip to content

Lightpanda: the headless browser designed for AI and automation

dedupe close path

Karl Seguin1bc6bcc3d1cc
diff --git a/src/server/cdp/CDP.zig b/src/server/cdp/CDP.zig
index aa44fbe16..cf1dd2e84 100644
--- a/src/server/cdp/CDP.zig
+++ b/src/server/cdp/CDP.zig
@@ -364,16 +364,12 @@ pub fn createBrowserContext(self: *CDP) ![]const u8 {
return id;
}
-pub fn disposeBrowserContext(self: *CDP, browser_context_id: []const u8) bool {
- const bc = &(self.browser_context orelse return false);
- if (std.mem.eql(u8, bc.id, browser_context_id) == false) {
- return false;
- }
+pub fn disposeBrowserContext(self: *CDP) void {
+ const bc = &(self.browser_context orelse return);
bc.deinit();
self.browser.closeSession();
self.browser_context = null;
_ = self.browser_context_arena.reset(.{ .retain_with_limit = 1024 * 16 });
- return true;
}
const SendEventOpts = struct {
@@ -840,6 +836,52 @@ pub const BrowserContext = struct {
}
}
+ // Shared by Target.closeTarget, Page.close and Target.disposeBrowserContext.
+ // Drivers settle page.close() on detachedFromTarget and drop the target
+ // on targetDestroyed, so both are sent even when nothing was attached.
+ pub fn closeTarget(self: *BrowserContext) !void {
+ const target_id = self.target_id orelse return;
+ const cdp = self.cdp;
+ for (self.attached_sessions.items) |session| {
+ self.fetchDisableForSession(session.id);
+ try cdp.sendEvent("Inspector.detached", .{
+ .reason = "Render process gone.",
+ }, .{ .session_id = session.id });
+ try cdp.sendEvent("Target.detachedFromTarget", .{
+ .targetId = target_id,
+ .sessionId = session.id,
+ .reason = "Render process gone.",
+ }, .{ .session_id = session.parent_id });
+ }
+ self.attached_sessions.clearRetainingCapacity();
+
+ // could be null, created but never attached
+ if (self.session_id) |session_id| {
+ self.fetchDisableForSession(session_id);
+ try cdp.sendEvent("Inspector.detached", .{
+ .reason = "Render process gone.",
+ }, .{ .session_id = session_id });
+ try cdp.sendEvent("Target.detachedFromTarget", .{
+ .targetId = target_id,
+ .sessionId = session_id,
+ .reason = "Render process gone.",
+ }, .{});
+ self.session_id = null;
+ }
+
+ try cdp.sendEvent("Target.targetDestroyed", .{ .targetId = target_id }, .{});
+
+ if (self.page_handle) |handle| {
+ handle.close();
+ self.page_handle = null;
+ }
+ for (self.isolated_worlds.items) |world| {
+ world.deinit();
+ }
+ self.isolated_worlds.clearRetainingCapacity();
+ self.target_id = null;
+ }
+
pub fn fetchDisableForSession(self: *BrowserContext, session_id: []const u8) void {
const active_session_id = self.fetch_session_id orelse return;
if (std.mem.eql(u8, active_session_id, session_id)) {
diff --git a/src/server/cdp/domains/page.zig b/src/server/cdp/domains/page.zig
index ea0de57d8..71fa88d29 100644
--- a/src/server/cdp/domains/page.zig
+++ b/src/server/cdp/domains/page.zig
@@ -238,41 +238,15 @@ fn removeScriptToEvaluateOnNewDocument(cmd: *CDP.Command) !void {
fn close(cmd: *CDP.Command) !void {
const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded;
- const target_id = bc.target_id orelse return error.TargetNotLoaded;
+ if (bc.target_id == null) {
+ return error.TargetNotLoaded;
+ }
// can't be null if we have a target_id
lp.assert(bc.session.hasPage(), "CDP.frame.close null frame", .{});
- try cmd.sendResult(.{}, .{});
-
- // Following code is similar to target.closeTarget
- //
- // could be null, created but never attached
- if (bc.session_id) |session_id| {
- // Inspector.detached event
- try cmd.sendEvent("Inspector.detached", .{
- .reason = "Render process gone.",
- }, .{ .session_id = session_id });
-
- // detachedFromTarget event
- try cmd.sendEvent("Target.detachedFromTarget", .{
- .targetId = target_id,
- .sessionId = session_id,
- .reason = "Render process gone.",
- }, .{});
-
- bc.session_id = null;
- }
-
- if (bc.page_handle) |handle| {
- handle.close();
- }
- bc.page_handle = null;
- for (bc.isolated_worlds.items) |world| {
- world.deinit();
- }
- bc.isolated_worlds.clearRetainingCapacity();
- bc.target_id = null;
+ try cmd.sendResult(null, .{});
+ try bc.closeTarget();
}
fn createIsolatedWorld(cmd: *CDP.Command) !void {
@@ -1234,6 +1208,29 @@ fn getLayoutMetrics(cmd: *CDP.Command) !void {
}
const testing = @import("../testing.zig");
+
+test "cdp.page: close detaches the target like Target.closeTarget" {
+ var ctx = try testing.context();
+ defer ctx.deinit();
+
+ try ctx.processMessage(.{ .id = 1, .method = "Target.setAutoAttach", .params = .{ .autoAttach = true, .waitForDebuggerOnStart = false } });
+ try ctx.processMessage(.{ .id = 2, .method = "Target.createTarget", .params = .{ .url = "about:blank" } });
+ const bc = &ctx.cdp().browser_context.?;
+ const target_id = bc.target_id.?;
+ const session_id = try testing.arena_allocator.dupe(u8, bc.session_id.?);
+
+ try ctx.processMessage(.{ .id = 3, .method = "Page.close", .sessionId = session_id });
+ try ctx.expectSentResult(null, .{ .id = 3, .session_id = session_id });
+ try ctx.expectSentEvent("Inspector.detached", .{ .reason = "Render process gone." }, .{ .session_id = session_id });
+ try ctx.expectSentEvent("Target.detachedFromTarget", .{
+ .targetId = target_id,
+ .sessionId = session_id,
+ .reason = "Render process gone.",
+ }, .{});
+ try ctx.expectSentEvent("Target.targetDestroyed", .{ .targetId = target_id }, .{});
+ try testing.expectEqual(null, bc.target_id);
+ try testing.expectEqual(null, bc.session_id);
+}
test "cdp.frame: setup no-ops" {
var ctx = try testing.context();
defer ctx.deinit();
diff --git a/src/server/cdp/domains/target.zig b/src/server/cdp/domains/target.zig
index 96f25a610..0457dc19f 100644
--- a/src/server/cdp/domains/target.zig
+++ b/src/server/cdp/domains/target.zig
@@ -141,15 +141,13 @@ fn disposeBrowserContext(cmd: *CDP.Command) !void {
const bc = cmd.browser_context orelse {
return cmd.sendError(-32602, "No browser context with the given id found", .{});
};
- if (!std.mem.eql(u8, bc.id, params.browserContextId)) {
+ if (std.mem.eql(u8, bc.id, params.browserContextId) == false) {
return cmd.sendError(-32602, "No browser context with the given id found", .{});
}
- // Disposing a context closes its target too. Clients use these events to
- // settle page.close() and remove the page from their target/session maps;
- // replying to disposeBrowserContext alone leaves them waiting forever.
- try detachTarget(cmd, bc);
- _ = cmd.cdp.disposeBrowserContext(params.browserContextId);
+ // Disposing a context closes its target; drivers wait on those events.
+ try bc.closeTarget();
+ cmd.cdp.disposeBrowserContext();
try cmd.sendResult(null, .{});
}
@@ -326,53 +324,7 @@ fn closeTarget(cmd: *CDP.Command) !void {
lp.assert(bc.session.hasPage(), "CDP.target.closeTarget null frame", .{});
try cmd.sendResult(.{ .success = true }, .{});
- try detachTarget(cmd, bc);
-
- if (bc.page_handle) |handle| {
- handle.close();
- bc.page_handle = null;
- }
- for (bc.isolated_worlds.items) |world| {
- world.deinit();
- }
- bc.isolated_worlds.clearRetainingCapacity();
- bc.target_id = null;
-}
-
-fn detachTarget(cmd: *CDP.Command, bc: *CDP.BrowserContext) !void {
- const target_id = bc.target_id orelse return;
- for (bc.attached_sessions.items) |session| {
- bc.fetchDisableForSession(session.id);
- try cmd.sendEvent("Inspector.detached", .{
- .reason = "Render process gone.",
- }, .{ .session_id = session.id });
- try cmd.sendEvent("Target.detachedFromTarget", .{
- .targetId = target_id,
- .sessionId = session.id,
- .reason = "Render process gone.",
- }, .{ .session_id = session.parent_id });
- }
- bc.attached_sessions.clearRetainingCapacity();
-
- // could be null, created but never attached
- if (bc.session_id) |session_id| {
- bc.fetchDisableForSession(session_id);
- // Inspector.detached event
- try cmd.sendEvent("Inspector.detached", .{
- .reason = "Render process gone.",
- }, .{ .session_id = session_id });
-
- // detachedFromTarget event
- try cmd.sendEvent("Target.detachedFromTarget", .{
- .targetId = target_id,
- .sessionId = session_id,
- .reason = "Render process gone.",
- }, .{});
-
- bc.session_id = null;
- }
-
- try cmd.sendEvent("Target.targetDestroyed", .{ .targetId = target_id }, .{});
+ try bc.closeTarget();
}
fn getTargetInfo(cmd: *CDP.Command) !void {
diff --git a/src/server/cdp/testing.zig b/src/server/cdp/testing.zig
index 57bfc54d0..fff827169 100644
--- a/src/server/cdp/testing.zig
+++ b/src/server/cdp/testing.zig
@@ -81,9 +81,7 @@ pub const TestContext = struct {
};
pub fn loadBrowserContext(self: *TestContext, opts: BrowserContextOpts) !*CDP.BrowserContext {
var c = self.cdp();
- if (c.browser_context) |bc| {
- _ = c.disposeBrowserContext(bc.id);
- }
+ c.disposeBrowserContext();
_ = try c.createBrowserContext();
var bc = &c.browser_context.?;