Centralize encoding of binary blob, do not return binary for /resources (#642)

* Always use a base64 representation for images

* Clean up encoding of images since it is now centralized

* Do not show the binary blobs for the user resources endpoint

Author: PGijsbers

src/database/model/ai_asset/distribution.py

@@ -1,8 +1,10 @@
+import base64
 from datetime import datetime
 from typing import Type
 
+from fastapi.encoders import jsonable_encoder
 from pydantic import create_model
-from sqlalchemy import Column, Integer, ForeignKey, String, LargeBinary
+from sqlalchemy import Column, ForeignKey, String, LargeBinary
 from sqlmodel import Field
 
 from database.model.concept.concept import AIoDConceptBase
@@ -62,6 +64,14 @@ class DistributionBase(AIoDConceptBase):
         sa_column=Column(LargeBinary),
     )
 
+    def dict(self, *args, **kwargs):
+        # Defining it as a `Config` does not work for some reason.
+        item_dict = super().dict(*args, **kwargs)
+        item = jsonable_encoder(
+            item_dict, custom_encoder={bytes: lambda v: base64.b64encode(v).decode("utf-8")}
+        )
+        return item
+
 
 def distribution_factory(table_from: str, distribution_name="distribution") -> Type:
     name = f"{distribution_name}_{table_from}"

src/routers/resource_router.py

@@ -230,14 +230,10 @@ def get_resources(
                     session, pagination, resource_filters, user, platform
                 )
                 for resource in resources:
-                    if not get_image and hasattr(resource, "media") and resource.media:
+                    if not get_image and hasattr(resource, "media"):
                         for media_obj in resource.media:
                             media_obj.binary_blob = None
 
-                    # Add image blobs if requested
-                    if get_image:
-                        self._add_binary_bytes_to_resource(session, resource)
-
                 return [convert_schema(resource) for resource in resources]
             except Exception as e:
                 raise as_http_exception(e)
@@ -266,9 +262,6 @@ def get_resource(
                     for media_obj in resource.media:
                         media_obj.binary_blob = None
 
-                if get_image:
-                    resource = self._add_binary_bytes_to_resource(session, resource)
-
                 if resource.aiod_entry.status != EntryStatus.PUBLISHED:
                     if user is None:
                         raise HTTPException(
@@ -389,18 +382,6 @@ def get_resources(
 
         return get_resources
 
-    def _add_binary_bytes_to_resource(self, session: Session, resource: AIoDConcept):
-        """
-        Attach binary_blob bytes as base64 encoded image from the resource's media.
-        """
-        if hasattr(resource, "media") and resource.media:
-            for media_obj in resource.media:
-                if media_obj.binary_blob:
-                    media_obj.binary_blob = base64.b64encode(media_obj.binary_blob).decode("utf-8")
-                else:
-                    media_obj.binary_blob = None
-        return resource
-
     def get_resource_func(self):
         """
         Return a function that can be used to retrieve a single resource.

src/routers/resource_routers/organisation_router.py

@@ -5,7 +5,6 @@
 from sqlmodel import select, Session
 from database.model.agent.organisation import Organisation
 from database.session import get_session
-import base64
 from authentication import KeycloakUser, get_user_or_none, get_user_or_raise
 from dependencies.filtering import ResourceFiltersParams
 from dependencies.pagination import PaginationParams
@@ -190,13 +189,7 @@ async def organisation_image(
                     status_code=HTTPStatus.NOT_FOUND, detail=f"Organisation {identifier} not found."
                 )
 
-            org_image_media = []
-            for media in org.media:
-                if media.binary_blob:
-                    media.binary_blob = base64.b64encode(media.binary_blob).decode("utf-8")
-                    org_image_media.append(media)
-
-            return org_image_media
+            return [media for media in org.media if media.binary_blob]
 
         @router.delete(  # type: ignore[no-redef]
             path, tags=[self.resource_name_plural]

src/routers/user_router.py

@@ -61,6 +61,11 @@ def get_versioned_resources_for_user(
             offset=pagination.offset,
             limit=limit,
         )
+        all_assets = [asset for assets in resources.values() for asset in assets]
+        for resource in [a for a in all_assets if hasattr(a, "media")]:
+            for media in resource.media:
+                media.binary_blob = None
+
         orm_to_read = {
             r.resource_class.__tablename__: r.orm_to_read
             for r in versioned_routers.get(version, [])