refactor: add custom ULID type for sqlalchemy

Author: Panaetius

components/renku_data_services/project/db.py

@@ -113,7 +113,7 @@ async def get_project_by_namespace_slug(
             authorized = await self.authz.has_permission(
                 user=user,
                 resource_type=ResourceType.project,
-                resource_id=ULID.from_str(project_orm.id),
+                resource_id=project_orm.id,
                 scope=Scope.READ,
             )
             if not authorized:
@@ -171,7 +171,7 @@ async def insert_project(
             creation_date=datetime.now(UTC).replace(microsecond=0),
             keywords=project.keywords,
         )
-        project_slug = schemas.ProjectSlug(slug, project_id=project_orm.id, namespace_id=ns.id)
+        project_slug = schemas.ProjectSlug(slug, project_id=str(project_orm.id), namespace_id=ns.id)
 
         session.add(project_slug)
         session.add(project_orm)

components/renku_data_services/project/orm.py

@@ -13,6 +13,7 @@
 from renku_data_services.namespace.orm import NamespaceORM
 from renku_data_services.project import models
 from renku_data_services.project.apispec import Visibility
+from renku_data_services.utils.sqlalchemy import ULIDType
 
 metadata_obj = MetaData(schema="projects")  # Has to match alembic ini section name
 
@@ -27,7 +28,7 @@ class ProjectORM(BaseORM):
     """A Renku native project."""
 
     __tablename__ = "projects"
-    id: Mapped[str] = mapped_column("id", String(26), primary_key=True, default_factory=lambda: str(ULID()), init=False)
+    id: Mapped[ULID] = mapped_column("id", ULIDType, primary_key=True, default_factory=lambda: str(ULID()), init=False)
     name: Mapped[str] = mapped_column("name", String(99))
     visibility: Mapped[Visibility]
     created_by_id: Mapped[str] = mapped_column("created_by_id", String())
@@ -53,7 +54,7 @@ class ProjectORM(BaseORM):
     def dump(self) -> models.Project:
         """Create a project model from the ProjectORM."""
         return models.Project(
-            id=ULID.from_str(self.id),
+            id=self.id,
             name=self.name,
             slug=self.slug.slug,
             namespace=self.slug.namespace.dump(),

components/renku_data_services/session/db.py

@@ -146,9 +146,7 @@ async def get_launcher(self, user: base_models.APIUser, launcher_id: ULID) -> mo
             launcher = res.one_or_none()
 
             authorized = (
-                await self.project_authz.has_permission(
-                    user, ResourceType.project, ULID.from_str(launcher.project_id), Scope.READ
-                )
+                await self.project_authz.has_permission(user, ResourceType.project, launcher.project_id, Scope.READ)
                 if launcher is not None
                 else False
             )
@@ -234,7 +232,7 @@ async def update_launcher(
             authorized = await self.project_authz.has_permission(
                 user,
                 ResourceType.project,
-                ULID.from_str(launcher.project_id),
+                launcher.project_id,
                 Scope.WRITE,
             )
             if not authorized:
@@ -311,7 +309,7 @@ async def delete_launcher(self, user: base_models.APIUser, launcher_id: ULID) ->
             authorized = await self.project_authz.has_permission(
                 user,
                 ResourceType.project,
-                ULID.from_str(launcher.project_id),
+                launcher.project_id,
                 Scope.WRITE,
             )
             if not authorized:

components/renku_data_services/session/orm.py

@@ -103,7 +103,7 @@ class SessionLauncherORM(BaseORM):
     project: Mapped[ProjectORM] = relationship(init=False)
     environment: Mapped[EnvironmentORM | None] = relationship(init=False)
 
-    project_id: Mapped[str] = mapped_column(
+    project_id: Mapped[ULID] = mapped_column(
         "project_id", ForeignKey(ProjectORM.id, ondelete="CASCADE"), default=None, index=True
     )
     """Id of the project this session belongs to."""
@@ -132,7 +132,7 @@ def load(cls, launcher: models.UnsavedSessionLauncher) -> "SessionLauncherORM":
             description=launcher.description,
             environment_kind=launcher.environment_kind,
             container_image=launcher.container_image,
-            project_id=str(launcher.project_id),
+            project_id=launcher.project_id,
             environment_id=launcher.environment_id,
             resource_class_id=launcher.resource_class_id,
             default_url=launcher.default_url,
@@ -142,7 +142,7 @@ def dump(self) -> models.SessionLauncher:
         """Create a session launcher model from the SessionLauncherORM."""
         return models.SessionLauncher(
             id=self.id,
-            project_id=ULID.from_str(self.project_id),
+            project_id=self.project_id,
             name=self.name,
             created_by=models.Member(id=self.created_by_id),
             creation_date=self.creation_date,

components/renku_data_services/utils/py.typed

@@ -0,0 +1,25 @@
+"""Utilities for SQLAlchemy."""
+
+from typing import cast
+
+from sqlalchemy import Dialect, types
+from ulid import ULID
+
+
+class ULIDType(types.TypeDecorator):
+    """Wrapper type for ULID <--> str conversion."""
+
+    impl = types.String
+    cache_ok = True
+
+    def process_bind_param(self, value: ULID | None, dialect: Dialect) -> str | None:
+        """Transform value for storing in the database."""
+        if value is None:
+            return None
+        return str(value)
+
+    def process_result_value(self, value: str | None, dialect: Dialect) -> ULID | None:
+        """Transform string from database into ULID."""
+        if value is None:
+            return None
+        return cast(ULID, ULID.from_str(value))