Include known providers in error message when provider is not found

[Copilot]

• Understand the issue and explore the repository structure
• Update DefaultClientServices.cs error message to include known providers for the specified kind
• Update DefaultSiloServices.cs error message to include known providers for the specified kind
• Create tests to verify the enhanced error messages
• Fix missing 'or' in DefaultClientServices.cs error message (pre-existing bug)
• Fix using statement ordering in DefaultClientServices.cs to comply with .editorconfig
• Fix test file build errors - use ConfigureAppConfiguration pattern and correct extension methods
• Request code review - passed with no issues
• Run security scanning - no vulnerabilities found

Summary

This PR successfully implements the requested feature to include known/registered providers in error messages when a provider is not found.

Key Changes:

1. Enhanced error messages in both DefaultClientServices.cs and DefaultSiloServices.cs
2. Error messages now include a sorted, comma-separated list of known providers for the requested kind
3. Fixed a pre-existing typo in DefaultClientServices.cs where "or" was missing
4. Fixed using statement ordering to comply with .editorconfig
5. Added comprehensive tests in ProviderErrorMessageTests.cs

Example Output:

Could not find Clustering provider named 'NonExistentProvider'. This can indicate that either the 'Microsoft.Orleans.Sdk' or the provider's package are not referenced by your application. Known Clustering providers: AzureStorage, Default, DynamoDB.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Include known providers in error message when a provider is not found</issue_title>
<issue_description>We should update these error messages to include the list of known/registered providers for the specified kind (eg, Clustering, GrainStorage, etc)

orleans/src/Orleans.Core/Core/DefaultClientServices.cs

Line 213 in f23233a

throw new InvalidOperationException($"Could not find {kind} provider named '{name}'. This can indicate that either the 'Microsoft.Orleans.Sdk' package the provider's package are not referenced by your application.");

orleans/src/Orleans.Runtime/Hosting/DefaultSiloServices.cs

Line 478 in f23233a

throw new InvalidOperationException($"Could not find {kind} provider named '{name}'. This can indicate that either the 'Microsoft.Orleans.Sdk' or the provider's package are not referenced by your application.");

</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Include known providers in error message when a provider is not found #9732

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Microsoft Reviewers: Open in CodeFlow

[ReubenBond]

@copilot the build failed

[Copilot]

@copilot the build failed

Fixed using statement ordering to comply with .editorconfig (System.* namespaces first, then alphabetically sorted). See commit cd40fc7.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• 0t3vsblobprodcus362.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Core/Orleans.Core.csproj (dns block)
• ckzvsblobprodcus347.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Core/Orleans.Core.csproj (dns block)
• dnceng.pkgs.visualstudio.com
  • Triggering command: dotnet build src/Orleans.Core/Orleans.Core.csproj (dns block)
• frdvsblobprodcus327.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Core/Orleans.Core.csproj (dns block)
• imzvsblobprodcus368.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Core/Orleans.Core.csproj (dns block)
• kh4vsblobprodcus325.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Core/Orleans.Core.csproj (dns block)
• lylvsblobprodcus31.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Core/Orleans.Core.csproj (dns block)
• yluvsblobprodcus367.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Core/Orleans.Core.csproj (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

[ReubenBond]

Look at the build errors

[Copilot]

Look at the build errors

Fixed the build errors in ProviderErrorMessageTests.cs. The issues were:

1. Using AddConfiguration() on IConfiguration instead of using ConfigureAppConfiguration() on the host builder
2. Using parameterless UseOrleans()/UseOrleansClient() which aren't available on IHostBuilder
3. Missing #nullable enable directive for nullable reference types

See commit 221f423.

[Copilot]

Pull request overview

This PR enhances error messages when providers are not found to include a list of known/registered providers of the same kind, making it easier for developers to diagnose configuration issues.

Changes:

• Enhanced error messages in both DefaultClientServices.cs and DefaultSiloServices.cs to include sorted lists of known providers when a provider is not found
• Fixed a pre-existing typo where "or" was missing in the DefaultClientServices.cs error message
• Fixed using statement ordering in DefaultClientServices.cs to comply with .editorconfig rules
• Added comprehensive tests in ProviderErrorMessageTests.cs to verify the enhanced error messages

Reviewed changes

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

File	Description
src/Orleans.Core/Core/DefaultClientServices.cs	Enhanced error messages to include known providers list, fixed typo ("or" was missing), and corrected using statement ordering
src/Orleans.Runtime/Hosting/DefaultSiloServices.cs	Enhanced error messages to include known providers list (consistent with client implementation)
test/NonSilo.Tests/ProviderErrorMessageTests.cs	Added comprehensive tests for client and silo provider error messages, covering different provider types