[Exporter.OTLP] Nullability for compiled in files - part 1 (#4282)

Kielek · web-flow · commit 811d0eb12d7d · 2023-03-20T17:08:39.000-07:00
diff --git a/src/OpenTelemetry.Api/Internal/ExceptionExtensions.cs b/src/OpenTelemetry.Api/Internal/ExceptionExtensions.cs
@@ -14,6 +14,8 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 using System.Globalization;
 
 namespace OpenTelemetry.Internal
diff --git a/src/OpenTelemetry.Api/Internal/SemanticConventions.cs b/src/OpenTelemetry.Api/Internal/SemanticConventions.cs
@@ -14,6 +14,8 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 namespace OpenTelemetry.Trace
 {
     /// <summary>
diff --git a/src/OpenTelemetry.Api/Internal/SpanAttributeConstants.cs b/src/OpenTelemetry.Api/Internal/SpanAttributeConstants.cs
@@ -14,6 +14,8 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 namespace OpenTelemetry.Trace
 {
     /// <summary>
diff --git a/src/OpenTelemetry.Api/Internal/StatusHelper.cs b/src/OpenTelemetry.Api/Internal/StatusHelper.cs
@@ -14,6 +14,8 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 using System.Runtime.CompilerServices;
 using OpenTelemetry.Trace;
 
@@ -26,7 +28,7 @@ internal static class StatusHelper
         public const string ErrorStatusCodeTagValue = "ERROR";
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public static string GetTagValueForStatusCode(StatusCode statusCode)
+        public static string? GetTagValueForStatusCode(StatusCode statusCode)
         {
             return statusCode switch
             {
@@ -43,7 +45,7 @@ public static string GetTagValueForStatusCode(StatusCode statusCode)
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public static StatusCode? GetStatusCodeForTagValue(string statusCodeTagValue)
+        public static StatusCode? GetStatusCodeForTagValue(string? statusCodeTagValue)
         {
             return statusCodeTagValue switch
             {
@@ -52,15 +54,15 @@ public static string GetTagValueForStatusCode(StatusCode statusCode)
                  * first because assumption is most spans will be
                  * Unset, then Error. Ok is not set by the SDK.
                  */
-                string _ when UnsetStatusCodeTagValue.Equals(statusCodeTagValue, StringComparison.OrdinalIgnoreCase) => StatusCode.Unset,
-                string _ when ErrorStatusCodeTagValue.Equals(statusCodeTagValue, StringComparison.OrdinalIgnoreCase) => StatusCode.Error,
-                string _ when OkStatusCodeTagValue.Equals(statusCodeTagValue, StringComparison.OrdinalIgnoreCase) => StatusCode.Ok,
+                not null when UnsetStatusCodeTagValue.Equals(statusCodeTagValue, StringComparison.OrdinalIgnoreCase) => StatusCode.Unset,
+                not null when ErrorStatusCodeTagValue.Equals(statusCodeTagValue, StringComparison.OrdinalIgnoreCase) => StatusCode.Error,
+                not null when OkStatusCodeTagValue.Equals(statusCodeTagValue, StringComparison.OrdinalIgnoreCase) => StatusCode.Ok,
                 _ => null,
             };
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public static bool TryGetStatusCodeForTagValue(string statusCodeTagValue, out StatusCode statusCode)
+        public static bool TryGetStatusCodeForTagValue(string? statusCodeTagValue, out StatusCode statusCode)
         {
             StatusCode? tempStatusCode = GetStatusCodeForTagValue(statusCodeTagValue);
 
diff --git a/src/OpenTelemetry/Internal/OpenTelemetrySdkEventSource.cs b/src/OpenTelemetry/Internal/OpenTelemetrySdkEventSource.cs
@@ -14,6 +14,8 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 using System.Diagnostics;
 using System.Diagnostics.Tracing;
 
@@ -39,15 +41,6 @@ public void SpanProcessorException(string evnt, Exception ex)
             }
         }
 
-        [NonEvent]
-        public void TracestateExtractException(Exception ex)
-        {
-            if (this.IsEnabled(EventLevel.Warning, EventKeywords.All))
-            {
-                this.TracestateExtractError(ex.ToInvariantString());
-            }
-        }
-
         [NonEvent]
         public void MetricObserverCallbackException(Exception exception)
         {
@@ -147,12 +140,6 @@ public void DroppedExportProcessorItems(string exportProcessorName, string expor
             }
         }
 
-        [Event(3, Message = "Exporter returned error '{0}'.", Level = EventLevel.Warning)]
-        public void ExporterErrorResult(ExportResult exportResult)
-        {
-            this.WriteEvent(3, exportResult);
-        }
-
         [Event(4, Message = "Unknown error in SpanProcessor event '{0}': '{1}'.", Level = EventLevel.Error)]
         public void SpanProcessorException(string evnt, string ex)
         {
@@ -165,12 +152,6 @@ public void InvalidArgument(string methodName, string argumentName, string issue
             this.WriteEvent(8, methodName, argumentName, issue);
         }
 
-        [Event(14, Message = "Tracestate parse error: '{0}'", Level = EventLevel.Warning)]
-        public void TracestateExtractError(string error)
-        {
-            this.WriteEvent(14, error);
-        }
-
         [Event(16, Message = "Exception occurred while invoking Observable instrument callback. Exception: '{0}'", Level = EventLevel.Warning)]
         public void ObservableInstrumentCallbackException(string exception)
         {
@@ -184,7 +165,7 @@ public void ActivityStarted(string name, string id)
         }
 
         [Event(25, Message = "Activity stopped. Name = '{0}', Id = '{1}'.", Level = EventLevel.Verbose)]
-        public void ActivityStopped(string name, string id)
+        public void ActivityStopped(string name, string? id)
         {
             this.WriteEvent(25, name, id);
         }
@@ -298,7 +279,7 @@ public void TracerProviderSdkEvent(string message)
         }
 
         [Event(47, Message = "{0} environment variable has an invalid value: '{1}'", Level = EventLevel.Warning)]
-        public void InvalidEnvironmentVariable(string key, string value)
+        public void InvalidEnvironmentVariable(string key, string? value)
         {
             this.WriteEvent(47, key, value);
         }
@@ -321,7 +302,7 @@ public override void Dispose()
 
             protected override void OnEventSourceCreated(EventSource eventSource)
             {
-                if (eventSource?.Name.StartsWith("OpenTelemetry", StringComparison.OrdinalIgnoreCase) == true)
+                if (eventSource.Name.StartsWith("OpenTelemetry", StringComparison.OrdinalIgnoreCase))
                 {
                     this.eventSources.Add(eventSource);
                     this.EnableEvents(eventSource, EventLevel.Verbose, EventKeywords.All);
@@ -332,8 +313,8 @@ protected override void OnEventSourceCreated(EventSource eventSource)
 
             protected override void OnEventWritten(EventWrittenEventArgs e)
             {
-                string message;
-                if (e.Message != null && (e.Payload?.Count ?? 0) > 0)
+                string? message;
+                if (e.Message != null && e.Payload != null && e.Payload.Count > 0)
                 {
                     message = string.Format(e.Message, e.Payload.ToArray());
                 }
diff --git a/src/OpenTelemetry/Internal/PeerServiceResolver.cs b/src/OpenTelemetry/Internal/PeerServiceResolver.cs
@@ -14,6 +14,8 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 using System.Runtime.CompilerServices;
 using OpenTelemetry.Trace;
 
@@ -32,19 +34,19 @@ internal static class PeerServiceResolver
 
         public interface IPeerServiceState
         {
-            string PeerService { get; set; }
+            string? PeerService { get; set; }
 
             int? PeerServicePriority { get; set; }
 
-            string HostName { get; set; }
+            string? HostName { get; set; }
 
-            string IpAddress { get; set; }
+            string? IpAddress { get; set; }
 
             long Port { get; set; }
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public static void InspectTag<T>(ref T state, string key, string value)
+        public static void InspectTag<T>(ref T state, string key, string? value)
             where T : struct, IPeerServiceState
         {
             if (PeerServiceKeyResolutionDictionary.TryGetValue(key, out int priority)
@@ -78,7 +80,7 @@ public static void InspectTag<T>(ref T state, string key, long value)
         }
 
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public static void Resolve<T>(ref T state, out string peerServiceName, out bool addAsTag)
+        public static void Resolve<T>(ref T state, out string? peerServiceName, out bool addAsTag)
             where T : struct, IPeerServiceState
         {
             peerServiceName = state.PeerService;
diff --git a/src/OpenTelemetry/Internal/PeriodicExportingMetricReaderHelper.cs b/src/OpenTelemetry/Internal/PeriodicExportingMetricReaderHelper.cs
@@ -14,6 +14,8 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 namespace OpenTelemetry.Metrics;
 
 internal static class PeriodicExportingMetricReaderHelper
@@ -28,10 +30,10 @@ internal static PeriodicExportingMetricReader CreatePeriodicExportingMetricReade
         int defaultExportTimeoutMilliseconds = DefaultExportTimeoutMilliseconds)
     {
         var exportInterval =
-            options.PeriodicExportingMetricReaderOptions?.ExportIntervalMilliseconds ?? defaultExportIntervalMilliseconds;
+            options.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds ?? defaultExportIntervalMilliseconds;
 
         var exportTimeout =
-            options.PeriodicExportingMetricReaderOptions?.ExportTimeoutMilliseconds ?? defaultExportTimeoutMilliseconds;
+            options.PeriodicExportingMetricReaderOptions.ExportTimeoutMilliseconds ?? defaultExportTimeoutMilliseconds;
 
         var metricReader = new PeriodicExportingMetricReader(exporter, exportInterval, exportTimeout)
         {
diff --git a/src/OpenTelemetry/Internal/ResourceSemanticConventions.cs b/src/OpenTelemetry/Internal/ResourceSemanticConventions.cs
@@ -14,6 +14,8 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 namespace OpenTelemetry.Resources
 {
     internal static class ResourceSemanticConventions
diff --git a/test/OpenTelemetry.Tests/Internal/PeriodicExportingMetricReaderHelperTests.cs b/test/OpenTelemetry.Tests/Internal/PeriodicExportingMetricReaderHelperTests.cs
@@ -14,14 +14,16 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 using Microsoft.Extensions.Configuration;
 using OpenTelemetry.Exporter;
 using OpenTelemetry.Metrics;
 using Xunit;
 
 namespace OpenTelemetry.Internal.Tests
 {
-    public class PeriodicExportingMetricReaderHelperTests : IDisposable
+    public sealed class PeriodicExportingMetricReaderHelperTests : IDisposable
     {
         public PeriodicExportingMetricReaderHelperTests()
         {
@@ -140,14 +142,11 @@ private static void ClearEnvVars()
         }
 
         private static PeriodicExportingMetricReader CreatePeriodicExportingMetricReader(
-            MetricReaderOptions options = null)
+            MetricReaderOptions? options = null)
         {
-            if (options == null)
-            {
-                options = new();
-            }
+            options ??= new();
 
-            var dummyMetricExporter = new InMemoryExporter<Metric>(new Metric[0]);
+            var dummyMetricExporter = new InMemoryExporter<Metric>(Array.Empty<Metric>());
             return PeriodicExportingMetricReaderHelper.CreatePeriodicExportingMetricReader(dummyMetricExporter, options);
         }
     }
diff --git a/test/OpenTelemetry.Tests/Internal/SelfDiagnosticsConfigRefresherTest.cs b/test/OpenTelemetry.Tests/Internal/SelfDiagnosticsConfigRefresherTest.cs
@@ -14,6 +14,8 @@
 // limitations under the License.
 // </copyright>
 
+#nullable enable
+
 using System.Diagnostics;
 using System.Text;
 using Xunit;
@@ -43,7 +45,7 @@ public void SelfDiagnosticsConfigRefresher_OmitAsConfigured()
                 using var configRefresher = new SelfDiagnosticsConfigRefresher();
 
                 // Emitting event of EventLevel.Warning
-                OpenTelemetrySdkEventSource.Log.ExporterErrorResult(ExportResult.Success);
+                OpenTelemetrySdkEventSource.Log.ObservableInstrumentCallbackException("exception");
 
                 int bufferSize = 512;
                 byte[] actualBytes = ReadFile(bufferSize);
@@ -97,12 +99,12 @@ private static string ParseLogMessage(string logLine)
 
         private static byte[] ReadFile(int byteCount)
         {
-            var outputFileName = Path.GetFileName(Process.GetCurrentProcess().MainModule.FileName) + "."
+            var outputFileName = Path.GetFileName(Process.GetCurrentProcess().MainModule?.FileName) + "."
                     + Process.GetCurrentProcess().Id + ".log";
             var outputFilePath = Path.Combine(".", outputFileName);
             using var file = File.Open(outputFilePath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
             byte[] actualBytes = new byte[byteCount];
-            file.Read(actualBytes, 0, byteCount);
+            _ = file.Read(actualBytes, 0, byteCount);
             return actualBytes;
         }
 
@@ -126,6 +128,7 @@ private static void CleanupConfigFile()
             }
             catch
             {
+                // ignore any exceptions while removing files
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`	`// limitations under the License.`
`15`	`15`	`// </copyright>`
`16`	`16`
	`17`	`+#nullable enable`
	`18`	`+`
`17`	`19`	`namespace OpenTelemetry.Trace`
`18`	`20`	`{`
`19`	`21`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -14,14 +14,16 @@`
`14`	`14`	`// limitations under the License.`
`15`	`15`	`// </copyright>`
`16`	`16`
	`17`	`+#nullable enable`
	`18`	`+`
`17`	`19`	`using Microsoft.Extensions.Configuration;`
`18`	`20`	`using OpenTelemetry.Exporter;`
`19`	`21`	`using OpenTelemetry.Metrics;`
`20`	`22`	`using Xunit;`
`21`	`23`
`22`	`24`	`namespace OpenTelemetry.Internal.Tests`
`23`	`25`	`{`
`24`		`- public class PeriodicExportingMetricReaderHelperTests : IDisposable`
	`26`	`+ public sealed class PeriodicExportingMetricReaderHelperTests : IDisposable`
`25`	`27`	`{`
`26`	`28`	`public PeriodicExportingMetricReaderHelperTests()`
`27`	`29`	`{`
`@@ -140,14 +142,11 @@ private static void ClearEnvVars()`
`140`	`142`	`}`
`141`	`143`
`142`	`144`	`private static PeriodicExportingMetricReader CreatePeriodicExportingMetricReader(`
`143`		`- MetricReaderOptions options = null)`
	`145`	`+ MetricReaderOptions? options = null)`
`144`	`146`	`{`
`145`		`- if (options == null)`
`146`		`- {`
`147`		`- options = new();`
`148`		`- }`
	`147`	`+ options ??= new();`
`149`	`148`
`150`		`- var dummyMetricExporter = new InMemoryExporter<Metric>(new Metric[0]);`
	`149`	`+ var dummyMetricExporter = new InMemoryExporter<Metric>(Array.Empty<Metric>());`
`151`	`150`	`return PeriodicExportingMetricReaderHelper.CreatePeriodicExportingMetricReader(dummyMetricExporter, options);`
`152`	`151`	`}`
`153`	`152`	`}`