feat(torii): dynamic schema for storage components

dojoengine · May 31, 2023 · 7e39eab · 7e39eab
1 parent a8c43b6
commit 7e39eab
Show file tree

Hide file tree

Showing 12 changed files with 162 additions and 33 deletions.
diff --git a/crates/torii/scripts/test.sh b/crates/torii/scripts/test.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+pushd $(dirname "$0")/..
+
+cargo test --bin torii -- --nocapture
diff --git a/crates/torii/sqlx-data.json b/crates/torii/sqlx-data.json
@@ -234,6 +234,60 @@
     },
     "query": "\n            SELECT \n                id,\n                name,\n                address,\n                class_hash,\n                transaction_hash,\n                storage_schema,\n                created_at as \"created_at: _\"\n            FROM components WHERE id = $1\n        "
   },
+  "f026d7d5f73e91c5f342fa624b46b394dfe968cab5702776ab6968c1e864b695": {
+    "describe": {
+      "columns": [
+        {
+          "name": "id",
+          "ordinal": 0,
+          "type_info": "Text"
+        },
+        {
+          "name": "name",
+          "ordinal": 1,
+          "type_info": "Text"
+        },
+        {
+          "name": "address",
+          "ordinal": 2,
+          "type_info": "Text"
+        },
+        {
+          "name": "class_hash",
+          "ordinal": 3,
+          "type_info": "Text"
+        },
+        {
+          "name": "transaction_hash",
+          "ordinal": 4,
+          "type_info": "Text"
+        },
+        {
+          "name": "storage_schema",
+          "ordinal": 5,
+          "type_info": "Text"
+        },
+        {
+          "name": "created_at: _",
+          "ordinal": 6,
+          "type_info": "Datetime"
+        }
+      ],
+      "nullable": [
+        false,
+        false,
+        false,
+        false,
+        false,
+        false,
+        false
+      ],
+      "parameters": {
+        "Right": 0
+      }
+    },
+    "query": "\n            SELECT \n                id,\n                name,\n                address,\n                class_hash,\n                transaction_hash,\n                storage_schema,\n                created_at as \"created_at: _\"\n            FROM components\n        "
+  },
   "f7b294431f97b0186f93a660ff986788f94febd42c44ebcceee2db9fa10a854f": {
     "describe": {
       "columns": [

diff --git a/crates/torii/src/graphql/component.rs b/crates/torii/src/graphql/component.rs
@@ -7,6 +7,7 @@ use sqlx::pool::PoolConnection;
 use sqlx::{FromRow, Pool, Result, Sqlite};
 
 use super::types::ScalarType;
+use super::utils::remove_quotes;
 use super::{ObjectTraitInstance, ObjectTraitStatic, TypeMapping, ValueMapping};
 
 #[derive(FromRow, Deserialize)]
@@ -63,7 +64,7 @@ impl ObjectTraitInstance for ComponentObject {
             Field::new(self.name(), TypeRef::named_nn(self.type_name()), |ctx| {
                 FieldFuture::new(async move {
                     let mut conn = ctx.data::<Pool<Sqlite>>()?.acquire().await?;
-                    let id = ctx.args.try_get("id")?.string()?.replace('\"', "");
+                    let id = remove_quotes(ctx.args.try_get("id")?.string()?);
                     let component_values = component_by_id(&mut conn, &id).await?;
                     Ok(Some(FieldValue::owned_any(component_values)))
                 })
@@ -95,6 +96,27 @@ async fn component_by_id(conn: &mut PoolConnection<Sqlite>, id: &str) -> Result<
     Ok(value_mapping(component))
 }
 
+pub async fn components(conn: &mut PoolConnection<Sqlite>) -> Result<Vec<ValueMapping>> {
+    let components = sqlx::query_as!(
+        Component,
+        r#"
+            SELECT 
+                id,
+                name,
+                address,
+                class_hash,
+                transaction_hash,
+                storage_schema,
+                created_at as "created_at: _"
+            FROM components
+        "#
+    )
+    .fetch_all(conn)
+    .await?;
+
+    Ok(components.into_iter().map(value_mapping).collect())
+}
+
 fn value_mapping(component: Component) -> ValueMapping {
     IndexMap::from([
         (Name::new("id"), Value::from(component.id)),

diff --git a/crates/torii/src/graphql/entity.rs b/crates/torii/src/graphql/entity.rs
@@ -7,6 +7,7 @@ use sqlx::pool::PoolConnection;
 use sqlx::{FromRow, Pool, Result, Sqlite};
 
 use super::types::ScalarType;
+use super::utils::remove_quotes;
 use super::{ObjectTraitInstance, ObjectTraitStatic, TypeMapping, ValueMapping};
 
 #[derive(FromRow, Deserialize)]
@@ -60,7 +61,7 @@ impl ObjectTraitInstance for EntityObject {
             Field::new(self.name(), TypeRef::named_nn(self.type_name()), |ctx| {
                 FieldFuture::new(async move {
                     let mut conn = ctx.data::<Pool<Sqlite>>()?.acquire().await?;
-                    let id = ctx.args.try_get("id")?.string()?.replace('\"', "");
+                    let id = remove_quotes(ctx.args.try_get("id")?.string()?);
                     let entity_values = entity_by_id(&mut conn, &id).await?;
                     Ok(Some(FieldValue::owned_any(entity_values)))
                 })

diff --git a/crates/torii/src/graphql/event.rs b/crates/torii/src/graphql/event.rs
@@ -10,6 +10,7 @@ use sqlx::{FromRow, Pool, Result, Sqlite};
 
 use super::system_call::system_call_by_id;
 use super::types::ScalarType;
+use super::utils::remove_quotes;
 use super::utils::value_accessor::ObjectAccessor;
 use super::{ObjectTraitInstance, ObjectTraitStatic, TypeMapping, ValueMapping};
 
@@ -63,7 +64,7 @@ impl ObjectTraitInstance for EventObject {
             Field::new(self.name(), TypeRef::named_nn(self.type_name()), |ctx| {
                 FieldFuture::new(async move {
                     let mut conn = ctx.data::<Pool<Sqlite>>()?.acquire().await?;
-                    let id = ctx.args.try_get("id")?.string()?.replace('\"', "");
+                    let id = remove_quotes(ctx.args.try_get("id")?.string()?);
                     let event_values = event_by_id(&mut conn, &id).await?;
 
                     Ok(Some(FieldValue::owned_any(event_values)))

diff --git a/crates/torii/src/graphql/schema.rs b/crates/torii/src/graphql/schema.rs
@@ -1,23 +1,21 @@
-use async_graphql::dynamic::{Object, Scalar, Schema, SchemaError};
+use async_graphql::dynamic::{Object, Scalar, Schema};
+use async_graphql_parser::parse_schema;
+use async_graphql_parser::types::TypeSystemDefinition;
 use sqlx::SqlitePool;
 
-use super::component::ComponentObject;
+use super::component::{components, ComponentObject};
 use super::entity::EntityObject;
 use super::event::EventObject;
 use super::system::SystemObject;
 use super::system_call::SystemCallObject;
 use super::types::ScalarType;
+use super::utils::remove_quotes;
 use super::{ObjectTraitInstance, ObjectTraitStatic};
 
-pub async fn build_schema(pool: &SqlitePool) -> Result<Schema, SchemaError> {
-    // base gql objects
-    let objects: Vec<Box<dyn ObjectTraitInstance>> = vec![
-        Box::new(EntityObject::new()),
-        Box::new(ComponentObject::new()),
-        Box::new(SystemObject::new()),
-        Box::new(EventObject::new()),
-        Box::new(SystemCallObject::new()),
-    ];
+pub async fn build_schema(pool: &SqlitePool) -> anyhow::Result<Schema> {
+    // gql objects
+    let mut objects = base_objects();
+    objects.extend(storage_objects(pool).await?);
 
     // collect field resolvers
     let mut fields = Vec::new();
@@ -42,5 +40,42 @@ pub async fn build_schema(pool: &SqlitePool) -> Result<Schema, SchemaError> {
         schema_builder = schema_builder.register(object.create());
     }
 
-    schema_builder.register(query_root).data(pool.clone()).finish()
+    schema_builder.register(query_root).data(pool.clone()).finish().map_err(|e| e.into())
+}
+
+// predefined base objects
+fn base_objects() -> Vec<Box<dyn ObjectTraitInstance>> {
+    vec![
+        Box::new(EntityObject::new()),
+        Box::new(ComponentObject::new()),
+        Box::new(SystemObject::new()),
+        Box::new(EventObject::new()),
+        Box::new(SystemCallObject::new()),
+    ]
+}
+
+// storage objects built according to their schema
+async fn storage_objects(pool: &SqlitePool) -> anyhow::Result<Vec<Box<dyn ObjectTraitInstance>>> {
+    let mut conn = pool.acquire().await?;
+    let objects: Vec<Box<dyn ObjectTraitInstance>> = Vec::new();
+
+    // query for all components
+    let components = components(&mut conn).await?;
+    for component in components {
+        let str = component.get("storageSchema").expect("storage schema not found");
+
+        let parsed = parse_schema(remove_quotes(&str.to_string()))?;
+        if parsed.definitions.len() != 1 {
+            return Err(anyhow::anyhow!("only one type definition per component"));
+        }
+
+        match parsed.definitions.first() {
+            Some(TypeSystemDefinition::Type(ty)) => {
+                // TODO: create storage objects
+            }
+            _ => return Err(anyhow::anyhow!("only type definition supported")),
+        }
+    }
+
+    Ok(objects)
 }
diff --git a/crates/torii/src/graphql/server.rs b/crates/torii/src/graphql/server.rs
@@ -17,8 +17,8 @@ async fn graphql_playground() -> impl IntoResponse {
     Html(playground_source(GraphQLPlaygroundConfig::new("/playground")))
 }
 
-pub async fn start_graphql(pool: &Pool<Sqlite>) -> std::io::Result<()> {
-    let schema = build_schema(pool).await.expect("failed to build schema");
+pub async fn start_graphql(pool: &Pool<Sqlite>) -> anyhow::Result<()> {
+    let schema = build_schema(pool).await?;
 
     let app = Route::new()
         .at("/query", get(graphiql).post(GraphQL::new(schema.clone())))

diff --git a/crates/torii/src/graphql/system.rs b/crates/torii/src/graphql/system.rs
@@ -10,6 +10,7 @@ use sqlx::{FromRow, Pool, Result, Sqlite};
 
 use super::system_call::system_calls_by_system_id;
 use super::types::ScalarType;
+use super::utils::remove_quotes;
 use super::utils::value_accessor::ObjectAccessor;
 use super::{ObjectTraitInstance, ObjectTraitStatic, TypeMapping, ValueMapping};
 
@@ -65,7 +66,7 @@ impl ObjectTraitInstance for SystemObject {
             Field::new(self.name(), TypeRef::named_nn(self.type_name()), |ctx| {
                 FieldFuture::new(async move {
                     let mut conn = ctx.data::<Pool<Sqlite>>()?.acquire().await?;
-                    let id = ctx.args.try_get("id")?.string()?.replace('\"', "");
+                    let id = remove_quotes(ctx.args.try_get("id")?.string()?);
                     let system_values = system_by_id(&mut conn, &id).await?;
                     Ok(Some(FieldValue::owned_any(system_values)))
                 })

diff --git a/crates/torii/src/graphql/utils/mod.rs b/crates/torii/src/graphql/utils/mod.rs
@@ -1 +1,5 @@
 pub mod value_accessor;
+
+pub fn remove_quotes(s: &str) -> String {
+    s.replace(&['\"', '\''][..], "")
+}
diff --git a/crates/torii/src/tests/components_test.rs b/crates/torii/src/tests/components_test.rs
@@ -1,14 +1,17 @@
-// #[cfg(test)]
-// mod tests {
-//     use async_graphql_parser::parse_schema;
-//     use sqlx::SqlitePool;
+#[cfg(test)]
+mod tests {
+    use sqlx::SqlitePool;
 
-//     use crate::graphql::entity::Entity;
-//     use crate::graphql::schema::{self, build_schema};
-//     use crate::tests::common::run_graphql_query;
+    use crate::graphql::schema::build_schema;
 
-//     #[sqlx::test(migrations = "./migrations", fixtures("components"))]
-//     async fn test_dynamic_component(pool: SqlitePool) {
-//         let schema = build_schema(&pool).await;
-//     }
-// }
+    #[sqlx::test(migrations = "./migrations", fixtures("components"))]
+    async fn test_dynamic_component(pool: SqlitePool) {
+        let schema = build_schema(&pool).await.expect("failed to build schema");
+    }
+
+    #[sqlx::test(migrations = "./migrations", fixtures("components_bad_schema"))]
+    async fn test_bad_schema(pool: SqlitePool) {
+        let result = build_schema(&pool).await;
+        assert!(result.is_err());
+    }
+}
diff --git a/crates/torii/src/tests/fixtures/components.sql b/crates/torii/src/tests/fixtures/components.sql
@@ -1,11 +1,11 @@
 INSERT INTO components (id, name, address, class_hash, transaction_hash, storage_schema)
 VALUES ('component_1', 'Game', '0x0', '0x0', '0x0', 
-    'type GameComponent { isFinished: Boolean! entity: Entity! component: Component! createdAt: DateTime! }');
+    'type Game { isFinished: Boolean! entity: Entity! component: Component! createdAt: DateTime! }');
 
 INSERT INTO components (id, name, address, class_hash, transaction_hash, storage_schema)
 VALUES ('component_2', 'Stats', '0x0', '0x0', '0x0', 
-    'type StatsComponent { health: U8! entity: Entity! component: Component! createdAt: DateTime! }');
+    'type Stats { health: U8! entity: Entity! component: Component! createdAt: DateTime! }');
 
 INSERT INTO components (id, name, address, class_hash, transaction_hash, storage_schema)
 VALUES ('component_3', 'Cash', '0x0', '0x0', '0x0', 
-    'type CashComponent { amount: U32! entity: Entity! component: Component! createdAt: DateTime! }');
+    'type Cash { amount: U32! entity: Entity! component: Component! createdAt: DateTime! }');
diff --git a/crates/torii/src/tests/fixtures/components_bad_schema.sql b/crates/torii/src/tests/fixtures/components_bad_schema.sql
@@ -0,0 +1,4 @@
+INSERT INTO components (id, name, address, class_hash, transaction_hash, storage_schema)
+VALUES ('component_1', 'Game', '0x0', '0x0', '0x0', 
+    'type Game {{ isFinished: Boolean! }');
+