Add RavenDB client & hosting integration

[shiranshalom]

Closes #396

This pull request includes several updates to the Aspire.CommunityToolkit.sln file, new project additions, and updates to dependencies. The most important changes include the addition of new RavenDB projects, updates to project references, and the introduction of new dependencies.

Project Additions and Updates:

Added new RavenDB projects to the solution, including Aspire.CommunityToolkit.Hosting.RavenDB, Aspire.CommunityToolkit.RavenDB.Client, and their respective test and example projects .

Dependency Updates:

Added new dependencies in Directory.Packages.props, including RavenDB.Client, AspNetCore.HealthChecks.RavenDB, and RavenDB.TestDriver.

PR Checklist

• Created a feature/dev branch in your fork (vs. submitting directly from a commit on main)
• Based off latest main branch of toolkit
• PR doesn't include merge commits (always rebase on top of our main, if needed)
• New integration
  • Docs are written - this PR includes README.md files for RavenDB client and hosting projects. Complete documentation is prepared, and we will open a PR to the dotnet/docs-aspire repository soon.
  • Added description of major feature to project description for NuGet package (4000 total character limit, so don't push entire description over that)
• Tests for the changes have been added (for bug fixes / features) (if applicable)
• Contains NO breaking changes
• Every new API (including internal ones) has full XML docs
• Code follows all style conventions

Other information

We are currently working on an article related to this integration. Once it's ready, I will attach the link here.
Additionally, some links in this PR will need to be updated once the NuGet packages are published.

[shiranshalom]

@dotnet-policy-service agree company="Hibernating Rhinos"

[Copilot]

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

Files not reviewed (15)

• CommunityToolkit.Aspire.sln: Language not supported
• Directory.Packages.props: Language not supported
• examples/ravendb/RavenDB.AppHost/Properties/launchSettings.json: Language not supported
• examples/ravendb/RavenDB.AppHost/RavenDB.AppHost.csproj: Language not supported
• src/CommunityToolkit.Aspire.Hosting.RavenDB/CommunityToolkit.Aspire.Hosting.RavenDB.csproj: Language not supported
• src/CommunityToolkit.Aspire.Hosting.RavenDB/PublicAPI.Shipped.txt: Language not supported
• src/CommunityToolkit.Aspire.Hosting.RavenDB/PublicAPI.Unshipped.txt: Language not supported
• src/CommunityToolkit.Aspire.RavenDB.Client/CommunityToolkit.Aspire.RavenDB.Client.csproj: Language not supported
• src/CommunityToolkit.Aspire.RavenDB.Client/PublicAPI.Shipped.txt: Language not supported
• src/CommunityToolkit.Aspire.RavenDB.Client/PublicAPI.Unshipped.txt: Language not supported
• src/CommunityToolkit.Aspire.Hosting.RavenDB/RavenDBServerSettings.cs: Evaluated as low risk
• src/CommunityToolkit.Aspire.RavenDB.Client/HealthChecksExtensions.cs: Evaluated as low risk
• src/CommunityToolkit.Aspire.RavenDB.Client/README.md: Evaluated as low risk
• src/CommunityToolkit.Aspire.Hosting.RavenDB/README.md: Evaluated as low risk
• src/CommunityToolkit.Aspire.Hosting.RavenDB/RavenDBDatabaseResource.cs: Evaluated as low risk

[aaronpowell]

This is a good start and I think the hosting integration is mostly there but we need to do some work on the client integration to align it with the Aspire API design (I've left a comment line on that).

Can we also get the sample expanded so that it includes the client library, even if it's just a serious of API endpoints, so that we have that as a reference point.

[shiranshalom]

@aaronpowell thanks for the feedback!

I’ll work on aligning the client integration and I’ll push these updates shortly.

[shiranshalom]

@aaronpowell
I’ve completed the changes you requested. Here’s a summary of the updates:

Client Integration:

• Updated the integration to fully support dependency injection and added support for configuration using a connection string. We opted to keep some of the extra methods to allow clients to use the library independently of the hosting integration.

Connection String Format:

• Modified the ConnectionStringExpression to the format: URL={Url};Database={DatabaseName}. We chose URL instead of ENDPOINT because we believe it aligns better with our code conventions and feels more intuitive.

Expanded Example Code:

• Expanded the example in the codebase to include a new ApiService project and added some basic API endpoints to demonstrate practical use cases of the integration.

Tests:

• Fixed existing tests to align with the new integration changes.
• Added new tests to cover the updated functionality and improve overall test coverage.

If you have any additional feedback or suggestions, I’d be happy to address them!

[aaronpowell]

Sorry for the delay, I'll hope to review the updates this week

[Copilot]

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

Files not reviewed (15)

• CommunityToolkit.Aspire.sln: Language not supported
• Directory.Packages.props: Language not supported
• examples/ravendb/CommunityToolkit.Aspire.Hosting.RavenDB.ApiService/CommunityToolkit.Aspire.Hosting.RavenDB.ApiService.csproj: Language not supported
• examples/ravendb/CommunityToolkit.Aspire.Hosting.RavenDB.ApiService/Properties/launchSettings.json: Language not supported
• examples/ravendb/CommunityToolkit.Aspire.Hosting.RavenDB.ApiService/RavenDB.ApiService.http: Language not supported
• examples/ravendb/CommunityToolkit.Aspire.Hosting.RavenDB.ServiceDefaults/CommunityToolkit.Aspire.Hosting.RavenDB.ServiceDefaults.csproj: Language not supported
• examples/ravendb/RavenDB.AppHost/CommunityToolkit.Aspire.Hosting.RavenDB.AppHost.csproj: Language not supported
• examples/ravendb/RavenDB.AppHost/Properties/launchSettings.json: Language not supported
• src/CommunityToolkit.Aspire.Hosting.RavenDB/CommunityToolkit.Aspire.Hosting.RavenDB.csproj: Language not supported
• src/CommunityToolkit.Aspire.Hosting.RavenDB/PublicAPI.Shipped.txt: Language not supported
• src/CommunityToolkit.Aspire.Hosting.RavenDB/PublicAPI.Unshipped.txt: Language not supported
• src/CommunityToolkit.Aspire.Hosting.RavenDB/HealthChecksExtensions.cs: Evaluated as low risk
• src/CommunityToolkit.Aspire.Hosting.RavenDB/README.md: Evaluated as low risk
• src/CommunityToolkit.Aspire.Hosting.RavenDB/RavenDBBuilderExtensions.cs: Evaluated as low risk
• src/CommunityToolkit.Aspire.Hosting.RavenDB/RavenDBContainerImageTags.cs: Evaluated as low risk

Comments suppressed due to low confidence (1)

examples/ravendb/CommunityToolkit.Aspire.Hosting.RavenDB.ApiService/Program.cs:40

• The properties of the 'Company' class should use non-nullable types where possible.

public class Company

[aaronpowell]

Last two things @shiranshalom

1. Can you update the CODEOWNERS file with you as the owner.
2. Can you update the README with the packages and their details (don't worry about broken links).

Regarding docs, do you want them to be on the RavenDB docs, or is the intent to be on the Microsoft Learn docs?

[shiranshalom]

Last two things @shiranshalom

1. Can you update the CODEOWNERS file with you as the owner.

Done

2. Can you update the README with the packages and their details (don't worry about broken links).

Done

Regarding docs, do you want them to be on the RavenDB docs, or is the intent to be on the Microsoft Learn docs?

Both! 🙂 I'll be submitting a new PR to the dotnet/docs-aspire repository, and there will also be documentation and articles on our website. I'll share the links as soon as they're available

[aaronpowell]

All good @shiranshalom and I've sent an invite to join the contributors (I thought I'd already done that, whoops!)