From 7884a67892bb3792485f66b76ae035557f0e9ff7 Mon Sep 17 00:00:00 2001
From: James Graham <james@hoppipolla.co.uk>
Date: Fri, 18 Nov 2022 10:20:40 +0000
Subject: [PATCH] Add WebDriver BiDi network request logging

---
 fetch.bs | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/fetch.bs b/fetch.bs
index 92f706325..5800b0b20 100644
--- a/fetch.bs
+++ b/fetch.bs
@@ -2083,6 +2083,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>navigation id</dfn>.
+Unless stated otherwise, it is null.
+
+<p class=note>This is for exclusive use by HTML's navigate algorithm. [[!HTML]]
+
 <p>A <a for=/>request</a> has an associated boolean <dfn export for=request>render-blocking</dfn>.
 Unless stated otherwise, it is false.
 
@@ -2124,6 +2129,13 @@ 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-request-id>request id</dfn> which is a unique
+string automatically set when the <a for=/>request</a> is created.
+
+Note: the [=request id=] is used by WebDriver-BiDi. When a request is [=cloned=],
+the created request gets a unique [=request id=]. [[!WEBDRIVER-BIDI]]
+
 <hr>
 
 <p>A <dfn export>subresource request</dfn> is a <a for=/>request</a>
@@ -4684,6 +4696,11 @@ steps:
      <a for=request>URL</a>, <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>
@@ -4934,6 +4951,13 @@ these steps:
      <a>filtered response</a>, and to <var>response</var>'s
      <a for="filtered response">internal response</a> otherwise.
 
+     <!-- the serviceworker spec 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 serviceworker will handle the fetch, and to get the
+     correct event ordering in the case of network fallback -->
+     <li><p>Run the [=WebDriver BiDi response started=] steps with
+     <var>request</var> and <var>response</var>.
+
      <li>
       <p>If one of the following is true
 
@@ -5338,6 +5362,10 @@ run these steps:
    <a for="header list">append</a> (`<code>Cache-Control</code>`, `<code>max-age=0</code>`) to
    <var>httpRequest</var>'s <a for=request>header list</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 <a>request</a>.
+
    <li>
     <p>If <var>httpRequest</var>'s <a for=request>cache mode</a> is "<code>no-store</code>" or
     "<code>reload</code>", then:
@@ -5540,6 +5568,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>
@@ -5803,6 +5833,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>