Simplify null warnings to show where exactly we are suppressing nulls

RenderMichael · RenderMichael · commit 93ffa986c39e · 2025-02-28T13:11:29.000-05:00
diff --git a/dotnet/src/webdriver/Chromium/ChromiumDriver.cs b/dotnet/src/webdriver/Chromium/ChromiumDriver.cs
@@ -330,7 +330,7 @@ public DevToolsSession GetDevToolsSession(DevToolsOptions options)
 
                 try
                 {
-                    DevToolsSession session = new DevToolsSession(debuggerAddress?.ToString(), options);
+                    DevToolsSession session = new DevToolsSession(debuggerAddress?.ToString()!, options);
                     Task.Run(async () => await session.StartSession()).GetAwaiter().GetResult();
                     this.devToolsSession = session;
                 }
diff --git a/dotnet/src/webdriver/NetworkAuthenticationHandler.cs b/dotnet/src/webdriver/NetworkAuthenticationHandler.cs
@@ -18,6 +18,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 
 #nullable enable
 
@@ -32,12 +33,14 @@ public class NetworkAuthenticationHandler
         /// Gets or sets a function that takes a <see cref="Uri"/> object, and returns a
         /// value indicating whether the supplied URI matches the specified criteria.
         /// </summary>
-        public Func<Uri, bool> UriMatcher { get; set; } = null!;
+        [DisallowNull]
+        public Func<Uri, bool>? UriMatcher { get; set; }
 
         /// <summary>
         /// Gets or sets the credentials to use when responding to an authentication request
         /// that matches the specified criteria.
         /// </summary>
-        public ICredentials Credentials { get; set; } = null!;
+        [DisallowNull]
+        public ICredentials? Credentials { get; set; }
     }
 }
diff --git a/dotnet/src/webdriver/NetworkManager.cs b/dotnet/src/webdriver/NetworkManager.cs
@@ -199,9 +199,9 @@ private async Task OnAuthRequired(object sender, AuthRequiredEventArgs e)
             bool successfullyAuthenticated = false;
             foreach (var authenticationHandler in this.authenticationHandlers)
             {
-                if (authenticationHandler.UriMatcher.Invoke(uri))
+                if (authenticationHandler.UriMatcher!.Invoke(uri))
                 {
-                    PasswordCredentials credentials = (PasswordCredentials)authenticationHandler.Credentials;
+                    PasswordCredentials credentials = (PasswordCredentials)authenticationHandler.Credentials!;
                     await this.session.Value.Domains.Network.ContinueWithAuth(e.RequestId, credentials.UserName, credentials.Password).ConfigureAwait(false);
                     successfullyAuthenticated = true;
                     break;
@@ -223,7 +223,7 @@ private async Task OnRequestPaused(object sender, RequestPausedEventArgs e)
 
             foreach (var handler in this.requestHandlers)
             {
-                if (handler.RequestMatcher.Invoke(e.RequestData))
+                if (handler.RequestMatcher!.Invoke(e.RequestData))
                 {
                     if (handler.RequestTransformer != null)
                     {
@@ -257,14 +257,14 @@ private async Task OnResponsePaused(object sender, ResponsePausedEventArgs e)
 
             foreach (var handler in this.responseHandlers)
             {
-                if (handler.ResponseMatcher.Invoke(e.ResponseData))
+                if (handler.ResponseMatcher!.Invoke(e.ResponseData))
                 {
                     // NOTE: We create a dummy HttpRequestData object here, because the ContinueRequestWithResponse
                     // method demands one; however, the only property used by that method is the RequestId property.
                     // It might be better to refactor that method signature to simply pass the request ID, or
                     // alternatively, just pass the response data, which should also contain the request ID anyway.
                     HttpRequestData requestData = new HttpRequestData { RequestId = e.ResponseData.RequestId };
-                    await this.session.Value.Domains.Network.ContinueRequestWithResponse(requestData, handler.ResponseTransformer(e.ResponseData)).ConfigureAwait(false);
+                    await this.session.Value.Domains.Network.ContinueRequestWithResponse(requestData, handler.ResponseTransformer!(e.ResponseData)).ConfigureAwait(false);
                     return;
                 }
             }
diff --git a/dotnet/src/webdriver/NetworkRequestHandler.cs b/dotnet/src/webdriver/NetworkRequestHandler.cs
@@ -18,6 +18,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 
 #nullable enable
 
@@ -32,7 +33,8 @@ public class NetworkRequestHandler
         /// Gets or sets a function that evaluates request data in an <see cref="HttpRequestData"/> object,
         /// and returns a value indicating whether the data matches the specified criteria.
         /// </summary>
-        public Func<HttpRequestData, bool> RequestMatcher { get; set; } = null!;
+        [DisallowNull]
+        public Func<HttpRequestData, bool>? RequestMatcher { get; set; }
 
         /// <summary>
         /// Gets or sets a function that accepts an <see cref="HttpRequestData"/> object describing a network
diff --git a/dotnet/src/webdriver/NetworkResponseHandler.cs b/dotnet/src/webdriver/NetworkResponseHandler.cs
@@ -18,6 +18,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 
 #nullable enable
 
@@ -32,13 +33,15 @@ public class NetworkResponseHandler
         /// Gets or sets a function that evaluates returned response data in an <see cref="HttpResponseData"/> object,
         /// and returns a value indicating whether the data matches the specified criteria.
         /// </summary>
-        public Func<HttpResponseData, bool> ResponseMatcher { get; set; } = null!;
+        [DisallowNull]
+        public Func<HttpResponseData, bool>? ResponseMatcher { get; set; }
 
         /// <summary>
         /// Gets or sets a function that accepts an <see cref="HttpResponseData"/> object describing a network
         /// response received by the browser, and returns a modified <see cref="HttpResponseData"/> object to used
         /// as the actual network response.
         /// </summary>
-        public Func<HttpResponseData, HttpResponseData> ResponseTransformer { get; set; } = null!;
+        [DisallowNull]
+        public Func<HttpResponseData, HttpResponseData>? ResponseTransformer { get; set; }
     }
 }
diff --git a/dotnet/src/webdriver/RelativeBy.cs b/dotnet/src/webdriver/RelativeBy.cs
@@ -33,16 +33,16 @@ namespace OpenQA.Selenium
     /// </summary>
     public class RelativeBy : By
     {
-        private string wrappedAtom;
-        private object root;
-        private List<object> filters = new List<object>();
+        private readonly string wrappedAtom;
+        private readonly object root;
+        private readonly List<object> filters = new List<object>();
 
         /// <summary>
         /// Prevents a default instance of the <see cref="RelativeBy"/> class.
         /// </summary>
         protected RelativeBy() : base()
         {
-            string atom = string.Empty;
+            string atom;
             using (Stream atomStream = ResourceUtilities.GetResourceStream("find-elements.js", "find-elements.js"))
             {
                 using (StreamReader atomReader = new StreamReader(atomStream))
@@ -56,7 +56,7 @@ protected RelativeBy() : base()
 
         private RelativeBy(object root, List<object>? filters = null) : this()
         {
-            this.root = this.GetSerializableRoot(root);
+            this.root = GetSerializableRoot(root);
 
             if (filters != null)
             {
@@ -105,7 +105,7 @@ public override ReadOnlyCollection<IWebElement> FindElements(ISearchContext cont
             IJavaScriptExecutor js = GetExecutor(context);
             Dictionary<string, object> parameters = new Dictionary<string, object>();
             Dictionary<string, object> filterParameters = new Dictionary<string, object>();
-            filterParameters["root"] = this.GetSerializableObject(this.root);
+            filterParameters["root"] = GetSerializableObject(this.root);
             filterParameters["filters"] = this.filters;
             parameters["relative"] = filterParameters;
             object rawElements = js.ExecuteScript(wrappedAtom, parameters);
@@ -279,6 +279,7 @@ public RelativeBy Near(IWebElement element)
         /// <param name="atMostDistanceInPixels">The maximum distance from the element to be considered "near."</param>
         /// <returns>A <see cref="RelativeBy"/> object for use in finding the elements.</returns>
         /// <exception cref="ArgumentNullException">If <paramref name="element"/> is null.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">If <paramref name="atMostDistanceInPixels"/> is not a positive value.</exception>
         public RelativeBy Near(IWebElement element, int atMostDistanceInPixels)
         {
             return Near((object)element, atMostDistanceInPixels);
@@ -302,6 +303,7 @@ public RelativeBy Near(By locator)
         /// <param name="atMostDistanceInPixels">The maximum distance from the element to be considered "near."</param>
         /// <returns>A <see cref="RelativeBy"/> object for use in finding the elements.</returns>
         /// <exception cref="ArgumentNullException">If <paramref name="locator"/> is null.</exception>
+        /// <exception cref="ArgumentOutOfRangeException">If <paramref name="atMostDistanceInPixels"/> is not a positive value.</exception>
         public RelativeBy Near(By locator, int atMostDistanceInPixels)
         {
             return Near((object)locator, atMostDistanceInPixels);
@@ -316,7 +318,7 @@ private RelativeBy Near(object locator, int atMostDistanceInPixels)
 
             if (atMostDistanceInPixels <= 0)
             {
-                throw new ArgumentException("Distance must be greater than zero", nameof(atMostDistanceInPixels));
+                throw new ArgumentOutOfRangeException(nameof(atMostDistanceInPixels), "Distance must be greater than zero");
             }
 
             Dictionary<string, object> filter = new Dictionary<string, object>();
@@ -347,61 +349,59 @@ private RelativeBy SimpleDirection(string direction, object locator)
             return new RelativeBy(this.root, this.filters);
         }
 
-        private object GetSerializableRoot(object toSerialize)
+        private static object GetSerializableRoot(object root)
         {
-            if (toSerialize == null)
+            if (root == null)
             {
-                throw new ArgumentNullException(nameof(toSerialize), "object to serialize must not be null");
+                throw new ArgumentNullException(nameof(root), "object to serialize must not be null");
             }
 
-            By? asBy = toSerialize as By;
-            if (asBy != null)
+            if (root is By asBy)
             {
                 return asBy;
             }
 
-            if (toSerialize is IWebElement element)
+            if (root is IWebElement element)
             {
                 return element;
             }
 
-            if (toSerialize is IWrapsElement wrapper)
+            if (root is IWrapsElement wrapper)
             {
                 return wrapper.WrappedElement;
             }
 
             throw new WebDriverException("Serializable locator must be a By, an IWebElement, or a wrapped element using IWrapsElement");
         }
 
-        private object GetSerializableObject(object toSerialize)
+        private static object GetSerializableObject(object root)
         {
-            if (toSerialize == null)
+            if (root == null)
             {
-                throw new ArgumentNullException(nameof(toSerialize), "object to serialize must not be null");
+                throw new ArgumentNullException(nameof(root), "object to serialize must not be null");
             }
 
-            By? asBy = toSerialize as By;
-            if (asBy != null)
+            if (root is By asBy)
             {
                 Dictionary<string, object> serializedBy = new Dictionary<string, object>();
                 serializedBy[asBy.Mechanism] = asBy.Criteria;
                 return serializedBy;
             }
 
-            if (toSerialize is IWebElement element)
+            if (root is IWebElement element)
             {
                 return element;
             }
 
-            if (toSerialize is IWrapsElement wrapper)
+            if (root is IWrapsElement wrapper)
             {
                 return wrapper.WrappedElement;
             }
 
             throw new WebDriverException("Serializable locator must be a By, an IWebElement, or a wrapped element using IWrapsElement");
         }
 
-        private IJavaScriptExecutor GetExecutor(ISearchContext context)
+        private static IJavaScriptExecutor GetExecutor(ISearchContext context)
         {
             IJavaScriptExecutor? executor = context as IJavaScriptExecutor;
             if (executor != null)

Original file line number	Diff line number	Diff line change
`@@ -330,7 +330,7 @@ public DevToolsSession GetDevToolsSession(DevToolsOptions options)`
`330`	`330`
`331`	`331`	`try`
`332`	`332`	`{`
`333`		`- DevToolsSession session = new DevToolsSession(debuggerAddress?.ToString(), options);`
	`333`	`+ DevToolsSession session = new DevToolsSession(debuggerAddress?.ToString()!, options);`
`334`	`334`	`Task.Run(async () => await session.StartSession()).GetAwaiter().GetResult();`
`335`	`335`	`this.devToolsSession = session;`
`336`	`336`	`}`
Original file line number	Diff line number	Diff line change
`@@ -199,9 +199,9 @@ private async Task OnAuthRequired(object sender, AuthRequiredEventArgs e)`
`199`	`199`	`bool successfullyAuthenticated = false;`
`200`	`200`	`foreach (var authenticationHandler in this.authenticationHandlers)`
`201`	`201`	`{`
`202`		`- if (authenticationHandler.UriMatcher.Invoke(uri))`
	`202`	`+ if (authenticationHandler.UriMatcher!.Invoke(uri))`
`203`	`203`	`{`
`204`		`- PasswordCredentials credentials = (PasswordCredentials)authenticationHandler.Credentials;`
	`204`	`+ PasswordCredentials credentials = (PasswordCredentials)authenticationHandler.Credentials!;`
`205`	`205`	`await this.session.Value.Domains.Network.ContinueWithAuth(e.RequestId, credentials.UserName, credentials.Password).ConfigureAwait(false);`
`206`	`206`	`successfullyAuthenticated = true;`
`207`	`207`	`break;`
`@@ -223,7 +223,7 @@ private async Task OnRequestPaused(object sender, RequestPausedEventArgs e)`
`223`	`223`
`224`	`224`	`foreach (var handler in this.requestHandlers)`
`225`	`225`	`{`
`226`		`- if (handler.RequestMatcher.Invoke(e.RequestData))`
	`226`	`+ if (handler.RequestMatcher!.Invoke(e.RequestData))`
`227`	`227`	`{`
`228`	`228`	`if (handler.RequestTransformer != null)`
`229`	`229`	`{`
`@@ -257,14 +257,14 @@ private async Task OnResponsePaused(object sender, ResponsePausedEventArgs e)`
`257`	`257`
`258`	`258`	`foreach (var handler in this.responseHandlers)`
`259`	`259`	`{`
`260`		`- if (handler.ResponseMatcher.Invoke(e.ResponseData))`
	`260`	`+ if (handler.ResponseMatcher!.Invoke(e.ResponseData))`
`261`	`261`	`{`
`262`	`262`	`// NOTE: We create a dummy HttpRequestData object here, because the ContinueRequestWithResponse`
`263`	`263`	`// method demands one; however, the only property used by that method is the RequestId property.`
`264`	`264`	`// It might be better to refactor that method signature to simply pass the request ID, or`
`265`	`265`	`// alternatively, just pass the response data, which should also contain the request ID anyway.`
`266`	`266`	`HttpRequestData requestData = new HttpRequestData { RequestId = e.ResponseData.RequestId };`
`267`		`- await this.session.Value.Domains.Network.ContinueRequestWithResponse(requestData, handler.ResponseTransformer(e.ResponseData)).ConfigureAwait(false);`
	`267`	`+ await this.session.Value.Domains.Network.ContinueRequestWithResponse(requestData, handler.ResponseTransformer!(e.ResponseData)).ConfigureAwait(false);`
`268`	`268`	`return;`
`269`	`269`	`}`
`270`	`270`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,16 +33,16 @@ namespace OpenQA.Selenium`
`33`	`33`	`/// </summary>`
`34`	`34`	`public class RelativeBy : By`
`35`	`35`	`{`
`36`		`- private string wrappedAtom;`
`37`		`- private object root;`
`38`		`- private List<object> filters = new List<object>();`
	`36`	`+ private readonly string wrappedAtom;`
	`37`	`+ private readonly object root;`
	`38`	`+ private readonly List<object> filters = new List<object>();`
`39`	`39`
`40`	`40`	`/// <summary>`
`41`	`41`	`/// Prevents a default instance of the <see cref="RelativeBy"/> class.`
`42`	`42`	`/// </summary>`
`43`	`43`	`protected RelativeBy() : base()`
`44`	`44`	`{`
`45`		`- string atom = string.Empty;`
	`45`	`+ string atom;`
`46`	`46`	`using (Stream atomStream = ResourceUtilities.GetResourceStream("find-elements.js", "find-elements.js"))`
`47`	`47`	`{`
`48`	`48`	`using (StreamReader atomReader = new StreamReader(atomStream))`
`@@ -56,7 +56,7 @@ protected RelativeBy() : base()`
`56`	`56`
`57`	`57`	`private RelativeBy(object root, List<object>? filters = null) : this()`
`58`	`58`	`{`
`59`		`- this.root = this.GetSerializableRoot(root);`
	`59`	`+ this.root = GetSerializableRoot(root);`
`60`	`60`
`61`	`61`	`if (filters != null)`
`62`	`62`	`{`
`@@ -105,7 +105,7 @@ public override ReadOnlyCollection<IWebElement> FindElements(ISearchContext cont`
`105`	`105`	`IJavaScriptExecutor js = GetExecutor(context);`
`106`	`106`	`Dictionary<string, object> parameters = new Dictionary<string, object>();`
`107`	`107`	`Dictionary<string, object> filterParameters = new Dictionary<string, object>();`
`108`		`- filterParameters["root"] = this.GetSerializableObject(this.root);`
	`108`	`+ filterParameters["root"] = GetSerializableObject(this.root);`
`109`	`109`	`filterParameters["filters"] = this.filters;`
`110`	`110`	`parameters["relative"] = filterParameters;`
`111`	`111`	`object rawElements = js.ExecuteScript(wrappedAtom, parameters);`
`@@ -279,6 +279,7 @@ public RelativeBy Near(IWebElement element)`
`279`	`279`	`/// <param name="atMostDistanceInPixels">The maximum distance from the element to be considered "near."</param>`
`280`	`280`	`/// <returns>A <see cref="RelativeBy"/> object for use in finding the elements.</returns>`
`281`	`281`	`/// <exception cref="ArgumentNullException">If <paramref name="element"/> is null.</exception>`
	`282`	`+ /// <exception cref="ArgumentOutOfRangeException">If <paramref name="atMostDistanceInPixels"/> is not a positive value.</exception>`
`282`	`283`	`public RelativeBy Near(IWebElement element, int atMostDistanceInPixels)`
`283`	`284`	`{`
`284`	`285`	`return Near((object)element, atMostDistanceInPixels);`
`@@ -302,6 +303,7 @@ public RelativeBy Near(By locator)`
`302`	`303`	`/// <param name="atMostDistanceInPixels">The maximum distance from the element to be considered "near."</param>`
`303`	`304`	`/// <returns>A <see cref="RelativeBy"/> object for use in finding the elements.</returns>`
`304`	`305`	`/// <exception cref="ArgumentNullException">If <paramref name="locator"/> is null.</exception>`
	`306`	`+ /// <exception cref="ArgumentOutOfRangeException">If <paramref name="atMostDistanceInPixels"/> is not a positive value.</exception>`
`305`	`307`	`public RelativeBy Near(By locator, int atMostDistanceInPixels)`
`306`	`308`	`{`
`307`	`309`	`return Near((object)locator, atMostDistanceInPixels);`
`@@ -316,7 +318,7 @@ private RelativeBy Near(object locator, int atMostDistanceInPixels)`
`316`	`318`
`317`	`319`	`if (atMostDistanceInPixels <= 0)`
`318`	`320`	`{`
`319`		`- throw new ArgumentException("Distance must be greater than zero", nameof(atMostDistanceInPixels));`
	`321`	`+ throw new ArgumentOutOfRangeException(nameof(atMostDistanceInPixels), "Distance must be greater than zero");`
`320`	`322`	`}`
`321`	`323`
`322`	`324`	`Dictionary<string, object> filter = new Dictionary<string, object>();`
`@@ -347,61 +349,59 @@ private RelativeBy SimpleDirection(string direction, object locator)`
`347`	`349`	`return new RelativeBy(this.root, this.filters);`
`348`	`350`	`}`
`349`	`351`
`350`		`- private object GetSerializableRoot(object toSerialize)`
	`352`	`+ private static object GetSerializableRoot(object root)`
`351`	`353`	`{`
`352`		`- if (toSerialize == null)`
	`354`	`+ if (root == null)`
`353`	`355`	`{`
`354`		`- throw new ArgumentNullException(nameof(toSerialize), "object to serialize must not be null");`
	`356`	`+ throw new ArgumentNullException(nameof(root), "object to serialize must not be null");`
`355`	`357`	`}`
`356`	`358`
`357`		`- By? asBy = toSerialize as By;`
`358`		`- if (asBy != null)`
	`359`	`+ if (root is By asBy)`
`359`	`360`	`{`
`360`	`361`	`return asBy;`
`361`	`362`	`}`
`362`	`363`
`363`		`- if (toSerialize is IWebElement element)`
	`364`	`+ if (root is IWebElement element)`
`364`	`365`	`{`
`365`	`366`	`return element;`
`366`	`367`	`}`
`367`	`368`
`368`		`- if (toSerialize is IWrapsElement wrapper)`
	`369`	`+ if (root is IWrapsElement wrapper)`
`369`	`370`	`{`
`370`	`371`	`return wrapper.WrappedElement;`
`371`	`372`	`}`
`372`	`373`
`373`	`374`	`throw new WebDriverException("Serializable locator must be a By, an IWebElement, or a wrapped element using IWrapsElement");`
`374`	`375`	`}`
`375`	`376`
`376`		`- private object GetSerializableObject(object toSerialize)`
	`377`	`+ private static object GetSerializableObject(object root)`
`377`	`378`	`{`
`378`		`- if (toSerialize == null)`
	`379`	`+ if (root == null)`
`379`	`380`	`{`
`380`		`- throw new ArgumentNullException(nameof(toSerialize), "object to serialize must not be null");`
	`381`	`+ throw new ArgumentNullException(nameof(root), "object to serialize must not be null");`
`381`	`382`	`}`
`382`	`383`
`383`		`- By? asBy = toSerialize as By;`
`384`		`- if (asBy != null)`
	`384`	`+ if (root is By asBy)`
`385`	`385`	`{`
`386`	`386`	`Dictionary<string, object> serializedBy = new Dictionary<string, object>();`
`387`	`387`	`serializedBy[asBy.Mechanism] = asBy.Criteria;`
`388`	`388`	`return serializedBy;`
`389`	`389`	`}`
`390`	`390`
`391`		`- if (toSerialize is IWebElement element)`
	`391`	`+ if (root is IWebElement element)`
`392`	`392`	`{`
`393`	`393`	`return element;`
`394`	`394`	`}`
`395`	`395`
`396`		`- if (toSerialize is IWrapsElement wrapper)`
	`396`	`+ if (root is IWrapsElement wrapper)`
`397`	`397`	`{`
`398`	`398`	`return wrapper.WrappedElement;`
`399`	`399`	`}`
`400`	`400`
`401`	`401`	`throw new WebDriverException("Serializable locator must be a By, an IWebElement, or a wrapped element using IWrapsElement");`
`402`	`402`	`}`
`403`	`403`
`404`		`- private IJavaScriptExecutor GetExecutor(ISearchContext context)`
	`404`	`+ private static IJavaScriptExecutor GetExecutor(ISearchContext context)`
`405`	`405`	`{`
`406`	`406`	`IJavaScriptExecutor? executor = context as IJavaScriptExecutor;`
`407`	`407`	`if (executor != null)`