[dotnet] Implement Permissions module

Author: RenderMichael

dotnet/src/webdriver/BiDi/Extensions/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.Extensions.Permissions;
+
+internal record PermissionDescriptor(string Name);

dotnet/src/webdriver/BiDi/Extensions/Permissions/PermissionState.cs

@@ -0,0 +1,31 @@
+// <copyright file="PermissionState.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>
+
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
+using System.Text.Json.Serialization;
+
+namespace OpenQA.Selenium.BiDi.Extensions.Permissions;
+
+[JsonConverter(typeof(CamelCaseEnumConverter<PermissionState>))]
+public enum PermissionState
+{
+    Granted,
+    Denied,
+    Prompt
+}

dotnet/src/webdriver/BiDi/Extensions/Permissions/PermissionsModule.cs

@@ -0,0 +1,29 @@
+using OpenQA.Selenium.BiDi.Browser;
+using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Threading.Tasks;
+
+namespace OpenQA.Selenium.BiDi.Extensions.Permissions;
+
+public class PermissionsModule : Module
+{
+    private PermissionsJsonSerializerContext JsonContext => (PermissionsJsonSerializerContext)base.JsonContext;
+
+    public async Task SetPermissionAsync(string permissionName, PermissionState state, string origin, UserContext? userContext, SetPermissionOptions? options = null)
+    {
+        var @params = new SetPermissionCommandParameters(new PermissionDescriptor(permissionName), state, origin, userContext);
+
+        await Broker.ExecuteCommandAsync(new SetPermissionCommand(@params), options, JsonContext.Permissions_SetPermissionCommand, JsonContext.Permissions_SetPermissionResult).ConfigureAwait(false);
+    }
+
+    protected override JsonSerializerContext Initialize(JsonSerializerOptions options)
+    {
+        return new PermissionsJsonSerializerContext(options);
+    }
+}
+
+[JsonSerializable(typeof(SetPermissionCommand), TypeInfoPropertyName = "Permissions_SetPermissionCommand")]
+[JsonSerializable(typeof(SetPermissionResult), TypeInfoPropertyName = "Permissions_SetPermissionResult")]
+internal partial class PermissionsJsonSerializerContext : JsonSerializerContext;

dotnet/src/webdriver/BiDi/Extensions/Permissions/SetPermissionCommand.cs

@@ -0,0 +1,17 @@
+using OpenQA.Selenium.BiDi.Browser;
+using OpenQA.Selenium.BiDi.Communication;
+using OpenQA.Selenium.BiDi.Communication.Json.Converters;
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Text.Json.Serialization;
+
+namespace OpenQA.Selenium.BiDi.Extensions.Permissions;
+
+internal class SetPermissionCommand(SetPermissionCommandParameters @params)
+    : Command<SetPermissionCommandParameters, SetPermissionResult>(@params, "permissions.setPermission");
+
+public class SetPermissionOptions : CommandOptions;
+public sealed record SetPermissionResult : EmptyResult;
+
+internal record SetPermissionCommandParameters(PermissionDescriptor Descriptor, PermissionState State, string Origin, UserContext? UserContext) : Parameters;

dotnet/src/webdriver/BiDi/WebDriver.Extensions.cs

@@ -17,6 +17,7 @@
 // under the License.
 // </copyright>
 
+using OpenQA.Selenium.BiDi.Extensions.Permissions;
 using System;
 using System.Threading.Tasks;
 
@@ -41,4 +42,9 @@ public static async Task<BiDi> AsBiDiAsync(this IWebDriver webDriver, BiDiOption
 
         return bidi;
     }
+
+    public static PermissionsModule AsPermissionsAsync(this BiDi bidi)
+    {
+        return Module.Create<PermissionsModule>(bidi, bidi.DefaultBiDiOptions());
+    }
 }

dotnet/test/common/BiDi/Extensions/Permissions/PermissionsTests.cs

@@ -0,0 +1,42 @@
+using NUnit.Framework;
+using OpenQA.Selenium.BiDi.BrowsingContext;
+using OpenQA.Selenium.BiDi.Script;
+using OpenQA.Selenium.Environment;
+using System.Threading.Tasks;
+
+namespace OpenQA.Selenium.BiDi.Extensions.Permissions;
+
+internal class PermissionsTests : BiDiTestFixture
+{
+    [Test]
+    public async Task SettingPermissionsTest()
+    {
+        var userContext = await bidi.Browser.CreateUserContextAsync();
+        var window = (await bidi.BrowsingContext.CreateAsync(ContextType.Window, new()
+        {
+            ReferenceContext = context,
+            UserContext = userContext.UserContext,
+            Background = true
+        })).Context;
+
+        var newPage = EnvironmentManager.Instance.UrlBuilder.CreateInlinePage(new InlinePage()
+            .WithBody("<div>new page</div>"));
+
+        await window.NavigateAsync(newPage);
+
+        var before = await window.Script.CallFunctionAsync("""
+            async () => (await navigator.permissions.query({ name: "geolocation" })).state
+            """, awaitPromise: true, new() { UserActivation = true, });
+
+        Assert.That(before.AsSuccessResult(), Is.EqualTo(new StringRemoteValue("prompt")));
+
+        var permissions = bidi.AsPermissionsAsync();
+        await permissions.SetPermissionAsync("geolocation", PermissionState.Denied, newPage, userContext.UserContext);
+
+        var after = await window.Script.CallFunctionAsync("""
+            async () => (await navigator.permissions.query({ name: "geolocation" })).state
+            """, awaitPromise: true, new() { UserActivation = true });
+
+        Assert.That(after.AsSuccessResult(), Is.EqualTo(new StringRemoteValue("denied")));
+    }
+}