[dotnet] Add nullability to Manage() (#15210)

RenderMichael · web-flow · commit 98b22f8ddd6b · 2025-02-03T02:18:21.000-05:00
* [dotnet] Add nullability to `Manage()`

* Reference langword null on navigation
diff --git a/dotnet/src/webdriver/INavigation.cs b/dotnet/src/webdriver/INavigation.cs
@@ -66,15 +66,15 @@ public interface INavigation
         /// should the underlying page change while your test is executing the results of
         /// future calls against this interface will be against the freshly loaded page.
         /// </remarks>
-        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is null.</exception>
+        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is <see langword="null"/>.</exception>
         void GoToUrl(string url);
 
         /// <summary>
         /// Navigate to a url as an asynchronous task.
         /// </summary>
         /// <param name="url">String of where you want the browser to go.</param>
         /// <returns>A task object representing the asynchronous operation.</returns>
-        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is null.</exception>
+        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is <see langword="null"/>.</exception>
         Task GoToUrlAsync(string url);
 
         /// <summary>
@@ -90,15 +90,15 @@ public interface INavigation
         /// should the underlying page change while your test is executing the results of
         /// future calls against this interface will be against the freshly loaded page.
         /// </remarks>
-        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is null.</exception>
+        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is <see langword="null"/>.</exception>
         void GoToUrl(Uri url);
 
         /// <summary>
         /// Navigate to a url as an asynchronous task.
         /// </summary>
         /// <param name="url">Uri object of where you want the browser to go.</param>
         /// <returns>A task object representing the asynchronous operation.</returns>
-        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is null.</exception>
+        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is <see langword="null"/>.</exception>
         Task GoToUrlAsync(Uri url);
 
         /// <summary>
diff --git a/dotnet/src/webdriver/IOptions.cs b/dotnet/src/webdriver/IOptions.cs
@@ -17,6 +17,8 @@
 // under the License.
 // </copyright>
 
+#nullable enable
+
 namespace OpenQA.Selenium
 {
     /// <summary>
diff --git a/dotnet/src/webdriver/ITimeouts.cs b/dotnet/src/webdriver/ITimeouts.cs
@@ -19,6 +19,8 @@
 
 using System;
 
+#nullable enable
+
 namespace OpenQA.Selenium
 {
     /// <summary>
diff --git a/dotnet/src/webdriver/IWindow.cs b/dotnet/src/webdriver/IWindow.cs
@@ -19,6 +19,8 @@
 
 using System.Drawing;
 
+#nullable enable
+
 namespace OpenQA.Selenium
 {
     /// <summary>
diff --git a/dotnet/src/webdriver/Navigator.cs b/dotnet/src/webdriver/Navigator.cs
@@ -86,7 +86,7 @@ public async Task ForwardAsync()
         /// Navigate to a url.
         /// </summary>
         /// <param name="url">String of where you want the browser to go to</param>
-        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is null.</exception>
+        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is <see langword="null"/>.</exception>
         public void GoToUrl(string url)
         {
             Task.Run(async delegate
@@ -100,7 +100,7 @@ public void GoToUrl(string url)
         /// </summary>
         /// <param name="url">String of where you want the browser to go.</param>
         /// <returns>A task object representing the asynchronous operation.</returns>
-        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is null.</exception>
+        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is <see langword="null"/>.</exception>
         public async Task GoToUrlAsync(string url)
         {
             if (url == null)
@@ -119,7 +119,7 @@ public async Task GoToUrlAsync(string url)
         /// Navigate to a url.
         /// </summary>
         /// <param name="url">Uri object of where you want the browser to go.</param>
-        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is null.</exception>
+        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is <see langword="null"/>.</exception>
         public void GoToUrl(Uri url)
         {
             Task.Run(async delegate
@@ -133,7 +133,7 @@ public void GoToUrl(Uri url)
         /// </summary>
         /// <param name="url">Uri object of where you want the browser to go.</param>
         /// <returns>A task object representing the asynchronous operation.</returns>
-        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is null.</exception>
+        /// <exception cref="ArgumentNullException">If <paramref name="url"/> is <see langword="null"/>.</exception>
         public async Task GoToUrlAsync(Uri url)
         {
             if (url == null)
diff --git a/dotnet/src/webdriver/OptionsManager.cs b/dotnet/src/webdriver/OptionsManager.cs
@@ -17,49 +17,42 @@
 // under the License.
 // </copyright>
 
+#nullable enable
+
 namespace OpenQA.Selenium
 {
     /// <summary>
     /// Provides a mechanism for setting options needed for the driver during the test.
     /// </summary>
-    internal class OptionsManager : IOptions
+    internal sealed class OptionsManager : IOptions
     {
-        private WebDriver driver;
+        private readonly WebDriver driver;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="OptionsManager"/> class
         /// </summary>
         /// <param name="driver">Instance of the driver currently in use</param>
         public OptionsManager(WebDriver driver)
         {
-            this.driver = driver;
+            this.driver = driver ?? throw new System.ArgumentNullException(nameof(driver));
         }
 
         /// <summary>
         /// Gets an object allowing the user to manipulate cookies on the page.
         /// </summary>
-        public ICookieJar Cookies
-        {
-            get { return new CookieJar(this.driver); }
-        }
+        public ICookieJar Cookies => new CookieJar(this.driver);
 
         /// <summary>
         /// Gets an object allowing the user to manipulate the currently-focused browser window.
         /// </summary>
         /// <remarks>"Currently-focused" is defined as the browser window having the window handle
         /// returned when IWebDriver.CurrentWindowHandle is called.</remarks>
-        public IWindow Window
-        {
-            get { return new Window(this.driver); }
-        }
+        public IWindow Window => new Window(this.driver);
 
         /// <summary>
         /// Gets an object allowing the user to examine the logs of the current driver instance.
         /// </summary>
-        public ILogs Logs
-        {
-            get { return new Logs(this.driver); }
-        }
+        public ILogs Logs => new Logs(this.driver);
 
         /// <summary>
         /// Provides access to the timeouts defined for this driver.
@@ -70,9 +63,6 @@ public ITimeouts Timeouts()
             return new Timeouts(this.driver);
         }
 
-        public INetwork Network
-        {
-            get { return this.driver.Network; }
-        }
+        public INetwork Network => this.driver.Network;
     }
 }
diff --git a/dotnet/src/webdriver/Timeouts.cs b/dotnet/src/webdriver/Timeouts.cs
@@ -21,6 +21,8 @@
 using System.Collections.Generic;
 using System.Globalization;
 
+#nullable enable
+
 namespace OpenQA.Selenium
 {
     /// <summary>
@@ -33,19 +35,19 @@ internal class Timeouts : ITimeouts
         private const string PageLoadTimeoutName = "pageLoad";
         private const string LegacyPageLoadTimeoutName = "page load";
 
-        private readonly TimeSpan DefaultImplicitWaitTimeout = TimeSpan.FromSeconds(0);
-        private readonly TimeSpan DefaultAsyncScriptTimeout = TimeSpan.FromSeconds(30);
-        private readonly TimeSpan DefaultPageLoadTimeout = TimeSpan.FromSeconds(300);
+        private static readonly TimeSpan DefaultImplicitWaitTimeout = TimeSpan.FromSeconds(0);
+        private static readonly TimeSpan DefaultAsyncScriptTimeout = TimeSpan.FromSeconds(30);
+        private static readonly TimeSpan DefaultPageLoadTimeout = TimeSpan.FromSeconds(300);
 
-        private WebDriver driver;
+        private readonly WebDriver driver;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="Timeouts"/> class
         /// </summary>
         /// <param name="driver">The driver that is currently in use</param>
         public Timeouts(WebDriver driver)
         {
-            this.driver = driver;
+            this.driver = driver ?? throw new ArgumentNullException(nameof(driver));
         }
 
         /// <summary>
@@ -70,8 +72,8 @@ public Timeouts(WebDriver driver)
         /// </remarks>
         public TimeSpan ImplicitWait
         {
-            get { return this.ExecuteGetTimeout(ImplicitTimeoutName); }
-            set { this.ExecuteSetTimeout(ImplicitTimeoutName, value); }
+            get => this.ExecuteGetTimeout(ImplicitTimeoutName);
+            set => this.ExecuteSetTimeout(ImplicitTimeoutName, value);
         }
 
         /// <summary>
@@ -87,8 +89,8 @@ public TimeSpan ImplicitWait
         /// </remarks>
         public TimeSpan AsynchronousJavaScript
         {
-            get { return this.ExecuteGetTimeout(AsyncScriptTimeoutName); }
-            set { this.ExecuteSetTimeout(AsyncScriptTimeoutName, value); }
+            get => this.ExecuteGetTimeout(AsyncScriptTimeoutName);
+            set => this.ExecuteSetTimeout(AsyncScriptTimeoutName, value);
         }
 
         /// <summary>
@@ -103,29 +105,21 @@ public TimeSpan AsynchronousJavaScript
         /// </remarks>
         public TimeSpan PageLoad
         {
-            get
-            {
-                string timeoutName = PageLoadTimeoutName;
-                return this.ExecuteGetTimeout(timeoutName);
-            }
-
-            set
-            {
-                string timeoutName = PageLoadTimeoutName;
-                this.ExecuteSetTimeout(timeoutName, value);
-            }
+            get => this.ExecuteGetTimeout(PageLoadTimeoutName);
+            set => this.ExecuteSetTimeout(PageLoadTimeoutName, value);
         }
 
         private TimeSpan ExecuteGetTimeout(string timeoutType)
         {
             Response commandResponse = this.driver.InternalExecute(DriverCommand.GetTimeouts, null);
-            Dictionary<string, object> responseValue = (Dictionary<string, object>)commandResponse.Value;
-            if (!responseValue.ContainsKey(timeoutType))
+
+            Dictionary<string, object?> responseValue = (Dictionary<string, object?>)commandResponse.Value!;
+            if (!responseValue.TryGetValue(timeoutType, out object? timeout))
             {
                 throw new WebDriverException("Specified timeout type not defined");
             }
 
-            return TimeSpan.FromMilliseconds(Convert.ToDouble(responseValue[timeoutType], CultureInfo.InvariantCulture));
+            return TimeSpan.FromMilliseconds(Convert.ToDouble(timeout, CultureInfo.InvariantCulture));
         }
 
         private void ExecuteSetTimeout(string timeoutType, TimeSpan timeToWait)
@@ -149,6 +143,7 @@ private void ExecuteSetTimeout(string timeoutType, TimeSpan timeToWait)
 
             Dictionary<string, object> parameters = new Dictionary<string, object>();
             parameters.Add(timeoutType, Convert.ToInt64(milliseconds));
+
             this.driver.InternalExecute(DriverCommand.SetTimeouts, parameters);
         }
     }
diff --git a/dotnet/src/webdriver/Window.cs b/dotnet/src/webdriver/Window.cs
@@ -22,12 +22,14 @@
 using System.Drawing;
 using System.Globalization;
 
+#nullable enable
+
 namespace OpenQA.Selenium
 {
     /// <summary>
     /// Defines the interface through which the user can manipulate the browser window.
     /// </summary>
-    internal class Window : IWindow
+    internal sealed class Window : IWindow
     {
         private WebDriver driver;
 
@@ -37,7 +39,7 @@ internal class Window : IWindow
         /// <param name="driver">Instance of the driver currently in use</param>
         public Window(WebDriver driver)
         {
-            this.driver = driver;
+            this.driver = driver ?? throw new ArgumentNullException(nameof(driver));
         }
 
         /// <summary>
@@ -48,12 +50,12 @@ public Point Position
         {
             get
             {
-                Response commandResponse;
-                commandResponse = this.driver.InternalExecute(DriverCommand.GetWindowRect, null);
+                Response commandResponse = this.driver.InternalExecute(DriverCommand.GetWindowRect, null);
 
-                Dictionary<string, object> rawPosition = (Dictionary<string, object>)commandResponse.Value;
+                Dictionary<string, object?> rawPosition = (Dictionary<string, object?>)commandResponse.Value!;
                 int x = Convert.ToInt32(rawPosition["x"], CultureInfo.InvariantCulture);
                 int y = Convert.ToInt32(rawPosition["y"], CultureInfo.InvariantCulture);
+
                 return new Point(x, y);
             }
 
@@ -74,11 +76,12 @@ public Size Size
         {
             get
             {
-                Response commandResponse;
-                commandResponse = this.driver.InternalExecute(DriverCommand.GetWindowRect, null);
-                Dictionary<string, object> rawPosition = (Dictionary<string, object>)commandResponse.Value;
+                Response commandResponse = this.driver.InternalExecute(DriverCommand.GetWindowRect, null);
+
+                Dictionary<string, object?> rawPosition = (Dictionary<string, object?>)commandResponse.Value!;
                 int height = Convert.ToInt32(rawPosition["height"], CultureInfo.InvariantCulture);
                 int width = Convert.ToInt32(rawPosition["width"], CultureInfo.InvariantCulture);
+
                 return new Size(width, height);
             }
 
@@ -96,26 +99,23 @@ public Size Size
         /// </summary>
         public void Maximize()
         {
-            Dictionary<string, object> parameters = null;
-            this.driver.InternalExecute(DriverCommand.MaximizeWindow, parameters);
+            this.driver.InternalExecute(DriverCommand.MaximizeWindow, null);
         }
 
         /// <summary>
         /// Minimizes the current window if it is not already minimized.
         /// </summary>
         public void Minimize()
         {
-            Dictionary<string, object> parameters = null;
-            this.driver.InternalExecute(DriverCommand.MinimizeWindow, parameters);
+            this.driver.InternalExecute(DriverCommand.MinimizeWindow, null);
         }
 
         /// <summary>
         /// Sets the current window to full screen if it is not already in that state.
         /// </summary>
         public void FullScreen()
         {
-            Dictionary<string, object> parameters = null;
-            this.driver.InternalExecute(DriverCommand.FullScreenWindow, parameters);
+            this.driver.InternalExecute(DriverCommand.FullScreenWindow, null);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`// under the License.`
`18`	`18`	`// </copyright>`
`19`	`19`
	`20`	`+#nullable enable`
	`21`	`+`
`20`	`22`	`namespace OpenQA.Selenium`
`21`	`23`	`{`
`22`	`24`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`
`20`	`20`	`using System;`
`21`	`21`
	`22`	`+#nullable enable`
	`23`	`+`
`22`	`24`	`namespace OpenQA.Selenium`
`23`	`25`	`{`
`24`	`26`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,14 @@`
`22`	`22`	`using System.Drawing;`
`23`	`23`	`using System.Globalization;`
`24`	`24`
	`25`	`+#nullable enable`
	`26`	`+`
`25`	`27`	`namespace OpenQA.Selenium`
`26`	`28`	`{`
`27`	`29`	`/// <summary>`
`28`	`30`	`/// Defines the interface through which the user can manipulate the browser window.`
`29`	`31`	`/// </summary>`
`30`		`- internal class Window : IWindow`
	`32`	`+ internal sealed class Window : IWindow`
`31`	`33`	`{`
`32`	`34`	`private WebDriver driver;`
`33`	`35`
`@@ -37,7 +39,7 @@ internal class Window : IWindow`
`37`	`39`	`/// <param name="driver">Instance of the driver currently in use</param>`
`38`	`40`	`public Window(WebDriver driver)`
`39`	`41`	`{`
`40`		`- this.driver = driver;`
	`42`	`+ this.driver = driver ?? throw new ArgumentNullException(nameof(driver));`
`41`	`43`	`}`
`42`	`44`
`43`	`45`	`/// <summary>`
`@@ -48,12 +50,12 @@ public Point Position`
`48`	`50`	`{`
`49`	`51`	`get`
`50`	`52`	`{`
`51`		`- Response commandResponse;`
`52`		`- commandResponse = this.driver.InternalExecute(DriverCommand.GetWindowRect, null);`
	`53`	`+ Response commandResponse = this.driver.InternalExecute(DriverCommand.GetWindowRect, null);`
`53`	`54`
`54`		`- Dictionary<string, object> rawPosition = (Dictionary<string, object>)commandResponse.Value;`
	`55`	`+ Dictionary<string, object?> rawPosition = (Dictionary<string, object?>)commandResponse.Value!;`
`55`	`56`	`int x = Convert.ToInt32(rawPosition["x"], CultureInfo.InvariantCulture);`
`56`	`57`	`int y = Convert.ToInt32(rawPosition["y"], CultureInfo.InvariantCulture);`
	`58`	`+`
`57`	`59`	`return new Point(x, y);`
`58`	`60`	`}`
`59`	`61`
`@@ -74,11 +76,12 @@ public Size Size`
`74`	`76`	`{`
`75`	`77`	`get`
`76`	`78`	`{`
`77`		`- Response commandResponse;`
`78`		`- commandResponse = this.driver.InternalExecute(DriverCommand.GetWindowRect, null);`
`79`		`- Dictionary<string, object> rawPosition = (Dictionary<string, object>)commandResponse.Value;`
	`79`	`+ Response commandResponse = this.driver.InternalExecute(DriverCommand.GetWindowRect, null);`
	`80`	`+`
	`81`	`+ Dictionary<string, object?> rawPosition = (Dictionary<string, object?>)commandResponse.Value!;`
`80`	`82`	`int height = Convert.ToInt32(rawPosition["height"], CultureInfo.InvariantCulture);`
`81`	`83`	`int width = Convert.ToInt32(rawPosition["width"], CultureInfo.InvariantCulture);`
	`84`	`+`
`82`	`85`	`return new Size(width, height);`
`83`	`86`	`}`
`84`	`87`
`@@ -96,26 +99,23 @@ public Size Size`
`96`	`99`	`/// </summary>`
`97`	`100`	`public void Maximize()`
`98`	`101`	`{`
`99`		`- Dictionary<string, object> parameters = null;`
`100`		`- this.driver.InternalExecute(DriverCommand.MaximizeWindow, parameters);`
	`102`	`+ this.driver.InternalExecute(DriverCommand.MaximizeWindow, null);`
`101`	`103`	`}`
`102`	`104`
`103`	`105`	`/// <summary>`
`104`	`106`	`/// Minimizes the current window if it is not already minimized.`
`105`	`107`	`/// </summary>`
`106`	`108`	`public void Minimize()`
`107`	`109`	`{`
`108`		`- Dictionary<string, object> parameters = null;`
`109`		`- this.driver.InternalExecute(DriverCommand.MinimizeWindow, parameters);`
	`110`	`+ this.driver.InternalExecute(DriverCommand.MinimizeWindow, null);`
`110`	`111`	`}`
`111`	`112`
`112`	`113`	`/// <summary>`
`113`	`114`	`/// Sets the current window to full screen if it is not already in that state.`
`114`	`115`	`/// </summary>`
`115`	`116`	`public void FullScreen()`
`116`	`117`	`{`
`117`		`- Dictionary<string, object> parameters = null;`
`118`		`- this.driver.InternalExecute(DriverCommand.FullScreenWindow, parameters);`
	`118`	`+ this.driver.InternalExecute(DriverCommand.FullScreenWindow, null);`
`119`	`119`	`}`
`120`	`120`	`}`
`121`	`121`	`}`