Bidi: BrowserContext (#3018)

kblok · web-flow · commit 6b3aa50b41b9 · 2025-11-26T17:04:46.000-03:00
* Bidi: BrowserContext

* it is ignore upstream

* fix json
diff --git a/lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.local.json b/lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.local.json
@@ -337,21 +337,6 @@
       "FAIL"
     ]
   },
-  {
-    "comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
-    "testIdPattern": "[browsercontext.spec] *",
-    "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": "[elementhandle.spec] *",
@@ -1328,21 +1313,6 @@
       "FAIL"
     ]
   },
-  {
-    "comment": "BidiBrowserContext.CloseAsync() is not implemented - fails with NotImplementedException",
-    "testIdPattern": "[cookies.spec] Cookie specs Page.setCookie should isolate cookies in browser contexts",
-    "platforms": [
-      "darwin",
-      "linux",
-      "win32"
-    ],
-    "parameters": [
-      "webDriverBiDi"
-    ],
-    "expectations": [
-      "SKIP"
-    ]
-  },
   {
     "comment": "BiDi Keyboard not implemented yet - requires BidiKeyboard implementation - NEEDS KEYBOARD",
     "testIdPattern": "[mouse.spec] Mouse should select the text with mouse",
diff --git a/lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.upstream.json b/lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.upstream.json
@@ -967,13 +967,6 @@
     "expectations": ["FAIL"],
     "comment": "In BiDi currently more events than needed are fired (because target is updated more often). We probably need to adjust the test as the behavior is not broken per se"
   },
-  {
-    "testIdPattern": "[browsercontext.spec] BrowserContext should wait for a target",
-    "platforms": ["darwin", "linux", "win32"],
-    "parameters": ["cdp", "firefox"],
-    "expectations": ["SKIP"],
-    "comment": "TODO: add a comment explaining why this expectation is required (include links to issues)"
-  },
   {
     "testIdPattern": "[browsercontext.spec] BrowserContext should work across sessions",
     "platforms": ["darwin", "linux", "win32"],
diff --git a/lib/PuppeteerSharp.Tests/BrowserContextTests/BrowserContextTests.cs b/lib/PuppeteerSharp.Tests/BrowserContextTests/BrowserContextTests.cs
@@ -11,23 +11,30 @@ public class BrowserContextTests : PuppeteerBrowserBaseTest
         [Test, PuppeteerTest("browsercontext.spec", "BrowserContext", "should have default context")]
         public void ShouldHaveDefaultContext()
         {
-            Assert.That(Browser.BrowserContexts(), Has.Exactly(1).Items);
-            var defaultContext = Browser.BrowserContexts()[0];
+            // Firefox with BiDi returns multiple user contexts (container tabs) by default
+            Assert.That(Browser.BrowserContexts().Length, Is.GreaterThanOrEqualTo(1));
+        }
+
+        [Test, PuppeteerTest("browsercontext.spec", "BrowserContext", "should not be able to close default context")]
+        public void ShouldNotBeAbleToCloseDefaultContext()
+        {
+            var defaultContext = Browser.DefaultContext;
+            Assert.That(defaultContext, Is.Not.Null);
             var exception = Assert.ThrowsAsync<PuppeteerException>(defaultContext.CloseAsync);
-            Assert.That(Browser.DefaultContext, Is.SameAs(defaultContext));
             Assert.That(exception!.Message, Does.Contain("cannot be closed"));
         }
 
-        [Test, PuppeteerTest("browsercontext.spec", "BrowserContext", "should create new incognito context")]
-        public async Task ShouldCreateNewIncognitoContext()
+        [Test, PuppeteerTest("browsercontext.spec", "BrowserContext", "should create new context")]
+        public async Task ShouldCreateNewContext()
         {
-            Assert.That(Browser.BrowserContexts(), Has.Exactly(1).Items);
+            var contextCount = Browser.BrowserContexts().Length;
+            Assert.That(contextCount, Is.GreaterThanOrEqualTo(1));
             var context = await Browser.CreateBrowserContextAsync();
-            Assert.That(Browser.BrowserContexts(), Has.Length.EqualTo(2));
+            Assert.That(Browser.BrowserContexts(), Has.Length.EqualTo(contextCount + 1));
             Assert.That(Browser.BrowserContexts(), Does.Contain(context));
             await context.CloseAsync();
             Assert.That(context.IsClosed, Is.True);
-            Assert.That(Browser.BrowserContexts(), Has.Exactly(1).Items);
+            Assert.That(Browser.BrowserContexts(), Has.Length.EqualTo(contextCount));
         }
 
         [Test, PuppeteerTest("browsercontext.spec", "BrowserContext", "should close all belonging targets once closing context")]
@@ -86,6 +93,9 @@ public async Task ShouldFireTargetEvents()
         [Test, PuppeteerTest("browsercontext.spec", "BrowserContext", "should isolate localStorage and cookies")]
         public async Task ShouldIsolateLocalStorageAndCookies()
         {
+            // Firefox with BiDi returns multiple user contexts (container tabs) by default
+            var contextCount = Browser.BrowserContexts().Length;
+
             // Create two incognito contexts.
             var context1 = await Browser.CreateBrowserContextAsync();
             var context2 = await Browser.CreateBrowserContextAsync();
@@ -126,7 +136,7 @@ await page2.EvaluateExpressionAsync(@"{
             await Task.WhenAll(context1.CloseAsync(), context2.CloseAsync());
             Assert.That(context1.IsClosed, Is.True);
             Assert.That(context2.IsClosed, Is.True);
-            Assert.That(Browser.BrowserContexts(), Has.Exactly(1).Items);
+            Assert.That(Browser.BrowserContexts(), Has.Length.EqualTo(contextCount));
         }
 
         [Test, PuppeteerTest("browsercontext.spec", "BrowserContext", "should work across sessions")]
@@ -149,12 +159,13 @@ public async Task ShouldWorkAcrossSessions()
         [Test, PuppeteerTest("browsercontext.spec", "BrowserContext", "should provide a context id")]
         public async Task ShouldProvideAContextId()
         {
-            Assert.That(Browser.BrowserContexts(), Has.Exactly(1).Items);
-            Assert.That(Browser.BrowserContexts()[0].Id, Is.Null);
+            // Firefox with BiDi returns multiple user contexts (container tabs) by default
+            var contextCount = Browser.BrowserContexts().Length;
+            Assert.That(contextCount, Is.GreaterThanOrEqualTo(1));
 
             await using var context = await Browser.CreateBrowserContextAsync();
-            Assert.That(Browser.BrowserContexts(), Has.Length.EqualTo(2));
-            Assert.That(Browser.BrowserContexts()[1].Id, Is.Not.Null);
+            Assert.That(Browser.BrowserContexts(), Has.Length.EqualTo(contextCount + 1));
+            Assert.That(context.Id, Is.Not.Null);
         }
 
         [Test, PuppeteerTest("browsercontext.spec", "BrowserContext", "should wait for a target")]
diff --git a/lib/PuppeteerSharp/Bidi/BidiBrowser.cs b/lib/PuppeteerSharp/Bidi/BidiBrowser.cs
@@ -21,6 +21,7 @@
 //  * SOFTWARE.
 
 using System;
+using System.Collections.Concurrent;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Threading.Tasks;
@@ -38,7 +39,7 @@ namespace PuppeteerSharp.Bidi;
 public class BidiBrowser : Browser
 {
     private readonly LaunchOptions _options;
-    private readonly ConcurrentSet<BidiBrowserContext> _browserContexts = [];
+    private readonly ConcurrentDictionary<UserContext, BidiBrowserContext> _browserContexts = new();
     private readonly ILogger<BidiBrowser> _logger;
     private readonly BidiBrowserTarget _target;
     private bool _isClosed;
@@ -59,7 +60,7 @@ private BidiBrowser(Core.Browser browserCore, LaunchOptions options, ILoggerFact
     public override ITarget Target => _target;
 
     /// <inheritdoc/>
-    public override IBrowserContext DefaultContext => _browserContexts.FirstOrDefault(b => b.Id == BrowserCore.DefaultUserContext.Id);
+    public override IBrowserContext DefaultContext => _browserContexts.TryGetValue(BrowserCore.DefaultUserContext, out var context) ? context : null;
 
     internal static string[] SubscribeModules { get; } =
     [
@@ -134,7 +135,7 @@ public override ITarget[] Targets()
         =>
         [
             _target,
-            .. _browserContexts.SelectMany(context => context.Targets()).ToArray()
+            .. BrowserContexts().SelectMany(context => ((BidiBrowserContext)context).Targets()).ToArray()
         ];
 
     /// <inheritdoc />
@@ -145,7 +146,12 @@ public override async Task<IBrowserContext> CreateBrowserContextAsync(BrowserCon
     }
 
     /// <inheritdoc />
-    public override IBrowserContext[] BrowserContexts() => _browserContexts.ToArray();
+    public override IBrowserContext[] BrowserContexts() =>
+        BrowserCore.UserContexts
+            .Select(userContext => _browserContexts.TryGetValue(userContext, out var context) ? context : null)
+            .Where(context => context != null)
+            .Cast<IBrowserContext>()
+            .ToArray();
 
     [SuppressMessage(
         "Reliability",
@@ -193,9 +199,10 @@ private void InitializeAsync()
 
     private void Detach()
     {
-        foreach (var context in _browserContexts)
+        foreach (var context in _browserContexts.Values)
         {
             context.TargetCreated -= (sender, args) => OnTargetCreated(args);
+            context.TargetChanged -= (sender, args) => OnTargetChanged(args);
             context.TargetDestroyed -= (sender, args) => OnTargetDestroyed(args);
         }
     }
@@ -207,9 +214,10 @@ private BidiBrowserContext CreateBrowserContext(UserContext userContext)
             userContext,
             new BidiBrowserContextOptions() { DefaultViewport = _options.DefaultViewport, });
 
-        _browserContexts.Add(browserContext);
+        _browserContexts.TryAdd(userContext, browserContext);
 
         browserContext.TargetCreated += (sender, args) => OnTargetCreated(args);
+        browserContext.TargetChanged += (sender, args) => OnTargetChanged(args);
         browserContext.TargetDestroyed += (sender, args) => OnTargetDestroyed(args);
 
         return browserContext;
diff --git a/lib/PuppeteerSharp/Bidi/BidiBrowserContext.cs b/lib/PuppeteerSharp/Bidi/BidiBrowserContext.cs
@@ -20,12 +20,15 @@
 //  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 //  * SOFTWARE.
 
+using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
 using PuppeteerSharp.Bidi.Core;
 using PuppeteerSharp.Helpers;
+using WebDriverBiDi.Permissions;
 
 namespace PuppeteerSharp.Bidi;
 
@@ -34,6 +37,7 @@ public class BidiBrowserContext : BrowserContext
 {
     private readonly ConcurrentDictionary<BrowsingContext, BidiPage> _pages = [];
     private readonly ConcurrentDictionary<BidiPage, BidiPageTargetInfo> _targets = new();
+    private readonly List<(string Origin, OverridePermission Permission)> _overrides = [];
 
     private BidiBrowserContext(BidiBrowser browser, UserContext userContext, BidiBrowserContextOptions options)
     {
@@ -49,10 +53,69 @@ private BidiBrowserContext(BidiBrowser browser, UserContext userContext, BidiBro
     internal UserContext UserContext { get; }
 
     /// <inheritdoc />
-    public override Task OverridePermissionsAsync(string origin, IEnumerable<OverridePermission> permissions) => throw new System.NotImplementedException();
+    public override async Task OverridePermissionsAsync(string origin, IEnumerable<OverridePermission> permissions)
+    {
+        var permissionsSet = new HashSet<OverridePermission>(permissions);
+
+        // We need to set all permissions - grant the ones in the list, deny the rest
+        var tasks = new List<Task>();
+        foreach (OverridePermission permission in Enum.GetValues(typeof(OverridePermission)))
+        {
+            var state = permissionsSet.Contains(permission)
+                ? PermissionState.Granted
+                : PermissionState.Denied;
+
+            var permissionName = GetPermissionName(permission);
+
+            var task = UserContext.SetPermissionsAsync(origin, permissionName, state);
+            _overrides.Add((origin, permission));
+
+            // Denying some outdated permissions might fail, so we catch those errors
+            if (!permissionsSet.Contains(permission))
+            {
+                task = task.ContinueWith(
+                    t =>
+                    {
+                        if (t.IsFaulted)
+                        {
+                            // Log the error but don't throw
+                            ((BidiBrowser)Browser).LoggerFactory?.CreateLogger<BidiBrowserContext>()
+                                .LogDebug(t.Exception, "Failed to deny permission {Permission}", permission);
+                        }
+                    },
+                    TaskScheduler.Default);
+            }
+
+            tasks.Add(task);
+        }
+
+        await Task.WhenAll(tasks).ConfigureAwait(false);
+    }
 
     /// <inheritdoc />
-    public override Task ClearPermissionOverridesAsync() => throw new System.NotImplementedException();
+    public override async Task ClearPermissionOverridesAsync()
+    {
+        var tasks = new List<Task>();
+        foreach (var (origin, permission) in _overrides.ToArray())
+        {
+            var permissionName = GetPermissionName(permission);
+            tasks.Add(UserContext.SetPermissionsAsync(origin, permissionName, PermissionState.Prompt)
+                .ContinueWith(
+                    t =>
+                    {
+                        if (t.IsFaulted)
+                        {
+                            // Log the error but don't throw
+                            ((BidiBrowser)Browser).LoggerFactory?.CreateLogger<BidiBrowserContext>()
+                                .LogDebug(t.Exception, "Failed to reset permission {Permission}", permission);
+                        }
+                    },
+                    TaskScheduler.Default));
+        }
+
+        _overrides.Clear();
+        await Task.WhenAll(tasks).ConfigureAwait(false);
+    }
 
     /// <inheritdoc />
     public override Task<IPage[]> PagesAsync() => Task.FromResult(_pages.Values.Cast<IPage>().ToArray());
@@ -83,7 +146,25 @@ public override async Task<IPage> NewPageAsync()
     }
 
     /// <inheritdoc />
-    public override Task CloseAsync() => throw new System.NotImplementedException();
+    public override async Task CloseAsync()
+    {
+        if (UserContext.Id == UserContext.DEFAULT)
+        {
+            throw new PuppeteerException("Default BrowserContext cannot be closed!");
+        }
+
+        try
+        {
+            await UserContext.RemoveAsync().ConfigureAwait(false);
+        }
+        catch (Exception ex)
+        {
+            ((BidiBrowser)Browser).LoggerFactory?.CreateLogger<BidiBrowserContext>()
+                .LogDebug(ex, "Failed to close browser context");
+        }
+
+        _targets.Clear();
+    }
 
     /// <inheritdoc />
     public override ITarget[] Targets()
@@ -107,6 +188,28 @@ internal static BidiBrowserContext From(
         return context;
     }
 
+    private static string GetPermissionName(OverridePermission permission)
+    {
+        return permission switch
+        {
+            OverridePermission.Geolocation => "geolocation",
+            OverridePermission.Midi => "midi",
+            OverridePermission.Notifications => "notifications",
+            OverridePermission.Camera => "camera",
+            OverridePermission.Microphone => "microphone",
+            OverridePermission.BackgroundSync => "background-sync",
+            OverridePermission.Sensors => "accelerometer",
+            OverridePermission.AccessibilityEvents => "accessibility-events",
+            OverridePermission.ClipboardReadWrite => "clipboard-read",
+            OverridePermission.PaymentHandler => "payment-handler",
+            OverridePermission.MidiSysex => "midi-sysex",
+            OverridePermission.IdleDetection => "idle-detection",
+            OverridePermission.PersistentStorage => "persistent-storage",
+            OverridePermission.LocalNetworkAccess => "local-network-access",
+            _ => throw new ArgumentOutOfRangeException(nameof(permission), permission, "Unknown permission"),
+        };
+    }
+
     private void Initialize()
     {
         // Create targets for existing browsing contexts.
diff --git a/lib/PuppeteerSharp/Bidi/BidiPageTarget.cs b/lib/PuppeteerSharp/Bidi/BidiPageTarget.cs
@@ -33,17 +33,15 @@ internal class BidiPageTarget(BidiPage page) : Target
 
     public override ITarget Opener => throw new InvalidOperationException();
 
-    internal override Browser Browser { get; }
+    internal override Browser Browser => (Browser)page.BrowserContext.Browser;
 
-    internal override BrowserContext BrowserContext => BidiBrowserContext;
-
-    internal BidiBrowserContext BidiBrowserContext { get; }
+    internal override BrowserContext BrowserContext => (BrowserContext)page.BrowserContext;
 
     public override Task<IPage> PageAsync() => Task.FromResult<IPage>(page);
 
     public override Task<IPage> AsPageAsync()
 #pragma warning disable CA2000
-        => Task.FromResult(BidiPage.From(BidiBrowserContext, page.BidiMainFrame.BrowsingContext) as IPage);
+        => Task.FromResult(BidiPage.From((BidiBrowserContext)page.BrowserContext, page.BidiMainFrame.BrowsingContext) as IPage);
 #pragma warning restore CA2000
 
     public override Task<ICDPSession> CreateCDPSessionAsync()
diff --git a/lib/PuppeteerSharp/Bidi/Core/UserContext.cs b/lib/PuppeteerSharp/Bidi/Core/UserContext.cs
