Skip to content

[Editorial review] Add BiDi network request lifecycle event pages - #46141

Merged
pepelsbey merged 10 commits into
mdn:mainfrom
pepelsbey:bidi/network-events
Nov 20, 2026
Merged

pepelsbey merged 10 commits into
mdn:mainfrom
pepelsbey:bidi/network-events

Conversation

@pepelsbey

@pepelsbey pepelsbey commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

Description

  • Added pages for the following events of the network module:
    • network.beforeRequestSent
    • network.fetchError
    • network.responseCompleted
    • network.responseStarted
  • Added a "Requests" section to the network module landing page.

Every example was run against Firefox Nightly 159 and Chrome 155 (through ChromeDriver) with a local server.

Spec links

Related issue

Doc issue: mdn/mdn#851

Compat quirks worth looking into:

Firefox

  • Outdated compat data. BCD and the implementation sheet mark Firefox's errorText on fetchError as unsupported, but Nightly 159 sends it (NS_ERROR_UNKNOWN_HOST, NS_BINDING_ABORTED).

/cc @whimboo for the compat sheet update.

Chrome

  • Outdated compat data. BCD and the implementation sheet mark Chrome's userContext as unsupported, but Chrome 155 sends "default".

/cc @sadym-chromium for the compat sheet update.

@pepelsbey
pepelsbey requested review from a team as code owners October 14, 2026 12:10
@pepelsbey
pepelsbey requested review from chrisdavidmills and dipikabh and removed request for a team October 14, 2026 12:10
@github-actions github-actions Bot added Content:WebDriver WebDriver docs size/xl [PR only] >1000 LoC changed labels Oct 14, 2026
@github-actions

github-actions Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Preview URLs (5 pages)

Flaws (18)

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

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network
Title: network module
Flaw count: 3

  • broken_links:
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/authRequired doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/addIntercept doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/continueRequest doesn't resolve

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/beforeRequestSent
Title: network.beforeRequestSent event
Flaw count: 6

  • broken_links:
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/addIntercept doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/continueRequest doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/continueRequest doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/failRequest doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/provideResponse doesn't resolve
    • and 1 more flaws omitted

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/fetchError
Title: network.fetchError event
Flaw count: 1

  • broken_links:
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/authRequired doesn't resolve

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/responseCompleted
Title: network.responseCompleted event
Flaw count: 1

  • broken_links:
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/authRequired doesn't resolve

URL: /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/responseStarted
Title: network.responseStarted event
Flaw count: 7

  • broken_links:
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/addIntercept doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/continueResponse doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/authRequired doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/continueResponse doesn't resolve
    • Link /en-US/docs/Web/WebDriver/Reference/BiDi/Modules/network/failRequest doesn't resolve
    • and 2 more flaws omitted

(comment last updated: 2026-11-20 12:33:19)

@dipikabh
dipikabh removed the request for review from chrisdavidmills October 14, 2026 12:53
@pepelsbey
pepelsbey force-pushed the bidi/network-events branch from 1d84f82 to c773441 Compare October 15, 2026 13:49

@juliandescottes juliandescottes left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Vadim! Really nice to see those events being documented after spending so much time on the implementation.

Having the events lifecycle written down will be extremely helpful. I have a few comments so I'll send it back to you to take a look. I will try to re-review it faster.

(Sorry for the delay with those)

@juliandescottes juliandescottes left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(and I forgot to request changes here, sorry)

@juliandescottes juliandescottes left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates, all my comments are addressed. Approving. One nit: in the fetch() example, the spec always sets top-level lineNumber/columnNumber on initiator, so you could add them to match the text below the example.

Also for the cookie size: the spec text says byte length of name=value, but browsers and wpt use name + value length, as in your example. That's a spec/test mismatch, so no change is needed here. I will file a spec issue for this. At the moment your doc matches the implementation, in case the spec issue results in updating the implementations (which I doubt) we would have to update this, but no reason to block for now.

@OrKoN

OrKoN commented Nov 3, 2026

Copy link
Copy Markdown

Please loop in @sadym-chromium for compat sheet updates.

@pepelsbey

Copy link
Copy Markdown
Member Author

One nit: in the fetch() example, the spec always sets top-level lineNumber/columnNumber on initiator, so you could add them to match the text below the example.

Thanks! I added the top-level lineNumber and columnNumber to the fetch() example. Neither browser sent them in my test run (Firefox sent no stack trace, and Chrome sent one without them), so I took the values from the first stack frame, as the spec does.

@pepelsbey pepelsbey changed the title [Technical review] Add BiDi network request lifecycle event pages [Editorial review] Add BiDi network request lifecycle event pages Nov 5, 2026
@pepelsbey

Copy link
Copy Markdown
Member Author

@dipikabh ready for your review!

@github-actions github-actions Bot added the merge conflicts 🚧 [PR only] label Nov 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor

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

* upstream/main: (204 commits)
  [Editorial review] Add BiDi `network.setCacheBehavior` and `network.setExtraHeaders` pages (mdn#46140)
  build(deps-dev): bump @mdn/fred from 2.10.1 to 2.11.0 (mdn#46474)
  Reorder sections on HTML attribute pages (mdn#46483)
  Reorder sections on HTML element pages (mdn#46484)
  Fix live sample code block order in web API pages (mdn#46452)
  Move SVG attribute usage notes after examples (mdn#46458)
  Move SVG attribute elements section before examples (mdn#46459)
  Fix SuppressedError nesting in the `using` error handling example (mdn#46479)
  Editorial review: Document Web Audio render quantum size (mdn#46241)
  Remove the SVGAnimateColorElement page (mdn#46473)
  FF161 Relnote: Move WebTransport.anticipatedConcurrentIncoming{Uni|Bi}directionalStreams from 160 (mdn#46440)
  [WebExt] Screenshot updates to Nova (mdn#46270)
  build(deps-dev): bump cspell from 10.4.0 to 10.4.1 in the npm-dev group (mdn#46455)
  Update Firefox 160 release notes for WebDriver conforming changes. (mdn#46415)
  ci(deps): bump peter-evans/create-pull-request from 8.1.1 to 8.1.2 (mdn#46454)
  Move subtitles_en.vtt to shared-assets and update audio-video reference (mdn#46451)
  Yank Express Application Generator, migrate Express tutorial to ESM (mdn#45596)
  Fix heading sequence in web-api property pages (mdn#46450)
  Fix heading sequence in web-api interface pages (mdn#46448)
  Fix heading sequence in css-property pages (mdn#46447)
  ...

# Conflicts:
#	files/en-us/web/webdriver/reference/bidi/modules/network/index.md
#	files/sidebars/webdriver.yaml
@github-actions github-actions Bot removed the merge conflicts 🚧 [PR only] label Nov 12, 2026

@dipikabh dipikabh left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sending a partial review, completed a read-through of the network.beforeRequestSent page.

Some of these changes can also be carried over to shared field descriptions in other files in this PR.

@pepelsbey

Copy link
Copy Markdown
Member Author

Thanks! I applied all the suggestions on beforeRequestSent and carried the shared ones over to the other three pages.

@dipikabh dipikabh left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review for the network.responseStarted page. Some suggestions can also be applied to the shared fields in network.responseCompleted.

@dipikabh dipikabh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review for the network.responseCompleted page.

@dipikabh dipikabh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot, Vadim, for this work. This is looking in great shape!
I have one reorganization comment for the overview page.

@pepelsbey
pepelsbey merged commit 5f25f2a into mdn:main Nov 20, 2026
14 checks passed
@pepelsbey
pepelsbey deleted the bidi/network-events branch November 20, 2026 12:39
@pepelsbey

Copy link
Copy Markdown
Member Author

Thank you everyone! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:WebDriver WebDriver docs size/xl [PR only] >1000 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

⌂ 换网址