[dotnet] link exceptions to documentation

titusfortner · titusfortner · commit b30ec03ddaa6 · 2023-06-06T21:35:43.000-05:00
diff --git a/dotnet/src/webdriver/InvalidSelectorException.cs b/dotnet/src/webdriver/InvalidSelectorException.cs
@@ -27,11 +27,16 @@ namespace OpenQA.Selenium
     [Serializable]
     public class InvalidSelectorException : WebDriverException
     {
+        /// <summary>
+        /// Link to the documentation for this error
+        /// </summary>
+        private static string supportUrl = baseSupportUrl + "#invalid-selector-exception";
+
         /// <summary>
         /// Initializes a new instance of the <see cref="InvalidSelectorException"/> class.
         /// </summary>
         public InvalidSelectorException()
-            : base()
+            : base(GetMessage(""))
         {
         }
 
@@ -41,7 +46,7 @@ public InvalidSelectorException()
         /// </summary>
         /// <param name="message">The message that describes the error.</param>
         public InvalidSelectorException(string message)
-            : base(message)
+            : base(GetMessage(message))
         {
         }
 
@@ -54,7 +59,7 @@ public InvalidSelectorException(string message)
         /// <param name="innerException">The exception that is the cause of the current exception,
         /// or <see langword="null"/> if no inner exception is specified.</param>
         public InvalidSelectorException(string message, Exception innerException)
-            : base(message, innerException)
+            : base(GetMessage(message), innerException)
         {
         }
 
@@ -69,5 +74,15 @@ protected InvalidSelectorException(SerializationInfo info, StreamingContext cont
             : base(info, context)
         {
         }
+
+        /// <summary>
+        /// Add information about obtaining additional support from documentation to this exception.
+        /// </summary>
+        /// <param name="message">The original message for exception</param>
+        /// <returns>The final message for exception</returns>
+        protected static string GetMessage(string message)
+        {
+            return message + "; " + supportMsg + supportUrl;
+        }
     }
 }
diff --git a/dotnet/src/webdriver/NoSuchElementException.cs b/dotnet/src/webdriver/NoSuchElementException.cs
@@ -27,11 +27,17 @@ namespace OpenQA.Selenium
     [Serializable]
     public class NoSuchElementException : NotFoundException
     {
+
+        /// <summary>
+        /// Link to the documentation for this error
+        /// </summary>
+        private static string supportUrl = baseSupportUrl + "#no-such-element-exception";
+
         /// <summary>
         /// Initializes a new instance of the <see cref="NoSuchElementException"/> class.
         /// </summary>
         public NoSuchElementException()
-            : base()
+            : base(GetMessage(""))
         {
         }
 
@@ -41,7 +47,7 @@ public NoSuchElementException()
         /// </summary>
         /// <param name="message">The message that describes the error.</param>
         public NoSuchElementException(string message)
-            : base(message)
+            : base(GetMessage(message))
         {
         }
 
@@ -54,7 +60,7 @@ public NoSuchElementException(string message)
         /// <param name="innerException">The exception that is the cause of the current exception,
         /// or <see langword="null"/> if no inner exception is specified.</param>
         public NoSuchElementException(string message, Exception innerException)
-            : base(message, innerException)
+            : base(GetMessage(message), innerException)
         {
         }
 
@@ -69,5 +75,15 @@ protected NoSuchElementException(SerializationInfo info, StreamingContext contex
             : base(info, context)
         {
         }
+
+        /// <summary>
+        /// Add information about obtaining additional support from documentation to this exception.
+        /// </summary>
+        /// <param name="message">The original message for exception</param>
+        /// <returns>The final message for exception</returns>
+        protected static string GetMessage(string message)
+        {
+            return message + "; " + supportMsg + supportUrl;
+        }
     }
 }
diff --git a/dotnet/src/webdriver/StaleElementReferenceException.cs b/dotnet/src/webdriver/StaleElementReferenceException.cs
@@ -27,11 +27,16 @@ namespace OpenQA.Selenium
     [Serializable]
     public class StaleElementReferenceException : WebDriverException
     {
+        /// <summary>
+        /// Link to the documentation for this error
+        /// </summary>
+        private static string supportUrl = baseSupportUrl + "#stale-element-reference-exception";
+
         /// <summary>
         /// Initializes a new instance of the <see cref="StaleElementReferenceException"/> class.
         /// </summary>
         public StaleElementReferenceException()
-            : base()
+            : base(GetMessage(""))
         {
         }
 
@@ -41,7 +46,7 @@ public StaleElementReferenceException()
         /// </summary>
         /// <param name="message">The message that describes the error.</param>
         public StaleElementReferenceException(string message)
-            : base(message)
+            : base(GetMessage(message))
         {
         }
 
@@ -54,7 +59,7 @@ public StaleElementReferenceException(string message)
         /// <param name="innerException">The exception that is the cause of the current exception,
         /// or <see langword="null"/> if no inner exception is specified.</param>
         public StaleElementReferenceException(string message, Exception innerException)
-            : base(message, innerException)
+            : base(GetMessage(message), innerException)
         {
         }
 
@@ -69,5 +74,15 @@ protected StaleElementReferenceException(SerializationInfo info, StreamingContex
             : base(info, context)
         {
         }
+
+        /// <summary>
+        /// Add information about obtaining additional support from documentation to this exception.
+        /// </summary>
+        /// <param name="message">The original message for exception</param>
+        /// <returns>The final message for exception</returns>
+        protected static string GetMessage(string message)
+        {
+            return message + "; " + supportMsg + supportUrl;
+        }
     }
 }
diff --git a/dotnet/src/webdriver/WebDriverException.cs b/dotnet/src/webdriver/WebDriverException.cs
@@ -27,6 +27,16 @@ namespace OpenQA.Selenium
     [Serializable]
     public class WebDriverException : Exception
     {
+        /// <summary>
+        /// Intro comment for pointing to documentation
+        /// </summary>
+        protected static string supportMsg = "For documentation on this error, please visit: ";
+
+        /// <summary>
+        /// Location of errors in documentation
+        /// </summary>
+        protected static string baseSupportUrl = "https://www.selenium.dev/documentation/webdriver/troubleshooting/errors";
+
         /// <summary>
         /// Initializes a new instance of the <see cref="WebDriverException"/> class.
         /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -27,11 +27,16 @@ namespace OpenQA.Selenium`
`27`	`27`	`[Serializable]`
`28`	`28`	`public class InvalidSelectorException : WebDriverException`
`29`	`29`	`{`
	`30`	`+ /// <summary>`
	`31`	`+ /// Link to the documentation for this error`
	`32`	`+ /// </summary>`
	`33`	`+ private static string supportUrl = baseSupportUrl + "#invalid-selector-exception";`
	`34`	`+`
`30`	`35`	`/// <summary>`
`31`	`36`	`/// Initializes a new instance of the <see cref="InvalidSelectorException"/> class.`
`32`	`37`	`/// </summary>`
`33`	`38`	`public InvalidSelectorException()`
`34`		`- : base()`
	`39`	`+ : base(GetMessage(""))`
`35`	`40`	`{`
`36`	`41`	`}`
`37`	`42`
`@@ -41,7 +46,7 @@ public InvalidSelectorException()`
`41`	`46`	`/// </summary>`
`42`	`47`	`/// <param name="message">The message that describes the error.</param>`
`43`	`48`	`public InvalidSelectorException(string message)`
`44`		`- : base(message)`
	`49`	`+ : base(GetMessage(message))`
`45`	`50`	`{`
`46`	`51`	`}`
`47`	`52`
`@@ -54,7 +59,7 @@ public InvalidSelectorException(string message)`
`54`	`59`	`/// <param name="innerException">The exception that is the cause of the current exception,`
`55`	`60`	`/// or <see langword="null"/> if no inner exception is specified.</param>`
`56`	`61`	`public InvalidSelectorException(string message, Exception innerException)`
`57`		`- : base(message, innerException)`
	`62`	`+ : base(GetMessage(message), innerException)`
`58`	`63`	`{`
`59`	`64`	`}`
`60`	`65`
`@@ -69,5 +74,15 @@ protected InvalidSelectorException(SerializationInfo info, StreamingContext cont`
`69`	`74`	`: base(info, context)`
`70`	`75`	`{`
`71`	`76`	`}`
	`77`	`+`
	`78`	`+ /// <summary>`
	`79`	`+ /// Add information about obtaining additional support from documentation to this exception.`
	`80`	`+ /// </summary>`
	`81`	`+ /// <param name="message">The original message for exception</param>`
	`82`	`+ /// <returns>The final message for exception</returns>`
	`83`	`+ protected static string GetMessage(string message)`
	`84`	`+ {`
	`85`	`+ return message + "; " + supportMsg + supportUrl;`
	`86`	`+ }`
`72`	`87`	`}`
`73`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,11 +27,17 @@ namespace OpenQA.Selenium`
`27`	`27`	`[Serializable]`
`28`	`28`	`public class NoSuchElementException : NotFoundException`
`29`	`29`	`{`
	`30`	`+`
	`31`	`+ /// <summary>`
	`32`	`+ /// Link to the documentation for this error`
	`33`	`+ /// </summary>`
	`34`	`+ private static string supportUrl = baseSupportUrl + "#no-such-element-exception";`
	`35`	`+`
`30`	`36`	`/// <summary>`
`31`	`37`	`/// Initializes a new instance of the <see cref="NoSuchElementException"/> class.`
`32`	`38`	`/// </summary>`
`33`	`39`	`public NoSuchElementException()`
`34`		`- : base()`
	`40`	`+ : base(GetMessage(""))`
`35`	`41`	`{`
`36`	`42`	`}`
`37`	`43`
`@@ -41,7 +47,7 @@ public NoSuchElementException()`
`41`	`47`	`/// </summary>`
`42`	`48`	`/// <param name="message">The message that describes the error.</param>`
`43`	`49`	`public NoSuchElementException(string message)`
`44`		`- : base(message)`
	`50`	`+ : base(GetMessage(message))`
`45`	`51`	`{`
`46`	`52`	`}`
`47`	`53`
`@@ -54,7 +60,7 @@ public NoSuchElementException(string message)`
`54`	`60`	`/// <param name="innerException">The exception that is the cause of the current exception,`
`55`	`61`	`/// or <see langword="null"/> if no inner exception is specified.</param>`
`56`	`62`	`public NoSuchElementException(string message, Exception innerException)`
`57`		`- : base(message, innerException)`
	`63`	`+ : base(GetMessage(message), innerException)`
`58`	`64`	`{`
`59`	`65`	`}`
`60`	`66`
`@@ -69,5 +75,15 @@ protected NoSuchElementException(SerializationInfo info, StreamingContext contex`
`69`	`75`	`: base(info, context)`
`70`	`76`	`{`
`71`	`77`	`}`
	`78`	`+`
	`79`	`+ /// <summary>`
	`80`	`+ /// Add information about obtaining additional support from documentation to this exception.`
	`81`	`+ /// </summary>`
	`82`	`+ /// <param name="message">The original message for exception</param>`
	`83`	`+ /// <returns>The final message for exception</returns>`
	`84`	`+ protected static string GetMessage(string message)`
	`85`	`+ {`
	`86`	`+ return message + "; " + supportMsg + supportUrl;`
	`87`	`+ }`
`72`	`88`	`}`
`73`	`89`	`}`