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

add missing page_info / cursors for Association Proxy logic #232

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

tylernisonoff
Copy link

@tylernisonoff tylernisonoff commented Jan 22, 2025

Description

association_proxy_resolver_for has a few code blocks that were not updated for the relay changes. Association proxy mapping would fail due do constructors missing either page_info or cursor args.

Types of Changes

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

Issues Fixed or Closed by This PR

  • N/a

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).

I haven't added tests as it looks like this code is originally untested.

Summary by Sourcery

Bug Fixes:

  • Fix association proxy mapping failures due to missing page_info or cursor arguments in constructors.

Sorry, something went wrong.

Copy link
Contributor

sourcery-ai bot commented Jan 22, 2025

Reviewer's Guide by Sourcery

The pull request addresses a bug in the association_proxy_resolver_for function where it was not updated to handle relay pagination. This resulted in missing page_info and cursor arguments in the constructors, causing failures in association proxy mapping. The changes ensure that the connection_type is properly initialized with the necessary page_info and cursor data when resolving relationships.

Sequence diagram for association proxy resolver with relay pagination

Loading
sequenceDiagram
    participant Client
    participant Resolver
    participant AssociationProxy
    participant Connection

    Client->>Resolver: Request data
    Resolver->>AssociationProxy: resolve(info)
    alt in_between_objects is None
        AssociationProxy-->>Connection: Create with empty edges + PageInfo
    else has objects
        AssociationProxy->>AssociationProxy: Process objects
        AssociationProxy-->>Connection: Create with edges + PageInfo + cursors
    end
    Connection-->>Client: Return paginated data

Class diagram for connection types with relay pagination

Loading
classDiagram
    class PageInfo {
        +boolean has_next_page
        +boolean has_previous_page
        +string start_cursor
        +string end_cursor
    }

    class ConnectionType {
        +List~Edge~ edges
        +PageInfo page_info
    }

    class Edge {
        +Object node
        +string cursor
    }

    ConnectionType *-- PageInfo
    ConnectionType *-- Edge

File-Level Changes

Change Details Files
Add page_info and cursor arguments to the connection_type constructor when resolving relationships.
  • When no in-between objects are found, initialize connection_type with an empty list of edges and a page_info object with default values.
  • When in-between objects are found, initialize connection_type with a list of edges and a page_info object with start_cursor and end_cursor values.
src/strawberry_sqlalchemy_mapper/mapper.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. 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

@botberry
Copy link
Member

botberry commented Jan 22, 2025

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:


Fixes relay pagination logic fo association proxy logic.

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 @tylernisonoff - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The hardcoded has_next_page and has_previous_page values should be calculated based on the actual data and pagination parameters rather than always being set to False
  • Consider adding tests for the pagination behavior to prevent future regressions, even though the original code was untested
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.

@Ckk3
Copy link
Contributor

Ckk3 commented Feb 4, 2025

Thanks so muck for your contribuition, @tylernisonoff , sorry for the delay!

I'll review it ASAP!

@Ckk3 Ckk3 self-assigned this Feb 4, 2025
@Ckk3
Copy link
Contributor

Ckk3 commented Feb 10, 2025

Hi, @tylernisonoff , sorry for the delay.
Can you add some tests to guarantee we dont break this function on the future?

@tylernisonoff
Copy link
Author

@Ckk3 I'm happy to help here, but honestly I'm not sure I understand the code well enough to know how to write tests for this. I simply saw the stacktrace errors, and saw that these were not passing in the appropriate commands, but given the lack of tests for the code before, I'm not sure how to scaffold tests here without really digging deeper into the code :/

I'd be happy to try to implement with ideas, or allow someone who knows the internals better to build on top of this

@Ckk3
Copy link
Contributor

Ckk3 commented Feb 17, 2025

Thanks @tylernisonoff , can you send the stacktrace?

That way it easier to see if make sense create new tests for this.

Thanks again!

@tylernisonoff
Copy link
Author

tylernisonoff commented Feb 18, 2025

@Ckk3 heres a sample stacktrace:

File "/Users/user/Library/Caches/pypoetry/virtualenvs/project-S0mj9Dhs-py3.10/lib/python3.10/site-packages/graphql/execution/execute.py", line 523, in execute_field
    result = resolve_fn(source, info, **args)
  File "/Users/user/Library/Caches/pypoetry/virtualenvs/project-S0mj9Dhs-py3.10/lib/python3.10/site-packages/strawberry/extensions/tracing/datadog.py", line 179, in resolve
    return _next(root, info, *args, **kwargs)
  File "/Users/user/Library/Caches/pypoetry/virtualenvs/project-S0mj9Dhs-py3.10/lib/python3.10/site-packages/strawberry/schema/schema_converter.py", line 741, in _resolver
    return _get_result_with_extensions(
  File "/Users/user/Library/Caches/pypoetry/virtualenvs/project-S0mj9Dhs-py3.10/lib/python3.10/site-packages/strawberry/schema/schema_converter.py", line 728, in extension_resolver
    return reduce(
  File "/Users/user/Library/Caches/pypoetry/virtualenvs/project-S0mj9Dhs-py3.10/lib/python3.10/site-packages/strawberry/schema/schema_converter.py", line 723, in wrapped_get_result
    return _get_result(
  File "/Users/user/Library/Caches/pypoetry/virtualenvs/project-S0mj9Dhs-py3.10/lib/python3.10/site-packages/strawberry/schema/schema_converter.py", line 680, in _get_result
    return field.get_result(
  File "/Users/user/Library/Caches/pypoetry/virtualenvs/project-S0mj9Dhs-py3.10/lib/python3.10/site-packages/strawberry/types/field.py", line 223, in get_result
    return self.base_resolver(*args, **kwargs)
  File "/Users/user/Library/Caches/pypoetry/virtualenvs/project-S0mj9Dhs-py3.10/lib/python3.10/site-packages/strawberry/types/fields/resolver.py", line 206, in __call__
    return self.wrapped_func(*args, **kwargs)
  File "<non-library-code>", line 727, in <lib code>
    edges = [FooEdge(node=a) for a in awards]
  File "<non-library-code>", line 727, in <listcomp>
    edges = [FooEdge(node=a) for a in awards]
TypeError: FooEdge.__init__() missing 1 required keyword-only argument: 'cursor'

@Ckk3
Copy link
Contributor

Ckk3 commented Feb 19, 2025

Thanks, @tylernisonoff , I think we can reproduce this error!

Can you send the model declaration, the strawberry query (or mutation) and the sqlalchemy table?

Please make sure you dont send any private information, We just need the code example.

@Ckk3 Ckk3 removed their assignment Feb 25, 2025
@tylernisonoff
Copy link
Author

@Ckk3 sorry for the delay, my model declaration and strawberry queries are all proprietary code -- I dont have a simple local repro that could be used as a code example.

I dont want to put the onus on the maintainers, but realistically, I dont think I have the in-depth knowledge to set up a code sample -- im not sure what set-ups lead to hitting this code, I just saw we were hitting it, and that the code was clearly wrong.

Is there a chance we can merge this and work on tests after? The existing code is both untested and broken. This at least makes the current code untested but working.

@Ckk3
Copy link
Contributor

Ckk3 commented Mar 10, 2025

Thanks for your patience, @tylernisonoff!

I totally understand you, but I’m not comfortable merging this until we have tests in place. Untested code can easily lead to more bugs like this one, and we want to make sure things are solid before moving forward. I’ll go ahead and write the tests myself so we can make sure everything works properly before merging.

Thanks again for understanding, and I’ll get those tests added as soon as I can!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants