Address comments

+ improvement
dotnet · May 11, 2021 · c41b411 · c41b411
1 parent 4a1d7f7
commit c41b411
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 104 deletions.
diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/Common/DbConnectionStringCommon.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/Common/DbConnectionStringCommon.cs
@@ -3,8 +3,10 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.Globalization;
+using System.Linq;
 using System.Reflection;
 using Microsoft.Data.SqlClient;
 
@@ -401,66 +403,46 @@ internal static SqlConnectionAttestationProtocol ConvertToAttestationProtocol(st
  #endregion
 
  #region <<IPAddressPreference Utility>>
-
  /// <summary>
  /// IP Address Preference.
  /// </summary>
- const string IPAddrPreference46 = "IPv4First";
- const string IPAddrPreference64 = "IPv6First";
- const string IPAddrPreferenceOS = "UsePlatformDefault";
-
+ private readonly static Dictionary<string, SqlConnectionIPAddressPreference> s_preferenceNames = new(StringComparer.InvariantCultureIgnoreCase);
+
+ static DbConnectionStringBuilderUtil()
+ {
+ foreach (SqlConnectionIPAddressPreference item in Enum.GetValues(typeof(SqlConnectionIPAddressPreference)))
+ {
+ s_preferenceNames.Add(item.ToString(), item);
+ }
+ }
+
  /// <summary>
- /// Convert a string value to the corresponding IPAddressPreference
+ /// Convert a string value to the corresponding IPAddressPreference.
  /// </summary>
- /// <param name="value"></param>
- /// <param name="result"></param>
- /// <returns></returns>
+ /// <param name="value">The string representation of the enumeration name to convert.</param>
+ /// <param name="result">When this method returns, `result` contains an object of type `SqlConnectionIPAddressPreference` whose value is represented by `value` if the operation succeeds. 
+ /// If the parse operation fails, `result` contains the default value of the `SqlConnectionIPAddressPreference` type.</param>
+ /// <returns>`true` if the value parameter was converted successfully; otherwise, `false`.</returns>
  internal static bool TryConvertToIPAddressPreference(string value, out SqlConnectionIPAddressPreference result)
  {
- if (StringComparer.InvariantCultureIgnoreCase.Equals(value, IPAddrPreference46))
- {
- result = SqlConnectionIPAddressPreference.IPv4First;
- return true;
- }
- else if (StringComparer.InvariantCultureIgnoreCase.Equals(value, IPAddrPreference64))
- {
- result = SqlConnectionIPAddressPreference.IPv6First;
- return true;
- }
- else if (StringComparer.InvariantCultureIgnoreCase.Equals(value, IPAddrPreferenceOS))
- {
- result = SqlConnectionIPAddressPreference.UsePlatformDefault;
- return true;
- }
- else
+ if (!s_preferenceNames.TryGetValue(value, out result))
  {
  result = DbConnectionStringDefaults.IPAddressPreference;
  return false;
  }
+ return true;
  }
 
+ /// <summary>
+ /// Verifies if the `value` is defined in the expected Enum.
+ /// </summary>
  internal static bool IsValidIPAddressPreference(SqlConnectionIPAddressPreference value)
- {
- Debug.Assert(Enum.GetNames(typeof(SqlConnectionIPAddressPreference)).Length == 3, "SqlConnectionIPAddressPreference enum has changed, update needed");
- return value == SqlConnectionIPAddressPreference.IPv4First
+ => value == SqlConnectionIPAddressPreference.IPv4First
  || value == SqlConnectionIPAddressPreference.IPv6First
  || value == SqlConnectionIPAddressPreference.UsePlatformDefault;
- }
 
  internal static string IPAddressPreferenceToString(SqlConnectionIPAddressPreference value)
- {
- Debug.Assert(IsValidIPAddressPreference(value), "value is not a valid IP address preference");
-
- switch (value)
- {
- case SqlConnectionIPAddressPreference.UsePlatformDefault:
- return IPAddrPreferenceOS;
- case SqlConnectionIPAddressPreference.IPv6First:
- return IPAddrPreference64;
- default:
- return IPAddrPreference46;
- }
- }
+ => Enum.GetName(typeof(SqlConnectionIPAddressPreference), value);
 
  internal static SqlConnectionIPAddressPreference ConvertToIPAddressPreference(string keyword, object value)
  {
@@ -523,8 +505,6 @@ internal static SqlConnectionIPAddressPreference ConvertToIPAddressPreference(st
  }
  }
  }
-
-
  #endregion
 
  internal static bool IsValidApplicationIntentValue(ApplicationIntent value)

diff --git a/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs b/src/Microsoft.Data.SqlClient/netcore/src/Microsoft/Data/SqlClient/SNI/SNITcpHandle.cs
@@ -176,26 +176,26 @@ public SNITCPHandle(string serverName, int port, long timerExpire, bool parallel
  int portRetry = string.IsNullOrEmpty(cachedDNSInfo.Port) ? port : int.Parse(cachedDNSInfo.Port);
  SqlClientEventSource.Log.TrySNITraceEvent(s_className, EventType.INFO, "Connection Id {0}, Retrying with cached DNS IP Address {1} and port {2}", args0: _connectionId, args1: cachedDNSInfo.AddrIPv4, args2: cachedDNSInfo.Port);
 
- string cachedIPA;
- string cachedIPB;
+ string firstCachedIP;
+ string secondCachedIP;
 
  if (SqlConnectionIPAddressPreference.IPv6First == ipPreference) {
- cachedIPA = cachedDNSInfo.AddrIPv6;
- cachedIPB = cachedDNSInfo.AddrIPv4;
+ firstCachedIP = cachedDNSInfo.AddrIPv6;
+ secondCachedIP = cachedDNSInfo.AddrIPv4;
  } else {
- cachedIPA = cachedDNSInfo.AddrIPv4;
- cachedIPB = cachedDNSInfo.AddrIPv6;
+ firstCachedIP = cachedDNSInfo.AddrIPv4;
+ secondCachedIP = cachedDNSInfo.AddrIPv6;
  }
 
  try
  {
  if (parallel)
  {
- _socket = TryConnectParallel(cachedIPA, portRetry, ts, isInfiniteTimeOut, ref reportError, cachedFQDN, ref pendingDNSInfo);
+ _socket = TryConnectParallel(firstCachedIP, portRetry, ts, isInfiniteTimeOut, ref reportError, cachedFQDN, ref pendingDNSInfo);
  }
  else
  {
- _socket = Connect(cachedIPA, portRetry, ts, isInfiniteTimeOut, ipPreference, cachedFQDN, ref pendingDNSInfo);
+ _socket = Connect(firstCachedIP, portRetry, ts, isInfiniteTimeOut, ipPreference, cachedFQDN, ref pendingDNSInfo);
  }
  }
  catch (Exception exRetry)
@@ -206,11 +206,11 @@ public SNITCPHandle(string serverName, int port, long timerExpire, bool parallel
  SqlClientEventSource.Log.TrySNITraceEvent(s_className, EventType.INFO, "Connection Id {0}, Retrying exception {1}", args0: _connectionId, args1: exRetry?.Message);
  if (parallel)
  {
- _socket = TryConnectParallel(cachedIPB, portRetry, ts, isInfiniteTimeOut, ref reportError, cachedFQDN, ref pendingDNSInfo);
+ _socket = TryConnectParallel(secondCachedIP, portRetry, ts, isInfiniteTimeOut, ref reportError, cachedFQDN, ref pendingDNSInfo);
  }
  else
  {
- _socket = Connect(cachedIPB, portRetry, ts, isInfiniteTimeOut, ipPreference, cachedFQDN, ref pendingDNSInfo);
+ _socket = Connect(secondCachedIP, portRetry, ts, isInfiniteTimeOut, ipPreference, cachedFQDN, ref pendingDNSInfo);
  }
  }
  else

diff --git a/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/Common/DbConnectionStringCommon.cs b/src/Microsoft.Data.SqlClient/netfx/src/Microsoft/Data/Common/DbConnectionStringCommon.cs
@@ -6,6 +6,7 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Globalization;
+using System.Linq;
 using Microsoft.Data.SqlClient;
 
 namespace Microsoft.Data.Common
@@ -999,82 +1000,60 @@ internal static SqlConnectionAttestationProtocol ConvertToAttestationProtocol(st
  #endregion
 
  #region <<IPAddressPreference Utility>>
-
  /// <summary>
  /// IP Address Preference.
  /// </summary>
- const string IPAddrPreference46 = "IPv4First";
- const string IPAddrPreference64 = "IPv6First";
- const string IPAddrPreferenceOS = "UsePlatformDefault";
-
+ private readonly static Dictionary<string, SqlConnectionIPAddressPreference> s_preferenceNames = new(StringComparer.InvariantCultureIgnoreCase);
+
+ static DbConnectionStringBuilderUtil()
+ {
+ foreach (SqlConnectionIPAddressPreference item in Enum.GetValues(typeof(SqlConnectionIPAddressPreference)))
+ {
+ s_preferenceNames.Add(item.ToString(), item);
+ }
+ }
+
  /// <summary>
- /// Convert a string value to the corresponding IPAddressPreference
+ /// Convert a string value to the corresponding IPAddressPreference.
  /// </summary>
- /// <param name="value"></param>
- /// <param name="result"></param>
- /// <returns></returns>
+ /// <param name="value">The string representation of the enumeration name to convert.</param>
+ /// <param name="result">When this method returns, `result` contains an object of type `SqlConnectionIPAddressPreference` whose value is represented by `value` if the operation succeeds. 
+ /// If the parse operation fails, `result` contains the default value of the `SqlConnectionIPAddressPreference` type.</param>
+ /// <returns>`true` if the value parameter was converted successfully; otherwise, `false`.</returns>
  internal static bool TryConvertToIPAddressPreference(string value, out SqlConnectionIPAddressPreference result)
  {
- if (StringComparer.InvariantCultureIgnoreCase.Equals(value, IPAddrPreference46))
- {
- result = SqlConnectionIPAddressPreference.IPv4First;
- return true;
- }
- else if (StringComparer.InvariantCultureIgnoreCase.Equals(value, IPAddrPreference64))
- {
- result = SqlConnectionIPAddressPreference.IPv6First;
- return true;
- }
- else if (StringComparer.InvariantCultureIgnoreCase.Equals(value, IPAddrPreferenceOS))
- {
- result = SqlConnectionIPAddressPreference.UsePlatformDefault;
- return true;
- }
- else
+ if (!s_preferenceNames.TryGetValue(value, out result))
  {
  result = DbConnectionStringDefaults.IPAddressPreference;
  return false;
  }
+ return true;
  }
 
+ /// <summary>
+ /// Verifies if the `value` is defined in the expected Enum.
+ /// </summary>
  internal static bool IsValidIPAddressPreference(SqlConnectionIPAddressPreference value)
- {
- Debug.Assert(Enum.GetNames(typeof(SqlConnectionIPAddressPreference)).Length == 3, "SqlConnectionIPAddressPreference enum has changed, update needed");
- return value == SqlConnectionIPAddressPreference.IPv4First
+ => value == SqlConnectionIPAddressPreference.IPv4First
  || value == SqlConnectionIPAddressPreference.IPv6First
  || value == SqlConnectionIPAddressPreference.UsePlatformDefault;
- }
 
  internal static string IPAddressPreferenceToString(SqlConnectionIPAddressPreference value)
- {
- Debug.Assert(IsValidIPAddressPreference(value), "value is not a valid IP address preference");
-
- switch (value)
- {
- case SqlConnectionIPAddressPreference.UsePlatformDefault:
- return IPAddrPreferenceOS;
- case SqlConnectionIPAddressPreference.IPv6First:
- return IPAddrPreference64;
- default:
- return IPAddrPreference46;
- }
- }
+ => Enum.GetName(typeof(SqlConnectionIPAddressPreference), value);
 
  internal static SqlConnectionIPAddressPreference ConvertToIPAddressPreference(string keyword, object value)
  {
- if (null == value)
+ if (value is null)
  {
  return DbConnectionStringDefaults.IPAddressPreference; // IPv4First
  }
 
  string sValue = (value as string);
- SqlConnectionIPAddressPreference result;
-
- if (null != sValue)
+ if (sValue is not null)
  {
  // try again after remove leading & trailing whitespaces.
  sValue = sValue.Trim();
- if (TryConvertToIPAddressPreference(sValue, out result))
+ if (TryConvertToIPAddressPreference(sValue, out SqlConnectionIPAddressPreference result))
  {
  return result;
  }
@@ -1087,9 +1066,9 @@ internal static SqlConnectionIPAddressPreference ConvertToIPAddressPreference(st
  // the value is not string, try other options
  SqlConnectionIPAddressPreference eValue;
 
- if (value is SqlConnectionIPAddressPreference)
+ if (value is SqlConnectionIPAddressPreference preference)
  {
- eValue = (SqlConnectionIPAddressPreference)value;
+ eValue = preference;
  }
  else if (value.GetType().IsEnum)
  {
@@ -1123,7 +1102,6 @@ internal static SqlConnectionIPAddressPreference ConvertToIPAddressPreference(st
  }
  }
  }
-
  #endregion
 
  internal static bool IsValidCertificateValue(string value)