Skip to content

Fix: Fail early when database server does not respond #711

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

amotl
Copy link
Member

@amotl amotl commented May 6, 2025

Problem

@shraik started using sqlalchemy-cratedb and reported that its behaviour deviates from other vendors by not failing on engine.connect() when the database server is not available.

We found this is not actually on the SQLAlchemy dialect, but on the DBAPI driver already, which exhibits the same behaviour.

Solution

The patch extends the _lowest_server_version method to re-raise the last ConnectionError when no connection can be made to any configured server node. By doing it this way, we didn't need to submit a dummy SQL command like planned. It is much better this way because it does not pollute the server-side statement log.

/cc @surister

@amotl amotl requested review from seut and kneth May 6, 2025 21:42
Copy link

coderabbitai bot commented May 6, 2025

"""

Walkthrough

The changes update the connection logic to fail early when the database server is unresponsive, by raising the last encountered connection error if no valid server version is found. The changelog is updated to reflect this. Additionally, a new test is introduced to verify that connection errors are properly raised for invalid server addresses.

Changes

File(s) Change Summary
CHANGES.rst Added changelog entry about early failure on unresponsive database server.
src/crate/client/connection.py Modified _lowest_server_version to raise last ConnectionError if no server is reachable.
tests/client/test_connection.py Added test to assert that a ConnectionError is raised for invalid server addresses.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Connection
    participant Server

    Client->>Connection: connect()
    loop For each server
        Connection->>Server: request server version
        alt Server responds with version
            Connection->>Connection: store version if valid
        else Server not available (ConnectionError)
            Connection->>Connection: store last ConnectionError
        else Invalid version (ValueError/InvalidVersion)
            Connection->>Connection: ignore and continue
        end
    end
    alt No valid server version found and ConnectionError occurred
        Connection-->>Client: raise last ConnectionError
    else Valid server version found
        Connection-->>Client: proceed with connection
    end
Loading

Poem

In tunnels deep, connections seek,
To servers strong or servers weak.
Now if a host just will not play,
We fail up front—no more delay!
A test ensures the right alarm,
No silent errors, just clear charm.
🐇✨
"""


📜 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 d84fa0a and def7e66.

📒 Files selected for processing (3)
  • CHANGES.rst (1 hunks)
  • src/crate/client/connection.py (2 hunks)
  • tests/client/test_connection.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • CHANGES.rst
  • tests/client/test_connection.py
  • src/crate/client/connection.py
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Python: 3.12 on macos-latest
  • GitHub Check: Python: 3.11 on macos-latest
  • GitHub Check: Python: 3.13 on ubuntu-22.04
  • GitHub Check: Python: 3.12 on ubuntu-22.04
  • GitHub Check: Python: 3.11 on ubuntu-22.04
  • GitHub Check: Python: 3.10 on ubuntu-22.04
  • GitHub Check: Python: 3.9 on ubuntu-22.04
  • GitHub Check: Python: 3.8 on ubuntu-22.04
  • GitHub Check: Python: 3.7 on ubuntu-22.04
  • GitHub Check: Run link checker
✨ 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.

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.

@amotl amotl force-pushed the fail-on-connect branch from d84fa0a to def7e66 Compare May 6, 2025 22:25
@amotl amotl marked this pull request as draft May 7, 2025 02:49
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