fix(katana-tasks): ensure is cancelled before waiting on shutdown

[kariy]

ref: #2409

Summary by CodeRabbit

• New Features

  • Enhanced the shutdown process to ensure proper cancellation of ongoing tasks before shutdown.

• Bug Fixes

  • Improved robustness of the shutdown procedure to prevent issues with active tasks during shutdown.

[coderabbitai]

Walkthrough

Ohayo, sensei! The changes in the TaskManager implementation primarily focus on enhancing the shutdown method. The method now includes a check to determine if the on_cancel object has already been cancelled. If it has not been cancelled, the method will invoke cancel() on on_cancel to terminate any ongoing tasks before proceeding with the shutdown sequence. The overall flow of the shutdown process remains intact, ensuring that the subsequent calls to wait_for_shutdown, close, and wait are unchanged.

Changes

File Path	Change Summary
crates/katana/tasks/src/manager.rs	Modified pub async fn shutdown(self) to include cancellation logic for on_cancel before shutdown.

Sequence Diagram(s)

sequenceDiagram
    participant TaskManager
    participant OnCancel
    participant Tracker

    TaskManager->>OnCancel: Check if cancelled
    alt Not Cancelled
        TaskManager->>OnCancel: Call cancel()
    end
    TaskManager->>Tracker: wait_for_shutdown()
    TaskManager->>Tracker: close()
    TaskManager->>Tracker: wait()

Loading

Tip

Announcements

• The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
• We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
• Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dbe8ca8 and b7ed118.

Files selected for processing (1)

• crates/katana/tasks/src/manager.rs (1 hunks)

Additional comments not posted (1)

crates/katana/tasks/src/manager.rs (1)

55-58: Ohayo sensei! The changes look good to me.

The added check ensures that cancel() is only called on on_cancel if it is not already cancelled. This prevents redundant cancellations and aligns with the PR objective of ensuring cancellation before waiting on shutdown.

The changes are correctly implemented and do not introduce any issues.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.94%. Comparing base (dbe8ca8) to head (b7ed118).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2412   +/-   ##
=======================================
  Coverage   67.94%   67.94%           
=======================================
  Files         364      364           
  Lines       47767    47770    +3     
=======================================
+ Hits        32456    32459    +3     
  Misses      15311    15311           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.