Start the beginning of AOT'ing the Aspire.Cli. (#9841)

* Start the beginning of AOT'ing the Aspire.Cli.

Depends on microsoft/vs-streamjsonrpc#1196

* Revert cli.csproj changes

* Revert Designer.cs changes

* Share state object types across CLI and Hosting.

* Split the Backchannel data types across assemblies again

* Revert launchSettings.json

Author: eerhardt

Directory.Packages.props

@@ -108,7 +108,7 @@
     <PackageVersion Include="StackExchange.Redis" Version="2.8.37" />
     <PackageVersion Include="System.IO.Hashing" Version="9.0.4" />
     <PackageVersion Include="Yarp.ReverseProxy" Version="2.3.0" />
-    <PackageVersion Include="StreamJsonRpc" Version="2.21.69" />
+    <PackageVersion Include="StreamJsonRpc" Version="2.22.11" />
     <PackageVersion Include="Semver" Version="3.0.0" />
     <!-- Open Telemetry -->
     <PackageVersion Include="Npgsql.OpenTelemetry" Version="9.0.3" />

src/Aspire.Cli/Aspire.Cli.csproj

@@ -34,10 +34,10 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Compile Include="$(RepoRoot)src\Shared\KnownConfigNames.cs" Link="KnownConfigNames.cs" />
+    <Compile Include="$(SharedDir)KnownConfigNames.cs" Link="KnownConfigNames.cs" />
     <Compile Include="$(SharedDir)PathNormalizer.cs" Link="Utils\PathNormalizer.cs" />
     <Compile Include="$(SharedDir)CircularBuffer.cs" Link="Utils\CircularBuffer.cs" />
-    <Compile Include="..\Shared\StringComparers.cs" Link="StringComparers.cs" />
+    <Compile Include="$(SharedDir)StringComparers.cs" Link="StringComparers.cs" />
   </ItemGroup>
 
   <ItemGroup>

src/Aspire.Cli/Backchannel/AppHostBackchannel.cs

@@ -22,7 +22,7 @@ internal interface IAppHostBackchannel
     Task<string[]> GetCapabilitiesAsync(CancellationToken cancellationToken);
 }
 
-internal sealed class AppHostBackchannel(ILogger<AppHostBackchannel> logger, CliRpcTarget target, AspireCliTelemetry telemetry) : IAppHostBackchannel
+internal sealed class AppHostBackchannel(ILogger<AppHostBackchannel> logger, AspireCliTelemetry telemetry) : IAppHostBackchannel
 {
     private const string BaselineCapability = "baseline.v2";
     private readonly TaskCompletionSource<JsonRpc> _rpcTaskCompletionSource = new();
@@ -69,15 +69,15 @@ await rpc.InvokeWithCancellationAsync(
 
         logger.LogDebug("Requesting dashboard URL");
 
-        var url = await rpc.InvokeWithCancellationAsync<(string BaseUrlWithLoginToken, string? CodespacesUrlWithLoginToken)>(
+        var url = await rpc.InvokeWithCancellationAsync<DashboardUrlsState>(
             "GetDashboardUrlsAsync",
             Array.Empty<object>(),
             cancellationToken);
 
-        return url;
+        return (url.BaseUrlWithLoginToken, url.CodespacesUrlWithLoginToken);
     }
 
-    public async IAsyncEnumerable<RpcResourceState> GetResourceStatesAsync([EnumeratorCancellation]CancellationToken cancellationToken)
+    public async IAsyncEnumerable<RpcResourceState> GetResourceStatesAsync([EnumeratorCancellation] CancellationToken cancellationToken)
     {
         using var activity = telemetry.ActivitySource.StartActivity();
 
@@ -116,7 +116,8 @@ public async Task ConnectAsync(string socketPath, CancellationToken cancellation
             logger.LogDebug("Connected to AppHost backchannel at {SocketPath}", socketPath);
 
             var stream = new NetworkStream(socket, true);
-            var rpc = JsonRpc.Attach(stream, target);
+            var rpc = new JsonRpc(new HeaderDelimitedMessageHandler(stream, stream, new SystemTextJsonFormatter()));
+            rpc.StartListening();
 
             var capabilities = await rpc.InvokeWithCancellationAsync<string[]>(
                 "GetCapabilitiesAsync",
@@ -143,15 +144,15 @@ public async Task ConnectAsync(string socketPath, CancellationToken cancellation
         }
     }
 
-    public async IAsyncEnumerable<(string Id, string StatusText, bool IsComplete, bool IsError)> GetPublishingActivitiesAsync([EnumeratorCancellation]CancellationToken cancellationToken)
+    public async IAsyncEnumerable<(string Id, string StatusText, bool IsComplete, bool IsError)> GetPublishingActivitiesAsync([EnumeratorCancellation] CancellationToken cancellationToken)
     {
         using var activity = telemetry.ActivitySource.StartActivity();
 
         var rpc = await _rpcTaskCompletionSource.Task;
 
         logger.LogDebug("Requesting publishing activities.");
 
-        var resourceStates = await rpc.InvokeWithCancellationAsync<IAsyncEnumerable<(string Id, string StatusText, bool IsComplete, bool IsError)>>(
+        var resourceStates = await rpc.InvokeWithCancellationAsync<IAsyncEnumerable<PublishingActivityState>>(
             "GetPublishingActivitiesAsync",
             Array.Empty<object>(),
             cancellationToken);
@@ -160,7 +161,11 @@ public async Task ConnectAsync(string socketPath, CancellationToken cancellation
 
         await foreach (var state in resourceStates.WithCancellation(cancellationToken))
         {
-            yield return state;
+            yield return (
+                state.Id,
+                state.StatusText,
+                state.IsComplete,
+                state.IsError);
         }
     }
 

src/Aspire.Cli/Backchannel/BackchannelDataTypes.cs

@@ -0,0 +1,77 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Aspire.Cli.Backchannel;
+
+/// <summary>
+/// Represents the state of a resource reported via RPC.
+/// </summary>
+internal sealed class RpcResourceState
+{
+    /// <summary>
+    /// Gets the name of the resource.
+    /// </summary>
+    public required string Resource { get; init; }
+
+    /// <summary>
+    /// Gets the type of the resource.
+    /// </summary>
+    public required string Type { get; init; }
+
+    /// <summary>
+    /// Gets the state of the resource.
+    /// </summary>
+    public required string State { get; init; }
+
+    /// <summary>
+    /// Gets the endpoints associated with the resource.
+    /// </summary>
+    public required string[] Endpoints { get; init; }
+
+    /// <summary>
+    /// Gets the health status of the resource.
+    /// </summary>
+    public string? Health { get; init; }
+}
+
+/// <summary>
+/// Represents dashboard URLs with authentication tokens.
+/// </summary>
+internal sealed class DashboardUrlsState
+{
+    /// <summary>
+    /// Gets the base dashboard URL with a login token.
+    /// </summary>
+    public required string BaseUrlWithLoginToken { get; init; }
+
+    /// <summary>
+    /// Gets the Codespaces dashboard URL with a login token, if available.
+    /// </summary>
+    public string? CodespacesUrlWithLoginToken { get; init; }
+}
+
+/// <summary>
+/// Represents the activity and status of a publishing operation.
+/// </summary>
+internal sealed class PublishingActivityState
+{
+    /// <summary>
+    /// Gets the unique identifier for the publishing activity.
+    /// </summary>
+    public required string Id { get; init; }
+
+    /// <summary>
+    /// Gets the status text describing the publishing activity.
+    /// </summary>
+    public required string StatusText { get; init; }
+
+    /// <summary>
+    /// Gets a value indicating whether the publishing activity is complete.
+    /// </summary>
+    public bool IsComplete { get; init; }
+
+    /// <summary>
+    /// Gets a value indicating whether the publishing activity encountered an error.
+    /// </summary>
+    public bool IsError { get; init; }
+}

src/Aspire.Cli/Backchannel/CliRpcTarget.cs

@@ -99,7 +99,6 @@ private static IHost BuildApplication(string[] args)
         builder.Services.AddSingleton<AspireCliTelemetry>();
         builder.Services.AddTransient<IDotNetCliRunner, DotNetCliRunner>();
         builder.Services.AddTransient<IAppHostBackchannel, AppHostBackchannel>();
-        builder.Services.AddSingleton<CliRpcTarget>();
         builder.Services.AddSingleton<INuGetPackageCache, NuGetPackageCache>();
         builder.Services.AddHostedService(BuildNuGetPackagePrefetcher);
         builder.Services.AddMemoryCache();

src/Aspire.Cli/Backchannel/RpcResourceState.cs

@@ -21,9 +21,9 @@ internal class AppHostRpcTarget(
     PublishingActivityProgressReporter activityReporter,
     IHostApplicationLifetime lifetime,
     DistributedApplicationOptions options
-    ) 
+    )
 {
-    public async IAsyncEnumerable<(string Id, string StatusText, bool IsComplete, bool IsError)> GetPublishingActivitiesAsync([EnumeratorCancellation]CancellationToken cancellationToken)
+    public async IAsyncEnumerable<PublishingActivityState> GetPublishingActivitiesAsync([EnumeratorCancellation] CancellationToken cancellationToken)
     {
         while (cancellationToken.IsCancellationRequested == false)
         {
@@ -36,14 +36,15 @@ DistributedApplicationOptions options
                 yield break;
             }
 
-            yield return (
-                publishingActivityStatus.Activity.Id,
-                publishingActivityStatus.StatusText,
-                publishingActivityStatus.IsComplete,
-                publishingActivityStatus.IsError
-            );
+            yield return new PublishingActivityState
+            {
+                Id = publishingActivityStatus.Activity.Id,
+                StatusText = publishingActivityStatus.StatusText,
+                IsComplete = publishingActivityStatus.IsComplete,
+                IsError = publishingActivityStatus.IsError
+            };
 
-            if ( publishingActivityStatus.Activity.IsPrimary &&(publishingActivityStatus.IsComplete || publishingActivityStatus.IsError))
+            if (publishingActivityStatus.Activity.IsPrimary && (publishingActivityStatus.IsComplete || publishingActivityStatus.IsError))
             {
                 // If the activity is complete or an error and it is the primary activity,
                 // we can stop listening for updates.
@@ -52,7 +53,7 @@ DistributedApplicationOptions options
         }
     }
 
-    public async IAsyncEnumerable<RpcResourceState> GetResourceStatesAsync([EnumeratorCancellation]CancellationToken cancellationToken)
+    public async IAsyncEnumerable<RpcResourceState> GetResourceStatesAsync([EnumeratorCancellation] CancellationToken cancellationToken)
     {
         var resourceEvents = resourceNotificationService.WatchAsync(cancellationToken);
 
@@ -69,15 +70,15 @@ public async IAsyncEnumerable<RpcResourceState> GetResourceStatesAsync([Enumerat
                 logger.LogTrace("Resource {Resource} does not have endpoints.", resourceEvent.Resource.Name);
                 endpoints = Enumerable.Empty<EndpointAnnotation>();
             }
-    
+
             var endpointUris = endpoints
                 .Where(e => e.AllocatedEndpoint != null)
                 .Select(e => e.AllocatedEndpoint!.UriString)
                 .ToArray();
 
             // Compute health status
             var healthStatus = CustomResourceSnapshot.ComputeHealthStatus(resourceEvent.Snapshot.HealthReports, resourceEvent.Snapshot.State?.Text);
-            
+
             yield return new RpcResourceState
             {
                 Resource = resourceEvent.Resource.Name,
@@ -103,12 +104,12 @@ public Task<long> PingAsync(long timestamp, CancellationToken cancellationToken)
         return Task.FromResult(timestamp);
     }
 
-    public Task<(string BaseUrlWithLoginToken, string? CodespacesUrlWithLoginToken)> GetDashboardUrlsAsync()
+    public Task<DashboardUrlsState> GetDashboardUrlsAsync()
     {
         return GetDashboardUrlsAsync(CancellationToken.None);
     }
 
-    public async Task<(string BaseUrlWithLoginToken, string? CodespacesUrlWithLoginToken)> GetDashboardUrlsAsync(CancellationToken cancellationToken)
+    public async Task<DashboardUrlsState> GetDashboardUrlsAsync(CancellationToken cancellationToken)
     {
         if (!options.DashboardEnabled)
         {
@@ -134,7 +135,7 @@ await resourceNotificationService.WaitForResourceHealthyAsync(
         if (!StringUtils.TryGetUriFromDelimitedString(dashboardOptions.Value.DashboardUrl, ";", out var dashboardUri))
         {
             logger.LogWarning("Dashboard URL could not be parsed from dashboard options.");
-            throw new InvalidOperationException("Dashboard URL could not be parsed from dashboard options.");            
+            throw new InvalidOperationException("Dashboard URL could not be parsed from dashboard options.");
         }
 
         var codespacesUrlRewriter = serviceProvider.GetService<CodespacesUrlRewriter>();
@@ -144,11 +145,18 @@ await resourceNotificationService.WaitForResourceHealthyAsync(
 
         if (baseUrlWithLoginToken == codespacesUrlWithLoginToken)
         {
-            return (baseUrlWithLoginToken, null);
+            return new DashboardUrlsState
+            {
+                BaseUrlWithLoginToken = baseUrlWithLoginToken
+            };
         }
         else
         {
-            return (baseUrlWithLoginToken, codespacesUrlWithLoginToken);
+            return new DashboardUrlsState
+            {
+                BaseUrlWithLoginToken = baseUrlWithLoginToken,
+                CodespacesUrlWithLoginToken = codespacesUrlWithLoginToken
+            };
         }
     }
 
@@ -178,4 +186,4 @@ public Task<string[]> GetCapabilitiesAsync(CancellationToken cancellationToken)
             });
     }
 #pragma warning restore CA1822
-}
+}