Lightpanda: the headless browser designed for AI and automation
webapi: searchParams keeps a linked URL in sync
Karl Seguin04c8a4c3a65c
diff --git a/src/browser/tests/url.html b/src/browser/tests/url.htmlindex 5b1b0b12b..bcab61e4a 100644--- a/src/browser/tests/url.html+++ b/src/browser/tests/url.html@@ -1361,3 +1361,41 @@testing.expectEqual('sc:///', url.href);}</script>++<script id=searchParamsQuerySync>+{+ // Accessing searchParams must not rewrite the query...+ const url = new URL('http://www.example.com/?a=b,c');+ url.searchParams;+ testing.expectEqual('http://www.example.com/?a=b,c', url.toString());+ testing.expectEqual('?a=b,c', url.search);+ testing.expectEqual('a=b%2Cc', url.searchParams.toString());++ // ...but mutations push the serialized list into it.+ url.searchParams.append('x', 'y');+ testing.expectEqual('http://www.example.com/?a=b%2Cc&x=y', url.toString());++ // Deleting the last param drops the '?'.+ const url2 = new URL('http://example.com/?p1&p2');+ url2.searchParams.delete('p1');+ url2.searchParams.delete('p2');+ testing.expectEqual('http://example.com/', url2.href);+ testing.expectEqual('', url2.search);++ // A double-'?' query reads back raw via url.search.+ const url3 = new URL('http://example.org/file??a=b&c=d');+ testing.expectEqual('??a=b&c=d', url3.search);+ testing.expectEqual('%3Fa=b&c=d', url3.searchParams.toString());++ // set() keeps the first entry's position when pushing back.+ const url4 = new URL('http://example.org/file?e=f&g=h');+ const sp = url4.searchParams;+ sp.append('i', ' j ');+ sp.set('e', 'updated');+ testing.expectEqual('?e=updated&g=h&i=+j+', url4.search);++ // search setter still propagates into an existing searchParams.+ url4.search = 'n=1';+ testing.expectEqual('n=1', sp.toString());+}+</script>diff --git a/src/browser/webapi/URL.zig b/src/browser/webapi/URL.zigindex 19c1037d2..37e10204f 100644--- a/src/browser/webapi/URL.zig+++ b/src/browser/webapi/URL.zig@@ -60,6 +60,9 @@ pub fn parse(url: []const u8, maybe_base: ?[]const u8, exec: *const Execution) ?pub fn deinit(self: *URL, page: *Page) void {if (self._search_params) |search_params| {+ // The params can outlive the URL. Unlink it.+ search_params._url = null;+ // And, remove the RC that we (URL) were holding on it.search_params.releaseRef(page);}// Not tracked by arena.@@ -171,18 +174,8 @@ pub fn setPort(self: *URL, maybe_value: ?[]const u8) void {_ = U.url_set_port(self._url, port);}-pub fn getSearch(self: *const URL, exec: *const Execution) ![]const u8 {- if (self._search_params) |search_params| {- if (search_params.getSize() == 0) {- return "";- }-- var buf = std.Io.Writer.Allocating.init(exec.local_arena);- try buf.writer.writeByte('?');- try search_params.toString(&buf.writer);- return buf.written();- }-+// searchParam pushes its mutations to URL, so self._url is always in sync+pub fn getSearch(self: *const URL, _: *const Execution) ![]const u8 {var out: [*]const u8 = undefined;var len: usize = 0;const res = U.url_get_query(self._url, &out, &len);@@ -257,12 +250,28 @@ pub fn getSearchParams(self: *URL, exec: *const Execution) !*URLSearchParams {const search_value = if (U.url_get_query(self._url, &out, &len) == 0) (out - 1)[0 .. len + 1] else "";const params = try URLSearchParams.init(.{ .query_string = search_value }, exec);- // Released in deinit; the cached params must outlive their JS wrapper.params.acquireRef();+ params._url = self;self._search_params = params;return params;}+// Every update to the url's _search_params needs to keep the url in sync+pub fn syncQueryFromParams(self: *URL, exec: *const Execution) !void {+ const params = self._search_params orelse return;+ if (params.getSize() == 0) {+ U.url_set_query_to_null(self._url);+ return;+ }++ var buf = std.Io.Writer.Allocating.init(exec.local_arena);+ try params.toString(&buf.writer);+ const query = buf.written();+ if (U.url_set_query(self._url, query.ptr, query.len) != 0) {+ return error.TypeError;+ }+}+pub fn getOrigin(self: *const URL, exec: *const Execution) ![]const u8 {const origin = U.url_get_origin(self._url);defer origin.deinit();@@ -288,21 +297,7 @@ pub fn setHref(self: *URL, value: []const u8, exec: *const Execution) !void {try search_params.updateFromString(search_value, exec);}-pub fn toString(self: *const URL, exec: *const Execution) ![]const u8 {- if (self._search_params) |search_params| {- if (search_params.getSize() == 0) {- U.url_set_query_to_null(self._url);- } else {- var buf = std.Io.Writer.Allocating.init(exec.local_arena);- defer buf.deinit();- try search_params.toString(&buf.writer);- const query = buf.written();- if (U.url_set_query(self._url, query.ptr, query.len) != 0) {- return error.ToString;- }- }- }-+pub fn toString(self: *const URL, _: *const Execution) ![]const u8 {var out: [*]const u8 = undefined;var len: usize = 0;U.url_to_string(self._url, &out, &len);diff --git a/src/browser/webapi/net/URLSearchParams.zig b/src/browser/webapi/net/URLSearchParams.zigindex 982993625..98169c64b 100644--- a/src/browser/webapi/net/URLSearchParams.zig+++ b/src/browser/webapi/net/URLSearchParams.zig@@ -22,6 +22,7 @@ const lp = @import("lightpanda");const js = @import("../../js/js.zig");const Page = @import("../../Page.zig");+const URL = @import("../URL.zig");const FormData = @import("FormData.zig");const KeyValueList = @import("../KeyValueList.zig");@@ -44,6 +45,7 @@ const URLSearchParams = @This();_rc: lp.RC = .{},_arena: *lp.Arena,_params: KeyValueList,+_url: ?*URL = null, // Set when created via the url.searchParams getterconst InitOpts = union(enum) {form_data: *FormData,@@ -62,9 +64,12 @@ pub fn init(opts_: ?InitOpts, exec: *const Execution) !*URLSearchParams {.form_data => |fd| break :blk try fd.toKeyValueList(arena.allocator()),.value => |js_val| {if (js_val.isObject()) {+ // Per Web IDL, an object with @@iterator converts as a+ // sequence of [name, value] pairs. This covers arrays,+ // Maps, generators and other URLSearchParams - including+ // ones with a patched @@iterator, so no instanceof+ // fast-path here.if (try js_val.iterator()) |it| {- // value satisfies the @@iterator protocol, so we're- // expecting [name, value] tuplesbreak :blk try paramsFromIterator(arena.allocator(), it);}// normalizer is null, so frame won't be used@@ -118,16 +123,19 @@ pub fn has(self: *const URLSearchParams, name: []const u8, value: ?[]const u8) breturn self._params.has(name, value);}-pub fn set(self: *URLSearchParams, name: []const u8, value: []const u8) !void {- return self._params.set(self._arena.allocator(), name, value);+pub fn set(self: *URLSearchParams, name: []const u8, value: []const u8, exec: *const Execution) !void {+ try self._params.set(self._arena.allocator(), name, value);+ try self.postUpdate(exec);}-pub fn append(self: *URLSearchParams, name: []const u8, value: []const u8) !void {- return self._params.append(self._arena.allocator(), name, value);+pub fn append(self: *URLSearchParams, name: []const u8, value: []const u8, exec: *const Execution) !void {+ try self._params.append(self._arena.allocator(), name, value);+ try self.postUpdate(exec);}-pub fn delete(self: *URLSearchParams, name: []const u8, value: ?[]const u8) void {+pub fn delete(self: *URLSearchParams, name: []const u8, value: ?[]const u8, exec: *const Execution) !void {self._params.delete(name, value);+ try self.postUpdate(exec);}pub fn keys(self: *URLSearchParams, exec: *const Execution) !*KeyIterator {@@ -154,7 +162,10 @@ pub fn format(self: *const URLSearchParams, writer: *std.Io.Writer) !void {pub fn forEach(self: *URLSearchParams, cb_: js.Function, js_this_: ?js.Object) !void {const cb = if (js_this_) |js_this| try cb_.withThis(js_this) else cb_;- // the callback can mutate the list+ // Index-based on purpose: the callback can mutate the list (delete,+ // append, ...), which both changes its length and can reallocate the+ // backing slice, so neither a captured slice nor a pointer into it+ // survives the call.var i: usize = 0;while (i < self._params._entries.items.len) : (i += 1) {const entry = self._params._entries.items[i];@@ -165,15 +176,27 @@ pub fn forEach(self: *URLSearchParams, cb_: js.Function, js_this_: ?js.Object) !}}-pub fn sort(self: *URLSearchParams) void {- // std.mem.sort is stable (as required by the spec)+pub fn sort(self: *URLSearchParams, exec: *const Execution) !void {+ // std.mem.sort (block sort) is stable, which the spec requires: entries+ // with equal names keep their relative order.std.mem.sort(KeyValueList.Entry, self._params._entries.items, {}, struct {fn cmp(_: void, a: KeyValueList.Entry, b: KeyValueList.Entry) bool {return utf16Order(a.name.str(), b.name.str()) == .lt;}}.cmp);+ try self.postUpdate(exec);}+// we need to keep the linked url in sync+fn postUpdate(self: *URLSearchParams, exec: *const Execution) !void {+ const url = self._url orelse return;+ try url.syncQueryFromParams(exec);+}++// The URL spec sorts by UTF-16 code units, not bytes or code points. The+// difference is observable for supplementary-plane characters: 🌈 (U+1F308)+// is a higher code point than ffi (U+FB03), but its UTF-16 lead surrogate+// (0xD83C) is a lower code unit.fn utf16Order(a: []const u8, b: []const u8) std.math.Order {var ia: usize = 0;var ib: usize = 0;@@ -231,21 +254,17 @@ fn paramsFromIterator(allocator: Allocator, it: js.Value.Iterator) !KeyValueListif (item.isArray()) {const as_array = item.toArray();- if (as_array.len() != 2) {- // we should be getting [name, value]- return error.TypeError;- }+ // Each pair must have exactly 2 items.+ if (as_array.len() != 2) return error.TypeError;name_val = try as_array.get(0);value_val = try as_array.get(1);} else {- // Not an array, but it could itself be an iterator+ // A non-array pair (e.g. what a Map entries iterator or a custom+ // generator yields) converts through its own @@iterator.var pair_it = (try item.iterator()) orelse return error.TypeError;name_val = (try pair_it.next()) orelse return error.TypeError;value_val = (try pair_it.next()) orelse return error.TypeError;- if (try pair_it.next() != null) {- // should only have a name and a value, anything else is wrong- return error.TypeError;- }+ if (try pair_it.next() != null) return error.TypeError;}try params._entries.append(allocator, .{@@ -301,6 +320,13 @@ fn paramsFromString(allocator: Allocator, input_: []const u8, buf: []u8) !KeyValreturn params;}+// True when value[i] starts a valid %XX escape. A '%' not followed by two+// hex digits is not an error: percent-decode passes it through literally+// ("b=%2sf" parses to "%2sf").+fn isEscapeTriplet(value: []const u8, i: usize) bool {+ return i + 2 < value.len and std.ascii.isHex(value[i + 1]) and std.ascii.isHex(value[i + 2]);+}+fn unescape(arena: Allocator, value: []const u8, buf: []u8) !String {if (value.len == 0) {return comptime .wrap("");@@ -390,11 +416,6 @@ pub const Iterator = struct {}};-// True when value[i] starts a valid %XX escape-fn isEscapeTriplet(value: []const u8, i: usize) bool {- return i + 2 < value.len and std.ascii.isHex(value[i + 1]) and std.ascii.isHex(value[i + 2]);-}-const GenericIterator = @import("../collections/iterator.zig").Entry;pub const KeyIterator = GenericIterator(Iterator, "0");pub const ValueIterator = GenericIterator(Iterator, "1");diff --git a/src/browser/webapi/net/body_init.zig b/src/browser/webapi/net/body_init.zigindex 4e6b85ea7..99579ac41 100644--- a/src/browser/webapi/net/body_init.zig+++ b/src/browser/webapi/net/body_init.zig@@ -154,8 +154,8 @@ test "BodyInit: URLSearchParams emit urlencoded body + content-type" {const usp = try arena.create(URLSearchParams);usp.* = .{ ._arena = arena, ._params = .empty };- try usp.append("a", "1");- try usp.append("b", "2");+ try usp._params.append(arena.allocator(), "a", "1");+ try usp._params.append(arena.allocator(), "b", "2");const r = try (BodyInit{ .url_search_params = usp }).extract(arena.allocator());try testing.expectString("a=1&b=2", r.bytes);