Improve models validation (#156)

* Improve models validation

* Changelog

CHANGELOG.md

@@ -4,7 +4,11 @@
 
 ### Added
 
-* New index type `head` allowing to handle head (reduced block header info) updates
+* New index type `head` allowing to handle head (reduced block header info) updates.
+
+### Improved
+
+* Raise `DatabaseConfigurationError` exception when project models are not compatible with GraphQL.
 
 ### Fixed
 

src/demo_tezos_domains_big_map/handlers/on_update_expiry_map.py

@@ -14,9 +14,9 @@ async def on_update_expiry_map(
     assert store_expiry_map.key
     assert store_expiry_map.value
 
-    expiry = store_expiry_map.value.__root__
+    timestamp = store_expiry_map.value.__root__
     record_name = bytes.fromhex(store_expiry_map.key.__root__).decode()
     await models.Expiry.update_or_create(
         id=record_name,
-        defaults=dict(expiry=expiry),
+        defaults=dict(timestamp=timestamp),
     )

src/demo_tezos_domains_big_map/models.py

@@ -8,7 +8,7 @@ class TLD(Model):
 
 class Expiry(Model):
     id = fields.CharField(max_length=255, pk=True)
-    expiry = fields.DatetimeField(null=True)
+    timestamp = fields.DatetimeField(null=True)
 
 
 class Domain(Model):

src/dipdup/dipdup.py

@@ -37,7 +37,7 @@
 from dipdup.models import IndexStatus, OperationData, Schema
 from dipdup.scheduler import add_job, create_scheduler
 from dipdup.utils import slowdown
-from dipdup.utils.database import generate_schema, get_schema_hash, set_schema, tortoise_wrapper, validate_models
+from dipdup.utils.database import generate_schema, get_schema_hash, prepare_models, set_schema, tortoise_wrapper, validate_models
 
 
 class IndexDispatcher:
@@ -351,7 +351,8 @@ async def _initialize_schema(self) -> None:
         await self._ctx.fire_hook('on_restart')
 
     async def _set_up_database(self, stack: AsyncExitStack, reindex: bool) -> None:
-        # NOTE: Must be called before Tortoise.init
+        # NOTE: Must be called before entering Tortoise context
+        prepare_models(self._config.package)
         validate_models(self._config.package)
 
         url = self._config.database.connection_string

src/dipdup/utils/database.py

@@ -166,16 +166,26 @@ async def move_table(conn: BaseDBAsyncClient, name: str, schema: str, new_schema
     await conn.execute_script(f'ALTER TABLE {schema}.{name} SET SCHEMA {new_schema}')
 
 
+def prepare_models(package: str) -> None:
+    for _, model in iter_models(package):
+        # NOTE: Generate missing table names before Tortoise does
+        model._meta.db_table = model._meta.db_table or pascal_to_snake(model.__name__)
+
+
 def validate_models(package: str) -> None:
-    """Validate project models"""
+    """Check project's models for common mistakes"""
     for _, model in iter_models(package):
-        # NOTE: Resolve missing table names before Tortoise does
-        if model._meta.db_table is None:
-            model._meta.db_table = pascal_to_snake(model.__name__)
+        table_name = model._meta.db_table
+
+        if table_name != pascal_to_snake(table_name):
+            raise DatabaseConfigurationError('Table name must be in snake_case', model)
 
-        name = model._meta.db_table
-        if name != pascal_to_snake(name):
-            raise DatabaseConfigurationError('Table names should be in snake_case', model)
         for field in model._meta.fields_map.values():
-            if field.model_field_name != pascal_to_snake(field.model_field_name):
-                raise DatabaseConfigurationError('Column names should be in snake_case', model)
+            field_name = field.model_field_name
+
+            if field_name != pascal_to_snake(field_name):
+                raise DatabaseConfigurationError('Model fields must be in snake_case', model)
+
+            # NOTE: Leads to GraphQL issues
+            if field_name == table_name:
+                raise DatabaseConfigurationError('Model fields must differ from table name', model)