Fix #1955: schemaTask parse payload failures handled gracefully

[ericallam]

Summary by CodeRabbit

• Bug Fixes

  • Improved error handling for payload parsing failures to ensure errors are reported clearly and retries are skipped when appropriate.

• Tests

  • Added a test to verify that task execution returns an immediate error when payload parsing fails, and that the task's main function is not executed in such cases.

[changeset-bot]

⚠️ No Changeset found

Latest commit: df648cc

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.

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 changes introduce enhanced error handling for payload parsing in the TaskExecutor class. If payload parsing fails, the error is now caught, recorded, and an error result is returned with a flag to skip retrying. Tests are updated to verify this behavior, and a helper function's instantiation is slightly modified.

Changes

File(s)	Change Summary
packages/core/src/v3/workers/taskExecutor.ts	Updated payload parsing in TaskExecutor to use tryCatch, handle errors, and add skippedRetrying flag to error results. The private method #internalErrorResult now accepts an optional skippedRetrying parameter.
packages/core/test/taskExecutor.test.ts	Added a test case to verify error handling when parsePayload throws, ensuring run is not called and retrying is skipped. Modified ConsoleInterceptor instantiation to add a third argument.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant TaskExecutor
    participant TracingSpan
    participant Task

    Caller->>TaskExecutor: execute(payload)
    TaskExecutor->>TaskExecutor: tryCatch(parsePayload)
    alt ParsePayload succeeds
        TaskExecutor->>Task: run(parsedPayload)
        Task-->>TaskExecutor: result
        TaskExecutor-->>Caller: return result
    else ParsePayload fails
        TaskExecutor->>TracingSpan: recordException(error)
        TaskExecutor-->>Caller: return error result (skippedRetrying: true)
    end

Loading

Poem

In the warren of code, a bug did hop,
Payload parsing tripped—oh, what a flop!
Now errors are caught, with retries skipped,
The task’s main run never even equipped.
With careful new checks, the code’s more robust—
A rabbit’s delight, in error handling we trust! 🐇✨

---

📜 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 7be07b4 and df648cc.

📒 Files selected for processing (2)

• packages/core/src/v3/workers/taskExecutor.ts (3 hunks)
• packages/core/test/taskExecutor.test.ts (2 hunks)

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

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

🔇 Additional comments (5)

packages/core/test/taskExecutor.test.ts (2)

1813-1842: Excellent test coverage for parse payload error handling!

This test successfully verifies that when a task's parsePayload function throws an error, the system:

1. Returns an appropriate error result with the correct error type and code
2. Properly formats the error message to show it's a payload parsing issue
3. Sets skippedRetrying: true to avoid unnecessary retry attempts
4. Doesn't execute the task's run function

This is a good implementation of the issue fix mentioned in PR #1955.

---

1862-1866: ConsoleInterceptor constructor usage updated correctly.

The additional false parameter matches the expected signature for the ConsoleInterceptor constructor. This ensures that console output isn't captured during tests unless specifically needed.

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

146-160: Good implementation of graceful payload parsing error handling.

This change properly wraps the payload parsing in a tryCatch block to capture errors during schema validation. When a parsing error occurs, it's recorded on the tracing span and an appropriate error response is generated with skippedRetrying: true to prevent wasteful retry attempts.

This approach aligns with the existing error handling patterns in the codebase while adding specific handling for payload parsing failures.

---

1386-1391: Well-structured method signature update.

The #internalErrorResult method has been properly updated to accept an optional skippedRetrying parameter, maintaining backward compatibility with existing calls while supporting the new error handling functionality.

---

1406-1406: Correctly implemented in the result object.

The skippedRetrying flag is properly included in the error result object, which will inform consumers of the API whether retrying the operation would be beneficial.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.