refactor(types): schema json sql value

[Larkooo]

Summary by CodeRabbit

• Refactor
  • Improved internal handling of numeric and address types when converting data to JSON, ensuring more consistent and reliable output for these values. No changes to visible features or functionality.

[coderabbitai]

Walkthrough

Ohayo sensei! This change refactors the to_json_value method in the Ty enum by centralizing the serialization of several primitive numeric types through a call to primitive.to_sql_value(). This replaces manual conversions and formatting, keeping public interfaces unchanged.

Changes

File(s)	Summary
crates/dojo/types/src/schema.rs	Refactored Ty::to_json_value to delegate serialization of numeric primitives to primitive.to_sql_value(). No changes to public interfaces.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Ty
    participant Primitive

    Caller->>Ty: to_json_value()
    alt Ty::Primitive variant (numeric types)
        Ty->>Primitive: to_sql_value()
        Primitive-->>Ty: SQL/JSON value
        Ty-->>Caller: JSON value
    else Other variants
        Ty-->>Caller: JSON value (other logic)
    end

Loading

Possibly related PRs

• feat(torii-core): json value for ty for efficient json ser #2730: Refactored to_json_value in Ty to delegate primitive serialization, directly relating to this change.
• fix(torii): u256 json serialization as string #3042: Changed U256 serialization format, also addressing JSON representation of numeric types.
• feat(torii): add eth address to ty and remove usize #2989: Introduced EthAddress and updated Primitive methods, including to_sql_value().

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 b5ec21d and 0f044bc.

📒 Files selected for processing (1)

• crates/dojo/types/src/schema.rs (1 hunks)

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

• crates/dojo/types/src/schema.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
• Commit Unit Tests in branch schema-sql-value

---

🪧 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: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5315244 and 9119a67.

📒 Files selected for processing (1)

• crates/dojo/types/src/schema.rs (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

crates/dojo/types/src/schema.rs (1)

crates/dojo/types/src/primitive.rs (1)

• to_sql_value (196-219)

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

• GitHub Check: fmt

🔇 Additional comments (5)

crates/dojo/types/src/schema.rs (5)

345-345: Ohayo sensei! LGTM - Clean refactor for I64.

The change to use primitive.to_sql_value() for I64 maintains decimal formatting and is compatible with the corresponding from_json_value parsing logic.

---

352-352: Ohayo sensei! U256 refactor looks good.

The U256 change is compatible since from_json_value uses U256::from_be_hex() which properly handles the hex format from to_sql_value().

---

353-354: Ohayo sensei! Felt252 and ClassHash changes look good.

These changes are compatible since Felt::from_str() used in from_json_value can handle the hex format output from to_sql_value().

---

356-356: Ohayo sensei! EthAddress change is compatible.

The EthAddress refactor looks good since Felt::from_str() used in from_json_value can handle the hex format.

---

345-356: Ohayo sensei! Verify round-trip serialization compatibility.

The format changes from decimal to hex for I128, U64, U128 may break round-trip serialization. Let's verify this concern with a test.

#!/bin/bash
# Description: Search for existing tests that verify round-trip serialization of these primitive types
# Expected: Find tests that create primitives, serialize to JSON, then deserialize back

echo "=== Searching for round-trip serialization tests ==="
rg -A 10 -B 5 "to_json_value.*from_json_value|from_json_value.*to_json_value"

echo "=== Searching for tests involving I128, U64, U128 JSON serialization ==="
rg -A 15 -B 5 "I128.*json|U64.*json|U128.*json"

echo "=== Searching for test files that might contain primitive serialization tests ==="
fd -e rs -x grep -l "to_json_value\|from_json_value" {} \;

[coderabbitai]

⚠️ Potential issue

Ohayo sensei! U128 has the same hex parsing issue.

U128 follows the same problematic pattern - hex output from to_sql_value() but decimal parsing in from_json_value (line 440).

Apply similar fix:

 Primitive::U128(v) => {
     if let JsonValue::String(s) = value {
-        *v = s.parse().ok();
+        if s.starts_with("0x") {
+            *v = u128::from_str_radix(&s[2..], 16).ok();
+        } else {
+            *v = s.parse().ok();
+        }
     }
 }

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

Suggested change

	Primitive::U128(Some(v)) => Ok(json!(primitive.to_sql_value())),
	Primitive::U128(v) => {
	if let JsonValue::String(s) = value {
	- *v = s.parse().ok();
	+ if s.starts_with("0x") {
	+ *v = u128::from_str_radix(&s[2..], 16).ok();
	+ } else {
	+ *v = s.parse().ok();
	+ }
	}
	}

🤖 Prompt for AI Agents

In crates/dojo/types/src/schema.rs at line 351, the Primitive::U128 variant uses
to_sql_value() which outputs hex, but from_json_value at line 440 expects
decimal, causing inconsistency. Modify the to_sql_value() call for U128 to
output a decimal string instead of hex, matching the decimal parsing logic in
from_json_value. This ensures consistent serialization and deserialization of
U128 values.

[coderabbitai]

⚠️ Potential issue

Ohayo sensei! Same hex compatibility issue with U64.

Similar to I128, U64's to_sql_value() returns hex format but from_json_value (line 435) uses s.parse().ok() which doesn't handle hex strings for u64.

Consider updating the from_json_value method:

 Primitive::U64(v) => {
     if let JsonValue::String(s) = value {
-        *v = s.parse().ok();
+        if s.starts_with("0x") {
+            *v = u64::from_str_radix(&s[2..], 16).ok();
+        } else {
+            *v = s.parse().ok();
+        }
     }
 }

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents

In crates/dojo/types/src/schema.rs at line 350 and around line 435, the U64
primitive's to_sql_value method returns a hex string, but from_json_value uses
s.parse().ok() which cannot parse hex strings. Update from_json_value to detect
hex strings for U64 and parse them accordingly, converting the hex string to a
u64 value instead of using direct parse().

[coderabbitai]

⚠️ Potential issue

Ohayo sensei! Potential compatibility issue with I128 hex formatting.

The to_sql_value() method formats I128 as hexadecimal (0x{:064x}), but the corresponding from_json_value method (line 415) uses s.parse().ok() which doesn't handle hex strings by default for i128. This could break round-trip serialization.

Consider updating the from_json_value method to handle hex parsing:

 Primitive::I128(v) => {
     if let JsonValue::String(s) = value {
-        *v = s.parse().ok();
+        if s.starts_with("0x") {
+            *v = i128::from_str_radix(&s[2..], 16).ok();
+        } else {
+            *v = s.parse().ok();
+        }
     }
 }

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

Suggested change

	Primitive::I128(Some(v)) => Ok(json!(primitive.to_sql_value())),
	// In your `from_json_value` implementation:
	Primitive::I128(v) => {
	if let JsonValue::String(s) = value {
	if s.starts_with("0x") {
	*v = i128::from_str_radix(&s[2..], 16).ok();
	} else {
	*v = s.parse().ok();
	}
	}
	}

🤖 Prompt for AI Agents

In crates/dojo/types/src/schema.rs around line 346, the to_sql_value() method
formats I128 values as hexadecimal strings, but the from_json_value method at
line 415 currently parses these strings as decimal, causing incompatibility. To
fix this, update from_json_value to detect and correctly parse hex-formatted
strings (starting with "0x") into i128 values, ensuring proper round-trip
serialization between to_sql_value and from_json_value.

[glihm]

Nice, thank you @Larkooo. Will be more homogeneous in the DB with the same formatting everywhere. 👍