Add WaitBehavior to WaitForResourceHealthyAsync

[mitchdenny]

Description

Added an overload to the WaitForResourceHealthyAsync method that allows us to specify the wait behavior if the resource fails to start. When set to StopOnDependencyFailure if the resource enters a failed to start state it will throw an exception.

Fixes #7601

Checklist

• Is this feature complete?
  • Yes. Ready to ship.
  • No. Follow-up changes expected.
• Are you including unit tests for the changes and scenario tests if relevant?
  • Yes
  • No
• Did you add public API?
  • Yes
    • If yes, did you have an API Review for it?
      • Yes
      • No
    • Did you add <remarks /> and <code /> elements on your triple slash comments?
      • Yes
      • No
  • No
• Does the change make any security assumptions or guarantees?
  • Yes
    • If yes, have you done a threat model and had a security review?
      • Yes
      • No
  • No
• Does the change require an update in our Aspire docs?
  • Yes
    • Is this introducing a breaking change?
      • Yes
        • Link to aspire-docs issue (please use this breaking-change template):
      • No
        • Link to aspire-docs issue (please use this doc-idea template):
  • No

[Copilot]

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

[mitchdenny]

@davidfowl @eerhardt this fixes #7601 however I am wondering if there is an API design issue here. We are adding an overload to WaitForResourceHealthyAsync to take a WaitBehavior enumeration but the value of StopOnDependencyFailure isn't exactly accurate since we aren't interrogating the dependency state in this case - we are just relying on the resources state (which may go into a failure state because its dependency failed).

I'm wondering whether we need either a new enumeration here or a new enumeration value. A new enumeration value would be a bit strange because then we would have enumeration values that only apply in certain contexts which is why I lead to a new enumeration - but WaitBehavior would be a good name for it.

Arguably we could rename StopOnDependencyFailure to just StopOnFailure (breaking change obviously).

[Copilot]

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

[davidfowl]

See main...davidfowl/wait-for-healthy

[mitchdenny]

Merging this now we can come back with the enum rename since its a breaking change (this would just be one more place where it breaks but this is a less frequent usage scenario I think).

[mitchdenny]

/backport to release/9.1

[github-actions]

Started backporting to release/9.1: https://github.com/dotnet/aspire/actions/runs/13401316958

[davidfowl]

@mitchdenny can you look at my branch and apply the delta?? I think this PR is incomplete

[mitchdenny]

Ok

[afscrome]

Merging this now we can come back with the enum rename since its a breaking change (this would just be one more place where it breaks but this is a less frequent usage scenario I think).

Isn't the WaitBehaviour enum new in 9.1, in which case we have a brief window to rename it without being a breaking change.

Edit: I see this got renamed in #7668