Skip to content

fix: recs getEventMessages #443

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

Merged
merged 1 commit into from
May 12, 2025
Merged

fix: recs getEventMessages #443

merged 1 commit into from
May 12, 2025

Conversation

MartianGreed
Copy link
Collaborator

@MartianGreed MartianGreed commented May 12, 2025

Closes #

Introduced changes

Checklist

  • Linked relevant issue
  • Updated relevant documentation
  • Added relevant tests
  • Add a dedicated CI job for new examples
  • Performed self-review of the code

Summary by CodeRabbit

  • Bug Fixes

    • Resolved an issue causing excessive looping when retrieving event messages, resulting in improved stability and correctness for event handling.
  • Chores

    • Updated dependencies for improved compatibility across several packages.

@MartianGreed MartianGreed marked this pull request as ready for review May 12, 2025 19:24
Copy link

coderabbitai bot commented May 12, 2025

Walkthrough

This update applies patch releases to several @dojoengine packages, focusing on refining the event message retrieval logic in the state management module to address a looping issue. Dependency updates are made in the predeployed-connector package, and internal logic for paginated fetching in event and entity queries is improved to prevent infinite loops.

Changes

Files / Areas Changed Summary
.changeset/afraid-berries-go.md Documents the patch updates and the fix for the event message retrieval looping issue.
packages/predeployed-connector/package.json Adds @starknet-react/core, react, react-dom, and starknet as dependencies and peerDependencies.
packages/state/src/recs/index.ts Refines paginated fetching logic in getEvents and getEntitiesQuery to prevent infinite/excessive loops.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant StateModule

    Client->>StateModule: Call getEvents or getEntitiesQuery(limit)
    loop While continueFetching
        StateModule->>StateModule: Fetch batch of items
        alt Items.length < limit and no next_cursor
            StateModule->>StateModule: Set continueFetching = false
            StateModule-->>Client: Return accumulated results
        else Items.length < limit or no items
            StateModule->>StateModule: Set continueFetching = false
            StateModule-->>Client: Return accumulated results
        else
            StateModule->>StateModule: Continue fetching with next_cursor
        end
    end
Loading

Possibly related PRs

  • fix: set entites bug #263: Also modifies getEntitiesQuery in packages/state/src/recs/index.ts to improve fetch control flow, directly related to the logic refined in this PR.

Poem

In the fields of code, where the fetchers roam,
A looping bug once called its home.
But now with checks both sharp and neat,
The queries end, the loops retreat!
Dependencies bloom, the garden grows—
A rabbit hops where logic flows. 🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/state/src/recs/index.ts (1)

247-251: Consider using proper logging levels for diagnostic messages.

While the added debug logs are useful for diagnosing the fix, they're using console.error() for non-error information. This could be confusing when reviewing logs.

-            console.error("STOP FETCHING");
+            if (logging) console.log("Stopping fetch: No more items");
...
-            console.error("NEXT_CURSOR", entities.next_cursor);
+            if (logging) console.log("Using next cursor:", entities.next_cursor);
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cb208ca and e1be67a.

📒 Files selected for processing (3)
  • .changeset/afraid-berries-go.md (1 hunks)
  • packages/predeployed-connector/package.json (1 hunks)
  • packages/state/src/recs/index.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: check
🔇 Additional comments (5)
packages/predeployed-connector/package.json (1)

67-71: Added StarkNet and React dependencies to align with peer dependencies.

The added dependencies match the existing peer dependencies, which is a good practice for a React-based package. This ensures compatibility between the package's code and its consumers.

packages/state/src/recs/index.ts (3)

241-244: Fix for infinite loop in getEvents by adding early termination condition.

This change correctly adds an early termination condition to stop fetching when both criteria are met: the number of items is less than the requested limit AND there's no next cursor. This prevents unnecessary additional requests and potential infinite loops.


291-303: Moved fetch call inside the loop for consistency.

Moving the fetch call inside the loop in getEntitiesQuery improves code consistency with other similar functions and simplifies the control flow.


311-317: Added consistent termination condition in getEntitiesQuery.

This change implements the same loop termination logic as in getEvents, ensuring consistent behavior between both functions when dealing with paginated results. Good for maintainability and preventing infinite loops.

.changeset/afraid-berries-go.md (1)

1-16: Appropriate changelog for the fix across multiple packages.

The changeset correctly identifies all affected packages and provides a clear description of the fix, which matches the code changes we've seen.

@MartianGreed MartianGreed merged commit bc12d45 into main May 12, 2025
5 checks passed
@MartianGreed MartianGreed deleted the fix/recs-get-eventmessages branch May 12, 2025 19:35
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.

1 participant