refactor(lang): update convention for keys and values naming (#2660)

* Updated functions to clear up naming with serialized * Removed some redundecies in the code * Removed some redundecies in the code * updated benchmarks * chore: bump scarb * fix: rebuild test database --------- Co-authored-by: glihm <[email protected]>
dojoengine · Nov 8, 2024 · 8ed5e72 · 8ed5e72
1 parent 61febd5
commit 8ed5e72
Show file tree

Hide file tree

Showing 18 changed files with 130 additions and 993 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -192,8 +192,8 @@ rpassword = "7.2.0"
 rstest = "0.18.2"
 rstest_reuse = "0.6.0"
 salsa = "0.16.1"
-scarb = { git = "https://github.com/dojoengine/scarb", rev = "b9965b7e2f0d97f2a97f18ca9a75bac541de7d84" }
-scarb-ui = { git = "https://github.com/dojoengine/scarb", rev = "b9965b7e2f0d97f2a97f18ca9a75bac541de7d84" }
+scarb = { git = "https://github.com/dojoengine/scarb", rev = "a6d3b5b17b288502fe9cc63c96c0ae22fd175857" }
+scarb-ui = { git = "https://github.com/dojoengine/scarb", rev = "a6d3b5b17b288502fe9cc63c96c0ae22fd175857" }
 semver = "1.0.5"
 serde = { version = "1.0", features = [ "derive" ] }
 serde_json = { version = "1.0", features = [ "arbitrary_precision" ] }

diff --git a/crates/dojo/core-cairo-test/src/tests/benchmarks.cairo b/crates/dojo/core-cairo-test/src/tests/benchmarks.cairo
@@ -195,7 +195,7 @@ fn bench_simple_struct() {
     gas.end("foo serialize");
 
     let gas = GasCounterTrait::start();
-    let values: Span<felt252> = foo.values();
+    let values: Span<felt252> = foo.serialized_values();
     gas.end("foo values");
 
     assert(serialized.len() == 2, 'serialized wrong length');
@@ -249,7 +249,7 @@ fn test_struct_with_many_fields_fixed() {
     gas.end("pos serialize");
 
     let gas = GasCounterTrait::start();
-    let values: Span<felt252> = pos.values();
+    let values: Span<felt252> = pos.serialized_values();
     gas.end("pos values");
 
     assert(serialized.len() == values.len(), 'serialized not equal');
@@ -268,7 +268,7 @@ fn test_struct_with_many_fields_fixed() {
     };
 
     let gas = GasCounterTrait::start();
-    database::set('positions', '42', pos.values(), 0, layout);
+    database::set('positions', '42', pos.serialized_values(), 0, layout);
     gas.end("pos db set");
 
     let gas = GasCounterTrait::start();
@@ -297,7 +297,7 @@ fn bench_nested_struct_packed() {
     gas.end("case serialize");
 
     let gas = GasCounterTrait::start();
-    let values: Span<felt252> = case.values();
+    let values: Span<felt252> = case.serialized_values();
     gas.end("case values");
 
     assert(serialized.len() == values.len(), 'serialized not equal');
@@ -378,7 +378,7 @@ fn bench_complex_struct_packed() {
     gas.end("chars serialize");
 
     let gas = GasCounterTrait::start();
-    let values: Span<felt252> = char.values();
+    let values: Span<felt252> = char.serialized_values();
     gas.end("chars values");
 
     assert(serialized.len() == values.len(), 'serialized not equal');
@@ -398,7 +398,7 @@ fn bench_complex_struct_packed() {
     };
 
     let gas = GasCounterTrait::start();
-    database::set('chars', '42', char.values(), 0, layout);
+    database::set('chars', '42', char.serialized_values(), 0, layout);
     gas.end("chars db set");
 
     let gas = GasCounterTrait::start();
@@ -467,8 +467,8 @@ fn test_benchmark_set_entity() {
     world
         .set_entity(
             model_selector: Model::<Case>::selector(DOJO_NSH),
-            index: ModelIndex::Keys(simple_entity_packed.keys()),
-            values: simple_entity_packed.values(),
+            index: ModelIndex::Keys(simple_entity_packed.serialized_keys()),
+            values: simple_entity_packed.serialized_values(),
             layout: Model::<Case>::layout()
         );
     gas.end("World::SetEntity::SimplePacked");
@@ -477,8 +477,8 @@ fn test_benchmark_set_entity() {
     world
         .set_entity(
             model_selector: Model::<CaseNotPacked>::selector(),
-            index: ModelIndex::Keys(simple_entity_not_packed.keys()),
-            values: simple_entity_not_packed.values(),
+            index: ModelIndex::Keys(simple_entity_not_packed.serialized_keys()),
+            values: simple_entity_not_packed.serialized_values(),
             layout: Model::<CaseNotPacked>::layout()
         );
     gas.end("World::SetEntity::SimpleNotPacked");
@@ -488,7 +488,7 @@ fn test_benchmark_set_entity() {
         .set_entity(
             model_selector: Model::<ComplexModel>::selector(),
             index: ModelIndex::Keys(complex_entity.keys()),
-            values: complex_entity.values(),
+            values: complex_entity.serialized_values(),
             layout: Model::<ComplexModel>::layout()
         );
     gas.end("World::SetEntity::ComplexModel");

diff --git a/crates/dojo/core-cairo-test/src/tests/model/model.cairo b/crates/dojo/core-cairo-test/src/tests/model/model.cairo
@@ -54,15 +54,15 @@ fn test_values() {
     let mvalues = FooValue { v1: 3, v2: 4 };
     let expected_values = [3, 4].span();
 
-    let values = mvalues.values();
+    let values = mvalues.serialized_values();
     assert!(expected_values == values);
 }
 
 #[test]
 fn test_from_values() {
     let mut values = [3, 4].span();
 
-    let model_values: Option<FooValue> = ModelValue::<FooValue>::from_values(1, ref values);
+    let model_values: Option<FooValue> = ModelValue::<FooValue>::from_serialized(values);
     assert!(model_values.is_some());
     let model_values = model_values.unwrap();
     assert!(model_values.v1 == 3 && model_values.v2 == 4);
@@ -71,7 +71,7 @@ fn test_from_values() {
 #[test]
 fn test_from_values_bad_data() {
     let mut values = [3].span();
-    let res: Option<FooValue> = ModelValue::<FooValue>::from_values(1, ref values);
+    let res: Option<FooValue> = ModelValue::<FooValue>::from_serialized(values);
     assert!(res.is_none());
 }
 
@@ -83,7 +83,7 @@ fn test_read_and_update_model_value() {
     world.write_model(@foo);
 
     let entity_id = foo.entity_id();
-    let mut model_value: FooValue = world.read_value(foo.key());
+    let mut model_value: FooValue = world.read_value(foo.keys());
     assert_eq!(model_value.v1, foo.v1);
     assert_eq!(model_value.v2, foo.v2);
 
@@ -92,7 +92,7 @@ fn test_read_and_update_model_value() {
 
     world.write_value_from_id(entity_id, @model_value);
 
-    let read_values: FooValue = world.read_value(foo.key());
+    let read_values: FooValue = world.read_value(foo.keys());
     assert!(read_values.v1 == model_value.v1 && read_values.v2 == model_value.v2);
 }
 
@@ -153,20 +153,20 @@ fn test_delete_from_model() {
 }
 
 #[test]
-fn test_model_ptr_from_key() {
+fn test_model_ptr_from_keys() {
     let mut world = spawn_foo_world();
     let foo = Foo { k1: 1, k2: 2, v1: 3, v2: 4 };
-    let ptr = Model::<Foo>::ptr_from_key(foo.key());
+    let ptr = Model::<Foo>::ptr_from_keys(foo.keys());
     world.write_model(@foo);
     let v1 = world.read_member(ptr, selector!("v1"));
     assert!(foo.v1 == v1);
 }
 
 #[test]
-fn test_model_ptr_from_keys() {
+fn test_model_ptr_from_serialized_keys() {
     let mut world = spawn_foo_world();
     let foo = Foo { k1: 1, k2: 2, v1: 3, v2: 4 };
-    let ptr = Model::<Foo>::ptr_from_keys(foo.keys());
+    let ptr = Model::<Foo>::ptr_from_serialized_keys(foo.serialized_keys());
     world.write_model(@foo);
     let v1 = world.read_member(ptr, selector!("v1"));
     assert!(foo.v1 == v1);

diff --git a/crates/dojo/core-cairo-test/src/tests/utils/key.cairo b/crates/dojo/core-cairo-test/src/tests/utils/key.cairo
@@ -1,9 +1,12 @@
-use dojo::utils::{entity_id_from_keys, combine_key};
+use dojo::utils::{entity_id_from_serialized_keys, combine_key};
 
 #[test]
 fn test_entity_id_from_keys() {
     let keys = [1, 2, 3].span();
-    assert(entity_id_from_keys(keys) == core::poseidon::poseidon_hash_span(keys), 'bad entity ID');
+    assert(
+        entity_id_from_serialized_keys(keys) == core::poseidon::poseidon_hash_span(keys),
+        'bad entity ID'
+    );
 }
 
 #[test]