Skip to content

Graduate HTTP probe APIs to stable - #20813

Merged
Mitch Denny (mitchdenny) merged 1 commit into
mainfrom
mitchdenny-stable-probe-apis
Oct 8, 2026
Merged

Mitch Denny (mitchdenny) merged 1 commit into
mainfrom
mitchdenny-stable-probe-apis

Conversation

@mitchdenny

Copy link
Copy Markdown
Member

Description

Graduates the existing HTTP probe APIs to stable so consumers no longer need to suppress ASPIREPROBES001. This is an attribute-only graduation, not API removal or redesign.

Removes all eight actual source attributes: both public WithHttpProbe overloads, internal WithHttpProbeExport, private WithProbe, ProbeType, ProbeAnnotation, EndpointProbeAnnotation, and IResourceWithProbes. Removes all explicit suppressions of this diagnostic from hosting resources, Kubernetes/ACA/App Service/Front Door consumers, and tests, preserving other diagnostics.

All signatures, defaults, overloads, runtime semantics, health-check behavior, ATS exports, and deployment output are preserved. The regenerated TypeScript snapshot changes only by removing 27 @experimental documentation tags from withHttpProbe; Go, Java, Python, and Rust snapshots remain unchanged.

No probe-specific suppressions remain in tracked non-baseline files. There were no such playground suppressions or Markdown descriptions explicitly labeling these APIs experimental in this checkout. Generated api/*.cs baselines, other experimental families, package/version flags, and dependency/configuration files are untouched. No additional dependencies are required.

User-facing usage

Existing usage now compiles without an ASPIREPROBES001 suppression:

var service = builder.AddProject<Projects.MyService>("service")
    .WithHttpProbe(ProbeType.Liveness, "/health");

Validation

All commands ran from the repository root. Test commands built their affected projects; none used --no-build. Quarantined and outerloop tests were excluded.

Exact command Result
git fetch origin main && git merge --ff-only origin/main Passed; branch started independently from current main, with no sibling/creator commits.
./restore.sh Passed, zero warnings/errors.
MSBUILDTERMINALLOGGER=false dotnet test --project tests/Aspire.Hosting.Tests/Aspire.Hosting.Tests.csproj --no-launch-profile -- --filter-class '*.ResourceWithProbeTests' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true' Passed: 3 tests.
MSBUILDTERMINALLOGGER=false dotnet test --project tests/Aspire.Hosting.Azure.Tests/Aspire.Hosting.Azure.Tests.csproj --no-launch-profile -- --filter-method '*.ResourceWithProbes*' --filter-method '*.HealthProbePathUsesResourceProbeAnnotation' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true' Passed: 5 tests; ACA/App Service generated Bicep snapshots unchanged, Front Door probe path preserved.
MSBUILDTERMINALLOGGER=false dotnet test --project tests/Aspire.Hosting.Kubernetes.Tests/Aspire.Hosting.Kubernetes.Tests.csproj --no-launch-profile -- --filter-method '*.PublishAsync_ResourceWithProbes' --filter-method '*.KubernetesProbeUsesContainerTargetPortNotServicePort' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true' Passed: 2 tests; generated deployment snapshots and target-port semantics unchanged.
MSBUILDTERMINALLOGGER=false dotnet test --project tests/Aspire.Hosting.CodeGeneration.TypeScript.Tests/Aspire.Hosting.CodeGeneration.TypeScript.Tests.csproj --no-launch-profile -- --filter-method '*.TwoPassScanning_GeneratesWithEnvironmentOnTestRedisBuilder' --filter-method '*.Scanner_HostingAssembly_ContainerResourceCapabilities' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true' Initial run: 1 passed, 1 expected snapshot failure; resolved by reviewing the regenerated metadata-only snapshot and rerunning below.
MSBUILDTERMINALLOGGER=false dotnet test --project tests/Aspire.Hosting.CodeGeneration.TypeScript.Tests/Aspire.Hosting.CodeGeneration.TypeScript.Tests.csproj --no-launch-profile -- --filter-class '*.AtsTypeScriptCodeGeneratorTests' --filter-class '*.TypeScriptApiExportTests' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true' Passed: 119 tests.
MSBUILDTERMINALLOGGER=false dotnet test --project tests/Aspire.Hosting.CodeGeneration.Go.Tests/Aspire.Hosting.CodeGeneration.Go.Tests.csproj --no-launch-profile -- --filter-method '*.TwoPassScanning_GeneratesWithEnvironmentOnTestRedisBuilder' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true' Passed: 1 test; snapshot unchanged.
MSBUILDTERMINALLOGGER=false dotnet test --project tests/Aspire.Hosting.CodeGeneration.Java.Tests/Aspire.Hosting.CodeGeneration.Java.Tests.csproj --no-launch-profile -- --filter-method '*.TwoPassScanning_GeneratesWithEnvironmentOnTestRedisBuilder' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true' Passed: 1 test; snapshot unchanged.
MSBUILDTERMINALLOGGER=false dotnet test --project tests/Aspire.Hosting.CodeGeneration.Python.Tests/Aspire.Hosting.CodeGeneration.Python.Tests.csproj --no-launch-profile -- --filter-method '*.TwoPassScanning_GeneratesWithEnvironmentOnTestRedisBuilder' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true' Passed: 1 test; snapshot unchanged.
MSBUILDTERMINALLOGGER=false dotnet test --project tests/Aspire.Hosting.CodeGeneration.Rust.Tests/Aspire.Hosting.CodeGeneration.Rust.Tests.csproj --no-launch-profile -- --filter-method '*.TwoPassScanning_GeneratesWithEnvironmentOnTestRedisBuilder' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true' Passed: 1 test; snapshot unchanged.
git diff --check Passed.
git grep -n ASPIREPROBES001 -- ':!**/api/*.cs' No matches (expected grep exit code 1); all source attributes/suppressions removed.

The initial focused TypeScript run passed the capability scan and failed the generated snapshot as expected when the experimental tags disappeared. The regenerated snapshot was reviewed: its only changes are those 27 documentation-tag deletions. The subsequent 119-test run passed.

Limitations: no full-solution build, full repository suite, native AOT build, live cloud deployment, or deployed polyglot execution was run. Focused test builds and generated deployment/codegen output were validated locally.

Fixes # (issue)

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

Remove ASPIREPROBES001 attributes and redundant consumer suppressions without changing signatures or probe behavior. Refresh only experimental documentation metadata in the TypeScript codegen snapshot.

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

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

🚀 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 -- 20813

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 20813"

@github-actions github-actions Bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Oct 8, 2026
@aspire-repo-bot
aspire-repo-bot Bot requested a balanced review from Copilot October 8, 2026 05:36
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

Tests selector

50 / 98 PR test projects · 4 PR jobs, from 17 changed files.

Selected PR test projects (50 / 98)

Aspire.Cli.EndToEnd.Tests, Aspire.Hosting.Analyzers.Tests, Aspire.Hosting.Azure.Kubernetes.Tests, Aspire.Hosting.Azure.Kusto.Tests, Aspire.Hosting.Azure.Provisioning.Tests, Aspire.Hosting.Azure.Tests, Aspire.Hosting.Blazor.Tests, Aspire.Hosting.Browsers.Tests, Aspire.Hosting.CodeGeneration.Go.Tests, Aspire.Hosting.CodeGeneration.Java.Tests, Aspire.Hosting.CodeGeneration.Python.Tests, Aspire.Hosting.CodeGeneration.Rust.Tests, Aspire.Hosting.CodeGeneration.TypeScript.Tests, Aspire.Hosting.Containers.Tests, Aspire.Hosting.DevTunnels.Tests, Aspire.Hosting.Docker.Tests, Aspire.Hosting.Dotnet.Tests, Aspire.Hosting.DotnetTool.Tests, Aspire.Hosting.EntityFrameworkCore.Tests, Aspire.Hosting.Foundry.Tests, Aspire.Hosting.Garnet.Tests, Aspire.Hosting.Go.Tests, Aspire.Hosting.Java.Tests, Aspire.Hosting.JavaScript.Tests, Aspire.Hosting.Kafka.Tests, Aspire.Hosting.Keycloak.Tests, Aspire.Hosting.Kubernetes.Tests, Aspire.Hosting.Maui.Tests, Aspire.Hosting.Milvus.Tests, Aspire.Hosting.MongoDB.Tests, Aspire.Hosting.MySql.Tests, Aspire.Hosting.Nats.Tests, Aspire.Hosting.OpenAI.Tests, Aspire.Hosting.Oracle.Tests, Aspire.Hosting.Orleans.Tests, Aspire.Hosting.PostgreSQL.Tests, Aspire.Hosting.Python.Tests, Aspire.Hosting.Qdrant.Tests, Aspire.Hosting.RabbitMQ.Tests, Aspire.Hosting.Radius.Tests, Aspire.Hosting.Redis.Tests, Aspire.Hosting.RemoteHost.Tests, Aspire.Hosting.Rust.Tests, Aspire.Hosting.Seq.Tests, Aspire.Hosting.SqlServer.Tests, Aspire.Hosting.Testing.Tests, Aspire.Hosting.Tests, Aspire.Hosting.Valkey.Tests, Aspire.Hosting.Yarp.Tests, Aspire.Playground.Tests

Selected PR jobs (4)

cli-starter-validation, extension-e2e, polyglot, typescript-api-compat


How these were chosen — grouped by what changed

⚠️ 40 of the 50 selected test projects come from a single change — src/Aspire.Hosting/ApplicationModel/ContainerResource.cs.

🔧 src/Aspire.Hosting/ApplicationModel/ContainerResource.cs (changed source)
→ 40 via the project graph

show 40

Aspire.Hosting.Analyzers.Tests (2 hops), Aspire.Hosting.Azure.Kusto.Tests (2 hops), Aspire.Hosting.Azure.Provisioning.Tests (3 hops), Aspire.Hosting.Browsers.Tests (2 hops), Aspire.Hosting.CodeGeneration.Go.Tests, Aspire.Hosting.CodeGeneration.Java.Tests, Aspire.Hosting.CodeGeneration.Python.Tests, Aspire.Hosting.CodeGeneration.Rust.Tests, Aspire.Hosting.Containers.Tests (2 hops), Aspire.Hosting.DevTunnels.Tests (2 hops), Aspire.Hosting.DotnetTool.Tests (2 hops), Aspire.Hosting.EntityFrameworkCore.Tests (2 hops), Aspire.Hosting.Foundry.Tests (2 hops), Aspire.Hosting.Garnet.Tests (2 hops), Aspire.Hosting.Go.Tests (2 hops), Aspire.Hosting.Java.Tests (2 hops), Aspire.Hosting.JavaScript.Tests (2 hops), Aspire.Hosting.Kafka.Tests (2 hops), Aspire.Hosting.Keycloak.Tests (2 hops), Aspire.Hosting.Maui.Tests, Aspire.Hosting.Milvus.Tests (2 hops), Aspire.Hosting.MongoDB.Tests (2 hops), Aspire.Hosting.MySql.Tests (2 hops), Aspire.Hosting.Nats.Tests (2 hops), Aspire.Hosting.OpenAI.Tests (2 hops), Aspire.Hosting.Oracle.Tests (2 hops), Aspire.Hosting.Orleans.Tests (2 hops), Aspire.Hosting.PostgreSQL.Tests (2 hops), Aspire.Hosting.Python.Tests (2 hops), Aspire.Hosting.Qdrant.Tests (2 hops), Aspire.Hosting.RabbitMQ.Tests (2 hops), Aspire.Hosting.Redis.Tests (2 hops), Aspire.Hosting.RemoteHost.Tests, Aspire.Hosting.Rust.Tests (2 hops), Aspire.Hosting.Seq.Tests (2 hops), Aspire.Hosting.SqlServer.Tests (2 hops), Aspire.Hosting.Testing.Tests (2 hops), Aspire.Hosting.Valkey.Tests (2 hops), Aspire.Hosting.Yarp.Tests (2 hops), Aspire.Playground.Tests

🧪 tests/Aspire.Hosting.Tests/ResourceWithProbeTests.cs (changed test)
→ 1 directly: Aspire.Hosting.Tests
→ 3 via the project graph: Aspire.Hosting.Blazor.Tests, Aspire.Hosting.Dotnet.Tests, Aspire.Hosting.Radius.Tests

🔧 src/Aspire.Hosting.Kubernetes/Extensions/ResourceExtensions.cs (changed source)
→ 1 directly: Aspire.Hosting.Kubernetes.Tests
→ 1 via the project graph: Aspire.Hosting.Docker.Tests

🧪 tests/Aspire.Hosting.Azure.Tests/AzureAppServiceTests.cs (changed test)
→ 1 directly: Aspire.Hosting.Azure.Tests
→ 1 via the project graph: Aspire.Hosting.Azure.Kubernetes.Tests

📦 affected project Aspire.Hosting.Kubernetes
→ 1 test: Aspire.Cli.EndToEnd.Tests

🔧 src/Aspire.Hosting.Azure.AppContainers/BaseContainerAppContext.cs (changed source)
→ 1 directly: Aspire.Hosting.Azure.Tests

🔧 src/Aspire.Hosting.Azure.AppService/AzureAppServiceWebsiteContext.cs (changed source)
→ 1 directly: Aspire.Hosting.Azure.Tests

🔧 src/Aspire.Hosting.Azure.FrontDoor/AzureFrontDoorExtensions.cs (changed source)
→ 1 directly: Aspire.Hosting.Azure.Tests

🔧 src/Aspire.Hosting.Kubernetes/KubernetesResource.cs (changed source)
→ 1 directly: Aspire.Hosting.Kubernetes.Tests

🧪 tests/Aspire.Hosting.Azure.Tests/AzureContainerAppsTests.cs (changed test)
→ 1 directly: Aspire.Hosting.Azure.Tests

🧪 tests/Aspire.Hosting.Azure.Tests/AzureFrontDoorTests.cs (changed test)
→ 1 directly: Aspire.Hosting.Azure.Tests

🧪 tests/Aspire.Hosting.CodeGeneration.TypeScript.Tests/Snapshots/TwoPassScanningGeneratedAspire.verified.ts (changed test)
→ 1 directly: Aspire.Hosting.CodeGeneration.TypeScript.Tests

🧪 tests/Aspire.Hosting.Kubernetes.Tests/KubernetesPublisherTests.cs (changed test)
→ 1 directly: Aspire.Hosting.Kubernetes.Tests

Job reasons

Job Triggered by
cli-starter-validation affected project Aspire.Hosting.JavaScript
extension-e2e • src/Aspire.Hosting/ApplicationModel/ContainerResource.cs, src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs, src/Aspire.Hosting/ApplicationModel/IResourceWithProbes.cs, src/Aspire.Hosting/ApplicationModel/ProbeAnnotation.cs, src/Aspire.Hosting/ApplicationModel/ProjectResource.cs, src/Aspire.Hosting/ResourceBuilderExtensions.cs
• affected project Aspire.Hosting
polyglot • affected project Aspire.Hosting.Azure.AppContainers
• affected project Aspire.Hosting.Azure.Provisioning.AppContainers
typescript-api-compat affected project Aspire.Hosting.Azure.AppContainers

Selection computed for commit 06d3d6c.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The stable overloads need a versionable options shape and complete ATS parameter documentation before their contracts are frozen.

2 open findings
What changed in this PR

Graduates HTTP probe APIs from experimental to stable while preserving runtime and deployment behavior.

Changes:

  • Removes ASPIREPROBES001 attributes and suppressions.
  • Updates TypeScript snapshots to remove experimental tags.
  • Retains existing probe deployment coverage.
File Description
tests/​Aspire.Hosting.Tests/​ResourceWithProbeTests.cs Removes probe warning suppression.
tests/​Aspire.Hosting.Kubernetes.Tests/​KubernetesPublisherTests.cs Removes suppressions from Kubernetes tests.
tests/​Aspire.Hosting.CodeGeneration.TypeScript.Tests/​Snapshots/​TwoPassScanningGeneratedAspire.verified.ts Removes generated experimental tags.
tests/​Aspire.Hosting.Azure.Tests/​AzureFrontDoorTests.cs Removes probe suppression.
tests/​Aspire.Hosting.Azure.Tests/​AzureContainerAppsTests.cs Removes probe suppressions.
tests/​Aspire.Hosting.Azure.Tests/​AzureAppServiceTests.cs Removes probe suppression.
src/​Aspire.Hosting/​ResourceBuilderExtensions.cs Stabilizes HTTP probe methods and export.
src/​Aspire.Hosting/​ApplicationModel/​ProjectResource.cs Removes probe suppression.
src/​Aspire.Hosting/​ApplicationModel/​ProbeAnnotation.cs Stabilizes probe model types.
src/​Aspire.Hosting/​ApplicationModel/​IResourceWithProbes.cs Stabilizes the probe marker interface.
src/​Aspire.Hosting/​ApplicationModel/​ExecutableResource.cs Removes probe suppression.
src/​Aspire.Hosting/​ApplicationModel/​ContainerResource.cs Removes probe suppression.
src/​Aspire.Hosting.Kubernetes/​KubernetesResource.cs Removes internal probe suppressions.
src/​Aspire.Hosting.Kubernetes/​Extensions/​ResourceExtensions.cs Removes probe suppression.
src/​Aspire.Hosting.Azure.FrontDoor/​AzureFrontDoorExtensions.cs Removes probe suppression.
src/​Aspire.Hosting.Azure.AppService/​AzureAppServiceWebsiteContext.cs Removes probe suppression.
src/​Aspire.Hosting.Azure.AppContainers/​BaseContainerAppContext.cs Removes probe suppression.

🧠 Review effort: Balanced


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the full diff and surrounding probe consumers at 06d3d6c. No concrete issues found: experimental attributes/suppressions and generated documentation tags are removed without changing runtime logic or ATS signatures. Existing regression coverage and CI inspected (282 successful checks, 16 skipped). Author reports focused tests passed. Local validation: source/diagnostic audit and git diff --check passed; no local builds/tests run.

@mitchdenny
Mitch Denny (mitchdenny) merged commit 26b5ca7 into main Oct 8, 2026
299 checks passed
@microsoft-github-policy-service microsoft-github-policy-service Bot added this to the 17.0 milestone Oct 8, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Pull request created: #1847

Generated by PR Documentation Check · copilot · auto · 81 AIC · ⌖ 10.3 AIC · ⊞ 20.4K

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

📝 Documentation has been drafted in microsoft/aspire.dev#1847 targeting release/17.0.

Updated aspireprobes001.mdx and diagnostics/overview.mdx to reflect that the HTTP probe APIs (WithHttpProbe, ProbeType, ProbeAnnotation, EndpointProbeAnnotation, IResourceWithProbes) graduated from experimental to stable in Aspire 17.0, mirroring the pattern used for the previously-graduated ASPIREACADOMAINS001/ASPIREDOTNETPROJECT001 diagnostics. Triggered signals: pr_body_has_user_facing_section (PR body's "User-facing usage" section shows existing WithHttpProbe calls now compile without suppressing ASPIREPROBES001) and pr_body_has_cli_flag_mention (false-positive match on --no-build/--filter-not-trait in the validation command table, not an actual CLI flag addition — no CLI surface changed). Added a "Graduated in Aspire 17.0" note, updated the warning description/suppression guidance to be historical, and changed the overview table row from "(Experimental) Warning" to "Warning" with updated description.

Note

This draft PR needs human review before merging.

@github-actions github-actions Bot locked and limited conversation to collaborators Nov 8, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants