Using SNI errors as uint as far as possible (dotnet#3017)

benrr101 · web-flow · commit 1b9df102761e · 2024-11-19T15:12:19.000-06:00
(Also setting myself up for failure when merging LocalDBAPI, but whatever)
diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/LocalDBAPI.Common.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/LocalDBAPI.Common.cs
@@ -93,28 +93,29 @@ internal static string GetLocalDBMessage(int hrCode)
         }
 
 
-        private static SqlException CreateLocalDBException(string errorMessage, string instance = null, int localDbError = 0, int sniError = 0)
+        private static SqlException CreateLocalDBException(string errorMessage, uint sniError = 0)
         {
-            Debug.Assert((localDbError == 0) || (sniError == 0), "LocalDB error and SNI error cannot be specified simultaneously");
             Debug.Assert(!string.IsNullOrEmpty(errorMessage), "Error message should not be null or empty");
-            SqlErrorCollection collection = new SqlErrorCollection();
-
-            int errorCode = (localDbError == 0) ? sniError : localDbError;
 
             if (sniError != 0)
             {
                 string sniErrorMessage = SQL.GetSNIErrorMessage(sniError);
-                errorMessage = string.Format("{0} (error: {1} - {2})",
-                         errorMessage, sniError, sniErrorMessage);
+                errorMessage = $"{errorMessage} (error: {sniError} - {sniErrorMessage})";
             }
 
-            collection.Add(new SqlError(errorCode, 0, TdsEnums.FATAL_ERROR_CLASS, instance, errorMessage, null, 0));
-
-            if (localDbError != 0)
-                collection.Add(new SqlError(errorCode, 0, TdsEnums.FATAL_ERROR_CLASS, instance, GetLocalDBMessage(localDbError), null, 0));
-
-            SqlException exc = SqlException.CreateException(collection, null);
-
+            SqlErrorCollection collection = new SqlErrorCollection
+            {
+                new SqlError(
+                    infoNumber: (int)sniError,
+                    errorState: 0,
+                    errorClass: TdsEnums.FATAL_ERROR_CLASS,
+                    server: null,
+                    errorMessage,
+                    procedure: null,
+                    lineNumber: 0)
+            };
+
+            SqlException exc = SqlException.CreateException(collection, serverVersion: null);
             exc._doNotReconnect = true;
 
             return exc;
diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/LocalDBAPI.Windows.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/LocalDBAPI.Windows.cs
@@ -30,7 +30,7 @@ private static IntPtr UserInstanceDLLHandle
                             else
                             {
                                 SNINativeMethodWrapper.SNIGetLastError(out SniError sniError);
-                                throw CreateLocalDBException(errorMessage: StringsHelper.GetString("LocalDB_FailedGetDLLHandle"), sniError: (int)sniError.sniError);
+                                throw CreateLocalDBException(StringsHelper.GetString("LocalDB_FailedGetDLLHandle"), sniError.sniError);
                             }
                         }
                     }
diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParser.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/TdsParser.cs
@@ -1577,15 +1577,15 @@ internal SqlError ProcessSNIError(TdsParserStateObject stateObj)
                     if (TdsParserStateObjectFactory.UseManagedSNI)
                     {
                         // SNI error. Append additional error message info if available and hasn't been included.
-                        string sniLookupMessage = SQL.GetSNIErrorMessage((int)details.sniErrorNumber);
+                        string sniLookupMessage = SQL.GetSNIErrorMessage(details.sniErrorNumber);
                         errorMessage = (string.IsNullOrEmpty(errorMessage) || errorMessage.Contains(sniLookupMessage))
                                         ? sniLookupMessage
                                         : (sniLookupMessage + ": " + errorMessage);
                     }
                     else
                     {
                         // SNI error. Replace the entire message.
-                        errorMessage = SQL.GetSNIErrorMessage((int)details.sniErrorNumber);
+                        errorMessage = SQL.GetSNIErrorMessage(details.sniErrorNumber);
 
                         // If its a LocalDB error, then nativeError actually contains a LocalDB-specific error code, not a win32 error code
                         if (details.sniErrorNumber == SniErrors.LocalDBErrorCode)
diff --git a/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/LocalDBAPI.cs b/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/LocalDBAPI.cs
@@ -90,7 +90,7 @@ static IntPtr UserInstanceDLLHandle
                             {
                                 SniError sniError = new SniError();
                                 SNINativeMethodWrapper.SNIGetLastError(out sniError);
-                                throw CreateLocalDBException(errorMessage: StringsHelper.GetString("LocalDB_FailedGetDLLHandle"), sniError: (int)sniError.sniError);
+                                throw CreateLocalDBException(errorMessage: StringsHelper.GetString("LocalDB_FailedGetDLLHandle"), sniError: sniError.sniError);
                             }
                         }
                     }
@@ -224,13 +224,13 @@ internal static string GetLocalDBMessage(int hrCode)
         }
 
 
-        static SqlException CreateLocalDBException(string errorMessage, string instance = null, int localDbError = 0, int sniError = 0)
+        static SqlException CreateLocalDBException(string errorMessage, string instance = null, int localDbError = 0, uint sniError = 0)
         {
             Debug.Assert((localDbError == 0) || (sniError == 0), "LocalDB error and SNI error cannot be specified simultaneously");
             Debug.Assert(!string.IsNullOrEmpty(errorMessage), "Error message should not be null or empty");
             SqlErrorCollection collection = new SqlErrorCollection();
 
-            int errorCode = (localDbError == 0) ? sniError : localDbError;
+            int errorCode = (localDbError == 0) ? (int)sniError : localDbError;
 
             if (sniError != 0)
             {
diff --git a/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParser.cs b/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/SqlClient/TdsParser.cs
@@ -1872,9 +1872,9 @@ internal SqlError ProcessSNIError(TdsParserStateObject stateObj)
             }
             else
             {
-                    // SNI error. Replace the entire message
-                    //
-                    errorMessage = SQL.GetSNIErrorMessage((int)sniError.sniError);
+                // SNI error. Replace the entire message
+                //
+                errorMessage = SQL.GetSNIErrorMessage(sniError.sniError);
 
                 // If its a LocalDB error, then nativeError actually contains a LocalDB-specific error code, not a win32 error code
                 if (sniError.sniError == SniErrors.LocalDBErrorCode)
diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlUtil.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlUtil.cs
@@ -1421,22 +1421,19 @@ internal static Exception MultiSubnetFailoverWithFailoverPartner(bool serverProv
 
         internal static Exception MultiSubnetFailoverWithMoreThan64IPs()
         {
-            // @TODO: This can be uint
-            string msg = GetSNIErrorMessage((int)SniErrors.MultiSubnetFailoverWithMoreThan64IPs);
+            string msg = GetSNIErrorMessage(SniErrors.MultiSubnetFailoverWithMoreThan64IPs);
             return ADP.InvalidOperation(msg);
         }
 
         internal static Exception MultiSubnetFailoverWithInstanceSpecified()
         {
-            // @TODO: This can be uint
-            string msg = GetSNIErrorMessage((int)SniErrors.MultiSubnetFailoverWithInstanceSpecified);
+            string msg = GetSNIErrorMessage(SniErrors.MultiSubnetFailoverWithInstanceSpecified);
             return ADP.Argument(msg);
         }
 
         internal static Exception MultiSubnetFailoverWithNonTcpProtocol()
         {
-            // @TODO: This can be uint
-            string msg = GetSNIErrorMessage((int)SniErrors.MultiSubnetFailoverWithNonTcpProtocol);
+            string msg = GetSNIErrorMessage(SniErrors.MultiSubnetFailoverWithNonTcpProtocol);
             return ADP.Argument(msg);
         }
 
@@ -2485,10 +2482,9 @@ static internal Exception TooManyValues(string arg)
         /// <summary>
         /// gets a message for SNI error (sniError must be valid, non-zero error code)
         /// </summary>
-        // @TODO: This can be uint
-        internal static string GetSNIErrorMessage(int sniError)
+        internal static string GetSNIErrorMessage(uint sniError)
         {
-            Debug.Assert(sniError > 0 && sniError <= (int)SniErrors.MaxErrorValue, "SNI error is out of range");
+            Debug.Assert(sniError > 0 && sniError <= SniErrors.MaxErrorValue, "SNI error is out of range");
 
             string errorMessageId = string.Format("SNI_ERROR_{0}", sniError);
             return StringsHelper.GetResourceString(errorMessageId);

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ private static IntPtr UserInstanceDLLHandle`
`30`	`30`	`else`
`31`	`31`	`{`
`32`	`32`	`SNINativeMethodWrapper.SNIGetLastError(out SniError sniError);`
`33`		`- throw CreateLocalDBException(errorMessage: StringsHelper.GetString("LocalDB_FailedGetDLLHandle"), sniError: (int)sniError.sniError);`
	`33`	`+ throw CreateLocalDBException(StringsHelper.GetString("LocalDB_FailedGetDLLHandle"), sniError.sniError);`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1577,15 +1577,15 @@ internal SqlError ProcessSNIError(TdsParserStateObject stateObj)`
`1577`	`1577`	`if (TdsParserStateObjectFactory.UseManagedSNI)`
`1578`	`1578`	`{`
`1579`	`1579`	`// SNI error. Append additional error message info if available and hasn't been included.`
`1580`		`- string sniLookupMessage = SQL.GetSNIErrorMessage((int)details.sniErrorNumber);`
	`1580`	`+ string sniLookupMessage = SQL.GetSNIErrorMessage(details.sniErrorNumber);`
`1581`	`1581`	`errorMessage = (string.IsNullOrEmpty(errorMessage) \|\| errorMessage.Contains(sniLookupMessage))`
`1582`	`1582`	`? sniLookupMessage`
`1583`	`1583`	`: (sniLookupMessage + ": " + errorMessage);`
`1584`	`1584`	`}`
`1585`	`1585`	`else`
`1586`	`1586`	`{`
`1587`	`1587`	`// SNI error. Replace the entire message.`
`1588`		`- errorMessage = SQL.GetSNIErrorMessage((int)details.sniErrorNumber);`
	`1588`	`+ errorMessage = SQL.GetSNIErrorMessage(details.sniErrorNumber);`
`1589`	`1589`
`1590`	`1590`	`// If its a LocalDB error, then nativeError actually contains a LocalDB-specific error code, not a win32 error code`
`1591`	`1591`	`if (details.sniErrorNumber == SniErrors.LocalDBErrorCode)`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ static IntPtr UserInstanceDLLHandle`
`90`	`90`	`{`
`91`	`91`	`SniError sniError = new SniError();`
`92`	`92`	`SNINativeMethodWrapper.SNIGetLastError(out sniError);`
`93`		`- throw CreateLocalDBException(errorMessage: StringsHelper.GetString("LocalDB_FailedGetDLLHandle"), sniError: (int)sniError.sniError);`
	`93`	`+ throw CreateLocalDBException(errorMessage: StringsHelper.GetString("LocalDB_FailedGetDLLHandle"), sniError: sniError.sniError);`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`	`}`
`@@ -224,13 +224,13 @@ internal static string GetLocalDBMessage(int hrCode)`
`224`	`224`	`}`
`225`	`225`
`226`	`226`
`227`		`- static SqlException CreateLocalDBException(string errorMessage, string instance = null, int localDbError = 0, int sniError = 0)`
	`227`	`+ static SqlException CreateLocalDBException(string errorMessage, string instance = null, int localDbError = 0, uint sniError = 0)`
`228`	`228`	`{`
`229`	`229`	`Debug.Assert((localDbError == 0) \|\| (sniError == 0), "LocalDB error and SNI error cannot be specified simultaneously");`
`230`	`230`	`Debug.Assert(!string.IsNullOrEmpty(errorMessage), "Error message should not be null or empty");`
`231`	`231`	`SqlErrorCollection collection = new SqlErrorCollection();`
`232`	`232`
`233`		`- int errorCode = (localDbError == 0) ? sniError : localDbError;`
	`233`	`+ int errorCode = (localDbError == 0) ? (int)sniError : localDbError;`
`234`	`234`
`235`	`235`	`if (sniError != 0)`
`236`	`236`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1872,9 +1872,9 @@ internal SqlError ProcessSNIError(TdsParserStateObject stateObj)`
`1872`	`1872`	`}`
`1873`	`1873`	`else`
`1874`	`1874`	`{`
`1875`		`- // SNI error. Replace the entire message`
`1876`		`- //`
`1877`		`- errorMessage = SQL.GetSNIErrorMessage((int)sniError.sniError);`
	`1875`	`+ // SNI error. Replace the entire message`
	`1876`	`+ //`
	`1877`	`+ errorMessage = SQL.GetSNIErrorMessage(sniError.sniError);`
`1878`	`1878`
`1879`	`1879`	`// If its a LocalDB error, then nativeError actually contains a LocalDB-specific error code, not a win32 error code`
`1880`	`1880`	`if (sniError.sniError == SniErrors.LocalDBErrorCode)`
Original file line number	Diff line number	Diff line change
`@@ -1421,22 +1421,19 @@ internal static Exception MultiSubnetFailoverWithFailoverPartner(bool serverProv`
`1421`	`1421`
`1422`	`1422`	`internal static Exception MultiSubnetFailoverWithMoreThan64IPs()`
`1423`	`1423`	`{`
`1424`		`- // @TODO: This can be uint`
`1425`		`- string msg = GetSNIErrorMessage((int)SniErrors.MultiSubnetFailoverWithMoreThan64IPs);`
	`1424`	`+ string msg = GetSNIErrorMessage(SniErrors.MultiSubnetFailoverWithMoreThan64IPs);`
`1426`	`1425`	`return ADP.InvalidOperation(msg);`
`1427`	`1426`	`}`
`1428`	`1427`
`1429`	`1428`	`internal static Exception MultiSubnetFailoverWithInstanceSpecified()`
`1430`	`1429`	`{`
`1431`		`- // @TODO: This can be uint`
`1432`		`- string msg = GetSNIErrorMessage((int)SniErrors.MultiSubnetFailoverWithInstanceSpecified);`
	`1430`	`+ string msg = GetSNIErrorMessage(SniErrors.MultiSubnetFailoverWithInstanceSpecified);`
`1433`	`1431`	`return ADP.Argument(msg);`
`1434`	`1432`	`}`
`1435`	`1433`
`1436`	`1434`	`internal static Exception MultiSubnetFailoverWithNonTcpProtocol()`
`1437`	`1435`	`{`
`1438`		`- // @TODO: This can be uint`
`1439`		`- string msg = GetSNIErrorMessage((int)SniErrors.MultiSubnetFailoverWithNonTcpProtocol);`
	`1436`	`+ string msg = GetSNIErrorMessage(SniErrors.MultiSubnetFailoverWithNonTcpProtocol);`
`1440`	`1437`	`return ADP.Argument(msg);`
`1441`	`1438`	`}`
`1442`	`1439`
`@@ -2485,10 +2482,9 @@ static internal Exception TooManyValues(string arg)`
`2485`	`2482`	`/// <summary>`
`2486`	`2483`	`/// gets a message for SNI error (sniError must be valid, non-zero error code)`
`2487`	`2484`	`/// </summary>`
`2488`		`- // @TODO: This can be uint`
`2489`		`- internal static string GetSNIErrorMessage(int sniError)`
	`2485`	`+ internal static string GetSNIErrorMessage(uint sniError)`
`2490`	`2486`	`{`
`2491`		`- Debug.Assert(sniError > 0 && sniError <= (int)SniErrors.MaxErrorValue, "SNI error is out of range");`
	`2487`	`+ Debug.Assert(sniError > 0 && sniError <= SniErrors.MaxErrorValue, "SNI error is out of range");`
`2492`	`2488`
`2493`	`2489`	`string errorMessageId = string.Format("SNI_ERROR_{0}", sniError);`
`2494`	`2490`	`return StringsHelper.GetResourceString(errorMessageId);`