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

feat: Allow setting max_results for connection fields #689

Merged
merged 1 commit into from
Jan 12, 2025

Conversation

bellini666
Copy link
Member

@bellini666 bellini666 commented Jan 12, 2025

@bellini666 bellini666 self-assigned this Jan 12, 2025
Copy link
Contributor

sourcery-ai bot commented Jan 12, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new max_results argument to the connection field. This argument allows developers to limit the maximum number of results returned by a connection field, which can be useful for performance optimization. The change also updates the Strawberry GraphQL dependency to 0.258.0 and Ruff to 0.9.1.

Class diagram for updated connection field structure

classDiagram
    class StrawberryDjangoConnectionExtension {
        +max_results: Optional[int]
        +__init__(max_results: Optional[int])
    }

    class connection {
        +field_name: str
        +max_results: Optional[int]
        +filters: Optional[type]
        +order: Optional[type]
        +extensions: Sequence[FieldExtension]
    }

    class WindowPagination {
        +apply_window_pagination()
        +offset: int
        +limit: Optional[int]
        +max_results: Optional[int]
    }

    connection --> StrawberryDjangoConnectionExtension
    StrawberryDjangoConnectionExtension --> WindowPagination
Loading

File-Level Changes

Change Details Files
Added max_results argument to connection fields
  • The connection field now accepts a max_results argument.
  • The StrawberryDjangoConnectionExtension now accepts a max_results argument.
strawberry_django/fields/field.py
Updated pagination logic to respect max_results
  • The apply_window_pagination function now uses max_results if provided, otherwise it falls back to the default limit.
  • The _optimize_prefetch_queryset function now passes max_results to apply_window_pagination.
strawberry_django/pagination.py
strawberry_django/optimizer.py
Updated dependencies
  • Updated strawberry-graphql dependency to 0.258.0.
  • Updated ruff dependency to 0.9.1.
pyproject.toml
poetry.lock
.pre-commit-config.yaml

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 @bellini666 - I've reviewed your changes and they look great!

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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov-commenter
Copy link

codecov-commenter commented Jan 12, 2025

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 89.05%. Comparing base (dbaf898) to head (2694167).

Files with missing lines Patch % Lines
strawberry_django/pagination.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #689   +/-   ##
=======================================
  Coverage   89.05%   89.05%           
=======================================
  Files          42       42           
  Lines        3836     3836           
=======================================
  Hits         3416     3416           
  Misses        420      420           

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

@bellini666 bellini666 merged commit 5e7cece into main Jan 12, 2025
30 checks passed
@bellini666 bellini666 deleted the connection_max_results branch January 12, 2025 11:29
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