fix navigation and related tests

Author: mookums

src/browser/html/History.zig

@@ -81,7 +81,9 @@ fn _dispatchPopStateEvent(state: ?[]const u8, page: *Page) !void {
 pub fn _pushState(_: *const History, state: js.Object, _: ?[]const u8, _url: ?[]const u8, page: *Page) !void {
     const arena = page.session.arena;
     const url = if (_url) |u| try arena.dupe(u8, u) else try arena.dupe(u8, page.url.raw);
-    _ = try page.session.navigation.pushEntry(url, .{ .state = state }, page);
+
+    const json = state.toJson(arena) catch return error.DataClone;
+    _ = try page.session.navigation.pushEntry(url, json, page);
 }
 
 pub fn _replaceState(_: *const History, state: js.Object, _: ?[]const u8, _url: ?[]const u8, page: *Page) !void {
@@ -113,7 +115,7 @@ pub fn go(_: *const History, delta: i32, page: *Page) !void {
         }
     }
 
-    _ = try entry.navigate(page, .force);
+    _ = try page.session.navigation.navigate(entry.url, .{ .traverse = index }, page);
 }
 
 pub fn _go(self: *History, _delta: ?i32, page: *Page) !void {

src/browser/html/Navigation.zig

@@ -34,16 +34,24 @@ const Navigation = @This();
 pub const Interfaces = .{
     Navigation,
     NavigationActivation,
+    NavigationTransition,
     NavigationHistoryEntry,
 };
 
+pub const NavigationKind = union(enum) {
+    initial,
+    push: ?[]const u8,
+    replace,
+    traverse: usize,
+    reload,
+};
+
 pub const prototype = *EventTarget;
 base: parser.EventTargetTBase = parser.EventTargetTBase{ .internal_target_type = .plain },
 
 index: usize = 0,
 entries: std.ArrayListUnmanaged(NavigationHistoryEntry) = .empty,
 next_entry_id: usize = 0,
-// TODO: key->index mapping
 
 // https://developer.mozilla.org/en-US/docs/Web/API/NavigationHistoryEntry
 const NavigationHistoryEntry = struct {
@@ -91,49 +99,17 @@ const NavigationHistoryEntry = struct {
             return null;
         }
     }
-
-    pub fn navigate(entry: NavigationHistoryEntry, reload: enum { none, force }, page: *Page) !NavigationReturn {
-        const arena = page.session.arena;
-        const url = entry.url orelse return error.MissingURL;
-
-        // https://github.com/WICG/navigation-api/issues/95
-        //
-        // These will only settle on same-origin navigation (mostly intended for SPAs).
-        // It is fine (and expected) for these to not settle on cross-origin requests :)
-        const committed = try page.js.createPromiseResolver(.page);
-        const finished = try page.js.createPromiseResolver(.page);
-
-        const new_url = try URL.parse(url, null);
-        if (try page.url.eqlDocument(&new_url, arena) or reload == .force) {
-            page.url = new_url;
-            try committed.resolve({});
-
-            // todo: Fire navigate event
-
-            try finished.resolve({});
-        } else {
-            // TODO: Change to history
-            try page.navigateFromWebAPI(url, .{ .reason = .history });
-        }
-
-        return .{
-            .committed = committed.promise(),
-            .finished = finished.promise(),
-        };
-    }
 };
 
 // https://developer.mozilla.org/en-US/docs/Web/API/NavigationActivation
 const NavigationActivation = struct {
     const NavigationActivationType = enum {
+        pub const ENUM_JS_USE_TAG = true;
+
         push,
         reload,
         replace,
         traverse,
-
-        pub fn toString(self: NavigationActivationType) []const u8 {
-            return @tagName(self);
-        }
     };
 
     entry: NavigationHistoryEntry,
@@ -153,6 +129,13 @@ const NavigationActivation = struct {
     }
 };
 
+// https://developer.mozilla.org/en-US/docs/Web/API/NavigationTransition
+const NavigationTransition = struct {
+    finished: js.Promise,
+    from: NavigationHistoryEntry,
+    navigation_type: NavigationActivation.NavigationActivationType,
+};
+
 pub fn get_canGoBack(self: *const Navigation) bool {
     return self.index > 0;
 }
@@ -169,6 +152,11 @@ pub fn get_currentEntry(self: *const Navigation) NavigationHistoryEntry {
     return self.entries.items[self.index];
 }
 
+pub fn get_transition(_: *const Navigation) ?NavigationTransition {
+    // For now, all transitions are just considered complete.
+    return null;
+}
+
 const NavigationReturn = struct {
     committed: js.Promise,
     finished: js.Promise,
@@ -183,7 +171,7 @@ pub fn _back(self: *Navigation, page: *Page) !NavigationReturn {
     const next_entry = self.entries.items[new_index];
     self.index = new_index;
 
-    return next_entry.navigate(.none, page);
+    return self.navigate(next_entry.url, .{ .traverse = new_index }, page);
 }
 
 pub fn _entries(self: *const Navigation) []NavigationHistoryEntry {
@@ -199,15 +187,33 @@ pub fn _forward(self: *Navigation, page: *Page) !NavigationReturn {
     const next_entry = self.entries.items[new_index];
     self.index = new_index;
 
-    return next_entry.navigate(.none, page);
+    return self.navigate(next_entry.url, .{ .traverse = new_index }, page);
+}
+
+// This is for after true navigation processing, where we need to ensure that our entries are up to date.
+pub fn processNavigation(self: *Navigation, url: []const u8, kind: NavigationKind, page: *Page) !void {
+    switch (kind) {
+        .initial => {
+            _ = try self.pushEntry(url, null, page);
+        },
+        .replace => {
+            // When replacing, we just update the URL but the state is nullified.
+            const entry = self.currentEntry();
+            entry.url = url;
+            entry.state = null;
+        },
+        .push => |state| {
+            _ = try self.pushEntry(url, state, page);
+        },
+        .traverse, .reload => {},
+    }
 }
 
 /// Pushes an entry into the Navigation stack WITHOUT actually navigating to it.
 /// For that, use `navigate`.
-pub fn pushEntry(self: *Navigation, _url: ?[]const u8, _opts: ?NavigateOptions, page: *Page) !NavigationHistoryEntry {
+pub fn pushEntry(self: *Navigation, _url: ?[]const u8, state: ?[]const u8, page: *Page) !NavigationHistoryEntry {
     const arena = page.session.arena;
 
-    const options = _opts orelse NavigateOptions{};
     const url = if (_url) |u| try arena.dupe(u8, u) else null;
 
     // truncates our history here.
@@ -221,14 +227,6 @@ pub fn pushEntry(self: *Navigation, _url: ?[]const u8, _opts: ?NavigateOptions,
 
     const id_str = try std.fmt.allocPrint(arena, "{d}", .{id});
 
-    const state: ?[]const u8 = blk: {
-        if (options.state) |s| {
-            break :blk s.toJson(arena) catch return error.DataClone;
-        } else {
-            break :blk null;
-        }
-    };
-
     const entry = NavigationHistoryEntry{
         .id = id_str,
         .key = id_str,
@@ -237,7 +235,6 @@ pub fn pushEntry(self: *Navigation, _url: ?[]const u8, _opts: ?NavigateOptions,
     };
 
     try self.entries.append(arena, entry);
-
     return entry;
 }
 
@@ -255,9 +252,67 @@ const NavigateOptions = struct {
     history: NavigateOptionsHistory = .auto,
 };
 
+pub fn navigate(
+    self: *Navigation,
+    _url: ?[]const u8,
+    kind: NavigationKind,
+    page: *Page,
+) !NavigationReturn {
+    const arena = page.session.arena;
+    const url = _url orelse return error.MissingURL;
+
+    // https://github.com/WICG/navigation-api/issues/95
+    //
+    // These will only settle on same-origin navigation (mostly intended for SPAs).
+    // It is fine (and expected) for these to not settle on cross-origin requests :)
+    const committed = try page.js.createPromiseResolver(.page);
+    const finished = try page.js.createPromiseResolver(.page);
+
+    const new_url = try URL.parse(url, null);
+    const is_same_document = try page.url.eqlDocument(&new_url, arena);
+
+    switch (kind) {
+        .push => |state| {
+            if (is_same_document) {
+                page.url = new_url;
+                try committed.resolve({});
+                // todo: Fire navigate event
+                try finished.resolve({});
+
+                _ = try self.pushEntry(url, state, page);
+            } else {
+                try page.navigateFromWebAPI(url, .{ .reason = .navigation }, kind);
+            }
+        },
+        .traverse => |index| {
+            self.index = index;
+
+            if (is_same_document) {
+                page.url = new_url;
+
+                try committed.resolve({});
+                // todo: Fire navigate event
+                try finished.resolve({});
+            } else {
+                try page.navigateFromWebAPI(url, .{ .reason = .navigation }, kind);
+            }
+        },
+        .reload => {
+            try page.navigateFromWebAPI(url, .{ .reason = .navigation }, kind);
+        },
+        else => unreachable,
+    }
+
+    return .{
+        .committed = committed.promise(),
+        .finished = finished.promise(),
+    };
+}
+
 pub fn _navigate(self: *Navigation, _url: []const u8, _opts: ?NavigateOptions, page: *Page) !NavigationReturn {
-    const entry = try self.pushEntry(_url, _opts, page);
-    return entry.navigate(.none, page);
+    const opts = _opts orelse NavigateOptions{};
+    const json = if (opts.state) |state| state.toJson(page.session.arena) catch return error.DataClone else null;
+    return try self.navigate(_url, .{ .push = json }, page);
 }
 
 pub const ReloadOptions = struct {
@@ -274,15 +329,23 @@ pub fn _reload(self: *Navigation, _opts: ?ReloadOptions, page: *Page) !Navigatio
         entry.state = state.toJson(arena) catch return error.DataClone;
     }
 
-    return entry.navigate(.force, page);
+    return self.navigate(entry.url, .reload, page);
 }
 
-pub fn _transition(_: *const Navigation) !NavigationReturn {
-    unreachable;
-}
+pub const TraverseToOptions = struct {
+    info: ?js.Object = null,
+};
+
+pub fn _traverseTo(self: *Navigation, key: []const u8, _: ?TraverseToOptions, page: *Page) !NavigationReturn {
+    // const opts = _opts orelse TraverseToOptions{};
+
+    for (self.entries.items, 0..) |entry, i| {
+        if (std.mem.eql(u8, key, entry.key)) {
+            return try self.navigate(entry.url, .{ .traverse = i }, page);
+        }
+    }
 
-pub fn _traverseTo(_: *const Navigation, _: []const u8) !NavigationReturn {
-    unreachable;
+    return error.InvalidStateError;
 }
 
 pub const UpdateCurrentEntryOptions = struct {

src/browser/html/document.zig

@@ -195,7 +195,7 @@ pub const HTMLDocument = struct {
     }
 
     pub fn set_location(_: *const parser.DocumentHTML, url: []const u8, page: *Page) !void {
-        return page.navigateFromWebAPI(url, .{ .reason = .script });
+        return page.navigateFromWebAPI(url, .{ .reason = .script }, .{ .push = null });
     }
 
     pub fn get_designMode(_: *parser.DocumentHTML) []const u8 {

src/browser/html/location.zig

@@ -70,15 +70,15 @@ pub const Location = struct {
     }
 
     pub fn _assign(_: *const Location, url: []const u8, page: *Page) !void {
-        return page.navigateFromWebAPI(url, .{ .reason = .script });
+        return page.navigateFromWebAPI(url, .{ .reason = .script }, .{ .push = null });
     }
 
     pub fn _replace(_: *const Location, url: []const u8, page: *Page) !void {
-        return page.navigateFromWebAPI(url, .{ .reason = .script });
+        return page.navigateFromWebAPI(url, .{ .reason = .script }, .replace);
     }
 
     pub fn _reload(_: *const Location, page: *Page) !void {
-        return page.navigateFromWebAPI(page.url.raw, .{ .reason = .script });
+        return page.navigateFromWebAPI(page.url.raw, .{ .reason = .script }, .reload);
     }
 
     pub fn _toString(self: *Location, page: *Page) ![]const u8 {

src/browser/html/window.zig

@@ -150,7 +150,7 @@ pub const Window = struct {
     }
 
     pub fn set_location(_: *const Window, url: []const u8, page: *Page) !void {
-        return page.navigateFromWebAPI(url, .{ .reason = .script });
+        return page.navigateFromWebAPI(url, .{ .reason = .script }, .{ .push = null });
     }
 
     pub fn get_console(self: *Window) *Console {