Skip to content

Fix GraphQL decode failure#34

Merged
leynos merged 2 commits intomainfrom
codex/fix-runtime-error-in-pull-request-code
Jul 27, 2025
Merged

Fix GraphQL decode failure#34
leynos merged 2 commits intomainfrom
codex/fix-runtime-error-in-pull-request-code

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 27, 2025

Summary

  • handle errors from GitHub GraphQL API before attempting to decode

Testing

  • make fmt
  • make lint
  • make test
  • make markdownlint
  • make nixie (fails: too many arguments)

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

Summary by Sourcery

Improve GraphQLClient error handling by deferring data decoding until after checking for API errors and exposing decoding failures with a new error variant

Bug Fixes:

  • Prevent silent decode failures by explicitly handling Serde errors when converting JSON data into the expected type

Enhancements:

  • Add BadResponseSerde error variant to represent JSON deserialization failures
  • Modify GraphQLClient.query to first deserialize response into a Value, check for GraphQL errors, then map to the target type with error mapping

Parse untyped JSON first so we surface API error messages instead of decode failures.
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 27, 2025

Reviewer's Guide

Improves error handling in GraphQLClient by returning API errors immediately, using an intermediate serde_json::Value for response data, preserving the original request context, and mapping JSON decoding failures to a unified BadResponseSerde error variant.

Sequence diagram for improved GraphQLClient error handling

sequenceDiagram
    participant Client as GraphQLClient
    participant HTTP as HTTP Server
    participant VkError

    Client->>HTTP: POST GraphQL query
    HTTP-->>Client: JSON response
    alt Response contains errors
        Client->>VkError: handle_graphql_errors(errors)
        Client-->>Client: Return VkError::ApiErrors
    else Response contains data
        Client->>Client: serde_json::from_value(data)
        alt Decoding fails
            Client->>VkError: BadResponseSerde(error)
            Client-->>Client: Return VkError::BadResponseSerde
        else Decoding succeeds
            Client-->>Client: Return Ok(result)
        end
    end
Loading

File-Level Changes

Change Details Files
Introduce new error variant for decoding failures
  • Added VkError::BadResponseSerde(String) to capture serde_json errors
src/main.rs
Use serde_json::Value as intermediate response type
  • Changed GraphQlResponse generic from T to serde_json::Value
  • Extract raw JSON value before attempting type-specific decoding
src/main.rs
Preserve request context on HTTP errors
  • Cloned ctx when mapping client.post errors to VkError::RequestContext
src/main.rs
Map decode failures to unified error
  • Replaced direct resp.data.ok_or with serde_json::from_value mapping to BadResponseSerde
  • Ensure API errors are returned before decoding
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

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 27, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling for deserialisation issues when processing responses, providing clearer error messages if response data cannot be interpreted correctly.

Walkthrough

Update the run_query method in the GraphQLClient implementation to introduce a two-step deserialization process: first into a generic JSON value, then into the target type. Adjust error handling to clone the context string before passing it to error variants. No changes to the method signature.

Changes

File(s) Change Summary
src/main.rs Refactor run_query to first deserialize into GraphQlResponse<serde_json::Value>, then into target type. Add BadResponseSerde(String) error variant. Clone context string in error handling.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

  • Refactor issue parsing and add GraphQL helper #18: Both PRs involve changes to a run_query function for GraphQL querying, but this PR refactors the method's internal deserialization, while the related PR introduces a new standalone generic function and broader refactoring.

Poem

Through JSON’s maze the query flies,
Two-step dance before your eyes.
Clone the context, catch each slip,
Errors handled—none shall trip.
GraphQL’s secrets now revealed,
With careful code, the bugs are healed!


📜 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 efbf2d8 and f81b61d.

📒 Files selected for processing (1)
  • src/main.rs (3 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)

91-92: Well implemented error variant addition.

The BadResponseSerde(String) variant properly addresses the previous concern about preserving deserialization error context whilst maintaining consistency with the existing error enum pattern.


158-158: Correct implementation of two-step deserialization.

Changing the initial deserialization target to serde_json::Value properly enables error checking before attempting typed deserialization, preventing decode failures when the API returns error responses.


172-172: Proper ownership handling for error context.

Cloning the context string ensures it's available for both error handling paths whilst maintaining clear ownership semantics.

✨ 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/fix-runtime-error-in-pull-request-code

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

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

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:179` </location>
<code_context>
-        resp.data.ok_or(VkError::BadResponse)
+
+        let value = resp.data.ok_or(VkError::BadResponse)?;
+        serde_json::from_value(value).map_err(|_| VkError::BadResponse)
     }
 }
</code_context>

<issue_to_address>
Mapping all deserialization errors to VkError::BadResponse may lose error context.

Consider preserving the original serde_json::from_value error message in VkError::BadResponse or another error variant to improve debugging and troubleshooting.

Suggested implementation:

```rust
        let value = resp.data.ok_or(VkError::BadResponse)?;
        serde_json::from_value(value).map_err(|e| VkError::BadResponseSerde(e.to_string()))

```

1. Update the `VkError` enum definition to add a new variant:
   ```rust
   VkError::BadResponseSerde(String)
   ```
2. Update any error handling or matching logic elsewhere in the codebase that expects only `VkError::BadResponse` to also handle `VkError::BadResponseSerde`.
3. Optionally, implement `Display`/`Error` for the new variant if not already handled.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread src/main.rs Outdated
Copy link
Copy Markdown

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cd587a7 and efbf2d8.

📒 Files selected for processing (1)
  • src/main.rs (2 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 (2)
src/main.rs (2)

156-156: Approve the intermediate deserialization approach.

The change to deserialize into GraphQlResponse<serde_json::Value> correctly implements the first step of the two-step process, allowing error handling before final type conversion.


170-170: Correct ownership handling in error paths.

Cloning the context string ensures both error branches can access it without violating Rust's ownership rules.

Comment thread src/main.rs Outdated
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jul 27, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

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:180` </location>
<code_context>
         }
-        resp.data.ok_or(VkError::BadResponse)
+
+        let value = resp.data.ok_or(VkError::BadResponse)?;
+        serde_json::from_value(value).map_err(|e| VkError::BadResponseSerde(e.to_string()))
     }
</code_context>

<issue_to_address>
Error variant for missing data may not provide enough context.

Consider including relevant response details in VkError::BadResponse to improve debugging.

Suggested implementation:

```rust
        let value = resp.data.ok_or_else(|| {
            VkError::BadResponse(format!("Missing data in response: {:?}", resp))
        })?;
        serde_json::from_value(value).map_err(|e| VkError::BadResponseSerde(e.to_string()))

```

1. You must update the definition of `VkError::BadResponse` to accept a `String` (or other suitable type) for context, e.g.:
   ```rust
   BadResponse(String)
   ```
2. Update all other usages and match arms for `VkError::BadResponse` to handle the new parameter.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread src/main.rs
@leynos leynos merged commit 0fa85d8 into main Jul 27, 2025
1 check passed
@coderabbitai coderabbitai Bot mentioned this pull request Aug 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant