feat: improve world contract performance

[remybar]

Description

Try some ideas to improve the performance of world contract functions to decrease the cost of the Dojo layer when manipulating model data.

Related issue

N/A

Tests

N/A

Added to documentation?

N/A

Checklist

• I've formatted my code (scripts/prettier.sh, scripts/rust_fmt.sh, scripts/cairo_fmt.sh)
• I've linted my code (scripts/clippy.sh, scripts/docs.sh)
• I've commented my code
• I've requested a review after addressing the comments

Summary by CodeRabbit

• New Features

  • Introduced new structures for data modeling, enhancing entity management capabilities, including CaseNotPacked and ComplexModel.
  • Added a deploy_world function for initializing a game world with new structures.
  • Included a benchmark test function for setting different entity types in the world.

• Improvements

  • Simplified array syntax across multiple files for enhanced readability and maintainability.
  • Improved error handling and efficiency in access control checks.

• Configuration Updates

  • Updated class_hash and original_class_hash values in multiple configuration files, reflecting changes to underlying contracts and models.

[codecov]

Codecov Report

Attention: Patch coverage is 46.93878% with 26 lines in your changes missing coverage. Please review.

Project coverage is 69.60%. Comparing base (a9b0bc5) to head (60da8bb).
Report is 1 commits behind head on main.

Files	Patch %	Lines
crates/sozo/ops/src/migration/migrate.rs	46.93%	26 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2287   +/-   ##
=======================================
  Coverage   69.60%   69.60%           
=======================================
  Files         352      352           
  Lines       46037    46031    -6     
=======================================
- Hits        32043    32040    -3     
+ Misses      13994    13991    -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Ohayo, sensei! The recent changes to the codebase primarily involve a simplification of array initialization syntax across multiple files, moving from the array![] macro to the standard [] notation. This enhances readability and maintainability without altering the underlying functionality. Additionally, new structures and test functions have been introduced to improve modeling capabilities and testing efficiency, reflecting a refined approach to data management within the application.

Changes

Files (Grouped)	Change Summary
crates/dojo-core/src/contract/upgradeable.cairo crates/dojo-core/src/model/introspect.cairo crates/dojo-core/src/model/metadata.cairo crates/dojo-core/src/model/model.cairo crates/dojo-core/src/storage/database.cairo	Replaced array![] with [] for empty arrays or fixed-size arrays in various functions, enhancing syntax simplicity.
crates/dojo-core/src/storage/layout.cairo crates/dojo-core/src/storage/storage.cairo crates/dojo-core/src/utils/test.cairo crates/dojo-core/src/utils/utils.cairo	Continued use of the [] syntax for array initialization in multiple functions, maintaining clarity and consistency in the codebase.
crates/dojo-core/src/tests/benchmarks.cairo	Introduced new structures (CaseNotPacked, ComplexModel) and functions (deploy_world, test_benchmark_set_entity) for improved testing and data modeling.
crates/dojo-core/src/world/world_contract.cairo	Refactored access control checks (assert_resource_owner, assert_namespace_write_access) for clarity and efficiency, alongside minor syntax adjustments.
examples/spawn-and-move/*.toml	Updated class_hash and original_class_hash values across various configuration files, indicating changes in underlying contract implementations.
examples/spawn-and-move/manifests/release/base/*.toml	Similar updates to class_hash and original_class_hash in release manifests, ensuring consistency with new versions of contracts.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant World
    participant Contract

    User->>World: Deploy Contract
    World->>Contract: Initialize with Class Hash
    Contract->>World: Confirm Deployment
    World-->>User: Deployment Successful

Loading

sequenceDiagram
    participant User
    participant Storage

    User->>Storage: Set Entity
    Storage-->>User: Confirm Set
    User->>Storage: Get Entity
    Storage-->>User: Return Entity Data

Loading

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[glihm]

Nice @remybar let's keep iterating on that, const array was a good start + the branching. 👍