Suppress existing violations for S4462 and turn the rule on (#1553)

Author: bart-vmware

Steeltoe.Debug.ruleset

@@ -107,6 +107,7 @@
     <Rule Id="S4277" Action="None" />
     <Rule Id="S4428" Action="None" />
     <Rule Id="S4433" Action="None" />
+    <Rule Id="S4462" Action="Warning" />
     <Rule Id="S4487" Action="Info" />
     <Rule Id="S4583" Action="None" />
     <Rule Id="S4663" Action="Info" />

Steeltoe.Release.ruleset

@@ -94,6 +94,7 @@
     <Rule Id="S4277" Action="None" />
     <Rule Id="S4428" Action="None" />
     <Rule Id="S4433" Action="None" />
+    <Rule Id="S4462" Action="Warning" />
     <Rule Id="S4583" Action="None" />
     <Rule Id="S6354" Action="Warning" />
     <Rule Id="S6419" Action="None" />

src/Configuration/src/ConfigServer/ConfigServerConfigurationProvider.cs

@@ -132,7 +132,10 @@ private void OnSettingsChanged()
         {
             if (_refreshTimer == null)
             {
+#pragma warning disable S4462 // Calls to "async" methods should not be blocking
+                // Justification: Configuration sources and providers don't support async.
                 _refreshTimer = new Timer(_ => DoPolledLoadAsync().GetAwaiter().GetResult(), null, TimeSpan.Zero, ClientOptions.PollingInterval);
+#pragma warning restore S4462 // Calls to "async" methods should not be blocking
             }
             else if (existingPollingInterval != ClientOptions.PollingInterval)
             {
@@ -197,7 +200,10 @@ private async Task DoPolledLoadAsync()
     /// </summary>
     public override void Load()
     {
+#pragma warning disable S4462 // Calls to "async" methods should not be blocking
+        // Justification: Configuration sources and providers don't support async.
         LoadInternalAsync(true, CancellationToken.None).GetAwaiter().GetResult();
+#pragma warning restore S4462 // Calls to "async" methods should not be blocking
     }
 
     internal async Task<ConfigEnvironment?> LoadInternalAsync(bool updateDictionary, CancellationToken cancellationToken)
@@ -695,8 +701,11 @@ private void AddPropertySource(PropertySource? source, Dictionary<string, string
 
     private void RenewToken()
     {
+#pragma warning disable S4462 // Calls to "async" methods should not be blocking
+        // Justification: Configuration sources and providers don't support async.
         _ = new Timer(_ => RefreshVaultTokenAsync(CancellationToken.None).GetAwaiter().GetResult(), null,
             TimeSpan.FromMilliseconds(ClientOptions.TokenRenewRate), TimeSpan.FromMilliseconds(ClientOptions.TokenRenewRate));
+#pragma warning restore S4462 // Calls to "async" methods should not be blocking
     }
 
     // fire and forget

src/Discovery/src/Consul/ConsulDiscoveryClient.cs

@@ -54,7 +54,10 @@ public ConsulDiscoveryClient(IConsulClient client, IOptionsMonitor<ConsulDiscove
         _thisServiceInstance = new ThisServiceInstance(registrar.Registration);
         _registrar = registrar;
 
+#pragma warning disable S4462 // Calls to "async" methods should not be blocking
+        // Justification: Async calls from a constructor are not possible. To fix this, an alternate design is needed.
         _registrar.StartAsync(CancellationToken.None).GetAwaiter().GetResult();
+#pragma warning restore S4462 // Calls to "async" methods should not be blocking
     }
 
     private static ConsulServiceRegistrar CreateRegistrar(IConsulClient client, IOptionsMonitor<ConsulDiscoveryOptions> optionsMonitor,

src/Discovery/src/Eureka/EurekaDiscoveryClient.cs

@@ -107,7 +107,10 @@ public EurekaDiscoveryClient(EurekaApplicationInfoManager appInfoManager, Eureka
                 try
                 {
                     // Only register when periodically refreshing. Just once at startup doesn't make sense.
+#pragma warning disable S4462 // Calls to "async" methods should not be blocking
+                    // Justification: Async calls from a constructor are not possible. To fix this, an alternate design is needed.
                     RegisterAsync(false, CancellationToken.None).GetAwaiter().GetResult();
+#pragma warning restore S4462 // Calls to "async" methods should not be blocking
                 }
                 catch (Exception exception)
                 {
@@ -125,7 +128,10 @@ public EurekaDiscoveryClient(EurekaApplicationInfoManager appInfoManager, Eureka
         {
             try
             {
+#pragma warning disable S4462 // Calls to "async" methods should not be blocking
+                // Justification: Async calls from a constructor are not possible. To fix this, an alternate design is needed.
                 FetchRegistryAsync(true, CancellationToken.None).GetAwaiter().GetResult();
+#pragma warning restore S4462 // Calls to "async" methods should not be blocking
             }
             catch (Exception exception)
             {

src/Security/src/Authentication.JwtBearer/TokenKeyResolver.cs

@@ -37,9 +37,11 @@ internal SecurityKey[] ResolveSigningKey(string keyId)
             return [resolved];
         }
 
-        // can't be async all the way until updates are complete in Microsoft libraries
+#pragma warning disable S4462 // Calls to "async" methods should not be blocking
+        // Justification: can't be async all the way until updates are complete in Microsoft libraries
         // https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/issues/468
         JsonWebKeySet? keySet = FetchKeySetAsync(CancellationToken.None).GetAwaiter().GetResult();
+#pragma warning restore S4462 // Calls to "async" methods should not be blocking
 
         if (keySet != null)
         {

src/Security/src/Authentication.OpenIdConnect/TokenKeyResolver.cs

@@ -37,9 +37,11 @@ internal SecurityKey[] ResolveSigningKey(string keyId)
             return [resolved];
         }
 
-        // can't be async all the way until updates are complete in Microsoft libraries
+#pragma warning disable S4462 // Calls to "async" methods should not be blocking
+        // Justification: can't be async all the way until updates are complete in Microsoft libraries
         // https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/issues/468
         JsonWebKeySet? keySet = FetchKeySetAsync(CancellationToken.None).GetAwaiter().GetResult();
+#pragma warning restore S4462 // Calls to "async" methods should not be blocking
 
         if (keySet != null)
         {