Skip to content

[quick PR] 1 line fix in gql.fix bookmark_folders_slice due to malformed variables #334

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

the-vampiire
Copy link

@the-vampiire the-vampiire commented Mar 21, 2025

1 line fix, closes #335

variables was redeclared with nested variables. this caused an infinite loop on next() calls as the variables were ignored due to being malformed.

really tough one to trace down. checked if it happened anywhere else and thankfully it does not.

thanks for the lib

Summary by Sourcery

Bug Fixes:

  • Fix a bug in bookmark_folders_slice where malformed variables caused an infinite loop.

Summary by CodeRabbit

  • Refactor
    • Streamlined how bookmark folder data is handled, simplifying the processing flow while maintaining the same bookmark experience.

variables was redeclared with nested variables. this caused an infinite loop on next() calls as the variables were ignored due to being malformed.
Copy link

sourcery-ai bot commented Mar 21, 2025

Reviewer's Guide by Sourcery

This pull request fixes an issue in the bookmark_folders_slice method where the GraphQL variables were being incorrectly nested, leading to an infinite loop. The fix involves removing the redundant nesting of the variables dictionary.

Sequence diagram for bookmark_folders_slice method

sequenceDiagram
  participant Client
  participant GQL
  Client->>Client: cursor is not None
  Client->>Client: variables['cursor'] = cursor
  Client->>GQL: gql_get(Endpoint.BOOKMARK_FOLDERS_SLICE, variables)
  GQL-->>Client: Response
Loading

File-Level Changes

Change Details Files
Fixed a malformed GraphQL variables declaration that was causing an infinite loop.
  • Removed the nested 'variables' key when constructing the variables dictionary for the bookmark_folders_slice method.
twikit/client/gql.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

Copy link
Contributor

coderabbitai bot commented Mar 21, 2025

Walkthrough

The change simplifies the bookmark_folders_slice method within the GQLClient class in the twikit/client/gql.py file. The method now constructs a variables dictionary based on the presence of a cursor and directly passes it to the asynchronous gql_get call. Previously, the dictionary was unnecessarily wrapped inside another dictionary with the key 'variables', which has now been removed. The modification does not alter the method signature or its overall functionality.

Changes

File(s) Summary
twikit/client/gql.py Updated bookmark_folders_slice in GQLClient by removing the extra dictionary wrapping for variables before calling gql_get.

Sequence Diagram(s)

sequenceDiagram
    actor Client
    participant GQLClient
    participant gql_get

    Client->>GQLClient: bookmark_folders_slice(cursor)
    GQLClient->>GQLClient: Construct variables dictionary (based on cursor)
    GQLClient->>gql_get: Call gql_get(variables)
    gql_get-->>GQLClient: Return result
    GQLClient-->>Client: Return result
Loading

Poem

I’m Rabbit, hopping through the lines of code so bright,
Variables now flow freely, making everything light.
No extra layers weighing down this delightful trace,
Each hop a cleaner step in our elegant data space.
Celebrate the change, let our code and carrots unite!
🐇🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3818195 and 398f393.

📒 Files selected for processing (1)
  • twikit/client/gql.py (0 hunks)
💤 Files with no reviewable changes (1)
  • twikit/client/gql.py

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

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

Overall Comments:

  • Thanks for fixing this tricky bug!
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.

@the-vampiire the-vampiire changed the title gql: fix bookmark_folders_slice malformed variables [quick PR] 1 line fix in gql.fix bookmark_folders_slice due to malformed variables Mar 21, 2025
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.

next() calls on result of get_bookmark_folders fail due to cursor being stuck
1 participant