timeout height task should be canceled after deleting client

[apri-me]

In case you should re initialize your injective async client multiple times, deleting the client won't stop sync timeout height task and it may increase the risk of memory leakage in the main program.

This two line makes sure when the client is no longer used, the timeout syncing will be stopped.

Summary by CodeRabbit

• Bug Fixes
  • Improved resource management by ensuring asynchronous tasks are properly canceled when an AsyncClient instance is deleted, preventing potential memory leaks.

[coderabbitai]

Walkthrough

The changes introduce a destructor method __del__ to the AsyncClient class in pyinjective/async_client.py. This method is designed to cancel the timeout height synchronization task when an instance of AsyncClient is deleted, thereby improving resource management and preventing memory leaks. No other functionalities, parameters, or return types of existing methods have been altered, and the overall structure of the class remains intact.

Changes

File	Change Summary
pyinjective/async_client.py	Added destructor method __del__ to AsyncClient class for task cancellation on deletion.

Sequence Diagram(s)

sequenceDiagram
    participant Client as AsyncClient
    participant Task as Timeout Height Sync Task

    Client->>Task: Start synchronization task
    Client->>Client: Instance is deleted
    Client->>Task: Call __del__()
    Task-->>Client: Cancel synchronization task

Loading

🐇 "In the meadow where bunnies play,
A new method hops in, hooray!
When the client takes its leave,
The task won't linger, it shall cleave.
With a wiggle and a bound,
Memory leaks won't be found!" 🐇

---

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

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

🧹 Outside diff range and nitpick comments (1)

pyinjective/async_client.py (1)

3466-3467: LGTM! The destructor ensures proper cleanup of the timeout height task.

The implementation correctly cancels the timeout height synchronization task when the AsyncClient instance is deleted, preventing potential memory leaks. The code reuses the existing _cancel_timeout_height_sync_task() method which safely handles the cleanup.

Consider adding a debug log statement to help with troubleshooting:

def __del__(self):
+    LoggerProvider().logger_for_class(logging_class=self.__class__).debug("Cleaning up AsyncClient instance")
    self._cancel_timeout_height_sync_task()

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cc6beec and 650acab.

📒 Files selected for processing (1)

• pyinjective/async_client.py (1 hunks)