Skip to content

Lightpanda: the headless browser designed for AI and automation

fix: discard superseded stylesheet completion events

Aaron Wong3ad9f1f00427
diff --git a/src/browser/Frame.zig b/src/browser/Frame.zig
index b80bfd9a2..0f90f4a00 100644
--- a/src/browser/Frame.zig
+++ b/src/browser/Frame.zig
@@ -2625,7 +2625,8 @@ pub fn trackFileList(self: *Frame, file_list: *FileList) !void {
pub const QueuedEvent = struct {
kind: Kind,
element: *Element.Html,
- generation: u32 = 0, // used by Image now, could be used by others though
+ generation: u32 = 0, // Image request generation
+ stylesheet_generation: ?u32 = null,
pub const Kind = enum { load, @"error" };
};
@@ -2642,6 +2643,10 @@ pub fn queueImageEvent(self: *Frame, image: *Element.Html.Image, kind: QueuedEve
try self.queueEvent(.{ .element = Factory.protoOf(image), .kind = kind, .generation = image._generation });
}
+fn queueStylesheetEvent(self: *Frame, link: *Element.Html.Link, kind: QueuedEvent.Kind, generation: u32) !void {
+ try self.queueEvent(.{ .element = Factory.protoOf(link), .kind = kind, .stylesheet_generation = generation });
+}
+
fn queueEvent(self: *Frame, event: QueuedEvent) !void {
try self._queued_events.append(self.page_arena, event);
if (self._queued_events.items.len == 1) {
@@ -2743,6 +2748,8 @@ pub fn loadExternalStylesheet(self: *Frame, link: *Element.Html.Link, href: []co
if (self._parse_mode == .fragment) {
return;
}
+ link._stylesheet_generation +%= 1;
+ const generation = link._stylesheet_generation;
const element = link.asElement();
// HttpClient will take out a larger arena for the body, if necessary
@@ -2751,7 +2758,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.queueElementEvent(Factory.protoOf(link), .@"error");
+ try self.queueStylesheetEvent(link, .@"error", generation);
return;
};
@@ -2772,7 +2779,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.queueElementEvent(Factory.protoOf(link), .@"error");
+ return self.queueStylesheetEvent(link, .@"error", generation);
};
{
errdefer transfer.deinit();
@@ -2794,13 +2801,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.queueElementEvent(Factory.protoOf(link), .@"error");
+ return self.queueStylesheetEvent(link, .@"error", generation);
};
defer response.deinit();
if (response.status < 200 or response.status >= 300) {
log.info(.http, "external stylesheet status", .{ .status = response.status, .url = resolved });
- return self.queueElementEvent(Factory.protoOf(link), .@"error");
+ return self.queueStylesheetEvent(link, .@"error", generation);
}
if (response.body.items.len > MAX_STYLESHEET_BYTES) {
@@ -2809,7 +2816,7 @@ pub fn loadExternalStylesheet(self: *Frame, link: *Element.Html.Link, href: []co
.max = MAX_STYLESHEET_BYTES,
.url = resolved,
});
- return self.queueElementEvent(Factory.protoOf(link), .@"error");
+ return self.queueStylesheetEvent(link, .@"error", generation);
}
// Reuse the cached sheet on re-fetch (href mutation on a connected
@@ -2844,11 +2851,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.queueElementEvent(Factory.protoOf(link), .@"error");
+ return self.queueStylesheetEvent(link, .@"error", generation);
};
sheet._href = try self.page_arena.dupe(u8, resolved);
- try self.queueLoad(Factory.protoOf(link));
+ try self.queueStylesheetEvent(link, .load, generation);
}
// https://html.spec.whatwg.org/multipage/iframe-embed-object.html#iframe-load-event-steps
@@ -2888,6 +2895,11 @@ fn dispatchQueuedEvents(self: *Frame) !void {
}
}
+ if (queued.stylesheet_generation) |generation| {
+ const link = html_element.asElement().as(Element.Html.Link);
+ if (link._stylesheet_generation != generation) continue;
+ }
+
const element = html_element.asElement();
switch (queued.kind) {
.load => {
diff --git a/src/browser/tests/css/stylesheet_event_order.html b/src/browser/tests/css/stylesheet_event_order.html
index 2c89c54b3..021362bdc 100644
--- a/src/browser/tests/css/stylesheet_event_order.html
+++ b/src/browser/tests/css/stylesheet_event_order.html
@@ -59,3 +59,46 @@
});
})();
</script>
+
+<script id="superseded_stylesheet_completion_is_not_delivered">
+(async () => {
+ const state = await testing.async();
+ const observed = [];
+ for (const [first, second] of [
+ ['/styles/404.css', '/styles/visibility.css'],
+ ['/styles/visibility.css?first', '/styles/visibility.css?second'],
+ ['/styles/visibility.css', '/styles/404.css'],
+ ]) {
+ const link = document.createElement('link');
+ link.rel = 'stylesheet';
+ link.href = first;
+ document.head.appendChild(link);
+ link.href = second;
+ const events = [];
+ link.addEventListener('load', () => events.push('load'));
+ link.addEventListener('error', () => events.push('error'));
+ await new Promise(resolve => setTimeout(resolve, 200));
+ observed.push(events);
+ link.remove();
+ }
+ state.resolve();
+ await state.done(() => testing.expectEqual([['load'], ['load'], ['error']], observed));
+})();
+</script>
+
+<script id="disconnected_stylesheet_does_not_deliver_completion">
+(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'));
+ link.addEventListener('error', () => events.push('error'));
+ document.head.appendChild(link);
+ link.remove();
+ await new Promise(resolve => setTimeout(resolve, 200));
+ state.resolve();
+ await state.done(() => testing.expectEqual([], events));
+})();
+</script>
diff --git a/src/browser/webapi/element/html/Link.zig b/src/browser/webapi/element/html/Link.zig
index c979b6cab..79f63deca 100644
--- a/src/browser/webapi/element/html/Link.zig
+++ b/src/browser/webapi/element/html/Link.zig
@@ -39,6 +39,7 @@ _proto_canary: if (lp.IS_DEBUG) *HtmlElement else void = undefined,
// old rules are dropped instead of accumulating in `document.styleSheets`.
// Mirrors `Style._sheet`.
_sheet: ?*@import("../../css/CSSStyleSheet.zig") = null,
+_stylesheet_generation: u32 = 0,
pub fn asElement(self: *Link) *Element {
return Factory.protoOf(self).asElement();
@@ -112,6 +113,7 @@ fn setRelList(self: *Link, value: String, frame: *Frame) !void {
}
pub fn linkAddedCallback(self: *Link, frame: *Frame) !void {
+ self._stylesheet_generation +%= 1;
// if we're planning on navigating to another frame, don't trigger load event.
if (frame.isGoingAway()) {
return;
@@ -195,6 +197,20 @@ pub const JsApi = struct {
// links in HTML go through `linkAddedCallback` at element-create time,
// with attributes already populated by `populateElementAttributes`.
pub const Build = struct {
+ pub fn attributeChange(element: *Element, name: String, _: String, _: *Frame) !void {
+ if (name.eql(comptime .wrap("href")) or name.eql(comptime .wrap("rel"))) {
+ element.as(Link)._stylesheet_generation +%= 1;
+ }
+ }
+
+ pub fn attributeRemove(element: *Element, name: String, frame: *Frame) !void {
+ try attributeChange(element, name, .wrap(""), frame);
+ }
+
+ pub fn disconnected(element: *Element, _: *Frame) !void {
+ element.as(Link)._stylesheet_generation +%= 1;
+ }
+
pub fn created(node: *Node, frame: *Frame) !void {
const self = node.as(Link);
return self.linkAddedCallback(frame);