Fix disposed timer issue in BitCarousel component (#9877)

[msynk]

closes #9877

Summary by CodeRabbit

• Bug Fixes
  • Enhanced carousel stability by ensuring autoplay operations gracefully stop if the component is disposed, preventing unexpected behavior during transitions.

[coderabbitai]

Walkthrough

The change introduces an early exit in the Go method of the carousel component when the component is disposed. After a delay in the autoplay logic, a check is now performed to verify whether the component has been disposed before proceeding further. This update prevents additional actions or state changes on disposed components, safeguarding the component's lifecycle management without altering the overall structure or external API.

Changes

File(s)	Change Summary
src/BlazorUI/.../Carousel/BitCarousel.razor.cs	Added a safeguard in the Go method: after a delay during autoplay, the method checks the _disposed flag to return early if necessary.

Sequence Diagram(s)

sequenceDiagram
    participant Carousel as "BitCarousel Component"
    participant Timer as "Delay Timer"

    Carousel->>Timer: Initiate autoplay delay
    Timer-->>Carousel: Delay completes
    Carousel->>Carousel: Check _disposed flag
    alt Component is disposed
        Carousel-->>Carousel: Exit method without further actions
    else Component is active
        Carousel->>Carousel: Proceed with remaining autoplay logic
    end

Loading

Poem

Hop, hop, I write this news so fine,
A check to guard my code divine.
When delays come in a playful spin,
I ensure not to act when disposed within.
With carrot-like care, my code's on track,
Hopping forward—with safety, no slack!
🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/BlazorUI/Bit.BlazorUI/Components/Lists/Carousel/BitCarousel.razor.cs (1)

320-320: LGTM! Good fix for the disposed timer issue.

The added check prevents further execution if the component is disposed during the delay, which effectively addresses the issue. This is particularly important for the auto-play scenario where the timer might trigger navigation after component disposal.

Consider adding similar disposed checks in other async methods that could be affected:

private async Task Next()
{
+   if (_disposed) return;
    var itemsCount = _allItems.Count;
    // ... rest of the method
}

private async Task Prev()
{
+   if (_disposed) return;
    _othersIndices = Enumerable.Range(0, _internalScrollItemsCount)
    // ... rest of the method
}

private async Task GotoPage(int index)
{
+   if (_disposed) return;
    if (index < 0)
    // ... rest of the method
}

private async void AutoPlayTimerElapsed(object? sender, System.Timers.ElapsedEventArgs e)
{
+   if (_disposed) return;
    await InvokeAsync(Next);
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b14be96 and f27d44c.

📒 Files selected for processing (1)

• src/BlazorUI/Bit.BlazorUI/Components/Lists/Carousel/BitCarousel.razor.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build and test

🔇 Additional comments (1)

src/BlazorUI/Bit.BlazorUI/Components/Lists/Carousel/BitCarousel.razor.cs (1)

439-443: Well-implemented timer cleanup!

The disposal logic follows best practices by properly unsubscribing the event handler before disposing of the timer.