Add lean site summaries for the Sites page

Author: daniel-slaugh

domains/sta/services/thing.py

@@ -1,4 +1,5 @@
 import uuid
+from collections import defaultdict
 from typing import Optional, Literal, List, get_args
 from ninja.errors import HttpError
 from django.http import HttpResponse
@@ -22,6 +23,7 @@
     FileAttachmentType,
 )
 from interfaces.api.schemas import (
+    TagGetResponse,
     ThingSummaryResponse,
     ThingDetailResponse,
     ThingPostBody,
@@ -226,6 +228,67 @@ def get_marker_values(queryset: QuerySet):
             "longitude_value",
         )
 
+    @classmethod
+    def get_site_summary_values(cls, queryset: QuerySet):
+        return queryset.annotate(
+            latitude_value=Cast("latitude", FloatField()),
+            longitude_value=Cast("longitude", FloatField()),
+        ).values(
+            "thing_id",
+            "thing__workspace_id",
+            "thing__name",
+            "thing__sampling_feature_code",
+            "thing__site_type",
+            "thing__is_private",
+            "latitude_value",
+            "longitude_value",
+        )
+
+    @staticmethod
+    def get_tags_by_thing_id(
+        principal: Optional[User | APIKey],
+        thing_ids: list[uuid.UUID],
+    ) -> dict[str, list[TagGetResponse]]:
+        if not thing_ids:
+            return {}
+
+        tags_by_thing_id: dict[str, list[TagGetResponse]] = defaultdict(list)
+        tag_rows = (
+            ThingTag.objects.visible(principal=principal)
+            .filter(thing_id__in=thing_ids)
+            .values("thing_id", "key", "value")
+            .order_by("thing_id", "key", "value")
+            .distinct()
+        )
+        for tag in tag_rows:
+            tags_by_thing_id[str(tag["thing_id"])].append(
+                {
+                    "key": tag["key"],
+                    "value": tag["value"],
+                }
+            )
+        return tags_by_thing_id
+
+    @staticmethod
+    def serialize_site_summary_rows(
+        site_rows,
+        tags_by_thing_id: dict[str, list[TagGetResponse]],
+    ) -> list[dict]:
+        return [
+            {
+                "id": str(site["thing_id"]),
+                "workspace_id": str(site["thing__workspace_id"]),
+                "name": site["thing__name"],
+                "sampling_feature_code": site["thing__sampling_feature_code"],
+                "site_type": site["thing__site_type"],
+                "is_private": site["thing__is_private"],
+                "latitude": site["latitude_value"],
+                "longitude": site["longitude_value"],
+                "tags": tags_by_thing_id.get(str(site["thing_id"]), []),
+            }
+            for site in site_rows
+        ]
+
     @classmethod
     def filter_cached_markers(
         cls, markers: list[dict], filtering: Optional[dict] = None
@@ -310,6 +373,24 @@ def list_markers(
         markers.sort(key=lambda marker: marker["id"])
         return markers
 
+    def list_site_summaries(
+        self,
+        principal: Optional[User | APIKey],
+        filtering: Optional[dict] = None,
+    ) -> list[dict]:
+        site_queryset = Location.objects.visible(principal=principal)
+        site_queryset = self.apply_marker_filters(site_queryset, filtering=filtering)
+        site_rows = list(
+            self.get_site_summary_values(
+                site_queryset.order_by("thing_id").distinct()
+            )
+        )
+        tags_by_thing_id = self.get_tags_by_thing_id(
+            principal=principal,
+            thing_ids=[site["thing_id"] for site in site_rows],
+        )
+        return self.serialize_site_summary_rows(site_rows, tags_by_thing_id)
+
     def list(
         self,
         principal: Optional[User | APIKey],

interfaces/api/schemas/__init__.py

@@ -29,6 +29,8 @@
 from .thing import (
     ThingMarkerResponse,
     ThingMarkerQueryParameters,
+    ThingSiteSummaryResponse,
+    ThingSiteSummaryQueryParameters,
     ThingSummaryResponse,
     ThingDetailResponse,
     ThingPostBody,

interfaces/api/schemas/thing.py

@@ -157,6 +157,25 @@ class ThingMarkerResponse(BaseGetResponse):
     longitude: float
 
 
+class ThingSiteSummaryQueryParameters(BaseQueryParameters):
+    workspace_id: list[uuid.UUID] = Query(
+        [], description="Filter site summaries by workspace ID."
+    )
+    site_type: list[str] = Query([], description="Filter site summaries by site type.")
+
+
+class ThingSiteSummaryResponse(BaseGetResponse):
+    id: uuid.UUID
+    workspace_id: uuid.UUID
+    name: str = Field(..., max_length=200)
+    sampling_feature_code: str = Field(..., max_length=200)
+    site_type: str = Field(..., max_length=200)
+    is_private: bool
+    latitude: float
+    longitude: float
+    tags: list[TagGetResponse]
+
+
 class ThingSummaryResponse(BaseGetResponse, ThingFields):
     id: uuid.UUID
     workspace_id: uuid.UUID

interfaces/api/views/thing.py

@@ -10,6 +10,8 @@
 from interfaces.api.schemas import (
     ThingMarkerResponse,
     ThingMarkerQueryParameters,
+    ThingSiteSummaryResponse,
+    ThingSiteSummaryQueryParameters,
     ThingSummaryResponse,
     ThingDetailResponse,
     ThingPostBody,
@@ -81,6 +83,29 @@ def get_thing_markers(
     )
 
 
+@thing_router.get(
+    "/site-summaries",
+    auth=[session_auth, bearer_auth, apikey_auth, anonymous_auth],
+    response={
+        200: list[ThingSiteSummaryResponse],
+        401: str,
+    },
+    by_alias=True,
+)
+def get_thing_site_summaries(
+    request: HydroServerHttpRequest,
+    query: Query[ThingSiteSummaryQueryParameters],
+):
+    """
+    Get lean site summary data for public Things and Things associated with the authenticated user.
+    """
+
+    return 200, thing_service.list_site_summaries(
+        principal=request.principal,
+        filtering=query.dict(exclude_unset=True),
+    )
+
+
 @thing_router.post(
     "",
     auth=[session_auth, bearer_auth, apikey_auth],

tests/sta/services/test_thing.py

@@ -185,6 +185,57 @@ def test_list_thing_markers_invalidates_public_cache_on_update():
     assert [marker["name"] for marker in markers] == ["Updated Public Thing"]
 
 
+def test_list_thing_site_summaries_returns_lean_payload_with_tags():
+    site_summaries = thing_service.list_site_summaries(principal=None)
+
+    assert site_summaries == [
+        {
+            "id": "3b7818af-eff7-4149-8517-e5cad9dc22e1",
+            "workspace_id": "6e0deaf2-a92b-421b-9ece-86783265596f",
+            "name": "Public Thing",
+            "sampling_feature_code": "UWRL",
+            "site_type": "Public",
+            "is_private": False,
+            "latitude": 41.739742,
+            "longitude": -111.793766,
+            "tags": [
+                {
+                    "key": "Test Public Key",
+                    "value": "Test Public Value",
+                }
+            ],
+        }
+    ]
+
+
+def test_list_thing_site_summaries_filters_by_workspace(get_principal):
+    site_summaries = thing_service.list_site_summaries(
+        principal=get_principal("owner"),
+        filtering={"workspace_id": ["6e0deaf2-a92b-421b-9ece-86783265596f"]},
+    )
+
+    assert Counter(site["name"] for site in site_summaries) == Counter(
+        [
+            "Public Thing",
+            "Private Thing Public Workspace",
+        ]
+    )
+    assert all(
+        set(site) == {
+            "id",
+            "workspace_id",
+            "name",
+            "sampling_feature_code",
+            "site_type",
+            "is_private",
+            "latitude",
+            "longitude",
+            "tags",
+        }
+        for site in site_summaries
+    )
+
+
 @pytest.mark.parametrize(
     "principal, thing, message, error_code",
     [