fix: add creation date and created by to namespaces (#491)

* fix: add creation date and created by to namespaces

* switch to plain python property

Author: Panaetius

components/renku_data_services/namespace/blueprints.py

@@ -188,7 +188,7 @@ async def _get_namespaces(
                         name=ns.name,
                         slug=ns.latest_slug if ns.latest_slug else ns.slug,
                         created_by=ns.created_by,
-                        creation_date=None,  # NOTE: we do not save creation date in the DB
+                        creation_date=ns.creation_date,
                         namespace_kind=apispec.NamespaceKind(ns.kind.value),
                     )
                     for ns in nss

components/renku_data_services/namespace/models.py

@@ -73,6 +73,7 @@ class Namespace:
     underlying_resource_id: ULID | str  # The user or group ID depending on the Namespace kind
     latest_slug: str | None = None
     name: str | None = None
+    creation_date: datetime | None = None
 
 
 @dataclass(frozen=True, eq=True, kw_only=True)

components/renku_data_services/namespace/orm.py

@@ -72,37 +72,65 @@ class NamespaceORM(BaseORM):
         nullable=True,
         index=True,
     )
-    user: Mapped[UserORM | None] = relationship(lazy="joined", init=False, repr=False, viewonly=True)
+    user: Mapped[UserORM | None] = relationship(
+        lazy="joined", back_populates="namespace", init=False, repr=False, viewonly=True
+    )
 
-    def dump(self) -> models.Namespace:
-        """Create a namespace model from the ORM."""
-        if self.group_id and self.group:
-            return models.Namespace(
-                id=self.id,
-                slug=self.slug,
-                kind=models.NamespaceKind.group,
-                created_by=self.group.created_by,
-                underlying_resource_id=self.group_id,
-                latest_slug=self.slug,
-                name=self.group.name,
-            )
+    @property
+    def created_by(self) -> str:
+        """User that created this namespace."""
+        if self.group is not None:
+            return self.group.created_by
+        elif self.user_id:
+            return self.user_id
+        raise errors.ProgrammingError(
+            message=f"Found a namespace {self.slug} that has no group or user associated with it."
+        )
 
-        if not self.user or not self.user_id:
-            raise errors.ProgrammingError(message="Found a namespace that has no group or user associated with it.")
+    @property
+    def creation_date(self) -> datetime | None:
+        """When this namespace was created."""
+        return self.group.creation_date if self.group else None
+
+    @property
+    def underlying_resource_id(self) -> str | ULID:
+        """Return the id of the underlying resource."""
+        if self.group_id is not None:
+            return self.group_id
+        elif self.user_id is not None:
+            return self.user_id
+
+        raise errors.ProgrammingError(
+            message=f"Found a namespace {self.slug} that has no group or user associated with it."
+        )
 
-        name = (
-            f"{self.user.first_name} {self.user.last_name}"
-            if self.user.first_name and self.user.last_name
-            else self.user.first_name or self.user.last_name
+    @property
+    def name(self) -> str | None:
+        """Return the name of the underlying resource."""
+        if self.group is not None:
+            return self.group.name
+        elif self.user is not None:
+            return (
+                f"{self.user.first_name} {self.user.last_name}"
+                if self.user.first_name and self.user.last_name
+                else self.user.first_name or self.user.last_name
+            )
+        raise errors.ProgrammingError(
+            message=f"Found a namespace {self.slug} that has no group or user associated with it."
         )
+
+    def dump(self) -> models.Namespace:
+        """Create a namespace model from the ORM."""
+        kind = models.NamespaceKind.group if self.group else models.NamespaceKind.user
         return models.Namespace(
             id=self.id,
             slug=self.slug,
-            kind=models.NamespaceKind.user,
-            created_by=self.user_id,
-            underlying_resource_id=self.user_id,
+            kind=kind,
+            created_by=self.created_by,
+            creation_date=self.creation_date,
+            underlying_resource_id=self.underlying_resource_id,
             latest_slug=self.slug,
-            name=name,
+            name=self.name,
         )
 
     def dump_user(self) -> UserInfo:
@@ -112,6 +140,8 @@ def dump_user(self) -> UserInfo:
                 message="Cannot dump ORM namespace as namespace with user if the namespace "
                 "has no associated user with it."
             )
+        # NOTE: calling `self.user.dump()` can cause sqlalchemy greenlet errors, as it tries to fetch the namespace
+        # again from the db, even though the back_populates should take care of this and not require loading.
         ns = self.dump()
         user_info = UserInfo(
             id=self.user.keycloak_id,
@@ -154,7 +184,8 @@ def dump(self) -> models.Namespace:
                 id=self.id,
                 slug=self.slug,
                 latest_slug=self.slug,
-                created_by=self.latest_slug.group.created_by,
+                created_by=self.latest_slug.created_by,
+                creation_date=self.created_at,
                 kind=models.NamespaceKind.group,
                 underlying_resource_id=self.latest_slug.group_id,
                 name=self.latest_slug.group.name,
@@ -175,6 +206,7 @@ def dump(self) -> models.Namespace:
             slug=self.slug,
             latest_slug=self.latest_slug.slug,
             created_by=self.latest_slug.user_id,
+            creation_date=self.created_at,
             kind=models.NamespaceKind.user,
             underlying_resource_id=self.latest_slug.user_id,
             name=name,

pyproject.toml

@@ -104,7 +104,7 @@ line-length = 120
 target-version = "py311"
 output-format = "full"
 include = ["*.py", "*.pyi"]
-exclude = ["*/avro_models/*"]
+exclude = ["*/avro_models/*", ".devcontainer/"]
 
 [tool.ruff.format]
 exclude = ["apispec.py"]

test/bases/renku_data_services/data_api/test_namespaces.py

@@ -2,7 +2,7 @@
 
 
 @pytest.mark.asyncio
-async def test_list_namespaces(sanic_client, user_headers) -> None:
+async def test_list_namespaces(sanic_client, user_headers, regular_user) -> None:
     payload = {
         "name": "Group1",
         "slug": "group-1",
@@ -16,8 +16,12 @@ async def test_list_namespaces(sanic_client, user_headers) -> None:
     assert len(res_json) == 2
     user_ns = res_json[0]
     assert user_ns["slug"] == "user.doe"
+    assert user_ns.get("creation_date") is None
+    assert user_ns["created_by"] == regular_user.id
     group_ns = res_json[1]
     assert group_ns["slug"] == "group-1"
+    assert group_ns.get("creation_date") is not None
+    assert group_ns["created_by"] == regular_user.id
 
 
 @pytest.mark.asyncio