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.

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

Add WebDriver BiDi network request logging #1540

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
47 changes: 44 additions & 3 deletions fetch.bs
Original file line number Diff line number Diff line change
Expand Up @@ -2157,6 +2157,11 @@ Unless stated otherwise, it is false.

<p class=note>This is for exclusive use by HTML's navigate algorithm. [[!HTML]]

<p>A <a for=/>request</a> has an associated <dfn export for=request>WebDriver navigation id</dfn>
(null or a string). Unless stated otherwise, it is null.

<p class=note>This is for exclusive use by HTML's navigate algorithm. [[!HTML]]
Copy link
Member

Choose a reason for hiding this comment

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

What do you think about calling these fields "WebDriver navigation id" and "WebDriver id"? If we ever make them more generic we can rename them and the way WebDriver consumes them can just be as ID, but at least that would discourage others from using them for purposes they're not intended for without additional review.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't really have a strong opinion so I changed them.


<p>A <a for=/>request</a> has an associated boolean <dfn export for=request>render-blocking</dfn>.
Unless stated otherwise, it is false.

Expand Down Expand Up @@ -2198,6 +2203,15 @@ otherwise, it is unset.
<a for=request>done flag</a>, and <a for=request>timing allow failed flag</a> are used as
bookkeeping details by the <a for=/>fetch</a> algorithm.

<p>A <a for=/>request</a> has an associated
<dfn export for=request id=concept-webdriver-id>WebDriver id</dfn>
which is a unique string automatically set when the <a for=/>request</a> is created.

<p class=note>The [=request/WebDriver id=] is used by WebDriver-BiDi. It remains constant
across all requests resulting from a redirect of an initial request. When a
request is [=request/cloned=], the created request gets a unique
[=request/WebDriver id=]. [[!WEBDRIVER-BIDI]]

<hr>

<p>A <dfn export>subresource request</dfn> is a <a for=/>request</a>
Expand Down Expand Up @@ -2274,7 +2288,9 @@ is to return the result of <a>serializing a request origin</a> with <var>request

<ol>
<li><p>Let <var>newRequest</var> be a copy of <var>request</var>, except for its
<a for=request>body</a>.
<a for=request>body</a> and <a for=request>WebDriver id</a>.

<li><p>Set <var>newRequest</var>'s <a for=request>WebDriver id</a> to a new unique string.

<li><p>If <var>request</var>'s <a for=request>body</a> is non-null, set <var>newRequest</var>'s
<a for=request>body</a> to the result of <a lt=clone for=body>cloning</a> <var>request</var>'s
Expand Down Expand Up @@ -4824,6 +4840,11 @@ steps:
<a for=request>URL</a>, <var>fetchParams</var>'s <a for="fetch params">request</a>'s
<a for=request>initiator type</a>, <var>global</var>, <var>cacheState</var>,
<var>bodyInfo</var>, and <var>responseStatus</var>.

<li><p>If <var>response</var> is a <a>network error</a>, run
the <a>WebDriver BiDi fetch error</a> steps with <var>request</var>. Otherwise
run the <a>WebDriver BiDi response completed</a> steps with
<var>request</var> and <var>response</var>.
</ol>

<li>
Expand Down Expand Up @@ -5165,6 +5186,13 @@ these steps:
<a>filtered response</a>; otherwise to <var>response</var>'s
<a for="filtered response">internal response</a>.

<li><p>Run the [=WebDriver BiDi response started=] steps with
<var>request</var> and <var>response</var>.
<!-- Service Workers is responsible for emmitting the WebDriver BiDi
request events in this case. That's necessary to ensure that the events are
only generated if the service worker will handle the fetch, and to get the
correct event ordering in the case of network fallback -->
jgraham marked this conversation as resolved.
Show resolved Hide resolved

<li>
<p>If one of the following is true

Expand Down Expand Up @@ -5292,8 +5320,12 @@ these steps:

<dt>"<code>follow</code>"
<dd>
<ol><li><p>Set <var>response</var> to the result of running <a>HTTP-redirect fetch</a> given
<var>fetchParams</var> and <var>response</var>.</ol>
<ol>
<li>Run the <a>WebDriver BiDi response completed</a> steps with <var>request</var> and
<var>response</var>.
<li><p>Set <var>response</var> to the result of running <a>HTTP-redirect fetch</a> given
<var>fetchParams</var> and <var>response</var>.
</ol>
</dl>
<!-- not resetting internalResponse since it's no longer used anyway -->
</ol>
Expand Down Expand Up @@ -5699,6 +5731,10 @@ run these steps:
<p class=note>This intentionally does not depend on <var>httpRequest</var>'s
<a for=request>credentials mode</a>.

<!-- After this point the request is not further modified before being either
retrieved from the cache or sent -->
<li><p>Run the <a>WebDriver BiDi before request sent</a> steps with <var>request</var>.

<li><p>Set <var>httpCache</var> to the result of <a>determining the HTTP cache partition</a>,
given <var>httpRequest</var>.

Expand Down Expand Up @@ -5794,6 +5830,8 @@ run these steps:
<li><p><a>If aborted</a>, then return the <a for=/>appropriate network error</a> for
<var>fetchParams</var>.

<li><p>If <var>response</var> is not null, run the <a>WebDriver BiDi response
started</a> steps with <var>request</var> and <var>response</var>.

<!-- If response is still null, we require a forwarded request. -->
<li>
Expand Down Expand Up @@ -6057,6 +6095,9 @@ optional boolean <var>forceNewConnection</var> (default false), run these steps:

<li><p>Wait until all the HTTP response headers are transmitted.

<li><p>Run the [=WebDriver BiDi response started=] steps with
|request| and |response|.

<li><p>Let <var>status</var> be the HTTP response's status code.

<li>
Expand Down