feat(apps): add list and patch endpoints

Author: wesjdj

components/renku_data_services/renku_apps/blueprints.py

@@ -1,16 +1,19 @@
 """Renku apps blueprints."""
 
 from dataclasses import dataclass
+from typing import Any
 
 from sanic import HTTPResponse, Request
-from sanic.response import JSONResponse, json
+from sanic.response import JSONResponse
 from sanic_ext import validate
 from ulid import ULID
 
 from renku_data_services import base_models
 from renku_data_services.base_api.auth import authenticate, only_authenticated
 from renku_data_services.base_api.blueprint import BlueprintFactoryResponse, CustomBlueprint
+from renku_data_services.base_models.validation import validated_json
 from renku_data_services.renku_apps import apispec
+from renku_data_services.renku_apps.models import App
 from renku_data_services.renku_apps.repository import RenkuAppsRepository
 
 
@@ -21,6 +24,19 @@ class RenkuAppBP(CustomBlueprint):
     apps_repo: RenkuAppsRepository
     authenticator: base_models.Authenticator
 
+    @staticmethod
+    def _dump_app(app: App) -> dict[str, Any]:
+        """Dump an app for API responses."""
+        return dict(
+            name=app.name,
+            launcher_id=str(app.launcher_id),
+            project_id=str(app.project_id),
+            status=app.status.value,
+            url=app.url,
+            started=app.started.isoformat() if app.started is not None else None,
+            image=app.image,
+        )
+
     def post(self) -> BlueprintFactoryResponse:
         """Launch a new app from a session launcher."""
 
@@ -29,7 +45,7 @@ def post(self) -> BlueprintFactoryResponse:
         @validate(json=apispec.AppPostRequest)
         async def _post(_: Request, user: base_models.APIUser, body: apispec.AppPostRequest) -> JSONResponse:
             app = await self.apps_repo.create_app(user=user, launcher_id=ULID.from_str(body.launcher_id))
-            return json(app.as_apispec().model_dump(exclude_none=True, mode="json"), status=201)
+            return validated_json(apispec.AppResponse, self._dump_app(app), status=201)
 
         return "/apps", ["POST"], _post
 
@@ -39,7 +55,7 @@ def get_one(self) -> BlueprintFactoryResponse:
         @authenticate(self.authenticator)
         async def _get_one(_: Request, user: base_models.APIUser, app_name: str) -> JSONResponse:
             app = await self.apps_repo.get_app(user=user, app_name=app_name)
-            return json(app.as_apispec().model_dump(exclude_none=True, mode="json"))
+            return validated_json(apispec.AppResponse, self._dump_app(app))
 
         return "/apps/<app_name>", ["GET"], _get_one
 
@@ -69,7 +85,7 @@ async def _patch_one(
                 state=body.state,
                 resource_class_id=body.resource_class_id,
             )
-            return json(app.as_apispec().model_dump(exclude_none=True, mode="json"))
+            return validated_json(apispec.AppResponse, self._dump_app(app))
 
         return "/apps/<app_name>", ["PATCH"], _patch_one
 
@@ -83,6 +99,6 @@ async def _get_all(
         ) -> JSONResponse:
             project_id = ULID.from_str(query.project_id) if query.project_id is not None else None
             apps = await self.apps_repo.list_apps(user=user, project_id=project_id)
-            return json([app.as_apispec().model_dump(exclude_none=True, mode="json") for app in apps])
+            return validated_json(apispec.AppListResponse, [self._dump_app(app) for app in apps])
 
         return "/apps", ["GET"], _get_all

components/renku_data_services/renku_apps/k8s_client.py

@@ -135,6 +135,10 @@ async def set_app_deployment_resources(self, app_name: str, resource_class: Reso
             gvk=KNATIVE_SERVICE_GVK,
             user_id=DUMMY_RENKU_APP_USER_ID,
         )
+        # TODO: This JSON patch targets the container by position (containers/0). Once apps run more
+        # than one container this becomes fragile and should be a strategic merge patch keyed on the
+        # container name. Our kr8s wrapper only emits json/merge patches (never strategic merge), so
+        # switching requires extending the wrapper first.
         patch_body: list[dict[str, Any]] = [
             {
                 "op": "replace",

components/renku_data_services/renku_apps/models.py

@@ -6,8 +6,6 @@
 
 from ulid import ULID
 
-from renku_data_services.renku_apps import apispec
-
 
 class AppStatus(StrEnum):
     """The status of an app."""
@@ -30,18 +28,6 @@ class App:
     started: datetime | None = None
     image: str | None = None
 
-    def as_apispec(self) -> apispec.AppResponse:
-        """Convert the app to an API response model."""
-        return apispec.AppResponse(
-            name=self.name,
-            launcher_id=str(self.launcher_id),
-            status=apispec.AppStatus(self.status.value),
-            url=self.url,
-            project_id=str(self.project_id),
-            started=self.started,
-            image=self.image,
-        )
-
 
 @dataclass(frozen=True, kw_only=True)
 class AppRuntimeState:

components/renku_data_services/renku_apps/repository.py

@@ -20,6 +20,11 @@
 logger = logging.getLogger(__name__)
 
 
+def _app_not_found_message(app_name: str) -> str:
+    """Build the message for a missing or inaccessible app."""
+    return f"App with name '{app_name}' does not exist or you do not have access to it."
+
+
 class RenkuAppsRepository:
     """Use-case-focused API for Renku apps, dispatching to k8s rather than SQL."""
 
@@ -64,9 +69,7 @@ async def get_app(self, user: base_models.APIUser, app_name: str) -> App:
         """Retrieve an app by its name."""
         runtime_state = await self.k8s_client.get_app_deployment(app_name)
         if runtime_state is None:
-            raise errors.MissingResourceError(
-                message=f"App with name '{app_name}' does not exist or you do not have access to it."
-            )
+            raise errors.MissingResourceError(message=_app_not_found_message(app_name))
 
         launcher = await self.session_repo.get_launcher(user, runtime_state.launcher_id)
         return build_app(launcher, runtime_state)
@@ -85,9 +88,7 @@ async def delete_app(self, user: base_models.APIUser, app_name: str) -> None:
 
         authorized = await self.authz.has_permission(user, ResourceType.project, launcher.project_id, Scope.WRITE)
         if not authorized:
-            raise errors.MissingResourceError(
-                message=f"App with name '{app_name}' does not exist or you do not have authorization to modify it."
-            )
+            raise errors.MissingResourceError(message=_app_not_found_message(app_name))
 
         await self.k8s_client.delete_app_deployment(app_name)
         logger.info(f"App with name {app_name} has been deleted.")
@@ -115,25 +116,21 @@ async def update_app(
 
         runtime_state = await self.k8s_client.get_app_deployment(app_name)
         if runtime_state is None:
-            raise errors.MissingResourceError(
-                message=f"App with name '{app_name}' does not exist or you do not have access to it."
-            )
+            raise errors.MissingResourceError(message=_app_not_found_message(app_name))
 
         launcher = await self.session_repo.get_launcher(user, runtime_state.launcher_id)
 
         authorized = await self.authz.has_permission(user, ResourceType.project, launcher.project_id, Scope.WRITE)
         if not authorized:
-            raise errors.MissingResourceError(
-                message=f"App with name '{app_name}' does not exist or you do not have authorization to modify it."
-            )
+            raise errors.MissingResourceError(message=_app_not_found_message(app_name))
 
         latest: AppRuntimeState = runtime_state
         if resource_class_id is not None:
             resource_class = await self.rp_repo.get_resource_class(user, resource_class_id)
             latest = await self.k8s_client.set_app_deployment_resources(app_name, resource_class)
-        if state == apispec.AppState.hibernated:
+        if state == apispec.AppState.hibernated and not runtime_state.is_hibernated:
             latest = await self.k8s_client.hibernate_app_deployment(app_name)
-        elif state == apispec.AppState.running:
+        elif state == apispec.AppState.running and runtime_state.is_hibernated:
             latest = await self.k8s_client.resume_app_deployment(app_name)
 
         return build_app(launcher, latest)