Add WithHttpHealthCheck remarks and Debug.Assert for external services (#10524)#17281
Merged
DamianEdwards merged 2 commits intoMay 20, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds clarity and a guardrail around how WithHttpHealthCheck behaves depending on whether an external service uses a static URI vs. a parameter-resolved URI.
Changes:
- Expanded XML docs to describe health check registration behavior for static URIs vs. URL parameters.
- Added a
Debug.Assertto enforce that eitherUriorUrlParameteris present before registering the health check.
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17281Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17281" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Follow-up on review comments from #10493 for
ExternalServiceResource.WithHttpHealthCheck(#10524).Changes:
<remarks>onWithHttpHealthCheckto document static URLs (AddUrlGroupat configuration time) vs. parameter-based URLs (ParameterUriHealthCheckwithGetValueAsyncon each probe).Debug.Assertthat eitherUriorUrlParameteris set, consistent withAddExternalServiceImpl.Motivation: The async parameter health-check behavior was added in #10493; this PR completes the remaining documentation and debug-assert feedback from that review. No behavioral changes.
Dependencies: None.
Fixes #10524
Checklist