Improve ability to override existing graphql models. #440

tjeerddie · 2024-01-10T14:49:06Z

Change register_graphql to re-create autogenerated models and update the graphql router schema.
add strawberry class override to change field resolvers of existing classes.
add unit tests for override_class function and add test that overrides Query.
move register_domain_models to create_graphql_router.
change register_domain_models to take existing models with a parameter instead of a global dict.
move StrawberryPydanticModel, StrawberryModelType and GRAPHQL_MODELS to graphql.schemas init.
create default Subscription inside the create_graphql_router to recreate it when interface is updated.

Fixes: #393, #310
Both fixed by the ability to update schema with running app.register_graphql multiple times.

codecov · 2024-01-10T15:07:19Z

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Comparison is base (fed5d8c) 71.33% compared to head (73ff838) 75.62%.

Files	Patch %	Lines
orchestrator/graphql/utils/override_class.py	87.50%	1 Missing and 1 partial ⚠️
orchestrator/graphql/schema.py	93.75%	0 Missing and 1 partial ⚠️
orchestrator/graphql/utils/is_query_detailed.py	75.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #440      +/-   ##
==========================================
+ Coverage   71.33%   75.62%   +4.29%     
==========================================
  Files         193      195       +2     
  Lines        9659     9703      +44     
  Branches     1316     1609     +293     
==========================================
+ Hits         6890     7338     +448     
+ Misses       2561     2130     -431     
- Partials      208      235      +27

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Mark90 · 2024-01-11T08:21:12Z

move register_domain_models to create_graphql_router.

move StrawberryPydanticModel, StrawberryModelType and GRAPHQL_MODELS to graphql.schemas init.

Will orchestrator implementations need to adjust imports for this?

orchestrator/app.py

orchestrator/graphql/autoregistration.py

orchestrator/graphql/resolvers/subscription.py

orchestrator/graphql/schema.py

orchestrator/graphql/utils/is_query_detailed.py

test/unit_tests/graphql/utils/test_override_class.py

orchestrator/graphql/autoregistration.py

- add strawberry class override to change field resolvers of existing classes. - add unit tests for override_class function and add test that overrides `Query`. - move register_domain_models to create_graphql_router. - change register_domain_models to take existing models with a parameter instead of a global dict. - move `StrawberryPydanticModel`, `StrawberryModelType` and `GRAPHQL_MODELS` to graphql.schemas init. - create default `Subscription` inside the create_graphql_router to recreate it when interface is updated.

Co-authored-by: Mark Moes <mark_moes@live.nl>

- rename format_default_subscriptions to format_base_subscription. - improve test_override_class.

- move `create_subscription_strawberry_type` out of `add_class_to_strawberry`.

- the override_class can make the mapping itself instead of needing to do duplicate naming in the field and in the mapping given to the override_class. - change interface type in autoregistration to Type.

- change unit test github action to not run graphql separately - update override_class function typing. Fixes: #393, #310

dmarjenburgh

LGTM

tjeerddie force-pushed the improve-graphql-override branch from a7d07ea to 07500d5 Compare January 10, 2024 15:01

tjeerddie force-pushed the customer-update branch from 21ff7b9 to 57fe549 Compare January 10, 2024 15:08

tjeerddie force-pushed the improve-graphql-override branch from 07500d5 to 0323f24 Compare January 10, 2024 15:08