Fix WithReference to only use IResourceWithEndpoints

[Falco20019]

Description

This allows to use ContainerResource with WithReference. Currently the interface enforces IResourceWithServiceDiscovery while internally only using/needing IResourceWithEndpoints. For backwards compatibility I will leave the original ones although redundant.

Fixes #10286

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
    • Link to aspire-docs issue (consider using one of the following templates):
      • New (or update) doc-idea template
      • New breaking-change template
      • New diagnostic template
  • No

[github-actions]

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

Or

• Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 14254"

[davidfowl]

Breaking change no?

[Falco20019]

As the other interface inherits it, I wouldn't think so. I can't see the unit tests here in GitHub Actions right now and won't be near a PC before Monday. If they still work, it shouldn't be breaking.

[Falco20019]

Breaking change no?

Ok, now I understand what you meant. It's not clashing with IResourceWithServiceDiscovery but with IResourceWithConnectionString. I will rename it to WithEndpoints to avoid issues but still give users some way to use it for simple cases.

[Falco20019]

I sadly don't get it to compile locally on macOS with Docker Desktop following https://github.com/dotnet/aspire/blob/main/docs/machine-requirements.md

Neither through DevContainers nor natively as protoc always gives an error 139. So have to rely on the CI to see if it's working now.

I think offering WithEndpoints should be a sufficient workaround until the next breaking change, but I would love to have WithReference be adjusted to only use IResourceWithEndpoints and have the check to offer the ReferenceEnvironmentInjectionFlags.ServiceDiscovery done by pattern matching against IResourceWithServiceDiscovery (as already done). I therefore prepared it in a way, that allows for adjusting the existing WithReference method on 14.x :)

https://dev.azure.com/dnceng-public/public/_build/results?buildId=1276039&view=results seems to hint that no tests have been executed by the CI, is that normal?

[Falco20019]

@davidfowl Should be non-breaking now.

[JamesNK]

For backwards compatibility I will leave the original ones although redundant.

Should they be made obsolete with a note that they'll be removed in the future?

[Falco20019]

@JamesNK I think this would then show obsolete messages all over the place in all cases where the more specific interface is used, right?