fix(bindgen): fix ts bytearray type mapping

[MartianGreed]

Description

Related issue

#3216

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of byte array types in TypeScript code generation, ensuring correct input type mapping.
• Tests
  • Added tests to verify accurate mapping of byte array types to string inputs.
• Style
  • Removed unnecessary trailing whitespace in documentation comments.

[coderabbitai]

Walkthrough

Ohayo sensei! This update adjusts TypeScript code generation for Cairo byte arrays. It removes the unnecessary ByteArray import from starknet and ensures that Cairo's ByteArray type is consistently mapped to JavaScript strings. Additional tests and a trait implementation for comparing type mappings are introduced. No logic or macro behavior is otherwise changed.

Changes

File(s)	Summary
crates/dojo/bindgen/src/plugins/typescript/generator/function.rs	Removed ByteArray from the starknet import list in check_imports.
crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs	Mapped CAIRO_BYTE_ARRAY to JS_STRING for input types; added test for this mapping; added PartialEq impl for tests.
crates/macros/merge-options/src/lib.rs	Removed trailing whitespace in a doc comment example.

Sequence Diagram(s)

sequenceDiagram
    participant CairoType
    participant JsTypeMapping
    participant TypeScriptGenerator

    CairoType->>JsTypeMapping: Request mapping for ByteArray
    JsTypeMapping-->>TypeScriptGenerator: Returns JS_STRING
    TypeScriptGenerator->>TypeScriptGenerator: Omits ByteArray from starknet imports

Loading

Possibly related PRs

• feat: add i128 + use BigNumberish type #2705: Adjusts the same check_imports method, modifying type handling and imports, closely related to the changes in this PR.

Suggested reviewers

• 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 f9ba1a9 and ae83f42.

📒 Files selected for processing (3)

• crates/dojo/bindgen/src/plugins/typescript/generator/function.rs (1 hunks)
• crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs (4 hunks)
• crates/macros/merge-options/src/lib.rs (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• crates/macros/merge-options/src/lib.rs

🚧 Files skipped from review as they are similar to previous changes (2)

• crates/dojo/bindgen/src/plugins/typescript/generator/function.rs
• crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: fmt

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🔭 Outside diff range comments (1)

crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs (1)

160-167: Ohayo sensei – ByteArray short-form is still unmapped

The new match arm correctly maps the full path (CAIRO_BYTE_ARRAY) to JS_STRING, but the test you add below expects the short literal "ByteArray" to resolve the same way.
Currently "ByteArray" falls through to the default branch and will remain "ByteArray", making the test (and generated TS) fail.

A minimal fix is to add an explicit arm (or a suffix check) for the short form in both JsPrimitiveInputType and JsPrimitiveType:

             CAIRO_CONTRACT_ADDRESS => JsPrimitiveInputType(JS_STRING.to_owned()),
             CAIRO_BYTE_ARRAY => JsPrimitiveInputType(JS_STRING.to_owned()),
+            // Allow using the short type without the full module path
+            "ByteArray" => JsPrimitiveInputType(JS_STRING.to_owned()),

Without this, cargo test will fail on test_byte_array_input_type.

🧹 Nitpick comments (1)

crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs (1)

378-395: Imported constants look good – minor style nit

Nice addition of JS_STRING to the test imports and the PartialEq shim for JsPrimitiveInputType.
You can simplify the comparison closure slightly:

-        fn eq(&self, other: &JsPrimitiveInputType) -> bool {
-            self == &other.0.as_str()
+        fn eq(&self, other: &JsPrimitiveInputType) -> bool {
+            *self == other.0
         }

No functional gain, just removes an extra reference & call.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4c0f09a and 2cfe3d2.

📒 Files selected for processing (2)

• crates/dojo/bindgen/src/plugins/typescript/generator/function.rs (1 hunks)
• crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: fmt

🔇 Additional comments (3)

crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs (1)

876-889: Test will fail until short-form mapping is added

As noted above, the second assert_eq! relies on "ByteArray" mapping to JS_STRING, which is not implemented yet. Merge will break CI unless the mapping arm is added.
After adding the extra match arm, this test will pass.

crates/dojo/bindgen/src/plugins/typescript/generator/function.rs (2)

22-25: Removal of ByteArray import LGTM

With ByteArray now mapped to plain string in generated TS, dropping it from the Starknet import keeps the bundle clean and avoids unused-import warnings.
No further action needed.

---

13-28: Quick sanity-check: detect residual ByteArray references

Just to be safe, run a quick grep to ensure no stale ByteArray symbols remain in the generator after this change:

#!/bin/bash
rg -n "ByteArray" crates/dojo/bindgen/src/plugins/typescript | head

Expect: only occurrences in tests or constant definitions, none inside production generator code.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

crates/dojo/bindgen/src/lib.rs (1)

267-267: Ohayo sensei! Replace magic number with self-documenting expectation

Bumping the expected model count from 8 → 9 works today but is brittle: any future model addition/removal will break the test again. Prefer deriving the expectation from the data you already have, or enumerating the expected tags and asserting on that list’s length—this keeps intent obvious and failures more informative.

-        assert_eq!(data.models.len(), 9);
+        // Expected models we explicitly care about; update list, not magic number.
+        let expected = ["ns-Position", "ns-Moves", "ns-Message", "ns-PlayerConfig", /* … */];
+        assert_eq!(data.models.len(), expected.len());
+        for tag in expected {
+            assert!(data.models.contains_key(tag), "{tag} missing");
+        }

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0a554ca and 10d2dbe.

📒 Files selected for processing (3)

• crates/dojo/bindgen/src/lib.rs (2 hunks)
• crates/dojo/bindgen/src/plugins/typescript/generator/function.rs (1 hunks)
• crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs (4 hunks)

✅ Files skipped from review due to trivial changes (1)

• crates/dojo/bindgen/src/plugins/typescript/generator/function.rs

🚧 Files skipped from review as they are similar to previous changes (1)

• crates/dojo/bindgen/src/plugins/typescript/generator/mod.rs

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: fmt

🔇 Additional comments (1)

crates/dojo/bindgen/src/lib.rs (1)

15-17: Ohayo sensei! Import re-order looks fine

Pure re-ordering; no semantic changes, compilation unaffected.