Skip to content
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

feat: remove field order from sdk #395

Merged
merged 1 commit into from
Feb 13, 2025
Merged

Conversation

MartianGreed
Copy link
Collaborator

@MartianGreed MartianGreed commented Feb 13, 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

  • Chores
    • Updated several core engine dependencies for enhanced performance, stability, and security.
  • Refactor
    • Streamlined data organization for greater flexibility, paving the way for more dynamic future functionality.

Copy link

coderabbitai bot commented Feb 13, 2025

Walkthrough

This update patches multiple Dojo Engine dependencies by bumping their versions and adjusting configuration details. The changes specifically remove the fieldOrder property from the SchemaType in the SDK, affecting how model data is structured. Additionally, the torii-client package now has its field order removed and its version incremented.

Changes

File(s) Summary
.changeset/great-olives-listen.md Patch update for multiple Dojo Engine packages (e.g., @dojoengine/sdk, template-vite-ts, @dojoengine/core, etc.). Also, removes field order and increments the torii-client version.
packages/sdk/src/types.ts Removed the fieldOrder: string[] property from the SchemaType model, altering the schema structure for dynamic field ordering.

Possibly related PRs

Suggested reviewers

  • ponderingdemocritus

Poem

I'm hopping through the code with glee,
No more lines of order—wild and free!
Carrots crunch in data streams,
A bunny’s patch fuels coding dreams.
With each update, leaps of joy decree!
🥕🐇 Happy hops in every key!


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f06a3b8 and ded4be2.

📒 Files selected for processing (2)
  • .changeset/great-olives-listen.md (1 hunks)
  • packages/sdk/src/types.ts (0 hunks)
💤 Files with no reviewable changes (1)
  • packages/sdk/src/types.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: check
  • GitHub Check: build
🔇 Additional comments (1)
.changeset/great-olives-listen.md (1)

16-17: Complete PR requirements before merging.

The PR description is empty and the checklist items are incomplete. Please:

  1. Link the relevant issue
  2. Update documentation to reflect the field order removal
  3. Add relevant tests
  4. Perform a self-review
  5. Create CI job if needed

Comment on lines +1 to +13
---
"@dojoengine/sdk": patch
"template-vite-ts": patch
"@dojoengine/core": patch
"@dojoengine/create-burner": patch
"@dojoengine/create-dojo": patch
"@dojoengine/predeployed-connector": patch
"@dojoengine/react": patch
"@dojoengine/state": patch
"@dojoengine/torii-client": patch
"@dojoengine/torii-wasm": patch
"@dojoengine/utils": patch
"@dojoengine/utils-wasm": patch
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Update version bump type to align with semantic versioning.

The changes include a feature removal (field order) which is a feature change, but all packages are marked for patch updates. According to semantic versioning:

  • Patch updates (0.0.x) are for backwards-compatible bug fixes
  • Minor updates (0.x.0) are for new features or feature removals

Consider updating the affected packages (especially @dojoengine/sdk and @dojoengine/torii-client) to use minor version bumps instead of patches.

@MartianGreed MartianGreed merged commit 58251c1 into main Feb 13, 2025
6 checks passed
@MartianGreed MartianGreed deleted the feat/remove-field-order branch February 13, 2025 19:28
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