Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Forward metadata when processing django type #666

Merged
merged 1 commit into from
Dec 8, 2024

Conversation

g-as
Copy link
Contributor

@g-as g-as commented Dec 2, 2024

Description

When trying to allow None filtering on a nullable FK, I found that metadata attr, where this info is stored, was not transferred to the underlying StrawberryField. So I fixed that.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Documentation

Issues Fixed or Closed by This PR

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

Fix the issue where metadata attributes were not being forwarded to the underlying StrawberryField when processing Django types, and add a test to ensure filtering on nullable foreign keys with None values works correctly.

Bug Fixes:

  • Fix metadata attribute not being transferred to the underlying StrawberryField when processing Django types.

Tests:

  • Add a test to verify filtering on nullable foreign keys with None values.

Copy link
Contributor

sourcery-ai bot commented Dec 2, 2024

Reviewer's Guide by Sourcery

This PR fixes a bug where metadata attributes were not being properly forwarded when processing Django types in Strawberry Django. The implementation adds metadata forwarding in the _process_type function and includes a test case demonstrating the fix for nullable foreign key filtering.

Sequence diagram for test_filter_none function

sequenceDiagram
    actor Tester
    participant Query
    participant Database
    Tester->>Query: Execute query with color filter as null
    Query->>Database: Fetch fruits with color as null
    Database-->>Query: Return fruits with null color
    Query-->>Tester: Return result with fruits having null color
    note right of Tester: Verifies that fruits with null color are returned correctly.
Loading

Class diagram for updated _process_type function

classDiagram
    class _process_type {
        +permission_classes
        +default
        +default_factory
        +metadata
        +deprecation_reason
        +directives
        +pagination
    }
    note for _process_type "Added metadata attribute to forward metadata when processing Django types."
Loading

File-Level Changes

Change Details Files
Added metadata forwarding in Django type processing
  • Added metadata parameter to field creation with fallback to None
  • Forwards the metadata attribute from the original field to the new StrawberryField
strawberry_django/type.py
Added test coverage for filtering null values on optional relations
  • Modified FruitFilter to enable null filtering on the color field
  • Added new test case to verify filtering works for null foreign key values
  • Test creates fruits with and without colors to verify correct filtering behavior
tests/filters/test_filters_v2.py

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @g-as - I've reviewed your changes - here's some feedback:

Overall Comments:

  • You've marked that this change requires documentation updates but haven't made them. Please add documentation about the nullable FK filtering functionality.
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
  • 🟢 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_django/type.py Show resolved Hide resolved
@bellini666 bellini666 merged commit 3e64009 into strawberry-graphql:main Dec 8, 2024
21 of 22 checks passed
@g-as g-as deleted the bugfix/metadata branch December 9, 2024 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants