Skip to content

Lightpanda: the headless browser designed for AI and automation

webapi, worker: Expose Navigator on Worker

Karl Seguind052a79241d2
diff --git a/src/browser/js/bridge.zig b/src/browser/js/bridge.zig
index 2b5dff32a..98216f715 100644
--- a/src/browser/js/bridge.zig
+++ b/src/browser/js/bridge.zig
@@ -1007,6 +1007,10 @@ pub const PageJsApis = flattenTypes(&.{
pub const WorkerJsApis = flattenTypes(&.{
@import("../webapi/WorkerGlobalScope.zig"),
@import("../webapi/WorkerLocation.zig"),
+ @import("../webapi/Navigator.zig"),
+ @import("../webapi/NavigatorUAData.zig"),
+ @import("../webapi/Permissions.zig"),
+ @import("../webapi/StorageManager.zig"),
@import("../webapi/EventTarget.zig"),
@import("../webapi/Event.zig"),
@import("../webapi/event/MessageEvent.zig"),
diff --git a/src/browser/tests/worker/navigator-worker.js b/src/browser/tests/worker/navigator-worker.js
new file mode 100644
index 000000000..4136e2013
--- /dev/null
+++ b/src/browser/tests/worker/navigator-worker.js
@@ -0,0 +1,48 @@
+// Exposes WorkerNavigator (navigator) inside a WorkerGlobalScope.
+// Replies with either { ok: true, results: {...} } or { ok: false, err }.
+onmessage = async function(event) {
+ try {
+ // Permissions (transitively reachable: navigator.permissions -> Permissions
+ // -> PermissionStatus). Must not depend on a Frame.
+ const status = await navigator.permissions.query({ name: 'geolocation' });
+
+ // StorageManager (navigator.storage -> StorageManager -> StorageEstimate).
+ const estimate = await navigator.storage.estimate();
+
+ // NavigatorUAData (navigator.userAgentData -> getHighEntropyValues()).
+ const ua = navigator.userAgentData;
+ const high_entropy = ua ? await ua.getHighEntropyValues(['architecture']) : null;
+
+ const results = {
+ has_navigator: typeof navigator !== 'undefined',
+ // userAgent must match the value the page sees (passed in via postMessage).
+ user_agent: navigator.userAgent,
+ user_agent_matches_page: navigator.userAgent === event.data.pageUserAgent,
+ app_name: navigator.appName,
+ platform: navigator.platform,
+ on_line: navigator.onLine,
+ // SameObject: navigator should be stable across reads.
+ identity_stable: navigator === navigator,
+
+ // Permissions
+ permission_name: status.name,
+ permission_state: status.state,
+
+ // StorageManager
+ storage_quota: estimate.quota,
+ storage_usage: estimate.usage,
+
+ // NavigatorUAData
+ has_ua_data: ua != null,
+ ua_high_entropy_arch: high_entropy ? high_entropy.architecture : null,
+
+ // [Exposed=Window] members must NOT leak into the worker realm.
+ no_plugins: navigator.plugins === undefined,
+ no_register_protocol_handler: navigator.registerProtocolHandler === undefined,
+ no_model_context: navigator.modelContext === undefined,
+ };
+ postMessage({ ok: true, results });
+ } catch (e) {
+ postMessage({ ok: false, err: e.message });
+ }
+};
diff --git a/src/browser/tests/worker/worker.html b/src/browser/tests/worker/worker.html
index 56c23dbdf..39aaad81d 100644
--- a/src/browser/tests/worker/worker.html
+++ b/src/browser/tests/worker/worker.html
@@ -251,6 +251,47 @@
}
</script>
+<script id="worker_navigator" type=module>
+ {
+ const state = await testing.async();
+ const worker = new Worker('./navigator-worker.js');
+
+ worker.onmessage = function(event) {
+ state.resolve(event.data);
+ };
+ worker.postMessage({ pageUserAgent: navigator.userAgent });
+
+ await state.done((data) => {
+ testing.expectTrue(data.ok, 'worker navigator error: ' + data.err);
+ const r = data.results;
+
+ testing.expectEqual(true, r.has_navigator);
+ testing.expectEqual(true, r.user_agent_matches_page);
+ testing.expectEqual('Netscape', r.app_name);
+ testing.expectTrue(r.platform.length > 0);
+ testing.expectEqual(true, r.on_line);
+ testing.expectEqual(true, r.identity_stable);
+
+ // Permissions (transitive: Permissions -> PermissionStatus)
+ testing.expectEqual('geolocation', r.permission_name);
+ testing.expectEqual('prompt', r.permission_state);
+
+ // StorageManager (transitive: StorageManager -> StorageEstimate)
+ testing.expectEqual(0, r.storage_usage);
+ testing.expectTrue(r.storage_quota > 0);
+
+ // NavigatorUAData
+ testing.expectEqual(true, r.has_ua_data);
+ testing.expectTrue(typeof r.ua_high_entropy_arch === 'string');
+
+ // [Exposed=Window] members aren't part of WorkerNavigator.
+ testing.expectEqual(true, r.no_plugins);
+ testing.expectEqual(true, r.no_register_protocol_handler);
+ testing.expectEqual(true, r.no_model_context);
+ });
+ }
+</script>
+
<script id="worker_dynamic_import" type=module>
{
const state = await testing.async();
diff --git a/src/browser/webapi/Navigator.zig b/src/browser/webapi/Navigator.zig
index 1ffd6af2d..4980201f8 100644
--- a/src/browser/webapi/Navigator.zig
+++ b/src/browser/webapi/Navigator.zig
@@ -21,6 +21,7 @@ const builtin = @import("builtin");
const js = @import("../js/js.zig");
const Frame = @import("../Frame.zig");
+const Execution = js.Execution;
const PluginArray = @import("PluginArray.zig");
const Permissions = @import("Permissions.zig");
@@ -37,8 +38,8 @@ _ua_data: NavigatorUAData = .{},
pub const init: Navigator = .{};
-pub fn getUserAgent(_: *const Navigator, frame: *Frame) []const u8 {
- return frame._session.browser.http_client.getUserAgent();
+pub fn getUserAgent(_: *const Navigator, exec: *const Execution) []const u8 {
+ return exec.session.browser.http_client.getUserAgent();
}
pub fn getLanguages(_: *const Navigator) [2][]const u8 {
@@ -219,9 +220,6 @@ pub const JsApi = struct {
pub const empty_with_no_proto = true;
};
- // Read-only properties. All are accessors (not data properties) so they
- // present as native getters on Navigator.prototype, matching real browsers
- // — see the getter definitions above for why.
pub const userAgent = bridge.accessor(Navigator.getUserAgent, null, .{});
pub const appName = bridge.accessor(Navigator.getAppName, null, .{});
pub const appCodeName = bridge.accessor(Navigator.getAppCodeName, null, .{});
@@ -237,18 +235,20 @@ pub const JsApi = struct {
pub const vendor = bridge.accessor(Navigator.getVendor, null, .{});
pub const product = bridge.accessor(Navigator.getProduct, null, .{});
pub const webdriver = bridge.accessor(Navigator.getWebdriver, null, .{});
- pub const plugins = bridge.accessor(Navigator.getPlugins, null, .{});
pub const doNotTrack = bridge.accessor(Navigator.getDoNotTrack, null, .{});
pub const globalPrivacyControl = bridge.accessor(Navigator.getGlobalPrivacyControl, null, .{});
- pub const registerProtocolHandler = bridge.function(Navigator.registerProtocolHandler, .{ .dom_exception = true });
- pub const unregisterProtocolHandler = bridge.function(Navigator.unregisterProtocolHandler, .{ .dom_exception = true });
- // Methods
pub const javaEnabled = bridge.function(Navigator.javaEnabled, .{});
pub const permissions = bridge.accessor(Navigator.getPermissions, null, .{});
pub const storage = bridge.accessor(Navigator.getStorage, null, .{});
pub const userAgentData = bridge.accessor(Navigator.getUserAgentData, null, .{});
- pub const modelContext = bridge.accessor(Navigator.getModelContext, null, .{});
+
+ // window only
+ pub const plugins = bridge.accessor(Navigator.getPlugins, null, .{ .exposed = .window });
+ pub const modelContext = bridge.accessor(Navigator.getModelContext, null, .{ .exposed = .window });
+ pub const registerProtocolHandler = bridge.function(Navigator.registerProtocolHandler, .{ .dom_exception = true, .exposed = .window });
+ pub const unregisterProtocolHandler = bridge.function(Navigator.unregisterProtocolHandler, .{ .dom_exception = true, .exposed = .window });
+
};
const testing = @import("../../testing.zig");
diff --git a/src/browser/webapi/NavigatorUAData.zig b/src/browser/webapi/NavigatorUAData.zig
index 308295e52..fe5cf01c4 100644
--- a/src/browser/webapi/NavigatorUAData.zig
+++ b/src/browser/webapi/NavigatorUAData.zig
@@ -20,7 +20,7 @@ const builtin = @import("builtin");
const Config = @import("../../Config.zig");
const js = @import("../js/js.zig");
-const Frame = @import("../Frame.zig");
+const Execution = js.Execution;
const NavigatorUAData = @This();
@@ -55,14 +55,14 @@ pub fn toJSON(_: *const NavigatorUAData) struct {
};
}
-pub fn getHighEntropyValues(_: *const NavigatorUAData, hints: []const []const u8, frame: *Frame) !js.Promise {
+pub fn getHighEntropyValues(_: *const NavigatorUAData, hints: []const []const u8, exec: *const Execution) !js.Promise {
// This should always return `brands` + `mobile` + `platform` and then whatever
// "hints" field is requested (assuming the browser has permission), but it's
// also valid to just return everything.
_ = hints;
- return frame.js.local.?.resolvePromise(.{
+ return exec.js.local.?.resolvePromise(.{
.brands = brandList(),
.mobile = false,
.platform = uaPlatform(),
diff --git a/src/browser/webapi/Permissions.zig b/src/browser/webapi/Permissions.zig
index 3485e11a3..795df7c9b 100644
--- a/src/browser/webapi/Permissions.zig
+++ b/src/browser/webapi/Permissions.zig
@@ -21,7 +21,7 @@ const lp = @import("lightpanda");
const js = @import("../js/js.zig");
const Page = @import("../Page.zig");
-const Frame = @import("../Frame.zig");
+const Execution = js.Execution;
const Allocator = std.mem.Allocator;
@@ -38,9 +38,9 @@ const QueryDescriptor = struct {
name: []const u8,
};
// We always report 'prompt' (the default safe value — neither granted nor denied).
-pub fn query(_: *const Permissions, qd: QueryDescriptor, frame: *Frame) !js.Promise {
- const arena = try frame.getArena(.tiny, "PermissionStatus");
- errdefer frame.releaseArena(arena);
+pub fn query(_: *const Permissions, qd: QueryDescriptor, exec: *const Execution) !js.Promise {
+ const arena = try exec.getArena(.tiny, "PermissionStatus");
+ errdefer exec.releaseArena(arena);
const status = try arena.create(PermissionStatus);
status.* = .{
@@ -48,7 +48,7 @@ pub fn query(_: *const Permissions, qd: QueryDescriptor, frame: *Frame) !js.Prom
._state = "prompt",
._name = try arena.dupe(u8, qd.name),
};
- return frame.js.local.?.resolvePromise(status);
+ return exec.js.local.?.resolvePromise(status);
}
const PermissionStatus = struct {
diff --git a/src/browser/webapi/StorageManager.zig b/src/browser/webapi/StorageManager.zig
index 40c3eeb06..bcfd85283 100644
--- a/src/browser/webapi/StorageManager.zig
+++ b/src/browser/webapi/StorageManager.zig
@@ -17,7 +17,7 @@
// along with this program. If not, see <https://www.gnu.org/licenses/>.
const js = @import("../js/js.zig");
-const Frame = @import("../Frame.zig");
+const Execution = js.Execution;
pub fn registerTypes() []const type {
return &.{ StorageManager, StorageEstimate };
@@ -27,12 +27,12 @@ const StorageManager = @This();
_pad: bool = false,
-pub fn estimate(_: *const StorageManager, frame: *Frame) !js.Promise {
- const est = try frame._factory.create(StorageEstimate{
+pub fn estimate(_: *const StorageManager, exec: *const Execution) !js.Promise {
+ const est = try exec._factory.create(StorageEstimate{
._usage = 0,
._quota = 1024 * 1024 * 1024, // 1 GiB
});
- return frame.js.local.?.resolvePromise(est);
+ return exec.js.local.?.resolvePromise(est);
}
const StorageEstimate = struct {
diff --git a/src/browser/webapi/WorkerGlobalScope.zig b/src/browser/webapi/WorkerGlobalScope.zig
index 16495be85..840f30649 100644
--- a/src/browser/webapi/WorkerGlobalScope.zig
+++ b/src/browser/webapi/WorkerGlobalScope.zig
@@ -37,6 +37,7 @@ const Event = @import("Event.zig");
const Worker = @import("Worker.zig");
const Crypto = @import("Crypto.zig");
const Console = @import("Console.zig");
+const Navigator = @import("Navigator.zig");
const Timers = @import("Timers.zig");
const EventTarget = @import("EventTarget.zig");
const Performance = @import("Performance.zig");
@@ -97,6 +98,7 @@ _closed: bool = false,
_proto: *EventTarget,
_console: Console = .init,
_crypto: Crypto = .init,
+_navigator: Navigator = .init,
_performance: Performance,
_on_error: ?JS.Function.Global = null,
_on_rejection_handled: ?JS.Function.Global = null,
@@ -259,6 +261,10 @@ pub fn getCrypto(self: *WorkerGlobalScope) *Crypto {
return &self._crypto;
}
+pub fn getNavigator(self: *WorkerGlobalScope) *Navigator {
+ return &self._navigator;
+}
+
pub fn performance(self: *WorkerGlobalScope) *Performance {
return &self._performance;
}
@@ -667,6 +673,7 @@ pub const JsApi = struct {
pub const self = bridge.accessor(WorkerGlobalScope.getSelf, WorkerGlobalScope.setSelf, .{});
pub const console = bridge.accessor(WorkerGlobalScope.getConsole, WorkerGlobalScope.setConsole, .{});
pub const crypto = bridge.accessor(WorkerGlobalScope.getCrypto, null, .{});
+ pub const navigator = bridge.accessor(WorkerGlobalScope.getNavigator, null, .{});
pub const performance = bridge.accessor(struct {
// Unnecessary, But, our WebAPI getters are ALWAYS `fn getPerformance()...`.
// But for performance, we _need_ to have fn performance() *Performance to