fix analyzer warnings: SA1210, SA1414, VSTHRD002, CA1849, VSTHRD103, VSTHRD104 (#341)

Author: RushabhBhansali

.editorconfig

@@ -463,14 +463,6 @@ dotnet_naming_rule.parameters_rule.severity             = warning
 # Using directive should appear within a namespace declaration
 dotnet_diagnostic.SA1200.severity = suggestion
 
-# https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1210.md
-#  Using directives should be ordered alphabetically by the namespaces
-dotnet_diagnostic.SA1210.severity = suggestion
-
-# https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1414.md
-# Tuple types in signatures should have element names
-dotnet_diagnostic.SA1414.severity = suggestion
-
 # https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1600.md
 # Elements should be documented
 dotnet_diagnostic.SA1600.severity = suggestion
@@ -500,22 +492,10 @@ dotnet_diagnostic.SA1642.severity = suggestion
 # https://github.com/Microsoft/vs-threading
 ##########################################
 
-# https://github.com/microsoft/vs-threading/blob/main/doc/analyzers/VSTHRD002.md
-# Synchronously waiting on tasks or awaiters may cause deadlocks. Use await or JoinableTaskFactory.Run instead.
-dotnet_diagnostic.VSTHRD002.severity = suggestion
-
-# https://github.com/microsoft/vs-threading/blob/main/doc/analyzers/VSTHRD103.md
-# Result synchronously blocks. Use await instead.
-dotnet_diagnostic.VSTHRD103.severity = suggestion
-
 # https://github.com/microsoft/vs-threading/blob/main/doc/analyzers/VSTHRD101.md
 # Avoid using async lambda for a void returning delegate type, because any exceptions not handled by the delegate will crash the process
 dotnet_diagnostic.VSTHRD101.severity = suggestion
 
-# https://github.com/microsoft/vs-threading/blob/main/doc/analyzers/VSTHRD104.md
-# Expose an async version of this method that does not synchronously block. Then simplify this method to call that async method within a JoinableTaskFactory.Run delegate.
-dotnet_diagnostic.VSTHRD104.severity = suggestion
-
 # https://github.com/microsoft/vs-threading/blob/main/doc/analyzers/VSTHRD111.md
 # Add .ConfigureAwait(bool) to your await expression
 dotnet_diagnostic.VSTHRD111.severity = suggestion
@@ -660,9 +640,6 @@ dotnet_diagnostic.CA1056.severity = suggestion
 # CA1838: Avoid 'StringBuilder' parameters for P/Invokes
 dotnet_diagnostic.CA1838.severity = suggestion
 
-# CA1849: Call async methods when in an async method
-dotnet_diagnostic.CA1849.severity = suggestion
-
 # CA2000: Dispose objects before losing scope
 dotnet_diagnostic.CA2000.severity = suggestion
 

src/Microsoft.ComponentDetection.Common/AsyncExecution.cs

@@ -21,7 +21,7 @@ public static async Task<T> ExecuteWithTimeoutAsync<T>(Func<Task<T>> toExecute,
                 throw new TimeoutException($"The execution did not complete in the alotted time ({timeout.TotalSeconds} seconds) and has been terminated prior to completion");
             }
 
-            return work.Result;
+            return await work;
         }
 
         public static async Task ExecuteVoidWithTimeoutAsync(Action toExecute, TimeSpan timeout, CancellationToken cancellationToken)

src/Microsoft.ComponentDetection.Common/DockerReference/DockerReferenceUtility.cs

@@ -87,10 +87,10 @@ public static DockerReference ParseQualifiedName(string qualifiedName)
             return CreateDockerReference(reference);
         }
 
-        public static (string, string) SplitDockerDomain(string name)
+        public static (string Domain, string Remainder) SplitDockerDomain(string name)
         {
             string domain;
-            string reminder;
+            string remainder;
 
             var indexOfSlash = name.IndexOf('/');
             if (indexOfSlash == -1 || !(
@@ -99,25 +99,25 @@ public static (string, string) SplitDockerDomain(string name)
                 name.StartsWith("localhost/")))
             {
                 domain = DEFAULTDOMAIN;
-                reminder = name;
+                remainder = name;
             }
             else
             {
                 domain = name[..indexOfSlash];
-                reminder = name[(indexOfSlash + 1)..];
+                remainder = name[(indexOfSlash + 1)..];
             }
 
             if (domain == LEGACYDEFAULTDOMAIN)
             {
                 domain = DEFAULTDOMAIN;
             }
 
-            if (domain == DEFAULTDOMAIN && reminder.IndexOf('/') == -1)
+            if (domain == DEFAULTDOMAIN && remainder.IndexOf('/') == -1)
             {
-                reminder = $"{OFFICIALREPOSITORYNAME}/{reminder}";
+                remainder = $"{OFFICIALREPOSITORYNAME}/{remainder}";
             }
 
-            return (domain, reminder);
+            return (domain, remainder);
         }
 
         public static DockerReference ParseFamiliarName(string name)

src/Microsoft.ComponentDetection.Common/Telemetry/Records/BcdeExecutionTelemetryRecord.cs

@@ -46,7 +46,7 @@ public static async Task<TReturn> TrackAsync<TReturn>(
                 record.Dispose();
                 if (terminalRecord && !(record.Command?.Equals("help", StringComparison.InvariantCultureIgnoreCase) ?? false))
                 {
-                    TelemetryRelay.Instance.Shutdown();
+                    await TelemetryRelay.Instance.ShutdownAsync();
                 }
             }
         }

src/Microsoft.ComponentDetection.Common/Telemetry/TelemetryRelay.cs

@@ -3,6 +3,7 @@
 using System.Composition;
 using System.Linq;
 using System.Threading;
+using System.Threading.Tasks;
 using Microsoft.ComponentDetection.Common.Telemetry.Records;
 
 namespace Microsoft.ComponentDetection.Common.Telemetry
@@ -51,7 +52,8 @@ public void PostTelemetryRecord(IDetectionTelemetryRecord record)
         /// <summary>
         /// Disables the sending of telemetry and flushes any messages out of the queue for each service.
         /// </summary>
-        public void Shutdown()
+        /// <returns><see cref="Task"/> representing the asynchronous operation.</returns>
+        public async Task ShutdownAsync()
         {
             Active = false;
 
@@ -60,10 +62,10 @@ public void Shutdown()
                 try
                 {
                     // Set a timeout for services that flush synchronously.
-                    AsyncExecution.ExecuteVoidWithTimeoutAsync(
+                    await AsyncExecution.ExecuteVoidWithTimeoutAsync(
                         () => service.Flush(),
                         TimeSpan.FromSeconds(20),
-                        CancellationToken.None).Wait();
+                        CancellationToken.None);
                 }
                 catch
                 {

src/Microsoft.ComponentDetection.Detectors/npm/NpmComponentDetectorWithRoots.cs

@@ -252,7 +252,7 @@ private async Task SafeProcessAllPackageJTokens(IComponentStream componentStream
             }
         }
 
-        private void TraverseRequirementAndDependencyTree(IEnumerable<(JProperty, TypedComponent)> topLevelDependencies, IDictionary<string, JProperty> dependencyLookup, ISingleFileComponentRecorder singleFileComponentRecorder)
+        private void TraverseRequirementAndDependencyTree(IEnumerable<(JProperty Dependency, TypedComponent ParentComponent)> topLevelDependencies, IDictionary<string, JProperty> dependencyLookup, ISingleFileComponentRecorder singleFileComponentRecorder)
         {
             // iterate through everything for a top level dependency with a single explicitReferencedDependency value
             foreach (var (currentDependency, _) in topLevelDependencies)
@@ -292,7 +292,7 @@ private void TraverseRequirementAndDependencyTree(IEnumerable<(JProperty, TypedC
             }
         }
 
-        private void EnqueueDependencies(Queue<(JProperty, TypedComponent)> queue, JToken dependencies, TypedComponent parentComponent)
+        private void EnqueueDependencies(Queue<(JProperty Dependency, TypedComponent ParentComponent)> queue, JToken dependencies, TypedComponent parentComponent)
         {
             if (dependencies != null)
             {
@@ -306,7 +306,7 @@ private void EnqueueDependencies(Queue<(JProperty, TypedComponent)> queue, JToke
             }
         }
 
-        private bool TryEnqueueFirstLevelDependencies(Queue<(JProperty, TypedComponent)> queue, JToken dependencies, IDictionary<string, JProperty> dependencyLookup, Queue<TypedComponent> parentComponentQueue = null, TypedComponent parentComponent = null, bool skipValidation = false)
+        private bool TryEnqueueFirstLevelDependencies(Queue<(JProperty DependencyProperty, TypedComponent ParentComponent)> queue, JToken dependencies, IDictionary<string, JProperty> dependencyLookup, Queue<TypedComponent> parentComponentQueue = null, TypedComponent parentComponent = null, bool skipValidation = false)
         {
             var isValid = true;
             if (dependencies != null)

src/Microsoft.ComponentDetection.Detectors/pip/IPythonCommandService.cs

@@ -8,6 +8,6 @@ public interface IPythonCommandService
     {
         Task<bool> PythonExists(string pythonPath = null);
 
-        Task<IList<(string, GitComponent)>> ParseFile(string path, string pythonPath = null);
+        Task<IList<(string PackageString, GitComponent Component)>> ParseFile(string path, string pythonPath = null);
     }
 }

src/Microsoft.ComponentDetection.Detectors/pip/PipComponentDetector.cs

@@ -51,8 +51,8 @@ protected override async Task OnFileFound(ProcessRequest processRequest, IDictio
             try
             {
                 var initialPackages = await this.PythonCommandService.ParseFile(file.Location, pythonExePath);
-                var listedPackage = initialPackages.Where(tuple => tuple.Item1 != null)
-                    .Select(tuple => tuple.Item1)
+                var listedPackage = initialPackages.Where(tuple => tuple.PackageString != null)
+                    .Select(tuple => tuple.PackageString)
                     .Where(x => !string.IsNullOrWhiteSpace(x))
                     .Select(x => new PipDependencySpecification(x))
                     .Where(x => !x.PackageIsUnsafe())
@@ -64,8 +64,8 @@ protected override async Task OnFileFound(ProcessRequest processRequest, IDictio
                     singleFileComponentRecorder,
                     roots);
 
-                initialPackages.Where(tuple => tuple.Item2 != null)
-                                .Select(tuple => new DetectedComponent(tuple.Item2))
+                initialPackages.Where(tuple => tuple.Component != null)
+                                .Select(tuple => new DetectedComponent(tuple.Component))
                                 .ToList()
                                 .ForEach(gitComponent => singleFileComponentRecorder.RegisterUsage(gitComponent, isExplicitReferencedDependency: true));
             }

src/Microsoft.ComponentDetection.Detectors/pip/PythonCommandService.cs

@@ -21,7 +21,7 @@ public async Task<bool> PythonExists(string pythonPath = null)
             return !string.IsNullOrEmpty(await this.ResolvePython(pythonPath));
         }
 
-        public async Task<IList<(string, GitComponent)>> ParseFile(string filePath, string pythonPath = null)
+        public async Task<IList<(string PackageString, GitComponent Component)>> ParseFile(string filePath, string pythonPath = null)
         {
             if (string.IsNullOrEmpty(filePath))
             {
@@ -69,7 +69,7 @@ private async Task<IList<string>> ParseSetupPyFile(string filePath, string pytho
             return result.Split(new string[] { "'," }, StringSplitOptions.RemoveEmptyEntries).Select(x => x.Trim().Trim('\'').Trim()).ToList();
         }
 
-        private IList<(string, GitComponent)> ParseRequirementsTextFile(string path)
+        private IList<(string PackageString, GitComponent Component)> ParseRequirementsTextFile(string path)
         {
             var items = new List<(string, GitComponent)>();
             foreach (var line in File.ReadAllLines(path).Select(x => x.Trim().TrimEnd('\\')).Where(x => !x.StartsWith("#") && !x.StartsWith("-") && !string.IsNullOrWhiteSpace(x)))

src/Microsoft.ComponentDetection.Detectors/pip/PythonResolver.cs

@@ -211,7 +211,7 @@ private class PythonResolverState
             public IDictionary<string, SortedDictionary<string, IList<PythonProjectRelease>>> ValidVersionMap { get; }
                 = new Dictionary<string, SortedDictionary<string, IList<PythonProjectRelease>>>(StringComparer.OrdinalIgnoreCase);
 
-            public Queue<(string, PipDependencySpecification)> ProcessingQueue { get; } = new Queue<(string, PipDependencySpecification)>();
+            public Queue<(string PackageName, PipDependencySpecification Package)> ProcessingQueue { get; } = new Queue<(string, PipDependencySpecification)>();
 
             public IDictionary<string, PipGraphNode> NodeReferences { get; } = new Dictionary<string, PipGraphNode>(StringComparer.OrdinalIgnoreCase);