Add support for extensions to the HTTP protocol #3461

omarzouk · 2024-04-19T17:38:08Z

Description

The GQL spec specifies a field called extensions as part of the request parameters spec in the HTTP protocol. We are missing support for this

Adding the field to be parsed and propagating it as part of the Info object. This is done by wrapping the entire context object in a temporary container, and then unwrapping it inside the Info context getter. A new function is also added to the Info class called input_extensions. It exposes the extensions data.

Example usage by the end-user:

@strawberry.field
def value_from_extensions(self, key: str, info: strawberry.Info) -> str:
    return info.input_extensions[key]

Types of Changes

Issues Fixed or Closed by This PR

fixes Support the extensions Request Parameter for the HTTP protocol #3224

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

This pull request introduces support for the 'extensions' field in HTTP requests, allowing it to be parsed and included in the ExecutionContext. This change is accompanied by updates to the documentation and new tests to ensure proper functionality.

New Features:
- Added support for the 'extensions' field in HTTP requests, allowing it to be parsed and propagated as part of the ExecutionContext.
Documentation:
- Updated documentation to reflect the new support for the 'extensions' field in HTTP requests.
Tests:
- Added tests to verify the correct handling and propagation of the 'extensions' field in both GET and POST HTTP requests.

for more information, see https://pre-commit.ci

botberry · 2024-04-19T17:39:37Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

This release adds support for input extension (To explain and document)

Here's the tweet text:

🆕 Release (next) is out! Thanks to Omar Marzouk for the PR 👏

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

sourcery-ai

Hey @omarzouk - I've reviewed your changes and they look great!

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
🟢 Docstrings: all looks good

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 to tell me if it was helpful.}

strawberry/http/__init__.py

codecov · 2024-04-19T17:44:57Z

Codecov Report

Attention: Patch coverage is 65.51724% with 20 lines in your changes missing coverage. Please review.

Project coverage is 95.01%. Comparing base (4db5a0d) to head (bacfce9).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3461      +/-   ##
==========================================
- Coverage   95.06%   95.01%   -0.06%     
==========================================
  Files         508      508              
  Lines       33018    33072      +54     
  Branches     1712     1719       +7     
==========================================
+ Hits        31388    31422      +34     
- Misses       1356     1370      +14     
- Partials      274      280       +6

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codspeed-hq · 2024-04-19T17:45:25Z

CodSpeed Performance Report

Merging #3461 will not alter performance

_{Comparing omarzouk:add_http_extensions (bacfce9) with main (4db5a0d)}

Summary

✅ 21 untouched benchmarks

erikwrede

Thanks for the PR! Can you add a test to ensure the exension dict is actually correctly passed down the chain? 🙂

Additionally, we can investigate merging the http protocol extensions with subscription extensions (need to double check if we support this already in strawberry). It might also make sense to add the protocol extensions to Info

omarzouk · 2024-06-24T10:37:44Z

@erikwrede Hi! yea I think I need to do a fresh take on this, I think I hit a dead end with my current approach, I've been investigating how to do it, and I think we have a couple options:

1- Wrap the context field in another object that holds the extensions and the context, i.e. wrap the field before this line, then unwrap it inside the Info class. We would then introduce an input_extensions or protocol_extensions field to Info that reads the extensions from the wrapper.

2- Extend the definition of the get_context function, add a 3rd parameter called extensions. However, this would require moving the body parsing and data fetching to happen before the get_context is called, i.e. this operation would have to move above this line. It will also require some refactoring to get a similar pattern to work with subscriptions.

The benefit of doing Option 1 would be that we can add this right away to http, without having to modify other protocols, and just include a type check for the wrapper in the info.context getter. It can then be added to other protocols over time, in other PRs.

What do u think? should I go ahead and do Option 1?

for more information, see https://pre-commit.ci

omarzouk · 2024-06-24T14:22:34Z

hi @erikwrede, I went ahead and implemented Option 1 mentioned above, which is to wrap the context object and unwrap it in the Info getter. I also added a new test that is passing successfully. Please let me know what you think. 🙏

sourcery-ai · 2024-06-24T14:24:36Z

Reviewer's Guide by Sourcery

This pull request adds support for the 'extensions' field in the HTTP protocol for GraphQL requests. The changes involve parsing the 'extensions' field from the request, propagating it through the ExecutionContext, and making it accessible to applications. Additionally, tests have been added to ensure the new functionality works correctly.

File-Level Changes

Files	Changes
`tests/http/clients/base.py` `tests/http/clients/channels.py` `tests/http/clients/aiohttp.py` `tests/http/clients/asgi.py` `tests/http/clients/chalice.py` `tests/http/clients/django.py` `tests/http/clients/fastapi.py` `tests/http/clients/flask.py` `tests/http/clients/litestar.py` `tests/http/clients/quart.py` `tests/http/clients/sanic.py` `tests/http/clients/starlite.py`	Added 'extensions' parameter to various HTTP client request functions and updated request body construction to include 'extensions'.
`strawberry/http/async_base_view.py` `strawberry/http/sync_base_view.py`	Wrapped context in ContextWrapper to include 'extensions' in execute_operation and parse_http_body functions.

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

sourcery-ai

Hey @omarzouk - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 3 issues found
🟢 Security: all looks good
🟡 Testing: 1 issue found
🟡 Complexity: 2 issues found
🟢 Documentation: all looks good

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 to tell me if it was helpful.}

strawberry/types/info.py

strawberry/http/__init__.py

strawberry/types/context_wrapper.py

tests/http/test_query.py

strawberry/http/async_base_view.py

strawberry/http/sync_base_view.py

omarzouk · 2024-06-24T14:31:11Z

pinging @patrick91 as well, since we discussed this originally in #3224

bellini666

Some comments, but I'm not totally aware of this, so other @strawberry-graphql/core will be able to do a better review :)

strawberry/http/__init__.py

strawberry/http/async_base_view.py

strawberry/http/sync_base_view.py

strawberry/types/info.py

bellini666 · 2024-07-06T18:39:54Z

strawberry/types/context_wrapper.py

+@dataclass
+class ContextWrapper:
+    context: Optional[Any]
+    extensions: Optional[Dict[str, Any]]


Same suggestion as above

Suggested change

extensions: Optional[Dict[str, Any]]

extensions: Optional[Dict[str, Any]] = None

tests/views/schema.py

strawberry/http/base.py

Co-authored-by: Thiago Bellini Ribeiro <[email protected]>

for more information, see https://pre-commit.ci

omarzouk · 2024-08-22T09:27:36Z

hello! sorry to keep pinging, we are really eager to use this in our APIs, do u think its possible to get some traction on it? I'm happy to help any way I can @patrick91 🙏

patrick91 · 2024-08-22T11:13:52Z

@omarzouk sure, I think I'll have time this week(end) (I'm currently travelling) 😊

And please consider sponsoring us, so we can prioritise issues better ;)

patrick91 · 2024-08-27T09:09:16Z

@omarzouk an update on this, I think I found a nice way to pass the request extensions to info, but it is quite different from this, so I might try it in another PR

omarzouk · 2025-02-03T12:30:00Z

And please consider sponsoring us, so we can prioritise issues better ;)

@patrick91 Hi Patrick! I talked with our management about it, it took a while to get done because github's invoice system for sponsorships is a big mess, but Soundtrack Technologies is now a 🍓 Sponsor! you guys built an awesome library, we use it for a lot of our apps, so it makes all the sense in the world to help you maintain it!

patrick91 · 2025-02-04T16:57:52Z

@omarzouk looks there's an alpha version of GraphQl-core which makes passing data around much easier, would you be ok with using their alpha?

omarzouk · 2025-02-06T09:01:28Z

@omarzouk looks there's an alpha version of GraphQl-core which makes passing data around much easier, would you be ok with using their alpha?

yea sure, building towards the future setup of GraphQl-core is definitely the for the best 👍

omarzouk · 2025-05-06T14:42:42Z

hi @patrick91 what is the status of this now? I see graphql-core have implemented some support for it in the alpha version. Are we working on something in Strawberry so we can make use of the new capability?

patrick91 · 2025-05-12T19:21:48Z

@omarzouk I'll take a look at this tomorrow! sorry!

patrick91 · 2025-05-13T19:19:28Z

/pre-release

patrick91 · 2025-05-13T19:20:02Z

@omarzouk I think we (@bellini666) got a nice implementation, would be interested in trying the pre-release? 😊

botberry · 2025-05-13T19:20:06Z

Pre-release

👋

Releasing commit [832ad16] to PyPi as pre-release! 📦

botberry · 2025-05-13T19:20:19Z

Pre-release

👋

Pre-release 0.269.0.dev.1747164009 [832ad16] has been released on PyPi! 🚀
You can try it by doing:

poetry add strawberry-graphql==0.269.0.dev.1747164009

omarzouk · 2025-05-14T08:24:05Z

strawberry/types/info.py

@@ -113,6 +113,11 @@ def context(self) -> ContextType:
        """The context passed to the query execution."""
        return self._raw_info.context

+    @property
+    def input_extensions(self) -> dict[str, Any]:


@patrick91 First of all, thanks a lot for taking the time to do it! I tested it in one of our APIs, the data does go through all the way! However it is returned as a string and not as a dict, so we need to json.loads the data before we return it from this function. The spec states that the parameter is expected to be a map so parsing it should be safe to do.

Edit: I was wrong, its actually correct

@patrick91 actually nvm I was wrong, I was wrongly escaping the input in my curl request, totally my bad. The implementation is actually correct! and I can confirm it works end to end 👍

@omarzouk awesome! I'll release this after we fix the unrelated issue with GlobalID :D

omarzouk

The pre-release works perfectly, thanks a lot guys! ❤️

botberry · 2025-05-17T09:36:17Z

Thanks for contributing to Strawberry! 🎉 You've been invited to join
the Strawberry GraphQL organisation 😊

You can also request a free sticker by filling this form: https://forms.gle/dmnfQUPoY5gZbVT67

And don't forget to join our discord server: https://strawberry.rocks/discord 🔥

mdgilene · 2025-05-19T20:00:00Z

Input extension information only being available from the Info object seems pretty limiting. It would make sense that someone would want to implement a custom extension and have access to the input extension information from the ExecutionContext. But currently from what I can tell this is not the case currently.

Are there any plans to make this info available to the various extension lifecycle hook methods?

patrick91 · 2025-05-20T10:11:43Z

@mdgilene can you open an issue with an example use case? We'll try to make it happen 😊

omarzouk and others added 2 commits April 19, 2024 19:35

first attempt, introducing new param

e97afee

[pre-commit.ci] auto fixes from pre-commit.com hooks

41fad16

for more information, see https://pre-commit.ci

omarzouk marked this pull request as draft April 19, 2024 17:38

sourcery-ai bot reviewed Apr 19, 2024

View reviewed changes

strawberry/http/__init__.py Outdated Show resolved Hide resolved

missing params

cbd138b

strawberry-graphql deleted a comment from botberry Jun 22, 2024

erikwrede reviewed Jun 22, 2024

View reviewed changes

omarzouk and others added 6 commits June 24, 2024 12:55

revert trying to pass to execute

69b35c3

implement Option 1

2841b69

[pre-commit.ci] auto fixes from pre-commit.com hooks

419f2f9

for more information, see https://pre-commit.ci

fix: missing parsing of extensions in params for GET requests

393b976

chore: add new test and adjust http test code to pass the parameter

3eafc92

[pre-commit.ci] auto fixes from pre-commit.com hooks

ae3456b

for more information, see https://pre-commit.ci

omarzouk requested a review from erikwrede June 24, 2024 14:16

omarzouk marked this pull request as ready for review June 24, 2024 14:24

sourcery-ai bot reviewed Jun 24, 2024

View reviewed changes

bellini666 reviewed Jul 6, 2024

View reviewed changes

omarzouk and others added 5 commits July 6, 2024 21:18

Change parameter order in test function

ea1b053

Co-authored-by: Thiago Bellini Ribeiro <[email protected]>

Use isinstance

351c48e

Co-authored-by: Thiago Bellini Ribeiro <[email protected]>

Use isinstance

494d2b6

Co-authored-by: Thiago Bellini Ribeiro <[email protected]>

change to absolute imports

2b16e45

[pre-commit.ci] auto fixes from pre-commit.com hooks

d22c2d9

for more information, see https://pre-commit.ci

DoctorJohn mentioned this pull request Jul 7, 2024

Fix incorrect query params type #3558

Merged

11 tasks

patrick91 mentioned this pull request Aug 27, 2024

How to pass additional information to GraphQLResolveInfo graphql-python/graphql-core#226

Closed

Merge branch 'main' into add_http_extensions

ecf62eb

patrick91 force-pushed the add_http_extensions branch from 2dd8a98 to 73dca8d Compare May 13, 2025 16:39

Use latest feature of GraphQL-core

43e274e

patrick91 force-pushed the add_http_extensions branch from 600f07e to 43e274e Compare May 13, 2025 16:43

patrick91 added 3 commits May 13, 2025 17:54

Only 3.3 has some new things

5af17dc

Lint

bc8ccbe

Add basic release

832ad16

botberry added bot:has-release-file bot:release-type-minor labels May 13, 2025

omarzouk commented May 14, 2025

View reviewed changes

Merge branch 'main' into add_http_extensions

bacfce9

patrick91 merged commit 0cfb7f6 into strawberry-graphql:main May 17, 2025
100 of 103 checks passed

mdgilene mentioned this pull request May 20, 2025

Make Input Extension data available within extension ExecutionContext #3864

Closed

3 tasks

	extensions: Optional[Dict[str, Any]]
	extensions: Optional[Dict[str, Any]] = None

Uh oh!

Add support for extensions to the HTTP protocol #3461

Add support for extensions to the HTTP protocol #3461

Uh oh!

Conversation

omarzouk commented Apr 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

Summary by Sourcery

Uh oh!

botberry commented Apr 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Apr 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq bot commented Apr 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #3461 will not alter performance

Summary

Uh oh!

erikwrede left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

omarzouk commented Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

omarzouk commented Jun 24, 2024

Uh oh!

sourcery-ai bot commented Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

File-Level Changes

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

omarzouk commented Jun 24, 2024

Uh oh!

bellini666 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bellini666 Jul 6, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

omarzouk commented Aug 22, 2024

Uh oh!

patrick91 commented Aug 22, 2024

Uh oh!

patrick91 commented Aug 27, 2024

Uh oh!

omarzouk commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

patrick91 commented Feb 4, 2025

Uh oh!

omarzouk commented Feb 6, 2025

omarzouk commented Apr 19, 2024 •

edited

Loading

botberry commented Apr 19, 2024 •

edited

Loading

codecov bot commented Apr 19, 2024 •

edited

Loading

codspeed-hq bot commented Apr 19, 2024 •

edited

Loading

erikwrede left a comment •

edited

Loading

omarzouk commented Jun 24, 2024 •

edited

Loading

sourcery-ai bot commented Jun 24, 2024 •

edited

Loading

omarzouk commented Feb 3, 2025 •

edited

Loading

omarzouk May 14, 2025 •

edited

Loading

omarzouk May 14, 2025 •

edited

Loading