Render publish summary hierarchy and timeline by sebastienros · Pull Request #15530 · microsoft/aspire

sebastienros · 2026-03-24T15:15:26Z

Description

Organizes the aspire do publish step summary hierarchically instead of sorting steps by duration alone.

It also adds a compact Unicode timeline ruler and per-step bars so the summary shows when each step starts and finishes while keeping the same number of step lines.

To support the display, the pipeline now includes display-parent and level metadata for publish steps, and the CLI uses that metadata when rendering the summary.

Examples:

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Link to aspire.dev issue:
    - New issue
- No

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-03-24T15:15:39Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 15530

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 15530"

Copilot

Pull request overview

This PR enhances aspire do publish step summaries by rendering steps in a hierarchical (parent/child) order and adding a compact timeline ruler + per-step bars to visualize when each step starts/finishes. It does so by emitting hierarchy metadata from the hosting pipeline and consuming it in the CLI summary renderer.

Changes:

Add ParentStepId / HierarchyLevel metadata to publishing step activities and propagate it from pipeline execution.
Update CLI summary rendering to order steps hierarchically and display a timeline scale with per-step bars.
Add/extend unit tests for hierarchy metadata emission and timeline/tree rendering.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tests/Aspire.Hosting.Tests/Publishing/PipelineActivityReporterTests.cs	Adds coverage ensuring hierarchy metadata is emitted on step create/complete activities.
tests/Aspire.Cli.Tests/Utils/ConsoleActivityLoggerTests.cs	Adds assertions for hierarchical ordering and timeline ruler/bar output in summaries.
src/Aspire.Hosting/Pipelines/ReportingStep.cs	Stores parent step id + hierarchy level on the reporting step instance.
src/Aspire.Hosting/Pipelines/PipelineActivityReporter.cs	Emits hierarchy metadata in step activities via a shared activity-data builder.
src/Aspire.Hosting/Pipelines/DistributedApplicationPipeline.cs	Computes display hierarchy from DAG dependencies and supplies parent/level metadata when creating reporting steps.
src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs	Extends backchannel activity payload with `ParentStepId` and `HierarchyLevel`.
src/Aspire.Cli/Utils/ConsoleActivityLogger.cs	Implements hierarchical ordering + timeline ruler/bars in the “Steps Summary” output.
src/Aspire.Cli/Commands/PipelineCommandBase.cs	Captures hierarchy metadata from activities and populates duration records with offsets for timeline rendering.

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs

src/Aspire.Cli/Commands/PipelineCommandBase.cs

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

adamint

I like it, works well with multiple hierarchy levels too

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

JamesNK · 2026-03-24T22:54:07Z

Nice.

I noticed the ticks at the top of the summary aren't consistently placed:

JamesNK · 2026-03-24T22:55:20Z

What happens with long step names when there isn't enough room:

JamesNK · 2026-03-24T22:56:40Z

How deeply can things be nested? If something is nested 10 levels deep, what is displayed? It seems like text would be completely out of view because of indenting.

JamesNK · 2026-03-24T22:58:11Z

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs

+        var timelineLabelPrefix = $"  {new string(' ', durationWidth)}    {"Step timeline:".PadRight(nameWidth)}  ";
+
+        _console.WriteLine();
+        _console.MarkupLine("Steps Summary:");


Move text to a resource file

JamesNK · 2026-03-24T22:59:10Z

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs

+    {
+        var orderedRecords = OrderStepDurationsHierarchically(records);
+        var durationWidth = Math.Max(10, orderedRecords.Max(r => DurationFormatter.FormatDuration(r.Duration, CultureInfo.InvariantCulture, DecimalDurationDisplay.Fixed).Length));
+        var nameWidth = Math.Max("Step timeline:".Length, orderedRecords.Max(r => GetIndentedDisplayName(r).Length));


Move text to a resource file

JamesNK · 2026-03-24T23:05:39Z

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs

+
+    private static string BuildTimelineLabels(TimeSpan totalTimeline, int width)
+    {
+        var startText = "0s";


Rather than hardcode "0s", what most timelines do (including the dashboard) is using the highest unit. That means if the highest time is still in ms, then the start should be "0ms"

For example:

ms:

s:

JamesNK · 2026-03-24T23:06:34Z

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs

+
+        if (startIndex == endIndex)
+        {
+            chars[startIndex] = '●';


Is this for very small duration? What does it look like?

Maybe add some more comments to these methods.

JamesNK · 2026-03-24T23:09:08Z

src/Aspire.Hosting/Backchannel/BackchannelDataTypes.cs

+    /// <summary>
+    /// Gets the identifier of the parent step used for hierarchical step summaries.
+    /// </summary>
+    public string? ParentStepId { get; init; }
+
+    /// <summary>
+    /// Gets the hierarchical level of the step used for display purposes.
+    /// </summary>
+    public int? HierarchyLevel { get; init; }


What happens if a new CLI is run against an old app host that doesn't return this data?

JamesNK · 2026-03-24T23:14:16Z

In the dashboard I found it useful to have a stress project that would generate extreme results that I could use to test the UI. I think you need something like that to test this timeline.

I added an internal aspire render command for testing rendering various things. I think you could add an option to render this timeline with static data for various scenarios: deeply nested steps, very long text, text containing markup, mixing in steps without parents, very long and very short durations, etc.

Use your imagination and try hard to break the UI with extreme situations. That's the only way to create something that consistently works for everyone.

Render publish summary hierarchy and timeline

5bf0ae9

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

sebastienros requested review from JamesNK, danegsta, davidfowl, karolz-ms and mitchdenny as code owners March 24, 2026 15:15

Copilot AI review requested due to automatic review settings March 24, 2026 15:15

Copilot started reviewing on behalf of sebastienros March 24, 2026 15:16 View session

Copilot AI reviewed Mar 24, 2026

View reviewed changes

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs Show resolved Hide resolved

src/Aspire.Cli/Commands/PipelineCommandBase.cs Outdated Show resolved Hide resolved

sebastienros and others added 2 commits March 24, 2026 08:27

Address publish summary review feedback

af190a3

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Stabilize publish summary timeline test

a20caef

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions bot mentioned this pull request Mar 24, 2026

[pull requests] Review required #13834

Open

adamint approved these changes Mar 24, 2026

View reviewed changes

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs Show resolved Hide resolved

src/Aspire.Cli/Utils/ConsoleActivityLogger.cs Outdated Show resolved Hide resolved

Address publish summary review feedback

ea8ba9b

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

JamesNK reviewed Mar 24, 2026

View reviewed changes

Conversation

sebastienros commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

github-actions bot commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

adamint left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JamesNK commented Mar 24, 2026

Uh oh!

JamesNK commented Mar 24, 2026

Uh oh!

JamesNK commented Mar 24, 2026

Uh oh!

JamesNK Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

JamesNK Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

JamesNK Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

JamesNK Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

JamesNK Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

JamesNK commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sebastienros commented Mar 24, 2026 •

edited

Loading

github-actions bot commented Mar 24, 2026 •

edited

Loading

JamesNK commented Mar 24, 2026 •

edited

Loading