2009916 - network.getData can timeout for redirects

Status: RESOLVED FIXED

(Remote Protocol :: WebDriver BiDi, defect, P2)

Description

[Julian Descottes [:jdescottes]]

Found this issue while investigating https://github.com/firefox-devtools/bidi-har-export/issues/43

The network.getData command is likely to time out for redirected responses if the command is received by the browser before the responseStarted trigger for the redirect has been handled.

The sequence of events for redirects looks as follows:

• beforeRequestSent for original
• responseStarted for original -> creates the collectedData map entry for request id
• responseCompleted for original
• beforeRequestSent for redirect
• responseStarted for redirect -> overrides the collectedData map entry for the same request id
• responseCompleted for redirect

Since both requests share the same request id, we don't attempt to collect the network body for the original response. However we should not blindly override the existing map entry when we receive the events for the redirected response, because existing getData commands might already by waiting on those.

We should check for the existence of the entry in https://searchfox.org/firefox-main/rev/6ece603789f6751c37c48b23f39dbbb16b290592/remote/webdriver-bidi/modules/root/network.sys.mjs#1922,1947-1951,1953,1977-1981

#cloneNetworkRequestBody(request) {
...
  this.#collectedNetworkData.set(
    `${request.requestId}-${DataType.Request}`,
    collectedData
  );
}
...
#cloneNetworkResponseBody(request) {
...
  this.#collectedNetworkData.set(
    `${request.requestId}-${DataType.Response}`,
    collectedData
  );
}

Comment 1

[Julian Descottes [:jdescottes]]

Let's wait for next milestone in case we have other items for network to work on during m20.

Comment 2

[Julian Descottes [:jdescottes]]

Attachment: Bug 2009916 - [bidi] Do not erase collected body for redirects

Comment 3

[Julian Descottes [:jdescottes]]

Attachment: Bug 2009916 - [wdspec] Add test for network.getData for redirected requests

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/af42c4c48c05
https://hg.mozilla.org/integration/autoland/rev/19679034eae9
[bidi] Do not erase collected body for redirects r=whimboo
https://github.com/mozilla-firefox/firefox/commit/56e6026303e5
https://hg.mozilla.org/integration/autoland/rev/ef38c2ccd4fe
[wdspec] Add test for network.getData for redirected requests r=whimboo

Comment 5

[amarc]

https://hg.mozilla.org/mozilla-central/rev/19679034eae9
https://hg.mozilla.org/mozilla-central/rev/ef38c2ccd4fe

Comment 6

[Web Platform Test Sync Bot [:wpt-sync] (Matrix: #interop:mozilla.org)]

Created web-platform-tests PR https://github.com/web-platform-tests/wpt/pull/59229 for changes under testing/web-platform/tests

Comment 7

[Web Platform Test Sync Bot [:wpt-sync] (Matrix: #interop:mozilla.org)]

Upstream PR merged by moz-wptsync-bot