Remove obsolete ATS export shims - #16624
Conversation
Remove obsolete internal compatibility shims from the ATS export surface so generated polyglot SDKs only expose the unified methods. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR removes obsolete ATS/polyglot compatibility shims (environment-variable helpers and a YARP route shim) so generated SDKs expose the unified withEnvironment(...) and addRoute(...) APIs instead of deprecated aliases.
Changes:
- Removed internal
AspireExportshims for legacywithEnvironment*exports and the YARPaddRouteClustershim. - Updated capabilities baselines and refreshed generated SDK snapshots across TypeScript, Python, Java, Rust, and Go.
- Removed a TypeScript generator test that asserted deprecated JSDoc generation for the obsolete exports.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/Aspire.Hosting.CodeGeneration.TypeScript.Tests/Snapshots/TwoPassScanningGeneratedAspire.verified.ts | Snapshot updated to remove generated withEnvironment* shim methods and RPCs. |
| tests/Aspire.Hosting.CodeGeneration.TypeScript.Tests/Snapshots/HostingContainerResourceCapabilities.verified.txt | Capabilities snapshot updated to remove withEnvironment* shim capability entries. |
| tests/Aspire.Hosting.CodeGeneration.TypeScript.Tests/AtsTypeScriptCodeGeneratorTests.cs | Removed test asserting deprecated JSDoc for obsolete exports. |
| tests/Aspire.Hosting.CodeGeneration.Rust.Tests/Snapshots/TwoPassScanningGeneratedAspire.verified.rs | Snapshot updated to remove generated with_environment_* shim methods. |
| tests/Aspire.Hosting.CodeGeneration.Python.Tests/Snapshots/TwoPassScanningGeneratedAspire.verified.py | Snapshot updated to remove shim abstract methods/kwargs and implementations. |
| tests/Aspire.Hosting.CodeGeneration.Java.Tests/Snapshots/TwoPassScanningGeneratedAspire.verified.java | Snapshot updated to remove shim methods (and helper overload) for withEnvironment*. |
| tests/Aspire.Hosting.CodeGeneration.Go.Tests/Snapshots/TwoPassScanningGeneratedAspire.verified.go | Snapshot updated to remove shim methods for WithEnvironment*. |
| src/Aspire.Hosting/ResourceBuilderExtensions.cs | Removed obsolete ATS-only exported shim extension methods for environment variable setting. |
| src/Aspire.Hosting/api/Aspire.Hosting.Capabilities.txt | Capabilities baseline updated to remove obsolete withEnvironment* capabilities. |
| src/Aspire.Hosting.Yarp/ConfigurationBuilder/IYarpConfigurationBuilder.cs | Removed obsolete exported shim AddRouteCluster. |
| src/Aspire.Hosting.SqlServer/api/Aspire.Hosting.SqlServer.ats.txt | ATS capabilities baseline updated to drop obsolete withEnvironment* capability entries. |
| src/Aspire.Hosting.Azure/AzureBicepResourceExtensions.cs | Removed obsolete ATS-only exported shim methods for Bicep output / Key Vault secret env var helpers. |
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 16624Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 16624" |
|
/backport to release/13.3 |
|
Started backporting to |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
🎬 CLI E2E Test Recordings — 76 recordings uploaded (commit View all recordings
📹 Recordings uploaded automatically from CI run #25194981797 |
|
No documentation PR is required for this change. This PR removes obsolete internal ATS export shims (backward compatibility aliases for polyglot SDK generation) in favor of the already-shipped unified
|
* Remove obsolete ATS export shims Remove obsolete internal compatibility shims from the ATS export surface so generated polyglot SDKs only expose the unified methods. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update Azure deployment diagnostics snapshot Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Description
The ATS surface had several obsolete compatibility shims that continued to generate extra polyglot SDK methods even after the unified
withEnvironmentandaddRouteexports were available. This removes those obsolete internal exports so generated SDKs expose the unified methods instead of deprecated aliases.This deletes the obsolete environment and YARP shim methods, updates the capability text baselines, and refreshes generated snapshots across TypeScript, Python, Java, Rust, and Go.
Reported during 13.3 validation as confusing
Checklist
<remarks />and<code />elements on your triple slash comments?aspire.devissue: