v4: Fix HandleErrorFunction type

[ericallam]

This should have been changed alongside the changes to the lifecycle hooks but was missed

Summary by CodeRabbit

• Refactor
  • Streamlined the error management workflow to ensure more consistent and robust handling of unexpected issues.
  • Introduced an early exit condition in error handling to prevent unnecessary processing when no hooks are available.

[changeset-bot]

⚠️ No Changeset found

Latest commit: af8d979

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The change updates the type definition for handling errors in the core tasks module. Previously, the HandleErrorFunction was defined with a specific function signature accepting three parameters. It is now redefined to use the generalized AnyOnCatchErrorHookFunction type, simplifying the error-handling function signature. The underlying structure for error arguments (HandleErrorArgs) remains unchanged. Additionally, the #handleError method in the TaskExecutor class has been modified to include an early exit condition for error handling when no hooks are available.

Changes

File	Change Summary
packages/core/.../types/tasks.ts	Updated the HandleErrorFunction type from a specific function signature with three parameters to an alias of AnyOnCatchErrorHookFunction.
packages/core/.../workers/taskExecutor.ts	Enhanced the #handleError method by adding early exit logic based on the availability of error handling hooks, streamlining the error handling flow.

Possibly related PRs

• Pass init output to all error handlers #1441: The changes in the main PR modify the HandleErrorFunction type definition, while the retrieved PR updates the HandleErrorArgs type and the #handleError method signature to include an init parameter, indicating a direct relationship in how error handling is structured.

Poem

I hopped through type fields with glee,
Changing signatures as quick as can be.
My code garden now sings a cleaner tune,
Simplified hooks under the coding moon.
With every leap, my journey feels so bright,
Carrots and code making a joyful night! 🥕🐇

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 020a752 and af8d979.

📒 Files selected for processing (1)

• packages/core/src/v3/workers/taskExecutor.ts (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

packages/core/src/v3/workers/taskExecutor.ts (1)

packages/core/src/v3/lifecycle-hooks-api.ts (1)

• lifecycleHooks (5-5)

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

• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
• GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
• GitHub Check: typecheck / typecheck
• GitHub Check: units / 🧪 Unit Tests

🔇 Additional comments (1)

packages/core/src/v3/workers/taskExecutor.ts (1)

1039-1044: Well-implemented early exit optimization for error handling.

The addition of an early exit condition when no error handling hooks are available is a good optimization. This change correctly retrieves both task-specific and global error handlers, then checks their existence before proceeding with the error handling logic. This prevents unnecessary processing when there are no hooks to execute.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.