Skip to content

fix: give logs a second to flush #660

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

Merged
merged 1 commit into from
Apr 16, 2025

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Apr 16, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved reliability of log output by ensuring logs are flushed before error messages are shown when a connector check fails.

@aaronsteers aaronsteers requested a review from Copilot April 16, 2025 06:04
@aaronsteers aaronsteers marked this pull request as ready for review April 16, 2025 06:04
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

airbyte/_connector_base.py:329

  • Using sleep(1) may not guarantee that logs are flushed in all environments; consider using an explicit log flush method or making the delay configurable to better ensure logs are output before error raising.
sleep(1)

Copy link
Contributor

coderabbitai bot commented Apr 16, 2025

📝 Walkthrough

Walkthrough

This change introduces a one-second pause after logging a failed connector check in the check method of airbyte/_connector_base.py. The pause is implemented using the sleep function from the time module and occurs immediately before raising the AirbyteConnectorCheckFailedError exception. No other logic or public interfaces are altered.

Changes

File(s) Change Summary
airbyte/_connector_base.py Imported sleep from time and added sleep(1) after logging a failed check, before raising an exception.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Connector
    participant Logger

    User->>Connector: check()
    Connector->>Connector: Perform check logic
    alt Check fails
        Connector->>Logger: Log failure
        Connector->>Connector: sleep(1)
        Connector->>User: Raise AirbyteConnectorCheckFailedError
    else Check succeeds
        Connector->>User: Return success
    end
Loading

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ 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
🪧 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 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 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
Contributor

@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: 0

🧹 Nitpick comments (1)
airbyte/_connector_base.py (1)

328-329: Nice touch adding a pause to help logs flush!

Adding sleep(1) after logging and before raising the exception is a pragmatic way to help ensure logs are visible before the process potentially exits. Would you consider either making the delay configurable (maybe via an optional parameter or class attribute), or adding a brief comment explaining why 1 second was chosen? This might help future maintainers understand the rationale and adjust if needed. Wdyt?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1b339b2 and 5611bef.

📒 Files selected for processing (1)
  • airbyte/_connector_base.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Pytest (All, Python 3.11, Windows)
  • GitHub Check: Pytest (All, Python 3.11, Ubuntu)
  • GitHub Check: Pytest (No Creds)
  • GitHub Check: Pytest (All, Python 3.10, Windows)
  • GitHub Check: Pytest (Fast)
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)
🔇 Additional comments (1)
airbyte/_connector_base.py (1)

9-9: Import of sleep from time looks good!

This import is minimal and directly supports the new logic. No concerns here.

@aaronsteers aaronsteers enabled auto-merge (squash) April 16, 2025 06:06
@aaronsteers aaronsteers merged commit 3eda2e3 into main Apr 16, 2025
20 of 21 checks passed
@aaronsteers aaronsteers deleted the aj/fix/give-logs-a-second-to-flush branch April 16, 2025 06:51
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