-
Notifications
You must be signed in to change notification settings - Fork 45
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
fix: create dojo issue, syscalls #308
Conversation
WalkthroughThe pull request introduces changes to the Changes
Possibly related PRs
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- examples/example-vite-react-sdk/src/useSystemCalls.ts (1 hunks)
- packages/create-dojo/.npmignore (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- packages/create-dojo/.npmignore
🔇 Additional comments (1)
examples/example-vite-react-sdk/src/useSystemCalls.ts (1)
30-35
: Verify state synchronization and race conditions
The optimistic update implementation could benefit from additional safeguards:
- Consider adding a timeout to
waitForEntityChange
- Validate that multiple spawn calls for the same entity don't conflict
- Verify that
remainingMoves
is within valid bounds
Let's check for potential race conditions and multiple spawn calls:
state.applyOptimisticUpdate(transactionId, (draft) => { | ||
if (draft.entities[entityId]?.models?.dojo_starter?.Moves) { | ||
draft.entities[entityId].models.dojo_starter.Moves.remaining = | ||
remainingMoves; | ||
} | ||
}); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Consider initializing the entity structure if missing
While the null check prevents runtime errors, silently skipping the update when the structure doesn't exist might lead to unexpected behavior. Consider initializing the full entity structure if it's missing.
Here's a more robust implementation:
state.applyOptimisticUpdate(transactionId, (draft) => {
- if (draft.entities[entityId]?.models?.dojo_starter?.Moves) {
- draft.entities[entityId].models.dojo_starter.Moves.remaining =
- remainingMoves;
- }
+ if (!draft.entities[entityId]) {
+ draft.entities[entityId] = {
+ models: {
+ dojo_starter: {
+ Moves: { remaining: remainingMoves }
+ }
+ }
+ };
+ } else if (!draft.entities[entityId]?.models?.dojo_starter?.Moves) {
+ draft.entities[entityId].models.dojo_starter = {
+ ...draft.entities[entityId]?.models?.dojo_starter,
+ Moves: { remaining: remainingMoves }
+ };
+ } else {
+ draft.entities[entityId].models.dojo_starter.Moves.remaining = remainingMoves;
+ }
});
This ensures the entity structure is properly initialized while maintaining the safety checks.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
state.applyOptimisticUpdate(transactionId, (draft) => { | |
if (draft.entities[entityId]?.models?.dojo_starter?.Moves) { | |
draft.entities[entityId].models.dojo_starter.Moves.remaining = | |
remainingMoves; | |
} | |
}); | |
state.applyOptimisticUpdate(transactionId, (draft) => { | |
if (!draft.entities[entityId]) { | |
draft.entities[entityId] = { | |
models: { | |
dojo_starter: { | |
Moves: { remaining: remainingMoves } | |
} | |
} | |
}; | |
} else if (!draft.entities[entityId]?.models?.dojo_starter?.Moves) { | |
draft.entities[entityId].models.dojo_starter = { | |
...draft.entities[entityId]?.models?.dojo_starter, | |
Moves: { remaining: remainingMoves } | |
}; | |
} else { | |
draft.entities[entityId].models.dojo_starter.Moves.remaining = remainingMoves; | |
} | |
}); |
Summary by CodeRabbit
Bug Fixes
useSystemCalls
hook to prevent runtime errors during optimistic updates.Chores
.npmignore
file to thecreate-dojo
package to manage files included in npm publishing.