[dotnet] [bidi] Specific result type for any command (#16405)

Author: nvborisenko

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

@@ -24,28 +24,28 @@ namespace OpenQA.Selenium.BiDi.Browser;
 
 public sealed class BrowserModule : Module
 {
-    public async Task<EmptyResult> CloseAsync(CloseOptions? options = null)
+    public async Task<CloseResult> CloseAsync(CloseOptions? options = null)
     {
-        return await Broker.ExecuteCommandAsync(new CloseCommand(), options, JsonContext.Browser_CloseCommand, JsonContext.EmptyResult).ConfigureAwait(false);
+        return await Broker.ExecuteCommandAsync(new CloseCommand(), options, JsonContext.Browser_CloseCommand, JsonContext.Browser_CloseResult).ConfigureAwait(false);
     }
 
-    public async Task<UserContextInfo> CreateUserContextAsync(CreateUserContextOptions? options = null)
+    public async Task<CreateUserContextResult> CreateUserContextAsync(CreateUserContextOptions? options = null)
     {
         var @params = new CreateUserContextParameters(options?.AcceptInsecureCerts, options?.Proxy, options?.UnhandledPromptBehavior);
 
-        return await Broker.ExecuteCommandAsync(new CreateUserContextCommand(@params), options, JsonContext.CreateUserContextCommand, JsonContext.UserContextInfo).ConfigureAwait(false);
+        return await Broker.ExecuteCommandAsync(new CreateUserContextCommand(@params), options, JsonContext.CreateUserContextCommand, JsonContext.CreateUserContextResult).ConfigureAwait(false);
     }
 
     public async Task<GetUserContextsResult> GetUserContextsAsync(GetUserContextsOptions? options = null)
     {
         return await Broker.ExecuteCommandAsync(new GetUserContextsCommand(), options, JsonContext.GetUserContextsCommand, JsonContext.GetUserContextsResult).ConfigureAwait(false);
     }
 
-    public async Task<EmptyResult> RemoveUserContextAsync(UserContext userContext, RemoveUserContextOptions? options = null)
+    public async Task<RemoveUserContextResult> RemoveUserContextAsync(UserContext userContext, RemoveUserContextOptions? options = null)
     {
         var @params = new RemoveUserContextParameters(userContext);
 
-        return await Broker.ExecuteCommandAsync(new RemoveUserContextCommand(@params), options, JsonContext.RemoveUserContextCommand, JsonContext.EmptyResult).ConfigureAwait(false);
+        return await Broker.ExecuteCommandAsync(new RemoveUserContextCommand(@params), options, JsonContext.RemoveUserContextCommand, JsonContext.RemoveUserContextResult).ConfigureAwait(false);
     }
 
     public async Task<GetClientWindowsResult> GetClientWindowsAsync(GetClientWindowsOptions? options = null)
@@ -54,24 +54,24 @@ public async Task<GetClientWindowsResult> GetClientWindowsAsync(GetClientWindows
             ).ConfigureAwait(false);
     }
 
-    public async Task<EmptyResult> SetDownloadBehaviorAllowedAsync(string destinationFolder, SetDownloadBehaviorOptions? options = null)
+    public async Task<SetDownloadBehaviorResult> SetDownloadBehaviorAllowedAsync(string destinationFolder, SetDownloadBehaviorOptions? options = null)
     {
         var @params = new SetDownloadBehaviorParameters(new DownloadBehaviorAllowed(destinationFolder), options?.UserContexts);
 
-        return await Broker.ExecuteCommandAsync(new SetDownloadBehaviorCommand(@params), options, JsonContext.SetDownloadBehaviorCommand, JsonContext.EmptyResult).ConfigureAwait(false);
+        return await Broker.ExecuteCommandAsync(new SetDownloadBehaviorCommand(@params), options, JsonContext.SetDownloadBehaviorCommand, JsonContext.SetDownloadBehaviorResult).ConfigureAwait(false);
     }
 
-    public async Task<EmptyResult> SetDownloadBehaviorAllowedAsync(SetDownloadBehaviorOptions? options = null)
+    public async Task<SetDownloadBehaviorResult> SetDownloadBehaviorAllowedAsync(SetDownloadBehaviorOptions? options = null)
     {
         var @params = new SetDownloadBehaviorParameters(null, options?.UserContexts);
 
-        return await Broker.ExecuteCommandAsync(new SetDownloadBehaviorCommand(@params), options, JsonContext.SetDownloadBehaviorCommand, JsonContext.EmptyResult).ConfigureAwait(false);
+        return await Broker.ExecuteCommandAsync(new SetDownloadBehaviorCommand(@params), options, JsonContext.SetDownloadBehaviorCommand, JsonContext.SetDownloadBehaviorResult).ConfigureAwait(false);
     }
 
-    public async Task<EmptyResult> SetDownloadBehaviorDeniedAsync(SetDownloadBehaviorOptions? options = null)
+    public async Task<SetDownloadBehaviorResult> SetDownloadBehaviorDeniedAsync(SetDownloadBehaviorOptions? options = null)
     {
         var @params = new SetDownloadBehaviorParameters(new DownloadBehaviorDenied(), options?.UserContexts);
 
-        return await Broker.ExecuteCommandAsync(new SetDownloadBehaviorCommand(@params), options, JsonContext.SetDownloadBehaviorCommand, JsonContext.EmptyResult).ConfigureAwait(false);
+        return await Broker.ExecuteCommandAsync(new SetDownloadBehaviorCommand(@params), options, JsonContext.SetDownloadBehaviorCommand, JsonContext.SetDownloadBehaviorResult).ConfigureAwait(false);
     }
 }

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

@@ -22,6 +22,8 @@
 namespace OpenQA.Selenium.BiDi.Browser;
 
 internal sealed class CloseCommand()
-    : Command<Parameters, EmptyResult>(Parameters.Empty, "browser.close");
+    : Command<Parameters, CloseResult>(Parameters.Empty, "browser.close");
 
 public sealed class CloseOptions : CommandOptions;
+
+public sealed record CloseResult : EmptyResult;

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

@@ -22,7 +22,7 @@
 namespace OpenQA.Selenium.BiDi.Browser;
 
 internal sealed class CreateUserContextCommand(CreateUserContextParameters @params)
-    : Command<CreateUserContextParameters, UserContextInfo>(@params, "browser.createUserContext");
+    : Command<CreateUserContextParameters, CreateUserContextResult>(@params, "browser.createUserContext");
 
 internal sealed record CreateUserContextParameters(bool? AcceptInsecureCerts, Session.ProxyConfiguration? Proxy, Session.UserPromptHandler? UnhandledPromptBehavior) : Parameters;
 
@@ -34,3 +34,5 @@ public sealed class CreateUserContextOptions : CommandOptions
 
     public Session.UserPromptHandler? UnhandledPromptBehavior { get; set; }
 }
+
+public sealed record CreateUserContextResult(UserContext UserContext) : UserContextInfo(UserContext);

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

@@ -44,8 +44,6 @@ internal GetClientWindowsResult(IReadOnlyList<ClientWindowInfo> clientWindows)
 
     public int Count => ClientWindows.Count;
 
-
-
     public IEnumerator<ClientWindowInfo> GetEnumerator() => ClientWindows.GetEnumerator();
 
     IEnumerator IEnumerable.GetEnumerator() => (ClientWindows as IEnumerable).GetEnumerator();

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

@@ -22,8 +22,10 @@
 namespace OpenQA.Selenium.BiDi.Browser;
 
 internal sealed class RemoveUserContextCommand(RemoveUserContextParameters @params)
-    : Command<RemoveUserContextParameters, EmptyResult>(@params, "browser.removeUserContext");
+    : Command<RemoveUserContextParameters, RemoveUserContextResult>(@params, "browser.removeUserContext");
 
 internal sealed record RemoveUserContextParameters(UserContext UserContext) : Parameters;
 
 public sealed class RemoveUserContextOptions : CommandOptions;
+
+public sealed record RemoveUserContextResult : EmptyResult;

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

@@ -24,7 +24,7 @@
 namespace OpenQA.Selenium.BiDi.Browser;
 
 internal sealed class SetDownloadBehaviorCommand(SetDownloadBehaviorParameters @params)
-    : Command<SetDownloadBehaviorParameters, EmptyResult>(@params, "browser.setDownloadBehavior");
+    : Command<SetDownloadBehaviorParameters, SetDownloadBehaviorResult>(@params, "browser.setDownloadBehavior");
 
 internal sealed record SetDownloadBehaviorParameters([property: JsonIgnore(Condition = JsonIgnoreCondition.Never)] DownloadBehavior? DownloadBehavior, IEnumerable<UserContext>? UserContexts) : Parameters;
 
@@ -41,3 +41,5 @@ public sealed class SetDownloadBehaviorOptions : CommandOptions
 {
     public IEnumerable<UserContext>? UserContexts { get; set; }
 }
+
+public sealed record SetDownloadBehaviorResult : EmptyResult;

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

@@ -21,4 +21,4 @@
 
 namespace OpenQA.Selenium.BiDi.Browser;
 
-public sealed record UserContextInfo(UserContext UserContext) : EmptyResult;
+public record UserContextInfo(UserContext UserContext) : EmptyResult;

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

@@ -22,8 +22,10 @@
 namespace OpenQA.Selenium.BiDi.BrowsingContext;
 
 internal sealed class ActivateCommand(ActivateParameters @params)
-    : Command<ActivateParameters, EmptyResult>(@params, "browsingContext.activate");
+    : Command<ActivateParameters, ActivateResult>(@params, "browsingContext.activate");
 
 internal sealed record ActivateParameters(BrowsingContext Context) : Parameters;
 
 public sealed class ActivateOptions : CommandOptions;
+
+public sealed record ActivateResult : EmptyResult;

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

@@ -62,12 +62,12 @@ public Task<NavigateResult> NavigateAsync(string url, NavigateOptions? options =
         return BiDi.BrowsingContext.NavigateAsync(this, url, options);
     }
 
-    public Task<NavigateResult> ReloadAsync(ReloadOptions? options = null)
+    public Task<ReloadResult> ReloadAsync(ReloadOptions? options = null)
     {
         return BiDi.BrowsingContext.ReloadAsync(this, options);
     }
 
-    public Task<EmptyResult> ActivateAsync(ActivateOptions? options = null)
+    public Task<ActivateResult> ActivateAsync(ActivateOptions? options = null)
     {
         return BiDi.BrowsingContext.ActivateAsync(this, options);
     }
@@ -82,7 +82,7 @@ public Task<CaptureScreenshotResult> CaptureScreenshotAsync(CaptureScreenshotOpt
         return BiDi.BrowsingContext.CaptureScreenshotAsync(this, options);
     }
 
-    public Task<EmptyResult> CloseAsync(CloseOptions? options = null)
+    public Task<CloseResult> CloseAsync(CloseOptions? options = null)
     {
         return BiDi.BrowsingContext.CloseAsync(this, options);
     }
@@ -92,7 +92,7 @@ public Task<TraverseHistoryResult> TraverseHistoryAsync(int delta, TraverseHisto
         return BiDi.BrowsingContext.TraverseHistoryAsync(this, delta, options);
     }
 
-    public Task<EmptyResult> SetViewportAsync(SetViewportOptions? options = null)
+    public Task<SetViewportResult> SetViewportAsync(SetViewportOptions? options = null)
     {
         return BiDi.BrowsingContext.SetViewportAsync(this, options);
     }
@@ -102,7 +102,7 @@ public Task<PrintResult> PrintAsync(PrintOptions? options = null)
         return BiDi.BrowsingContext.PrintAsync(this, options);
     }
 
-    public Task<EmptyResult> HandleUserPromptAsync(HandleUserPromptOptions? options = null)
+    public Task<HandleUserPromptResult> HandleUserPromptAsync(HandleUserPromptOptions? options = null)
     {
         return BiDi.BrowsingContext.HandleUserPromptAsync(this, options);
     }

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

@@ -20,23 +20,22 @@
 using System.Threading.Tasks;
 using OpenQA.Selenium.BiDi.Input;
 using System.Collections.Generic;
-using OpenQA.Selenium.BiDi.Communication;
 
 namespace OpenQA.Selenium.BiDi.BrowsingContext;
 
 public sealed class BrowsingContextInputModule(BrowsingContext context, InputModule inputModule)
 {
-    public Task<EmptyResult> PerformActionsAsync(IEnumerable<SourceActions> actions, PerformActionsOptions? options = null)
+    public Task<PerformActionsResult> PerformActionsAsync(IEnumerable<SourceActions> actions, PerformActionsOptions? options = null)
     {
         return inputModule.PerformActionsAsync(context, actions, options);
     }
 
-    public Task<EmptyResult> ReleaseActionsAsync(ReleaseActionsOptions? options = null)
+    public Task<ReleaseActionsResult> ReleaseActionsAsync(ReleaseActionsOptions? options = null)
     {
         return inputModule.ReleaseActionsAsync(context, options);
     }
 
-    public Task<EmptyResult> SetFilesAsync(Script.ISharedReference element, IEnumerable<string> files, SetFilesOptions? options = null)
+    public Task<SetFilesResult> SetFilesAsync(Script.ISharedReference element, IEnumerable<string> files, SetFilesOptions? options = null)
     {
         return inputModule.SetFilesAsync(context, element, files, options);
     }