update fxcop to version 2.9.8 (#1499)

* update fxcop to version 2.9.8 and fixing issues
microsoft · Dec 18, 2019 · a26a43f · a26a43f
1 parent 376eb5b
commit a26a43f
Show file tree

Hide file tree

Showing 97 changed files with 981 additions and 124 deletions.
diff --git a/.rulesets/ApplicationInsightsSDKRules.ruleset b/.rulesets/ApplicationInsightsSDKRules.ruleset
@@ -17,10 +17,10 @@
     <Rule Id="CA1049" Action="Warning" />
     <Rule Id="CA1060" Action="Warning" />
     <Rule Id="CA1061" Action="Warning" />
-    <!-- Disabling this check "CA1063: Implement IDisposable correctly". 
-    This analyzer has a bug which fails the build, https://github.com/dotnet/roslyn-analyzers/issues/1815 -->
-    <Rule Id="CA1063" Action="None" />
+    <Rule Id="CA1063" Action="Warning" />
     <Rule Id="CA1065" Action="Warning" />
+    <!-- Suppressing Message "Do not pass literals as localized parameters" because we do not localize our SDK -->
+    <Rule Id="CA1303" Action="None" />
     <Rule Id="CA1304" Action="Warning" />
     <Rule Id="CA1305" Action="Warning" />
     <Rule Id="CA1307" Action="Warning" />
@@ -85,9 +85,7 @@
     <Rule Id="CA2207" Action="Warning" />
     <Rule Id="CA2210" Action="None" />
     <Rule Id="CA2212" Action="Warning" />
-    <!-- Disabling this check "CA2213:DisposableFieldsShouldBeDisposed". 
-    This analyzer has a bug which fails the build, https://github.com/dotnet/roslyn-analyzers/issues/1815 -->
-    <Rule Id="CA2213" Action="None" />
+    <Rule Id="CA2213" Action="Warning" />
     <Rule Id="CA2214" Action="Warning" />
     <Rule Id="CA2216" Action="Warning" />
     <Rule Id="CA2219" Action="Warning" />

diff --git a/BASE/src/Microsoft.ApplicationInsights/Channel/InMemoryTransmitter.cs b/BASE/src/Microsoft.ApplicationInsights/Channel/InMemoryTransmitter.cs
@@ -28,6 +28,8 @@ internal class InMemoryTransmitter : IDisposable
         /// A lock object to serialize the sending calls from Flush, OnFull event and the Runner.  
         /// </summary>
         private object sendingLockObj = new object();
+
+        [SuppressMessage("Microsoft.Usage", "CA2213:DisposableFieldsShouldBeDisposed", Justification = "Object is disposed within the using statement of the " + nameof(Runner) + " method.")]
         private AutoResetEvent startRunnerEvent;
         private bool enabled = true;
 

diff --git a/BASE/src/Microsoft.ApplicationInsights/Channel/SamplingScoreGenerator.cs b/BASE/src/Microsoft.ApplicationInsights/Channel/SamplingScoreGenerator.cs
@@ -25,6 +25,11 @@ public static double GetSamplingScore(string value)
         /// <returns>Item sampling score.</returns>
         public static double GetSamplingScore(ITelemetry telemetry)
         {
+            if (telemetry == null)
+            {
+                throw new ArgumentNullException(nameof(telemetry));
+            }
+
             double samplingScore = 0;
 
             if (telemetry.Context.Operation.Id != null)

diff --git a/BASE/src/Microsoft.ApplicationInsights/Channel/Transmission.cs b/BASE/src/Microsoft.ApplicationInsights/Channel/Transmission.cs
@@ -227,6 +227,11 @@ public virtual async Task<HttpWebResponseWrapper> SendAsync()
         /// </returns>
         public virtual Tuple<Transmission, Transmission> Split(Func<int, int> calculateLength)
         {
+            if (calculateLength == null)
+            {
+                throw new ArgumentNullException(nameof(calculateLength));
+            }
+
             Transmission transmissionA = this;
             Transmission transmissionB = null;
 

diff --git a/BASE/src/Microsoft.ApplicationInsights/DataContracts/AvailabilityTelemetry.cs b/BASE/src/Microsoft.ApplicationInsights/DataContracts/AvailabilityTelemetry.cs
@@ -186,6 +186,11 @@ public ITelemetry DeepClone()
         /// <inheritdoc/>
         public void SerializeData(ISerializationWriter serializationWriter)
         {
+            if (serializationWriter == null)
+            {
+                throw new ArgumentNullException(nameof(serializationWriter));
+            }
+
             serializationWriter.WriteProperty(this.Data);            
         }
 

diff --git a/BASE/src/Microsoft.ApplicationInsights/DataContracts/EventTelemetry.cs b/BASE/src/Microsoft.ApplicationInsights/DataContracts/EventTelemetry.cs
@@ -152,6 +152,11 @@ void ITelemetry.Sanitize()
         /// <inheritdoc/>
         public void SerializeData(ISerializationWriter serializationWriter)
         {
+            if (serializationWriter == null)
+            {
+                throw new ArgumentNullException(nameof(serializationWriter));
+            }
+
             serializationWriter.WriteProperty(this.Data);
         }
     }

diff --git a/BASE/src/Microsoft.ApplicationInsights/DataContracts/ExceptionTelemetry.cs b/BASE/src/Microsoft.ApplicationInsights/DataContracts/ExceptionTelemetry.cs
@@ -299,6 +299,11 @@ public ITelemetry DeepClone()
         /// <inheritdoc/>
         public void SerializeData(ISerializationWriter serializationWriter)
         {
+            if (serializationWriter == null)
+            {
+                throw new ArgumentNullException(nameof(serializationWriter));
+            }
+
             serializationWriter.WriteProperty(this.Data.Data);
         }
 

diff --git a/BASE/src/Microsoft.ApplicationInsights/DataContracts/MetricTelemetry.cs b/BASE/src/Microsoft.ApplicationInsights/DataContracts/MetricTelemetry.cs
@@ -259,6 +259,11 @@ public ITelemetry DeepClone()
         /// <inheritdoc/>
         public void SerializeData(ISerializationWriter serializationWriter)
         {
+            if (serializationWriter == null)
+            {
+                throw new ArgumentNullException(nameof(serializationWriter));
+            }
+
             serializationWriter.WriteProperty(this.Data);
         }
 

diff --git a/BASE/src/Microsoft.ApplicationInsights/DataContracts/PageViewPerformanceTelemetry.cs b/BASE/src/Microsoft.ApplicationInsights/DataContracts/PageViewPerformanceTelemetry.cs
@@ -242,6 +242,11 @@ void ITelemetry.Sanitize()
         /// <inheritdoc/>
         public void SerializeData(ISerializationWriter serializationWriter)
         {
+            if (serializationWriter == null)
+            {
+                throw new ArgumentNullException(nameof(serializationWriter));
+            }
+
             serializationWriter.WriteProperty(this.Data);
         }
     }

diff --git a/BASE/src/Microsoft.ApplicationInsights/DataContracts/PageViewTelemetry.cs b/BASE/src/Microsoft.ApplicationInsights/DataContracts/PageViewTelemetry.cs
@@ -197,6 +197,11 @@ public ITelemetry DeepClone()
         /// <inheritdoc/>
         public void SerializeData(ISerializationWriter serializationWriter)
         {
+            if (serializationWriter == null)
+            {
+                throw new ArgumentNullException(nameof(serializationWriter));
+            }
+
             serializationWriter.WriteProperty(this.Data);
         }
 

diff --git a/BASE/src/Microsoft.ApplicationInsights/DataContracts/TraceTelemetry.cs b/BASE/src/Microsoft.ApplicationInsights/DataContracts/TraceTelemetry.cs
@@ -153,6 +153,11 @@ public ITelemetry DeepClone()
         /// <inheritdoc/>
         public void SerializeData(ISerializationWriter serializationWriter)
         {
+            if (serializationWriter == null)
+            {
+                throw new ArgumentNullException(nameof(serializationWriter));
+            }
+
             serializationWriter.WriteProperty(this.Data);            
         }
 

diff --git a/...cationInsights/Extensibility/Implementation/Experimental/ExperimentalFeaturesExtension.cs b/...cationInsights/Extensibility/Implementation/Experimental/ExperimentalFeaturesExtension.cs
@@ -25,6 +25,11 @@ public static class ExperimentalFeaturesExtension
         [EditorBrowsable(EditorBrowsableState.Never)]
         public static bool EvaluateExperimentalFeature(this TelemetryConfiguration telemetryConfiguration, string featureName)
         {
+            if (telemetryConfiguration == null)
+            {
+                throw new ArgumentNullException(nameof(telemetryConfiguration));
+            }
+
             return telemetryConfiguration.ExperimentalFeatures.Any(x => x.Equals(featureName, StringComparison.OrdinalIgnoreCase));
         }
     }

diff --git a/BASE/src/Microsoft.ApplicationInsights/Extensibility/Implementation/JsonSerializer.cs b/BASE/src/Microsoft.ApplicationInsights/Extensibility/Implementation/JsonSerializer.cs
@@ -52,6 +52,11 @@ public static string ContentType
         [SuppressMessage("Microsoft.Usage", "CA2202:Do not dispose objects multiple times", Justification = "Disposing a MemoryStream multiple times is harmless.")]
         public static byte[] Serialize(IEnumerable<ITelemetry> telemetryItems, bool compress = true)
         {
+            if (telemetryItems == null)
+            {
+                throw new ArgumentNullException(nameof(telemetryItems));
+            }
+
             var memoryStream = new MemoryStream();
             using (Stream compressedStream = compress ? CreateCompressedStream(memoryStream) : memoryStream)
             {

diff --git a/...soft.ApplicationInsights/Extensibility/Implementation/TelemetryConfigurationExtensions.cs b/...soft.ApplicationInsights/Extensibility/Implementation/TelemetryConfigurationExtensions.cs
@@ -1,5 +1,6 @@
 namespace Microsoft.ApplicationInsights.Extensibility.Implementation
 {
+    using System;
     using System.ComponentModel;
     using Microsoft.ApplicationInsights.DataContracts;
 
@@ -14,6 +15,11 @@ public static class TelemetryConfigurationExtensions
         /// </summary>
         public static double GetLastObservedSamplingPercentage(this TelemetryConfiguration configuration, SamplingTelemetryItemTypes samplingItemType)
         {
+            if (configuration == null)
+            {
+                throw new ArgumentNullException(nameof(configuration));
+            }
+
             return configuration.LastKnownSampleRateStore.GetLastObservedSamplingPercentage(samplingItemType);
         }
 
@@ -22,6 +28,11 @@ public static double GetLastObservedSamplingPercentage(this TelemetryConfigurati
         /// </summary>
         public static void SetLastObservedSamplingPercentage(this TelemetryConfiguration configuration, SamplingTelemetryItemTypes samplingItemType, double value)
         {
+            if (configuration == null)
+            {
+                throw new ArgumentNullException(nameof(configuration));
+            }
+
             configuration.LastKnownSampleRateStore.SetLastObservedSamplingPercentage(samplingItemType, value);
         }
     }

diff --git a/...crosoft.ApplicationInsights/Extensibility/Implementation/TelemetryConfigurationFactory.cs b/...crosoft.ApplicationInsights/Extensibility/Implementation/TelemetryConfigurationFactory.cs
@@ -3,6 +3,7 @@
     using System;
     using System.Collections;
     using System.Collections.Generic;
+    using System.Diagnostics.CodeAnalysis;
     using System.Globalization;
     using System.IO;
     using System.Linq;
@@ -50,6 +51,7 @@ public static TelemetryConfigurationFactory Instance
             set { instance = value; }
         }
 
+        [SuppressMessage("Microsoft.Reliability", "CA2000:DisposeObjectsBeforeLosingScope", Justification = "We want objects created in this method to live for the life of the application.")]
         public virtual void Initialize(TelemetryConfiguration configuration, TelemetryModules modules, string serializedConfiguration)
         {
             try

diff --git a/.../Microsoft.ApplicationInsights/Extensibility/Implementation/TelemetryContextExtensions.cs b/.../Microsoft.ApplicationInsights/Extensibility/Implementation/TelemetryContextExtensions.cs
@@ -1,5 +1,6 @@
 namespace Microsoft.ApplicationInsights.Extensibility.Implementation
 {
+    using System;
     using System.ComponentModel;
     using Microsoft.ApplicationInsights.DataContracts;
 
@@ -16,6 +17,11 @@ public static class TelemetryContextExtensions
         /// <returns>Internal context for TelemetryContext.</returns>
         public static InternalContext GetInternalContext(this TelemetryContext context)
         {
+            if (context == null)
+            {
+                throw new ArgumentNullException(nameof(context));
+            }
+
             return context.Internal;
         }
     }

diff --git a/BASE/src/Microsoft.ApplicationInsights/Extensibility/Implementation/TelemetryDebugWriter.cs b/BASE/src/Microsoft.ApplicationInsights/Extensibility/Implementation/TelemetryDebugWriter.cs
@@ -30,6 +30,11 @@ public class TelemetryDebugWriter : IDebugOutput
         /// <param name="filteredBy">If specified, indicates the telemetry item was filtered out and not sent to the API.</param>
         public static void WriteTelemetry(ITelemetry telemetry, string filteredBy = null)
         {
+            if (telemetry == null)
+            {
+                throw new ArgumentNullException(nameof(telemetry));
+            }
+
             var output = PlatformSingleton.Current.GetDebugOutput();
             if (output.IsAttached() && output.IsLogging())
             {

diff --git a/BASE/src/Microsoft.ApplicationInsights/Extensibility/Implementation/Tracing/Extensions.cs b/BASE/src/Microsoft.ApplicationInsights/Extensibility/Implementation/Tracing/Extensions.cs
@@ -17,14 +17,19 @@ public static class Extensions
         /// </summary>
         public static string ToInvariantString(this Exception exception)
         {
-#if !NETSTANDARD1_3
+            if (exception == null)
+            {
+                return string.Empty;
+            }
+
+#if NETSTANDARD1_3
+            return exception.ToString();
+#else
             CultureInfo originalUICulture = Thread.CurrentThread.CurrentUICulture;
             try
             {
                 Thread.CurrentThread.CurrentUICulture = CultureInfo.InvariantCulture;
-#endif
                 return exception.ToString();
-#if !NETSTANDARD1_3
             }
             finally
             {

diff --git a/...c/Microsoft.ApplicationInsights/Extensibility/OperationCorrelationTelemetryInitializer.cs b/...c/Microsoft.ApplicationInsights/Extensibility/OperationCorrelationTelemetryInitializer.cs
@@ -1,5 +1,6 @@
 namespace Microsoft.ApplicationInsights.Extensibility
 {
+    using System;
     using System.Diagnostics;
 
     using Microsoft.ApplicationInsights;
@@ -22,6 +23,11 @@ public class OperationCorrelationTelemetryInitializer : ITelemetryInitializer
         /// <param name="telemetryItem">Target telemetry item to add operation context.</param>
         public void Initialize(ITelemetry telemetryItem)
         {
+            if (telemetryItem == null)
+            {
+                throw new ArgumentNullException(nameof(telemetryItem));
+            }
+
             var itemOperationContext = telemetryItem.Context.Operation;
             var telemetryProp = telemetryItem as ISupportProperties;            
 

diff --git a/BASE/src/Microsoft.ApplicationInsights/Extensibility/SequencePropertyInitializer.cs b/BASE/src/Microsoft.ApplicationInsights/Extensibility/SequencePropertyInitializer.cs
@@ -20,6 +20,11 @@ public sealed class SequencePropertyInitializer : ITelemetryInitializer
         /// </summary>
         public void Initialize(ITelemetry telemetry)
         {
+            if (telemetry == null)
+            {
+                throw new ArgumentNullException(nameof(telemetry));
+            }
+
             if (string.IsNullOrEmpty(telemetry.Sequence))
             {
                 telemetry.Sequence = this.stablePrefix + Interlocked.Increment(ref this.currentNumber).ToString(CultureInfo.InvariantCulture);

diff --git a/BASE/src/Microsoft.ApplicationInsights/Extensibility/W3C/W3CActivityExtensions.cs b/BASE/src/Microsoft.ApplicationInsights/Extensibility/W3C/W3CActivityExtensions.cs
@@ -65,6 +65,11 @@ public static Activity UpdateContextOnActivity(this Activity activity)
         [Obsolete("Activity from System.Diagnostics.DiagnosticSource 4.6.0 onwards natively support W3C.")]
         public static string GetTraceparent(this Activity activity)
         {
+            if (activity == null)
+            {
+                throw new ArgumentNullException(nameof(activity));
+            }
+
             // Activity.ID is the trasceparent header.
             return activity.Id;
         }
@@ -90,6 +95,11 @@ public static void SetTraceparent(this Activity activity, string value)
         [Obsolete("Activity from System.Diagnostics.DiagnosticSource 4.6.0 onwards natively support W3C.")]
         public static string GetTracestate(this Activity activity)
         {
+            if (activity == null)
+            {
+                throw new ArgumentNullException(nameof(activity));
+            }
+
             return activity.TraceStateString;
         }
 
@@ -102,6 +112,11 @@ public static string GetTracestate(this Activity activity)
         [Obsolete("Activity from System.Diagnostics.DiagnosticSource 4.6.0 onwards natively support W3C.")]
         public static void SetTracestate(this Activity activity, string value)
         {
+            if (activity == null)
+            {
+                throw new ArgumentNullException(nameof(activity));
+            }
+
             activity.TraceStateString = value;
         }
 
@@ -114,6 +129,11 @@ public static void SetTracestate(this Activity activity, string value)
         [Obsolete("Activity from System.Diagnostics.DiagnosticSource 4.6.0 onwards natively support W3C. Use Activity.TraceId to get Trace ID")]
         public static string GetTraceId(this Activity activity)
         {
+            if (activity == null)
+            {
+                throw new ArgumentNullException(nameof(activity));
+            }
+
             return activity.TraceId.ToHexString();
         }
 
@@ -126,6 +146,11 @@ public static string GetTraceId(this Activity activity)
         [Obsolete("Activity from System.Diagnostics.DiagnosticSource 4.6.0 onwards natively support W3C. Use Activity.SpanId to get Span ID")]
         public static string GetSpanId(this Activity activity)
         {
+            if (activity == null)
+            {
+                throw new ArgumentNullException(nameof(activity));
+            }
+
             return activity.SpanId.ToHexString();
         }
 
@@ -138,6 +163,11 @@ public static string GetSpanId(this Activity activity)
         [Obsolete("Activity from System.Diagnostics.DiagnosticSource 4.6.0 onwards natively support W3C. Use Activity.ParentSpanId to get ParentSpan ID")]
         public static string GetParentSpanId(this Activity activity)
         {
+            if (activity == null)
+            {
+                throw new ArgumentNullException(nameof(activity));
+            }
+
             return activity.ParentSpanId.ToHexString();
         }
 

diff --git a/BASE/src/Microsoft.ApplicationInsights/Metrics/Extensibility/MetricExtensions.cs b/BASE/src/Microsoft.ApplicationInsights/Metrics/Extensibility/MetricExtensions.cs
@@ -15,6 +15,11 @@ public static class MetricExtensions
         /// <returns>The configuration of the metric.</returns>
         public static MetricConfiguration GetConfiguration(this Metric metric)
         {
+            if (metric == null)
+            {
+                throw new ArgumentNullException(nameof(metric));
+            }
+
             return metric.configuration;
         }
 

diff --git a/BASE/src/Microsoft.ApplicationInsights/Metrics/Extensibility/MetricSeriesExtensions.cs b/BASE/src/Microsoft.ApplicationInsights/Metrics/Extensibility/MetricSeriesExtensions.cs
@@ -16,6 +16,11 @@ public static class MetricSeriesExtensions
         /// <returns>Configuration of the specified series.</returns>
         public static IMetricSeriesConfiguration GetConfiguration(this MetricSeries metricSeries)
         {
+            if (metricSeries == null)
+            {
+                throw new ArgumentNullException(nameof(metricSeries));
+            }
+
             return metricSeries.configuration;
         }
     }