Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Aug 12, 2025

Link issues

fixes #6604

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

Improve OnlineSheet sample performance by deferring and scoping mock updates and removing unnecessary hosted service

Enhancements:

  • Defer mock contributor dispatch for the OnlineSheet demo until 5 seconds after initial render
  • Filter dispatch entries to only process the "OnlineSheet-Demo" sample
  • Remove MockOnlineContributor hosted service registration from DI and replace it with a static trigger in the sample
  • Introduce Contributor model and static MockOnlineContributor helper in the tutorial folder
  • Unify background service registration by removing conditional compilation around hosted services

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

sourcery-ai bot commented Aug 12, 2025

Reviewer's Guide

This PR enhances the OnlineSheet sample by deferring mock data initialization after initial render, tightening dispatch matching, refactoring hosted service registrations, and consolidating contributor models and mock logic into the tutorial sample.

Sequence diagram for deferred mock contributor dispatch after initial render

sequenceDiagram
    participant OnlineSheet as OnlineSheet.razor.cs
    participant MockOnlineContributor
    participant DispatchService
    OnlineSheet->>OnlineSheet: OnAfterRenderAsync(firstRender)
    OnlineSheet->>OnlineSheet: await Task.Delay(5000)
    OnlineSheet->>MockOnlineContributor: Trigger(DispatchService)
    MockOnlineContributor->>DispatchService: Dispatch(DispatchEntry<Contributor>)
Loading

Class diagram for new Contributor and MockOnlineContributor classes

classDiagram
    class Contributor {
        string? Name
        string? Avatar
        string? Description
        UniverSheetData? Data
    }
    class MockOnlineContributor {
        +static void Trigger(IDispatchService<Contributor> dispatchService)
    }
    Contributor <|-- MockOnlineContributor: uses
Loading

File-Level Changes

Change Details Files
Defer mock data trigger until after initial render
  • Override OnAfterRenderAsync with firstRender check
  • Introduce a 5-second delay before invoking MockOnlineContributor.Trigger
  • Call base.OnAfterRenderAsync to preserve lifecycle behavior
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/OnlineSheet.razor.cs
Tighten dispatch condition using pattern matching
  • Replace entry.Entry != null check with pattern matching on Name and Entry not null
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/OnlineSheet.razor.cs
Refactor hosted service registration
  • Remove MockOnlineContributor from hosted services under build directives
  • Retain only required mock socket server services
src/BootstrapBlazor.Server/Extensions/ServiceCollectionExtensions.cs
Consolidate contributor model and mock logic in sample
  • Add new Contributor model class with Name, Avatar, Description, and Data properties
  • Add static MockOnlineContributor in the tutorial folder to dispatch sample data
  • Delete the old MockOnlineContributor service implementation
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/Contributor.cs
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/MockOnlineContributor.cs
src/BootstrapBlazor.Server/Services/MockOnlineContributor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6604 Improve the performance of the OnlineSheet component.
#6604 Add sample code for the OnlineSheet component.

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 6086ac3 into main Aug 12, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the doc-task branch August 12, 2025 01:26
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:

  • Avoid using a fixed Task.Delay in OnAfterRenderAsync—consider using an event-driven trigger or making the delay configurable so updates aren’t tied to an arbitrary timeout.
  • The new pattern-matching check in Dispatch is concise but could be hard to follow; adding a named helper or comment might improve clarity and maintainability.
  • You removed the hosted‐service registration for MockOnlineContributor but then rely on its static Trigger method—verify that your service configuration matches the new mock implementation across build configurations.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Avoid using a fixed Task.Delay in OnAfterRenderAsync—consider using an event-driven trigger or making the delay configurable so updates aren’t tied to an arbitrary timeout.
- The new pattern-matching check in Dispatch is concise but could be hard to follow; adding a named helper or comment might improve clarity and maintainability.
- You removed the hosted‐service registration for MockOnlineContributor but then rely on its static Trigger method—verify that your service configuration matches the new mock implementation across build configurations.

## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor.Server/Extensions/ServiceCollectionExtensions.cs:39` </location>
<code_context>

-#if !DEBUG
         // 增加后台任务服务
         services.AddTaskServices();
         services.AddHostedService<ClearTempFilesService>();
-        services.AddHostedService<MockOnlineContributor>();
</code_context>

<issue_to_address>
Consider replacing the open-generic AddTaskServices registration with explicit service registrations or a small factory to improve clarity and maintainability.

```suggestion
The call to `services.AddTaskServices()` is hiding an open‐generic/reflection‐based scan that can make it hard to see exactly which `IDispatchService<T>` implementations are wired up. You can simplify by registering each dispatch service explicitly (or with a tiny factory) while preserving all existing behavior. For example:

```csharp
// instead of: services.AddTaskServices();
services.AddScoped<IDispatchService<Order>, OrderDispatchService>();
services.AddScoped<IDispatchService<Invoice>, InvoiceDispatchService>();
services.AddScoped<IDispatchService<Customer>, CustomerDispatchService>();
// …repeat for each T…
```

Or, if you still want a single registration point, use a small factory delegate:

```csharp
services.AddSingleton<Func<Type, object>>(sp => serviceType =>
{
    if (serviceType == typeof(IDispatchService<Order>))
        return sp.GetRequiredService<OrderDispatchService>();
    if (serviceType == typeof(IDispatchService<Invoice>))
        return sp.GetRequiredService<InvoiceDispatchService>();
    if (serviceType == typeof(IDispatchService<Customer>))
        return sp.GetRequiredService<CustomerDispatchService>();
    throw new KeyNotFoundException($"No dispatch service for {serviceType}");
});
```

This keeps the registrations explicit—no hidden assembly scans—and makes it obvious which dispatch services are available.
</issue_to_address>

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.


#if !DEBUG
// 增加后台任务服务
services.AddTaskServices();
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (complexity): Consider replacing the open-generic AddTaskServices registration with explicit service registrations or a small factory to improve clarity and maintainability.

Suggested change
services.AddTaskServices();
The call to `services.AddTaskServices()` is hiding an open‐generic/reflection‐based scan that can make it hard to see exactly which `IDispatchService<T>` implementations are wired up. You can simplify by registering each dispatch service explicitly (or with a tiny factory) while preserving all existing behavior. For example:
```csharp
// instead of: services.AddTaskServices();
services.AddScoped<IDispatchService<Order>, OrderDispatchService>();
services.AddScoped<IDispatchService<Invoice>, InvoiceDispatchService>();
services.AddScoped<IDispatchService<Customer>, CustomerDispatchService>();
// …repeat for each T…

Or, if you still want a single registration point, use a small factory delegate:

services.AddSingleton<Func<Type, object>>(sp => serviceType =>
{
    if (serviceType == typeof(IDispatchService<Order>))
        return sp.GetRequiredService<OrderDispatchService>();
    if (serviceType == typeof(IDispatchService<Invoice>))
        return sp.GetRequiredService<InvoiceDispatchService>();
    if (serviceType == typeof(IDispatchService<Customer>))
        return sp.GetRequiredService<CustomerDispatchService>();
    throw new KeyNotFoundException($"No dispatch service for {serviceType}");
});

This keeps the registrations explicit—no hidden assembly scans—and makes it obvious which dispatch services are available.

@codecov
Copy link

codecov bot commented Aug 12, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (60d1be7) to head (12f6602).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6605   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          739       739           
  Lines        31669     31669           
  Branches      4458      4458           
=========================================
  Hits         31669     31669           
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(OnlineSheet): improve performance

2 participants