SetGeolocation

Author: nvborisenko

dotnet/src/webdriver/BiDi/Communication/Json/BiDiJsonSerializerContext.cs

@@ -178,5 +178,6 @@ namespace OpenQA.Selenium.BiDi.Communication.Json;
 [JsonSerializable(typeof(Emulation.SetForcedColorsModeThemeOverrideCommand))]
 [JsonSerializable(typeof(Emulation.SetScriptingEnabledCommand))]
 [JsonSerializable(typeof(Emulation.SetScreenOrientationOverrideCommand))]
+[JsonSerializable(typeof(Emulation.SetGeolocationOverrideCommand))]
 
 internal partial class BiDiJsonSerializerContext : JsonSerializerContext;

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

@@ -17,6 +17,7 @@
 // under the License.
 // </copyright>
 
+using System;
 using System.Threading.Tasks;
 using OpenQA.Selenium.BiDi.Communication;
 
@@ -65,4 +66,27 @@ public async Task<EmptyResult> SetScreenOrientationOverrideAsync(ScreenOrientati
 
         return await Broker.ExecuteCommandAsync<SetScreenOrientationOverrideCommand, EmptyResult>(new SetScreenOrientationOverrideCommand(@params), options).ConfigureAwait(false);
     }
+
+    public async Task<EmptyResult> SetGeolocationCoordinatesOverrideAsync(double latitude, double longitude, SetGeolocationCoordinatesOverrideOptions? options = null)
+    {
+        var coordinates = new GeolocationCoordinates(latitude, longitude, options?.Accuracy, options?.Altitude, options?.AltitudeAccuracy, options?.Heading, options?.Speed);
+
+        var @params = new SetGeolocationOverrideCoordinatesParameters(coordinates, options?.Contexts, options?.UserContexts);
+
+        return await Broker.ExecuteCommandAsync<SetGeolocationOverrideCommand, EmptyResult>(new SetGeolocationOverrideCommand(@params), options).ConfigureAwait(false);
+    }
+
+    public async Task<EmptyResult> SetGeolocationCoordinatesOverrideAsync(SetGeolocationOverrideOptions? options = null)
+    {
+        var @params = new SetGeolocationOverrideCoordinatesParameters(null, options?.Contexts, options?.UserContexts);
+
+        return await Broker.ExecuteCommandAsync<SetGeolocationOverrideCommand, EmptyResult>(new SetGeolocationOverrideCommand(@params), options).ConfigureAwait(false);
+    }
+
+    public async Task<EmptyResult> SetGeolocationPositionErrorOverrideAsync(SetGeolocationPositionErrorOverrideOptions? options = null)
+    {
+        var @params = new SetGeolocationOverridePositionErrorParameters(new GeolocationPositionError(), options?.Contexts, options?.UserContexts);
+
+        return await Broker.ExecuteCommandAsync<SetGeolocationOverrideCommand, EmptyResult>(new SetGeolocationOverrideCommand(@params), options).ConfigureAwait(false);
+    }
 }

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

@@ -0,0 +1,61 @@
+// <copyright file="SetGeolocationOverrideCommand.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 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 System.Collections.Generic;
+using System.Text.Json.Serialization;
+using OpenQA.Selenium.BiDi.Communication;
+
+namespace OpenQA.Selenium.BiDi.Emulation;
+
+internal sealed class SetGeolocationOverrideCommand(SetGeolocationOverrideParameters @params)
+    : Command<SetGeolocationOverrideParameters, EmptyResult>(@params, "emulation.setGeolocationOverride");
+
+[JsonDerivedType(typeof(SetGeolocationOverrideCoordinatesParameters))]
+[JsonDerivedType(typeof(SetGeolocationOverridePositionErrorParameters))]
+internal abstract record SetGeolocationOverrideParameters(IEnumerable<BrowsingContext.BrowsingContext>? Contexts, IEnumerable<Browser.UserContext>? UserContexts) : Parameters;
+
+internal sealed record SetGeolocationOverrideCoordinatesParameters([property: JsonIgnore(Condition = JsonIgnoreCondition.Never)] GeolocationCoordinates? Coordinates, IEnumerable<BrowsingContext.BrowsingContext>? Contexts, IEnumerable<Browser.UserContext>? UserContexts) : SetGeolocationOverrideParameters(Contexts, UserContexts);
+
+internal sealed record SetGeolocationOverridePositionErrorParameters(GeolocationPositionError Error, IEnumerable<BrowsingContext.BrowsingContext>? Contexts, IEnumerable<Browser.UserContext>? UserContexts) : SetGeolocationOverrideParameters(Contexts, UserContexts);
+
+internal sealed record GeolocationCoordinates(double Latitude, double Longitude, double? Accuracy, double? Altitude, double? AltitudeAccuracy, double? Heading, double? Speed);
+
+internal sealed record GeolocationPositionError
+{
+    [JsonInclude]
+    internal string Type { get; } = "positionUnavailable";
+}
+
+public class SetGeolocationOverrideOptions : CommandOptions
+{
+    public IEnumerable<BrowsingContext.BrowsingContext>? Contexts { get; set; }
+
+    public IEnumerable<Browser.UserContext>? UserContexts { get; set; }
+}
+
+public sealed class SetGeolocationCoordinatesOverrideOptions : SetGeolocationOverrideOptions
+{
+    public double? Accuracy { get; set; }
+    public double? Altitude { get; set; }
+    public double? AltitudeAccuracy { get; set; }
+    public double? Heading { get; set; }
+    public double? Speed { get; set; }
+}
+
+public sealed class SetGeolocationPositionErrorOverrideOptions : SetGeolocationOverrideOptions;

dotnet/test/common/BiDi/Emulation/EmulationTest.cs

@@ -26,43 +26,51 @@ class EmulationTest : BiDiTestFixture
     [Test]
     public void CanSetTimezoneOverride()
     {
-        Assert.That(async () => await bidi.Emulation.SetTimezoneOverrideAsync("UTC", new () { Contexts = [context] }), Throws.Nothing);
-        Assert.That(async () => await bidi.Emulation.SetTimezoneOverrideAsync(null, new () { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetTimezoneOverrideAsync("UTC", new() { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetTimezoneOverrideAsync(null, new() { Contexts = [context] }), Throws.Nothing);
     }
 
     [Test]
     public void CanSetUserAgentOverride()
     {
-        Assert.That(async () => await bidi.Emulation.SetUserAgentOverrideAsync("MyUserAgent/1.0", new () { Contexts = [context] }), Throws.Nothing);
-        Assert.That(async () => await bidi.Emulation.SetUserAgentOverrideAsync(null, new () { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetUserAgentOverrideAsync("MyUserAgent/1.0", new() { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetUserAgentOverrideAsync(null, new() { Contexts = [context] }), Throws.Nothing);
     }
 
     [Test]
     public void CanSetLocaleOverride()
     {
-        Assert.That(async () => await bidi.Emulation.SetLocaleOverrideAsync("en-US", new () { Contexts = [context] }), Throws.Nothing);
-        Assert.That(async () => await bidi.Emulation.SetLocaleOverrideAsync(null, new () { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetLocaleOverrideAsync("en-US", new() { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetLocaleOverrideAsync(null, new() { Contexts = [context] }), Throws.Nothing);
     }
 
     [Test]
     public void CanSetForcedColorsModeThemeOverride()
     {
-        Assert.That(async () => await bidi.Emulation.SetForcedColorsModeThemeOverrideAsync(ForcedColorsModeTheme.Light, new () { Contexts = [context] }), Throws.Nothing);
-        Assert.That(async () => await bidi.Emulation.SetForcedColorsModeThemeOverrideAsync(null, new () { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetForcedColorsModeThemeOverrideAsync(ForcedColorsModeTheme.Light, new() { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetForcedColorsModeThemeOverrideAsync(null, new() { Contexts = [context] }), Throws.Nothing);
     }
 
     [Test]
     public void CanSetScriptingEnabled()
     {
-        Assert.That(async () => await bidi.Emulation.SetScriptingEnabledAsync(false, new () { Contexts = [context] }), Throws.Nothing);
-        Assert.That(async () => await bidi.Emulation.SetScriptingEnabledAsync(null, new () { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetScriptingEnabledAsync(false, new() { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetScriptingEnabledAsync(null, new() { Contexts = [context] }), Throws.Nothing);
     }
 
     [Test]
     public void CanSetScreenOrientationOverride()
     {
         var orientation = new ScreenOrientation(ScreenOrientationNatural.Portrait, ScreenOrientationType.PortraitPrimary);
-        Assert.That(async () => await bidi.Emulation.SetScreenOrientationOverrideAsync(orientation, new () { Contexts = [context] }), Throws.Nothing);
-        Assert.That(async () => await bidi.Emulation.SetScreenOrientationOverrideAsync(null, new () { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetScreenOrientationOverrideAsync(orientation, new() { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetScreenOrientationOverrideAsync(null, new() { Contexts = [context] }), Throws.Nothing);
+    }
+
+    [Test]
+    public void CanSetGeolocationOverride()
+    {
+        Assert.That(async () => await bidi.Emulation.SetGeolocationCoordinatesOverrideAsync(0, 0, new() { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetGeolocationCoordinatesOverrideAsync(new() { Contexts = [context] }), Throws.Nothing);
+        Assert.That(async () => await bidi.Emulation.SetGeolocationPositionErrorOverrideAsync(new() { Contexts = [context] }), Throws.Nothing);
     }
 }