Change pydantic conversion to not load field data unless requested

[Mark90]

Changes the Pydantic model conversion so that it doesn't retrieve data for fields that aren't going to be used.

Description

It's been 8 months since I manually patched this in our own codebase, I wanted to create a PR here after some time when I was sure it didn't cause any regressions.

Without this patch I observed unnecessary requests (lazyloading through our ORM) being made which originated from fields on "Pydantic strawberry types" that weren't requested in the query. Moving these lines inside the if field.init: section appeared sufficient to fix this.

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

Enhancements:

• Improve performance by avoiding unnecessary data loading for Pydantic fields not requested in the query.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request modifies the Pydantic model conversion to avoid unnecessary data retrieval for unrequested fields. The changes involve moving data retrieval logic inside a conditional block that checks if the field is initialized.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Modified the Pydantic model conversion logic to only retrieve data for fields that are used.	Moved the data retrieval logic for data_from_extra and data_from_model inside the if field.init: block. Added a release note to RELEASE.md.	strawberry/experimental/pydantic/conversion.py RELEASE.md

---

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. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for 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 @Mark90 - I've reviewed your changes - here's some feedback:

Overall Comments:

• It would be helpful to add a test case that specifically demonstrates the performance improvement from this change.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[botberry]

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

---

Change pydantic conversion to not load field data unless requested

Here's the tweet text:

🆕 Release (next) is out! Thanks to Mark Moes for the PR 👏

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

[Mark90]

If tests to measure the performance difference are required I'll be happy to supply them; I haven't delved into the testsuite deep enough yet to know how you typically do this.

I just wanted to get this PR up before I forget to do so again. :)

[patrick91]

@Mark90 thanks!

If tests to measure the performance difference are required I'll be happy to supply them; I haven't delved into the testsuite deep enough yet to know how you typically do this.

They aren't really needed, unless you think there was a big change!

[patrick91]

@Mark90 but it would be nice to have some test to check the behaviour is what we expect now 😄

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.23%. Comparing base (7d4ba10) to head (9027fb3).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3812   +/-   ##
=======================================
  Coverage   97.23%   97.23%           
=======================================
  Files         503      503           
  Lines       33580    33580           
  Branches     1717     1717           
=======================================
  Hits        32653    32653           
  Misses        708      708           
  Partials      219      219           

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[codspeed-hq]

CodSpeed Performance Report

Merging #3812 will not alter performance

_{Comparing Mark90:pydantic-load-data-when-needed (9027fb3) with main (7d4ba10)}

Summary

✅ 21 untouched benchmarks

[Mark90]

@Mark90 but it would be nice to have some test to check the behaviour is what we expect now 😄

Done!

The added test fails without the change in conversion.py, and passes with the change.

The test uses root._original_model.name in the resolver, which is probably not recommended usage, but this is not even necessary to reproduce the problem. E.g. if the get_name() resolver is changed to return "foo" and the change in conversion.py reverted, then the name computed_field is still accessed somewhere during the conversion.

[Mark90]

@patrick91 Have you had a chance to look at this?

[patrick91]

Hey! Really sorry this took a while! Code looks perfect! Thanks 😊

[botberry]

Thanks for contributing to Strawberry! 🎉 You've been invited to join
the Strawberry GraphQL organisation 😊

You can also request a free sticker by filling this form: https://forms.gle/dmnfQUPoY5gZbVT67

And don't forget to join our discord server: https://strawberry.rocks/discord 🔥