feat(torii): enum support (#874)

* fix(torii): exact key matching issue

* chore(torii): gen sql type mapping at runtime

* fix graphql type

* update ecs example to add enum

* remove obsolete fixtures

* update test manifest

* fix test

crates/dojo-lang/src/manifest_test_data/manifest

@@ -626,7 +626,7 @@ test_manifest_file
         }
       ],
       "outputs": [],
-      "class_hash": "0x3459b99fd17b3bf9aeb6c55b610a457520785646f5c80c21d07041403a25315",
+      "class_hash": "0x205287b11aa6c42e3cef3539607aa250c2b9ffe27f847af8e88f005e1b3525d",
       "dependencies": [],
       "abi": [
         {
@@ -701,11 +701,11 @@ test_manifest_file
         },
         {
           "name": "direction",
-          "type": "dojo_examples::systems::move::Direction"
+          "type": "dojo_examples::components::Direction"
         }
       ],
       "outputs": [],
-      "class_hash": "0x578416d298f2f6c280a229f58fd7b5b2486285700fcfde9ad102c4052d3804e",
+      "class_hash": "0x501dbe28cf4e7f3a47c9abeee23c85992b97fdaa324c1fcb1e2a638882fc470",
       "dependencies": [],
       "abi": [
         {
@@ -721,8 +721,12 @@ test_manifest_file
         },
         {
           "type": "enum",
-          "name": "dojo_examples::systems::move::Direction",
+          "name": "dojo_examples::components::Direction",
           "variants": [
+            {
+              "name": "None",
+              "type": "()"
+            },
             {
               "name": "Left",
               "type": "()"
@@ -779,7 +783,7 @@ test_manifest_file
           "inputs": [
             {
               "name": "direction",
-              "type": "dojo_examples::systems::move::Direction"
+              "type": "dojo_examples::components::Direction"
             },
             {
               "name": "ctx",
@@ -801,7 +805,7 @@ test_manifest_file
             },
             {
               "name": "direction",
-              "type": "dojo_examples::systems::move::Direction",
+              "type": "dojo_examples::components::Direction",
               "kind": "data"
             }
           ]
@@ -952,9 +956,14 @@ test_manifest_file
           "name": "remaining",
           "type": "u8",
           "key": false
+        },
+        {
+          "name": "last_direction",
+          "type": "Direction",
+          "key": false
         }
       ],
-      "class_hash": "0x74c8a6b2e93b4a34788c23eb3d931da62d5a973ef66ba0a671de41b1607a9a4",
+      "class_hash": "0x451a367ced4c22bfc661e6a342391faa6087d3162ea53cf4c6cc86c8630de49",
       "abi": [
         {
           "type": "function",

crates/torii/client/src/contract/system_test.rs

@@ -34,7 +34,7 @@ async fn test_system() {
     let component = world.component("Moves", block_id).await.unwrap();
     let moves = component.entity(vec![account.address()], block_id).await.unwrap();
 
-    assert_eq!(moves, vec![10_u8.into()]);
+    assert_eq!(moves, vec![10_u8.into(), FieldElement::ZERO]);
 
     let move_system = world.system("move", block_id).await.unwrap();
 
@@ -48,11 +48,11 @@ async fn test_system() {
 
     let moves = component.entity(vec![account.address()], block_id).await.unwrap();
 
-    assert_eq!(moves, vec![8_u8.into()]);
+    assert_eq!(moves, vec![8_u8.into(), FieldElement::THREE]);
 
     let position_component = world.component("Position", block_id).await.unwrap();
 
     let position = position_component.entity(vec![account.address()], block_id).await.unwrap();
 
-    assert_eq!(position, vec![11_u8.into(), 11_u8.into()]);
+    assert_eq!(position, vec![9_u8.into(), 9_u8.into()]);
 }

crates/torii/core/src/sql.rs

@@ -1,3 +1,5 @@
+use std::collections::HashMap;
+
 use anyhow::Result;
 use async_trait::async_trait;
 use chrono::{DateTime, Utc};
@@ -27,6 +29,7 @@ pub struct Sql {
     world_address: FieldElement,
     pool: Pool<Sqlite>,
     query_queue: Mutex<Vec<String>>,
+    sql_types: Mutex<HashMap<String, &'static str>>,
 }
 
 impl Sql {
@@ -50,7 +53,29 @@ impl Sql {
 
         tx.commit().await?;
 
-        Ok(Self { pool, world_address, query_queue: Mutex::new(vec![]) })
+        let sql_types = HashMap::from([
+            ("u8".to_string(), "INTEGER"),
+            ("u16".to_string(), "INTEGER"),
+            ("u32".to_string(), "INTEGER"),
+            ("u64".to_string(), "INTEGER"),
+            ("u128".to_string(), "TEXT"),
+            ("u256".to_string(), "TEXT"),
+            ("usize".to_string(), "INTEGER"),
+            ("bool".to_string(), "INTEGER"),
+            ("Cursor".to_string(), "TEXT"),
+            ("ContractAddress".to_string(), "TEXT"),
+            ("ClassHash".to_string(), "TEXT"),
+            ("DateTime".to_string(), "TEXT"),
+            ("felt252".to_string(), "TEXT"),
+            ("Enum".to_string(), "INTEGER"),
+        ]);
+
+        Ok(Self {
+            pool,
+            world_address,
+            query_queue: Mutex::new(vec![]),
+            sql_types: Mutex::new(sql_types),
+        })
     }
 }
 
@@ -157,6 +182,8 @@ impl State for Sql {
     }
 
     async fn register_component(&self, component: Component) -> Result<()> {
+        let mut sql_types = self.sql_types.lock().await;
+
         let component_id = component.name.to_lowercase();
         let mut queries = vec![format!(
             "INSERT INTO components (id, name, class_hash) VALUES ('{}', '{}', '{:#x}') ON \
@@ -169,12 +196,24 @@ impl State for Sql {
             component.name.to_lowercase()
         );
 
-        for member in component.clone().members {
-            component_table_query.push_str(&format!(
-                "external_{} {}, ",
-                member.name,
-                sql_type(&member.ty)?
+        for member in &component.members {
+            // FIXME: defaults all unknown component types to Enum for now until we support nested
+            // components
+            let (sql_type, member_type) = match sql_types.get(&member.ty) {
+                Some(sql_type) => (*sql_type, member.ty.as_str()),
+                None => {
+                    sql_types.insert(member.ty.clone(), "INTEGER");
+                    ("INTEGER", "Enum")
+                }
+            };
+
+            queries.push(format!(
+                "INSERT OR IGNORE INTO component_members (component_id, name, type, key) VALUES \
+                 ('{}', '{}', '{}', {})",
+                component_id, member.name, member_type, member.key,
             ));
+
+            component_table_query.push_str(&format!("external_{} {}, ", member.name, sql_type));
         }
 
         component_table_query.push_str(
@@ -183,15 +222,8 @@ impl State for Sql {
         );
         queries.push(component_table_query);
 
-        for member in component.members {
-            queries.push(format!(
-                "INSERT OR IGNORE INTO component_members (component_id, name, type, key) VALUES \
-                 ('{}', '{}', '{}', {})",
-                component_id, member.name, member.ty, member.key,
-            ));
-        }
-
         self.queue(queries).await;
+
         // Since previous query has not been executed, we have to make sure created_at exists
         let created_at: DateTime<Utc> =
             match sqlx::query("SELECT created_at FROM components WHERE id = ?")
@@ -259,7 +291,9 @@ impl State for Sql {
         member_values.extend(keys);
         member_values.extend(values);
 
-        let (names_str, values_str) = format_values(member_names_result, member_values)?;
+        let sql_types = self.sql_types.lock().await;
+        let (names_str, values_str) =
+            format_values(member_names_result, member_values, &sql_types)?;
         let insert_components = format!(
             "INSERT OR REPLACE INTO external_{} (entity_id {}) VALUES ('{}' {})",
             component.to_lowercase(),
@@ -329,6 +363,7 @@ fn component_names(entity_result: Option<SqliteRow>, new_component: &str) -> Res
 fn format_values(
     member_results: Vec<SqliteRow>,
     values: Vec<FieldElement>,
+    sql_types: &HashMap<String, &str>,
 ) -> Result<(String, String)> {
     let names: Result<Vec<String>> = member_results
         .iter()
@@ -345,26 +380,12 @@ fn format_values(
     let values: Result<Vec<String>> = values
         .iter()
         .zip(types?.iter())
-        .map(|(value, ty)| {
-            if sql_type(ty)? == "INTEGER" {
-                Ok(format!(",'{}'", value))
-            } else {
-                Ok(format!(",'{:#x}'", value))
-            }
+        .map(|(value, ty)| match sql_types.get(ty).copied() {
+            Some("INTEGER") => Ok(format!(",'{}'", value)),
+            Some("TEXT") => Ok(format!(",'{:#x}'", value)),
+            _ => Err(anyhow::anyhow!("Unsupported type {}", ty)),
         })
         .collect();
 
     Ok((names?.join(""), values?.join("")))
 }
-
-// NOTE: If adding/removing types, corresponding change needs to be made to torii-graphql
-// `src/types.rs`
-fn sql_type(member_type: &str) -> Result<&str, anyhow::Error> {
-    match member_type {
-        "u8" | "u16" | "u32" | "u64" | "usize" | "bool" => Ok("INTEGER"),
-        "u128" | "u256" | "Cursor" | "ContractAddress" | "ClassHash" | "DateTime" | "felt252" => {
-            Ok("TEXT")
-        }
-        _ => Err(anyhow::anyhow!("Unknown member type {}", member_type.to_string())),
-    }
-}

crates/torii/graphql/src/tests/mod.rs

@@ -1,5 +1,4 @@
 mod common;
 mod components_test;
 mod entities_test;
-mod events_test;
 mod subscription_test;

crates/torii/graphql/src/types.rs

@@ -19,6 +19,7 @@ pub enum ScalarType {
     ClassHash,
     DateTime,
     Felt252,
+    Enum,
 }
 
 impl fmt::Display for ScalarType {
@@ -37,6 +38,7 @@ impl fmt::Display for ScalarType {
             ScalarType::ClassHash => write!(f, "ClassHash"),
             ScalarType::DateTime => write!(f, "DateTime"),
             ScalarType::Felt252 => write!(f, "felt252"),
+            ScalarType::Enum => write!(f, "Enum"),
         }
     }
 }
@@ -57,6 +59,7 @@ impl ScalarType {
             ScalarType::ClassHash,
             ScalarType::DateTime,
             ScalarType::Felt252,
+            ScalarType::Enum,
         ]
         .into_iter()
         .collect()
@@ -70,6 +73,7 @@ impl ScalarType {
             ScalarType::U64,
             ScalarType::USize,
             ScalarType::Bool,
+            ScalarType::Enum,
         ]
         .into_iter()
         .collect()
@@ -114,6 +118,7 @@ impl FromStr for ScalarType {
             "ClassHash" => Ok(ScalarType::ClassHash),
             "DateTime" => Ok(ScalarType::DateTime),
             "felt252" => Ok(ScalarType::Felt252),
+            "Enum" => Ok(ScalarType::Enum),
             _ => Err(anyhow::anyhow!("Unknown type {}", s.to_string())),
         }
     }