Fix issues of timer utilization in BitCarousel (#9952)

[msynk]

closes #9952

Summary by CodeRabbit

• Bug Fixes
  • Fixed potential issues in carousel auto-play by ensuring that timer operations during component disposal are handled safely.
• Refactor
  • Enhanced internal timer management, allowing for more reliable lifecycle handling in the carousel component.

[coderabbitai]

Walkthrough

The changes update the BitCarousel component in the Blazor UI project by making the _autoPlayTimer field nullable. The timer's type is now declared as System.Timers.Timer?, and the component’s disposal logic has been modified to explicitly set _autoPlayTimer to null after disposal. This adjustment helps prevent potential issues related to accessing a disposed timer.

Changes

File	Summary
src/BlazorUI/…/Carousel/BitCarousel.razor.cs	Changed _autoPlayTimer from non-nullable (Timer) to nullable (Timer?) and updated DisposeAsync to nullify the timer.

Poem

Oh how I hop through lines of code,
Ensuring timers safely unload.
With nulls in place and logic refined,
My whiskers twitch with joy combined.
A rabbit's cheer in every byte—
Code now hops in pure delight!

---

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)

202-207: Consider handling AutoPlay parameter changes.

The timer is only initialized during first render, but changes to AutoPlay or AutoPlayInterval parameters after initial render are not handled. Consider implementing OnParametersSet to handle these changes.

 protected override void OnParametersSet()
 {
     _internalScrollItemsCount = ScrollItemsCount;
+    
+    if (AutoPlay && _autoPlayTimer == null)
+    {
+        _autoPlayTimer = new System.Timers.Timer(AutoPlayInterval);
+        _autoPlayTimer.Elapsed += AutoPlayTimerElapsed;
+        _autoPlayTimer.Start();
+    }
+    else if (!AutoPlay && _autoPlayTimer != null)
+    {
+        _autoPlayTimer.Stop();
+        _autoPlayTimer.Elapsed -= AutoPlayTimerElapsed;
+        _autoPlayTimer.Dispose();
+        _autoPlayTimer = null;
+    }
+    else if (AutoPlay && _autoPlayTimer?.Interval != AutoPlayInterval)
+    {
+        _autoPlayTimer.Interval = AutoPlayInterval;
+    }
 
     base.OnParametersSet();
 }

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a2102a4 and c67c072.

📒 Files selected for processing (1)

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

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

• GitHub Check: build and test

🔇 Additional comments (3)

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

15-15: LGTM! Improved type safety with nullable timer.

The change from Timer to Timer? better reflects that the timer can be null, especially before initialization and after disposal.

---

316-320: LGTM! Enhanced timer safety checks.

Good improvements to prevent timer-related issues:

1. Added IsDisposed check before timer operations
2. Using null-conditional operator (?.) for safer timer access

---

430-435: LGTM! Proper timer cleanup.

Good practice to explicitly set the timer to null after disposal, preventing any potential use-after-dispose scenarios.