Add invocation REST API viewset (#4733)

See DIAGNijmegen/rse-roadmap#481

Author: koopmant

app/grandchallenge/algorithms/apps.py

@@ -23,12 +23,23 @@ def init_job_permissions(*_, **__):
     assign_perm("algorithms.add_job", g)
 
 
+def init_invocation_permissions(*_, **__):
+    from django.contrib.auth.models import Group
+    from guardian.shortcuts import assign_perm
+
+    g, _ = Group.objects.get_or_create(
+        name=settings.REGISTERED_USERS_GROUP_NAME
+    )
+    assign_perm("algorithms.add_invocation", g)
+
+
 class AlgorithmsConfig(AppConfig):
     name = "grandchallenge.algorithms"
 
     def ready(self):
         post_migrate.connect(init_algorithm_creators_group, sender=self)
         post_migrate.connect(init_job_permissions, sender=self)
+        post_migrate.connect(init_invocation_permissions, sender=self)
         # noinspection PyUnresolvedReferences
         import grandchallenge.algorithms.signals  # noqa: F401
         from grandchallenge.algorithms.models import AlgorithmImage

app/grandchallenge/algorithms/filters.py

@@ -1,8 +1,15 @@
 from django_filters import BooleanFilter, FilterSet, filters
+from rest_framework.filters import BaseFilterBackend
 
-from grandchallenge.algorithms.models import Algorithm, Endpoint, Job
+from grandchallenge.algorithms.models import (
+    Algorithm,
+    Endpoint,
+    Invocation,
+    Job,
+)
 from grandchallenge.cases.models import Image
 from grandchallenge.core.filters import TitleDescriptionModalityStructureFilter
+from grandchallenge.core.guardian import filter_by_permission
 
 
 class EndpointFilter(FilterSet):
@@ -28,6 +35,35 @@ def filter_status(self, queryset, name, value):
             return queryset.none()
 
 
+class InvocationObjectPermissionsFilter(BaseFilterBackend):
+    def filter_queryset(self, request, queryset, view):
+        endpoints = filter_by_permission(
+            queryset=Endpoint.objects.all(),
+            user=request.user,
+            codename="view_endpoint",
+        )
+        return queryset.filter(endpoint__in=endpoints)
+
+
+class InvocationFilter(FilterSet):
+    status = filters.CharFilter(method="filter_status")
+
+    class Meta:
+        model = Invocation
+        fields = ["endpoint", "status"]
+
+    def filter_status(self, queryset, name, value):
+        display_to_value = {
+            label.lower(): db_value
+            for db_value, label in Invocation.StatusChoices.choices
+        }
+
+        try:
+            return queryset.filter(status=display_to_value[value.lower()])
+        except KeyError:
+            return queryset.none()
+
+
 class JobViewsetFilter(FilterSet):
     input_image = filters.ModelMultipleChoiceFilter(
         field_name="inputs__image", queryset=Image.objects.all()

app/grandchallenge/algorithms/views.py

@@ -39,6 +39,8 @@
 from grandchallenge.algorithms.filters import (
     AlgorithmFilter,
     EndpointFilter,
+    InvocationFilter,
+    InvocationObjectPermissionsFilter,
     JobViewsetFilter,
 )
 from grandchallenge.algorithms.forms import (
@@ -71,13 +73,16 @@
     AlgorithmModel,
     AlgorithmPermissionRequest,
     Endpoint,
+    Invocation,
     Job,
 )
 from grandchallenge.algorithms.serializers import (
     AlgorithmImageSerializer,
     AlgorithmSerializer,
     EndpointSerializer,
+    HyperlinkedInvocationSerializer,
     HyperlinkedJobSerializer,
+    InvocationPostSerializer,
     JobPostSerializer,
 )
 from grandchallenge.components.backends.exceptions import (
@@ -914,6 +919,21 @@ class EndpointViewSet(ReadOnlyModelViewSet):
     filterset_class = EndpointFilter
 
 
+class InvocationViewSet(
+    CreateModelMixin, RetrieveModelMixin, ListModelMixin, GenericViewSet
+):
+    queryset = Invocation.objects.all()
+    permission_classes = [DjangoObjectPermissions]
+    filter_backends = [DjangoFilterBackend, InvocationObjectPermissionsFilter]
+    filterset_class = InvocationFilter
+
+    def get_serializer_class(self):
+        if self.action == "create":
+            return InvocationPostSerializer
+        else:
+            return HyperlinkedInvocationSerializer
+
+
 class AlgorithmPermissionRequestCreate(
     LoginRequiredMixin, SuccessMessageMixin, CreateView
 ):

app/grandchallenge/api/urls.py

@@ -6,6 +6,7 @@
     AlgorithmImageViewSet,
     AlgorithmViewSet,
     EndpointViewSet,
+    InvocationViewSet,
     JobViewSet,
 )
 from grandchallenge.api.views import GCAPIView
@@ -50,6 +51,11 @@
 router.register(
     r"algorithms/endpoints", EndpointViewSet, basename="algorithms-endpoint"
 )
+router.register(
+    r"algorithms/invocations",
+    InvocationViewSet,
+    basename="algorithms-invocation",
+)
 router.register(r"algorithms", AlgorithmViewSet, basename="algorithm")
 
 # Archives