Make IReportingStep and IReportingTask completion idempotent #12602

Copilot · 2025-11-01T22:21:08Z

Make IReportingStep and IReportingTask completion idempotent

Issue Analysis

The error message Cannot complete step '333e03eb-984a-4bc1-8163-627f1206228c' with state 'CompletedWithError'. Only 'InProgress' steps can be completed. indicates that a step cannot be completed when it's already in a non-InProgress state. The issue required making state transitions idempotent.

Requirements (from agent instructions)

✅ Allow valid transitions: InProgress → Completed or CompletedWithError (or CompletedWithWarning)
✅ Make double completion a noop instead of throwing exception
✅ ANY completion attempt on a terminal state is a noop (per feedback from @davidfowl)

Implementation Summary

Core Changes (Updated per @davidfowl feedback)

✅ Modified PipelineActivityReporter.CompleteStepAsync to be fully idempotent:
- If step is already in ANY terminal state, return immediately (noop) - no exceptions
- Simplified logic: just check if state is not InProgress and return if so
✅ Modified PipelineActivityReporter.CompleteTaskAsync to be fully idempotent:
- If task is already in ANY terminal state, return immediately (noop) - no exceptions
- Simplified logic: just check if state is not InProgress and return if so

Test Updates (Updated per @davidfowl feedback)

✅ Updated all tests to verify noop behavior for all terminal state transitions
✅ Added helper methods ClearActivities() and AssertNoActivitiesEmitted() to reduce code duplication
✅ Replaced 13 instances of repeated pattern with helper method calls

Validation Results

✅ All 57 tests in PublishingActivityReporterTests pass

Behavior Changes

Before: Attempting to complete a step/task that was already completed would throw an exception

After (per @davidfowl feedback):

Attempting to complete a step/task when it's already in ANY terminal state is now a complete noop
No exceptions are thrown regardless of which terminal state is being requested
The original state and completion text are retained
This is the simplest and most robust idempotent implementation

Fixes #12601

Original prompt

This section details on the original issue you should resolve

<issue_title>Make state changes on IReportingStep and IReportingTask idempotent</issue_title>
<issue_description>```
(Cannot complete step '333e03eb-984a-4bc1-8163-627f1206228c'
with state 'CompletedWithError'. Only 'InProgress' steps can be completed.) (Step 'build-frontend' failed: Docker build failed with exit code 1.)
<agent_instructions>There are only a few states but we want to make sure that transitions are valid:
- Inprogress to complete or complete with error
- Noop on double completion
- Fail if going from a terminal state (comlete or complete with error) to a non terminal state (that's a coding bug)

</agent_instructions>

## Comments on the Issue (you are @copilot in this section)

<comments>
</comments>

Fixes Make state changes on IReportingStep and IReportingTask idempotent #12601

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: davidfowl <[email protected]>

davidfowl · 2025-11-01T22:48:14Z

@copilot transitioning from terminal state to a different terminal state is fine. Just noop.

Co-authored-by: davidfowl <[email protected]>

Copilot · 2025-11-01T22:56:15Z

@copilot transitioning from terminal state to a different terminal state is fine. Just noop.

Updated in c9582ef. All terminal state transitions are now a noop - the implementation simply returns early if the step/task is already in any terminal state, keeping the original state and completion text.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

aka.ms
- Triggering command: /usr/local/bin/bicep build /tmp/aspireC3HzyJ/env.module.bicep --stdout (dns block)
- Triggering command: /usr/local/bin/bicep build /tmp/aspireRt1h6y/teststorage.module.bicep --stdout (dns block)
- Triggering command: /usr/local/bin/bicep build /tmp/aspireB1SyMe/teststorage.module.bicep --stdout (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

github-actions · 2025-11-01T22:57:56Z

🚀 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/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 12602

Or

Run remotely in PowerShell:

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

Copilot

Pull Request Overview

This PR modifies the PipelineActivityReporter to make task and step completion operations idempotent. Previously, attempting to complete an already-completed task or step would throw an InvalidOperationException. Now, subsequent completion attempts on terminal states are no-ops.

Key Changes

Changed exception-throwing behavior to early returns when tasks/steps are already in terminal states (Completed, CompletedWithWarning, CompletedWithError)
Updated test suite to verify idempotent behavior instead of testing for exceptions
Added comprehensive test coverage for all terminal state transitions

Reviewed Changes

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

File	Description
src/Aspire.Hosting/Pipelines/PipelineActivityReporter.cs	Changed `CompleteStepAsync` and `CompleteTaskAsync` to return early when already in terminal state instead of throwing exceptions
tests/Aspire.Hosting.Tests/Publishing/PipelineActivityReporterTests.cs	Replaced exception-testing tests with idempotency tests and added extensive coverage for terminal state transitions

Copilot · 2025-11-01T23:21:28Z

tests/Aspire.Hosting.Tests/Publishing/PipelineActivityReporterTests.cs

+        await task.CompleteAsync(null, cancellationToken: CancellationToken.None);

+        // Assert - No new activity should be emitted (noop)
+        Assert.False(reporter.ActivityItemUpdated.Reader.TryRead(out _));


[nitpick] The pattern while (reporter.ActivityItemUpdated.Reader.TryRead(out _)) { } followed by Assert.False(reporter.ActivityItemUpdated.Reader.TryRead(out _)) is repeated throughout the new tests. Consider extracting this into a helper method like AssertNoActivitiesEmitted(reporter) to reduce duplication and improve maintainability.

Copilot · 2025-11-01T23:21:28Z

tests/Aspire.Hosting.Tests/Publishing/PipelineActivityReporterTests.cs

-        var exception = await Assert.ThrowsAsync<InvalidOperationException>(
-            () => task.CompleteAsync(null, cancellationToken: CancellationToken.None));
+        // Clear activities
+        while (reporter.ActivityItemUpdated.Reader.TryRead(out _)) { }


[nitpick] The activity clearing pattern while (reporter.ActivityItemUpdated.Reader.TryRead(out _)) { } is repeated 10+ times across the new tests. Consider creating a helper method like ClearActivities(reporter) to improve code maintainability and readability.

@copilot apply changes based on this feedback

Refactored in dea6fa8. Added ClearActivities() and AssertNoActivitiesEmitted() helper methods and replaced all 13 instances of the duplicated patterns.

…ities Co-authored-by: davidfowl <[email protected]>

davidfowl · 2025-11-02T17:54:12Z

/backport to release/13.0

github-actions · 2025-11-02T17:54:19Z

Started backporting to release/13.0: https://github.com/dotnet/aspire/actions/runs/19015985829

Initial plan

063f829

Copilot AI assigned Copilot and davidfowl Nov 1, 2025

Copilot started work on behalf of davidfowl November 1, 2025 22:21 View session

Make state changes on IReportingStep and IReportingTask idempotent

99a967f

Co-authored-by: davidfowl <[email protected]>

Copilot AI changed the title ~~[WIP] Make state changes on IReportingStep and IReportingTask idempotent~~ Make IReportingStep and IReportingTask completion idempotent Nov 1, 2025

Copilot finished work on behalf of davidfowl November 1, 2025 22:42

Copilot AI requested a review from davidfowl November 1, 2025 22:42

Copilot started work on behalf of davidfowl November 1, 2025 22:48 View session

Make ALL terminal state transitions idempotent (noop)

c9582ef

Co-authored-by: davidfowl <[email protected]>

Copilot finished work on behalf of davidfowl November 1, 2025 22:57

davidfowl marked this pull request as ready for review November 1, 2025 23:11

davidfowl requested a review from mitchdenny as a code owner November 1, 2025 23:11

Copilot AI review requested due to automatic review settings November 1, 2025 23:11

Copilot AI reviewed Nov 1, 2025

View reviewed changes

Copilot started work on behalf of davidfowl November 2, 2025 03:03 View session

Extract helper methods for clearing activities and asserting no activ…

dea6fa8

…ities Co-authored-by: davidfowl <[email protected]>

Copilot finished work on behalf of davidfowl November 2, 2025 03:13

davidfowl requested a review from captainsafia November 2, 2025 05:31

captainsafia approved these changes Nov 2, 2025

View reviewed changes

davidfowl merged commit ba652c4 into main Nov 2, 2025
300 of 302 checks passed

davidfowl deleted the copilot/make-state-changes-idempotent branch November 2, 2025 17:53

dotnet-policy-service bot added this to the 13.1 milestone Nov 2, 2025

github-actions bot mentioned this pull request Nov 2, 2025

[release/13.0] Make IReportingStep and IReportingTask completion idempotent #12613

Merged

github-actions bot locked and limited conversation to collaborators Dec 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Make IReportingStep and IReportingTask completion idempotent #12602

Make IReportingStep and IReportingTask completion idempotent #12602

Uh oh!

Copilot AI commented Nov 1, 2025 •

edited

Loading

Uh oh!

davidfowl commented Nov 1, 2025

Uh oh!

Copilot AI commented Nov 1, 2025 •

edited

Loading

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

github-actions bot commented Nov 1, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 1, 2025

Uh oh!

Copilot AI Nov 1, 2025

Uh oh!

davidfowl Nov 2, 2025

Uh oh!

Copilot AI Nov 2, 2025

Uh oh!

Uh oh!

davidfowl commented Nov 2, 2025

Uh oh!

github-actions bot commented Nov 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Make IReportingStep and IReportingTask completion idempotent #12602

Make IReportingStep and IReportingTask completion idempotent #12602

Uh oh!

Conversation

Copilot AI commented Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue Analysis

Requirements (from agent instructions)

Implementation Summary

Core Changes (Updated per @davidfowl feedback)

Test Updates (Updated per @davidfowl feedback)

Validation Results

Behavior Changes

Uh oh!

davidfowl commented Nov 1, 2025

Uh oh!

Copilot AI commented Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

github-actions bot commented Nov 1, 2025 • 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

Key Changes

Reviewed Changes

Uh oh!

Copilot AI Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

davidfowl Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

davidfowl commented Nov 2, 2025

Uh oh!

github-actions bot commented Nov 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Nov 1, 2025 •

edited

Loading

Copilot AI commented Nov 1, 2025 •

edited

Loading

github-actions bot commented Nov 1, 2025 •

edited

Loading