[dotnet] Add nullability annotations to devtools domains (#15143)

* [dotnet] Add nullability annotations to devtools domains * Update dotnet/src/webdriver/DevTools/Json/JsonEnumMemberConverter.cs
SeleniumHQ · Feb 4, 2025 · 787cf6f · 787cf6f
1 parent 773f9e0
commit 787cf6f
Show file tree

Hide file tree

Showing 12 changed files with 54 additions and 29 deletions.
diff --git a/dotnet/src/webdriver/DevTools/DevToolsExtensionMethods.cs b/dotnet/src/webdriver/DevTools/DevToolsExtensionMethods.cs
@@ -17,6 +17,8 @@
 // under the License.
 // </copyright>
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools
 {
     /// <summary>

diff --git a/dotnet/src/webdriver/DevTools/DevToolsOptions.cs b/dotnet/src/webdriver/DevTools/DevToolsOptions.cs
@@ -17,6 +17,8 @@
 // under the License.
 // </copyright>
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools
 {
     /// <summary>

diff --git a/dotnet/src/webdriver/DevTools/DevToolsSessionDomains.cs b/dotnet/src/webdriver/DevTools/DevToolsSessionDomains.cs
@@ -17,15 +17,15 @@
 // under the License.
 // </copyright>
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools
 {
     /// <summary>
     /// Provides an abstract base class for version-specific domain implementations.
     /// </summary>
     public abstract class DevToolsSessionDomains
     {
-        private CommandResponseTypeMap responseTypeMap = new CommandResponseTypeMap();
-
         /// <summary>
         /// Initializes a new instance of the <see cref="DevToolsSessionDomains"/> class.
         /// </summary>
@@ -37,7 +37,7 @@ protected DevToolsSessionDomains()
         /// <summary>
         /// Gets the <see cref="CommandResponseTypeMap"/> containing information about the types returned by DevTools Protocol commands.,
         /// </summary>
-        internal CommandResponseTypeMap ResponseTypeMap => this.responseTypeMap;
+        internal CommandResponseTypeMap ResponseTypeMap { get; } = new CommandResponseTypeMap();
 
         /// <summary>
         /// Populates the command response type map.

diff --git a/dotnet/src/webdriver/DevTools/DevToolsSessionEventReceivedEventArgs.cs b/dotnet/src/webdriver/DevTools/DevToolsSessionEventReceivedEventArgs.cs
@@ -21,6 +21,8 @@
 using System.Text.Json;
 using System.Text.Json.Nodes;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools
 {
     /// <summary>
@@ -44,16 +46,16 @@ public DevToolsEventReceivedEventArgs(string domainName, string eventName, JsonE
         /// <summary>
         /// Gets the domain on which the event is to be raised.
         /// </summary>
-        public string DomainName { get; private set; }
+        public string DomainName { get; }
 
         /// <summary>
         /// Gets the name of the event to be raised.
         /// </summary>
-        public string EventName { get; private set; }
+        public string EventName { get; }
 
         /// <summary>
         /// Gets the data with which the event is to be raised.
         /// </summary>
-        public JsonElement EventData { get; private set; }
+        public JsonElement EventData { get; }
     }
 }
diff --git a/dotnet/src/webdriver/DevTools/DevToolsSessionLogMessageEventArgs.cs b/dotnet/src/webdriver/DevTools/DevToolsSessionLogMessageEventArgs.cs
@@ -19,6 +19,8 @@
 
 using System;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools
 {
     /// <summary>

diff --git a/dotnet/src/webdriver/DevTools/ExceptionThrownEventArgs.cs b/dotnet/src/webdriver/DevTools/ExceptionThrownEventArgs.cs
@@ -19,21 +19,34 @@
 
 using System;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools
 {
     /// <summary>
     /// Provides data for events relating to JavaScript exception handling.
     /// </summary>
     public class ExceptionThrownEventArgs : EventArgs
     {
+        /// <summary>
+        /// Initializes new instance of the <see cref="ExceptionThrownEventArgs"/> type.
+        /// </summary>
+        /// <param name="timestamp">The time stamp of the exception.</param>
+        /// <param name="message">The text of the exception.</param>
+        public ExceptionThrownEventArgs(DateTime timestamp, string message)
+        {
+            Timestamp = timestamp;
+            Message = message;
+        }
+
         /// <summary>
         /// Gets the time stamp of the exception.
         /// </summary>
-        public DateTime Timestamp { get; internal set; }
+        public DateTime Timestamp { get; }
 
         /// <summary>
         /// Gets the text of the exception.
         /// </summary>
-        public string Message { get; internal set; }
+        public string Message { get; }
     }
 }
diff --git a/dotnet/src/webdriver/DevTools/Json/JsonEnumMemberConverter.cs b/dotnet/src/webdriver/DevTools/Json/JsonEnumMemberConverter.cs
@@ -24,6 +24,8 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools.Json
 {
     internal sealed class JsonEnumMemberConverter<TEnum> : JsonConverter<TEnum>
@@ -63,7 +65,7 @@ public JsonEnumMemberConverter()
 
         public override TEnum Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
         {
-            var stringValue = reader.GetString();
+            var stringValue = reader.GetString() ?? throw new JsonException("Could not read an enum string from \"null\"");
 
             if (_stringToEnum.TryGetValue(stringValue, out var enumValue))
             {

diff --git a/dotnet/src/webdriver/DevTools/ResponsePausedEventArgs.cs b/dotnet/src/webdriver/DevTools/ResponsePausedEventArgs.cs
@@ -19,6 +19,8 @@
 
 using System;
 
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools
 {
     /// <summary>

diff --git a/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs b/dotnet/src/webdriver/DevTools/v130/V130JavaScript.cs
@@ -153,11 +153,11 @@ private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArg
         private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEventArgs e)
         {
             // TODO: Collect stack trace elements
-            var wrapped = new ExceptionThrownEventArgs()
-            {
-                Timestamp = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc).AddMilliseconds(e.Timestamp),
-                Message = e.ExceptionDetails.Text
-            };
+            var wrapped = new ExceptionThrownEventArgs
+            (
+                timestamp: new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc).AddMilliseconds(e.Timestamp),
+                message: e.ExceptionDetails.Text
+            );
 
             this.OnExceptionThrown(wrapped);
         }

diff --git a/dotnet/src/webdriver/DevTools/v131/V131JavaScript.cs b/dotnet/src/webdriver/DevTools/v131/V131JavaScript.cs
@@ -153,11 +153,11 @@ private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArg
         private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEventArgs e)
         {
             // TODO: Collect stack trace elements
-            var wrapped = new ExceptionThrownEventArgs()
-            {
-                Timestamp = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc).AddMilliseconds(e.Timestamp),
-                Message = e.ExceptionDetails.Text
-            };
+            var wrapped = new ExceptionThrownEventArgs
+            (
+                timestamp: new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc).AddMilliseconds(e.Timestamp),
+                message: e.ExceptionDetails.Text
+            );
 
             this.OnExceptionThrown(wrapped);
         }

diff --git a/dotnet/src/webdriver/DevTools/v132/V132JavaScript.cs b/dotnet/src/webdriver/DevTools/v132/V132JavaScript.cs
@@ -153,11 +153,11 @@ private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArg
         private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEventArgs e)
         {
             // TODO: Collect stack trace elements
-            var wrapped = new ExceptionThrownEventArgs()
-            {
-                Timestamp = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc).AddMilliseconds(e.Timestamp),
-                Message = e.ExceptionDetails.Text
-            };
+            var wrapped = new ExceptionThrownEventArgs
+            (
+                timestamp: new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc).AddMilliseconds(e.Timestamp),
+                message: e.ExceptionDetails.Text
+            );
 
             this.OnExceptionThrown(wrapped);
         }

diff --git a/dotnet/src/webdriver/DevTools/v85/V85JavaScript.cs b/dotnet/src/webdriver/DevTools/v85/V85JavaScript.cs
@@ -153,11 +153,11 @@ private void OnRuntimeBindingCalled(object sender, Runtime.BindingCalledEventArg
         private void OnRuntimeExceptionThrown(object sender, Runtime.ExceptionThrownEventArgs e)
         {
             // TODO: Collect stack trace elements
-            var wrapped = new ExceptionThrownEventArgs()
-            {
-                Timestamp = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc).AddMilliseconds(e.Timestamp),
-                Message = e.ExceptionDetails.Text
-            };
+            var wrapped = new ExceptionThrownEventArgs
+            (
+                timestamp: new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc).AddMilliseconds(e.Timestamp),
+                message: e.ExceptionDetails.Text
+            );
 
             this.OnExceptionThrown(wrapped);
         }