Remove InternalsVisibleTo from Components to Components.Server

Copilot · javiercn · Copilot · commit 45bf8bc082e6 · 2025-05-23T16:40:43.000Z
Co-authored-by: javiercn &lt;6995051+javiercn@users.noreply.github.com&gt;
diff --git a/src/Components/Components/src/ComponentsActivitySource.cs b/src/Components/Components/src/ComponentsActivitySource.cs
@@ -11,17 +11,28 @@ namespace Microsoft.AspNetCore.Components;
 internal class ComponentsActivitySource
 {
     internal const string Name = "Microsoft.AspNetCore.Components";
-    internal const string OnCircuitName = $"{Name}.CircuitStart";
     internal const string OnRouteName = $"{Name}.RouteChange";
     internal const string OnEventName = $"{Name}.HandleEvent";
 
     private ActivityContext _httpContext;
-    private ActivityContext _circuitContext;
-    private string? _circuitId;
     private ActivityContext _routeContext;
+    private Activity? _capturedActivity;
 
     private ActivitySource ActivitySource { get; } = new ActivitySource(Name);
 
+    /// <summary>
+    /// Initializes the ComponentsActivitySource with a captured activity for linking.
+    /// </summary>
+    /// <param name="capturedActivity">Activity to link with component activities.</param>
+    public void Initialize(Activity? capturedActivity)
+    {
+        _capturedActivity = capturedActivity;
+        _httpContext = CaptureHttpContext();
+    }
+
+    /// <summary>
+    /// Captures the current HTTP context activity.
+    /// </summary>
     public static ActivityContext CaptureHttpContext()
     {
         var parentActivity = Activity.Current;
@@ -32,58 +43,19 @@ public static ActivityContext CaptureHttpContext()
         return default;
     }
 
-    public Activity? StartCircuitActivity(string circuitId, ActivityContext httpContext)
-    {
-        _circuitId = circuitId;
-
-        var activity = ActivitySource.CreateActivity(OnCircuitName, ActivityKind.Internal, parentId: null, null, null);
-        if (activity is not null)
-        {
-            if (activity.IsAllDataRequested)
-            {
-                if (_circuitId != null)
-                {
-                    activity.SetTag("aspnetcore.components.circuit.id", _circuitId);
-                }
-                if (httpContext != default)
-                {
-                    activity.AddLink(new ActivityLink(httpContext));
-                }
-            }
-            activity.DisplayName = $"Circuit {circuitId ?? ""}";
-            activity.Start();
-            _circuitContext = activity.Context;
-        }
-        return activity;
-    }
-
-    public void FailCircuitActivity(Activity? activity, Exception ex)
-    {
-        _circuitContext = default;
-        if (activity != null && !activity.IsStopped)
-        {
-            activity.SetTag("error.type", ex.GetType().FullName);
-            activity.SetStatus(ActivityStatusCode.Error);
-            activity.Stop();
-        }
-    }
-
     public Activity? StartRouteActivity(string componentType, string route)
     {
-        if (_httpContext == default)
-        {
-            _httpContext = CaptureHttpContext();
-        }
-
         var activity = ActivitySource.CreateActivity(OnRouteName, ActivityKind.Internal, parentId: null, null, null);
         if (activity is not null)
         {
             if (activity.IsAllDataRequested)
             {
-                if (_circuitId != null)
+                // Copy any circuit ID from captured activity if present
+                if (_capturedActivity != null && _capturedActivity.GetTagItem("aspnetcore.components.circuit.id") is string circuitId)
                 {
-                    activity.SetTag("aspnetcore.components.circuit.id", _circuitId);
+                    activity.SetTag("aspnetcore.components.circuit.id", circuitId);
                 }
+                
                 if (componentType != null)
                 {
                     activity.SetTag("aspnetcore.components.type", componentType);
@@ -96,9 +68,9 @@ public void FailCircuitActivity(Activity? activity, Exception ex)
                 {
                     activity.AddLink(new ActivityLink(_httpContext));
                 }
-                if (_circuitContext != default)
+                if (_capturedActivity != null)
                 {
-                    activity.AddLink(new ActivityLink(_circuitContext));
+                    activity.AddLink(new ActivityLink(_capturedActivity.Context));
                 }
             }
 
@@ -116,10 +88,12 @@ public void FailCircuitActivity(Activity? activity, Exception ex)
         {
             if (activity.IsAllDataRequested)
             {
-                if (_circuitId != null)
+                // Copy any circuit ID from captured activity if present
+                if (_capturedActivity != null && _capturedActivity.GetTagItem("aspnetcore.components.circuit.id") is string circuitId)
                 {
-                    activity.SetTag("aspnetcore.components.circuit.id", _circuitId);
+                    activity.SetTag("aspnetcore.components.circuit.id", circuitId);
                 }
+                
                 if (componentType != null)
                 {
                     activity.SetTag("aspnetcore.components.type", componentType);
@@ -136,9 +110,9 @@ public void FailCircuitActivity(Activity? activity, Exception ex)
                 {
                     activity.AddLink(new ActivityLink(_httpContext));
                 }
-                if (_circuitContext != default)
+                if (_capturedActivity != null)
                 {
-                    activity.AddLink(new ActivityLink(_circuitContext));
+                    activity.AddLink(new ActivityLink(_capturedActivity.Context));
                 }
                 if (_routeContext != default)
                 {
diff --git a/src/Components/Components/src/Microsoft.AspNetCore.Components.csproj b/src/Components/Components/src/Microsoft.AspNetCore.Components.csproj
@@ -79,7 +79,6 @@
 
   <ItemGroup>
     <InternalsVisibleTo Include="Microsoft.AspNetCore.Components.Web" />
-    <InternalsVisibleTo Include="Microsoft.AspNetCore.Components.Server" />
     <InternalsVisibleTo Include="Microsoft.AspNetCore.Blazor.Build.Tests" />
     <InternalsVisibleTo Include="Microsoft.AspNetCore.Components.Authorization.Tests" />
     <InternalsVisibleTo Include="Microsoft.AspNetCore.Components.Forms.Tests" />
diff --git a/src/Components/Server/src/Circuits/CircuitActivitySource.cs b/src/Components/Server/src/Circuits/CircuitActivitySource.cs
@@ -0,0 +1,86 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics;
+
+namespace Microsoft.AspNetCore.Components.Server.Circuits;
+
+/// <summary>
+/// Activity source for circuit-related activities.
+/// </summary>
+public class CircuitActivitySource
+{
+    internal const string Name = "Microsoft.AspNetCore.Components.Server";
+    internal const string OnCircuitName = $"{Name}.CircuitStart";
+    
+    private ActivitySource ActivitySource { get; } = new ActivitySource(Name);
+
+    /// <summary>
+    /// Creates and starts a new activity for circuit initialization.
+    /// </summary>
+    /// <param name="circuitId">The ID of the circuit being initialized.</param>
+    /// <param name="httpContext">The HTTP context associated with the request that created the circuit.</param>
+    /// <returns>The created activity.</returns>
+    public Activity? StartCircuitActivity(string circuitId, ActivityContext httpContext)
+    {
+        var activity = ActivitySource.CreateActivity(OnCircuitName, ActivityKind.Internal, parentId: null, null, null);
+        if (activity is not null)
+        {
+            if (activity.IsAllDataRequested)
+            {
+                if (circuitId != null)
+                {
+                    activity.SetTag("aspnetcore.components.circuit.id", circuitId);
+                }
+                if (httpContext != default)
+                {
+                    activity.AddLink(new ActivityLink(httpContext));
+                }
+            }
+            activity.DisplayName = $"Circuit {circuitId ?? ""}";
+            activity.Start();
+        }
+        return activity;
+    }
+
+    /// <summary>
+    /// Stops a circuit activity that was previously started.
+    /// </summary>
+    /// <param name="activity">The activity to stop.</param>
+    public void StopCircuitActivity(Activity? activity)
+    {
+        if (activity != null && !activity.IsStopped)
+        {
+            activity.Stop();
+        }
+    }
+
+    /// <summary>
+    /// Marks a circuit activity as failed and stops it.
+    /// </summary>
+    /// <param name="activity">The activity to mark as failed.</param>
+    /// <param name="ex">The exception that caused the failure.</param>
+    public void FailCircuitActivity(Activity? activity, Exception ex)
+    {
+        if (activity != null && !activity.IsStopped)
+        {
+            activity.SetTag("error.type", ex.GetType().FullName);
+            activity.SetStatus(ActivityStatusCode.Error);
+            activity.Stop();
+        }
+    }
+
+    /// <summary>
+    /// Captures the current HTTP context activity.
+    /// </summary>
+    /// <returns>The captured HTTP context activity.</returns>
+    public static ActivityContext CaptureHttpContext()
+    {
+        var parentActivity = Activity.Current;
+        if (parentActivity is not null && parentActivity.OperationName == "Microsoft.AspNetCore.Hosting.HttpRequestIn" && parentActivity.Recorded)
+        {
+            return parentActivity.Context;
+        }
+        return default;
+    }
+}
diff --git a/src/Components/Server/src/Circuits/CircuitActivitySourceServiceCollectionExtensions.cs b/src/Components/Server/src/Circuits/CircuitActivitySourceServiceCollectionExtensions.cs
@@ -0,0 +1,24 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Microsoft.AspNetCore.Components.Server.Circuits;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+/// <summary>
+/// Extension methods for adding <see cref="CircuitActivitySource"/> to the service collection.
+/// </summary>
+internal static class CircuitActivitySourceServiceCollectionExtensions
+{
+    /// <summary>
+    /// Adds <see cref="CircuitActivitySource"/> to the service collection.
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/>.</param>
+    /// <returns>The <see cref="IServiceCollection"/>.</returns>
+    public static IServiceCollection AddCircuitActivitySource(this IServiceCollection services)
+    {
+        services.TryAddSingleton<CircuitActivitySource>();
+        return services;
+    }
+}
diff --git a/src/Components/Server/src/Circuits/CircuitFactory.cs b/src/Components/Server/src/Circuits/CircuitFactory.cs
@@ -1,6 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Diagnostics;
 using System.Linq;
 using System.Security.Claims;
 using Microsoft.AspNetCore.Components.Infrastructure;
@@ -45,7 +46,8 @@ public async ValueTask<CircuitHost> CreateCircuitHostAsync(
         string uri,
         ClaimsPrincipal user,
         IPersistentComponentStateStore store,
-        ResourceAssetCollection resourceCollection)
+        ResourceAssetCollection resourceCollection,
+        Activity? circuitActivity = null)
     {
         var scope = _scopeFactory.CreateAsyncScope();
         var jsRuntime = (RemoteJSRuntime)scope.ServiceProvider.GetRequiredService<IJSRuntime>();
@@ -67,6 +69,11 @@ public async ValueTask<CircuitHost> CreateCircuitHostAsync(
             navigationManager.Initialize(baseUri, uri);
         }
         var componentsActivitySource = scope.ServiceProvider.GetService<ComponentsActivitySource>();
+        
+        // Initialize the components activity source with the circuit activity if available
+        componentsActivitySource?.Initialize(circuitActivity);
+        
+        var circuitActivitySource = scope.ServiceProvider.GetService<CircuitActivitySource>();
 
         if (components.Count > 0)
         {
@@ -99,8 +106,10 @@ public async ValueTask<CircuitHost> CreateCircuitHostAsync(
             .OrderBy(h => h.Order)
             .ToArray();
 
+        var circuitId = _circuitIdFactory.CreateCircuitId();
+        
         var circuitHost = new CircuitHost(
-            _circuitIdFactory.CreateCircuitId(),
+            circuitId,
             scope,
             _options,
             client,
@@ -110,7 +119,8 @@ public async ValueTask<CircuitHost> CreateCircuitHostAsync(
             navigationManager,
             circuitHandlers,
             _circuitMetrics,
-            componentsActivitySource,
+            circuitActivitySource,
+            circuitActivity,
             _loggerFactory.CreateLogger<CircuitHost>());
         Log.CreatedCircuit(_logger, circuitHost);
 
diff --git a/src/Components/Server/src/Circuits/CircuitHost.cs b/src/Components/Server/src/Circuits/CircuitHost.cs
@@ -25,7 +25,8 @@ internal partial class CircuitHost : IAsyncDisposable
     private readonly RemoteNavigationManager _navigationManager;
     private readonly ILogger _logger;
     private readonly CircuitMetrics? _circuitMetrics;
-    private readonly ComponentsActivitySource? _componentsActivitySource;
+    private readonly CircuitActivitySource? _circuitActivitySource;
+    private readonly Activity? _circuitActivity;
     private Func<Func<Task>, Task> _dispatchInboundActivity;
     private CircuitHandler[] _circuitHandlers;
     private bool _initialized;
@@ -52,7 +53,8 @@ public CircuitHost(
         RemoteNavigationManager navigationManager,
         CircuitHandler[] circuitHandlers,
         CircuitMetrics? circuitMetrics,
-        ComponentsActivitySource? componentsActivitySource,
+        CircuitActivitySource? circuitActivitySource,
+        Activity? circuitActivity,
         ILogger logger)
     {
         CircuitId = circuitId;
@@ -71,7 +73,8 @@ public CircuitHost(
         _navigationManager = navigationManager ?? throw new ArgumentNullException(nameof(navigationManager));
         _circuitHandlers = circuitHandlers ?? throw new ArgumentNullException(nameof(circuitHandlers));
         _circuitMetrics = circuitMetrics;
-        _componentsActivitySource = componentsActivitySource;
+        _circuitActivitySource = circuitActivitySource;
+        _circuitActivity = circuitActivity;
         _logger = logger ?? throw new ArgumentNullException(nameof(logger));
 
         Services = scope.ServiceProvider;
@@ -124,7 +127,6 @@ public Task InitializeAsync(ProtectedPrerenderComponentApplicationStore store, A
             {
                 _initialized = true; // We're ready to accept incoming JSInterop calls from here on
 
-                activity = _componentsActivitySource?.StartCircuitActivity(CircuitId.Id, httpContext);
                 _startTime = (_circuitMetrics != null && _circuitMetrics.IsDurationEnabled()) ? Stopwatch.GetTimestamp() : 0;
 
                 // We only run the handlers in case we are in a Blazor Server scenario, which renders
@@ -169,12 +171,10 @@ public Task InitializeAsync(ProtectedPrerenderComponentApplicationStore store, A
                 _isFirstUpdate = Descriptors.Count == 0;
 
                 Log.InitializationSucceeded(_logger);
-
-                activity?.Stop();
             }
             catch (Exception ex)
             {
-                _componentsActivitySource?.FailCircuitActivity(activity, ex);
+                _circuitActivitySource?.FailCircuitActivity(_circuitActivity, ex);
 
                 // Report errors asynchronously. InitializeAsync is designed not to throw.
                 Log.InitializationFailed(_logger, ex);
@@ -337,6 +337,9 @@ private async Task OnCircuitDownAsync(CancellationToken cancellationToken)
     {
         Log.CircuitClosed(_logger, CircuitId);
         _circuitMetrics?.OnCircuitDown(_startTime, Stopwatch.GetTimestamp());
+        
+        // Stop the circuit activity when the circuit is closed
+        _circuitActivitySource?.StopCircuitActivity(_circuitActivity);
 
         List<Exception> exceptions = null;
 
diff --git a/src/Components/Server/src/Circuits/ICircuitFactory.cs b/src/Components/Server/src/Circuits/ICircuitFactory.cs
@@ -1,6 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Diagnostics;
 using System.Security.Claims;
 
 namespace Microsoft.AspNetCore.Components.Server.Circuits;
@@ -14,5 +15,6 @@ ValueTask<CircuitHost> CreateCircuitHostAsync(
         string uri,
         ClaimsPrincipal user,
         IPersistentComponentStateStore store,
-        ResourceAssetCollection resourceCollection);
+        ResourceAssetCollection resourceCollection,
+        Activity? circuitActivity = null);
 }
diff --git a/src/Components/Server/src/ComponentHub.cs b/src/Components/Server/src/ComponentHub.cs
diff --git a/src/Components/Server/src/DependencyInjection/ComponentServiceCollectionExtensions.cs b/src/Components/Server/src/DependencyInjection/ComponentServiceCollectionExtensions.cs
