Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Aug 2, 2025

Link issues

fixes #6528

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Bug Fixes:

  • Wrap TaskService and related hosted services registration in a non-debug conditional to prevent them from running in development builds

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Aug 2, 2025
@bb-auto bb-auto bot added this to the 9.8.0 milestone Aug 2, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Aug 2, 2025

Reviewer's Guide

Background task services (AddTaskServices, ClearTempFilesService, MockOnlineContributor) are now conditionally registered only in non-DEBUG builds, disabling them in development mode.

Class diagram for ServiceCollectionExtensions changes

classDiagram
    class ServiceCollectionExtensions {
        +AddBootstrapBlazorServerService(IServiceCollection services)
    }
    class ClearTempFilesService
    class MockOnlineContributor
    class MockReceiveSocketServerService
    class MockSendReceiveSocketServerService
    class MockCustomProtocolSocketServerService
    class TaskServices

    ServiceCollectionExtensions --> "registers (non-DEBUG only)" ClearTempFilesService
    ServiceCollectionExtensions --> "registers (non-DEBUG only)" MockOnlineContributor
    ServiceCollectionExtensions --> "registers (non-DEBUG only)" TaskServices
    ServiceCollectionExtensions --> "registers (always)" MockReceiveSocketServerService
    ServiceCollectionExtensions --> "registers (always)" MockSendReceiveSocketServerService
    ServiceCollectionExtensions --> "registers (always)" MockCustomProtocolSocketServerService
Loading

File-Level Changes

Change Details Files
Disable background task services in development (DEBUG) mode
  • Introduced #if !DEBUG directive
  • Wrapped AddTaskServices, ClearTempFilesService, and MockOnlineContributor registrations within the conditional block
  • Added matching #endif to close the block
src/BootstrapBlazor.Server/Extensions/ServiceCollectionExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6528 Disable the TaskService when running in development (dev) mode.
#6528 Document the change regarding disabling TaskService in dev mode. There is no evidence in the diff or PR body of any documentation being updated or added to describe the change. The change is only in code.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@ArgoZhang ArgoZhang merged commit db1fc33 into main Aug 2, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the chore-service branch August 2, 2025 01:38
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

  • Consider using a runtime check (e.g. IHostEnvironment.IsDevelopment()) instead of #if DEBUG so you can toggle task services without rebuilding the app.
  • Add a brief comment explaining why certain hosted services remain enabled in dev mode to improve future maintainability and avoid confusion.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider using a runtime check (e.g. IHostEnvironment.IsDevelopment()) instead of #if DEBUG so you can toggle task services without rebuilding the app.
- Add a brief comment explaining why certain hosted services remain enabled in dev mode to improve future maintainability and avoid confusion.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Aug 2, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (6fbacbc) to head (e0ea7a6).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6529   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          714       714           
  Lines        31387     31387           
  Branches      4431      4430    -1     
=========================================
  Hits         31387     31387           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc(TaskService): disable task service on dev mode

2 participants