Skip to content

fix: optimistic update on spawn #346

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 2 commits into from
Dec 9, 2024
Merged

Conversation

starknetdev
Copy link
Contributor

@starknetdev starknetdev commented Nov 29, 2024

Introduced changes

Small fix to the dojo starter client example from an update function setting a state on an entity that may not exist.

Previous Behavior

On a new burner wallet, clicking spawn would result in error:

useSystemCalls.ts:69 Error executing spawn: Error: waitForEntityChange: Timeout of 6000ms exceeded

New Behavior

No error from waitForEntityChange and spawn updates as expected.

Summary by CodeRabbit

  • New Features

    • Improved logic for creating and updating entities in the system, ensuring proper initialization of new entities.
  • Bug Fixes

    • Enhanced error handling for spawn actions, ensuring better reliability during updates.

Copy link

coderabbitai bot commented Nov 29, 2024

Walkthrough

The changes in this pull request focus on the spawn function within the useSystemCalls custom hook in the useSystemCalls.ts file. The logic for handling entity creation and updates has been modified: the function now creates a new entity if it does not already exist and initializes its properties accordingly. The error handling and optimistic update mechanisms remain unchanged, ensuring proper logging and state management during failures.

Changes

File Path Change Summary
examples/example-vite-react-sdk/src/useSystemCalls.ts Modified the spawn function to improve entity creation and updating logic, ensuring new entities are initialized correctly. Error handling and optimistic updates remain intact.

Possibly related PRs

  • fix: create dojo issue, syscalls #308: The changes in this PR directly modify the spawn function within the useSystemCalls hook, which is the same function that was altered in the main PR, focusing on error handling and state update logic during the optimistic update process.

Poem

In the code where entities play,
A new spawn logic leads the way.
If not found, a new one’s born,
With moves to keep it from the scorn.
Errors logged, updates bright,
Hopping forward, all feels right! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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

🧹 Outside diff range and nitpick comments (1)
examples/example-vite-react-sdk/src/useSystemCalls.ts (1)

47-59: Consider these maintainability improvements.

  1. Extract the magic number as a constant:
+ const INITIAL_MOVES = 100;
  const spawn = async () => {
    const entityId = generateEntityId();
    const transactionId = uuidv4();
-   const remainingMoves = 100;
+   const remainingMoves = INITIAL_MOVES;
  1. Consider creating a type-safe entity model structure:
type DojoEntity = {
  entityId: string;
  models: {
    dojo_starter: {
      Moves: {
        remaining: number;
      };
    };
  };
};
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f52a83e and c179cc1.

📒 Files selected for processing (1)
  • examples/example-vite-react-sdk/src/useSystemCalls.ts (1 hunks)
🔇 Additional comments (2)
examples/example-vite-react-sdk/src/useSystemCalls.ts (2)

47-59: LGTM! This fixes the spawn timeout issue.

The changes correctly handle the case where the entity doesn't exist by creating it with the proper structure before setting the state. This resolves the timeout issue mentioned in the PR objectives.


47-59: Verify error handling with different wallet states.

The error handling looks robust, but let's verify the behavior with different wallet states to ensure the optimistic update is properly handled.

✅ Verification successful

Let me gather more context about the error handling implementation.


Let me fix the regex and try again.


Let me try a different approach to check the error handling implementation.


Based on the code analysis, I can now generate the final response:

Error handling implementation is robust and follows best practices

The error handling implementation in useSystemCalls.ts is well-structured and handles different wallet states appropriately:

  • Optimistic updates are properly managed with unique transaction IDs
  • Error handling includes try-catch-finally pattern with proper cleanup
  • Failed transactions are reverted using revertOptimisticUpdate
  • Successful transactions are confirmed in the finally block
  • Entity state changes are validated through waitForEntityChange
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other uses of optimistic updates in the codebase
# to ensure consistent error handling patterns
rg "applyOptimisticUpdate|revertOptimisticUpdate|confirmTransaction" --type ts

Length of output: 2684


Script:

#!/bin/bash
# Check the implementation of error handling in useSystemCalls.ts
rg -A 10 "try\s*{" examples/example-vite-react-sdk/src/useSystemCalls.ts

# Also check the test coverage for error scenarios
rg -A 5 "test\(.*error|describe\(.*error" --type ts

Length of output: 206


Script:

#!/bin/bash
# Check the implementation of error handling in useSystemCalls.ts
rg -A 10 "try {" examples/example-vite-react-sdk/src/useSystemCalls.ts

# Look for test cases related to error handling
rg -A 5 "test.*error|describe.*error" packages/sdk/src/__tests__/

Length of output: 214


Script:

#!/bin/bash
# Get the full content of useSystemCalls.ts to analyze error handling
cat examples/example-vite-react-sdk/src/useSystemCalls.ts

# Check test files for error handling patterns
ast-grep --pattern 'test($name, async () => {
  try {
    $$$
  } catch $$$
})'

Length of output: 3126

@starknetdev
Copy link
Contributor Author

I have just seen #343, so this may duplicate

@MartianGreed MartianGreed merged commit c179cc1 into dojoengine:main Dec 9, 2024
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