Skip to content

Lightpanda: the headless browser designed for AI and automation

switch permission value/state from string to enum

Karl Seguin3335c746dc88
diff --git a/src/browser/Page.zig b/src/browser/Page.zig
index 1b4b6264a..f785d78fb 100644
--- a/src/browser/Page.zig
+++ b/src/browser/Page.zig
@@ -25,6 +25,7 @@ const v8 = js.v8;
const Frame = @import("Frame.zig");
const Session = @import("Session.zig");
const Factory = @import("Factory.zig");
+const PermissionState = @import("webapi/Permissions.zig").State;
const Allocator = std.mem.Allocator;
const IS_DEBUG = builtin.mode == .Debug;
@@ -72,9 +73,8 @@ origins: std.StringHashMapUnmanaged(*js.Origin) = .empty,
// Permission state set via CDP Browser.grantPermissions / setPermission /
// resetPermissions, keyed by permission name (e.g. "geolocation"). Read back
-// by navigator.permissions.query(). Keys and values are duped into
-// frame_arena, so they live for (and reset with) the Page.
-permissions: std.StringHashMapUnmanaged([]const u8) = .empty,
+// by navigator.permissions.query().
+permissions: std.StringHashMapUnmanaged(PermissionState) = .empty,
// Identity tracking for the main world. All main-world contexts in this Page
// share this, ensuring object identity works across same-origin frames.
@@ -208,14 +208,12 @@ pub fn releaseArena(self: *Page, allocator: Allocator) void {
return self.session.releaseArena(allocator);
}
-// Set (or overwrite) the stored state for a permission. Name and state are
-// duped into frame_arena. Used by CDP Browser.grantPermissions / setPermission.
-pub fn setPermission(self: *Page, name: []const u8, state: []const u8) !void {
+pub fn setPermission(self: *Page, name: []const u8, state: PermissionState) !void {
const gop = try self.permissions.getOrPut(self.frame_arena, name);
if (!gop.found_existing) {
gop.key_ptr.* = try self.frame_arena.dupe(u8, name);
}
- gop.value_ptr.* = try self.frame_arena.dupe(u8, state);
+ gop.value_ptr.* = state;
}
pub fn getOrCreateOrigin(self: *Page, key_: ?[]const u8) !*js.Origin {
diff --git a/src/browser/webapi/Permissions.zig b/src/browser/webapi/Permissions.zig
index 1cf3249e3..effe590aa 100644
--- a/src/browser/webapi/Permissions.zig
+++ b/src/browser/webapi/Permissions.zig
@@ -29,6 +29,12 @@ pub fn registerTypes() []const type {
return &.{ Permissions, PermissionStatus };
}
+pub const State = enum {
+ granted,
+ prompt,
+ denied,
+};
+
const Permissions = @This();
// Padding to avoid zero-size struct pointer collisions
@@ -44,12 +50,11 @@ pub fn query(_: *const Permissions, qd: QueryDescriptor, exec: *const Execution)
const arena = try exec.getArena(.tiny, "PermissionStatus");
errdefer exec.releaseArena(arena);
- const state = exec.page.permissions.get(qd.name) orelse "prompt";
-
+ const state = exec.page.permissions.get(qd.name) orelse .prompt;
const status = try arena.create(PermissionStatus);
status.* = .{
._arena = arena,
- ._state = try arena.dupe(u8, state),
+ ._state = state,
._name = try arena.dupe(u8, qd.name),
};
return exec.js.local.?.resolvePromise(status);
@@ -59,7 +64,7 @@ const PermissionStatus = struct {
_rc: lp.RC(u8) = .{},
_arena: Allocator,
_name: []const u8,
- _state: []const u8,
+ _state: State,
pub fn deinit(self: *PermissionStatus, page: *Page) void {
page.releaseArena(self._arena);
@@ -78,7 +83,7 @@ const PermissionStatus = struct {
}
fn getState(self: *const PermissionStatus) []const u8 {
- return self._state;
+ return @tagName(self._state);
}
pub const JsApi = struct {
diff --git a/src/cdp/domains/browser.zig b/src/cdp/domains/browser.zig
index 8766f87ee..5d121bb0e 100644
--- a/src/cdp/domains/browser.zig
+++ b/src/cdp/domains/browser.zig
@@ -108,7 +108,7 @@ fn grantPermissions(cmd: *CDP.Command) !void {
const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded;
const page = bc.session.currentPage() orelse return error.PageNotLoaded;
for (params.permissions) |name| {
- try page.setPermission(name, "granted");
+ try page.setPermission(name, .granted);
}
return cmd.sendResult(null, .{ .include_session_id = false });
@@ -126,8 +126,12 @@ fn setPermission(cmd: *CDP.Command) !void {
const bc = cmd.browser_context orelse return error.BrowserContextNotLoaded;
const page = bc.session.currentPage() orelse return error.PageNotLoaded;
- try page.setPermission(params.permission.name, params.setting);
+ const PermissionState = @import("../../browser/webapi/Permissions.zig").State;
+ const state = std.meta.stringToEnum(PermissionState, params.setting) orelse {
+ return error.InvalidPermissionSetting;
+ };
+ try page.setPermission(params.permission.name, state);
return cmd.sendResult(null, .{ .include_session_id = false });
}
@@ -192,8 +196,8 @@ test "cdp.browser: grant/set/reset permissions reach navigator.permissions" {
.params = .{ .permissions = &[_][]const u8{ "geolocation", "notifications" } },
});
try ctx.expectSentResult(null, .{ .id = 40, .session_id = null });
- try testing.expectEqualSlices(u8, "granted", page.permissions.get("geolocation").?);
- try testing.expectEqualSlices(u8, "granted", page.permissions.get("notifications").?);
+ try testing.expectEqual(.granted, page.permissions.get("geolocation").?);
+ try testing.expectEqual(.granted, page.permissions.get("notifications").?);
// setPermission: override a single permission to an explicit state.
try ctx.processMessage(.{
@@ -202,7 +206,7 @@ test "cdp.browser: grant/set/reset permissions reach navigator.permissions" {
.params = .{ .permission = .{ .name = "geolocation" }, .setting = "denied" },
});
try ctx.expectSentResult(null, .{ .id = 41, .session_id = null });
- try testing.expectEqualSlices(u8, "denied", page.permissions.get("geolocation").?);
+ try testing.expectEqual(.denied, page.permissions.get("geolocation").?);
// resetPermissions: clears everything; query falls back to "prompt".
try ctx.processMessage(.{