Open door to sequential input actions

Author: nvborisenko

dotnet/src/webdriver/BiDi/Communication/Json/Converters/Enumerable/InputSourceActionsConverter.cs

@@ -9,14 +9,14 @@
 
 namespace OpenQA.Selenium.BiDi.Communication.Json.Converters.Enumerable;
 
-internal class InputSourceActionsConverter : JsonConverter<ISourceActions>
+internal class InputSourceActionsConverter : JsonConverter<SourceActions>
 {
-    public override ISourceActions Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+    public override SourceActions Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
     {
         throw new NotImplementedException();
     }
 
-    public override void Write(Utf8JsonWriter writer, ISourceActions value, JsonSerializerOptions options)
+    public override void Write(Utf8JsonWriter writer, SourceActions value, JsonSerializerOptions options)
     {
         writer.WriteStartObject();
 

dotnet/src/webdriver/BiDi/Modules/BrowsingContext/BrowsingContextInputModule.cs

@@ -8,7 +8,7 @@ namespace OpenQA.Selenium.BiDi.Modules.BrowsingContext;
 
 public class BrowsingContextInputModule(BrowsingContext context, InputModule inputModule)
 {
-    public Task PerformActionsAsync(IEnumerable<ISourceActions> actions, PerformActionsOptions? options = null)
+    public Task PerformActionsAsync(IEnumerable<SourceActions> actions, PerformActionsOptions? options = null)
     {
         return inputModule.PerformActionsAsync(context, actions, options);
     }

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

@@ -8,7 +8,7 @@ namespace OpenQA.Selenium.BiDi.Modules.Input;
 
 public sealed class InputModule(Broker broker) : Module(broker)
 {
-    public async Task PerformActionsAsync(BrowsingContext.BrowsingContext context, IEnumerable<ISourceActions> actions, PerformActionsOptions? options = null)
+    public async Task PerformActionsAsync(BrowsingContext.BrowsingContext context, IEnumerable<SourceActions> actions, PerformActionsOptions? options = null)
     {
         var @params = new PerformActionsCommandParameters(context, actions);
 

dotnet/src/webdriver/BiDi/Modules/Input/Key.cs

@@ -0,0 +1,6 @@
+namespace OpenQA.Selenium.BiDi.Modules.Input;
+
+partial record Key
+{
+    public static char Shift { get; } = '\xE008';
+}

dotnet/src/webdriver/BiDi/Modules/Input/PerformActionsCommand.cs

@@ -7,6 +7,6 @@ namespace OpenQA.Selenium.BiDi.Modules.Input;
 
 internal class PerformActionsCommand(PerformActionsCommandParameters @params) : Command<PerformActionsCommandParameters>(@params);
 
-internal record PerformActionsCommandParameters(BrowsingContext.BrowsingContext Context, IEnumerable<ISourceActions> Actions) : CommandParameters;
+internal record PerformActionsCommandParameters(BrowsingContext.BrowsingContext Context, IEnumerable<SourceActions> Actions) : CommandParameters;
 
 public record PerformActionsOptions : CommandOptions;

dotnet/src/webdriver/BiDi/Modules/Input/SequentialSourceActions.cs

@@ -0,0 +1,68 @@
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace OpenQA.Selenium.BiDi.Modules.Input;
+
+public interface ISequentialSourceActions : IEnumerable<SourceActions>
+{
+    public SequentialSourceActions Type(string text);
+
+    public SequentialSourceActions KeyDown(char key);
+}
+
+public record SequentialSourceActions : ISequentialSourceActions
+{
+    private readonly KeyActions _keyActions = [];
+    private readonly PointerActions _pointerActions = [];
+    private readonly WheelActions _wheelActions = [];
+
+    public SequentialSourceActions Type(string text)
+    {
+        _keyActions.Type(text);
+
+        return Normalized();
+    }
+
+    public SequentialSourceActions KeyDown(char key)
+    {
+        _keyActions.Add(new Key.Down(key));
+
+        return Normalized();
+    }
+
+    private SequentialSourceActions Normalized()
+    {
+        var max = new[] { _keyActions.Count(), _pointerActions.Count(), _wheelActions.Count() }.Max();
+
+        for (int i = _keyActions.Count(); i < max; i++)
+        {
+            _keyActions.Add(new Key.Pause());
+        }
+
+        for (int i = _pointerActions.Count(); i < max; i++)
+        {
+            _pointerActions.Add(new Pointer.Pause());
+        }
+
+        for (int i = _wheelActions.Count(); i < max; i++)
+        {
+            _wheelActions.Add(new Pointer.Pause());
+        }
+
+        return this;
+    }
+
+    public IEnumerator<SourceActions> GetEnumerator()
+    {
+        var sourceActions = new List<SourceActions>
+        {
+            _keyActions,
+            _pointerActions,
+            _wheelActions
+        };
+        return sourceActions.GetEnumerator();
+    }
+
+    IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
+}

dotnet/src/webdriver/BiDi/Modules/Input/SourceActions.cs

@@ -7,18 +7,14 @@
 
 namespace OpenQA.Selenium.BiDi.Modules.Input;
 
-public interface ISourceActions
+public abstract record SourceActions
 {
-    string Id { get; }
-
-    IList<ISourceAction> Actions { get; }
+    public string Id { get; } = Guid.NewGuid().ToString();
 }
 
-public abstract record SourceActions<T> : ISourceActions, IEnumerable<ISourceAction>
+public record SourceActions<T> : SourceActions, IEnumerable<ISourceAction> where T : ISourceAction
 {
-    public string Id { get; } = Guid.NewGuid().ToString();
-
-    public IList<ISourceAction> Actions { get; } = [];
+    public IList<ISourceAction> Actions { get; set; } = [];
 
     public IEnumerator<ISourceAction> GetEnumerator() => Actions.GetEnumerator();
 
@@ -27,9 +23,21 @@ public abstract record SourceActions<T> : ISourceActions, IEnumerable<ISourceAct
     public void Add(ISourceAction action) => Actions.Add(action);
 }
 
-public record KeyActions : SourceActions<Key>, ISourceActions;
+public record KeyActions : SourceActions<Key>
+{
+    public KeyActions Type(string text)
+    {
+        foreach (var character in text)
+        {
+            Add(new Key.Down(character));
+            Add(new Key.Up(character));
+        }
+
+        return this;
+    }
+}
 
-public record PointerActions : SourceActions<Pointer>, ISourceActions
+public record PointerActions : SourceActions<Pointer>
 {
     public PointerParameters? Options { get; set; }
 }
@@ -44,16 +52,16 @@ public interface ISourceAction;
 [JsonDerivedType(typeof(Pause), "pause")]
 [JsonDerivedType(typeof(Down), "keyDown")]
 [JsonDerivedType(typeof(Up), "keyUp")]
-public abstract record Key : ISourceAction
+public abstract partial record Key : ISourceAction
 {
     public record Pause : Key
     {
         public long? Duration { get; set; }
     }
 
-    public record Down(string Value) : Key;
+    public record Down(char Value) : Key;
 
-    public record Up(string Value) : Key;
+    public record Up(char Value) : Key;
 }
 
 [JsonPolymorphic(TypeDiscriminatorPropertyName = "type")]

dotnet/test/common/BiDi/Input/CombinedInputActionsTest.cs

@@ -22,8 +22,8 @@ await context.Input.PerformActionsAsync([new PointerActions {
         }]);
 
         await context.Input.PerformActionsAsync([new KeyActions {
-            new Key.Down("U"),
-            new Key.Up("U")
+            new Key.Down('U'),
+            new Key.Up('U')
         }]);
 
         await context.Input.PerformActionsAsync([new PointerActions {

dotnet/test/common/BiDi/Input/DefaultMouseTest.cs

@@ -1,4 +1,5 @@
 using NUnit.Framework;
+using OpenQA.Selenium.BiDi.Modules.BrowsingContext;
 using OpenQA.Selenium.BiDi.Modules.Input;
 using System.Threading.Tasks;
 
@@ -16,16 +17,16 @@ await context.Input.PerformActionsAsync([
             {
                 Actions =
                 {
-                    new Key.Down("A"),
-                    new Key.Up("B")
+                    new Key.Down('A'),
+                    new Key.Up('B')
                 }
             }
             ]);
 
         await context.Input.PerformActionsAsync([new KeyActions
         {
-            new Key.Down("A"),
-            new Key.Down("B"),
+            new Key.Down('A'),
+            new Key.Down('B'),
             new Key.Pause()
         }]);
 
@@ -35,4 +36,14 @@ await context.Input.PerformActionsAsync([new PointerActions
             new Pointer.Up(0),
         }]);
     }
+
+    //[Test]
+    public async Task PerformCombined()
+    {
+        await context.NavigateAsync("https://nuget.org", new() { Wait = ReadinessState.Complete });
+        
+        await context.Input.PerformActionsAsync(new SequentialSourceActions().Type("Hello").KeyDown(Key.Shift).Type("World"));
+
+        await Task.Delay(3000);
+    }
 }