Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: emit browsingContext.navigationCommitted event #3057

Merged
merged 3 commits into from
Jan 31, 2025
Merged

feat: emit browsingContext.navigationCommitted event #3057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1569905
feat: emit `browsingContext.navigationCommitted`
sadym-chromium Jan 31, 2025
8526917
add tests
sadym-chromium Jan 31, 2025
a0378ee
fix tests
sadym-chromium Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/bidiMapper/modules/context/NavigationTracker.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,12 @@ describe('NavigationTracker', () => {

navigationTracker.frameNavigated(YET_ANOTHER_URL, LOADER_ID);

assertNoNavigationEvents();
assertNavigationEvent(
ChromiumBidi.BrowsingContext.EventNames.NavigationCommitted,
sinon.match.any,
YET_ANOTHER_URL,
);

assert.equal(navigationTracker.url, YET_ANOTHER_URL);

navigationTracker.loadPageEvent(LOADER_ID);
Expand Down
14 changes: 12 additions & 2 deletions src/bidiMapper/modules/context/NavigationTracker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,16 @@ export class NavigationState {

frameNavigated() {
this.#navigated = true;
if (!this.#isInitial) {
this.#eventManager.registerEvent(
{
type: 'event',
method: ChromiumBidi.BrowsingContext.EventNames.NavigationCommitted,
params: this.navigationInfo(),
},
this.#browsingContextId,
);
}
}

fragmentNavigated() {
Expand Down Expand Up @@ -257,7 +267,7 @@ export class NavigationTracker {

if (
this.#pendingNavigation !== undefined &&
this.#pendingNavigation?.loaderId === undefined
this.#pendingNavigation.loaderId === undefined
) {
// This can be a pending navigation to `about:blank` created by a command. Use the
// pending navigation in this case.
Expand Down Expand Up @@ -289,7 +299,6 @@ export class NavigationTracker {
}

const navigation = this.#getNavigationForFrameNavigated(url, loaderId);
navigation.frameNavigated();

if (navigation !== this.#currentNavigation) {
this.#currentNavigation.fail(
Expand All @@ -301,6 +310,7 @@ export class NavigationTracker {
navigation.loaderId = loaderId;
this.#loaderIdToNavigationsMap.set(loaderId, navigation);
navigation.start();
navigation.frameNavigated();

this.#currentNavigation = navigation;
if (this.#pendingNavigation === navigation) {
Expand Down
212 changes: 212 additions & 0 deletions tests/browsing_context/__snapshots__/test_navigate_events.ambr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
Expand Down Expand Up @@ -88,6 +97,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
Expand Down Expand Up @@ -152,6 +170,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
Expand Down Expand Up @@ -242,6 +269,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_6',
'url': 'stable_7',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
Expand Down Expand Up @@ -295,6 +331,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
Expand Down Expand Up @@ -359,6 +404,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
Expand Down Expand Up @@ -423,6 +477,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
Expand Down Expand Up @@ -493,6 +556,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationStarted',
'params': dict({
Expand All @@ -511,6 +583,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_3',
'url': 'stable_4',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
Expand Down Expand Up @@ -542,6 +623,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
Expand Down Expand Up @@ -573,6 +663,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.fragmentNavigated',
'params': dict({
Expand Down Expand Up @@ -613,6 +712,15 @@
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_1',
'url': 'stable_2',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.fragmentNavigated',
'params': dict({
Expand Down Expand Up @@ -642,3 +750,107 @@
}),
])
# ---
# name: test_window_open_aboutBlank_checkEvents[]
list([
dict({
'method': 'browsingContext.contextCreated',
'params': dict({
'children': None,
'clientWindow': '',
'context': 'stable_0',
'originalOpener': 'stable_2',
'parent': None,
'url': 'stable_1',
'userContext': 'default',
}),
'type': 'event',
}),
])
# ---
# name: test_window_open_aboutBlank_checkEvents[about:blank?test]
list([
dict({
'method': 'browsingContext.contextCreated',
'params': dict({
'children': None,
'clientWindow': '',
'context': 'stable_0',
'originalOpener': 'stable_2',
'parent': None,
'url': 'stable_1',
'userContext': 'default',
}),
'type': 'event',
}),
])
# ---
# name: test_window_open_aboutBlank_checkEvents[about:blank]
list([
dict({
'method': 'browsingContext.contextCreated',
'params': dict({
'children': None,
'clientWindow': '',
'context': 'stable_0',
'originalOpener': 'stable_2',
'parent': None,
'url': 'stable_1',
'userContext': 'default',
}),
'type': 'event',
}),
])
# ---
# name: test_window_open_url_checkEvents
list([
dict({
'method': 'browsingContext.contextCreated',
'params': dict({
'children': None,
'clientWindow': '',
'context': 'stable_0',
'originalOpener': 'stable_2',
'parent': None,
'url': 'stable_1',
'userContext': 'default',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationStarted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_3',
'url': 'stable_4',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.navigationCommitted',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_3',
'url': 'stable_4',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.domContentLoaded',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_3',
'url': 'stable_4',
}),
'type': 'event',
}),
dict({
'method': 'browsingContext.load',
'params': dict({
'context': 'stable_0',
'navigation': 'stable_3',
'url': 'stable_4',
}),
'type': 'event',
}),
])
# ---
11 changes: 10 additions & 1 deletion tests/browsing_context/test_create.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ async def test_browsingContext_windowOpen_nonBlank_eventsEmitted(
})

events = await read_messages(
4,
5,
# Filter out the command result, as it's order is not defined.
filter_lambda=lambda m: 'id' not in m,
keys_to_stabilize=['context', 'navigation'],
Expand Down Expand Up @@ -140,6 +140,15 @@ async def test_browsingContext_windowOpen_nonBlank_eventsEmitted(
'url': url_example,
},
'type': 'event',
}, {
'method': 'browsingContext.navigationCommitted',
'params': {
'context': 'stable_0',
'navigation': 'stable_1',
'timestamp': ANY_TIMESTAMP,
'url': url_example,
},
'type': 'event',
}, {
'method': 'browsingContext.domContentLoaded',
'params': {
Expand Down
Loading
Loading