Dashboard line record

Author: JamesNK

src/Aspire.Dashboard/Components/Controls/LogViewer.razor.cs

@@ -40,7 +40,7 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
     private readonly List<LogEntry> _logEntries = new();
     private int? _baseLineNumber;
 
-    internal async Task SetLogSourceAsync(IAsyncEnumerable<IReadOnlyList<(int LineNumber, string Content, bool IsErrorMessage)>> batches, bool convertTimestampsFromUtc)
+    internal async Task SetLogSourceAsync(IAsyncEnumerable<IReadOnlyList<ResourceLogLine>> batches, bool convertTimestampsFromUtc)
     {
         _convertTimestampsFromUtc = convertTimestampsFromUtc;
 

src/Aspire.Dashboard/Model/DashboardClient.cs

@@ -426,7 +426,7 @@ async IAsyncEnumerable<IReadOnlyList<ResourceViewModelChange>> StreamUpdatesAsyn
         }
     }
 
-    async IAsyncEnumerable<IReadOnlyList<(int LineNumber, string Content, bool IsErrorMessage)>>? IDashboardClient.SubscribeConsoleLogs(string resourceName, [EnumeratorCancellation] CancellationToken cancellationToken)
+    async IAsyncEnumerable<IReadOnlyList<ResourceLogLine>>? IDashboardClient.SubscribeConsoleLogs(string resourceName, [EnumeratorCancellation] CancellationToken cancellationToken)
     {
         EnsureInitialized();
 
@@ -438,7 +438,7 @@ async IAsyncEnumerable<IReadOnlyList<ResourceViewModelChange>> StreamUpdatesAsyn
 
         // Write incoming logs to a channel, and then read from that channel to yield the logs.
         // We do this to batch logs together and enforce a minimum read interval.
-        var channel = Channel.CreateUnbounded<IReadOnlyList<(int LineNumber, string Content, bool IsErrorMessage)>>(
+        var channel = Channel.CreateUnbounded<IReadOnlyList<ResourceLogLine>>(
             new UnboundedChannelOptions { AllowSynchronousContinuations = false, SingleReader = true, SingleWriter = true });
 
         var readTask = Task.Run(async () =>
@@ -447,11 +447,11 @@ async IAsyncEnumerable<IReadOnlyList<ResourceViewModelChange>> StreamUpdatesAsyn
             {
                 await foreach (var response in call.ResponseStream.ReadAllAsync(cancellationToken: combinedTokens.Token))
                 {
-                    var logLines = new (int LineNumber, string Content, bool IsErrorMessage)[response.LogLines.Count];
+                    var logLines = new ResourceLogLine[response.LogLines.Count];
 
                     for (var i = 0; i < logLines.Length; i++)
                     {
-                        logLines[i] = (response.LogLines[i].LineNumber, response.LogLines[i].Text, response.LogLines[i].IsStdErr);
+                        logLines[i] = new ResourceLogLine(response.LogLines[i].LineNumber, response.LogLines[i].Text, response.LogLines[i].IsStdErr);
                     }
 
                     // Channel is unbound so TryWrite always succeeds.

src/Aspire.Dashboard/Model/IDashboardClient.cs

@@ -49,7 +49,7 @@ public interface IDashboardClient : IAsyncDisposable
     /// </remarks>
     /// <para>It is important that callers trigger <paramref name="cancellationToken"/>
     /// so that resources owned by the sequence and its consumers can be freed.</para>
-    IAsyncEnumerable<IReadOnlyList<(int LineNumber, string Content, bool IsErrorMessage)>>? SubscribeConsoleLogs(string resourceName, CancellationToken cancellationToken);
+    IAsyncEnumerable<IReadOnlyList<ResourceLogLine>>? SubscribeConsoleLogs(string resourceName, CancellationToken cancellationToken);
 
     Task<ResourceCommandResponseViewModel> ExecuteResourceCommandAsync(string resourceName, string resourceType, CommandViewModel command, CancellationToken cancellationToken);
 }

src/Aspire.Dashboard/Model/ResourceLogLine.cs

@@ -0,0 +1,8 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Aspire.Dashboard.Model;
+
+public readonly record struct ResourceLogLine(int LineNumber, string Content, bool IsErrorMessage)
+{
+}

tests/Aspire.Dashboard.Components.Tests/Controls/ApplicationNameTests.cs

@@ -51,7 +51,7 @@ private sealed class MockDashboardClient : IDashboardClient
         public string ApplicationName => "<marquee>An HTML title!</marquee>";
         public ValueTask DisposeAsync() => ValueTask.CompletedTask;
         public Task<ResourceCommandResponseViewModel> ExecuteResourceCommandAsync(string resourceName, string resourceType, CommandViewModel command, CancellationToken cancellationToken) => throw new NotImplementedException();
-        public IAsyncEnumerable<IReadOnlyList<(int LineNumber, string Content, bool IsErrorMessage)>>? SubscribeConsoleLogs(string resourceName, CancellationToken cancellationToken) => throw new NotImplementedException();
+        public IAsyncEnumerable<IReadOnlyList<ResourceLogLine>>? SubscribeConsoleLogs(string resourceName, CancellationToken cancellationToken) => throw new NotImplementedException();
         public Task<ResourceViewModelSubscription> SubscribeResourcesAsync(CancellationToken cancellationToken) => throw new NotImplementedException();
     }
 }

tests/Aspire.Dashboard.Tests/ResourceOutgoingPeerResolverTests.cs

@@ -181,7 +181,7 @@ private sealed class MockDashboardClient(Task<ResourceViewModelSubscription> sub
         public string ApplicationName => "ApplicationName";
         public ValueTask DisposeAsync() => ValueTask.CompletedTask;
         public Task<ResourceCommandResponseViewModel> ExecuteResourceCommandAsync(string resourceName, string resourceType, CommandViewModel command, CancellationToken cancellationToken) => throw new NotImplementedException();
-        public IAsyncEnumerable<IReadOnlyList<(int LineNumber, string Content, bool IsErrorMessage)>>? SubscribeConsoleLogs(string resourceName, CancellationToken cancellationToken) => throw new NotImplementedException();
+        public IAsyncEnumerable<IReadOnlyList<ResourceLogLine>>? SubscribeConsoleLogs(string resourceName, CancellationToken cancellationToken) => throw new NotImplementedException();
         public Task<ResourceViewModelSubscription> SubscribeResourcesAsync(CancellationToken cancellationToken) => subscribeResult;
     }
 }