Repository navigation
Graduate HTTP probe APIs to stable - #20813
Conversation
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>
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 20813Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 20813" |
Tests selector50 / 98 PR test projects · 4 PR jobs, from 17 changed files. Selected PR test projects (50 / 98)
Selected PR jobs (4)
How these were chosen — grouped by what changed
🔧 show 40
🧪 🔧 🧪 📦 affected project 🔧 🔧 🔧 🔧 🧪 🧪 🧪 🧪 Job reasons
Selection computed for commit |
There was a problem hiding this comment.
🟡 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
ASPIREPROBES001attributes 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.
James Newton-King (JamesNK)
left a comment
There was a problem hiding this comment.
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.
|
Pull request created: #1847
|
|
📝 Documentation has been drafted in microsoft/aspire.dev#1847 targeting Updated Note This draft PR needs human review before merging. |


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
WithHttpProbeoverloads, internalWithHttpProbeExport, privateWithProbe,ProbeType,ProbeAnnotation,EndpointProbeAnnotation, andIResourceWithProbes. 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
@experimentaldocumentation tags fromwithHttpProbe; 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/*.csbaselines, 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
ASPIREPROBES001suppression:Validation
All commands ran from the repository root. Test commands built their affected projects; none used
--no-build. Quarantined and outerloop tests were excluded.git fetch origin main && git merge --ff-only origin/mainmain, with no sibling/creator commits../restore.shMSBUILDTERMINALLOGGER=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'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'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'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'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'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'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'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'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'git diff --checkgit grep -n ASPIREPROBES001 -- ':!**/api/*.cs'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
<remarks />and<code />elements on your triple slash comments?