feat(ux): improve connection error reporting

[abn]

After (non-verbose)

After (verbose)

Summary by Sourcery

Improve connection error reporting by providing more context and potential causes for the error.

Bug Fixes:

• Fixed an issue where connection errors provided insufficient information about the cause of the failure.

Enhancements:

• Improved the error messages for connection errors to include more helpful information.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request improves the error reporting for connection errors in Poetry. It provides more context to the user about the possible causes of the error, such as DNS resolution issues or network connectivity problems. Additionally, it modifies the generic HTTP error message to include the HTTP method and URL.

Sequence diagram for improved connection error handling

sequenceDiagram
    participant User as User
    participant Poetry as Poetry Client
    participant Server as Remote Server

    User->>Poetry: Execute command requiring HTTP request
    activate Poetry
    Poetry->>Server: Attempt HTTP request
    alt Connection fails
        Server--xPoetry: Connection error
        Poetry->>Poetry: Create detailed error message
        Poetry-->>User: Display formatted error with:
        Note right of User: - Failed URL
        Note right of User: - Possible causes:
        Note right of User: * Server not responding
        Note right of User: * DNS resolution issue
        Note right of User: * Network connectivity
    end
    deactivate Poetry

Loading

Class diagram showing PoetryRuntimeError modifications

classDiagram
    class PoetryRuntimeError {
        -_messages: List[ConsoleMessage]
        +create(reason: str, exception: Exception) PoetryRuntimeError
        +append(message: str|ConsoleMessage) PoetryRuntimeError
    }
    class ConsoleMessage {
        +indent(prefix: str) ConsoleMessage
        +make_section(title: str) ConsoleMessage
        +wrap(style: str) ConsoleMessage
    }
    PoetryRuntimeError ..> ConsoleMessage : uses

Loading

File-Level Changes

Change	Details	Files
Improve connection error reporting by providing more context to the user.	Catch connection errors and create a PoetryRuntimeError with a detailed message. Include possible causes of the connection error in the error message.	src/poetry/utils/authenticator.py
Modify the generic HTTP error message to include the HTTP method and URL.	Update the generic HTTP error message to include the HTTP method and URL.	src/poetry/utils/authenticator.py
Add an append method to the PoetryRuntimeError class.	Add a new test case for the append method of PoetryRuntimeError. Implement the append method in the PoetryRuntimeError class.	tests/console/test_exections_poetry_runtime_error.py src/poetry/console/exceptions.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @abn - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟡 Security: 1 issue found
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

Review comments implemented.