SetScreenOrientation

Author: nvborisenko

dotnet/src/webdriver/BiDi/Communication/Broker.cs

@@ -84,6 +84,7 @@ internal Broker(BiDi bidi, Uri url)
                 new PreloadScriptConverter(_bidi),
                 new RealmConverter(_bidi),
                 new RealmTypeConverter(),
+                new ScreenOrientationTypeConverter(),
                 new DateTimeOffsetConverter(),
                 new PrintPageRangeConverter(),
                 new InputOriginConverter(),

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

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

dotnet/src/webdriver/BiDi/Communication/Json/Converters/ScreenOrientationTypeConverter.cs

@@ -0,0 +1,55 @@
+// <copyright file="ScreenOrientationTypeConverter.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 System;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using OpenQA.Selenium.BiDi.Emulation;
+
+namespace OpenQA.Selenium.BiDi.Communication.Json.Converters;
+
+internal class ScreenOrientationTypeConverter : JsonConverter<ScreenOrientationType>
+{
+    public override ScreenOrientationType Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+    {
+        var str = reader.GetString();
+        return str switch
+        {
+            "portrait-primary" => ScreenOrientationType.PortraitPrimary,
+            "portrait-secondary" => ScreenOrientationType.PortraitSecondary,
+            "landscape-primary" => ScreenOrientationType.LandscapePrimary,
+            "landscape-secondary" => ScreenOrientationType.LandscapeSecondary,
+            _ => throw new JsonException($"Unrecognized '{str}' value of {typeof(ScreenOrientationType)}."),
+        };
+    }
+
+    public override void Write(Utf8JsonWriter writer, ScreenOrientationType value, JsonSerializerOptions options)
+    {
+        var str = value switch
+        {
+            ScreenOrientationType.PortraitPrimary => "portrait-primary",
+            ScreenOrientationType.PortraitSecondary => "portrait-secondary",
+            ScreenOrientationType.LandscapePrimary => "landscape-primary",
+            ScreenOrientationType.LandscapeSecondary => "landscape-secondary",
+            _ => throw new JsonException($"Unrecognized '{value}' value of {typeof(ScreenOrientationType)}."),
+        };
+
+        writer.WriteStringValue(str);
+    }
+}

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

@@ -58,4 +58,11 @@ public async Task<EmptyResult> SetScriptingEnabledAsync(bool? enabled, SetScript
 
         return await Broker.ExecuteCommandAsync<SetScriptingEnabledCommand, EmptyResult>(new SetScriptingEnabledCommand(@params), options).ConfigureAwait(false);
     }
+
+    public async Task<EmptyResult> SetScreenOrientationOverrideAsync(ScreenOrientation? screenOrientation, SetScreenOrientationOverrideOptions? options = null)
+    {
+        var @params = new SetScreenOrientationOverrideParameters(screenOrientation, options?.Contexts, options?.UserContexts);
+
+        return await Broker.ExecuteCommandAsync<SetScreenOrientationOverrideCommand, EmptyResult>(new SetScreenOrientationOverrideCommand(@params), options).ConfigureAwait(false);
+    }
 }

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

@@ -0,0 +1,52 @@
+// <copyright file="SetScreenOrientationOverrideCommand.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 System.Collections.Generic;
+using System.Text.Json.Serialization;
+using OpenQA.Selenium.BiDi.Communication;
+
+namespace OpenQA.Selenium.BiDi.Emulation;
+
+internal sealed class SetScreenOrientationOverrideCommand(SetScreenOrientationOverrideParameters @params)
+    : Command<SetScreenOrientationOverrideParameters, EmptyResult>(@params, "emulation.setScreenOrientationOverride");
+
+internal sealed record SetScreenOrientationOverrideParameters([property: JsonIgnore(Condition = JsonIgnoreCondition.Never)] ScreenOrientation? ScreenOrientation, IEnumerable<BrowsingContext.BrowsingContext>? Contexts, IEnumerable<Browser.UserContext>? UserContexts) : Parameters;
+
+public sealed class SetScreenOrientationOverrideOptions : CommandOptions
+{
+    public IEnumerable<BrowsingContext.BrowsingContext>? Contexts { get; set; }
+
+    public IEnumerable<Browser.UserContext>? UserContexts { get; set; }
+}
+
+public enum ScreenOrientationNatural
+{
+    Portrait,
+    Landscape
+}
+
+public enum ScreenOrientationType
+{
+    PortraitPrimary,
+    PortraitSecondary,
+    LandscapePrimary,
+    LandscapeSecondary
+}
+
+public sealed record ScreenOrientation(ScreenOrientationNatural Natural, ScreenOrientationType Type);

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

@@ -57,4 +57,12 @@ 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);
     }
+
+    [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);
+    }
 }