Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add and use new internal error for very outdated SDK versions #1453

Merged
merged 2 commits into from
Nov 1, 2024

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Nov 1, 2024

Runs locked to very old SDK versions < beta.25 would previously get stuck in a queued state. This will crash those runs instead and advise uprading to latest.

Summary by CodeRabbit

  • New Features

    • Introduced an error handling mechanism for outdated SDKs, providing users with specific error messages and guidance to update their SDK for continued compatibility.
    • Added a new documentation link for upgrading to the latest beta version.
  • Bug Fixes

    • Enhanced error reporting for task failures related to outdated SDK versions, improving overall robustness.
  • Documentation

    • Updated error messages and documentation links to assist users in understanding and resolving SDK-related issues.

Copy link

changeset-bot bot commented Nov 1, 2024

🦋 Changeset detected

Latest commit: a3abd07

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 10 packages
Name Type
@trigger.dev/core Patch
@trigger.dev/build Patch
trigger.dev Patch
@trigger.dev/sdk Patch
@internal/redis-worker Patch
@internal/zod-worker Patch
@trigger.dev/react-hooks Patch
@trigger.dev/database Patch
@trigger.dev/otlp-importer Patch
@internal/testcontainers Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link
Contributor

coderabbitai bot commented Nov 1, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes implement an error handling mechanism for outdated SDKs in the @trigger.dev/core package. This includes the addition of a specific error message for outdated SDK versions, modifications to control flow for error checks, and enhancements to error reporting in the SharedQueueConsumer class. New error codes and documentation links are introduced, providing users with guidance on updating their SDK. Overall, the changes improve the granularity and clarity of error handling related to SDK compatibility.

Changes

File Path Change Summary
.changeset/giant-mugs-clean.md Added error handling for outdated SDKs in @trigger.dev/core, including a specific error message.
apps/webapp/app/v3/marqs/sharedQueueConsumer.server.ts Imported TaskRunErrorCodes and refined error handling in #doWorkInternal for outdated SDKs.
packages/core/src/v3/errors.ts Introduced OUTDATED_SDK_VERSION error code, updated related functions for enhanced error handling.
packages/core/src/v3/links.ts Added upgrade property with a link to upgrade documentation for the beta version.
packages/core/src/v3/schemas/common.ts Added "OUTDATED_SDK_VERSION" to TaskRunInternalError enum for specific error identification.

Possibly related PRs

🐰 "In the meadow where errors abound,
A new code was found, oh so profound!
Outdated SDKs, no longer a plight,
With messages clear, we'll set things right.
Hop along, dear friends, to update your way,
For smoother paths in the light of day!" 🌼


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

@nicktrn nicktrn merged commit 58def05 into main Nov 1, 2024
0 of 7 checks passed
@nicktrn nicktrn deleted the feat/outdated-sdk-error branch November 1, 2024 15:41
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.

1 participant