fix(codegen): Relay Node id field generated as _id instead of id #4053
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's GuideFixes query codegen to use each Strawberry field’s GraphQL name (e.g. Relay Node File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4053 +/- ##
=======================================
Coverage 94.41% 94.41%
=======================================
Files 536 537 +1
Lines 35036 35077 +41
Branches 1842 1842
=======================================
+ Hits 33079 33118 +39
- Misses 1659 1661 +2
Partials 298 298 🚀 New features to boost your workflow:
|
CodSpeed Performance ReportMerging #4053 will not alter performanceComparing Summary
|
Ckk3
changed the title
_id instead of id
Ckk3
changed the title
_id instead of id
Member
|
Thanks for adding the Here's a preview of the changelog: Fixed a bug in the codegen where Relay Node's The codegen now correctly respects the explicit Here's the tweet text: |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
Greptile OverviewGreptile SummaryThis PR fixes a bug where Relay Node's Key Changes:
Impact: Confidence Score: 5/5
Important Files ChangedFile Analysis
Sequence DiagramsequenceDiagram
participant User as User Query
participant QC as QueryCodegen
participant Helper as _get_field_name()
participant Schema as Strawberry Schema
participant Field as StrawberryField
User->>QC: Generate code for Relay query
QC->>Schema: Get Relay Node type definition
Schema-->>QC: Node with _id method (@field(name="id"))
QC->>QC: Process field for codegen
QC->>Helper: _get_field_name(field)
Helper->>Field: Check field.graphql_name
alt graphql_name is set (e.g., "id")
Field-->>Helper: "id" (explicit GraphQL name)
Helper-->>QC: Return "id"
else graphql_name is None
Field-->>Helper: None
Helper->>Field: Get field.name (Python name)
Field-->>Helper: Python method name
Helper-->>QC: Return Python name
end
QC->>QC: Create GraphQLField with correct name
QC-->>User: Generated code with "id: str"
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Collaborator
Author
|
@sourcery-ai review |
bellini666
approved these changes
Dec 2, 2025
| return strawberry.Schema(query=Query) | ||
|
|
||
|
|
||
| HERE = Path(__file__).parent |
Member
There was a problem hiding this comment.
nitpick: move this to the top of the file, after imports
Comment on lines
54
to
65
| RELAY_QUERIES = list((HERE / "relay_queries").glob("*.graphql")) | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| ("plugin_class", "plugin_name", "extension"), | ||
| [ | ||
| (PythonPlugin, "python", "py"), | ||
| (TypeScriptPlugin, "typescript", "ts"), | ||
| ], | ||
| ids=["python", "typescript"], | ||
| ) | ||
| @pytest.mark.parametrize("query", RELAY_QUERIES, ids=[x.name for x in RELAY_QUERIES]) |
Member
There was a problem hiding this comment.
nitpick:
Suggested change
| RELAY_QUERIES = list((HERE / "relay_queries").glob("*.graphql")) | |
| @pytest.mark.parametrize( | |
| ("plugin_class", "plugin_name", "extension"), | |
| [ | |
| (PythonPlugin, "python", "py"), | |
| (TypeScriptPlugin, "typescript", "ts"), | |
| ], | |
| ids=["python", "typescript"], | |
| ) | |
| @pytest.mark.parametrize("query", RELAY_QUERIES, ids=[x.name for x in RELAY_QUERIES]) | |
| @pytest.mark.parametrize( | |
| ("plugin_class", "plugin_name", "extension"), | |
| [ | |
| (PythonPlugin, "python", "py"), | |
| (TypeScriptPlugin, "typescript", "ts"), | |
| ], | |
| ids=["python", "typescript"], | |
| ) | |
| @pytest.mark.parametrize("query", RELAY_QUERIES, ids=[x.name for x in (HERE / "relay_queries").glob("*.graphql")]) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes a bug in the codegen where Relay Node's
idfield was incorrectly generated as_idin the output code.Description
The Relay Node class defines its
idfield like this:The codegen was using
field.name(the Python name_id) instead of respecting the explicitgraphql_name(id) set via the decorator.Types of Changes
Issues Fixed or Closed by This PR
Checklist
Summary by Sourcery
Tests:
id: strusing a sample query and schemaSummary by Sourcery
Ensure code generation respects GraphQL field names (e.g. Relay Node
id) instead of Python attribute names.Bug Fixes:
_idinstead of the GraphQL field nameidin codegen outputs.Enhancements:
graphql_namewhen present.Documentation:
idfield name generation in codegen.Tests:
idfields, aliases, fragments, lists, nested nodes, and variables.