Skip to content

sozo(unrealengine): handle UE5.6 and Dojo 1.5 - #3252

Merged
glihm merged 1 commit into
dojoengine:mainfrom
caillef:unreal-bindgen-fix
Jun 23, 2025
Merged

sozo(unrealengine): handle UE5.6 and Dojo 1.5#3252
glihm merged 1 commit into
dojoengine:mainfrom
caillef:unreal-bindgen-fix

Conversation

@caillef

@caillef caillef commented Jun 21, 2025

Copy link
Copy Markdown
Contributor

This PR fixes the generated files using sozo build --unrealengine.

  • std::vector are not working anymore in UE5.6, we must use TArray
  • Handle the new pagination system (not implemented yet but at least it compiles and fetch the latest 1000 entities)

Summary by CodeRabbit

  • Bug Fixes
    • Improved compatibility with Unreal Engine by updating how string collections are handled in asynchronous functions.
    • Enhanced entity fetching by switching to a paginated approach for better data management and reliability.

@coderabbitai

coderabbitai Bot commented Jun 21, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Ohayo sensei! This update refactors internal logic in the Unreal Engine plugin by replacing std::vector<std::string> with Unreal's TArray<std::string>, updates entity fetching to use a paginated API, and adjusts error handling and data access accordingly. No changes were made to public or exported entity declarations.

Changes

File(s) Change Summary
crates/dojo/bindgen/src/plugins/unrealengine/... Switched from std::vector<std::string> to TArray<std::string>, updated entity fetch API usage, and revised error/data handling in async functions.

Suggested reviewers

  • kariy
  • glihm

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79963e2 and 62eb3e7.

📒 Files selected for processing (1)
  • crates/dojo/bindgen/src/plugins/unrealengine/mod.rs (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: fmt
🔇 Additional comments (3)
crates/dojo/bindgen/src/plugins/unrealengine/mod.rs (3)

1238-1238: Ohayo sensei! LGTM - Perfect UE5.6 compatibility fix!

The replacement of std::vector<std::string> with TArray<std::string> and corresponding push_back to Add method change is exactly what's needed for UE5.6 compatibility. This aligns perfectly with the PR objectives.

Also applies to: 1244-1244


1257-1257: Consistent application of UE5.6 fix - nice work sensei!

Same container type migration applied consistently to ExecuteFromOutside function. The uniform application of these changes across both execution functions ensures compatibility.

Also applies to: 1263-1263


1274-1288: Ohayo! Solid pagination implementation for Dojo 1.5 sensei!

The migration to ResultPageEntity with paginated data access (&resEntities.ok.items) correctly implements the new Dojo 1.5 API. The hardcoded 1000 entity limit aligns with the PR's preliminary pagination support goals.

The error handling updates (ErrPageEntity tag) and cleaner async lambda formatting are well-executed improvements.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this 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.

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
glihm merged commit de22474 into dojoengine:main Jun 23, 2025
9 checks passed
glihm added a commit that referenced this pull request Jul 3, 2025
* Fix broken getting started link in README (#3235)

* chore(versions): add torii 1.5.6

* Update DEVELOPMENT.md (#3236)

* Update DEVELOPMENT.md with new instructions

* Update scripts/rebuild_test_artifacts.sh with Rabbit suggestion

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Respond to review comments

* Respond to review comments II

* Respond to review comments III

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* feat: update rpc spec to 0.8 (#3179)

* release(prepare): v1.6.0-alpha.0 (#3241)

Prepare release: v1.6.0-alpha.0

Co-authored-by: glihm <glihm@users.noreply.github.com>

* chore(versions): bump katana to 1.6.0-alpha.0

* fix(dojoup): remove new line in the source cmd (#3244)

fix: fixed new line in the source cmd

* chore: edited the build badge and its link (#3221)

Co-authored-by: Ammar Arif <evergreenkary@gmail.com>

* chore(devcontainer): update image: v1.6.0-alpha.0 (#3242)

Update devcontainer image: v1.6.0-alpha.0

Co-authored-by: glihm <glihm@users.noreply.github.com>

* chore: add katana 1.5.4 (#3245)

* chore: add the missing backticks in the comments (#3243)

Signed-off-by: one230six <723682061@qq.com>

* fix(bindgen): use world namespace for imported models in TypeScript S… (#3249)

* fix(bindgen): filter out Value models (#3248)

* fix(bindgen): fix ts bytearray type mapping (#3247)

* chore: update katana versions (#3253)

add katana versions

* sozo(unrealengine): handle UE5.6 and Dojo 1.5 (#3252)

* fix(sozo): assert caller permission with match (#3254)

* handle call_contract_syscall() result for better panic trace

* avoid using 0 as caller address

* remove temporarly the RPC version check.

Currently, Katana uses the new RPC types, without
bumping the spec version. To ensure we can still use
sozo with sepolia/mainnet and Katana, Sozo will not check
the RPC version for now

* update test dbs

---------

Co-authored-by: glihm <dev@glihm.net>

* feat(sozo): create standalone bindgen command (#3246)

* feat: create standalone bindgen command

* cleanup unused inputs

* remove dbg

* add meaningful error if project is not built

---------

Co-authored-by: glihm <dev@glihm.net>

* feat(sozo): add MCP sever (#3256)

* feat(sozo): add mvp for mcp server

* refacto: restructure MCP server

* evaluate changes using official rust sdk

* feat(mcp): add stdio support

* refacto with rmcp crate

* wip

* bump rmcp

* add testing support

* wip

* refacto

* cleanup

* add instructions

* add instructions

* wip test

* refacto tests

* add debugging

* ignore test with katana at the moment

* fix typos and sozo path

* refacto uri parsing

* remove dbg

* disable test that should be run with katana

* fix test, windows fails because of new reqwest version

* refactor(types): schema json sql value (#3257)

* refactor(types): schema json sql value

* remove excess comma

* fix clippy

---------

Co-authored-by: glihm <dev@glihm.net>

* chore: bump cairo packages to 1.6.0-alpha.0

* fix(mcp): ensure test is using latest version

* split scarb metadata ext in a different crate for dependencies

* wip: controller issue

* wip

* wip: resolve conflicts and update deps

* cleanup

* lint

* wip

* wip tests

* fix all tests

* rebuild test db

* fix: run linter

* fix slot dep with github commit

* fix clippy

* fix inspect by adding missing json format

* fix mcp formatting

* fix stdio_test

* use sozo from path

---------

Signed-off-by: one230six <723682061@qq.com>
Co-authored-by: Ritik <ritikverma0050@gmail.com>
Co-authored-by: Daniel Kronovet <kronovet@gmail.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Ammar Arif <evergreenkary@gmail.com>
Co-authored-by: Tarrence van As <tarrencev@users.noreply.github.com>
Co-authored-by: glihm <glihm@users.noreply.github.com>
Co-authored-by: Benjamin <158306087+bengineer42@users.noreply.github.com>
Co-authored-by: braveocheretovych <braveocheretovych@gmail.com>
Co-authored-by: one230six <163239332+one230six@users.noreply.github.com>
Co-authored-by: Brother MartianGreed <valentin@pupucecorp.com>
Co-authored-by: Corentin Cailleaud <corentin.cailleaud@caillef.com>
Co-authored-by: Rémy Baranx <remy.baranx@gmail.com>
Co-authored-by: Larko <59736843+Larkooo@users.noreply.github.com>
glihm added a commit that referenced this pull request Jul 14, 2025
…3266)

* feat: add external contract registering in the world (#3195)

* Use the world as external contract reference and manage upgrades with sozo

* update spawn-and-move with new external contract features

* update test artifacts + world_address in dojo_dev.toml

* export entrypoints + fix tests + remove TODO RBA

* restore test_metadata_updated_event test

* fix tests

* rabbit improvements

* fix test

* feat: add proc macros (#3212)

* WIP

* add macros + core-tests crates + update them from 1.6.0

* update scripts/cairo_fmt.sh + fix fmt

* update CI + Scarb.toml files

* fix fmt

* change from 2.11.2 to 2.11.4

* fix scarb issue + fmt

* one testing library for each test runner (cairo, snfoundry) + update examples

* fix fmt

* update comment

* chore: apply patches to sync exact same commits than scarb

* fix(ci): update rust-toolchain version

* fix(ci): bump clippy to use nightly compatible with 1.86

* fix: clippy and fmt

* update spawn-and-move to use dojo-snf-test

* update world address

---------

Co-authored-by: glihm <dev@glihm.net>

* Scarb crate removing (#3223)

* introduce scarb_interop crate

* handle missing scarb

* introduce metadata instead of workspace to manage dojo related paths and config

* add stats back and ensure profile is propagated until build not only metadata

* cleanup and add error message if SCARB is not set correctly

* add features + packages to build command

* update scarb build/test command

* refactor packages/features

* fix utils.rs + enable auth command

* fix rust fmt

* re-enable sozo commands

* re-enable the last sozo commands + new version command

* fix issue with conflicts_with_all

* check if manifest_path does not exist

* set run() functions as async instead of using tokio

* update init command management

* refactor metadata loading + dead code cleaning

* add build_simple_dev() function to be used to easily build spawn-and-move for tests/benches

* update tests + fmt + clippy

* remove dojo/lang

* remove useless sozo files

* tiny change

* fix CI

* use scarb nightly in CI

* fix manifest_path/manifest_dir issue

* fix fmt

* update snfoundry version + update tests accordingly + add cairo-profiler to .tool-versions

---------

Co-authored-by: glihm <dev@glihm.net>

* feat: add DojoStore trait to handle storage serialization (#3219)

* add DojoStore management

* fix rust fmt after abigen

* fix ModelReader

* fix fmt

* set DojoStore functions as inline(always)

* update test artifacts

* fix fmt

* remove dojo-core test from CI as all tests are now in core-tests

* feat: add block number for external contract events (#3224)

* add block_number to ExternalContractRegistered/ExternalContractUpgraded events

* remove useless println

* restore external_contracts tests + update with block_number

* update test artifacts

* fix clippy

* rework: handle block_number

* fix world.dns for external contract + update tests

* update sozo events with missing events

* add a self-managed external contract called from spawn-and-move

* update manifest_dev.json

* use dns_address

* fix fmt + abigen

* update test artifacts

* fix fmt

* update starkli path

* update policies

* rebuild test db

* fix: restore resource order to avoid storage conflict (#3238)

* Resource enum variant order should not change as it is used in the world storage

* fix fmt

* fix world address and test db

* fix fmt

---------

Co-authored-by: glihm <dev@glihm.net>

* fix(lang): remove warning with unit type (#3255)

fix warning with unit type for enumerations serialization generated code.

* dev: merge main in dev 1.6.0 (#3263)

* Fix broken getting started link in README (#3235)

* chore(versions): add torii 1.5.6

* Update DEVELOPMENT.md (#3236)

* Update DEVELOPMENT.md with new instructions

* Update scripts/rebuild_test_artifacts.sh with Rabbit suggestion

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Respond to review comments

* Respond to review comments II

* Respond to review comments III

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* feat: update rpc spec to 0.8 (#3179)

* release(prepare): v1.6.0-alpha.0 (#3241)

Prepare release: v1.6.0-alpha.0

Co-authored-by: glihm <glihm@users.noreply.github.com>

* chore(versions): bump katana to 1.6.0-alpha.0

* fix(dojoup): remove new line in the source cmd (#3244)

fix: fixed new line in the source cmd

* chore: edited the build badge and its link (#3221)

Co-authored-by: Ammar Arif <evergreenkary@gmail.com>

* chore(devcontainer): update image: v1.6.0-alpha.0 (#3242)

Update devcontainer image: v1.6.0-alpha.0

Co-authored-by: glihm <glihm@users.noreply.github.com>

* chore: add katana 1.5.4 (#3245)

* chore: add the missing backticks in the comments (#3243)

Signed-off-by: one230six <723682061@qq.com>

* fix(bindgen): use world namespace for imported models in TypeScript S… (#3249)

* fix(bindgen): filter out Value models (#3248)

* fix(bindgen): fix ts bytearray type mapping (#3247)

* chore: update katana versions (#3253)

add katana versions

* sozo(unrealengine): handle UE5.6 and Dojo 1.5 (#3252)

* fix(sozo): assert caller permission with match (#3254)

* handle call_contract_syscall() result for better panic trace

* avoid using 0 as caller address

* remove temporarly the RPC version check.

Currently, Katana uses the new RPC types, without
bumping the spec version. To ensure we can still use
sozo with sepolia/mainnet and Katana, Sozo will not check
the RPC version for now

* update test dbs

---------

Co-authored-by: glihm <dev@glihm.net>

* feat(sozo): create standalone bindgen command (#3246)

* feat: create standalone bindgen command

* cleanup unused inputs

* remove dbg

* add meaningful error if project is not built

---------

Co-authored-by: glihm <dev@glihm.net>

* feat(sozo): add MCP sever (#3256)

* feat(sozo): add mvp for mcp server

* refacto: restructure MCP server

* evaluate changes using official rust sdk

* feat(mcp): add stdio support

* refacto with rmcp crate

* wip

* bump rmcp

* add testing support

* wip

* refacto

* cleanup

* add instructions

* add instructions

* wip test

* refacto tests

* add debugging

* ignore test with katana at the moment

* fix typos and sozo path

* refacto uri parsing

* remove dbg

* disable test that should be run with katana

* fix test, windows fails because of new reqwest version

* refactor(types): schema json sql value (#3257)

* refactor(types): schema json sql value

* remove excess comma

* fix clippy

---------

Co-authored-by: glihm <dev@glihm.net>

* chore: bump cairo packages to 1.6.0-alpha.0

* fix(mcp): ensure test is using latest version

* split scarb metadata ext in a different crate for dependencies

* wip: controller issue

* wip

* wip: resolve conflicts and update deps

* cleanup

* lint

* wip

* wip tests

* fix all tests

* rebuild test db

* fix: run linter

* fix slot dep with github commit

* fix clippy

* fix inspect by adding missing json format

* fix mcp formatting

* fix stdio_test

* use sozo from path

---------

Signed-off-by: one230six <723682061@qq.com>
Co-authored-by: Ritik <ritikverma0050@gmail.com>
Co-authored-by: Daniel Kronovet <kronovet@gmail.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Ammar Arif <evergreenkary@gmail.com>
Co-authored-by: Tarrence van As <tarrencev@users.noreply.github.com>
Co-authored-by: glihm <glihm@users.noreply.github.com>
Co-authored-by: Benjamin <158306087+bengineer42@users.noreply.github.com>
Co-authored-by: braveocheretovych <braveocheretovych@gmail.com>
Co-authored-by: one230six <163239332+one230six@users.noreply.github.com>
Co-authored-by: Brother MartianGreed <valentin@pupucecorp.com>
Co-authored-by: Corentin Cailleaud <corentin.cailleaud@caillef.com>
Co-authored-by: Rémy Baranx <remy.baranx@gmail.com>
Co-authored-by: Larko <59736843+Larkooo@users.noreply.github.com>

* feat(core): use metaprogramming for tuple and fixed size array Introspect and DojoStore (#3260)

* reuse Starkware metaprogramming stuff to manage tuples

* fix fmt + clippy + artifacts

* use metaprogramming to handle tuple introspect

* fix fmt + clippy + artifacts

* add fixed size array support

* update dojo-world

* update abigen + artifacts after rebase

* add a sum_sizes function

* update artifacts

* tooling: add cairo-bench tool + bench tests (#3240)

* add cairo-bench tool

* add bench tests

* first optimisation batch

* fix fmt

* add license info

* update artifacts after rebase

* fix cairo-bench tests

* update artifacts

* update artifacts

* update scarb lock

---------

Co-authored-by: glihm <dev@glihm.net>

* fix(cairo-bench): use write and threshold + refactor fixed size array (#3267)

* remove update-ref-test-list argument

* add threshold parameter to cairo-bench (set to 3% by default)

* max_fee_raw and fee_estimate_multiplier don't exist anymore

* update sozo model commands for fixed size arrays

* fix fmt + clippy

* rename --update-ref to --write

* fix some tests

* fix fmt

* fix(ci): update katana to 1.6.2 for compatible db

---------

Signed-off-by: one230six <723682061@qq.com>
Co-authored-by: Rémy Baranx <remy.baranx@gmail.com>
Co-authored-by: Ritik <ritikverma0050@gmail.com>
Co-authored-by: Daniel Kronovet <kronovet@gmail.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Ammar Arif <evergreenkary@gmail.com>
Co-authored-by: Tarrence van As <tarrencev@users.noreply.github.com>
Co-authored-by: glihm <glihm@users.noreply.github.com>
Co-authored-by: Benjamin <158306087+bengineer42@users.noreply.github.com>
Co-authored-by: braveocheretovych <braveocheretovych@gmail.com>
Co-authored-by: one230six <163239332+one230six@users.noreply.github.com>
Co-authored-by: Brother MartianGreed <valentin@pupucecorp.com>
Co-authored-by: Corentin Cailleaud <corentin.cailleaud@caillef.com>
Co-authored-by: Larko <59736843+Larkooo@users.noreply.github.com>
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