emulation.setNetworkConditions

Author: sadym-chromium

index.bs

@@ -1541,6 +1541,14 @@ A [=BiDi session=] has a
 A [=BiDi session=] has a <dfn>user context to proxy configuration map</dfn>, which is
 a [=/map=] between [=user contexts=] and [=proxy configuration=].
 
+An <dfn>emulated network conditions struct</dfn> is a [=struct=] with:
+* [=struct/item=] named <dfn id="emulated-network-conditions-struct-offline"
+  for="emulated-network-conditions-struct">offline</dfn> which is a boolean or null.
+
+A [=BiDi session=] has an <dfn>emulated network conditions map</dfn>, which is a weak
+map between [=navigables=] or [=user contexts=] and
+[=emulated network conditions struct=] or null.
+
 When a [=user context=] is [=set/remove|removed=] from the
 [=set of user contexts=], [=remove user context subscriptions=].
 
@@ -5825,6 +5833,7 @@ EmulationCommand = (
   emulation.SetForcedColorsModeThemeOverride //
   emulation.SetGeolocationOverride //
   emulation.SetLocaleOverride //
+  emulation.SetNetworkConditions //
   emulation.SetScreenOrientationOverride //
   emulation.SetScriptingEnabled //
   emulation.SetTimezoneOverride //
@@ -6163,6 +6172,86 @@ The [=remote end steps=] with |command parameters| are:
 
 </div>
 
+#### The emulation.setNetworkConditions Command ####  {#command-emulation-setNetworkConditions}
+
+The <dfn export for=commands>emulation.setNetworkConditions</dfn> command
+emulates specific network conditions for the given browsing context or for a user
+context.
+
+<dl>
+   <dt>Command Type</dt>
+   <dd>
+    <pre class="cddl" data-cddl-module="remote-cddl">
+      emulation.SetNetworkConditions = (
+        method: "emulation.setNetworkConditions",
+        params: emulation.setNetworkConditionsParameters
+      )
+
+      emulation.setNetworkConditionsParameters = {
+        networkConditions: emulation.NetworkConditions / null,
+        ? contexts: [+browsingContext.BrowsingContext],
+        ? userContexts: [+browser.UserContext],
+      }
+
+      emulation.NetworkConditions = emulation.NetworkConditionsOffline
+
+      emulation.NetworkConditionsOffline = {
+        type: "offline"
+      }
+    </pre>
+   </dd>
+   <dt>Result Type</dt>
+   <dd>
+    <code>
+     EmptyResult
+    </code>
+   </dd>
+</dl>
+
+<div algorithm="remote end steps for emulation.setNetworkConditions">
+
+The [=remote end steps=] with |command parameters| are:
+
+1. If |command parameters| [=map/contains=] "<code>userContexts</code>"
+   and |command parameters| [=map/contains=] "<code>context</code>",
+   return [=error=] with [=error code=] [=invalid argument=].
+
+1. If |command parameters| doesn't [=map/contain=] "<code>userContexts</code>"
+   and |command parameters| doesn't [=map/contain=] "<code>context</code>",
+   return [=error=] with [=error code=] [=invalid argument=].
+
+1. Let |emulated network conditions| be null.
+
+1. If |command parameters|["<code>networkConditions</code>"] is not null and
+      |command parameters|["<code>networkConditions</code>"]["<code>type</code>"]
+      equals "<code>offline</code>", set |emulated network conditions| to a new
+      [=emulated network conditions struct=] with
+      [=emulated-network-conditions-struct/offline=] set to true.
+
+1. If the <code>contexts</code> field of |command parameters| is present:
+
+   1. Let |navigables| be the result of [=trying=] to
+      [=get valid top-level traversables by ids=] with
+      |command parameters|["<code>contexts</code>"].
+
+   1. For each |navigable| of |navigables|:
+
+      1. [=map/Set=] [=emulated network conditions map=][|navigable|] to
+         |emulated network conditions|.
+
+1. If the <code>userContexts</code> field of |command parameters| is present:
+
+   1. Let |user contexts| be the result of [=trying=] to [=get valid user contexts=]
+      with |command parameters|["<code>userContexts</code>"].
+
+   1. For each |user context| of |user contexts|:
+
+      1. [=map/Set=] [=emulated network conditions map=][|user context|] to |emulated network conditions|.
+
+1. Return [=success=] with data null.
+
+</div>
+
 #### The emulation.setScreenOrientationOverride Command ####  {#command-emulation-setScreenOrientationOverride}
 
 The <dfn export for=commands>emulation.setScreenOrientationOverride</dfn> command
@@ -9507,6 +9596,29 @@ and |user context| are:
 
 </div>
 
+<div algorithm>
+The steps to <dfn>get emulated network conditions</dfn> given |related navigables|
+are:
+
+1. For each |navigable| of |related navigables|:
+
+   1. Let |top-level traversable| be |navigable|’s [=navigable/top-level traversable=].
+
+   1. Let |user context| be |top-level traversable|'s [=associated user context=].
+
+   1. For each |session| in [=active BiDI sessions=]:
+
+      1. If |session|'s [=emulated network conditions map=] [=map/contains=]
+         |top-level traversable|, return
+         [=emulated network conditions map=][|top-level traversable|].
+
+      1. If |session|'s [=emulated network conditions map=] [=map/contains=]
+         |user context|, return [=emulated network conditions map=][|user context|].
+
+1. Return null.
+
+</div>
+
 <div algorithm>
 The [=remote end event trigger=] is the <dfn export>WebDriver BiDi before
 request sent</dfn> steps given |request|:
@@ -9614,8 +9726,17 @@ request sent</dfn> steps given |request|:
 
     Note: While waiting, no further processing of the request occurs.
 
+1. Let |emulated network conditions| be the result of
+   [=get emulated network conditions=] with |related navigables|.
+
+1. If |emulated network conditions| is not null and
+   |emulated network conditions|'s [=emulated-network-conditions-struct/offline=] is
+   true, return ([=network error=], "<code>complete</code>").
+
 1. Return (|response|, |response status|).
 
+Issue: Respect return value in Fetch's "HTTP-network-or-cache fetch" algorithm.
+
 </div>
 
 #### The network.fetchError Event #### {#event-network-fetchError}