Dynamic examples for view content field help text (#3697)

ammar257ammar · amickan · web-flow · commit 77c0438bcaef · 2024-11-25T15:08:54.000+01:00
Related to the first part of https://github.com/DIAGNijmegen/rse-roadmap/issues/362 --------- Co-authored-by: Anne Mickan <amickan1990@gmail.com>
diff --git a/app/grandchallenge/algorithms/forms.py b/app/grandchallenge/algorithms/forms.py
@@ -83,6 +83,7 @@
 )
 from grandchallenge.evaluation.utils import get
 from grandchallenge.groups.forms import UserGroupForm
+from grandchallenge.hanging_protocols.forms import ViewContentExampleMixin
 from grandchallenge.hanging_protocols.models import VIEW_CONTENT_SCHEMA
 from grandchallenge.reader_studies.models import ReaderStudy
 from grandchallenge.subdomains.utils import reverse, reverse_lazy
@@ -241,6 +242,7 @@ class AlgorithmForm(
     AlgorithmIOValidationMixin,
     WorkstationUserFilterMixin,
     SaveFormInitMixin,
+    ViewContentExampleMixin,
     ModelForm,
 ):
     inputs = ModelMultipleChoiceField(
@@ -378,17 +380,6 @@ def __init__(self, *args, **kwargs):
             MaxValueValidator(settings.ALGORITHMS_MAX_MEMORY_GB),
         ]
 
-        if self.instance:
-            interface_slugs = (
-                (self.instance.inputs.all() | self.instance.outputs.all())
-                .distinct()
-                .values_list("slug", flat=True)
-            )
-            self.fields["view_content"].help_text += (
-                " The following interfaces are used in your algorithm: "
-                f"{oxford_comma(interface_slugs)}."
-            )
-
 
 class UserAlgorithmsForPhaseMixin:
     def __init__(self, *args, user, phase, **kwargs):
diff --git a/app/grandchallenge/algorithms/models.py b/app/grandchallenge/algorithms/models.py
@@ -443,6 +443,10 @@ def add_user(self, user):
     def remove_user(self, user):
         return user.groups.remove(self.users_group)
 
+    @cached_property
+    def interfaces(self):
+        return (self.inputs.all() | self.outputs.all()).distinct()
+
     @cached_property
     def user_statistics(self):
         return (
diff --git a/app/grandchallenge/archives/forms.py b/app/grandchallenge/archives/forms.py
@@ -38,6 +38,7 @@
     MarkdownEditorInlineWidget,
 )
 from grandchallenge.groups.forms import UserGroupForm
+from grandchallenge.hanging_protocols.forms import ViewContentExampleMixin
 from grandchallenge.hanging_protocols.models import VIEW_CONTENT_SCHEMA
 from grandchallenge.reader_studies.models import ReaderStudy
 from grandchallenge.subdomains.utils import reverse_lazy
@@ -46,6 +47,7 @@
 class ArchiveForm(
     WorkstationUserFilterMixin,
     SaveFormInitMixin,
+    ViewContentExampleMixin,
     ModelForm,
 ):
     def __init__(self, *args, **kwargs):
@@ -67,17 +69,6 @@ def __init__(self, *args, **kwargs):
             .filter(has_active_image=True)
             .distinct()
         )
-        if self.instance:
-            interface_slugs = (
-                self.instance.items.exclude(values__isnull=True)
-                .values_list("values__interface__slug", flat=True)
-                .order_by()
-                .distinct()
-            )
-            self.fields["view_content"].help_text += (
-                " The following interfaces are used in your archive: "
-                f"{', '.join(interface_slugs)}."
-            )
 
     class Meta:
         model = Archive
diff --git a/app/grandchallenge/components/models.py b/app/grandchallenge/components/models.py
@@ -2578,6 +2578,14 @@ def values_for_interfaces(self):
         }
         return values_for_interfaces
 
+    @cached_property
+    def interfaces(self):
+        return ComponentInterface.objects.filter(
+            pk__in=self.civ_sets_related_manager.exclude(
+                values__isnull=True
+            ).values_list("values__interface__pk", flat=True)
+        ).distinct()
+
 
 class Tarball(UUIDModel):
     ImportStatusChoices = ImportStatusChoices
diff --git a/app/grandchallenge/evaluation/forms.py b/app/grandchallenge/evaluation/forms.py
@@ -56,6 +56,7 @@
     Submission,
 )
 from grandchallenge.evaluation.utils import SubmissionKindChoices
+from grandchallenge.hanging_protocols.forms import ViewContentExampleMixin
 from grandchallenge.hanging_protocols.models import VIEW_CONTENT_SCHEMA
 from grandchallenge.subdomains.utils import reverse, reverse_lazy
 from grandchallenge.uploads.models import UserUpload
@@ -150,6 +151,7 @@ class PhaseUpdateForm(
     PhaseTitleMixin,
     WorkstationUserFilterMixin,
     SaveFormInitMixin,
+    ViewContentExampleMixin,
     forms.ModelForm,
 ):
     def __init__(self, *args, **kwargs):
diff --git a/app/grandchallenge/evaluation/models.py b/app/grandchallenge/evaluation/models.py
@@ -868,6 +868,12 @@ def set_default_interfaces(self):
             [ComponentInterface.objects.get(slug="metrics-json-file")]
         )
 
+    @cached_property
+    def interfaces(self):
+        return (
+            self.algorithm_inputs.all() | self.algorithm_outputs.all()
+        ).distinct()
+
     def assign_permissions(self):
         assign_perm("view_phase", self.challenge.admins_group, self)
         assign_perm("change_phase", self.challenge.admins_group, self)
diff --git a/app/grandchallenge/hanging_protocols/forms.py b/app/grandchallenge/hanging_protocols/forms.py
@@ -1,13 +1,26 @@
+import json
+
 from crispy_forms.helper import FormHelper
 from crispy_forms.layout import ButtonHolder, Div, Layout, Submit
 from django import forms
+from django.core.exceptions import ValidationError
+from django.utils.text import format_lazy
 
+from grandchallenge.components.models import (
+    InterfaceKind,
+    InterfaceKindChoices,
+)
 from grandchallenge.core.forms import SaveFormInitMixin
+from grandchallenge.core.templatetags.remove_whitespace import oxford_comma
+from grandchallenge.core.validators import JSONValidator
 from grandchallenge.core.widgets import JSONEditorWidget
 from grandchallenge.hanging_protocols.models import (
     HANGING_PROTOCOL_SCHEMA,
+    VIEW_CONTENT_SCHEMA,
     HangingProtocol,
+    ViewportNames,
 )
+from grandchallenge.subdomains.utils import reverse
 
 
 class HangingProtocolForm(SaveFormInitMixin, forms.ModelForm):
@@ -116,3 +129,92 @@ def _validate_slice_plane_indicator(self, *, viewport, viewport_names):
                 error=f"Viewport {viewport['viewport_name']} has a slice_plane_indicator that is the same as the viewport_name.",
                 field="json",
             )
+
+
+class ViewContentExampleMixin:
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.instance:
+            interface_slugs = [
+                interface.slug for interface in self.instance.interfaces
+            ]
+
+            if len(interface_slugs) > 0:
+                self.fields[
+                    "view_content"
+                ].help_text += f"The following interfaces are used in your {self.instance._meta.verbose_name}: {oxford_comma(interface_slugs)}. "
+
+            view_content_example = self.generate_view_content_example()
+
+            if view_content_example:
+                self.fields[
+                    "view_content"
+                ].help_text += f"Example usage: {view_content_example}. "
+            else:
+                self.fields[
+                    "view_content"
+                ].help_text += "No interfaces of type image, chart, pdf, mp4, thumbnail_jpg or thumbnail_png are used. At least one interface of those types is needed to configure the viewer. "
+
+        self.fields["view_content"].help_text += format_lazy(
+            'Refer to the <a href="{}">documentation</a> for more information',
+            reverse("documentation:detail", args=["viewer-content"]),
+        )
+
+    def generate_view_content_example(self):
+        images = [
+            interface.slug
+            for interface in self.instance.interfaces
+            if interface.kind == InterfaceKindChoices.IMAGE
+        ]
+        mandatory_isolation_interfaces = [
+            interface.slug
+            for interface in self.instance.interfaces
+            if interface.kind
+            in InterfaceKind.interface_type_mandatory_isolation()
+        ]
+
+        if not images and not mandatory_isolation_interfaces:
+            return None
+
+        overlays = [
+            interface.slug
+            for interface in self.instance.interfaces
+            if interface.kind
+            not in (
+                *InterfaceKind.interface_type_undisplayable(),
+                *InterfaceKind.interface_type_mandatory_isolation(),
+                InterfaceKindChoices.IMAGE,
+            )
+        ]
+
+        if images:
+            overlays_per_image = len(overlays) // len(images)
+            remaining_overlays = len(overlays) % len(images)
+
+        view_content_example = {}
+
+        for port in ViewportNames.values:
+            if mandatory_isolation_interfaces:
+                view_content_example[port] = [
+                    mandatory_isolation_interfaces.pop(0)
+                ]
+            elif images:
+                view_content_example[port] = [images.pop(0)]
+                for _ in range(overlays_per_image):
+                    view_content_example[port].append(overlays.pop(0))
+                if remaining_overlays > 0:
+                    view_content_example[port].append(overlays.pop(0))
+                    remaining_overlays -= 1
+
+        try:
+            JSONValidator(schema=VIEW_CONTENT_SCHEMA)(
+                value=view_content_example
+            )
+            self.instance.clean_view_content(
+                view_content=view_content_example,
+                hanging_protocol=self.instance.hanging_protocol,
+            )
+        except ValidationError as error:
+            raise RuntimeError("view_content example is not valid.") from error
+
+        return json.dumps(view_content_example)
diff --git a/app/grandchallenge/hanging_protocols/models.py b/app/grandchallenge/hanging_protocols/models.py
@@ -306,7 +306,9 @@ class HangingProtocolMixin(models.Model):
     view_content = models.JSONField(
         blank=True,
         default=dict,
-        validators=[JSONValidator(schema=VIEW_CONTENT_SCHEMA)],
+        validators=[
+            JSONValidator(schema=VIEW_CONTENT_SCHEMA),
+        ],
     )
     hanging_protocol = models.ForeignKey(
         "hanging_protocols.HangingProtocol",
@@ -326,24 +328,28 @@ class HangingProtocolMixin(models.Model):
     def clean(self):
         super().clean()
 
-        self.check_consistent_viewports()
-        self.check_all_interfaces_in_view_content_exist()
+        self.clean_view_content(
+            view_content=self.view_content,
+            hanging_protocol=self.hanging_protocol,
+        )
 
-    def check_consistent_viewports(self):
-        if self.view_content and self.hanging_protocol:
-            if set(self.view_content.keys()) != {
-                x["viewport_name"] for x in self.hanging_protocol.json
+    @staticmethod
+    def check_consistent_viewports(*, view_content, hanging_protocol):
+        if view_content and hanging_protocol:
+            if set(view_content.keys()) != {
+                x["viewport_name"] for x in hanging_protocol.json
             }:
                 raise ValidationError(
                     "Image ports in view_content do not match "
                     "those in the selected hanging protocol."
                 )
 
-    def check_all_interfaces_in_view_content_exist(self):
-        if not hasattr(self.view_content, "items"):
+    @staticmethod
+    def check_all_interfaces_in_view_content_exist(*, view_content):
+        if not hasattr(view_content, "items"):
             raise ValidationError("View content is invalid")
 
-        for viewport, slugs in self.view_content.items():
+        for viewport, slugs in view_content.items():
             viewport_interfaces = ComponentInterface.objects.filter(
                 slug__in=slugs
             )
@@ -395,5 +401,14 @@ def check_all_interfaces_in_view_content_exist(self):
                     f"{', '.join(i.slug for i in undisplayable_interfaces)}"
                 )
 
+    @staticmethod
+    def clean_view_content(*, view_content, hanging_protocol):
+        HangingProtocolMixin.check_consistent_viewports(
+            view_content=view_content, hanging_protocol=hanging_protocol
+        )
+        HangingProtocolMixin.check_all_interfaces_in_view_content_exist(
+            view_content=view_content
+        )
+
     class Meta:
         abstract = True
diff --git a/app/grandchallenge/reader_studies/forms.py b/app/grandchallenge/reader_studies/forms.py
@@ -56,6 +56,7 @@
     MarkdownEditorInlineWidget,
 )
 from grandchallenge.groups.forms import UserGroupForm
+from grandchallenge.hanging_protocols.forms import ViewContentExampleMixin
 from grandchallenge.hanging_protocols.models import VIEW_CONTENT_SCHEMA
 from grandchallenge.reader_studies.models import (
     ANSWER_TYPE_TO_INTERACTIVE_ALGORITHM_CHOICES,
@@ -189,7 +190,9 @@ def clean(self):
             )
 
 
-class ReaderStudyUpdateForm(ReaderStudyCreateForm, ModelForm):
+class ReaderStudyUpdateForm(
+    ReaderStudyCreateForm, ViewContentExampleMixin, ModelForm
+):
     class Meta(ReaderStudyCreateForm.Meta):
         fields = (
             "title",
@@ -254,19 +257,6 @@ class Meta(ReaderStudyCreateForm.Meta):
             ),
         }
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        interface_slugs = (
-            self.instance.display_sets.exclude(values__isnull=True)
-            .values_list("values__interface__slug", flat=True)
-            .order_by()
-            .distinct()
-        )
-        self.fields["view_content"].help_text += (
-            " The following interfaces are used in your reader study: "
-            f"{', '.join(interface_slugs)}."
-        )
-
 
 class ReaderStudyCopyForm(Form):
     title = CharField(required=True)
diff --git a/app/tests/hanging_protocols_tests/test_forms.py b/app/tests/hanging_protocols_tests/test_forms.py
