[dotnet] Annotate nullability on JavaScript protocol (#15238)

RenderMichael · web-flow · commit 572b0879752b · 2025-02-06T00:18:18.000-05:00
diff --git a/dotnet/src/webdriver/DevTools/JavaScript.cs b/dotnet/src/webdriver/DevTools/JavaScript.cs
@@ -20,6 +20,8 @@
 using System;
 using System.Threading.Tasks;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools
 {
     /// <summary>
@@ -30,17 +32,17 @@ public abstract class JavaScript
         /// <summary>
         /// Occurs when a JavaScript script binding is called.
         /// </summary>
-        public event EventHandler<BindingCalledEventArgs> BindingCalled;
+        public event EventHandler<BindingCalledEventArgs>? BindingCalled;
 
         /// <summary>
         /// Occurs when the browser's JavaScript console API is called.
         /// </summary>
-        public event EventHandler<ConsoleApiCalledEventArgs> ConsoleApiCalled;
+        public event EventHandler<ConsoleApiCalledEventArgs>? ConsoleApiCalled;
 
         /// <summary>
         /// Occurs when a JavaScript exception is thrown.
         /// </summary>
-        public event EventHandler<ExceptionThrownEventArgs> ExceptionThrown;
+        public event EventHandler<ExceptionThrownEventArgs>? ExceptionThrown;
 
         /// <summary>
         /// Asynchronously enables the Runtime domain in the DevTools Protocol.
diff --git a/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs b/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs
@@ -23,25 +23,28 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools.V130
 {
     /// <summary>
     /// Class containing the JavaScript implementation for version 130 of the DevTools Protocol.
     /// </summary>
     public class V130JavaScript : JavaScript
     {
-        private RuntimeAdapter runtime;
-        private PageAdapter page;
+        private readonly RuntimeAdapter runtime;
+        private readonly PageAdapter page;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="V130JavaScript"/> class.
         /// </summary>
         /// <param name="runtime">The DevTools Protocol adapter for the Runtime domain.</param>
         /// <param name="page">The DevTools Protocol adapter for the Page domain.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="runtime"/> or <paramref name="page"/> are <see langword="null"/>.</exception>
         public V130JavaScript(RuntimeAdapter runtime, PageAdapter page)
         {
-            this.runtime = runtime;
-            this.page = page;
+            this.runtime = runtime ?? throw new ArgumentNullException(nameof(runtime));
+            this.page = page ?? throw new ArgumentNullException(nameof(page));
             this.runtime.BindingCalled += OnRuntimeBindingCalled;
             this.runtime.ConsoleAPICalled += OnRuntimeConsoleApiCalled;
             this.runtime.ExceptionThrown += OnRuntimeExceptionThrown;
@@ -138,7 +141,7 @@ internal override async Task Evaluate(string script)
             await runtime.Evaluate(new EvaluateCommandSettings { Expression = script }).ConfigureAwait(false);
         }
 
-        private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArgs e)
+        private void OnRuntimeBindingCalled(object? sender, Runtime.BindingCalledEventArgs e)
         {
             BindingCalledEventArgs wrapped = new BindingCalledEventArgs
             (
@@ -150,7 +153,7 @@ private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArg
             this.OnBindingCalled(wrapped);
         }
 
-        private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEventArgs e)
+        private void OnRuntimeExceptionThrown(object? sender, Runtime.ExceptionThrownEventArgs e)
         {
             // TODO: Collect stack trace elements
             var wrapped = new ExceptionThrownEventArgs
@@ -162,12 +165,12 @@ private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEven
             this.OnExceptionThrown(wrapped);
         }
 
-        private void OnRuntimeConsoleApiCalled(object sender, ConsoleAPICalledEventArgs e)
+        private void OnRuntimeConsoleApiCalled(object? sender, ConsoleAPICalledEventArgs e)
         {
-            List<ConsoleApiArgument> args = new List<ConsoleApiArgument>();
+            List<ConsoleApiArgument> args = new List<ConsoleApiArgument>(e.Args.Length);
             foreach (var arg in e.Args)
             {
-                string argValue = arg.Value?.ToString();
+                string? argValue = arg.Value?.ToString();
                 args.Add(new ConsoleApiArgument(arg.Type.ToString(), argValue));
             }
 
diff --git a/dotnet/src/webdriver/DevTools/v131/V131JavaScript.cs b/dotnet/src/webdriver/DevTools/v131/V131JavaScript.cs
@@ -23,25 +23,28 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools.V131
 {
     /// <summary>
     /// Class containing the JavaScript implementation for version 131 of the DevTools Protocol.
     /// </summary>
     public class V131JavaScript : JavaScript
     {
-        private RuntimeAdapter runtime;
-        private PageAdapter page;
+        private readonly RuntimeAdapter runtime;
+        private readonly PageAdapter page;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="V131JavaScript"/> class.
         /// </summary>
         /// <param name="runtime">The DevTools Protocol adapter for the Runtime domain.</param>
         /// <param name="page">The DevTools Protocol adapter for the Page domain.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="runtime"/> or <paramref name="page"/> are <see langword="null"/>.</exception>
         public V131JavaScript(RuntimeAdapter runtime, PageAdapter page)
         {
-            this.runtime = runtime;
-            this.page = page;
+            this.runtime = runtime ?? throw new ArgumentNullException(nameof(runtime));
+            this.page = page ?? throw new ArgumentNullException(nameof(page));
             this.runtime.BindingCalled += OnRuntimeBindingCalled;
             this.runtime.ConsoleAPICalled += OnRuntimeConsoleApiCalled;
             this.runtime.ExceptionThrown += OnRuntimeExceptionThrown;
@@ -138,7 +141,7 @@ internal override async Task Evaluate(string script)
             await runtime.Evaluate(new EvaluateCommandSettings { Expression = script }).ConfigureAwait(false);
         }
 
-        private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArgs e)
+        private void OnRuntimeBindingCalled(object? sender, Runtime.BindingCalledEventArgs e)
         {
             BindingCalledEventArgs wrapped = new BindingCalledEventArgs
             (
@@ -150,7 +153,7 @@ private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArg
             this.OnBindingCalled(wrapped);
         }
 
-        private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEventArgs e)
+        private void OnRuntimeExceptionThrown(object? sender, Runtime.ExceptionThrownEventArgs e)
         {
             // TODO: Collect stack trace elements
             var wrapped = new ExceptionThrownEventArgs
@@ -162,12 +165,12 @@ private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEven
             this.OnExceptionThrown(wrapped);
         }
 
-        private void OnRuntimeConsoleApiCalled(object sender, ConsoleAPICalledEventArgs e)
+        private void OnRuntimeConsoleApiCalled(object? sender, ConsoleAPICalledEventArgs e)
         {
-            List<ConsoleApiArgument> args = new List<ConsoleApiArgument>();
+            List<ConsoleApiArgument> args = new List<ConsoleApiArgument>(e.Args.Length);
             foreach (var arg in e.Args)
             {
-                string argValue = arg.Value?.ToString();
+                string? argValue = arg.Value?.ToString();
                 args.Add(new ConsoleApiArgument(arg.Type.ToString(), argValue));
             }
 
diff --git a/dotnet/src/webdriver/DevTools/v132/V132JavaScript.cs b/dotnet/src/webdriver/DevTools/v132/V132JavaScript.cs
@@ -23,25 +23,28 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools.V132
 {
     /// <summary>
     /// Class containing the JavaScript implementation for version 132 of the DevTools Protocol.
     /// </summary>
     public class V132JavaScript : JavaScript
     {
-        private RuntimeAdapter runtime;
-        private PageAdapter page;
+        private readonly RuntimeAdapter runtime;
+        private readonly PageAdapter page;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="V132JavaScript"/> class.
         /// </summary>
         /// <param name="runtime">The DevTools Protocol adapter for the Runtime domain.</param>
         /// <param name="page">The DevTools Protocol adapter for the Page domain.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="runtime"/> or <paramref name="page"/> are <see langword="null"/>.</exception>
         public V132JavaScript(RuntimeAdapter runtime, PageAdapter page)
         {
-            this.runtime = runtime;
-            this.page = page;
+            this.runtime = runtime ?? throw new ArgumentNullException(nameof(runtime));
+            this.page = page ?? throw new ArgumentNullException(nameof(page));
             this.runtime.BindingCalled += OnRuntimeBindingCalled;
             this.runtime.ConsoleAPICalled += OnRuntimeConsoleApiCalled;
             this.runtime.ExceptionThrown += OnRuntimeExceptionThrown;
@@ -138,7 +141,7 @@ internal override async Task Evaluate(string script)
             await runtime.Evaluate(new EvaluateCommandSettings { Expression = script }).ConfigureAwait(false);
         }
 
-        private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArgs e)
+        private void OnRuntimeBindingCalled(object? sender, Runtime.BindingCalledEventArgs e)
         {
             BindingCalledEventArgs wrapped = new BindingCalledEventArgs
             (
@@ -150,7 +153,7 @@ private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArg
             this.OnBindingCalled(wrapped);
         }
 
-        private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEventArgs e)
+        private void OnRuntimeExceptionThrown(object? sender, Runtime.ExceptionThrownEventArgs e)
         {
             // TODO: Collect stack trace elements
             var wrapped = new ExceptionThrownEventArgs
@@ -162,12 +165,12 @@ private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEven
             this.OnExceptionThrown(wrapped);
         }
 
-        private void OnRuntimeConsoleApiCalled(object sender, ConsoleAPICalledEventArgs e)
+        private void OnRuntimeConsoleApiCalled(object? sender, ConsoleAPICalledEventArgs e)
         {
-            List<ConsoleApiArgument> args = new List<ConsoleApiArgument>();
+            List<ConsoleApiArgument> args = new List<ConsoleApiArgument>(e.Args.Length);
             foreach (var arg in e.Args)
             {
-                string argValue = arg.Value?.ToString();
+                string? argValue = arg.Value?.ToString();
                 args.Add(new ConsoleApiArgument(arg.Type.ToString(), argValue));
             }
 
diff --git a/dotnet/src/webdriver/DevTools/v85/V85JavaScript.cs b/dotnet/src/webdriver/DevTools/v85/V85JavaScript.cs
@@ -23,25 +23,28 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools.V85
 {
     /// <summary>
     /// Class containing the JavaScript implementation for version 86 of the DevTools Protocol.
     /// </summary>
     public class V85JavaScript : JavaScript
     {
-        private RuntimeAdapter runtime;
-        private PageAdapter page;
+        private readonly RuntimeAdapter runtime;
+        private readonly PageAdapter page;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="V85JavaScript"/> class.
         /// </summary>
         /// <param name="runtime">The DevTools Protocol adapter for the Runtime domain.</param>
         /// <param name="page">The DevTools Protocol adapter for the Page domain.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="runtime"/> or <paramref name="page"/> are <see langword="null"/>.</exception>
         public V85JavaScript(RuntimeAdapter runtime, PageAdapter page)
         {
-            this.runtime = runtime;
-            this.page = page;
+            this.runtime = runtime ?? throw new ArgumentNullException(nameof(runtime));
+            this.page = page ?? throw new ArgumentNullException(nameof(page));
             this.runtime.BindingCalled += OnRuntimeBindingCalled;
             this.runtime.ConsoleAPICalled += OnRuntimeConsoleApiCalled;
             this.runtime.ExceptionThrown += OnRuntimeExceptionThrown;
@@ -138,7 +141,7 @@ internal override async Task Evaluate(string script)
             await runtime.Evaluate(new EvaluateCommandSettings { Expression = script }).ConfigureAwait(false);
         }
 
-        private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArgs e)
+        private void OnRuntimeBindingCalled(object? sender, Runtime.BindingCalledEventArgs e)
         {
             BindingCalledEventArgs wrapped = new BindingCalledEventArgs
             (
@@ -150,7 +153,7 @@ private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArg
             this.OnBindingCalled(wrapped);
         }
 
-        private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEventArgs e)
+        private void OnRuntimeExceptionThrown(object? sender, Runtime.ExceptionThrownEventArgs e)
         {
             // TODO: Collect stack trace elements
             var wrapped = new ExceptionThrownEventArgs
@@ -162,12 +165,12 @@ private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEven
             this.OnExceptionThrown(wrapped);
         }
 
-        private void OnRuntimeConsoleApiCalled(object sender, ConsoleAPICalledEventArgs e)
+        private void OnRuntimeConsoleApiCalled(object? sender, ConsoleAPICalledEventArgs e)
         {
-            List<ConsoleApiArgument> args = new List<ConsoleApiArgument>();
+            List<ConsoleApiArgument> args = new List<ConsoleApiArgument>(e.Args.Length);
             foreach (var arg in e.Args)
             {
-                string argValue = arg.Value?.ToString();
+                string? argValue = arg.Value?.ToString();
                 args.Add(new ConsoleApiArgument(arg.Type.ToString(), argValue));
             }
 

Original file line number	Diff line number	Diff line change
`@@ -23,25 +23,28 @@`
`23`	`23`	`using System.Collections.Generic;`
`24`	`24`	`using System.Threading.Tasks;`
`25`	`25`
	`26`	`+#nullable enable`
	`27`	`+`
`26`	`28`	`namespace OpenQA.Selenium.DevTools.V130`
`27`	`29`	`{`
`28`	`30`	`/// <summary>`
`29`	`31`	`/// Class containing the JavaScript implementation for version 130 of the DevTools Protocol.`
`30`	`32`	`/// </summary>`
`31`	`33`	`public class V130JavaScript : JavaScript`
`32`	`34`	`{`
`33`		`- private RuntimeAdapter runtime;`
`34`		`- private PageAdapter page;`
	`35`	`+ private readonly RuntimeAdapter runtime;`
	`36`	`+ private readonly PageAdapter page;`
`35`	`37`
`36`	`38`	`/// <summary>`
`37`	`39`	`/// Initializes a new instance of the <see cref="V130JavaScript"/> class.`
`38`	`40`	`/// </summary>`
`39`	`41`	`/// <param name="runtime">The DevTools Protocol adapter for the Runtime domain.</param>`
`40`	`42`	`/// <param name="page">The DevTools Protocol adapter for the Page domain.</param>`
	`43`	`+ /// <exception cref="ArgumentNullException">If <paramref name="runtime"/> or <paramref name="page"/> are <see langword="null"/>.</exception>`
`41`	`44`	`public V130JavaScript(RuntimeAdapter runtime, PageAdapter page)`
`42`	`45`	`{`
`43`		`- this.runtime = runtime;`
`44`		`- this.page = page;`
	`46`	`+ this.runtime = runtime ?? throw new ArgumentNullException(nameof(runtime));`
	`47`	`+ this.page = page ?? throw new ArgumentNullException(nameof(page));`
`45`	`48`	`this.runtime.BindingCalled += OnRuntimeBindingCalled;`
`46`	`49`	`this.runtime.ConsoleAPICalled += OnRuntimeConsoleApiCalled;`
`47`	`50`	`this.runtime.ExceptionThrown += OnRuntimeExceptionThrown;`
`@@ -138,7 +141,7 @@ internal override async Task Evaluate(string script)`
`138`	`141`	`await runtime.Evaluate(new EvaluateCommandSettings { Expression = script }).ConfigureAwait(false);`
`139`	`142`	`}`
`140`	`143`
`141`		`- private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArgs e)`
	`144`	`+ private void OnRuntimeBindingCalled(object? sender, Runtime.BindingCalledEventArgs e)`
`142`	`145`	`{`
`143`	`146`	`BindingCalledEventArgs wrapped = new BindingCalledEventArgs`
`144`	`147`	`(`
`@@ -150,7 +153,7 @@ private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArg`
`150`	`153`	`this.OnBindingCalled(wrapped);`
`151`	`154`	`}`
`152`	`155`
`153`		`- private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEventArgs e)`
	`156`	`+ private void OnRuntimeExceptionThrown(object? sender, Runtime.ExceptionThrownEventArgs e)`
`154`	`157`	`{`
`155`	`158`	`// TODO: Collect stack trace elements`
`156`	`159`	`var wrapped = new ExceptionThrownEventArgs`
`@@ -162,12 +165,12 @@ private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEven`
`162`	`165`	`this.OnExceptionThrown(wrapped);`
`163`	`166`	`}`
`164`	`167`
`165`		`- private void OnRuntimeConsoleApiCalled(object sender, ConsoleAPICalledEventArgs e)`
	`168`	`+ private void OnRuntimeConsoleApiCalled(object? sender, ConsoleAPICalledEventArgs e)`
`166`	`169`	`{`
`167`		`- List<ConsoleApiArgument> args = new List<ConsoleApiArgument>();`
	`170`	`+ List<ConsoleApiArgument> args = new List<ConsoleApiArgument>(e.Args.Length);`
`168`	`171`	`foreach (var arg in e.Args)`
`169`	`172`	`{`
`170`		`- string argValue = arg.Value?.ToString();`
	`173`	`+ string? argValue = arg.Value?.ToString();`
`171`	`174`	`args.Add(new ConsoleApiArgument(arg.Type.ToString(), argValue));`
`172`	`175`	`}`
`173`	`176`