Improve BadResponse error context

[leynos]

Summary

• attach context string to VkError::BadResponse
• report missing GraphQL data or comment nodes
• derive Debug for GraphQlResponse

Testing

• cargo fmt
• make lint
• make test

---

https://chatgpt.com/codex/tasks/task_e_68862b79e02883228c52432e6dc03ecd

Summary by Sourcery

Enhance BadResponse errors to include contextual debug information, improve reporting for missing GraphQL data and comment nodes, and derive Debug for GraphQlResponse

Enhancements:

• Convert VkError::BadResponse into a tuple variant carrying a context string
• Include detailed response debug output when data is missing in GraphQLClient
• Add specific error context for missing comment nodes in fetch_comment_page
• Derive Debug for GraphQlResponse to enable formatted response inspection

[sourcery-ai]

Reviewer's Guide

This PR enriches error reporting for malformed or incomplete API responses by extending the BadResponse variant to carry a context string, deriving Debug for GraphQlResponse, and updating client code to attach detailed debug information when data or comment nodes are missing.

Sequence diagram for improved error context in GraphQLClient::run_query

sequenceDiagram
    participant Client as GraphQLClient
    participant API as GraphQL API
    participant Error as VkError
    Client->>API: Send GraphQL query
    API-->>Client: Return response (resp)
    alt resp.errors is Some
        Client->>Error: handle_graphql_errors(errs)
        Client-->>Client: Return error
    else resp.data is None
        Client->>Error: VkError::BadResponse("Missing data in response: {resp:?}")
        Client-->>Client: Return error
    else resp.data is Some
        Client->>Client: Deserialize data
    end

Loading

Sequence diagram for improved error context in fetch_comment_page

sequenceDiagram
    participant fetcher as fetch_comment_page
    participant Client as GraphQLClient
    participant Error as VkError
    fetcher->>Client: run_query(COMMENT_QUERY, ...)
    Client-->>fetcher: CommentNodeWrapper
    alt wrapper.node is None
        fetcher->>Error: VkError::BadResponse("Missing comment node in response")
        fetcher-->>fetcher: Return error
    else wrapper.node is Some
        fetcher->>fetcher: Access comments
    end

Loading

File-Level Changes

Change	Details	Files
Extend BadResponse to carry a contextual message	Changed BadResponse from a unit variant to BadResponse(String) Updated its error attribute to #[error("bad response: {0}")]	src/main.rs
Enable Debug on GraphQlResponse	Added Debug to the derive list for GraphQlResponse	src/main.rs
Attach detailed context when response data or comment nodes are missing	Inserted a resp_debug string by formatting the full response with {:?} Replaced ok_or with ok_or_else for missing data, using resp_debug in the error message Replaced ok_or with ok_or_else for missing comment node, providing a descriptive message	src/main.rs

---

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!

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.

[coderabbitai]

Summary by CodeRabbit

• Bug Fixes

  • Improved error messages by including detailed context when certain response fields are missing, making it easier to understand issues when they occur.

• Other Improvements

  • Enhanced error reporting for failed responses and added support for better debugging information.

Walkthrough

Update the VkError::BadResponse enum variant to carry a string message for richer error context. Enhance error reporting in both run_query and fetch_comment_page by including detailed debug information. Derive the Debug trait for GraphQlResponse to facilitate improved diagnostics.

Changes

File(s)	Change Summary
src/main.rs	Change VkError::BadResponse to carry a String message; derive Debug for GraphQlResponse; update error reporting in run_query and fetch_comment_page to include detailed context strings.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant GraphQLClient
    participant Server

    Caller->>GraphQLClient: run_query(query)
    GraphQLClient->>Server: send GraphQL query
    Server-->>GraphQLClient: GraphQL response
    GraphQLClient->>GraphQLClient: Format response as debug string
    alt data present
        GraphQLClient-->>Caller: Return data
    else data missing
        GraphQLClient-->>Caller: Return VkError::BadResponse(debug string)
    end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

• Fix GraphQL decode failure #34: Both PRs enhance error handling in run_query by modifying how BadResponse errors are reported, though this PR focuses on adding context strings while the related PR introduces a separate variant for deserialization errors.

Poem

When errors arise and things go wrong,
Let context and messages make them strong.
With debug in tow and strings in the fray,
Troubles are clearer, no more dismay!
🐛➡️💡

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd5a834 and 71bb0c4.

📒 Files selected for processing (1)

• src/main.rs (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rs

📄 CodeRabbit Inference Engine (AGENTS.md)

**/*.rs: Every module must begin with a module level (//!) comment explaining the module's purpose and utility.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Place function attributes after doc comments.
Do not use return in single-line functions.
Use predicate functions for conditional criteria with more than two branches.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Prefer semantic error enums: Derive std::error::Error (via the thiserror crate) for any condition the caller might inspect, retry, or map to an HTTP status.
Use an opaque error only at the app boundary: Use eyre::Report for human-readable logs; these should not be exposed in public APIs.
Never export the opaque type from a library: Convert to domain enums at API boundaries, and to eyre only in the main main() entrypoint or top-level async task.
Clippy warnings MUST be disallowed.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Write unit and behavioural tests for new functionality. Run both before and after making any change.
Avoid unsafe code unless absolutely necessary and document any usage clearly.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Prefer expect over allow.
Prefer .expect() over .unwrap().
Use concat!() to combine long string literals rather than escaping newlines with a backslash.

Files:

• src/main.rs

---

⚙️ CodeRabbit Configuration File

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

• Adhere to single responsibility and CQRS

• Place function attributes after doc comments.

• Do not use return in single-line functions.

• Move conditionals with >2 branches into a predicate function.

• Avoid unsafe unless absolutely necessary.

• Every module must begin with a //! doc comment that explains the module's purpose and utility.

• Comments and docs must follow en-GB-oxendict (-ize / -our) spelling and grammar

• Lints must not be silenced except as a last resort.

  • #[allow] is forbidden.
  • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
  • No lint groups, no blanket or file-wide suppression.
  • Include FIXME: with link if a fix is expected.

• Use rstest fixtures for shared setup and to avoid repetition between tests.

• Replace duplicated tests with #[rstest(...)] parameterised cases.

• Prefer mockall for mocks/stubs.

• Prefer .expect() over .unwrap()

• Ensure that any API or behavioural changes are reflected in the documentation in docs/

• Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

• Files must not exceed 400 lines in length

  • Large modules must be decomposed
  • Long match statements or dispatch tables should be decomposed by domain and collocated with targets
  • Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.

Files:

• src/main.rs

🔇 Additional comments (3)

src/main.rs (3)

89-90: Well-implemented error context enhancement.

The change from a unit variant to a string-carrying variant improves error diagnostics significantly. The error message formatting is correct and follows Rust conventions.

---

112-112: Necessary Debug derivation for enhanced error reporting.

Adding Debug to GraphQlResponse<T> enables the debug formatting used in error messages. This is a correct and minimal change.

---

176-183: Excellent error context enhancement.

Creating the debug representation early and including it in the error message provides valuable debugging information when GraphQL responses lack data. The implementation correctly captures the response state before processing.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/update-vkerror-badresponse-for-better-context

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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 generate unit tests to generate unit tests 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 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.

[sourcery-ai]

Hey @leynos - I've reviewed your changes and found some issues that need to be addressed.

Prompt for AI Agents

Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/main.rs:377` </location>
<code_context>
-    let conn = wrapper.node.ok_or(VkError::BadResponse)?.comments;
+    let conn = wrapper
+        .node
+        .ok_or_else(|| VkError::BadResponse("Missing comment node in response".into()))?
+        .comments;
     Ok((conn.nodes, conn.page_info))
</code_context>

<issue_to_address>
Error message for missing comment node could include more context.

Consider including the id or cursor in the error message to make debugging easier.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
    let conn = wrapper
        .node
        .ok_or_else(|| VkError::BadResponse("Missing comment node in response".into()))?
        .comments;
=======
    let conn = wrapper
        .node
        .ok_or_else(|| {
            VkError::BadResponse(format!(
                "Missing comment node in response (id: {}, cursor: {})",
                id,
                cursor.as_deref().unwrap_or("None")
            ))
        })?
        .comments;
>>>>>>> REPLACE

</suggested_fix>

---

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