Repository navigation
Stabilize compute endpoint mapping contracts - #22167
Maddy Montaquila (maddymontaquila) merged 2 commits into
Conversation
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 22167Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 22167" |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for the host-address and endpoint-property mapping API stabilization.
No open issues 🎉
What changed in this PR
This PR stabilizes Aspire’s compute-environment host-address and endpoint-property mapping contracts without changing signatures or runtime behavior. It does not add endpoint support to providers that lack it or stabilize Kubernetes persistent-volume APIs.
Changes:
- Remove experimental markers from the interface members and marked provider implementations.
- Remove obsolete endpoint-related diagnostic suppressions from consumers and existing tests.
- Clarify optional mapping capabilities and document the remaining volume-specific scope of
ASPIRECOMPUTE002.
| File | Description |
|---|---|
tests/Aspire.Hosting.Tests/ComputeEnvironmentValidationTests.cs |
Remove suppressions from default-contract tests and their implementation. |
tests/Aspire.Hosting.Tests/ComputeEnvironmentEndpointResolverTests.cs |
Remove suppression from the test host mapper. |
tests/Aspire.Hosting.RemoteHost.Tests/KubernetesManifestTests.cs |
Remove obsolete compute diagnostic suppression. |
tests/Aspire.Hosting.Radius.Tests/RadiusEnvironmentResourceTests.cs |
Remove suppression from Radius environment tests. |
tests/Aspire.Hosting.Radius.Tests/Publishing/BackingResourceContractTests.cs |
Remove suppression from backing-resource contract tests. |
tests/Aspire.Hosting.Kubernetes.Tests/KubernetesDeployTests.cs |
Remove obsolete compute diagnostic suppression. |
tests/Aspire.Hosting.Foundry.Tests/ProjectResourceTests.cs |
Remove suppression from browser-origin mapping tests. |
tests/Aspire.Hosting.Docker.Tests/DockerComposeTests.cs |
Remove suppression from Compose tests. |
tests/Aspire.Hosting.Azure.Tests/AzureFrontDoorTests.cs |
Remove obsolete endpoint suppression. |
tests/Aspire.Hosting.Azure.Tests/AzureEnvironmentResourceTests.cs |
Remove suppression from unsupported browser-origin tests. |
tests/Aspire.Hosting.Azure.Tests/AzureContainerAppsTests.cs |
Remove endpoint-mapping suppressions. |
tests/Aspire.Hosting.Azure.Tests/AzureContainerAppExpressEndpointTests.cs |
Remove obsolete compute diagnostic suppression. |
tests/Aspire.Hosting.Azure.Tests/AzureAppServiceTests.cs |
Remove endpoint-mapping suppressions. |
tests/Aspire.Hosting.Azure.Tests/AzureApiManagementTests.cs |
Remove obsolete compute diagnostic suppression. |
tests/Aspire.Hosting.Azure.EntraId.Tests/EntraIdProvisioningTests.cs |
Remove suppression around the test compute environment. |
src/Shared/ComputeEnvironmentEndpointResolver.cs |
Remove suppression around endpoint-property resolution. |
src/Aspire.Hosting/ApplicationModel/IComputeEnvironmentResource.cs |
Stabilize both mapping members and clarify default behavior. |
src/Aspire.Hosting.Radius/RadiusEnvironmentResource.cs |
Stabilize host mapping and remove obsolete suppression/import. |
src/Aspire.Hosting.Radius/Publishing/RadiusInfrastructureBuilder.cs |
Remove publisher endpoint-mapping suppression. |
src/Aspire.Hosting.Kubernetes/KubernetesEnvironmentResource.cs |
Stabilize host mapping while retaining volume suppression. |
src/Aspire.Hosting.Foundry/HostedAgent/AzureHostedAgentResource.cs |
Remove suppression around deployed endpoint resolution. |
src/Aspire.Hosting.Docker/DockerComposeEnvironmentResource.cs |
Stabilize Compose host mapping. |
src/Aspire.Hosting.Azure.Sandboxes/AzureSandboxGroupResource.cs |
Stabilize both Sandbox mapping implementations. |
src/Aspire.Hosting.Azure.Sandboxes/AzureSandboxesExtensions.cs |
Remove obsolete compute diagnostic suppression. |
src/Aspire.Hosting.Azure.Sandboxes/AzureSandboxContainerDeployment.cs |
Remove obsolete compute diagnostic suppression. |
src/Aspire.Hosting.Azure.FrontDoor/AzureFrontDoorExtensions.cs |
Remove host-mapping suppression. |
src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs |
Remove suppressions from redirect-URI endpoint resolution. |
src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs |
Stabilize both App Service mapping implementations. |
src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs |
Stabilize both Container Apps mapping implementations. |
src/Aspire.Hosting.Azure.ApiManagement/Aspire.Hosting.Azure.ApiManagement.csproj |
Remove project-wide ASPIRECOMPUTE002 suppression. |
docs/list-of-diagnostics.md |
Document the diagnostic’s remaining persistent-volume scope. |
Review effort: Balanced
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Keep Kubernetes and AKS persistent-volume contracts experimental under ASPIRECOMPUTE002, preserve endpoint behavior, and remove obsolete endpoint suppressions. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
e95230b to
5a11c1f
Compare
This comment has been minimized.
This comment has been minimized.
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
Drop both obsolete Radius publisher suppressions: the release branch graduated connection-string metadata, and this PR graduates compute endpoint mapping. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
bcfa151
into
release/17.0
Tests selector52 / 101 PR test projects · 4 PR jobs, from 30 changed files. Selected PR test projects (52 / 101)
Selected PR jobs (4)
How these were chosen — grouped by what changed
🔧 show 37
🔧 📦 affected project 🔧 🔧 🔧 🧪 📦 affected project 🔧 🔧 🔧 🔧 🔧 🔧 🔧 🔧 🔧 🔧 🧪 🧪 🧪 🧪 🧪 🧪 🧪 🧪 🧪 🧪 🧪 🧪 🧪 🧪 Job reasons
Selection computed for commit |
|
Pull request created: #2170
|
|
📝 Documentation has been drafted in microsoft/aspire.dev#2170 targeting Updated the ASPIRECOMPUTE002 diagnostic page and the diagnostics overview table to reflect that the diagnostic now covers only Kubernetes persistent volume APIs, and that GetHostAddressExpression/GetEndpointPropertyExpression are stable. Triggered signals: diagnostic_documentation_changed (docs/list-of-diagnostics.md), pr_body_has_user_facing_section, pr_body_has_deprecation_marker, pr_body_has_cli_flag_mention. Note This draft PR needs human review before merging. |
Description
Consumers and compute-environment implementers can use
IComputeEnvironmentResource.GetHostAddressExpressionandGetEndpointPropertyExpressionwithout opting intoASPIRECOMPUTE002. This graduates the endpoint-mapping contracts only, not every API sharing that diagnostic or the production-readiness of each provider.ASPIRECOMPUTE002onKubernetesPersistentVolumeExtensions,KubernetesPersistentVolumeResource,PersistentVolumeAccessMode, andAzureKubernetesPersistentVolumeExtensions. Volume lifecycle, storage/access-mode semantics, and their necessary suppressions remain experimental and unchanged. Keeping the existing diagnostic avoids requiring volume consumers to migrate suppressions.api/*.csbaselines are untouched.Contract review
Host addresses are not full URLs. The default endpoint-property mapper composes the existing host, scheme, and port expressions; provider overrides retain their platform-specific mappings and validation. Browser-origin resolution remains a separate capability: unsupported environments still reject it rather than inferring a public origin from a host.
The default
GetHostAddressExpressionstill throwsNotImplementedException. This preserves compatibility with environments that implement the interface without providing host mapping; the XML documentation now makes that optional capability and the host-dependent property requirement explicit. In particular,AzureKubernetesEnvironmentResourcedoes not provide these mappings and still inherits the defaults. This change does not add endpoint support to that provider or alter any runtime method body.User-facing usage
The existing endpoint-mapping calls no longer need an
ASPIRECOMPUTE002suppression:Original API contributors
Introduction history and GitHub identities were checked, rather than attributing the APIs to their latest editors or merge committers. These mentions are for context, not claims of approval or reviewer assignments:
No attribution uncertainty remains for these verified introductions.
Validation on release/17.0
Only the stabilization commit was replayed from its verified original-main fork point (
793dfe6e254fe050af24cb7bcfba214066dcaab8) ontoorigin/release/17.0at9a97ab889bfb731de74ead0280be279ffdd000bf. The replay had no conflicts and required no release-specific adaptations;git range-diffconfirms the original patch is unchanged. The PR contains one intended commit affecting 31 files, without unrelated main history.Existing behavioral tests compile without the removed endpoint suppressions. No signatures or runtime behavior were changed, so no new test cases were added. The original 141-test main validation is historical; all nine selections below were independently rerun serially on release-based commit
5a11c1fd35a3670d6c2d059bc0ef13bc6f57a88dand passed, totaling 141 tests:Release validation emitted NU1903 advisories for the unchanged
System.Security.Cryptography.Xmldependency during Entra ID restore; the selected tests passed. The earlier RemoteHost shared-build file-lock failure occurred during the original main validation, not this serial release run. No live cloud deployments or full repository suite were run.Fixes # (issue)
Checklist
<remarks />and<code />elements on your triple slash comments?