[dotnet] Implement third-party Permissions module (#16414)

Co-authored-by: Nikolay Borisenko <[email protected]>

Author: RenderMichael

dotnet/src/webdriver/BiDi/BiDi.cs

@@ -29,15 +29,13 @@ namespace OpenQA.Selenium.BiDi;
 
 public sealed class BiDi : IAsyncDisposable
 {
-    private readonly Broker _broker;
-    private readonly JsonSerializerOptions _jsonOptions;
+    internal Broker Broker { get; }
+    internal JsonSerializerOptions JsonOptions { get; }
     private readonly BiDiJsonSerializerContext _jsonContext;
 
-    private BiDi(string url)
+    public JsonSerializerOptions DefaultBiDiOptions()
     {
-        var uri = new Uri(url);
-
-        _jsonOptions = new JsonSerializerOptions
+        return new JsonSerializerOptions
         {
             PropertyNameCaseInsensitive = true,
             PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
@@ -60,20 +58,27 @@ private BiDi(string url)
                 new WebExtensionConverter(this),
             }
         };
+    }
+
+    private BiDi(string url)
+    {
+        var uri = new Uri(url);
 
-        _jsonContext = new BiDiJsonSerializerContext(_jsonOptions);
-
-        _broker = new Broker(this, uri, _jsonOptions);
-        SessionModule = Module.Create<Session.SessionModule>(this, _broker, _jsonOptions, _jsonContext);
-        BrowsingContext = Module.Create<BrowsingContext.BrowsingContextModule>(this, _broker, _jsonOptions, _jsonContext);
-        Browser = Module.Create<Browser.BrowserModule>(this, _broker, _jsonOptions, _jsonContext);
-        Network = Module.Create<Network.NetworkModule>(this, _broker, _jsonOptions, _jsonContext);
-        InputModule = Module.Create<Input.InputModule>(this, _broker, _jsonOptions, _jsonContext);
-        Script = Module.Create<Script.ScriptModule>(this, _broker, _jsonOptions, _jsonContext);
-        Log = Module.Create<Log.LogModule>(this, _broker, _jsonOptions, _jsonContext);
-        Storage = Module.Create<Storage.StorageModule>(this, _broker, _jsonOptions, _jsonContext);
-        WebExtension = Module.Create<WebExtension.WebExtensionModule>(this, _broker, _jsonOptions, _jsonContext);
-        Emulation = Module.Create<Emulation.EmulationModule>(this, _broker, _jsonOptions, _jsonContext);
+        JsonOptions = DefaultBiDiOptions();
+
+        _jsonContext = new BiDiJsonSerializerContext(JsonOptions);
+
+        Broker = new Broker(this, uri, JsonOptions);
+        SessionModule = Module.Create<Session.SessionModule>(this, JsonOptions, _jsonContext);
+        BrowsingContext = Module.Create<BrowsingContext.BrowsingContextModule>(this, JsonOptions, _jsonContext);
+        Browser = Module.Create<Browser.BrowserModule>(this, JsonOptions, _jsonContext);
+        Network = Module.Create<Network.NetworkModule>(this, JsonOptions, _jsonContext);
+        InputModule = Module.Create<Input.InputModule>(this, JsonOptions, _jsonContext);
+        Script = Module.Create<Script.ScriptModule>(this, JsonOptions, _jsonContext);
+        Log = Module.Create<Log.LogModule>(this, JsonOptions, _jsonContext);
+        Storage = Module.Create<Storage.StorageModule>(this, JsonOptions, _jsonContext);
+        WebExtension = Module.Create<WebExtension.WebExtensionModule>(this, JsonOptions, _jsonContext);
+        Emulation = Module.Create<Emulation.EmulationModule>(this, JsonOptions, _jsonContext);
     }
 
     internal Session.SessionModule SessionModule { get; }
@@ -105,7 +110,7 @@ public static async Task<BiDi> ConnectAsync(string url, BiDiOptions? options = n
     {
         var bidi = new BiDi(url);
 
-        await bidi._broker.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
+        await bidi.Broker.ConnectAsync(CancellationToken.None).ConfigureAwait(false);
 
         return bidi;
     }
@@ -117,7 +122,7 @@ public Task EndAsync(Session.EndOptions? options = null)
 
     public async ValueTask DisposeAsync()
     {
-        await _broker.DisposeAsync().ConfigureAwait(false);
+        await Broker.DisposeAsync().ConfigureAwait(false);
         GC.SuppressFinalize(this);
     }
 }

dotnet/src/webdriver/BiDi/Browser/BrowserModule.cs

@@ -17,12 +17,17 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Browser;
 
 public sealed class BrowserModule : Module
 {
+    internal new BiDiJsonSerializerContext JsonContext => (BiDiJsonSerializerContext)base.JsonContext;
+
     public async Task<CloseResult> CloseAsync(CloseOptions? options = null)
     {
         return await Broker.ExecuteCommandAsync(new CloseCommand(), options, JsonContext.Browser_CloseCommand, JsonContext.Browser_CloseResult).ConfigureAwait(false);
@@ -73,4 +78,8 @@ public async Task<SetDownloadBehaviorResult> SetDownloadBehaviorDeniedAsync(SetD
 
         return await Broker.ExecuteCommandAsync(new SetDownloadBehaviorCommand(@params), options, JsonContext.SetDownloadBehaviorCommand, JsonContext.SetDownloadBehaviorResult).ConfigureAwait(false);
     }
+    protected override JsonSerializerContext CreateJsonContext(JsonSerializerOptions options)
+    {
+        return new BiDiJsonSerializerContext(options);
+    }
 }

dotnet/src/webdriver/BiDi/Browser/UserContext.cs

@@ -22,7 +22,7 @@
 
 namespace OpenQA.Selenium.BiDi.Browser;
 
-public sealed class UserContext : IAsyncDisposable
+public sealed class UserContext : IEquatable<UserContext>, IAsyncDisposable
 {
     private readonly BiDi _bidi;
 
@@ -44,15 +44,19 @@ public async ValueTask DisposeAsync()
         await RemoveAsync().ConfigureAwait(false);
     }
 
-    public override bool Equals(object? obj)
+    public bool Equals(UserContext? other)
     {
-        if (obj is UserContext userContextObj) return userContextObj.Id == Id;
+        return other is not null && string.Equals(Id, other.Id, StringComparison.Ordinal);
+    }
+
 
-        return false;
+    public override bool Equals(object? obj)
+    {
+        return Equals(obj as UserContext);
     }
 
     public override int GetHashCode()
     {
-        return Id.GetHashCode();
+        return StringComparer.Ordinal.GetHashCode(Id);
     }
 }

dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextModule.cs

@@ -17,13 +17,18 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json;
 using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.BrowsingContext;
 
 public sealed class BrowsingContextModule : Module
 {
+    internal new BiDiJsonSerializerContext JsonContext => (BiDiJsonSerializerContext)base.JsonContext;
+
     public async Task<CreateResult> CreateAsync(ContextType type, CreateOptions? options = null)
     {
         var @params = new CreateParameters(type, options?.ReferenceContext, options?.Background, options?.UserContext);
@@ -247,4 +252,8 @@ public async Task<Subscription> OnUserPromptClosedAsync(Action<UserPromptClosedE
     {
         return await Broker.SubscribeAsync("browsingContext.userPromptClosed", handler, options, JsonContext.UserPromptClosedEventArgs).ConfigureAwait(false);
     }
+    protected override JsonSerializerContext CreateJsonContext(JsonSerializerOptions options)
+    {
+        return new BiDiJsonSerializerContext(options);
+    }
 }

dotnet/src/webdriver/BiDi/Emulation/EmulationModule.cs

@@ -17,12 +17,17 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Emulation;
 
 public sealed class EmulationModule : Module
 {
+    internal new BiDiJsonSerializerContext JsonContext => (BiDiJsonSerializerContext)base.JsonContext;
+
     public async Task<SetTimezoneOverrideResult> SetTimezoneOverrideAsync(string? timezone, SetTimezoneOverrideOptions? options = null)
     {
         var @params = new SetTimezoneOverrideParameters(timezone, options?.Contexts, options?.UserContexts);
@@ -87,4 +92,8 @@ public async Task<SetGeolocationOverrideResult> SetGeolocationPositionErrorOverr
 
         return await Broker.ExecuteCommandAsync(new SetGeolocationOverrideCommand(@params), options, JsonContext.SetGeolocationOverrideCommand, JsonContext.SetGeolocationOverrideResult).ConfigureAwait(false);
     }
+    protected override JsonSerializerContext CreateJsonContext(JsonSerializerOptions options)
+    {
+        return new BiDiJsonSerializerContext(options);
+    }
 }

dotnet/src/webdriver/BiDi/Input/InputModule.cs

@@ -17,13 +17,18 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json;
 using System.Collections.Generic;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Input;
 
 public sealed class InputModule : Module
 {
+    internal new BiDiJsonSerializerContext JsonContext => (BiDiJsonSerializerContext)base.JsonContext;
+
     public async Task<PerformActionsResult> PerformActionsAsync(BrowsingContext.BrowsingContext context, IEnumerable<SourceActions> actions, PerformActionsOptions? options = null)
     {
         var @params = new PerformActionsParameters(context, actions);
@@ -44,4 +49,8 @@ public async Task<SetFilesResult> SetFilesAsync(BrowsingContext.BrowsingContext
 
         return await Broker.ExecuteCommandAsync(new SetFilesCommand(@params), options, JsonContext.SetFilesCommand, JsonContext.SetFilesResult).ConfigureAwait(false);
     }
+    protected override JsonSerializerContext CreateJsonContext(JsonSerializerOptions options)
+    {
+        return new BiDiJsonSerializerContext(options);
+    }
 }

dotnet/src/webdriver/BiDi/Log/LogModule.cs

@@ -17,13 +17,18 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json;
 using System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Log;
 
 public sealed class LogModule : Module
 {
+    internal new BiDiJsonSerializerContext JsonContext => (BiDiJsonSerializerContext)base.JsonContext;
+
     public async Task<Subscription> OnEntryAddedAsync(Func<LogEntry, Task> handler, SubscriptionOptions? options = null)
     {
         return await Broker.SubscribeAsync("log.entryAdded", handler, options, JsonContext.LogEntry).ConfigureAwait(false);
@@ -33,4 +38,8 @@ public async Task<Subscription> OnEntryAddedAsync(Action<LogEntry> handler, Subs
     {
         return await Broker.SubscribeAsync("log.entryAdded", handler, options, JsonContext.LogEntry).ConfigureAwait(false);
     }
+    protected override JsonSerializerContext CreateJsonContext(JsonSerializerOptions options)
+    {
+        return new BiDiJsonSerializerContext(options);
+    }
 }

dotnet/src/webdriver/BiDi/Module.cs

@@ -17,29 +17,28 @@
 // under the License.
 // </copyright>
 
-using OpenQA.Selenium.BiDi.Json;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 
 namespace OpenQA.Selenium.BiDi;
 
 public abstract class Module
 {
     protected Broker Broker { get; private set; }
 
-    internal BiDiJsonSerializerContext JsonContext { get; private set; }
+    internal JsonSerializerContext JsonContext { get; private set; }
 
-    protected virtual void Initialize(JsonSerializerOptions options) { }
+    protected abstract JsonSerializerContext CreateJsonContext(JsonSerializerOptions options);
 
-    internal static TModule Create<TModule>(BiDi bidi, Broker broker, JsonSerializerOptions jsonOptions, BiDiJsonSerializerContext context)
+    public static TModule Create<TModule>(BiDi bidi, JsonSerializerOptions jsonOptions, JsonSerializerContext? cachedContext = null)
         where TModule : Module, new()
     {
         TModule module = new()
         {
-            Broker = broker,
-            JsonContext = context
+            Broker = bidi.Broker,
         };
 
-        module.Initialize(jsonOptions);
+        module.JsonContext = cachedContext ?? module.CreateJsonContext(jsonOptions);
 
         return module;
     }

dotnet/src/webdriver/BiDi/Network/NetworkModule.cs

@@ -17,14 +17,19 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Json;
 using System;
 using System.Collections.Generic;
+using System.Text.Json;
+using System.Text.Json.Serialization;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.Network;
 
 public sealed partial class NetworkModule : Module
 {
+    internal new BiDiJsonSerializerContext JsonContext => (BiDiJsonSerializerContext)base.JsonContext;
+
     public async Task<Collector> AddDataCollectorAsync(IEnumerable<DataType> DataTypes, int MaxEncodedDataSize, AddDataCollectorOptions? options = null)
     {
         var @params = new AddDataCollectorParameters(DataTypes, MaxEncodedDataSize, options?.CollectorType, options?.Contexts, options?.UserContexts);
@@ -172,4 +177,8 @@ public async Task<Subscription> OnAuthRequiredAsync(Action<AuthRequiredEventArgs
     {
         return await Broker.SubscribeAsync("network.authRequired", handler, options, JsonContext.AuthRequiredEventArgs).ConfigureAwait(false);
     }
+    protected override JsonSerializerContext CreateJsonContext(JsonSerializerOptions options)
+    {
+        return new BiDiJsonSerializerContext(options);
+    }
 }

dotnet/src/webdriver/BiDi/Permissions/PermissionDescriptor.cs

@@ -0,0 +1,22 @@
+// <copyright file="PermissionDescriptor.cs" company="Selenium Committers">
+// Licensed to the Software Freedom Conservancy (SFC) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The SFC licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+// </copyright>
+
+namespace OpenQA.Selenium.BiDi.Permissions;
+
+public record PermissionDescriptor(string Name);