Skip to content

Extract client creation logic#37

Merged
leynos merged 2 commits intomainfrom
codex/refactor-graphqlclient-creation-logic
Jul 28, 2025
Merged

Extract client creation logic#37
leynos merged 2 commits intomainfrom
codex/refactor-graphqlclient-creation-logic

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jul 27, 2025

Summary

  • factor out helper to build GraphQLClient with optional transcript
  • reuse helper in run_pr and run_issue

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Extract GraphQLClient creation logic into a shared helper and update run_pr and run_issue to use it for streamlined client initialization with transcript fallback

Enhancements:

  • Add create_client helper to centralize GraphQLClient instantiation with optional transcript and fallback on failure
  • Refactor run_pr and run_issue to use create_client instead of duplicating client setup logic

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jul 27, 2025

Reviewer's Guide

This PR centralizes GraphQLClient initialization by extracting a create_client helper with transcript-fallback logic, and updates run_pr and run_issue to leverage this new function.

Sequence diagram for GraphQLClient creation with transcript fallback

sequenceDiagram
    participant Caller
    participant create_client
    participant GraphQLClient
    Caller->>create_client: create_client(token, transcript)
    create_client->>GraphQLClient: new(token, transcript)
    alt Success
        GraphQLClient-->>create_client: Ok(client)
        create_client-->>Caller: Ok(client)
    else Failure
        GraphQLClient-->>create_client: Err(e)
        create_client->>GraphQLClient: new(token, None)
        alt Success
            GraphQLClient-->>create_client: Ok(client)
            create_client-->>Caller: Ok(client)
        else Failure
            GraphQLClient-->>create_client: Err(e)
            create_client-->>Caller: Err(e)
        end
    end
Loading

Class diagram for extracted client creation logic

classDiagram
    class GraphQLClient {
        +new(token: &str, transcript: Option<PathBuf>) Result<GraphQLClient, VkError>
    }
    class VkError
    class PathBuf
    class create_client {
        +create_client(token: &str, transcript: Option<PathBuf>) Result<GraphQLClient, VkError>
    }
    GraphQLClient <.. create_client : uses
    PathBuf <.. GraphQLClient : transcript
    VkError <.. GraphQLClient : error
    VkError <.. create_client : error
Loading

File-Level Changes

Change Details Files
Extract client initialization into create_client helper
  • Define create_client function that wraps GraphQLClient::new
  • Implement fallback to no transcript on error with a warning
  • Add clippy allow annotations for result_large_err
src/main.rs
Replace inline client creation in run_pr and run_issue
  • Remove match-based GraphQLClient::new blocks in run_pr
  • Remove match-based GraphQLClient::new blocks in run_issue
  • Invoke create_client(token, global.transcript.clone()) with ? error propagation
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

  • Refactor

    • Improved error handling by replacing direct error printing with structured logging for warnings and errors.
    • Centralised client creation logic for better maintainability.
  • Chores

    • Introduced new logging dependencies to enhance application logging capabilities.

Walkthrough

Refactor the client creation logic by introducing a new helper function, build_graphql_client, which encapsulates the process of creating a GraphQLClient with optional transcript support and fallback handling. Replace direct client instantiation in run_pr and run_issue with calls to this helper function. Replace all eprintln! calls with structured logging macros (warn!, error!). Initialise env_logger in main to enable logging.

Changes

Cohort / Files Change Summary
Client creation and logging refactor
src/main.rs
Add build_graphql_client helper to centralise GraphQL client creation with transcript fallback; replace eprintln! with warn! and error!; initialise env_logger in main.
Dependency additions
Cargo.toml
Add log 0.4 and env_logger 0.11 dependencies to enable structured logging and environment-based logger configuration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • Add e2e test harness #36: Introduced transcript support and fallback logic in GraphQL client creation, closely related to this PR’s refactor of client initialization and transcript handling.

Poem

🚀 A helper born to build with care,
Logs warnings now float in the air.
From eprintln! to logs that gleam,
The client’s born from a neat new scheme.
Transcript tries, then falls back light,
Code shines clearer, logging bright!
🦀✨📜


📜 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 2c5ce97 and 0b06356.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • Cargo.toml (1 hunks)
  • src/main.rs (7 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
Cargo.toml

📄 CodeRabbit Inference Engine (AGENTS.md)

Cargo.toml: Use explicit version ranges in Cargo.toml and keep dependencies up-to-date.
Mandate caret requirements for all dependencies: All crate versions specified in Cargo.toml must use SemVer-compatible caret requirements (e.g., some-crate = "1.2.3").
Prohibit unstable version specifiers: The use of wildcard (*), or open-ended inequality (>=) version requirements are strictly forbidden in Cargo.toml. Tilde requirements (~) should only be used where a dependency must be locked to patch-level updates for a specific, documented reason.

Files:

  • Cargo.toml
**/*.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 (13)
Cargo.toml (1)

15-16: LGTM!

The new logging dependencies use proper caret requirements as mandated by the coding guidelines.

src/main.rs (12)

16-16: LGTM!

The log import is correctly added to support the structured logging refactoring.


722-742: Excellent refactoring with proper error handling.

The build_graphql_client helper function effectively centralises client creation logic with appropriate fallback behaviour. The implementation correctly handles I/O errors during transcript creation and uses structured logging for the warning.

The function signature and error handling follow Rust best practices:

  • Uses Result return type for error propagation
  • Employs proper #[expect] attribute with clear reasoning
  • Handles the fallback scenario gracefully

199-199: LGTM!

Proper replacement of eprintln! with structured warn! logging for transcript write failures.


202-202: LGTM!

Correct use of warn! macro for transcript lock failures.


753-753: LGTM!

Appropriate use of warn! for missing GITHUB_TOKEN instead of direct error printing.


756-756: LGTM!

Proper structured logging for locale warnings.


759-759: LGTM!

Excellent use of the new helper function to centralise client creation logic.


776-776: LGTM!

Correct replacement of eprintln! with error! for thread printing failures.


792-792: LGTM!

Consistent use of structured logging for missing GITHUB_TOKEN warnings.


795-795: LGTM!

Proper structured logging for locale warnings.


798-798: LGTM!

Consistent use of the helper function for client creation in run_issue.


840-840: LGTM!

Proper initialisation of the environment logger to enable the structured logging infrastructure.

✨ 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/refactor-graphqlclient-creation-logic

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

Blocking issues:

  • Use of #[allow] is forbidden; use narrowly scoped #[expect(lint, reason = "...")] instead. (link)

General comments:

  • Replace the eprintln! calls with a structured logging macro (e.g., log::warn! or tracing) for consistent and configurable logging.
  • Consider changing create_client to accept a reference to the transcript Option (e.g., &Option) to avoid unnecessary cloning at each call site.
  • Rename create_client to build_graphql_client (or similar) to match the existing build_* naming convention and clarify its purpose.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Replace the eprintln! calls with a structured logging macro (e.g., log::warn! or tracing) for consistent and configurable logging.
- Consider changing create_client to accept a reference to the transcript Option<PathBuf> (e.g., &Option<PathBuf>) to avoid unnecessary cloning at each call site.
- Rename create_client to build_graphql_client (or similar) to match the existing build_* naming convention and clarify its purpose.

## Individual Comments

### Comment 1
<location> `src/main.rs:726` </location>
<code_context>
+/// This attempts to initialize the client with the provided `transcript`.
+/// If the transcript cannot be created, it logs a warning and retries
+/// without one.
+#[allow(
+    clippy::result_large_err,
+    reason = "VkError has many variants but they are small"
</code_context>

<issue_to_address>
Use of `#[allow]` is forbidden; use narrowly scoped `#[expect(lint, reason = "...")]` instead.

The review instructions explicitly forbid the use of `#[allow]`. Please replace this with a narrowly scoped `#[expect(lint, reason = "...")]` and provide a clear reason. Blanket or group lint suppression is not permitted.
</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
@leynos leynos merged commit a851b95 into main Jul 28, 2025
1 check passed
@coderabbitai coderabbitai Bot mentioned this pull request Aug 3, 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