// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using Aspire.Dashboard.Components.Controls;
using Aspire.Dashboard.Components.Controls.Grid;
using Aspire.Dashboard.Components.Pages;
using Aspire.Dashboard.Components.Resize;
using Aspire.Dashboard.Components.Tests.Shared;
using Aspire.Dashboard.Configuration;
using Aspire.Dashboard.Extensions;
using Aspire.Dashboard.Model;
using Aspire.Dashboard.Model.Otlp;
using Aspire.Dashboard.Otlp.Model;
using Aspire.Dashboard.Otlp.Storage;
using Aspire.Dashboard.Utils;
using Bunit;
using Google.Protobuf.Collections;
using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Components.Web.Virtualization;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Localization;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Options;
using Microsoft.FluentUI.AspNetCore.Components;
using OpenTelemetry.Proto.Logs.V1;
using Xunit;
using static Aspire.Tests.Shared.Telemetry.TelemetryTestHelpers;
namespace Aspire.Dashboard.Components.Tests.Pages;
[UseCulture("en-US")]
public partial class StructuredLogsTests : DashboardTestContext
{
[Fact]
public async Task Render_ResourceInstanceHasDashes_AppKeyResolvedCorrectly()
{
// Arrange
SetupStructureLogsServices();
var telemetryRepository = Services.GetRequiredService<SqliteTelemetryRepository>();
await telemetryRepository.AddLogsAsync(new AddContext(), new RepeatedField<ResourceLogs>
{
new ResourceLogs
{
Resource = CreateResource(name: "TestApp", instanceId: "abc-def"),
ScopeLogs =
{
new ScopeLogs
{
Scope = CreateScope(name: "test-scope"),
LogRecords =
{
CreateLogRecord()
}
}
}
}
});
var navigationManager = Services.GetRequiredService<NavigationManager>();
var uri = navigationManager.ToAbsoluteUri(DashboardUrls.StructuredLogsUrl(resource: "TestApp"));
navigationManager.NavigateTo(uri.OriginalString);
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var dimensionManager = Services.GetRequiredService<DimensionManager>();
dimensionManager.InvokeOnViewportInformationChanged(viewport);
// Act
var cut = Render<StructuredLogs>(builder =>
{
builder.Add(p => p.ResourceName, "TestApp");
builder.Add(p => p.ViewportInformation, viewport);
});
// Assert
var viewModel = cut.Instance.ViewModel;
Assert.NotNull(viewModel.ResourceKey);
Assert.Equal("TestApp", viewModel.ResourceKey.Value.Name);
Assert.Equal("abc-def", viewModel.ResourceKey.Value.InstanceId);
}
[Fact]
public void Render_TraceIdAndSpanId_FilterAdded()
{
// Arrange
SetupStructureLogsServices();
var navigationManager = Services.GetRequiredService<NavigationManager>();
var uri = navigationManager.ToAbsoluteUri(DashboardUrls.StructuredLogsUrl(traceId: "123", spanId: "456"));
navigationManager.NavigateTo(uri.OriginalString);
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var dimensionManager = Services.GetRequiredService<DimensionManager>();
dimensionManager.InvokeOnViewportInformationChanged(viewport);
// Act
var cut = Render<StructuredLogs>(builder =>
{
builder.Add(p => p.ViewportInformation, viewport);
});
// Assert
var viewModel = cut.Instance.ViewModel;
Assert.Collection(viewModel.Filters,
f =>
{
Assert.Equal(KnownStructuredLogFields.TraceIdField, f.Field);
Assert.Equal("123", f.Value);
},
f =>
{
Assert.Equal(KnownStructuredLogFields.SpanIdField, f.Field);
Assert.Equal("456", f.Value);
});
}
[Fact]
public void Render_DuplicateFilters_SingleFilterAdded()
{
// Arrange
SetupStructureLogsServices();
var filter = new FieldTelemetryFilter { Field = "TestField", Condition = FilterCondition.Contains, Value = "TestValue" };
var serializedFilter = TelemetryFilterFormatter.SerializeFiltersToString([filter, filter]);
var navigationManager = Services.GetRequiredService<NavigationManager>();
var uri = navigationManager.ToAbsoluteUri(DashboardUrls.StructuredLogsUrl(filters: serializedFilter));
navigationManager.NavigateTo(uri.OriginalString);
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var dimensionManager = Services.GetRequiredService<DimensionManager>();
dimensionManager.InvokeOnViewportInformationChanged(viewport);
// Act
var cut = Render<StructuredLogs>(builder =>
{
builder.Add(p => p.ViewportInformation, viewport);
});
// Assert
var viewModel = cut.Instance.ViewModel;
Assert.Collection(viewModel.Filters,
f =>
{
Assert.Equal(filter.Field, f.Field);
Assert.Equal(filter.Condition, f.Condition);
Assert.Equal(filter.Value, f.Value);
});
}
[Fact]
public void Render_FiltersWithSpecialCharacters_SuccessfullyParsed()
{
// Arrange
SetupStructureLogsServices();
var filter1 = new FieldTelemetryFilter { Field = "Test:Field", Condition = FilterCondition.Contains, Value = "Test Value" };
var filter2 = new FieldTelemetryFilter { Field = "Test!@#", Condition = FilterCondition.Contains, Value = "http://localhost#fragment?hi=true" };
var filter3 = new FieldTelemetryFilter { Field = "\u2764\uFE0F", Condition = FilterCondition.Contains, Value = "\u4F60" };
var serializedFilter = TelemetryFilterFormatter.SerializeFiltersToString([filter1, filter2, filter3]);
var navigationManager = Services.GetRequiredService<NavigationManager>();
var uri = navigationManager.ToAbsoluteUri(DashboardUrls.StructuredLogsUrl(filters: serializedFilter));
navigationManager.NavigateTo(uri.OriginalString);
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var dimensionManager = Services.GetRequiredService<DimensionManager>();
dimensionManager.InvokeOnViewportInformationChanged(viewport);
// Act
var cut = Render<StructuredLogs>(builder =>
{
builder.Add(p => p.ViewportInformation, viewport);
});
// Assert
var viewModel = cut.Instance.ViewModel;
Assert.Collection(viewModel.Filters,
f =>
{
Assert.Equal(filter1.Field, f.Field);
Assert.Equal(filter1.Condition, f.Condition);
Assert.Equal(filter1.Value, f.Value);
},
f =>
{
Assert.Equal(filter2.Field, f.Field);
Assert.Equal(filter2.Condition, f.Condition);
Assert.Equal(filter2.Value, f.Value);
},
f =>
{
Assert.Equal(filter3.Field, f.Field);
Assert.Equal(filter3.Condition, f.Condition);
Assert.Equal(filter3.Value, f.Value);
});
}
[Fact]
public void Render_FocusesAccessibleScrollContainerOnInitialRender()
{
SetupStructureLogsServices();
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var dimensionManager = Services.GetRequiredService<DimensionManager>();
dimensionManager.InvokeOnViewportInformationChanged(viewport);
var cut = Render<StructuredLogs>(builder =>
{
builder.Add(p => p.ViewportInformation, viewport);
});
var scrollContainer = cut.Find("#structuredLogsScrollContainer");
var scrollButton = Assert.Single(scrollContainer.QuerySelectorAll(":scope > aspire-scroll-to-bottom"));
Assert.True(scrollButton.HasAttribute("hidden"));
var controlsLoc = Services.GetRequiredService<IStringLocalizer<Dashboard.Resources.ControlsStrings>>();
Assert.Equal(controlsLoc[nameof(Dashboard.Resources.ControlsStrings.ScrollToBottom)].Value, scrollButton.GetAttribute("data-scroll-to-bottom-label"));
var grid = cut.FindComponent<AspireFluentDataGrid<LogSummary>>();
var loc = Services.GetRequiredService<IStringLocalizer<Dashboard.Resources.StructuredLogs>>();
Assert.Equal("0", scrollContainer.GetAttribute("tabindex"));
Assert.Equal("region", scrollContainer.GetAttribute("role"));
Assert.Equal(loc[nameof(Dashboard.Resources.StructuredLogs.StructuredLogsHeader)].Value, scrollContainer.GetAttribute("aria-label"));
Assert.Equal(VirtualizeAnchorMode.End, grid.Instance.AnchorMode);
cut.WaitForAssertion(() =>
{
Assert.Contains(JSInterop.Invocations, invocation =>
invocation.Identifier == "focusElement" &&
invocation.Arguments.Count == 2 &&
string.Equals(invocation.Arguments[0]?.ToString(), "structuredLogsScrollContainer", StringComparison.Ordinal) &&
string.Equals(invocation.Arguments[1]?.ToString(), bool.TrueString, StringComparison.OrdinalIgnoreCase));
});
}
[Fact]
public async Task ItemsProvider_ZeroCountRefresh_ReturnsData()
{
SetupStructureLogsServices();
var telemetryRepository = Services.GetRequiredService<SqliteTelemetryRepository>();
await telemetryRepository.AddLogsAsync(new AddContext(), new RepeatedField<ResourceLogs>
{
new ResourceLogs
{
Resource = CreateResource(),
ScopeLogs =
{
new ScopeLogs
{
Scope = CreateScope(),
LogRecords =
{
CreateLogRecord(),
CreateLogRecord(),
CreateLogRecord(),
CreateLogRecord(),
CreateLogRecord(),
CreateLogRecord()
}
}
}
}
});
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
Services.GetRequiredService<DimensionManager>().InvokeOnViewportInformationChanged(viewport);
var cut = Render<StructuredLogs>(builder => builder.Add(p => p.ViewportInformation, viewport));
var grid = cut.FindComponent<AspireFluentDataGrid<LogSummary>>();
await grid.InvokeAsync(grid.Instance.RefreshDataAndRenderAsync);
var result = await cut.InvokeAsync(() => grid.Instance.ItemsProvider!(new GridItemsProviderRequest<LogSummary>
{
StartIndex = 0,
Count = 0
}).AsTask());
var refreshedResult = await cut.InvokeAsync(() => grid.Instance.ItemsProvider!(new GridItemsProviderRequest<LogSummary>
{
StartIndex = 0,
Count = 0
}).AsTask());
Assert.Equal(6, result.TotalItemCount);
Assert.Equal(6, result.Items.Count);
var itemComparer = Assert.IsAssignableFrom<IEqualityComparer<LogSummary>>(grid.Instance.ItemComparer);
var items = result.Items.ToArray();
var refreshedItems = refreshedResult.Items.ToArray();
Assert.NotSame(items[0], refreshedItems[0]);
Assert.True(itemComparer.Equals(items[0], refreshedItems[0]));
Assert.False(itemComparer.Equals(items[0], items[1]));
}
[Fact]
public void Render_FilterDisablesBrowserAutocomplete()
{
SetupStructureLogsServices();
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var dimensionManager = Services.GetRequiredService<DimensionManager>();
dimensionManager.InvokeOnViewportInformationChanged(viewport);
var cut = Render<StructuredLogs>(builder =>
{
builder.Add(p => p.ViewportInformation, viewport);
});
var search = Assert.Single(cut.FindComponents<FluentTextInput>());
Assert.Equal("off", search.Instance.AutoComplete);
}
[Fact]
public void PauseIncomingData_DisplaysPauseWarningImmediately()
{
SetupStructureLogsServices();
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
var dimensionManager = Services.GetRequiredService<DimensionManager>();
dimensionManager.InvokeOnViewportInformationChanged(viewport);
var cut = Render<StructuredLogs>(builder =>
{
builder.Add(p => p.ViewportInformation, viewport);
});
cut.FindComponent<PauseIncomingDataSwitch>().WaitForElement("fluent-button").Click();
// The click handler flows through PauseManager and then re-renders the page, so the pause state and the
// warning banner do not both land in the same render pass. Waiting avoids asserting on an interim render.
cut.WaitForAssertion(() =>
{
Assert.True(Services.GetRequiredService<PauseManager>().AreStructuredLogsPaused(out _));
Assert.Contains("Capture paused", cut.Markup);
});
}
[Theory]
[InlineData(false, 1)]
[InlineData(true, 0)]
public async Task Render_AtLogLimit_LimitMessageOnlyDisplayedForLiveRun(bool isReadOnly, int expectedMessageCount)
{
SetupStructureLogsServices();
Services.AddSingleton<IOptions<DashboardOptions>>(Options.Create(new DashboardOptions
{
TelemetryLimits = { MaxLogCount = 1 }
}));
await FluentUISetupHelpers.ConfigureTelemetryRepository(this, isReadOnly, telemetryRepository => telemetryRepository.AddLogsAsync(new AddContext(), new RepeatedField<ResourceLogs>
{
new ResourceLogs
{
Resource = CreateResource(),
ScopeLogs =
{
new ScopeLogs
{
Scope = CreateScope(),
LogRecords = { CreateLogRecord() }
}
}
}
}));
var viewport = new ViewportInformation(IsDesktop: true, IsUltraLowHeight: false, IsUltraLowWidth: false);
Services.GetRequiredService<DimensionManager>().InvokeOnViewportInformationChanged(viewport);
var cut = FluentUISetupHelpers.RenderMessageBarProviderWithPage<StructuredLogs>(this, viewport);
var grid = cut.FindComponent<AspireFluentDataGrid<LogSummary>>();
await grid.InvokeAsync(grid.Instance.RefreshDataAndRenderAsync);
cut.WaitForAssertion(() => Assert.Equal(expectedMessageCount, cut.FindComponents<DashboardMessageBar>().Count));
}
private void SetupStructureLogsServices()
{
FluentUISetupHelpers.SetupFluentDivider(this);
FluentUISetupHelpers.SetupFluentInputLabel(this);
FluentUISetupHelpers.SetupFluentDataGrid(this);
FluentUISetupHelpers.SetupFluentList(this);
FluentUISetupHelpers.SetupFluentSearch(this);
FluentUISetupHelpers.SetupFluentKeyCode(this);
FluentUISetupHelpers.SetupFluentMenu(this);
FluentUISetupHelpers.SetupFluentToolbar(this);
FluentUISetupHelpers.SetupFluentAnchoredRegion(this);
JSInterop.SetupVoid("focusElement", _ => true);
FluentUISetupHelpers.AddCommonDashboardServices(this);
Services.AddSingleton<ILogger<StructuredLogs>>(NullLogger<StructuredLogs>.Instance);
Services.AddTransient<StructuredLogsViewModel>();
}
}