Added get_tag_keys endpoint

Author: Ken Lippold

sta/models/tag.py

@@ -1,5 +1,7 @@
 import typing
+from typing import Optional
 from django.db import models
+from django.db.models import Q
 from iam.models.utils import PermissionChecker
 from .thing import Thing
 
@@ -9,7 +11,26 @@
     User = get_user_model()
 
 
+class TagQuerySet(models.QuerySet):
+    def visible(self, user: Optional["User"]):
+        if user is None:
+            return self.filter(Q(thing__workspace__is_private=False, thing__is_private=False))
+        elif user.account_type == "admin":
+            return self
+        else:
+            return self.filter(
+                Q(thing__workspace__is_private=False,
+                  thing__is_private=False) |
+                Q(thing__workspace__owner=user) |
+                Q(thing__workspace__collaborators__user=user,
+                  thing__workspace__collaborators__role__permissions__resource_type__in=["*", "Thing"],
+                  thing__workspace__collaborators__role__permissions__permission_type__in=["*", "view"])
+            )
+
+
 class Tag(models.Model, PermissionChecker):
     thing = models.ForeignKey(Thing, related_name="tags", on_delete=models.DO_NOTHING)
     key = models.CharField(max_length=255)
     value = models.CharField(max_length=255)
+
+    objects = TagQuerySet.as_manager()

sta/services/thing.py

@@ -97,6 +97,18 @@ def get_tags(self, user: Optional[User], uid: uuid.UUID):
 
         return thing.tags
 
+    @staticmethod
+    def get_tag_keys(user: Optional[User], workspace_id: Optional[uuid.UUID], thing_id: Optional[uuid.UUID]):
+        queryset = Tag.objects
+
+        if workspace_id:
+            queryset = queryset.filter(thing__workspace_id=workspace_id)
+
+        if thing_id:
+            queryset = queryset.filter(thing_id=thing_id)
+
+        return list(queryset.visible(user=user).values_list("key", flat=True).distinct())
+
     def add_tag(self, user: User, uid: uuid.UUID, data: TagPostBody):
         thing = self.get_thing_for_action(user=user, uid=uid, action="edit")
 

sta/urls.py

@@ -2,8 +2,8 @@
 from django.urls import path
 from django.views.decorators.csrf import ensure_csrf_cookie
 from hydroserver import __version__
-from sta.views import (thing_router, tag_router, photo_router, observed_property_router, processing_level_router,
-                       result_qualifier_router, sensor_router, unit_router, datastream_router)
+from sta.views import (thing_router, tag_router, tag_key_router, photo_router, observed_property_router,
+                       processing_level_router, result_qualifier_router, sensor_router, unit_router, datastream_router)
 
 
 data_api = NinjaAPI(
@@ -16,6 +16,7 @@
 thing_router.add_router("{thing_id}/tags", tag_router)
 thing_router.add_router("{thing_id}/photos", photo_router)
 data_api.add_router("things", thing_router)
+data_api.add_router("tags", tag_key_router)
 data_api.add_router("observed-properties", observed_property_router)
 data_api.add_router("processing-levels", processing_level_router)
 data_api.add_router("result-qualifiers", result_qualifier_router)

sta/views/__init__.py

@@ -1,5 +1,5 @@
 from .thing import thing_router
-from .tag import tag_router
+from .tag import tag_router, tag_key_router
 from .photo import photo_router
 from .observed_property import observed_property_router
 from .processing_level import processing_level_router

sta/views/tag.py

@@ -1,11 +1,13 @@
 import uuid
 from ninja import Router, Path
+from typing import Optional
 from hydroserver.security import bearer_auth, session_auth, anonymous_auth
 from hydroserver.http import HydroServerHttpRequest
 from sta.schemas import TagGetResponse, TagPostBody, TagDeleteBody
 from sta.services import ThingService
 
 tag_router = Router(tags=["Tags"])
+tag_key_router = Router(tags=["Tags"])
 thing_service = ThingService()
 
 
@@ -30,6 +32,27 @@ def get_tags(request: HydroServerHttpRequest, thing_id: Path[uuid.UUID]):
     )
 
 
+@tag_key_router.get(
+    "keys",
+    auth=[session_auth, bearer_auth, anonymous_auth],
+    response={
+        200: list[str],
+        401: str,
+    }
+)
+def get_tag_keys(request: HydroServerHttpRequest, workspace_id: Optional[uuid.UUID] = None,
+                 thing_id: Optional[uuid.UUID] = None):
+    """
+    Get all existing unique tag keys.
+    """
+
+    return 200, thing_service.get_tag_keys(
+        user=request.authenticated_user,
+        workspace_id=workspace_id,
+        thing_id=thing_id,
+    )
+
+
 @tag_router.post(
     "",
     auth=[session_auth, bearer_auth],

tests/fixtures/test_things.yaml

@@ -26,8 +26,8 @@
   pk: 1000000010
   fields:
     thing: 3b7818af-eff7-4149-8517-e5cad9dc22e1
-    key: Test Key
-    value: Test Value
+    key: Test Public Key
+    value: Test Public Value
 - model: sta.photo
   pk: 1000000010
   fields:
@@ -63,8 +63,8 @@
   pk: 1000000011
   fields:
     thing: 76dadda5-224b-4e1f-8570-e385bd482b2d
-    key: Test Key
-    value: Test Value
+    key: Test Private Key
+    value: Test Private Value
 - model: sta.photo
   pk: 1000000011
   fields:
@@ -100,8 +100,8 @@
   pk: 1000000012
   fields:
     thing: 92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7
-    key: Test Key
-    value: Test Value
+    key: Test Private Key
+    value: Test Private Value
 - model: sta.photo
   pk: 1000000012
   fields:
@@ -137,8 +137,8 @@
   pk: 1000000013
   fields:
     thing: 819260c8-2543-4046-b8c4-7431243ed7c5
-    key: Test Key
-    value: Test Value
+    key: Test Private Key
+    value: Test Private Value
 - model: sta.photo
   pk: 1000000013
   fields:

tests/sta/services/test_thing.py

@@ -234,14 +234,46 @@ def test_get_tags(get_user, user, thing, message, error_code):
             user=get_user(user), uid=uuid.UUID(thing)
         )
         assert len(list(thing_tags.all())) == 1
-        assert list(thing_tags.all())[0].key == "Test Key"
-        assert list(thing_tags.all())[0].value == "Test Value"
+        assert list(thing_tags.all())[0].key in ["Test Public Key", "Test Private Key"]
+        assert list(thing_tags.all())[0].value in ["Test Public Value", "Test Private Value"]
+
+
+@pytest.mark.parametrize("user, workspace, thing, length, max_queries", [
+    ("owner", None, None, 2, 2),
+    ("owner", "b27c51a0-7374-462d-8a53-d97d47176c10", None, 1, 2),
+    ("owner", None, "76dadda5-224b-4e1f-8570-e385bd482b2d", 1, 2),
+    ("owner", "6e0deaf2-a92b-421b-9ece-86783265596f", "76dadda5-224b-4e1f-8570-e385bd482b2d", 0, 2),
+    ("admin", None, None, 2, 2),
+    ("admin", "b27c51a0-7374-462d-8a53-d97d47176c10", None, 1, 2),
+    ("admin", None, "76dadda5-224b-4e1f-8570-e385bd482b2d", 1, 2),
+    ("admin", "6e0deaf2-a92b-421b-9ece-86783265596f", "76dadda5-224b-4e1f-8570-e385bd482b2d", 0, 2),
+    ("editor", None, None, 2, 2),
+    ("editor", "b27c51a0-7374-462d-8a53-d97d47176c10", None, 1, 2),
+    ("editor", None, "76dadda5-224b-4e1f-8570-e385bd482b2d", 1, 2),
+    ("editor", "6e0deaf2-a92b-421b-9ece-86783265596f", "76dadda5-224b-4e1f-8570-e385bd482b2d", 0, 2),
+    ("viewer", None, None, 2, 2),
+    ("viewer", "b27c51a0-7374-462d-8a53-d97d47176c10", None, 1, 2),
+    ("viewer", None, "76dadda5-224b-4e1f-8570-e385bd482b2d", 1, 2),
+    ("viewer", "6e0deaf2-a92b-421b-9ece-86783265596f", "76dadda5-224b-4e1f-8570-e385bd482b2d", 0, 2),
+    ("anonymous", None, None, 1, 2),
+    ("anonymous", "b27c51a0-7374-462d-8a53-d97d47176c10", None, 0, 2),
+    ("anonymous", None, "76dadda5-224b-4e1f-8570-e385bd482b2d", 0, 2),
+    ("anonymous", "6e0deaf2-a92b-421b-9ece-86783265596f", "76dadda5-224b-4e1f-8570-e385bd482b2d", 0, 2),
+])
+def test_get_tag_keys(django_assert_num_queries, get_user, user, workspace, thing, length, max_queries):
+    with django_assert_num_queries(max_queries):
+        tag_key_list = thing_service.get_tag_keys(
+            user=get_user(user), workspace_id=uuid.UUID(workspace) if workspace else None,
+            thing_id=uuid.UUID(thing) if thing else None
+        )
+        assert len(tag_key_list) == length
+        assert (isinstance(str, tag_key) for tag_key in tag_key_list)
 
 
 @pytest.mark.parametrize("user, thing, tag, message, error_code", [
     ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "New Key", "value": "New Value"}, None, None),
     ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "New Key", "value": "Test Value"}, None, None),
-    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key", "value": "New Value"}, "Tag already exists", 400),
+    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key", "value": "New Value"}, "Tag already exists", 400),
     ("owner", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "New Key", "value": "New Value"}, None, None),
     ("owner", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "New Key", "value": "New Value"}, None, None),
     ("owner", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "New Key", "value": "New Value"}, None, None),
@@ -280,28 +312,28 @@ def test_add_tag(get_user, user, thing, tag, message, error_code):
 
 
 @pytest.mark.parametrize("user, thing, tag, message, error_code", [
-    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key", "value": "New Value"}, None, None),
+    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key", "value": "New Value"}, None, None),
+    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key", "value": "New Value"}, None, None),
     ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "New Key", "value": "New Value"}, "Tag does not exist", 404),
-    ("owner", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("owner", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("owner", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("admin", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("admin", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("admin", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("admin", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("editor", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("editor", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("editor", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("editor", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key", "value": "New Value"}, None, None),
-    ("viewer", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key", "value": "New Value"}, "You do not have permission", 403),
-    ("viewer", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key", "value": "New Value"}, "You do not have permission", 403),
-    ("viewer", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key", "value": "New Value"}, "You do not have permission", 403),
-    ("viewer", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key", "value": "New Value"}, "You do not have permission", 403),
-    ("anonymous", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key", "value": "New Value"}, "You do not have permission", 403),
-    ("anonymous", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key", "value": "New Value"}, "Thing does not exist", 404),
-    ("anonymous", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key", "value": "New Value"}, "Thing does not exist", 404),
-    ("anonymous", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key", "value": "New Value"}, "Thing does not exist", 404),
+    ("owner", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key", "value": "New Value"}, None, None),
+    ("owner", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key", "value": "New Value"}, None, None),
+    ("owner", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key", "value": "New Value"}, None, None),
+    ("admin", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key", "value": "New Value"}, None, None),
+    ("admin", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key", "value": "New Value"}, None, None),
+    ("admin", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key", "value": "New Value"}, None, None),
+    ("admin", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key", "value": "New Value"}, None, None),
+    ("editor", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key", "value": "New Value"}, None, None),
+    ("editor", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key", "value": "New Value"}, None, None),
+    ("editor", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key", "value": "New Value"}, None, None),
+    ("editor", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key", "value": "New Value"}, None, None),
+    ("viewer", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key", "value": "New Value"}, "You do not have permission", 403),
+    ("viewer", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key", "value": "New Value"}, "You do not have permission", 403),
+    ("viewer", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key", "value": "New Value"}, "You do not have permission", 403),
+    ("viewer", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key", "value": "New Value"}, "You do not have permission", 403),
+    ("anonymous", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key", "value": "New Value"}, "You do not have permission", 403),
+    ("anonymous", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key", "value": "New Value"}, "Thing does not exist", 404),
+    ("anonymous", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key", "value": "New Value"}, "Thing does not exist", 404),
+    ("anonymous", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key", "value": "New Value"}, "Thing does not exist", 404),
 ])
 def test_update_tag(get_user, user, thing, tag, message, error_code):
     if error_code:
@@ -321,28 +353,28 @@ def test_update_tag(get_user, user, thing, tag, message, error_code):
 
 
 @pytest.mark.parametrize("user, thing, tag, message, error_code", [
-    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key"}, None, None),
-    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key"}, None, None),
+    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key"}, None, None),
+    ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key"}, None, None),
     ("owner", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "New Key"}, "Tag does not exist", 404),
-    ("owner", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key"}, None, None),
-    ("owner", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key"}, None, None),
-    ("owner", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key"}, None, None),
-    ("admin", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key"}, None, None),
-    ("admin", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key"}, None, None),
-    ("admin", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key"}, None, None),
-    ("admin", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key"}, None, None),
-    ("editor", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key"}, None, None),
-    ("editor", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key"}, None, None),
-    ("editor", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key"}, None, None),
-    ("editor", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key"}, None, None),
-    ("viewer", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key"}, "You do not have permission", 403),
-    ("viewer", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key"}, "You do not have permission", 403),
-    ("viewer", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key"}, "You do not have permission", 403),
-    ("viewer", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key"}, "You do not have permission", 403),
-    ("anonymous", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Key"}, "You do not have permission", 403),
-    ("anonymous", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Key"}, "Thing does not exist", 404),
-    ("anonymous", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Key"}, "Thing does not exist", 404),
-    ("anonymous", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Key"}, "Thing does not exist", 404),
+    ("owner", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key"}, None, None),
+    ("owner", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key"}, None, None),
+    ("owner", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key"}, None, None),
+    ("admin", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key"}, None, None),
+    ("admin", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key"}, None, None),
+    ("admin", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key"}, None, None),
+    ("admin", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key"}, None, None),
+    ("editor", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key"}, None, None),
+    ("editor", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key"}, None, None),
+    ("editor", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key"}, None, None),
+    ("editor", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key"}, None, None),
+    ("viewer", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key"}, "You do not have permission", 403),
+    ("viewer", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key"}, "You do not have permission", 403),
+    ("viewer", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key"}, "You do not have permission", 403),
+    ("viewer", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key"}, "You do not have permission", 403),
+    ("anonymous", "3b7818af-eff7-4149-8517-e5cad9dc22e1", {"key": "Test Public Key"}, "You do not have permission", 403),
+    ("anonymous", "76dadda5-224b-4e1f-8570-e385bd482b2d", {"key": "Test Private Key"}, "Thing does not exist", 404),
+    ("anonymous", "92a3a099-f2d3-40ec-9b0e-d25ae8bf59b7", {"key": "Test Private Key"}, "Thing does not exist", 404),
+    ("anonymous", "819260c8-2543-4046-b8c4-7431243ed7c5", {"key": "Test Private Key"}, "Thing does not exist", 404),
 ])
 def test_remove_tag(get_user, user, thing, tag, message, error_code):
     if error_code: