Skip to content

Lightpanda: the headless browser designed for AI and automation

fix: defer external stylesheet completion events

Aaron Wong60ba0f4fc87e
diff --git a/src/browser/Frame.zig b/src/browser/Frame.zig
index 00be794de..b80bfd9a2 100644
--- a/src/browser/Frame.zig
+++ b/src/browser/Frame.zig
@@ -2722,6 +2722,7 @@ pub fn queueHashChange(self: *Frame, old_url: []const u8, new_url: []const u8) !
pub const MAX_STYLESHEET_BYTES: usize = 4 * 1024 * 1024;
// Synchronously fetch and parse an external `<link rel=stylesheet>`.
+// Completion events wait until the current script has installed its listeners.
// href is passed in as an optimization since the [currently] only callsite has
// it, so why look it up again?
pub fn loadExternalStylesheet(self: *Frame, link: *Element.Html.Link, href: []const u8) !void {
@@ -2750,7 +2751,7 @@ pub fn loadExternalStylesheet(self: *Frame, link: *Element.Html.Link, href: []co
const resolved = URL.resolve(arena.allocator(), self.base(), href, .{ .encoding = self.charset }) catch |err| {
log.debug(.http, "external stylesheet resolve", .{ .err = err, .href = href });
- try self.fireElementEvent(element, comptime .wrap("error"));
+ try self.queueElementEvent(Factory.protoOf(link), .@"error");
return;
};
@@ -2771,7 +2772,7 @@ pub fn loadExternalStylesheet(self: *Frame, link: *Element.Html.Link, href: []co
.shutdown_callback = HttpClient.noopShutdown, // syncRequest installs its own
}, &self._http_owner) catch |err| {
log.debug(.http, "external stylesheet fetch", .{ .err = err, .url = resolved });
- return self.fireElementEvent(element, comptime .wrap("error"));
+ return self.queueElementEvent(Factory.protoOf(link), .@"error");
};
{
errdefer transfer.deinit();
@@ -2793,13 +2794,13 @@ pub fn loadExternalStylesheet(self: *Frame, link: *Element.Html.Link, href: []co
var response = transfer.submitSync(.{}) catch |err| {
log.debug(.http, "external stylesheet fetch", .{ .err = err, .url = resolved });
- return self.fireElementEvent(element, comptime .wrap("error"));
+ return self.queueElementEvent(Factory.protoOf(link), .@"error");
};
defer response.deinit();
if (response.status < 200 or response.status >= 300) {
log.info(.http, "external stylesheet status", .{ .status = response.status, .url = resolved });
- return self.fireElementEvent(element, comptime .wrap("error"));
+ return self.queueElementEvent(Factory.protoOf(link), .@"error");
}
if (response.body.items.len > MAX_STYLESHEET_BYTES) {
@@ -2808,7 +2809,7 @@ pub fn loadExternalStylesheet(self: *Frame, link: *Element.Html.Link, href: []co
.max = MAX_STYLESHEET_BYTES,
.url = resolved,
});
- return self.fireElementEvent(element, comptime .wrap("error"));
+ return self.queueElementEvent(Factory.protoOf(link), .@"error");
}
// Reuse the cached sheet on re-fetch (href mutation on a connected
@@ -2843,11 +2844,11 @@ pub fn loadExternalStylesheet(self: *Frame, link: *Element.Html.Link, href: []co
const text = try css_charset.decode(arena.allocator(), response.body.items, protocol_charset, self.charset);
sheet.replaceSync(text, self) catch |err| {
log.debug(.http, "external stylesheet parse", .{ .err = err, .url = resolved });
- return self.fireElementEvent(element, comptime .wrap("error"));
+ return self.queueElementEvent(Factory.protoOf(link), .@"error");
};
sheet._href = try self.page_arena.dupe(u8, resolved);
- try self.fireElementEvent(element, comptime .wrap("load"));
+ try self.queueLoad(Factory.protoOf(link));
}
// https://html.spec.whatwg.org/multipage/iframe-embed-object.html#iframe-load-event-steps
diff --git a/src/browser/tests/css/external_stylesheet.html b/src/browser/tests/css/external_stylesheet.html
index fba7b0c41..a8bedbc60 100644
--- a/src/browser/tests/css/external_stylesheet.html
+++ b/src/browser/tests/css/external_stylesheet.html
@@ -121,24 +121,27 @@
link.rel = 'stylesheet';
link.href = '/styles/visibility.css';
- const baseline = document.styleSheets.length;
+ const ownedSheets = () => Array.from(document.styleSheets).filter(sheet => sheet.ownerNode === link);
+ const baseline = ownedSheets().length;
await new Promise(resolve => {
link.addEventListener('load', () => resolve(), { once: true });
document.head.appendChild(link);
});
- const afterFirst = document.styleSheets.length;
+ const firstSheets = ownedSheets();
+ const afterFirst = firstSheets.length;
+ const firstSheet = firstSheets[0];
const second = await new Promise(resolve => {
link.addEventListener('load', () => resolve('load'), { once: true });
link.addEventListener('error', () => resolve('error'), { once: true });
link.href = '/styles/visibility2.css';
});
- const afterSecond = document.styleSheets.length;
+ const secondSheets = ownedSheets();
+ const afterSecond = secondSheets.length;
- // New rules must be in effect after the swap. The reused sheet is
- // the last registered one (the static head link registered first).
- const sheet = document.styleSheets[afterFirst - 1];
+ // Other module scripts may add unrelated sheets while the load is pending.
+ const sheet = secondSheets[0];
const sheetHref = sheet.href;
const sheetRulesLen = sheet.cssRules.length;
const sheetSelector = sheet.cssRules[0].selectorText;
@@ -148,6 +151,7 @@
testing.expectEqual(baseline + 1, afterFirst);
testing.expectEqual('load', second);
testing.expectEqual(afterFirst, afterSecond);
+ testing.expectTrue(firstSheet === sheet);
testing.expectEqual(testing.ORIGIN + '/styles/visibility2.css', sheetHref);
testing.expectEqual(1, sheetRulesLen);
testing.expectEqual('.ext-hide-2', sheetSelector);
diff --git a/src/browser/tests/css/stylesheet_event_order.html b/src/browser/tests/css/stylesheet_event_order.html
new file mode 100644
index 000000000..2c89c54b3
--- /dev/null
+++ b/src/browser/tests/css/stylesheet_event_order.html
@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<script src="../testing.js"></script>
+<head></head>
+<body></body>
+
+<script id="stylesheet_load_after_append">
+(async () => {
+ const state = await testing.async();
+ const link = document.createElement('link');
+ link.rel = 'stylesheet';
+ link.href = '/styles/visibility.css';
+ const events = [];
+ link.addEventListener('load', () => events.push('load'));
+
+ const completion = new Promise(resolve => {
+ document.head.appendChild(link);
+ events.push('appended');
+ queueMicrotask(() => events.push('microtask'));
+ link.addEventListener('load', () => resolve('load'));
+ link.addEventListener('error', () => resolve('error'));
+ });
+ const outcome = await Promise.race([
+ completion,
+ new Promise(resolve => setTimeout(() => resolve('timeout'), 500)),
+ ]);
+ state.resolve();
+ await state.done(() => {
+ testing.expectEqual('load', outcome);
+ testing.expectEqual(['appended', 'microtask', 'load'], events);
+ testing.expectEqual('.ext-hide', document.styleSheets[0].cssRules[0].selectorText);
+ });
+})();
+</script>
+
+<script id="stylesheet_error_after_append">
+(async () => {
+ const state = await testing.async();
+ const link = document.createElement('link');
+ link.rel = 'stylesheet';
+ link.href = '/styles/404.css';
+ const events = [];
+ link.addEventListener('error', () => events.push('error'));
+
+ const completion = new Promise(resolve => {
+ document.head.appendChild(link);
+ events.push('appended');
+ queueMicrotask(() => events.push('microtask'));
+ link.addEventListener('load', () => resolve('load'));
+ link.addEventListener('error', () => resolve('error'));
+ });
+ const outcome = await Promise.race([
+ completion,
+ new Promise(resolve => setTimeout(() => resolve('timeout'), 500)),
+ ]);
+ state.resolve();
+ await state.done(() => {
+ testing.expectEqual('error', outcome);
+ testing.expectEqual(['appended', 'microtask', 'error'], events);
+ });
+})();
+</script>
diff --git a/src/browser/webapi/element/html/Link.zig b/src/browser/webapi/element/html/Link.zig
index 0fd0e28e1..c979b6cab 100644
--- a/src/browser/webapi/element/html/Link.zig
+++ b/src/browser/webapi/element/html/Link.zig
@@ -215,6 +215,11 @@ test "WebApi: HTML.Link external stylesheet charset" {
try testing.htmlRunner("css/stylesheet_charset.html", .{ .load_resources = .{ .stylesheet = true } });
}
+test "WebApi: HTML.Link external stylesheet event ordering" {
+ testing.silenceLog(&.{.http});
+ try testing.htmlRunner("css/stylesheet_event_order.html", .{ .load_resources = .{ .stylesheet = true } });
+}
+
// Regression: a synchronous external-stylesheet fetch must not strand the
// completion of an in-flight <script defer> (held back by the blocking-
// request gate during the sync window). Otherwise the deferred-script queue