[Technical review] BiDi - Add pages for navigation commands of browsingContext module by dipikabh · Pull Request #44377 · mdn/content

dipikabh · 2026-06-08T01:09:27Z

Description

This PR adds pages for navigation commands:

browsingContext.navigate
browsingContext.reload
browsingContext.traverseHistory

Spec links

Related issue

Doc issue: mdn/mdn#339

github-actions · 2026-06-08T01:11:09Z

Preview URLs (4 pages)

Flaws (24)

Found an unexpected or unresolvable flaw? Please report it here.

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/close
Title: browsingContext.close command
Flaw count: 4

broken_links:
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/contextDestroyed doesn't resolve

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigate
Title: browsingContext.navigate command
Flaw count: 7

broken_links:
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigationStarted doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigationAborted doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigationCommitted doesn't resolve
- and 2 more flaws omitted

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/reload
Title: browsingContext.reload command
Flaw count: 7

broken_links:
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigationStarted doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigationAborted doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigationCommitted doesn't resolve
- and 2 more flaws omitted

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/traverseHistory
Title: browsingContext.traverseHistory command
Flaw count: 6

broken_links:
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/getTree doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigationAborted doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigationCommitted doesn't resolve
- Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/browsingContext/navigationFailed doesn't resolve
- and 1 more flaws omitted

dipikabh · 2026-06-08T01:13:10Z

+
+The `result` object in the response contains the following fields:
+
+- `navigation`


The CDDL in the spec for navigation in the "Return Type" is:

navigation: browsingContext.Navigation / null

But from the code it seems it is never null. Is the spec in need of an update?

Looks like you are right. Feel free to file a new issue on the BiDi repository. Thanks.

dipikabh · 2026-06-08T01:13:51Z

+The `result` object in the response contains the following fields:
+
+- `navigation`
+  - : A string that contains the ID ([UUID](/en-US/docs/Glossary/UUID)) that uniquely identifies this navigation. A new UUID is generated for each `browsingContext.navigate` command.


As per the code, this is always a UUID. Is that correct?

Yes, that is correct.

dipikabh · 2026-06-08T01:14:33Z

+
+### Return value
+
+The `result` field in the response is an empty object (`{}`). The command returns once the traversal has been queued, before the resulting navigation is complete.


Is this the correct current behavior?

Yes, but there is a TODO to wait for the traversal to be complete. Maybe for now lets add a reference to the browsingContext.historyUpdated event, which informs about when the history update is done.

dipikabh · 2026-06-08T01:18:29Z

  - : A boolean that indicates whether the browser runs [`beforeunload`](/en-US/docs/Web/API/Window/beforeunload_event) event handlers before closing the context.
-    The default value is `false`.
-    - `false`: The specified context closes immediately without running `beforeunload` event handlers.
+    - `false`: The specified context closes immediately without running `beforeunload` event handlers. This is the default.


minor style update to make it similar to boolean value descriptions in browsingContext.reload

whimboo

Thank you @dipikabh! Overall this looks pretty good. Just some minor comments inline (including the responses to your questions).

whimboo · 2026-06-09T13:01:30Z

+    - `"interactive"`
+      - : The command returns when the document has been parsed and is ready for interaction.
+        Use this value when you need the DOM to be available but don't need images or other subresources to finish loading.
+    - `"none"`


We should mention that this is the default behavior if the parameter is not specified.

whimboo · 2026-06-09T13:07:31Z

+
+The `result` object in the response contains the following fields:
+
+- `navigation`


Looks like you are right. Feel free to file a new issue on the BiDi repository. Thanks.

whimboo · 2026-06-09T13:07:55Z

+The `result` object in the response contains the following fields:
+
+- `navigation`
+  - : A string that contains the ID ([UUID](/en-US/docs/Glossary/UUID)) that uniquely identifies this navigation. A new UUID is generated for each `browsingContext.navigate` command.


Yes, that is correct.

whimboo · 2026-06-09T13:08:54Z

+    - `"interactive"`
+      - : The command returns when the document has been parsed and is ready for interaction.
+        Use this value when you need the DOM to be available but don't need images or other subresources to finish loading.
+    - `"none"`


Same comment as for navigate.

whimboo · 2026-06-09T13:14:50Z

+
+### Return value
+
+The `result` field in the response is an empty object (`{}`). The command returns once the traversal has been queued, before the resulting navigation is complete.


Yes, but there is a TODO to wait for the traversal to be complete. Maybe for now lets add a reference to the browsingContext.historyUpdated event, which informs about when the history update is done.

github-actions · 2026-06-09T19:48:15Z

This pull request has merge conflicts that must be resolved before it can be merged.

adds nav commands

4fdf8c0

dipikabh requested a review from a team June 8, 2026 01:09

dipikabh requested review from a team as code owners June 8, 2026 01:09

dipikabh requested review from hamishwillee and pepelsbey and removed request for a team June 8, 2026 01:09

github-actions Bot added the Content:WebDriver WebDriver docs label Jun 8, 2026

dipikabh removed request for hamishwillee and pepelsbey June 8, 2026 01:09

github-actions Bot added the size/m [PR only] 51-500 LoC changed label Jun 8, 2026

dipikabh commented Jun 8, 2026

View reviewed changes

whimboo requested changes Jun 9, 2026

View reviewed changes

github-actions Bot added the merge conflicts 🚧 [PR only] label Jun 9, 2026


		The `result` object in the response contains the following fields:

		- `navigation`


		### Return value

		The `result` field in the response is an empty object (`{}`). The command returns once the traversal has been queued, before the resulting navigation is complete.

Conversation

dipikabh commented Jun 8, 2026

Description

Spec links

Related issue

Uh oh!

github-actions Bot commented Jun 8, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

whimboo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants