Skip to content

API Review Feedback#16673

Merged
eerhardt merged 4 commits intomainfrom
eerhardt/api-review-fixes
May 4, 2026
Merged

API Review Feedback#16673
eerhardt merged 4 commits intomainfrom
eerhardt/api-review-fixes

Conversation

@eerhardt
Copy link
Copy Markdown
Member

@eerhardt eerhardt commented May 1, 2026

Addressing feedback from #16602

Rename JS experimental ID, refactor AKS/EF resource APIs

Renames ASPIREEXTENSION001 to ASPIREJAVASCRIPT001 for JavaScript APIs, resources, and tests. Refactors AKS-related code to Aspire.Hosting.Azure.Kubernetes, makes AksSkuTier internal, and defaults AKS SKU tier to Free. Renames EFMigrationResource.ContextTypeName to DbContextTypeName throughout. Adds missing using directives, Experimental attributes, and AspireValue metadata. Updates tests and samples for new names and diagnostics.

Addressing feedback from #16602

Rename JS experimental ID, refactor AKS/EF resource APIs

Renames ASPIREEXTENSION001 to ASPIREJAVASCRIPT001 for JavaScript APIs, resources, and tests. Refactors AKS-related code to Aspire.Hosting.Azure.Kubernetes, makes AksSkuTier internal, and defaults AKS SKU tier to Free. Renames EFMigrationResource.ContextTypeName to DbContextTypeName throughout. Adds missing using directives, Experimental attributes, and AspireValue metadata. Updates tests and samples for new names and diagnostics.
Copilot AI review requested due to automatic review settings May 1, 2026 20:13
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

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

Or

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

@eerhardt
Copy link
Copy Markdown
Member Author

eerhardt commented May 1, 2026

/backport to release/13.3

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

Started backporting to release/13.3 (link to workflow run)

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR addresses prior API review feedback by standardizing experimental diagnostic IDs for JavaScript hosting APIs, refactoring/relocating AKS-related Azure Kubernetes code, and renaming an EF Core migrations resource property for clarity.

Changes:

  • Renames JavaScript experimental diagnostic usage to ASPIREJAVASCRIPT001 across relevant APIs, tests, and samples; adds missing [Experimental] attributes on JavaScript types/methods.
  • Refactors Azure Kubernetes (AKS) code into Aspire.Hosting.Azure.Kubernetes, removes the AKS SKU tier surface area, and hard-codes the provisioned tier to Free.
  • Renames EFMigrationResource.ContextTypeName to DbContextTypeName and updates EF migrations code/tests accordingly (including moving EFMigrationResource to a new namespace).

Reviewed changes

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

Show a summary per file
File Description
tests/Aspire.Hosting.JavaScript.Tests/NodeJsPublicApiTests.cs Updates pragma suppression to the new JavaScript experimental diagnostic ID.
tests/Aspire.Hosting.JavaScript.Tests/AddViteAppTests.cs Updates pragma suppression to ASPIREJAVASCRIPT001 for JavaScript publish-related tests.
tests/Aspire.Hosting.JavaScript.Tests/AddNodeAppTests.cs Adds ASPIREJAVASCRIPT001 suppression alongside existing experimental suppression for debugging-related tests.
tests/Aspire.Hosting.JavaScript.Tests/AddJavaScriptAppTests.cs Updates pragma suppression to ASPIREJAVASCRIPT001.
tests/Aspire.Hosting.EntityFrameworkCore.Tests/EFMigrationConfigurationTests.cs Updates assertions to use DbContextTypeName.
tests/Aspire.Hosting.EntityFrameworkCore.Tests/EFMigrationCommandsTests.cs Updates assertions to use DbContextTypeName.
tests/Aspire.Hosting.EntityFrameworkCore.Tests/AddEFMigrationsTests.cs Updates assertions to use DbContextTypeName.
tests/Aspire.Hosting.Azure.Kubernetes.Tests/AzureKubernetesEnvironmentExtensionsTests.cs Removes assertions tied to the removed SkuTier surface.
src/Aspire.Hosting/Pipelines/WellKnownPipelineSteps.cs Adds missing AspireValue metadata attributes for pipeline step constants.
src/Aspire.Hosting/Dcp/DcpExecutor.cs Removes obsolete ASPIREEXTENSION001 suppression.
src/Aspire.Hosting/Dcp/ContainerCreator.cs Removes obsolete ASPIREEXTENSION001 suppression.
src/Aspire.Hosting.JavaScript/PublishAsStaticWebsiteOptions.cs Marks options type as experimental under ASPIREJAVASCRIPT001.
src/Aspire.Hosting.JavaScript/NextJsAppResource.cs Marks Next.js resource type as experimental under ASPIREJAVASCRIPT001.
src/Aspire.Hosting.JavaScript/JavaScriptHostingExtensions.cs Updates/expands experimental annotations for JavaScript publish APIs and Next.js APIs.
src/Aspire.Hosting.EntityFrameworkCore/EFResourceBuilderExtensions.cs Switches to DbContextTypeName and updates executor calls accordingly.
src/Aspire.Hosting.EntityFrameworkCore/EFMigrationResourceBuilderExtensions.cs Adds the new EF Core namespace import needed after moving EFMigrationResource.
src/Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.cs Renames property to DbContextTypeName and changes the type’s namespace.
src/Aspire.Hosting.Azure.Kubernetes/AzureKubernetesIngressExtensions.cs Updates using to the new Azure Kubernetes namespace.
src/Aspire.Hosting.Azure.Kubernetes/AzureKubernetesEnvironmentResource.cs Moves resource into Aspire.Hosting.Azure.Kubernetes and removes SkuTier property.
src/Aspire.Hosting.Azure.Kubernetes/AzureKubernetesEnvironmentResource.AksPipeline.cs Moves pipeline implementation into Aspire.Hosting.Azure.Kubernetes.
src/Aspire.Hosting.Azure.Kubernetes/AzureKubernetesEnvironmentExtensions.cs Hard-codes AKS managed cluster SKU tier to Free in provisioning.
src/Aspire.Hosting.Azure.Kubernetes/AksSkuTier.cs Makes AksSkuTier internal.
playground/AspireWithNode/AspireWithNode.AppHost/AppHost.cs Removes ASPIREEXTENSION001 suppression from the sample AppHost.
playground/AspireWithJavaScript/AspireJavaScript.AppHost/AppHost.cs Updates sample pragmas to use ASPIREJAVASCRIPT001 for static website publish demo.
Comments suppressed due to low confidence (1)

src/Aspire.Hosting.JavaScript/JavaScriptHostingExtensions.cs:439

  • Marking this private helper method as [Experimental("ASPIREJAVASCRIPT001")] will raise ASPIREJAVASCRIPT001 warnings at its internal call sites (including within this file), and there is no suppression for ASPIREJAVASCRIPT001 here. Since the method is private and not part of the public surface, consider removing the attribute (keep it on the public entry points) or add appropriate local suppression where it’s invoked.
    [Experimental("ASPIREJAVASCRIPT001", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
    private static IResourceBuilder<TResource> PublishAsStaticWebsiteCore<TResource>(
        IResourceBuilder<TResource> builder,
        string? apiPath,
        IResourceBuilder<IResourceWithServiceDiscovery>? apiTarget,
        PublishAsStaticWebsiteOptions options)

Comment thread src/Aspire.Hosting.JavaScript/JavaScriptHostingExtensions.cs
Comment thread src/Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.cs
@eerhardt
Copy link
Copy Markdown
Member Author

eerhardt commented May 1, 2026

/backport to release/13.3

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

Started backporting to release/13.3 (link to workflow run)

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

Re-running the failed jobs in the CI workflow for this pull request because 1 job was identified as retry-safe transient failures in the CI run attempt.
GitHub was asked to rerun all failed jobs for that attempt, and the rerun is being tracked in the rerun attempt.
The job links below point to the failed attempt jobs that matched the retry-safe transient failure rules.

Adding [AspireValue("WellKnownPipelineSteps")] to BeforeStart and
CheckContainerRuntime causes the language code generators to emit them
in the WellKnownPipelineSteps exported value catalog. Update the
TwoPassScanningGeneratedAspire snapshots for Go, Java, Python, Rust, and
TypeScript to include the two new entries.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

Re-running the failed jobs in the CI workflow for this pull request because 3 jobs were identified as retry-safe transient failures in the CI run attempt.
GitHub was asked to rerun all failed jobs for that attempt, and the rerun is being tracked in the rerun attempt.
The job links below point to the failed attempt jobs that matched the retry-safe transient failure rules.

Matched test failure patterns (2 tests)
  • Aspire.Cli.EndToEnd.Tests.PsCommandTests.PsCommandListsRunningAppHost — MCR registry rate limiting (HTTP 403)
  • Aspire.Cli.EndToEnd.Tests.PsCommandTests.PsFormatJsonOutputsOnlyJsonToStdout — MCR registry rate limiting (HTTP 403)

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

🎬 CLI E2E Test Recordings — 76 recordings uploaded (commit 5080e03)

View all recordings
Status Test Recording
AddPackageInteractiveWhileAppHostRunningDetached ▶️ View Recording
AddPackageWhileAppHostRunningDetached ▶️ View Recording
AgentCommands_AllHelpOutputs_AreCorrect ▶️ View Recording
AgentInitCommand_DefaultSelection_InstallsSkillOnly ▶️ View Recording
AgentInitCommand_MigratesDeprecatedConfig ▶️ View Recording
AspireAddPackageVersionToDirectoryPackagesProps ▶️ View Recording
AspireUpdateRemovesAppHostPackageVersionFromDirectoryPackagesProps ▶️ View Recording
Banner_DisplayedOnFirstRun ▶️ View Recording
Banner_DisplayedWithExplicitFlag ▶️ View Recording
Banner_NotDisplayedWithNoLogoFlag ▶️ View Recording
CertificatesClean_RemovesCertificates ▶️ View Recording
CertificatesTrust_WithNoCert_CreatesAndTrustsCertificate ▶️ View Recording
CertificatesTrust_WithUntrustedCert_TrustsCertificate ▶️ View Recording
ConfigSetGet_CreatesNestedJsonFormat ▶️ View Recording
CreateAndRunAspireStarterProject ▶️ View Recording
CreateAndRunAspireStarterProjectWithBundle ▶️ View Recording
CreateAndRunEmptyAppHostProject ▶️ View Recording
CreateAndRunJavaEmptyAppHostProject ▶️ View Recording
CreateAndRunJsReactProject ▶️ View Recording
CreateAndRunPythonReactProject ▶️ View Recording
CreateAndRunTypeScriptEmptyAppHostProject ▶️ View Recording
CreateAndRunTypeScriptStarterProject ▶️ View Recording
CreateJavaAppHostWithViteApp ▶️ View Recording
CreateTypeScriptAppHostWithViteApp_UsesConfiguredToolchain ▶️ View Recording
DashboardRunWithOtelTracesReturnsNoTraces ▶️ View Recording
DeployK8sBasicApiService ▶️ View Recording
DeployK8sWithGarnet ▶️ View Recording
DeployK8sWithMongoDB ▶️ View Recording
DeployK8sWithMySql ▶️ View Recording
DeployK8sWithPostgres ▶️ View Recording
DeployK8sWithRabbitMQ ▶️ View Recording
DeployK8sWithRedis ▶️ View Recording
DeployK8sWithSqlServer ▶️ View Recording
DeployK8sWithValkey ▶️ View Recording
DeployTypeScriptAppToKubernetes ▶️ View Recording
DescribeCommandResolvesReplicaNames ▶️ View Recording
DescribeCommandShowsRunningResources ▶️ View Recording
DetachFormatJsonProducesValidJson ▶️ View Recording
DetachFormatJsonProducesValidJsonWhenRestartingExistingInstance ▶️ View Recording
DoListStepsShowsPipelineSteps ▶️ View Recording
DocsCommand_RendersInteractiveMarkdownFromLocalSource ▶️ View Recording
DoctorCommand_DetectsDeprecatedAgentConfig ▶️ View Recording
DoctorCommand_TypeScriptAppHostReportsMissingConfiguredToolchain ▶️ View Recording
DoctorCommand_WithSslCertDir_ShowsTrusted ▶️ View Recording
DoctorCommand_WithoutSslCertDir_ShowsPartiallyTrusted ▶️ View Recording
GlobalMigration_HandlesCommentsAndTrailingCommas ▶️ View Recording
GlobalMigration_HandlesMalformedLegacyJson ▶️ View Recording
GlobalMigration_PreservesAllValueTypes ▶️ View Recording
GlobalMigration_SkipsWhenNewConfigExists ▶️ View Recording
GlobalSettings_MigratedFromLegacyFormat ▶️ View Recording
InitTypeScriptAppHost_AugmentsExistingViteRepoAtRoot ▶️ View Recording
InteractiveCSharpInitCreatesExpectedFiles ▶️ View Recording
InvalidAppHostPathWithComments_IsHealedOnRun ▶️ View Recording
LatestCliCanStartStableChannelAppHost ▶️ View Recording
LatestCliCanStartStableChannelTypeScriptAppHost ▶️ View Recording
LegacySettingsMigration_AdjustsRelativeAppHostPath ▶️ View Recording
LogsCommandShowsResourceLogs ▶️ View Recording
OtelLogsReturnsStructuredLogsFromStarterAppCore ▶️ View Recording
PsCommandListsRunningAppHost ▶️ View Recording
PsFormatJsonOutputsOnlyJsonToStdout ▶️ View Recording
PublishWithConfigureEnvFileUpdatesEnvOutput ▶️ View Recording
PublishWithDockerComposeServiceCallbackSucceeds ▶️ View Recording
PublishWithoutOutputPathUsesAppHostDirectoryDefault ▶️ View Recording
RestoreGeneratesSdkFiles ▶️ View Recording
RestoreGeneratesSdkFiles_WithConfiguredToolchain ▶️ View Recording
RestoreRefreshesGeneratedSdkAfterAddingIntegration ▶️ View Recording
RestoreSupportsConfigOnlyHelperPackageAndCrossPackageTypes ▶️ View Recording
RunFromParentDirectory_UsesExistingConfigNearAppHost ▶️ View Recording
SecretCrudOnDotNetAppHost ▶️ View Recording
SecretCrudOnTypeScriptAppHost ▶️ View Recording
StagingChannel_ConfigureAndVerifySettings_ThenSwitchChannels ▶️ View Recording
StartAndWaitForTypeScriptSqlServerAppHostWithNativeAssets ▶️ View Recording
StopAllAppHostsFromAppHostDirectory ▶️ View Recording
StopNonInteractiveSingleAppHost ▶️ View Recording
StopWithNoRunningAppHostExitsSuccessfully ▶️ View Recording
UnAwaitedChainsCompileWithAutoResolvePromises ▶️ View Recording

📹 Recordings uploaded automatically from CI run #25235507522

@eerhardt eerhardt merged commit 85532fd into main May 4, 2026
566 of 571 checks passed
@microsoft-github-policy-service microsoft-github-policy-service Bot added this to the 13.4 milestone May 4, 2026
@aspire-repo-bot
Copy link
Copy Markdown
Contributor


Warning

The create_pull_request operation failed: Failed to create both pull request and fallback issue. PR error: Server Error. Issue error: Server Error. The code changes were not applied.

📝 Documentation update drafted

A draft docs PR has been opened on microsoft/aspire.dev to document the ASPIREJAVASCRIPT001 diagnostic introduced by this PR.

Target branch: main (falling back from release/13.4, which does not yet exist on aspire.dev)

Summary of documentation changes:

  • Added a new reference page diagnostics/aspirejavascript001.mdx documenting the warning, the affected APIs (PublishAsStaticWebsite, PublishAsNodeServer, PublishAsNpmScript, AddNextJsApp, DisableBuildValidation), and how to suppress it
  • Updated diagnostics/overview.mdx to include ASPIREJAVASCRIPT001 in the diagnostics table

The draft PR needs human review before merging.

Generated by PR Documentation Check for issue #16673 · ● 1.2M ·

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants