Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 29 additions & 20 deletions src/Aspire.Dashboard/Model/ResourceMenuItems.cs
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,26 @@ public static void AddMenuItems(
}

// Show telemetry menu items if there is telemetry for the resource.
var hasTelemetryApplication = telemetryRepository.GetApplicationByCompositeName(resource.Name) != null;
if (hasTelemetryApplication)
var telemetryApplication = telemetryRepository.GetApplicationByCompositeName(resource.Name);
if (telemetryApplication != null)
{
menuItems.Add(new MenuButtonItem { IsDivider = true });
menuItems.Add(new MenuButtonItem

if (!telemetryApplication.UninstrumentedPeer)
{
Text = loc[nameof(Resources.Resources.ResourceActionStructuredLogsText)],
Tooltip = loc[nameof(Resources.Resources.ResourceActionStructuredLogsText)],
Icon = s_structuredLogsIcon,
OnClick = () =>
menuItems.Add(new MenuButtonItem
{
navigationManager.NavigateTo(DashboardUrls.StructuredLogsUrl(resource: getResourceName(resource)));
return Task.CompletedTask;
}
});
Text = loc[nameof(Resources.Resources.ResourceActionStructuredLogsText)],
Tooltip = loc[nameof(Resources.Resources.ResourceActionStructuredLogsText)],
Icon = s_structuredLogsIcon,
OnClick = () =>
{
navigationManager.NavigateTo(DashboardUrls.StructuredLogsUrl(resource: getResourceName(resource)));
return Task.CompletedTask;
}
});
}

menuItems.Add(new MenuButtonItem
{
Text = loc[nameof(Resources.Resources.ResourceActionTracesText)],
Expand All @@ -82,17 +87,21 @@ public static void AddMenuItems(
return Task.CompletedTask;
}
});
menuItems.Add(new MenuButtonItem

if (!telemetryApplication.UninstrumentedPeer)
{
Text = loc[nameof(Resources.Resources.ResourceActionMetricsText)],
Tooltip = loc[nameof(Resources.Resources.ResourceActionMetricsText)],
Icon = s_metricsIcon,
OnClick = () =>
menuItems.Add(new MenuButtonItem
{
navigationManager.NavigateTo(DashboardUrls.MetricsUrl(resource: getResourceName(resource)));
return Task.CompletedTask;
}
});
Text = loc[nameof(Resources.Resources.ResourceActionMetricsText)],
Tooltip = loc[nameof(Resources.Resources.ResourceActionMetricsText)],
Icon = s_metricsIcon,
OnClick = () =>
{
navigationManager.NavigateTo(DashboardUrls.MetricsUrl(resource: getResourceName(resource)));
return Task.CompletedTask;
}
});
}
}

var menuCommands = resource.Commands
Expand Down
159 changes: 159 additions & 0 deletions tests/Aspire.Dashboard.Tests/Model/ResourceMenuItemsTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
// 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.Model;
using Aspire.Dashboard.Otlp.Model;
using Aspire.Dashboard.Tests.TelemetryRepositoryTests;
using Aspire.Tests.Shared.DashboardModel;
using Aspire.Tests.Shared.Telemetry;
using Google.Protobuf.Collections;
using Microsoft.AspNetCore.Components;
using OpenTelemetry.Proto.Trace.V1;
using Xunit;

namespace Aspire.Dashboard.Tests.Model;

public sealed class ResourceMenuItemsTests
{
private static readonly DateTime s_testTime = new(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);

[Fact]
public void AddMenuItems_NoTelemetry_NoTelemetryItems()
{
// Arrange
var resource = ModelTestHelpers.CreateResource();
var telemetryRespository = TelemetryTestHelpers.CreateRepository();

// Act
var menuItems = new List<MenuButtonItem>();
ResourceMenuItems.AddMenuItems(
menuItems,
openingMenuButtonId: null,
resource,
new TestNavigationManager(),
telemetryRespository,
r => r.Name,
new TestStringLocalizer<Resources.ControlsStrings>(),
new TestStringLocalizer<Resources.Resources>(),
_ => Task.CompletedTask,
_ => Task.CompletedTask,
(_, _) => false,
true,
true);

// Assert
Assert.Collection(menuItems,
e => Assert.Equal("Localized:ActionViewDetailsText", e.Text),
e => Assert.Equal("Localized:ResourceActionConsoleLogsText", e.Text));
}

[Fact]
public void AddMenuItems_UninstrumentedPeer_TraceItem()
{
// Arrange
var resource = ModelTestHelpers.CreateResource(appName: "test-abc");
var outgoingPeerResolver = new TestOutgoingPeerResolver(onResolve: attributes => (resource.Name, resource));
var repository = TelemetryTestHelpers.CreateRepository(outgoingPeerResolvers: [outgoingPeerResolver]);
var addContext = new AddContext();
repository.AddTraces(addContext, new RepeatedField<ResourceSpans>()
{
new ResourceSpans
{
Resource = TelemetryTestHelpers.CreateResource(name: "source", instanceId: "abc"),
ScopeSpans =
{
new ScopeSpans
{
Scope = TelemetryTestHelpers.CreateScope(),
Spans =
{
TelemetryTestHelpers.CreateSpan(traceId: "1", spanId: "1-1", startTime: s_testTime.AddMinutes(1), endTime: s_testTime.AddMinutes(10), attributes: [KeyValuePair.Create(OtlpSpan.PeerServiceAttributeKey, "value-1")], kind: Span.Types.SpanKind.Client),
TelemetryTestHelpers.CreateSpan(traceId: "1", spanId: "1-2", startTime: s_testTime.AddMinutes(5), endTime: s_testTime.AddMinutes(10), parentSpanId: "1-1", attributes: [KeyValuePair.Create(OtlpSpan.PeerServiceAttributeKey, "value-2")], kind: Span.Types.SpanKind.Client)
}
}
}
}
});

// Act
var menuItems = new List<MenuButtonItem>();
ResourceMenuItems.AddMenuItems(
menuItems,
openingMenuButtonId: null,
resource,
new TestNavigationManager(),
repository,
r => r.Name,
new TestStringLocalizer<Resources.ControlsStrings>(),
new TestStringLocalizer<Resources.Resources>(),
_ => Task.CompletedTask,
_ => Task.CompletedTask,
(_, _) => false,
true,
true);

// Assert
Assert.Collection(menuItems,
e => Assert.Equal("Localized:ActionViewDetailsText", e.Text),
e => Assert.Equal("Localized:ResourceActionConsoleLogsText", e.Text),
e => Assert.True(e.IsDivider),
e => Assert.Equal("Localized:ResourceActionTracesText", e.Text));
}

[Fact]
public void AddMenuItems_HasTelemetry_TelemetryItems()
{
// Arrange
var resource = ModelTestHelpers.CreateResource(appName: "test-abc");
var repository = TelemetryTestHelpers.CreateRepository();
var addContext = new AddContext();
repository.AddTraces(addContext, new RepeatedField<ResourceSpans>()
{
new ResourceSpans
{
Resource = TelemetryTestHelpers.CreateResource(name: "test", instanceId: "abc"),
ScopeSpans =
{
new ScopeSpans
{
Scope = TelemetryTestHelpers.CreateScope(),
Spans =
{
TelemetryTestHelpers.CreateSpan(traceId: "1", spanId: "1-1", startTime: s_testTime.AddMinutes(1), endTime: s_testTime.AddMinutes(10))
}
}
}
}
});

// Act
var menuItems = new List<MenuButtonItem>();
ResourceMenuItems.AddMenuItems(
menuItems,
openingMenuButtonId: null,
resource,
new TestNavigationManager(),
repository,
r => r.Name,
new TestStringLocalizer<Resources.ControlsStrings>(),
new TestStringLocalizer<Resources.Resources>(),
_ => Task.CompletedTask,
_ => Task.CompletedTask,
(_, _) => false,
true,
true);

// Assert
Assert.Collection(menuItems,
e => Assert.Equal("Localized:ActionViewDetailsText", e.Text),
e => Assert.Equal("Localized:ResourceActionConsoleLogsText", e.Text),
e => Assert.True(e.IsDivider),
e => Assert.Equal("Localized:ResourceActionStructuredLogsText", e.Text),
e => Assert.Equal("Localized:ResourceActionTracesText", e.Text),
e => Assert.Equal("Localized:ResourceActionMetricsText", e.Text));
}

private sealed class TestNavigationManager : NavigationManager
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// 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.Model;
using Aspire.Tests.Shared.DashboardModel;

namespace Aspire.Dashboard.Tests.TelemetryRepositoryTests;

public sealed class TestOutgoingPeerResolver : IOutgoingPeerResolver, IDisposable
{
private readonly Func<KeyValuePair<string, string>[], (string? Name, ResourceViewModel? Resource)>? _onResolve;
private readonly List<Func<Task>> _callbacks;

public TestOutgoingPeerResolver(Func<KeyValuePair<string, string>[], (string? Name, ResourceViewModel? Resource)>? onResolve = null)
{
_onResolve = onResolve;
_callbacks = new();
}

public void Dispose()
{
}

public IDisposable OnPeerChanges(Func<Task> callback)
{
_callbacks.Add(callback);
return this;
}

public async Task InvokePeerChanges()
{
foreach (var callback in _callbacks)
{
await callback();
}
}

public bool TryResolvePeer(KeyValuePair<string, string>[] attributes, out string? name, out ResourceViewModel? matchedResourced)
{
if (_onResolve != null)
{
(name, matchedResourced) = _onResolve(attributes);
return (name != null);
}

name = "TestPeer";
matchedResourced = ModelTestHelpers.CreateResource(appName: "TestPeer");
return true;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

using System.Globalization;
using System.Text;
using Aspire.Dashboard.Model;
using Aspire.Dashboard.Model.Otlp;
using Aspire.Dashboard.Otlp.Model;
using Aspire.Dashboard.Otlp.Storage;
Expand Down Expand Up @@ -1929,49 +1928,6 @@ public void RemoveTraces_SelectedResource_SpansFromDifferentTrace()
});
}

private sealed class TestOutgoingPeerResolver : IOutgoingPeerResolver, IDisposable
{
private readonly Func<KeyValuePair<string, string>[], (string? Name, ResourceViewModel? Resource)>? _onResolve;
private readonly List<Func<Task>> _callbacks;

public TestOutgoingPeerResolver(Func<KeyValuePair<string, string>[], (string? Name, ResourceViewModel? Resource)>? onResolve = null)
{
_onResolve = onResolve;
_callbacks = new();
}

public void Dispose()
{
}

public IDisposable OnPeerChanges(Func<Task> callback)
{
_callbacks.Add(callback);
return this;
}

public async Task InvokePeerChanges()
{
foreach (var callback in _callbacks)
{
await callback();
}
}

public bool TryResolvePeer(KeyValuePair<string, string>[] attributes, out string? name, out ResourceViewModel? matchedResourced)
{
if (_onResolve != null)
{
(name, matchedResourced) = _onResolve(attributes);
return (name != null);
}

name = "TestPeer";
matchedResourced = ModelTestHelpers.CreateResource(appName: "TestPeer");
return true;
}
}

[Fact]
public void AddTraces_HaveUninstrumentedPeers()
{
Expand Down