Add redis parameter to bit Boilerplate (#11937) #11938

ysmoradi · 2025-12-29T21:55:09Z

closes #11937

Summary by CodeRabbit

Release Notes

New Features
- Added optional Redis support to the boilerplate template for distributed caching, background job processing, SignalR scaling, and distributed locking.
Documentation
- Updated documentation describing Redis infrastructure setup, including two Redis instances for caching and persistent storage.
Chores
- Updated template configurations and CI/CD workflows to support optional Redis enablement (disabled by default).

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-29T21:55:22Z

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.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

This PR adds Redis support to the Bit.Boilerplate template by introducing a redis boolean parameter, configuring two separate Redis instances (ephemeral cache and persistent storage) in Aspire, and adding conditional package references and service registration across the solution.

Changes

Cohort / File(s)	Summary
CI/CD and Build Configuration `.github/workflows/bit.full.ci.yml`	Added `--redis` flag to dotnet new bit-bp invocations for PostgreSQL templates; first config enables Redis, second explicitly disables it.
Template Configuration and Metadata `src/Templates/Boilerplate/Bit.Boilerplate/.template.config/template.json` `src/Templates/Boilerplate/Bit.Boilerplate/.template.config/ide.host.json` `src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md`	Introduced new template symbol `redis` (boolean parameter, default false) in template.json, added corresponding entry in ide.host.json, and documented Redis in copilot-instructions as distributed caching storage, Hangfire job storage, and SignalR backplane.
Documentation `src/Templates/Boilerplate/Bit.Boilerplate/.docs/14- Response Caching System.md`	Added Redis Infrastructure section describing ephemeral redis-cache (in-memory, L2 cache + SignalR backplane) and persistent redis-persistent (AOF-enabled, Hangfire + distributed locking); updated monitor cache headers example.
Package References `src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props` `src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Boilerplate.Server.Api.csproj` `src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Boilerplate.Server.Shared.csproj` `src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/Boilerplate.Server.AppHost.csproj`	Added conditional Redis-related packages (Aspire.Hosting.Redis, Aspire.StackExchange.Redis, DistributedLock.Redis, Hangfire.Redis.StackExchange, Microsoft.AspNetCore.SignalR.StackExchangeRedis, ZiggyCreatures.FusionCache.Backplane.StackExchangeRedis, Microsoft.Extensions.Caching.StackExchangeRedis) gated by `$(redis)` property. Also bumped Scalar.AspNetCore to 2.11.10.
Configuration Files `src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/appsettings.json` `src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/appsettings.json`	Added Redis connection strings (redis-cache and redis-persistent) under ConnectionStrings, guarded by redis conditional compilation.
Service Registration and Dependency Injection `src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Services.cs` `src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/WebApplicationBuilderExtensions.cs`	Added Redis-backed distributed lock factory (Medallion.Threading.Redis), Hangfire storage configuration (Redis when enabled, EF Core fallback), SignalR backplane via StackExchange.Redis, and FusionCache distributed cache + backplane setup. Updated AddHangfire method signature to accept IServiceProvider and Hangfire configuration. Changed identity role type to Models.Identity.Role.
Aspire Orchestration `src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/Program.cs`	Introduced two Redis container instances (redis-cache without persistence, redis-persistent with AOF and data volume). Added conditional wiring of both instances to API and Web projects, fixed dev tunnel endpoints to specific ports (5031 for API, 5000 for Web). Enhanced SqlServer database provisioning with data volume.

Sequence Diagram(s)

sequenceDiagram
    participant Aspire as Aspire Host
    participant Redis1 as redis-cache<br/>(Ephemeral)
    participant Redis2 as redis-persistent<br/>(Persistent)
    participant API as Server API
    participant FusionCache
    participant SignalR
    participant Hangfire
    participant DistLock as Distributed<br/>Locking
    
    Aspire->>Redis1: Create ephemeral instance
    Aspire->>Redis2: Create persistent instance<br/>(with AOF + data volume)
    
    API->>Redis1: Register redis-cache multiplexer
    API->>Redis2: Register redis-persistent multiplexer
    
    FusionCache->>Redis1: Connect for L2 cache
    FusionCache->>Redis1: Connect for backplane
    
    SignalR->>Redis1: Connect for backplane<br/>(scale-out)
    
    Hangfire->>Redis2: Connect for job storage<br/>(RedisStorageOptions)
    
    DistLock->>Redis2: Connect for distributed locks
    
    rect rgba(100, 150, 200, 0.1)
        note over Redis1: In-memory, regenerable data
        note over Redis2: Persistent, critical data
    end

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~50 minutes

Poem

🐰 A Redis tale, so fine and grand,
Cache layers dancing, hand in hand!
Ephemeral whispers, persistent dreams,
Hangfire's jobs flow through Redis streams—
Distributed locks, backplanes align,
Two instances perfect, a template divine! 🔴

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	A minor version bump of Scalar.AspNetCore (2.11.9 to 2.11.10) appears unrelated to the redis parameter addition and may represent an out-of-scope change not justified by the linked issue.	Clarify whether the Scalar.AspNetCore version bump is intentional or should be reverted to keep the PR focused on redis parameter implementation.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title 'Add redis parameter to bit Boilerplate (#11937)' directly and clearly describes the main change: adding a redis parameter to the Boilerplate template, matching the scope of the entire changeset.
Linked Issues check	✅ Passed	The PR fully implements the objective from issue #11937 to add a missing redis parameter to the Boilerplate template. Changes include the parameter definition, configuration files, documentation, CI workflow updates, and implementation across all relevant project files.

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

♻️ Duplicate comments (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Boilerplate.Server.Shared.csproj (1)

26-28: Same condition inconsistency as noted in AppHost.csproj.

These conditions also use OR '$(redis)' == '', which conflicts with the defaultValue: "false" in template.json. See the previous review comment on Boilerplate.Server.AppHost.csproj for details.

🧹 Nitpick comments (2)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/appsettings.json (1)
9-10: Add explanatory comments for Redis connection strings.

For consistency with the Api project's appsettings.json (lines 27-30), consider adding comments that explain the purpose of each Redis instance:
🔎 Suggested addition
-        "redis-cache": "localhost:6379",
-        "redis-persistent": "localhost:6380",
+        "redis-cache": "localhost:6379",
+        "redis-cache_Comment": "Redis for FusionCache L2 distributed cache layer and SignalR backplane - no persistence needed, acts as fast ephemeral cache",
+        "redis-persistent": "localhost:6380",
+        "redis-persistent_Comment": "Redis for Hangfire background jobs and distributed locking - requires persistence for durability",
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md (1)
25-27: Minor capitalization inconsistency in Redis description.

The description uses lowercase "hangfire" and "signalr", while line 28 uses "Hangfire" and line 23 uses "SignalR" with proper capitalization.
🔎 Suggested fix
-*   **Redis**: Distributed caching storage and backplane, hangfire job storage, signalr backplane and distributed lock. 
+*   **Redis**: Distributed caching storage and backplane, Hangfire job storage, SignalR backplane, and distributed lock.

📜 Review details

Configuration used: Repository 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 b8078e0 and 97eea61.

📒 Files selected for processing (14)

.github/workflows/bit.full.ci.yml
src/Templates/Boilerplate/Bit.Boilerplate/.docs/14- Response Caching System.md
src/Templates/Boilerplate/Bit.Boilerplate/.github/copilot-instructions.md
src/Templates/Boilerplate/Bit.Boilerplate/.template.config/ide.host.json
src/Templates/Boilerplate/Bit.Boilerplate/.template.config/template.json
src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Packages.props
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Boilerplate.Server.Api.csproj
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Services.cs
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/appsettings.json
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/Boilerplate.Server.AppHost.csproj
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.AppHost/Program.cs
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Boilerplate.Server.Shared.csproj
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Shared/Extensions/WebApplicationBuilderExtensions.cs
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/appsettings.json

🧰 Additional context used

🧬 Code graph analysis (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Services.cs (2)

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

GetRequiredConnectionString (5-11)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Models/Identity/Role.cs (1)

Role (3-7)

🪛 Biome (2.1.2)

src/Templates/Boilerplate/Bit.Boilerplate/.template.config/template.json

[error] 176-176: End of file expected