Fixup doc and style warnings.

Author: philliphoff

src/Shared/Grpc/Tracing/DiagnosticActivityExtensions.cs

@@ -1,21 +1,31 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-// NOTE: Modified from https://github.com/Azure/durabletask/blob/main/src/DurableTask.Core/Tracing/DiagnosticActivityExtensions.cs
-
 using System.Diagnostics;
 using System.Linq.Expressions;
 using System.Reflection;
 
+// NOTE: Modified from https://github.com/Azure/durabletask/blob/main/src/DurableTask.Core/Tracing/DiagnosticActivityExtensions.cs
 namespace Microsoft.DurableTask.Tracing;
 
 /// <summary>
-/// Replica from System.Diagnostics.DiagnosticSource >= 6.0.0
+/// Replica from System.Diagnostics.DiagnosticSource >= 6.0.0.
 /// </summary>
 enum ActivityStatusCode
 {
+    /// <summary>
+    /// The default value indicating the status code is not initialized.
+    /// </summary>
     Unset = 0,
-    OK = 1,
+
+    /// <summary>
+    /// Indicates the operation has been validated and completed successfully.
+    /// </summary>
+    Ok = 1,
+
+    /// <summary>
+    /// Indicates an error was encountered during the operation.
+    /// </summary>
     Error = 2,
 }
 
@@ -24,39 +34,56 @@ enum ActivityStatusCode
 /// </summary>
 static class DiagnosticActivityExtensions
 {
-    static readonly Action<Activity, string> s_setSpanId;
-    static readonly Action<Activity, ActivityStatusCode, string> s_setStatus;
+    static readonly Action<Activity, string> SetSpanIdMethod;
+    static readonly Action<Activity, ActivityStatusCode, string> SetStatusMethod;
 
     static DiagnosticActivityExtensions()
     {
         BindingFlags flags = BindingFlags.NonPublic | BindingFlags.Instance;
-        s_setSpanId = (typeof(Activity).GetField("_spanId", flags) ?? throw new InvalidOperationException("The field Activity._spanId was not found.")).CreateSetter<Activity, string>();
-        s_setStatus = CreateSetStatus();
+        SetSpanIdMethod = (typeof(Activity).GetField("_spanId", flags) ?? throw new InvalidOperationException("The field Activity._spanId was not found.")).CreateSetter<Activity, string>();
+        SetStatusMethod = CreateSetStatus();
     }
 
+    /// <summary>
+    /// Explicitly sets the span ID for the given activity.
+    /// </summary>
+    /// <param name="activity">The activity on which to set the span ID.</param>
+    /// <param name="spanId">The span ID to set.</param>
     public static void SetSpanId(this Activity activity, string spanId)
-        => s_setSpanId(activity, spanId);
+        => SetSpanIdMethod(activity, spanId);
 
+    /// <summary>
+    /// Explicitly sets the status code and description for the given activity.
+    /// </summary>
+    /// <param name="activity">The activity on which to set the span ID.</param>
+    /// <param name="status">The status to set.</param>
+    /// <param name="description">The description to set.</param>
     public static void SetStatus(this Activity activity, ActivityStatusCode status, string description)
-        => s_setStatus(activity, status, description);
+        => SetStatusMethod(activity, status, description);
 
     static Action<Activity, ActivityStatusCode, string> CreateSetStatus()
     {
-        MethodInfo method = typeof(Activity).GetMethod("SetStatus");
+        MethodInfo? method = typeof(Activity).GetMethod("SetStatus");
+
         if (method is null)
         {
-            return (activity, status, description) => {
+            return (activity, status, description) =>
+            {
+#pragma warning disable CA1510
                 if (activity is null)
                 {
                     throw new ArgumentNullException(nameof(activity));
                 }
-                string str = status switch
+#pragma warning restore CA1510
+
+                string? str = status switch
                 {
                     ActivityStatusCode.Unset => "UNSET",
-                    ActivityStatusCode.OK => "OK",
+                    ActivityStatusCode.Ok => "OK",
                     ActivityStatusCode.Error => "ERROR",
                     _ => null,
                 };
+
                 activity.SetTag("otel.status_code", str);
                 activity.SetTag("otel.status_description", description);
             };

src/Shared/Grpc/Tracing/FieldInfoExtensionMethods.cs

@@ -1,11 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-// NOTE: Modified from https://github.com/Azure/durabletask/blob/main/src/DurableTask.Core/Tracing/FieldInfoExtensionMethods.cs
-
 using System.Linq.Expressions;
 using System.Reflection;
 
+// NOTE: Modified from https://github.com/Azure/durabletask/blob/main/src/DurableTask.Core/Tracing/FieldInfoExtensionMethods.cs
 namespace Microsoft.DurableTask.Tracing;
 
 /// <summary>
@@ -23,10 +22,17 @@ static class FieldInfoExtensionMethods
     /// <returns>A re-usable action to set the field.</returns>
     internal static Action<TTarget, TValue> CreateSetter<TTarget, TValue>(this FieldInfo fieldInfo)
     {
+#pragma warning disable CA1510
         if (fieldInfo == null)
         {
             throw new ArgumentNullException(nameof(fieldInfo));
         }
+#pragma warning restore CA1510
+
+        if (fieldInfo.DeclaringType is null)
+        {
+            throw new ArgumentException("FieldInfo.DeclaringType cannot be null.", nameof(fieldInfo));
+        }
 
         ParameterExpression targetExp = Expression.Parameter(typeof(TTarget), "target");
         Expression source = targetExp;

src/Shared/Grpc/Tracing/TraceActivityConstants.cs

@@ -1,17 +1,41 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-// NOTE: Modified from https://github.com/Azure/durabletask/blob/main/src/DurableTask.Core/Tracing/TraceActivityConstants.cs
-
+// Modified from https://github.com/Azure/durabletask/blob/main/src/DurableTask.Core/Tracing/TraceActivityConstants.cs.
 namespace Microsoft.DurableTask.Tracing;
 
+/// <summary>
+/// Constants for trace activity names used in Durable Task Framework.
+/// </summary>
 class TraceActivityConstants
 {
+    /// <summary>
+    /// The name of the activity that represents orchestration operations.
+    /// </summary>
     public const string Orchestration = "orchestration";
+
+    /// <summary>
+    /// The name of the activity that represents activity operations.
+    /// </summary>
     public const string Activity = "activity";
+
+    /// <summary>
+    /// The name of the activity that represents entity operations.
+    /// </summary>
     public const string Event = "event";
+
+    /// <summary>
+    /// The name of the activity that represents timer operations.
+    /// </summary>
     public const string Timer = "timer";
 
+    /// <summary>
+    /// The name of the activity that represents an operation to create an orchestration.
+    /// </summary>
     public const string CreateOrchestration = "create_orchestration";
+
+    /// <summary>
+    /// The name of the activity that represents an operation to raise an event.
+    /// </summary>
     public const string OrchestrationEvent = "orchestration_event";
 }