dojoengine / dojo.js

dojo.js - enter the dojo via js
https://dojoengine.github.io/dojo.js/
MIT License
23 stars 45 forks source link

feat: draft zustand state management system #280

Closed ponderingdemocritus closed 5 days ago

ponderingdemocritus commented 6 days ago

WIP:

Summary by CodeRabbit

coderabbitai[bot] commented 6 days ago

Walkthrough

The pull request introduces updates to the example-vite-react-sdk, transitioning to workspace dependencies in package.json and adding new libraries such as @types/uuid, immer, and zustand. The state management in App.tsx is refactored to utilize a custom hook, useDojoStore, which centralizes entity management and introduces an optimisticUpdate function. Additionally, new types and interfaces related to burner accounts are defined in packages/sdk/src/types.ts, enhancing the SDK's functionality.

Changes

Files Change Summary
examples/example-vite-react-sdk/package.json Updated dependencies to workspace references, added @types/uuid, uuid, immer, and zustand.
examples/example-vite-react-sdk/src/App.tsx Refactored state management to use useDojoStore, introduced optimisticUpdate function, adjusted entity rendering.
packages/sdk/package.json Added dependencies @rollup/plugin-commonjs, @dojoengine/create-burner, and immer.
packages/sdk/src/types.ts Introduced new types and interfaces for managing burner accounts and predeployed accounts.
packages/sdk/src/__example__/index.ts Added GalaxyModel interface and updated MockSchemaType to use it.
packages/sdk/src/__tests__/state.test.ts Added unit tests for createDojoStore function covering various functionalities.
packages/sdk/src/__tests__/zustand.perf.test.ts Introduced performance tests for Zustand store operations.
packages/sdk/src/state/zustand.ts Implemented Zustand store with Immer middleware for state management, defining GameState interface.

Possibly related PRs

🐇 In the code, we hop and play,
With new tools brightening our day.
State is managed with such great flair,
Optimistic updates fill the air!
Dependencies shift, a monorepo's grace,
In our coding burrow, we find our place! 🌟


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between aa6d5dfe7dc490c7ec9bf509f34daa5b6df9ad56 and cad1567c5c87063ac2d53af1e5505909a486843a.
📒 Files selected for processing (1) * .github/workflows/npx-test.yaml (0 hunks)
💤 Files not reviewed due to no reviewable changes (1) * .github/workflows/npx-test.yaml
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.