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

Feat: Improved exception logging #351

Merged
merged 5 commits into from
Sep 2, 2024
Merged

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Sep 1, 2024

Cherry-picked drive-by changes from #350.

Summary by CodeRabbit

  • New Features

    • Enhanced error handling for improved clarity and debugging, including new exceptions for specific error scenarios.
    • Introduced a new error class for handling broken pipe situations, providing guidance for troubleshooting.
  • Bug Fixes

    • Improved exception management in various functions to prevent abrupt failures and provide clearer context for errors.
  • Documentation

    • Updated documentation strings for error classes to better describe their functionalities and contexts.

Copy link

coderabbitai bot commented Sep 1, 2024

Warning

Rate limit exceeded

@aaronsteers has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 40 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between a00d7e9 and 54e9d9b.

Walkthrough

Walkthrough

The changes involve enhancements to error handling across multiple files in the Airbyte codebase. Key modifications include the introduction of specific exception classes, refined error reporting mechanisms, and adjustments to how exceptions are raised and handled in various methods. These updates aim to provide clearer context and improve the robustness of error management within the framework.

Changes

File Path Change Summary
airbyte/_connector_base.py Modified error handling in check and _execute methods; raised AirbyteConnectorFailedError with original_exception instead of log_text, and added context for AirbyteSubprocessFailedError.
airbyte/_executors/base.py Updated _pump_input to handle BrokenPipeError without immediate raising, and refined exception raising in _stream_from_subprocess to improve error management flow.
airbyte/destinations/base.py Changed exception raising in _write_airbyte_message_stream to include original_exception, suppressing the context of the original exception in the traceback.
airbyte/exceptions.py Added AirbyteConnectorBrokenPipeError, enhanced PyAirbyteError with original_exception, and updated guidance and documentation for several error classes to improve clarity and context in error reporting.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Connector
    participant Subprocess
    participant ExceptionHandler

    User->>Connector: Initiate check
    Connector->>ExceptionHandler: Handle AirbyteConnectorFailedError
    ExceptionHandler->>Connector: Raise error with original_exception

    User->>Connector: Execute process
    Connector->>Subprocess: Start subprocess
    Subprocess->>Connector: Return exit code
    Connector->>ExceptionHandler: Handle AirbyteSubprocessFailedError
    ExceptionHandler->>Connector: Raise error with log_text and context
Loading

Tip

Early access features: enabled

We are currently testing the following features in early access:

  • Anthropic claude-3-5-sonnet for code reviews: The new Claude model has stronger code understanding and code generation capabilities than the previous models. We're excited to hear your feedback as we evaluate its performance over the next few days.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues on the discussion post.

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 or @coderabbitai title 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

Outside diff range, codebase verification and nitpick comments (1)
airbyte/_executors/base.py (1)

45-48: Nice addition of BrokenPipeError handling! 👍

This change improves the robustness of the input pumping process. What do you think about adding a debug log here to track when this specific error occurs? It might help with troubleshooting in the future. Something like:

import logging

logger = logging.getLogger(__name__)

# ...

except BrokenPipeError:
    logger.debug("BrokenPipeError occurred in _pump_input")
    exception_holder.set_exception(exc.AirbyteConnectorBrokenPipeError())

WDYT?

airbyte/_executors/base.py Outdated Show resolved Hide resolved
airbyte/_executors/base.py Outdated Show resolved Hide resolved
airbyte/exceptions.py Show resolved Hide resolved
airbyte/exceptions.py Show resolved Hide resolved
airbyte/exceptions.py Outdated Show resolved Hide resolved
airbyte/exceptions.py Show resolved Hide resolved
@aaronsteers aaronsteers enabled auto-merge (squash) September 1, 2024 23:13
@aaronsteers aaronsteers merged commit 9257d4e into main Sep 2, 2024
13 checks passed
@aaronsteers aaronsteers deleted the feat/improved-exception-logging branch September 2, 2024 00:00
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