Skip to content

Fix ObjectDisposedException in BitCarousel (#9821)#9823

Merged
msynk merged 1 commit intobitfoundation:developfrom
msynk:9821-blazorui-carousel-ObjectDisposedException
Feb 7, 2025
Merged

Fix ObjectDisposedException in BitCarousel (#9821)#9823
msynk merged 1 commit intobitfoundation:developfrom
msynk:9821-blazorui-carousel-ObjectDisposedException

Conversation

@msynk
Copy link
Member

@msynk msynk commented Feb 7, 2025

closes #9821

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced carousel stability by refining its cleanup process and preventing actions once the component is no longer active, reducing potential errors during user interactions.

@coderabbitai
Copy link

coderabbitai bot commented Feb 7, 2025

Walkthrough

This pull request adds a check to prevent actions on a disposed BitCarousel component. The Go method now verifies the component’s disposed state before proceeding, avoiding potential exceptions. Additionally, DisposeAsync is modified to set the disposed flag only once during cleanup. These changes improve error handling and maintain proper component lifecycle management.

Changes

File Path Changes Summary
src/BlazorUI/…/Carousel/BitCarousel.razor.cs Added disposed state check in the Go method; modified DisposeAsync to set disposed flag once and streamlined disposal logic

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Carousel

    Caller->>Carousel: Call Go()
    alt Component disposed (_disposed == true)
        Carousel-->>Caller: Exit early without action
    else Component active (_disposed == false)
        Carousel->>Carousel: Execute navigation logic
        Carousel-->>Caller: Return normal response
    end
Loading
sequenceDiagram
    participant Caller
    participant Carousel

    Caller->>Carousel: Call DisposeAsync()
    Carousel->>Carousel: Set _disposed flag to true
    Carousel-->>Caller: Complete disposal process
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent ObjectDisposedException when accessing Timer in Go (#9821)

Poem

I'm a rabbit coding with glee,
Guarding my carousel safely, you see.
With a disposed check in place,
I hop without a trace of grace.
Bugs retreat from my playful spree!
🐇💻 Happy hops and bug-free dreams!


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
🪧 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (4)
src/BlazorUI/Bit.BlazorUI/Components/Lists/Carousel/BitCarousel.razor.cs (4)

287-287: Consider returning a boolean to indicate operation success.

The disposal check is good, but callers might benefit from knowing if the operation was skipped. This helps with error handling and state management in the calling methods.

-private async Task Go(bool isNext = false, int scrollCount = 0)
+private async Task<bool> Go(bool isNext = false, int scrollCount = 0)
 {
-    if (_disposed) return;
+    if (_disposed) return false;
     if (_othersIndices.Length == 0) return;

     // ... rest of the method ...
+    return true;
 }

446-446: Fix outdated comment referencing incorrect variable name.

The comment refers to _dotnetObjRef but the variable is named _dotnetObj.

-            //_dotnetObjRef.Dispose(); // it is getting disposed in the following js call:
+            //_dotnetObj.Dispose(); // it is getting disposed in the following js call:

447-451: Consider handling all JS exceptions during cleanup.

The code only handles JSDisconnectedException, but other JS exceptions could occur during cleanup.

             try
             {
                 await _js.BitObserversUnregisterResize(_Id, RootElement, _dotnetObj);
             }
-            catch (JSDisconnectedException) { } // we can ignore this exception here
+            catch (JSException) { } // we can ignore JS exceptions during cleanup

438-442: Enhance timer cleanup robustness.

The timer cleanup could be more robust by stopping the timer before disposal and using a null-conditional operator.

         if (_autoPlayTimer is not null)
         {
+            _autoPlayTimer.Stop();
             _autoPlayTimer.Elapsed -= AutoPlayTimerElapsed;
             _autoPlayTimer.Dispose();
+            _autoPlayTimer = null;
         }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3b8a09c and 52a88fa.

📒 Files selected for processing (1)
  • src/BlazorUI/Bit.BlazorUI/Components/Lists/Carousel/BitCarousel.razor.cs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build and test

@msynk msynk merged commit fba8660 into bitfoundation:develop Feb 7, 2025
3 checks passed
@msynk msynk deleted the 9821-blazorui-carousel-ObjectDisposedException branch February 7, 2025 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ObjectDisposedException in the BitCarousel component

3 participants