Bidi: SetCacheEnabled support (#3017)

Author: kblok

lib/.claude/commands/implement-bidi-feature.md

@@ -11,8 +11,8 @@ In order to do that you will need to:
  * You are going to look for tests that might match that `testIdPattern` but looking at the test attribute.
     - For instance if the `testIdPattern` is `Chromium-Specific *`, `[Test, PuppeteerTest("chromiumonly.spec", "Chromium-Specific Page Tests", "Page.setRequestInterception should work with intervention headers")]` will be a valid match.
  * Once you see what fail in those tests you will need to modify the code to make the test pass. You should not edit the tests themselves.
- * You will find the code in typescript implementing the feature at ../../puppeteer/puppeteer and you will need to port that code to .NET.
- * You will also find BidiDriver code at ../../puppeteer/bidi-client you need to check what you need to use from there to make the tests pass.
+ * You will find the code in typescript implementing the feature at ../../../puppeteer/puppeteer and you will need to port that code to .NET.
+ * You will also find BidiDriver code at ../../../webdriverbidi-net/webdriverbidi-net you need to check what you need to use from there to make the tests pass.
  * You will have to implement the code as close as possible to the original code, but adapted to .NET idioms and practices.
  * As part of the task you will need to generate a document explaining the changes you made, and how they relate to the original PR.
  * You need to run related tests to ensure everything is working as expected.

lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.local.json

@@ -982,36 +982,6 @@
       "FAIL"
     ]
   },
-  {
-    "comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
-    "testIdPattern": "[page.spec] *Page.Events.error*",
-    "platforms": [
-      "darwin",
-      "linux",
-      "win32"
-    ],
-    "parameters": [
-      "webDriverBiDi"
-    ],
-    "expectations": [
-      "FAIL"
-    ]
-  },
-  {
-    "comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
-    "testIdPattern": "[page.spec] *Page.Events.Load*",
-    "platforms": [
-      "darwin",
-      "linux",
-      "win32"
-    ],
-    "parameters": [
-      "webDriverBiDi"
-    ],
-    "expectations": [
-      "FAIL"
-    ]
-  },
   {
     "comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
     "testIdPattern": "[page.spec] *Page.removeExposedFunction*",
@@ -1042,21 +1012,6 @@
       "FAIL"
     ]
   },
-  {
-    "comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
-    "testIdPattern": "[page.spec] *Page.setCacheEnabled*",
-    "platforms": [
-      "darwin",
-      "linux",
-      "win32"
-    ],
-    "parameters": [
-      "webDriverBiDi"
-    ],
-    "expectations": [
-      "FAIL"
-    ]
-  },
   {
     "comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
     "testIdPattern": "[page.spec] *Page.setJavaScriptEnabled*",

lib/PuppeteerSharp.Tests/PageTests/PageEventsErrorTests.cs

@@ -15,7 +15,8 @@ public async Task ShouldThrowWhenPageCrashes()
         {
             string error = null;
             Page.Error += (_, e) => error = e.Error;
-            var gotoTask = Page.GoToAsync("chrome://crash");
+            var crashUrl = TestConstants.IsChrome ? "chrome://crash" : "about:crashcontent";
+            var gotoTask = Page.GoToAsync(crashUrl);
 
             await WaitForError();
             Assert.That(error, Is.EqualTo("Page crashed!"));

lib/PuppeteerSharp/Bidi/BidiPage.cs

@@ -30,6 +30,7 @@
 using PuppeteerSharp.Helpers;
 using PuppeteerSharp.Media;
 using WebDriverBiDi.BrowsingContext;
+using WebDriverBiDi.Network;
 
 namespace PuppeteerSharp.Bidi;
 
@@ -40,8 +41,9 @@ public class BidiPage : Page
     private readonly CdpEmulationManager _cdpEmulationManager;
     private InternalNetworkConditions _emulatedNetworkConditions;
     private TaskCompletionSource<bool> _closedTcs;
+    private string _requestInterception;
 
-    internal BidiPage(BidiBrowserContext browserContext, BrowsingContext browsingContext) : base(browserContext.ScreenshotTaskQueue)
+    private BidiPage(BidiBrowserContext browserContext, BrowsingContext browsingContext) : base(browserContext.ScreenshotTaskQueue)
     {
         BrowserContext = browserContext;
         Browser = browserContext.Browser;
@@ -267,7 +269,16 @@ public override async Task SetGeolocationAsync(GeolocationOption options)
     public override Task SetBypassCSPAsync(bool enabled) => throw new NotImplementedException();
 
     /// <inheritdoc />
-    public override Task SetCacheEnabledAsync(bool enabled = true) => throw new NotImplementedException();
+    public override async Task SetCacheEnabledAsync(bool enabled = true)
+    {
+        var commandParameters = new SetCacheBehaviorCommandParameters
+        {
+            CacheBehavior = enabled ? CacheBehavior.Default : CacheBehavior.Bypass,
+            Contexts = [BidiMainFrame.BrowsingContext.Id],
+        };
+
+        await BidiMainFrame.BrowsingContext.Session.Driver.Network.SetCacheBehaviorAsync(commandParameters).ConfigureAwait(false);
+    }
 
     /// <inheritdoc />
     public override Task EmulateMediaTypeAsync(MediaType type) => throw new NotImplementedException();
@@ -291,14 +302,14 @@ public override async Task SetViewportAsync(ViewPortOptions viewport)
             await BidiMainFrame.BrowsingContext.SetViewportAsync(
                 new SetViewportOptions()
                 {
-                    Viewport = viewport?.Width > 0 && viewport?.Height > 0
-                        ? new WebDriverBiDi.BrowsingContext.Viewport()
+                    Viewport = viewport is { Width: > 0, Height: > 0 }
+                        ? new Viewport()
                         {
                             Width = (ulong)viewport.Width,
                             Height = (ulong)viewport.Height,
                         }
                         : null,
-                    DevicePixelRatio = viewport?.DeviceScaleFactor,
+                    DevicePixelRatio = viewport.DeviceScaleFactor,
                 }).ConfigureAwait(false);
             Viewport = viewport;
             return;
@@ -398,7 +409,7 @@ public override async Task CloseAsync(PageCloseOptions options = null)
         }
         catch (Exception)
         {
-            return;
+            // Swallow.
         }
     }
 
@@ -464,7 +475,13 @@ await BidiBrowser.Driver.Storage.DeleteCookiesAsync(new WebDriverBiDi.Storage.De
     public override Task<IJSHandle> QueryObjectsAsync(IJSHandle prototypeHandle) => throw new NotImplementedException();
 
     /// <inheritdoc />
-    public override Task SetRequestInterceptionAsync(bool value) => throw new NotImplementedException();
+    public override async Task SetRequestInterceptionAsync(bool value)
+    {
+        _requestInterception = await ToggleInterceptionAsync(
+            [InterceptPhase.BeforeRequestSent],
+            _requestInterception,
+            value).ConfigureAwait(false);
+    }
 
     /// <inheritdoc />
     public override async Task SetOfflineModeAsync(bool value)
@@ -675,6 +692,30 @@ await BidiMainFrame.Client.SendAsync(
             }).ConfigureAwait(false);
     }
 
+    private async Task<string> ToggleInterceptionAsync(
+        InterceptPhase[] phases,
+        string interception,
+        bool expected)
+    {
+        if (expected && interception == null)
+        {
+            var options = new AddInterceptCommandParameters();
+            foreach (var phase in phases)
+            {
+                options.Phases.Add(phase);
+            }
+
+            return await BidiMainFrame.BrowsingContext.AddInterceptAsync(options).ConfigureAwait(false);
+        }
+        else if (!expected && interception != null)
+        {
+            await BidiMainFrame.BrowsingContext.UserContext.Browser.RemoveInterceptAsync(interception).ConfigureAwait(false);
+            return null;
+        }
+
+        return interception;
+    }
+
     private void Initialize()
     {
         BidiMainFrame.BrowsingContext.Closed += (_, _) =>
@@ -686,17 +727,15 @@ private void Initialize()
         // Track workers
         WorkerCreated += (_, e) =>
         {
-            var worker = e.Worker as BidiWebWorker;
-            if (worker != null)
+            if (e.Worker is BidiWebWorker worker)
             {
                 _workers[worker.RealmId] = worker;
             }
         };
 
         WorkerDestroyed += (_, e) =>
         {
-            var worker = e.Worker as BidiWebWorker;
-            if (worker != null)
+            if (e.Worker is BidiWebWorker worker)
             {
                 _workers.TryRemove(worker.RealmId, out var _);
             }

lib/PuppeteerSharp/Bidi/Core/Browser.cs

@@ -99,6 +99,11 @@ public async Task<UserContext> CreateUserContextAsync()
         return CreateUserContext(result.UserContextId);
     }
 
+    public async Task RemoveInterceptAsync(string intercept)
+    {
+        await Session.Driver.Network.RemoveInterceptAsync(new WebDriverBiDi.Network.RemoveInterceptCommandParameters(intercept)).ConfigureAwait(false);
+    }
+
     private void Dispose(string reason)
     {
         _reason = reason;

lib/PuppeteerSharp/Bidi/Core/BrowsingContext.cs

@@ -205,6 +205,14 @@ internal async Task TraverseHistoryAsync(int delta)
     internal async Task ReloadAsync()
         => await Session.Driver.BrowsingContext.ReloadAsync(new ReloadCommandParameters(Id)).ConfigureAwait(false);
 
+    internal async Task<string> AddInterceptAsync(WebDriverBiDi.Network.AddInterceptCommandParameters options)
+    {
+        options.BrowsingContextIds ??= new List<string>();
+        options.BrowsingContextIds.Add(Id);
+        var result = await Session.Driver.Network.AddInterceptAsync(options).ConfigureAwait(false);
+        return result.InterceptId;
+    }
+
     protected virtual void OnBrowsingContextCreated(BidiBrowsingContextEventArgs e) => BrowsingContextCreated?.Invoke(this, e);
 
     private void Initialize()