fix(fastapi): context_getter signature to allow Awaitable

[alexey-pelykh]

Description

The context_getter is further passed to

strawberry/strawberry/fastapi/router.py

Lines 69 to 71 in 7ba5928

	custom_getter: Callable[
	..., Union[Optional[CustomContext], Awaitable[Optional[CustomContext]]]
	],

so

strawberry/strawberry/fastapi/router.py

Line 128 in 7ba5928

context_getter: Optional[Callable[..., Optional[Context]]] = None,

should likely have the same signature

Types of Changes

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

Issues Fixed or Closed by This PR

• Fixes context_getter signature does not offer passing Awaitable #3762

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

Bug Fixes:

• Fix an issue where context getters were not awaited properly.

[sourcery-ai]

Reviewer's Guide by Sourcery

The pull request modifies the signature of the context_getter in the FastAPI router to allow for an Awaitable return type. This change aligns the signature with how the context_getter is used in the process_result method.

Sequence diagram showing context getter usage in FastAPI router

sequenceDiagram
    participant Client
    participant Router as GraphQLRouter
    participant ContextGetter

    Client->>Router: GraphQL Request
    Router->>ContextGetter: Get Context
    alt Synchronous Context
        ContextGetter-->>Router: Return Context directly
    else Asynchronous Context
        ContextGetter-->>Router: Return Awaitable[Context]
        Router-->>Router: Await Context
    end
    Router-->>Client: GraphQL Response

Loading

File-Level Changes

Change	Details	Files
Modified the context_getter signature to allow for an Awaitable return type.	Updated the type hint for context_getter to accept either an optional context or an awaitable of an optional context.	strawberry/fastapi/router.py

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#3762	Update the context_getter signature to allow Awaitable return type	✅
#3762	Ensure the context_getter signature matches its usage in the router	✅

Possibly linked issues

• context_getter signature does not offer passing Awaitable #3762: This PR fixes the issue by allowing context_getter to be awaitable.

---

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:

• Consider adding tests to verify both synchronous and asynchronous context getters work as expected.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 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.}

[botberry]

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

---

This release adjusts the context_getter attribute from the fastapi GraphQLRouter
to accept an async callables.

Here's the tweet text:

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

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

[botberry]

Hi, thanks for contributing to Strawberry 🍓!

We noticed that this PR is missing a RELEASE.md file. We use that to automatically do releases here on GitHub and, most importantly, to PyPI!

So as soon as this PR is merged, a release will be made 🚀.

Here's an example of RELEASE.md:

Release type: patch

Description of the changes, ideally with some examples, if adding a new feature.

Release type can be one of patch, minor or major. We use semver, so make sure to pick the appropriate type. If in doubt feel free to ask :)

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 I force-pushed and lost your changes to RELEASE.md - was that only about that suggestion?

[bellini666]

@bellini666 I force-pushed and lost your changes to RELEASE.md - was that only about that suggestion?

yep! I didn't know you were going to be that fast, so I applied it myself lol

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.24%. Comparing base (7ba5928) to head (9ae8b3d).
Report is 10 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3763      +/-   ##
==========================================
- Coverage   97.27%   97.24%   -0.03%     
==========================================
  Files         504      502       -2     
  Lines       33480    33460      -20     
  Branches     5502     1702    -3800     
==========================================
- Hits        32566    32537      -29     
- Misses        703      706       +3     
- Partials      211      217       +6     

[codspeed-hq]

CodSpeed Performance Report

Merging #3763 will not alter performance

_{Comparing alexey-pelykh:fix/fastapi/context_getter-signature (9ae8b3d) with main (3c0f9e4)}

Summary

✅ 21 untouched benchmarks

[alexey-pelykh]

I have a feeling that the new signature made things worse for mypy - see #3781 nah