feat: add field extension support #2567

erikwrede · 2023-02-18T16:33:13Z

fix(test): correct pytest.raises exception matching
feat: add field extension support

Description

Adds support for field extensions using the approach specified in PR #2168. Field extensions can support sync ,async or both.

However, sync and async extensions cannot be mixed on the same field: The result of an async resolver would have to be awaited before calling the sync extension, making it impossible for the sync extension to modify any arguments before calling the resolvers.

async-only extensions can be applied to sync resolvers, because we automatically wrap sync resolvers in a SyncToAsyncExtension.

Additional checks to verify no async extensions are used in a sync server (django, flask) may be added in a later PR.

Types of Changes

Issues Fixed or Closed by This PR

Custom field API discussion #2168

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

codecov · 2023-02-18T16:48:00Z

Codecov Report

Merging #2567 (62002c6) into main (548d612) will increase coverage by 0.01%.
The diff coverage is 98.30%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2567      +/-   ##
==========================================
+ Coverage   96.28%   96.30%   +0.01%     
==========================================
  Files         184      185       +1     
  Lines        7653     7708      +55     
  Branches     1404     1422      +18     
==========================================
+ Hits         7369     7423      +54     
  Misses        183      183              
- Partials      101      102       +1

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

blocked by strawberry-graphql#2567

botberry · 2023-02-20T16:42:55Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

Adds support for a custom field using the approach specified in issue #2168.
Field Extensions may be used to change the way how fields work and what they return.
Use cases might include pagination, permissions or other behavior modifications.

from strawberry.extensions import FieldExtension


class UpperCaseExtension(FieldExtension):
    async def resolve_async(
        self, next: Callable[..., Awaitable[Any]], source: Any, info: Info, **kwargs
    ):
        result = await next(source, info, **kwargs)
        return str(result).upper()


@strawberry.type
class Query:
    @strawberry.field(extensions=[UpperCaseExtension()])
    async def string(self) -> str:
        return "This is a test!!"

query {
    string
}

{
  "string": "THIS IS A TEST!!"
}

Here's the tweet text:

🆕 Release (next) is out! Thanks to Erik Wrede for the PR 👏

Get it here 👉 https://github.com/strawberry-graphql/strawberry/releases/tag/(next)

strawberry/extensions/field_extension.py

strawberry/schema/schema_converter.py

blocked by strawberry-graphql#2567

jkimbo

This is really great! 👏 Just added a couple of suggestions for the docs but otherwise I say we ship it.

docs/guides/field-extensions.md

Co-authored-by: Jonathan Kim <jkimbo@gmail.com>

bellini666

LGTM 👍🏼

There are some comments that I made at the other PR, but they are mostly for the permissions integration.

github-actions · 2023-03-07T10:28:23Z

Hi 👋 You can find a preview of the docs here:

https://strawberry.rocks/docs/pr/2567/guides/custom-extensions
https://strawberry.rocks/docs/pr/2567/guides/field-extensions

RELEASE.md

docs/guides/field-extensions.md

patrick91 · 2023-03-07T11:08:59Z

docs/guides/field-extensions.md

+
+## Combining multiple field extensions
+
+When chaining multiple field extensions, the outermost extension is called first,


do you think we could replace outermost with last?

or could we make it so that the order is the same as the one you pass? I think the current behaviour might be confusing 😊

I'd love to have a diagram here for nested extensions, that would clear things up a lot. Do we have a preferred tool for that?

let's use mermaid, it should work on github too: https://mermaid.js.org

Something like this?: https://mermaid.live/edit#pako:eNqNkVFLwzAQx79KOF8UWthzB0Kr86mipN2DLDJCe3XFNClpqi1j391rbJkOBPOU3O_3vwvJEQpTIkTwZmV7YClfC81odW5UyLI85jmraqWiqwe_VquAmDXveK5cRJ6e_5uY3B17XQ40aycAByx6VxvNCqMdDk7AbMREt22L9k52uBkc6o40wnO7hHhqPv_knDjHzqgPtOeqnxuGAuw32lc1qvL6RkAY3sazFE_C4wvjm2yb5h753E-s6a77OZcsV5pAMzLq3Sv3q2VymVmenvtZI-PnTLKGABq0jaxL-qvjJApwB2xQQETbEivpZaFPpMremWzUBUTO9hhA35bS4X0t6ZcbiCqpOjx9AUu0mVA

yup, maybe vertical, as it might be easier to read on mobile 😊

Ok I just realized that doesn't work because the content inside those tags (the diagram in this case) won't be parsed by markdown then.

@erikwrede we could make a custom component for that if it helps

or add a directive, like

```mermaid (mobile:vertical)

if it is easy to change the setting 😊

Ok it actually looks just fine on the github preview. The strawberry preview doesn't seem to update though.

it's probably because we don't support mermaid yet on the site :D I'll see if I can add support to the current design in the next couple of days 😊

We could also add the graph later when the new website is ready

docs/guides/field-extensions.md

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

patrick91

This is awesome 😊

jkimbo · 2023-03-12T20:21:05Z

🎉

* feat: add field extension support * fix: revert imports broken by pycharm * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix: match error message on test * chore: refactor & add RELEASE.md * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore: make mypy happy * chore: enable async-only extensions on sync * chore: adjust callable type hint for resolve_async * hopefully fix codecov... * hopefully fix codecov... #2 * fix: make field directives mutable * docs: add field extension documentation * chore: change next to next_ * chore: make sync-only extensions before async-only extensions possible * fix: test case match string adapted * feat(draft): add permission extension blocked by #2567 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix: use permission.raise_error * chore: fix mypy, drop old PermissionError raise * fix: add permissions extension to field automatically * fix: fix failing tests * fix: recognize async permissions correctly * refactor: move permission error raising to extension * tests: fix test regex to support python <3.10 * refactor: enable silent permissions * fix?: move noqa comment * chore: refactor permissions directives and add RELEASE.md * fix: use correct type annotation for schema_directive * fix: remove permission classes from base resolver Co-authored-by: Thiago Bellini Ribeiro <hackedbellini@gmail.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore: address review comment * chore: add type alias type hint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore: add better error docs * chore: import type alias from extensions * chore: remove unused private method on strawberry field to improve code cov * chore: improve on review comments * chore: improve coverage * chore: improve coverage * docs: fix keyword name in Release.MD Co-authored-by: Etty <28976199+estyxx@users.noreply.github.com> * chore: rename handle_no_permission to on_unauthorized * docs: describe permission extensions * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix: update cached property import * fix: update cached property import * chore: mypy fixes * Make sure we test the exception * Lint * "Improve" coverage --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Thiago Bellini Ribeiro <hackedbellini@gmail.com> Co-authored-by: Patrick Arminio <patrick.arminio@gmail.com> Co-authored-by: Etty <28976199+estyxx@users.noreply.github.com>

erikwrede force-pushed the 2168-field-extensions branch from 566e9f7 to 9525070 Compare February 18, 2023 16:37

feat: add field extension support

c0c7bed

erikwrede force-pushed the 2168-field-extensions branch from 9525070 to c0c7bed Compare February 18, 2023 16:46

erikwrede and others added 5 commits February 18, 2023 16:59

fix: revert imports broken by pycharm

a3d6c7b

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

b140105

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

fix: match error message on test

3f46d75

chore: refactor & add RELEASE.md

c2d8c4a

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

badc528

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

erikwrede added a commit to erikwrede/strawberry that referenced this pull request Feb 18, 2023

feat(draft): add permission extension

c0b3f4f

blocked by strawberry-graphql#2567

erikwrede added 2 commits February 20, 2023 16:58

chore: make mypy happy

fcd3345

chore: enable async-only extensions on sync

dd1d1f8

erikwrede marked this pull request as ready for review February 20, 2023 16:40

botberry added bot:has-release-file labels Feb 20, 2023

erikwrede added 3 commits February 21, 2023 13:03

chore: adjust callable type hint for resolve_async

fca0fde

hopefully fix codecov...

58858c2

hopefully fix codecov... strawberry-graphql#2

ec0860a

bellini666 requested changes Feb 21, 2023

View reviewed changes

strawberry/extensions/field_extension.py Show resolved Hide resolved

strawberry/schema/schema_converter.py Outdated Show resolved Hide resolved

erikwrede added 3 commits February 22, 2023 17:58

fix: make field directives mutable

1249d03

docs: add field extension documentation

2bdf764

chore: change next to next_

f71430b

erikwrede force-pushed the 2168-field-extensions branch from 2cb8d1c to f71430b Compare February 23, 2023 17:29

erikwrede added 2 commits February 23, 2023 19:57

chore: make sync-only extensions before async-only extensions possible

966c7cd

fix: test case match string adapted

e097fc0

erikwrede mentioned this pull request Feb 23, 2023

Custom field API discussion #2168

Closed

erikwrede added a commit to erikwrede/strawberry that referenced this pull request Feb 24, 2023

feat(draft): add permission extension

e6b1d7f

blocked by strawberry-graphql#2567

jkimbo suggested changes Feb 24, 2023

View reviewed changes

docs/guides/field-extensions.md Outdated Show resolved Hide resolved

docs/guides/field-extensions.md Show resolved Hide resolved

Update docs/guides/field-extensions.md

36ac64a

Co-authored-by: Jonathan Kim <jkimbo@gmail.com>

erikwrede added 5 commits February 28, 2023 14:01

chore: style fixes

059345a

docs: add warning about StrawberryField

7eb7814

fix: fix rebase fail

c469632

fix: mypy

302d99d

retrigger test runs

d644cd0

jkimbo approved these changes Mar 1, 2023

View reviewed changes

bellini666 approved these changes Mar 1, 2023

View reviewed changes

erikwrede mentioned this pull request Mar 2, 2023

Object Type Extensions #2605

Open

2 tasks

patrick91 added the ok-to-preview label Mar 7, 2023

patrick91 reviewed Mar 7, 2023

View reviewed changes

RELEASE.md Outdated Show resolved Hide resolved

docs/guides/field-extensions.md Outdated Show resolved Hide resolved

Fix language name in markdown

9e0eeb6

patrick91 reviewed Mar 7, 2023

View reviewed changes

docs/guides/field-extensions.md Show resolved Hide resolved

Minor doc fixes

bff4ee5

botberry removed bot:release-type-minor labels Mar 7, 2023

erikwrede and others added 2 commits March 7, 2023 15:09

docs: add graph to docs

1bfda76

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

b406646

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

botberry added bot:release-type-minor labels Mar 7, 2023

patrick91 mentioned this pull request Mar 9, 2023

feat: Initial relay implementation #2511

Merged

2 tasks

Merge branch 'main' into 2168-field-extensions

62002c6

patrick91 approved these changes Mar 10, 2023

View reviewed changes

patrick91 merged commit dfc3d51 into strawberry-graphql:main Mar 10, 2023

patrick91 mentioned this pull request Mar 10, 2023

Proposal: Strawberry decorator #473

Closed

11 tasks

nrbnlulu mentioned this pull request Jun 28, 2023

Return types from permission classes, instead of raising exceptions. #2100

Closed

3 tasks

sourcery-ai bot mentioned this pull request Jul 16, 2025

Add support for @defer and @stream #3819

Open


		## Combining multiple field extensions

		When chaining multiple field extensions, the outermost extension is called first,

Uh oh!

feat: add field extension support #2567

feat: add field extension support #2567

Uh oh!

Conversation

erikwrede commented Feb 18, 2023 • 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

Uh oh!

codecov bot commented Feb 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

botberry commented Feb 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jkimbo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bellini666 left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 7, 2023

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

patrick91 left a comment

Choose a reason for hiding this comment

Uh oh!

jkimbo commented Mar 12, 2023

Uh oh!

Uh oh!

erikwrede commented Feb 18, 2023 •

edited

Loading

codecov bot commented Feb 18, 2023 •

edited

Loading

botberry commented Feb 20, 2023 •

edited

Loading