Take oneOf directive into account in codegen module #3652

enoua5 · 2024-09-28T00:12:55Z

Description

Adds support for oneOf to the codegen module

The codegen manager now passes is_one_of to GraphQLObjectType making it part of the codegen plugin api
Python plugin has been updated to output oneOf types as a union of classes with one field each
Typescript plugin has been updated to output oneOf types as a union of objects where in each all but one field has a type of never

Types of Changes

Issues Fixed or Closed by This PR

None

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

Implement support for the oneOf directive in the code generation module, enhancing the Python and TypeScript plugins to handle oneOf types as unions. Add corresponding tests and snapshots to verify the new functionality.

New Features:

Add support for the oneOf directive in the code generation module, allowing the generation of union types for oneOf fields in both Python and TypeScript plugins.

Enhancements:

Update the Python plugin to output oneOf types as a union of classes, each with one field.
Update the TypeScript plugin to output oneOf types as a union of objects, where each object has all but one field typed as never.

Tests:

Add new test cases and snapshots for the oneOf directive in both Python and TypeScript code generation to ensure correct functionality.

codecov · 2024-09-28T00:16:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.83%. Comparing base (92ae942) to head (1347bde).
Report is 10 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3652      +/-   ##
==========================================
+ Coverage   96.76%   96.83%   +0.06%     
==========================================
  Files         522      503      -19     
  Lines       33824    33457     -367     
  Branches     5635     5596      -39     
==========================================
- Hits        32731    32397     -334     
+ Misses        863      830      -33     
  Partials      230      230

codspeed-hq · 2024-09-28T00:22:58Z

CodSpeed Performance Report

Merging #3652 will not alter performance

_{Comparing enoua5:codegen-oneof (1347bde) with main (3484480)}

Summary

✅ 15 untouched benchmarks

sourcery-ai · 2024-09-28T02:30:44Z

Reviewer's Guide by Sourcery

This pull request adds support for the oneOf directive in the codegen module. The changes primarily affect the Python and TypeScript plugins, introducing new logic to handle oneOf types in code generation. The implementation includes updates to object type handling, field printing, and type definitions to accommodate the oneOf functionality.

Sequence Diagram

sequenceDiagram
    participant CG as Codegen Manager
    participant PY as Python Plugin
    participant TS as TypeScript Plugin
    CG->>CG: Set is_one_of flag in GraphQLObjectType
    CG->>PY: Process oneOf type
    PY->>PY: Generate union of classes
    CG->>TS: Process oneOf type
    TS->>TS: Generate union of objects

File-Level Changes

Change	Details	Files
Added support for `oneOf` directive in the codegen module	Updated GraphQLObjectType to include `is_one_of` flag Modified _collect_type_from_strawberry_type to set `is_one_of` flag Added new methods to handle oneOf object types in Python and TypeScript plugins Updated existing methods to account for oneOf types	`strawberry/codegen/query_codegen.py` `strawberry/codegen/types.py` `strawberry/codegen/plugins/python.py` `strawberry/codegen/plugins/typescript.py`
Updated Python plugin to generate oneOf types as a union of classes	Added _print_oneof_object_type method to generate oneOf classes Modified _print_field method to handle oneOf members Updated _print_type to use oneOf-specific logic when applicable	`strawberry/codegen/plugins/python.py`
Updated TypeScript plugin to generate oneOf types as a union of objects	Added _print_oneof_object_type method to generate oneOf types Added _print_oneof_field method to handle oneOf fields Updated _print_type to use oneOf-specific logic when applicable	`strawberry/codegen/plugins/typescript.py`
Added test cases and snapshots for oneOf functionality	Created new test queries for oneOf types Added snapshot files for Python and TypeScript oneOf output	`tests/codegen/conftest.py` `tests/codegen/snapshots/typescript/oneof_typename.ts` `tests/codegen/snapshots/python/oneof_typename.py` `tests/codegen/snapshots/typescript/oneof.ts` `tests/codegen/snapshots/python/oneof.py` `tests/codegen/queries/oneof_typename.graphql` `tests/codegen/queries/oneof.graphql`

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.

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 @enoua5 - 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: 4 issues found
🟢 Complexity: all looks good
🟢 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 and I'll use the feedback to improve your reviews.}

strawberry/codegen/plugins/python.py

strawberry/codegen/plugins/typescript.py

strawberry/codegen/types.py

tests/codegen/conftest.py

tests/codegen/snapshots/python/oneof.py

tests/codegen/snapshots/typescript/oneof.ts

tests/codegen/snapshots/python/oneof_typename.py

botberry · 2024-09-28T02:32:57Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

The Query Codegen system now supports the @oneOf directive.

When writing plugins, you can now access GraphQLObjectType.is_one_of to determine if the object being worked with has a @oneOf directive.

The default plugins have been updated to take advantage of the new attribute.

For example, given this schema:

@strawberry.input(one_of=True)
class OneOfInput:
    a: Optional[str] = strawberry.UNSET
    b: Optional[str] = strawberry.UNSET


@strawberry.type
class Query:
    @strawberry.field
    def one_of(self, value: OneOfInput) -> str: ...


schema = strawberry.Schema(Query)

And this query:

query OneOfTest($value: OneOfInput!) {
  oneOf(value: $value)
}

The query codegen can now generate this Typescript file:

type OneOfTestResult = {
    one_of: string
}

type OneOfInput = { a: string, b?: never }
    | { a?: never, b: string }

type OneOfTestVariables = {
    value: OneOfInput
}

Here's the tweet text:

🆕 Release (next) is out! Thanks to Jacob Allen for the PR 👏

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

…3393 into codegen-oneof

enoua5 · 2024-09-29T05:41:50Z

I unchecked "My change requires a change to the documentation". I would add a note about this to the documentation on codegen plugins, but the docs already don't go over any of the other types that are passed into the plugin.

enoua5 · 2024-10-02T02:21:18Z

If anyone has opinions on how those Typescript unions should be formatted, I'd be happy to take the feedback 😄

patrick91 · 2024-10-02T07:51:14Z

@enoua5 I'll check this on the weekend! thank you so much 😊

enoua5 · 2024-10-06T20:56:50Z

If anyone has opinions on how those Typescript unions should be formatted, I'd be happy to take the feedback 😄

Looking at dotansimha/graphql-code-generator, it looks like it would generate code like this:

type OneOfInput =
  { a: string, b?: never }
  |  { a?: never, b: string };

I'm not a big fan of the hanging =, but, thoughts?

patrick91 · 2024-10-06T22:43:01Z

@enoua5 I think that's fine, we could maybe in future run prettier/biome to the output if the user has one of them installed :)

enoua5 · 2024-10-06T23:13:40Z

@patrick91 That's a fair point. Do you think its not worth changing it from how it is now, then?

enoua5 added 2 commits September 27, 2024 18:08

Pass is_one_of into codegen context

cdc943c

Update python plug-in to use is_one_of

0d60c8d

Fix python codegen

bd34fca

enoua5 added 3 commits September 27, 2024 18:46

More fixes on python plugin

93b19c3

Add tests for python plugin

b0479b0

Update typescript plugin

6d4c073

enoua5 changed the title ~~Take oneOf directive into account when codegen module~~ Take oneOf directive into account in codegen module Sep 28, 2024

enoua5 added 3 commits September 27, 2024 19:33

Fix print operation error

d926ba4

Add tests for typenames and aliases

b2094c4

Clean up code coverage

db0b0d1

enoua5 marked this pull request as ready for review September 28, 2024 02:30

Create RELEASE.md

5497709

sourcery-ai bot reviewed Sep 28, 2024

View reviewed changes

botberry added bot:has-release-file bot:release-type-minor labels Sep 28, 2024

enoua5 added 4 commits September 27, 2024 20:47

Add comments to potentially confusing sections

0b1386a

Merge branch 'codegen-oneof' of https://github.com/enoua5/strawberry-…

625ccc1

…3393 into codegen-oneof

Add spacing around component classes

0434e68

Remove the "just in case" branches that don't affect anything

5834355

Make typescript output optional fields for the never types

4e57fbd

Explain to codecov that we don't need to test Ellipsis

2854ef3

Fix spacing in python union generation

a9194bf

Update release file to make example match actual current output

1347bde

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Take oneOf directive into account in codegen module #3652

Take oneOf directive into account in codegen module #3652

enoua5 commented Sep 28, 2024 •

edited by sourcery-ai bot

Loading

codecov bot commented Sep 28, 2024 •

edited

Loading

codspeed-hq bot commented Sep 28, 2024 •

edited

Loading

sourcery-ai bot commented Sep 28, 2024 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

botberry commented Sep 28, 2024 •

edited

Loading

enoua5 commented Sep 29, 2024

enoua5 commented Oct 2, 2024

patrick91 commented Oct 2, 2024

enoua5 commented Oct 6, 2024 •

edited

Loading

patrick91 commented Oct 6, 2024

enoua5 commented Oct 6, 2024

Take oneOf directive into account in codegen module #3652

Are you sure you want to change the base?

Take oneOf directive into account in codegen module #3652

Conversation

enoua5 commented Sep 28, 2024 • edited by sourcery-ai bot Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

Summary by Sourcery

codecov bot commented Sep 28, 2024 • edited Loading

Codecov Report

codspeed-hq bot commented Sep 28, 2024 • edited Loading

CodSpeed Performance Report

Merging #3652 will not alter performance

Summary

sourcery-ai bot commented Sep 28, 2024 • edited Loading

Reviewer's Guide by Sourcery

Sequence Diagram

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

botberry commented Sep 28, 2024 • edited Loading

enoua5 commented Sep 29, 2024

enoua5 commented Oct 2, 2024

patrick91 commented Oct 2, 2024

enoua5 commented Oct 6, 2024 • edited Loading

patrick91 commented Oct 6, 2024

enoua5 commented Oct 6, 2024

enoua5 commented Sep 28, 2024 •

edited by sourcery-ai bot

Loading

codecov bot commented Sep 28, 2024 •

edited

Loading

codspeed-hq bot commented Sep 28, 2024 •

edited

Loading

sourcery-ai bot commented Sep 28, 2024 •

edited

Loading

botberry commented Sep 28, 2024 •

edited

Loading

enoua5 commented Oct 6, 2024 •

edited

Loading