Improve bit Boilerplate debug experience (#11965)

[ysmoradi]

closes #11965

Summary by CodeRabbit

• Chores
  • Extended timeout duration for external service operations to improve reliability
  • Updated development environment configuration settings for enhanced local development experience
  • Optimized project build dependencies

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

[coderabbitai]

Walkthrough

Visual Studio debugging settings are configured for improved development workflow, HTTP client timeout for NuGet statistics service is extended from 3 to 20 seconds, and Boilerplate.Server.Web now references Boilerplate.Client.Core to optimize Blazor Server development-time builds.

Changes

Cohort / File(s)	Summary
Visual Studio Debug Configuration src/Templates/Boilerplate/Bit.Boilerplate/settings.VisualStudio.json	Added debugging.general.closeConsoleWhenDebuggingEnds: true and projectsAndSolutions.webProjects.enableDebugTargetsObserver: false settings for improved debugging experience.
HTTP Client Configuration src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Services.cs	Increased NugetStatisticsService HTTP client timeout from 3 seconds to 20 seconds to accommodate longer request durations.
Project Dependencies src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Boilerplate.Server.Web.csproj	Added project reference to Boilerplate.Client.Core.csproj with documentation explaining the performance rationale for accelerating Blazor Server development-time builds.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A timeout grows from three to twenty tides,
Debug consoles close, the target observer hides,
Client.Core joins the Web's embrace,
Blazor builds now sprint at a swifter pace! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
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 (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly addresses the main objective of the PR—improving the debug experience for bit Boilerplate, which aligns with all three code changes: Visual Studio settings, HTTP timeout adjustment, and project reference addition.
Linked Issues check	✅ Passed	The PR implements changes to improve Boilerplate debug experience: VS settings for debugging, timeout adjustment for service reliability, and project reference for faster builds—all supporting the stated objective of addressing debug experience issues.
Out of Scope Changes check	✅ Passed	All three file changes are directly related to improving the debug experience: Visual Studio settings, service timeout reliability, and build optimization for development—no out-of-scope changes detected.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent 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 29b4148 and bf94787.

📒 Files selected for processing (3)

• src/Templates/Boilerplate/Bit.Boilerplate/settings.VisualStudio.json
• src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Program.Services.cs
• src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Boilerplate.Server.Web.csproj

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: CodeQL analysis (csharp)
• GitHub Check: build Bit.Templates

🔇 Additional comments (4)

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

418-423: LGTM! Timeout increase improves reliability during debugging.

The timeout increase from 3 to 20 seconds for the NuGet statistics service is reasonable. External API calls can be slower during debugging sessions, and the original 3-second timeout was quite aggressive for a remote service. This change should reduce timeout failures during development.

src/Templates/Boilerplate/Bit.Boilerplate/settings.VisualStudio.json (2)

11-11: LGTM! Cleaner debugging experience.

Automatically closing the console when debugging ends improves the development workflow by reducing manual cleanup.

---

13-13: LGTM! Disabling debug targets observer may resolve Aspire debugging issues.

Disabling enableDebugTargetsObserver for web projects likely addresses specific issues with the Aspire debug experience mentioned in issue #11965. This setting controls Visual Studio's automatic detection of debug targets in web projects.

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

27-28: LGTM! Excellent optimization with clear documentation.

Adding a direct reference to Client.Core is a smart optimization for Blazor Server development. The explanatory comment clearly documents the rationale: developers can unload Client.Web during development and still have the necessary client functionality available through Client.Core, significantly speeding up build times.

This is a well-considered change that directly addresses the PR objective of improving the debug experience.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[Copilot]

Pull request overview

This PR improves the debugging experience for the Bit Boilerplate project by optimizing build times during Blazor Server development and enhancing Visual Studio debugging behavior.

Key changes:

• Added Client.Core project reference to Server.Web to enable faster builds when developing with Blazor Server
• Increased NuGet API HTTP client timeout from 3 to 20 seconds to prevent premature timeouts
• Enhanced Visual Studio debugging settings for a smoother development workflow

Reviewed changes

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

File	Description
Boilerplate.Server.Web.csproj	Added Client.Core project reference with explanatory comment to optimize build times during Blazor Server development
Program.Services.cs	Increased NugetStatisticsService HTTP client timeout from 3 to 20 seconds for more reliable external API calls
settings.VisualStudio.json	Added two debugging settings: auto-close console on debug end and disabled debug targets observer