api.db: decouple model indexes from DB engine

Implement a dataclass `Index` to store model field names
and constraints to create indexes. Instead of directly
creating indexes from model method for specific DB engine
(at the moment, MongoDB), implement a method to get indexes
from models independent of DB engine i.e. list of
`DatabaseModel.Index` class instances. Create MongoDB specific
indexes in the database method `Database.create_indexes`.

Signed-off-by: Jeny Sadadia <[email protected]>

Author: Jeny Sadadia

api/db.py

@@ -62,8 +62,12 @@ def _get_collection(self, model):
     async def create_indexes(self):
         """Create indexes for models"""
         for model in self.COLLECTIONS:
+            indexes = model.get_indexes()
+            if not indexes:
+                continue
             col = self._get_collection(model)
-            model.create_indexes(col)
+            for index in indexes:
+                col.create_index(index.field, **index.attributes)
 
     async def find_one(self, model, **kwargs):
         """Find one object with matching attributes

api/models.py

@@ -29,6 +29,7 @@
 )
 from bson import ObjectId
 from kernelci.api.models_base import DatabaseModel, ModelId
+from pydantic.dataclasses import dataclass
 
 
 # PubSub model definitions
@@ -66,9 +67,11 @@ class UserGroup(DatabaseModel):
     )
 
     @classmethod
-    def create_indexes(cls, collection):
-        """Create an index to bind unique constraint to group name"""
-        collection.create_index("name", unique=True)
+    def get_indexes(cls):
+        """Get an index to bind unique constraint to group name"""
+        return [
+            cls.Index('name', {'unique': True}),
+        ]
 
 
 class User(BeanieBaseUser, Document,  # pylint: disable=too-many-ancestors
@@ -86,10 +89,11 @@ class Settings(BeanieBaseUser.Settings):
         name = "user"
 
     @classmethod
-    def create_indexes(cls, collection):
-        """Create an index to bind unique constraint to email"""
-        collection.create_index("email", unique=True)
-
+    def get_indexes(cls):
+        """Get indices"""
+        return [
+            cls.Index('email', {'unique': True}),
+        ]
 
 class UserRead(schemas.BaseUser[PydanticObjectId], ModelId):
     """Schema for reading a user"""