[Instrumentation.Wcf] Add .NET6 as target framework (#2243)

Co-authored-by: Mikel Blanchard <mblanchard@macrosssoftware.com>
open-telemetry · Oct 28, 2024 · fdedd5b · fdedd5b
1 parent 3f5d91c
commit fdedd5b
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 33 deletions.
diff --git a/src/OpenTelemetry.Instrumentation.Wcf/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.Wcf/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+* Add target for `net6.0` to ensure that non-vulnerable transient
+  dependencies are referenced by default for .NET6+.
+  ([#2243](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/2243))
+
 ## 1.0.0-rc.17
 
 Released 2024-Jun-18

diff --git a/src/OpenTelemetry.Instrumentation.Wcf/Implementation/AsyncResultWithTelemetryState.cs b/src/OpenTelemetry.Instrumentation.Wcf/Implementation/AsyncResultWithTelemetryState.cs
@@ -15,7 +15,7 @@ public AsyncResultWithTelemetryState(IAsyncResult inner, RequestTelemetryState t
 
     public RequestTelemetryState TelemetryState { get; }
 
-    object IAsyncResult.AsyncState => this.Inner.AsyncState;
+    object? IAsyncResult.AsyncState => this.Inner.AsyncState;
 
     WaitHandle IAsyncResult.AsyncWaitHandle => this.Inner.AsyncWaitHandle;
 

diff --git a/src/OpenTelemetry.Instrumentation.Wcf/Implementation/ClientChannelInstrumentation.cs b/src/OpenTelemetry.Instrumentation.Wcf/Implementation/ClientChannelInstrumentation.cs
@@ -82,7 +82,7 @@ public static RequestTelemetryState BeforeSendRequest(Message request, Uri? remo
         };
     }
 
-    public static void AfterRequestCompleted(Message? reply, RequestTelemetryState state)
+    public static void AfterRequestCompleted(Message? reply, RequestTelemetryState? state)
     {
         Guard.ThrowIfNull(state);
 
@@ -128,7 +128,7 @@ private static ActionMetadata GetActionMetadata(Message request, string action)
         if (request.Properties.TryGetValue(TelemetryContextMessageProperty.Name, out object telemetryContextProperty))
         {
             var actionMappings = (telemetryContextProperty as TelemetryContextMessageProperty)?.ActionMappings;
-            if (actionMappings != null && actionMappings.TryGetValue(action, out ActionMetadata metadata))
+            if (actionMappings != null && actionMappings.TryGetValue(action, out var metadata))
             {
                 actionMetadata = metadata;
             }

diff --git a/src/OpenTelemetry.Instrumentation.Wcf/Implementation/HttpRequestMessagePropertyWrapper.cs b/src/OpenTelemetry.Instrumentation.Wcf/Implementation/HttpRequestMessagePropertyWrapper.cs
@@ -32,7 +32,7 @@ public static string Name
     public static object CreateNew()
     {
         AssertHttpEnabled();
-        return Activator.CreateInstance(ReflectedValues!.Type);
+        return Activator.CreateInstance(ReflectedValues!.Type)!;
     }
 
     public static WebHeaderCollection GetHeaders(object httpRequestMessageProperty)
@@ -49,23 +49,25 @@ public static WebHeaderCollection GetHeaders(object httpRequestMessageProperty)
         {
             type = Type.GetType(
                 "System.ServiceModel.Channels.HttpRequestMessageProperty, System.ServiceModel, Version=0.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089",
-                true);
+                true)!;
 
-            var headersProp = type.GetProperty("Headers", BindingFlags.Public | BindingFlags.Instance, null, typeof(WebHeaderCollection), Array.Empty<Type>(), null);
-            if (headersProp == null)
-            {
-                throw new NotSupportedException("HttpRequestMessageProperty.Headers property not found");
-            }
+            var constructor = type.GetConstructor(Type.EmptyTypes)
+                ?? throw new NotSupportedException("HttpRequestMessageProperty public parameterless constructor was not found");
+
+            var headersProp = type.GetProperty("Headers", BindingFlags.Public | BindingFlags.Instance, null, typeof(WebHeaderCollection), Array.Empty<Type>(), null)
+                ?? throw new NotSupportedException("HttpRequestMessageProperty.Headers property not found");
+
+            var nameProp = type.GetProperty("Name", BindingFlags.Public | BindingFlags.Static, null, typeof(string), Array.Empty<Type>(), null)
+                ?? throw new NotSupportedException("HttpRequestMessageProperty.Name property not found");
 
-            var nameProp = type.GetProperty("Name", BindingFlags.Public | BindingFlags.Static, null, typeof(string), Array.Empty<Type>(), null);
-            if (nameProp == null)
+            if (nameProp.GetValue(null) is not string name)
             {
-                throw new NotSupportedException("HttpRequestMessageProperty.Name property not found");
+                throw new NotSupportedException("HttpRequestMessageProperty.Name property was null");
             }
 
             return new ReflectedInfo(
                 type: type,
-                name: (string)nameProp.GetValue(null),
+                name: name,
                 headersFetcher: new PropertyFetcher<WebHeaderCollection>("Headers"));
         }
         catch (Exception ex)

diff --git a/src/OpenTelemetry.Instrumentation.Wcf/Implementation/InstrumentedDuplexChannel.cs b/src/OpenTelemetry.Instrumentation.Wcf/Implementation/InstrumentedDuplexChannel.cs
@@ -178,20 +178,27 @@ private IAsyncResult SendInternal(Message message, TimeSpan timeout, Func<AsyncC
     private void SendInternal(Message message, TimeSpan timeout, Action<RequestTelemetryState> executeSend)
     {
         RequestTelemetryState? telemetryState = null;
-        ContextCallback executeInChildContext = _ =>
+
+        void ExecuteInChildContext(object? unused)
         {
             telemetryState = ClientChannelInstrumentation.BeforeSendRequest(message, this.RemoteAddress?.Uri);
             RequestTelemetryStateTracker.PushTelemetryState(message, telemetryState, timeout, OnTelemetryStateTimedOut);
             executeSend(telemetryState);
-        };
+        }
+
+        var executionContext = ExecutionContext.Capture();
+        if (executionContext == null)
+        {
+            throw new InvalidOperationException("Cannot fetch execution context");
+        }
 
         try
         {
-            ExecutionContext.Run(ExecutionContext.Capture(), executeInChildContext, null);
+            ExecutionContext.Run(executionContext, ExecuteInChildContext, null);
         }
         catch (Exception)
         {
-            ClientChannelInstrumentation.AfterRequestCompleted(null, telemetryState!);
+            ClientChannelInstrumentation.AfterRequestCompleted(null, telemetryState);
             throw;
         }
     }

diff --git a/src/OpenTelemetry.Instrumentation.Wcf/Implementation/InstrumentedRequestChannel.cs b/src/OpenTelemetry.Instrumentation.Wcf/Implementation/InstrumentedRequestChannel.cs
@@ -99,14 +99,21 @@ Message IRequestChannel.EndRequest(IAsyncResult result)
     private IAsyncResult InternalBeginRequest(Message message, Func<AsyncCallback, object?, IAsyncResult> beginRequestDelegate, AsyncCallback callback, object? state)
     {
         IAsyncResult? result = null;
-        ContextCallback executeInChildContext = _ =>
+
+        void ExecuteInChildContext(object? unused)
         {
             var telemetryState = ClientChannelInstrumentation.BeforeSendRequest(message, ((IRequestChannel)this).RemoteAddress?.Uri);
             var asyncCallback = AsyncResultWithTelemetryState.GetAsyncCallback(callback, telemetryState);
             result = new AsyncResultWithTelemetryState(beginRequestDelegate(asyncCallback, state), telemetryState);
-        };
+        }
+
+        var executionContext = ExecutionContext.Capture();
+        if (executionContext == null)
+        {
+            throw new InvalidOperationException("Cannot fetch execution context");
+        }
 
-        ExecutionContext.Run(ExecutionContext.Capture(), executeInChildContext, null);
+        ExecutionContext.Run(executionContext, ExecuteInChildContext, null);
         return result!;
     }
 }
diff --git a/src/OpenTelemetry.Instrumentation.Wcf/Implementation/RequestTelemetryStateTracker.cs b/src/OpenTelemetry.Instrumentation.Wcf/Implementation/RequestTelemetryStateTracker.cs
@@ -9,8 +9,8 @@ internal static class RequestTelemetryStateTracker
 {
     private static readonly Dictionary<string, Entry> OutstandingRequestStates = new Dictionary<string, Entry>();
     private static readonly SortedSet<EntryTimeoutProperties> TimeoutQueue = new SortedSet<EntryTimeoutProperties>();
-    private static readonly object Sync = new object();
-    private static readonly Timer Timer = new Timer(OnTimer);
+    private static readonly object Sync = new();
+    private static readonly Timer Timer = new(OnTimer);
     private static long currentTimerDueAt = Timeout.Infinite;
 
     public static void PushTelemetryState(Message request, RequestTelemetryState telemetryState, TimeSpan timeout, Action<RequestTelemetryState> timeoutCallback)
@@ -50,7 +50,7 @@ public static void PushTelemetryState(Message request, RequestTelemetryState tel
         }
     }
 
-    private static void OnTimer(object state)
+    private static void OnTimer(object? state)
     {
         List<Tuple<EntryTimeoutProperties, Entry>>? timedOutEntries = null;
         lock (Sync)
@@ -139,9 +139,13 @@ public EntryTimeoutProperties(string messageId, long expiresAt, Action<RequestTe
             this.TimeoutCallback = timeoutCallback;
         }
 
-        public int CompareTo(object obj)
+        public int CompareTo(object? obj)
         {
-            var other = (EntryTimeoutProperties)obj;
+            if (obj is not EntryTimeoutProperties other)
+            {
+                return 1;
+            }
+
             var result = this.ExpiresAt.CompareTo(other.ExpiresAt);
             if (result == 0)
             {

diff --git a/src/OpenTelemetry.Instrumentation.Wcf/Implementation/TelemetryPropagationWriter.cs b/src/OpenTelemetry.Instrumentation.Wcf/Implementation/TelemetryPropagationWriter.cs
@@ -48,8 +48,7 @@ public static void HttpRequestHeaders(Message request, string name, string value
             return;
         }
 
-        object prop;
-        if (!request.Properties.TryGetValue(HttpRequestMessagePropertyWrapper.Name, out prop))
+        if (!request.Properties.TryGetValue(HttpRequestMessagePropertyWrapper.Name, out var prop))
         {
             prop = HttpRequestMessagePropertyWrapper.CreateNew();
             request.Properties.Add(HttpRequestMessagePropertyWrapper.Name, prop);

diff --git a/src/OpenTelemetry.Instrumentation.Wcf/Implementation/WcfInstrumentationActivitySource.cs b/src/OpenTelemetry.Instrumentation.Wcf/Implementation/WcfInstrumentationActivitySource.cs
@@ -16,7 +16,7 @@ internal static class WcfInstrumentationActivitySource
 {
     internal static readonly Assembly Assembly = typeof(WcfInstrumentationActivitySource).Assembly;
     internal static readonly AssemblyName AssemblyName = Assembly.GetName();
-    internal static readonly string ActivitySourceName = AssemblyName.Name;
+    internal static readonly string ActivitySourceName = AssemblyName.Name!;
     internal static readonly string IncomingRequestActivityName = ActivitySourceName + ".IncomingRequest";
     internal static readonly string OutgoingRequestActivityName = ActivitySourceName + ".OutgoingRequest";
 

diff --git a/src/OpenTelemetry.Instrumentation.Wcf/OpenTelemetry.Instrumentation.Wcf.csproj b/src/OpenTelemetry.Instrumentation.Wcf/OpenTelemetry.Instrumentation.Wcf.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <!-- OmniSharp/VS Code requires TargetFrameworks to be in descending order for IntelliSense and analysis. -->
-    <TargetFrameworks>$(NetStandardMinimumSupportedVersion);$(NetFrameworkMinimumSupportedVersion)</TargetFrameworks>
+    <TargetFrameworks>net6.0;$(NetStandardMinimumSupportedVersion);$(NetFrameworkMinimumSupportedVersion)</TargetFrameworks>
     <Description>OpenTelemetry instrumentation for WCF.</Description>
     <PackageTags>$(PackageTags);distributed-tracing;WCF</PackageTags>
     <MinVerTagPrefix>Instrumentation.Wcf-</MinVerTagPrefix>
@@ -23,9 +23,10 @@
     <Reference Include="System.ServiceModel" />
   </ItemGroup>
 
-  <ItemGroup Condition="'$(TargetFramework)' == '$(NetStandardMinimumSupportedVersion)'">
+  <ItemGroup Condition="'$(TargetFramework)' == '$(NetStandardMinimumSupportedVersion)' OR '$(TargetFramework)' == 'net6.0' " >
     <PackageReference Include="System.Security.Cryptography.Xml" Version="4.7.1" />
     <PackageReference Include="System.ServiceModel.Primitives" Version="4.7.0" />
+    <PackageReference Include="System.Drawing.Common" Version="4.7.2" Condition=" '$(TargetFramework)' == 'net6.0' " />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/test/OpenTelemetry.Instrumentation.Wcf.Tests/OpenTelemetry.Instrumentation.Wcf.Tests.csproj b/test/OpenTelemetry.Instrumentation.Wcf.Tests/OpenTelemetry.Instrumentation.Wcf.Tests.csproj
@@ -22,8 +22,6 @@
   <ItemGroup Condition="'$(TargetFramework)' != '$(NetFrameworkMinimumSupportedVersion)'">
     <PackageReference Include="System.ServiceModel.Http" Version="4.7.0" />
     <PackageReference Include="System.ServiceModel.NetTcp" Version="4.7.0" />
-    <!-- System.Drawing.Common is indirect reference. It is needed to upgrade it directly to avoid https://github.com/advisories/GHSA-rxg9-xrhp-64gj -->
-    <PackageReference Include="System.Drawing.Common" Version="4.7.3" />
   </ItemGroup>
 
   <ItemGroup>