From a808110c27e33e08936bbba924572fd37e4654d3 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 | 47 ++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 44 insertions(+), 3 deletions(-)

diff --git a/fetch.bs b/fetch.bs
index 58579420d..7a33e7e76 100644
--- a/fetch.bs
+++ b/fetch.bs
@@ -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]]
+
 <p>A <a for=/>request</a> has an associated boolean <dfn export for=request>render-blocking</dfn>.
 Unless stated otherwise, it is false.
 
@@ -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>
@@ -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
@@ -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>
@@ -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 -->
+
      <li>
       <p>If one of the following is true
 
@@ -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>
@@ -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>.
 
@@ -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>
@@ -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>