[dotnet] [bidi] Do not throw when CallFunction or Evaluate return exceptional result (breaking change)

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

@@ -44,7 +44,7 @@ public async Task<IReadOnlyList<RealmInfo>> GetRealmsAsync(GetRealmsOptions? opt
         return await scriptModule.GetRealmsAsync(options).ConfigureAwait(false);
     }
 
-    public Task<EvaluateResultSuccess> EvaluateAsync(string expression, bool awaitPromise, EvaluateOptions? options = null, ContextTargetOptions? targetOptions = null)
+    public Task<EvaluateResult> EvaluateAsync(string expression, bool awaitPromise, EvaluateOptions? options = null, ContextTargetOptions? targetOptions = null)
     {
         var contextTarget = new ContextTarget(context);
 
@@ -60,10 +60,10 @@ public Task<EvaluateResultSuccess> EvaluateAsync(string expression, bool awaitPr
     {
         var result = await EvaluateAsync(expression, awaitPromise, options, targetOptions).ConfigureAwait(false);
 
-        return result.Result.ConvertTo<TResult>();
+        return result.AsSuccessResult().ConvertTo<TResult>();
     }
 
-    public Task<EvaluateResultSuccess> CallFunctionAsync(string functionDeclaration, bool awaitPromise, CallFunctionOptions? options = null, ContextTargetOptions? targetOptions = null)
+    public Task<EvaluateResult> CallFunctionAsync(string functionDeclaration, bool awaitPromise, CallFunctionOptions? options = null, ContextTargetOptions? targetOptions = null)
     {
         var contextTarget = new ContextTarget(context);
 
@@ -79,6 +79,6 @@ public Task<EvaluateResultSuccess> CallFunctionAsync(string functionDeclaration,
     {
         var result = await CallFunctionAsync(functionDeclaration, awaitPromise, options, targetOptions).ConfigureAwait(false);
 
-        return result.Result.ConvertTo<TResult>();
+        return result.AsSuccessResult().ConvertTo<TResult>();
     }
 }

dotnet/src/webdriver/BiDi/Modules/Script/EvaluateCommand.cs

@@ -18,6 +18,7 @@
 // </copyright>
 
 using OpenQA.Selenium.BiDi.Communication;
+using System;
 
 namespace OpenQA.Selenium.BiDi.Modules.Script;
 
@@ -39,7 +40,20 @@ public record EvaluateOptions : CommandOptions
 //[JsonPolymorphic(TypeDiscriminatorPropertyName = "type")]
 //[JsonDerivedType(typeof(EvaluateResultSuccess), "success")]
 //[JsonDerivedType(typeof(EvaluateResultException), "exception")]
-public abstract record EvaluateResult;
+public abstract record EvaluateResult
+{
+    public RemoteValue AsSuccessResult()
+    {
+        if (this is EvaluateResultSuccess success)
+        {
+            return success.Result;
+        }
+
+        var exceptionResult = (EvaluateResultException)this;
+
+        throw new BiDiException(exceptionResult.ExceptionDetails.FormatException());
+    }
+}
 
 public record EvaluateResultSuccess(RemoteValue Result, Realm Realm) : EvaluateResult
 {
@@ -48,4 +62,10 @@ public record EvaluateResultSuccess(RemoteValue Result, Realm Realm) : EvaluateR
 
 public record EvaluateResultException(ExceptionDetails ExceptionDetails, Realm Realm) : EvaluateResult;
 
-public record ExceptionDetails(long ColumnNumber, long LineNumber, StackTrace StackTrace, string Text);
+public record ExceptionDetails(long ColumnNumber, long LineNumber, StackTrace StackTrace, string Text)
+{
+    public string FormatException()
+    {
+        return $"{Text} ({LineNumber},{ColumnNumber}){StackTrace.FormatStackTrace(indent: 2)}";
+    }
+}

dotnet/src/webdriver/BiDi/Modules/Script/LocalValue.cs

@@ -160,9 +160,9 @@ public record BigIntLocalValue(string Value) : PrimitiveProtocolLocalValue;
 
 public record ChannelLocalValue(ChannelProperties Value) : LocalValue
 {
-    // TODO: Revise why we need it
+    // AddPreloadScript takes arguments typed as ChannelLocalValue but still requires "type":"channel"
     [JsonInclude]
-    internal string type = "channel";
+    internal string Type => "channel";
 }
 
 public record ArrayLocalValue(IEnumerable<LocalValue> Value) : LocalValue;

dotnet/src/webdriver/BiDi/Modules/Script/ScriptModule.cs

@@ -25,46 +25,36 @@ namespace OpenQA.Selenium.BiDi.Modules.Script;
 
 public sealed class ScriptModule(Broker broker) : Module(broker)
 {
-    public async Task<EvaluateResultSuccess> EvaluateAsync(string expression, bool awaitPromise, Target target, EvaluateOptions? options = null)
+    public async Task<EvaluateResult> EvaluateAsync(string expression, bool awaitPromise, Target target, EvaluateOptions? options = null)
     {
         var @params = new EvaluateCommandParameters(expression, target, awaitPromise, options?.ResultOwnership, options?.SerializationOptions, options?.UserActivation);
 
         var result = await Broker.ExecuteCommandAsync<EvaluateCommand, EvaluateResult>(new EvaluateCommand(@params), options).ConfigureAwait(false);
 
-        if (result is EvaluateResultException exp)
-        {
-            throw new ScriptEvaluateException(exp);
-        }
-
-        return (EvaluateResultSuccess)result;
+        return result;
     }
 
     public async Task<TResult?> EvaluateAsync<TResult>(string expression, bool awaitPromise, Target target, EvaluateOptions? options = null)
     {
         var result = await EvaluateAsync(expression, awaitPromise, target, options).ConfigureAwait(false);
 
-        return result.Result.ConvertTo<TResult>();
+        return result.AsSuccessResult().ConvertTo<TResult>();
     }
 
-    public async Task<EvaluateResultSuccess> CallFunctionAsync(string functionDeclaration, bool awaitPromise, Target target, CallFunctionOptions? options = null)
+    public async Task<EvaluateResult> CallFunctionAsync(string functionDeclaration, bool awaitPromise, Target target, CallFunctionOptions? options = null)
     {
         var @params = new CallFunctionCommandParameters(functionDeclaration, awaitPromise, target, options?.Arguments, options?.ResultOwnership, options?.SerializationOptions, options?.This, options?.UserActivation);
 
         var result = await Broker.ExecuteCommandAsync<CallFunctionCommand, EvaluateResult>(new CallFunctionCommand(@params), options).ConfigureAwait(false);
 
-        if (result is EvaluateResultException exp)
-        {
-            throw new ScriptEvaluateException(exp);
-        }
-
-        return (EvaluateResultSuccess)result;
+        return result;
     }
 
     public async Task<TResult?> CallFunctionAsync<TResult>(string functionDeclaration, bool awaitPromise, Target target, CallFunctionOptions? options = null)
     {
         var result = await CallFunctionAsync(functionDeclaration, awaitPromise, target, options).ConfigureAwait(false);
 
-        return result.Result.ConvertTo<TResult>();
+        return result.AsSuccessResult().ConvertTo<TResult>();
     }
 
     public async Task<GetRealmsResult> GetRealmsAsync(GetRealmsOptions? options = null)

dotnet/src/webdriver/BiDi/Modules/Script/StackFrame.cs

@@ -19,4 +19,15 @@
 
 namespace OpenQA.Selenium.BiDi.Modules.Script;
 
-public record StackFrame(long LineNumber, long ColumnNumber, string Url, string FunctionName);
+public record StackFrame(long LineNumber, long ColumnNumber, string Url, string FunctionName)
+{
+    public string FormatStackFrame()
+    {
+        if (string.IsNullOrEmpty(FunctionName))
+        {
+            return $"({LineNumber},{ColumnNumber}) {Url}";
+        }
+
+        return $"{FunctionName} ({LineNumber},{ColumnNumber}) {Url}";
+    }
+}

dotnet/src/webdriver/BiDi/Modules/Script/StackTrace.cs

@@ -17,8 +17,27 @@
 // under the License.
 // </copyright>
 
+using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace OpenQA.Selenium.BiDi.Modules.Script;
 
-public record StackTrace(IReadOnlyCollection<StackFrame> CallFrames);
+public record StackTrace(IReadOnlyList<StackFrame> CallFrames)
+{
+    public string FormatStackTrace(int indent)
+    {
+        if (CallFrames.Count == 0)
+        {
+            return string.Empty;
+        }
+
+        const string Preamble = "---> ";
+
+        string firstLineIndentString = Environment.NewLine + new string(' ', indent);
+        string firstLine = firstLineIndentString + Preamble + CallFrames[0].FormatStackFrame();
+
+        string indentString = Environment.NewLine + new string(' ', indent + Preamble.Length);
+        return firstLine + indentString + string.Join(indentString, CallFrames.Skip(1).Select(frame => frame.FormatStackFrame()));
+    }
+}