fune/testing/web-platform/tests/navigation-api/commit-behavior/resources/after-transition-commit-helpers.js
Nate Chapin c89c906507 Bug 1824039 [wpt PR 39152] - NavigationAPI: navigateEvent.commit() and { commit: 'after-transition' }, a=testonly
Automatic update from web-platform-tests
NavigationAPI: navigateEvent.commit() and { commit: 'after-transition' }

Explainer: https://github.com/WICG/navigation-api#manual-commit
I2P: https://groups.google.com/a/chromium.org/g/blink-dev/c/Aef4fm1Wn18

This introduces a new `commit` option on navigateEvent.intercept().
When `commit` is set to 'after-transition', instead of immediately committing
the navigation when the NavigateEvent finishes dispatch, we defer the
commit until navigateEvent.commit() is called or just before
navigatesuccess fires (whichever comes first).

Change-Id: Ife63c552dc89923b5e205cd6cad210dad7d222fd
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3794770
Reviewed-by: Rakina Zata Amni <rakina@chromium.org>
Reviewed-by: Will Harris <wfh@chromium.org>
Reviewed-by: Domenic Denicola <domenic@chromium.org>
Commit-Queue: Nate Chapin <japhet@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1126097}

--

wpt-commits: b4a465a4c3b1dde76fb86290b3e93d08e14de5ab
wpt-pr: 39152
2023-04-14 11:15:42 +00:00

90 lines
4.3 KiB
JavaScript

window.testAfterTransitionCommit = async (t, navigationType, mode, destinationIndex = 0) => {
let startHash = location.hash;
let destinationHash;
const err = new Error("boo!");
let popstate_fired = false;
window.addEventListener("popstate", () => popstate_fired = true, { once : true });
let navigatesuccess_fired = false;
navigation.addEventListener("navigatesuccess", () => navigatesuccess_fired = true, { once : true });
let navigateerror_fired = false;
navigation.addEventListener("navigateerror", () => navigateerror_fired = true, { once : true });
// mode-specific logic for the navigate event handler
let navigate_helpers = {
rejectBeforeCommit : async (e) => {
return Promise.reject(err);
},
rejectAfterCommit : async (e) => {
e.commit();
assert_equals(location.hash, destinationHash, "hash after commit");
assert_true(popstate_fired, "popstate fired after commit");
await new Promise(resolve => t.step_timeout(resolve, 0));
return Promise.reject(err);
},
successExplicitCommit : async (e) => {
e.commit();
assert_equals(location.hash, destinationHash, "hash after commit");
assert_true(popstate_fired, "popstate fired after commit");
return new Promise(resolve => t.step_timeout(resolve, 0));
},
successNoExplicitCommit : async (e) => {
assert_equals(location.hash, startHash, "start has after first async step");
assert_false(popstate_fired, "popstate fired after first async step");
await new Promise(resolve => t.step_timeout(resolve, 0));
assert_equals(location.hash, startHash, "start has after second async step");
assert_false(popstate_fired, "popstate fired after second async step");
return new Promise(resolve => t.step_timeout(resolve, 0));
}
}
navigation.addEventListener("navigate", e => {
e.intercept({ commit: "after-transition",
handler: t.step_func(async () => {
assert_equals(e.navigationType, navigationType);
assert_equals(location.hash, startHash, "start hash");
assert_false(popstate_fired, "popstate fired at handler start");
await new Promise(resolve => t.step_timeout(resolve, 0));
assert_equals(location.hash, startHash, "hash after first async step");
assert_false(popstate_fired, "popstate fired after first async step");
return navigate_helpers[mode](e);
})});
}, { once: true });
let promises;
if (navigationType === "push" || navigationType === "replace") {
destinationHash = (startHash === "" ? "#" : startHash) + "a";
promises = navigation.navigate(destinationHash, { history: navigationType });
} else if (navigationType === "reload") {
destinationHash = startHash;
promises = navigation.reload();
} else if (navigationType === "traverse") {
let destinationEntry = navigation.entries()[destinationIndex];
destinationHash = new URL(destinationEntry.url).hash;
promises = navigation.traverseTo(destinationEntry.key);
}
if (mode === "rejectBeforeCommit") {
await assertBothRejectExactly(t, promises, err);
assert_equals(location.hash, startHash, "hash after promise resolution");
assert_false(popstate_fired, "popstate fired after promise resolution");
assert_false(navigatesuccess_fired, "navigatesuccess fired");
assert_true(navigateerror_fired, "navigateerror fired");
} else if (mode === "rejectAfterCommit") {
await promises.committed;
await assertCommittedFulfillsFinishedRejectsExactly(t, promises, navigation.currentEntry, err);
assert_equals(location.hash, destinationHash, "hash after promise resolution");
assert_true(popstate_fired, "popstate fired after promise resolution");
assert_false(navigatesuccess_fired, "navigatesuccess fired");
assert_true(navigateerror_fired, "navigateerror fired");
} else {
await promises.committed;
await assertBothFulfill(t, promises, navigation.currentEntry);
assert_equals(location.hash, destinationHash, "hash after promise resolution");
assert_true(popstate_fired, "popstate fired after promise resolution");
assert_true(navigatesuccess_fired, "navigatesuccess fired");
assert_false(navigateerror_fired, "navigateerror fired");
}
}