Add support for aspire in bit Boilerplate (#11033) #11034

ysmoradi · 2025-06-30T19:56:05Z

Summary by CodeRabbit

New Features
- Added optional Aspire distributed application hosting support, including new configuration options and project files.
- Introduced a shared server project to centralize common services and settings.
- Added extension methods for easier middleware and service configuration.
- Enhanced logging and telemetry support with OpenTelemetry and related packages.
Bug Fixes
- Simplified and unified middleware and service registration, reducing redundancy and potential misconfiguration.
Refactor
- Moved and exposed several shared utility methods and settings for broader use.
- Streamlined project structure and conditional feature inclusion based on configuration flags.
Chores
- Updated documentation and configuration defaults for improved clarity and maintainability.

coderabbitai · 2025-06-30T19:56:13Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update introduces comprehensive support for the "aspire" feature in the bit Boilerplate project template. It adds new configuration options, shared code, and conditional logic to enable Aspire hosting, shared services, and related infrastructure. Several files are refactored or reorganized to centralize shared logic, enhance modularity, and streamline service and middleware registration.

Changes

File(s) / Group	Change Summary
template.json, Boilerplate.Web.slnf, Boilerplate.slnx, Directory.Packages.props, appsettings.json	Added "aspire" parameter, conditional project/package inclusion, and configuration logic for Aspire support.
Boilerplate.Server.AppHost/* (new files)	Introduced new AppHost project for distributed app hosting with Aspire, including configs and entry point.
Boilerplate.Server.Shared/* (new files)	Added shared server project with extensions for caching, localization, health, telemetry, and trusted origins.
Boilerplate.Server.Api/*	Refactored to use shared services, removed/reorganized caching, compression, and trusted origin logic.
Boilerplate.Server.Web/*	Refactored to use shared services, removed redundant service registrations, updated project references.
Extensions/* (Api, Web, Shared)	Moved and reorganized extension methods for HttpContext/HttpRequest; centralized shared logic.
AppResponseCachePolicy.cs (Api, Shared)	Moved caching policy class to shared project; updated constructor and namespace.
ServerApiSettings.cs, ServerWebSettings.cs	Refactored settings classes to move shared logic to ServerSharedSettings; removed/relocated properties.
README.md, .template.config/template.json	Minor doc and config updates, including anchor and whitespace fixes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TemplateEngine
    participant AppHost
    participant ServerWeb
    participant ServerApi
    participant Shared

    User->>TemplateEngine: Create project (aspire=true/false)
    TemplateEngine->>AppHost: Include/exclude AppHost project (if aspire)
    TemplateEngine->>ServerWeb: Always include ServerWeb
    TemplateEngine->>ServerApi: Include based on config
    TemplateEngine->>Shared: Always include Shared
    AppHost->>ServerWeb: Reference project
    AppHost->>ServerApi: Reference project (conditionally)
    AppHost->>Shared: Reference project
    ServerWeb->>Shared: Reference project
    ServerApi->>Shared: Reference project
    Note over AppHost,Shared: Shared services, health checks, telemetry, and caching are centralized

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Add support for Aspire in bit Boilerplate project template (#11033)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Update README anchor (src/Websites/WikiDocs/README.md)	Documentation anchor update is unrelated to Aspire support objective.

Poem

🐇
With Aspire now in every hop,
The boilerplate leaps to the top!
Shared code and hosts, all neat and bright,
Services bundled, templates light.
From configs deep to middlewares clear,
The rabbit cheers: "Aspire is here!"
🥕✨

✨ Finishing Touches

🧪 Generate Unit Tests

Create PR with Unit Tests
Post Copyable Unit Tests in a Comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Pull Request Overview

This PR adds optional Aspire support to the Bit Boilerplate template by centralizing shared server logic, introducing a ServerShared project, and updating templates and solution files to conditionally include Aspire components.

Extract shared settings, middleware, and service registrations into Boilerplate.Server.Shared
Introduce aspire template parameter and wire up MapAspire() and AddAspireServiceDefaults()
Update solution, project references, and template.json to include new shared and AppHost projects

Reviewed Changes

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

Show a summary per file

File	Description
README.md	Updated DeepWiki link anchor
ServerWebSettings.cs	Removed in-project response caching and moved to shared settings
Program.*.cs	Removed duplicated CORS/compression/config from individual projects and delegated to `AddServerSharedServices` & `Use*` extensions
HttpRequestExtensions.cs / HttpContextExtensions.cs	Removed Web/API-specific extensions and moved core methods to shared extensions
Boilerplate.Server.Shared/**	New shared project containing common settings, extensions, policies, and service registrations
.template-config/template.json	Added `aspire` parameter and generated ports for AppHost
.sln	Updated solution and solution filter to include `Server.Shared` and `Server.AppHost` projects conditionally

Comments suppressed due to low confidence (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/WebApplicationExtensions.cs:18

Add automated tests or integration tests to verify that MapAspire() registers the expected endpoints (e.g., /health, /alive) only in development mode.

    public static WebApplication MapAspire(this WebApplication app)

...late/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Services/AppResponseCachePolicy.cs

coderabbitai

Actionable comments posted: 6

🧹 Nitpick comments (3)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/appsettings.json (1)
3-12: Conditional markers break JSON tooling; consider a .template extension or build-step rename

//#if … directives are perfectly valid for the dotnet-template engine, but they render the file invalid JSON everywhere else (IDE syntax highlighting, containerised linter pipelines, infra that expects valid JSON, etc.).
Two lightweight mitigations that keep template support intact:
-// file keeps the .json extension
+// rename to appsettings.json.template (or .json.tt)
or add a pre-build copy task that renames it back to appsettings.json only when the template engine has resolved the markers.

This avoids the static-analysis noise you are already seeing in Biome.
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/Boilerplate.Server.AppHost.csproj (1)
3-10: Duplicate UserSecretsId across projects may leak secrets

UserSecretsId is identical to the one in other server projects. Secrets written while developing the AppHost will therefore be visible to Api/Web and vice-versa, which defeats isolation and can surprise new contributors.
-<UserSecretsId>AC87AA5B-4B37-4E52-8468-2D5DF24AF256</UserSecretsId>
+<UserSecretsId>C4D6F3A0-...-UNIQUE-...</UserSecretsId>
Generating a new GUID for each project is a one-time fix.
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/HttpRequestExtensions.cs (1)
32-41: Consider expanding Lighthouse detection logic.

The current detection only checks for "google" and "lighthouse" strings, which may miss other Lighthouse-related user agents or give false positives.

Consider a more specific detection pattern:
-public static bool IsLightHouseRequest(this HttpRequest request)
-{
-    var agent = GetLoweredUserAgent(request);
-
-    if (agent.Contains("google")) return true;
-
-    if (agent.Contains("lighthouse")) return true;
-
-    return false;
-}
+public static bool IsLightHouseRequest(this HttpRequest request)
+{
+    var agent = GetLoweredUserAgent(request);
+
+    // More specific Lighthouse detection
+    return agent.Contains("lighthouse") || 
+           agent.Contains("chrome-lighthouse") ||
+           (agent.Contains("google") && agent.Contains("lighthouse"));
+}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between d245ad0 and 00d6966.

📒 Files selected for processing (33)

src/Templates/Boilerplate/Bit.Boilerplate/.template.config/template.json (4 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.Web.slnf (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.slnx (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Boilerplate.Server.Api.csproj (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Extensions/HttpContextExtensions.cs (0 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Extensions/HttpRequestExtensions.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Middlewares.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Services.cs (6 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.cs (0 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/ServerApiSettings.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Services/AppResponseCachePolicy.cs (0 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/appsettings.json (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/Boilerplate.Server.AppHost.csproj (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/Program.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/Properties/launchSettings.json (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/appsettings.Development.json (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/appsettings.json (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Boilerplate.Server.Shared.csproj (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/HttpContextExtensions.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/HttpRequestExtensions.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/WebApplicationBuilderExtensions.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/WebApplicationExtensions.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/ServerSharedSettings.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Services/AppResponseCachePolicy.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Boilerplate.Server.Web.csproj (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Components/App.razor (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Extensions/HttpRequestExtensions.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Middlewares.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Services.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.cs (0 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/ServerWebSettings.cs (0 hunks)
src/Websites/WikiDocs/README.md (1 hunks)

💤 Files with no reviewable changes (5)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.cs
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.cs
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/ServerWebSettings.cs
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Extensions/HttpContextExtensions.cs
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Services/AppResponseCachePolicy.cs

🧰 Additional context used

🧬 Code Graph Analysis (6)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/HttpContextExtensions.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Extensions/HttpContextExtensions.cs (1)

HttpContextExtensions (7-30)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Services.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/ServerWebSettings.cs (1)

ServerWebSettings (9-45)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/WebApplicationExtensions.cs (2)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/ServerSharedSettings.cs (1)

ServerSharedSettings (8-53)

src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Services/CultureInfoManager.cs (1)

CultureInfoManager (5-94)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/ServerApiSettings.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/ServerSharedSettings.cs (1)

ServerSharedSettings (8-53)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Services/AppResponseCachePolicy.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/ServerSharedSettings.cs (1)

ServerSharedSettings (8-53)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/HttpRequestExtensions.cs (3)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Extensions/HttpRequestExtensions.cs (2)

HttpRequestExtensions (5-28)

Uri (12-27)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Extensions/HttpRequestExtensions.cs (1)

HttpRequestExtensions (3-29)

src/BlazorUI/Bit.BlazorUI/Extensions/StringExtensions.cs (1)

HasValue (6-11)

🪛 Biome (1.9.4)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/appsettings.json

[error] 3-3: Expected a property but instead found '//#if (database == "SqlServer" && aspire == false)'.

Expected a property here.

(parse)

[error] 4-4: End of file expected