(imp) fastapi: GraphQLRouter typing

[alexey-pelykh]

Description

Seems like fastapi's GraphQLRouter is sort-of generic with Context and RootValue being non-passable explicitly.

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Documentation

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Summary by Sourcery

Enhancements:

• Improve type hinting for the FastAPI GraphQLRouter.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request enhances the typing of FastAPI's GraphQLRouter by making Context and RootValue explicitly generic. It refines the type annotations in the class definition and methods, ensuring more robust typing support. Additionally, a release note is added to document this patch.

Updated Class diagram for GraphQLRouter Enhancement

classDiagram
    %% Base classes and interfaces
    class APIRouter
    class Generic

    %% GraphQLRouter definition
    class GraphQLRouter {
        +bool allow_queries_via_get
        +ASGIRequestAdapter request_adapter_class
        +__get_context_getter(custom_getter: Union[Callable[..., Optional[Context>], Callable[..., Awaitable[Optional[Context>>): Callable[..., Awaitable[CustomContext]]
        +__init__(root_value_getter: Optional[Callable[[], RootValue]], context_getter: Union[None, Callable[..., Optional[Context]], Callable[..., Awaitable[Optional[Context]]]], ...)
    }

    %% Inheritance and generic usage
    GraphQLRouter --|> APIRouter : inherits
    GraphQLRouter ..> Generic : generic{Context, RootValue}

Loading

File-Level Changes

Change	Details	Files
Refactored GraphQLRouter typing to be generic for Context and RootValue	Added Generic import and included Generic[Context, RootValue] in the GraphQLRouter class definition Refined the type annotations in __get_context_getter by unifying the callable signatures Updated the signature of context_getter parameter in init to allow None, a synchronous or asynchronous callable returning an Optional Context	strawberry/fastapi/router.py
Documented the release changes	Added a RELEASE.md file with a patch release note detailing the changes to GraphQLRouter typing	RELEASE.md

Possibly linked issues

• mypy: Need type annotation for "graphql_app" [var-annotated] #2711: The PR fixes the mypy error reported in the issue by improving the typing of GraphQLRouter, making the issue no longer relevant.

---

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 @alexey-pelykh - I've reviewed your changes - here's some feedback:

Overall Comments:

• It's great to see the RELEASE.md file updated with the release type and a brief description of the changes.
• Consider adding a test case that specifically checks the typing of the GraphQLRouter with custom Context and RootValue types.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 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.}

[sourcery-ai]

suggestion: Clarify generic parameters and add an example

It would be helpful to clarify what these generic parameters are (e.g., Context and RootValue) and provide a short example of how this change affects users. This would make the release notes more informative and easier to understand.

[botberry]

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

---

This release adjusts the fastapi GraphQLRouter typing to redeclare
Context and RootValue as generic parameters.

Here's the tweet text:

🆕 Release (next) is out! Thanks to @alexey_pelykh for the PR 👏

Get it here 👉 https://strawberry.rocks/release/(next)

[alexey-pelykh]

@bellini666 sort-of a follow-up on #3763 - what's your opinion?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.24%. Comparing base (4c4e07b) to head (e1e3986).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3781   +/-   ##
=======================================
  Coverage   97.24%   97.24%           
=======================================
  Files         502      503    +1     
  Lines       33481    33495   +14     
  Branches     1714     1714           
=======================================
+ Hits        32558    32572   +14     
  Misses        706      706           
  Partials      217      217           

[codspeed-hq]

CodSpeed Performance Report

Merging #3781 will not alter performance

_{Comparing alexey-pelykh:imp/fastapi/router-typing (e1e3986) with main (4c4e07b)}

Summary

✅ 21 untouched benchmarks