Allow extending overlay segments for sockets (#4034)

Closes
DIAGNijmegen/rse-grand-challenge-admin#520

---------

Co-authored-by: James Meakin <12661555+jmsmkn@users.noreply.github.com>

Author: amickan

app/grandchallenge/components/models.py

@@ -622,6 +622,7 @@ def _clean_overlay_segments(self):
         if (
             self.pk is not None
             and self._overlay_segments_orig != self.overlay_segments
+            and not self._overlay_segments_preserved
             and (
                 ComponentInterfaceValue.objects.filter(interface=self).exists()
                 or Question.objects.filter(interface=self).exists()
@@ -632,6 +633,16 @@ def _clean_overlay_segments(self):
                 "for this ComponentInterface exist."
             )
 
+    @property
+    def _overlay_segments_preserved(self):
+        orig_overlay_segments = {
+            tuple(sorted(d.items())) for d in self._overlay_segments_orig
+        }
+        new_overlay_segments = {
+            tuple(sorted(d.items())) for d in self.overlay_segments
+        }
+        return orig_overlay_segments <= new_overlay_segments
+
     def _clean_relative_path(self):
         if (
             self.is_file_kind or self.is_json_kind

app/tests/components_tests/test_models.py

@@ -1110,15 +1110,15 @@ def test_runtime_metrics_chart():
 
 @pytest.mark.django_db
 def test_clean_overlay_segments_with_values():
-    ci = ComponentInterfaceFactory(kind=InterfaceKindChoices.SEGMENTATION)
-    ci.overlay_segments = [{"name": "s1", "visible": True, "voxel_value": 1}]
+    ci = ComponentInterfaceFactory(
+        kind=InterfaceKindChoices.SEGMENTATION,
+        overlay_segments=[{"name": "s1", "visible": True, "voxel_value": 1}],
+    )
     ci._clean_overlay_segments()
-    ci.save()
 
     ComponentInterfaceValueFactory(interface=ci)
     ci.overlay_segments = [
-        {"name": "s1", "visible": True, "voxel_value": 1},
-        {"name": "s2", "visible": True, "voxel_value": 2},
+        {"name": "s2", "visible": True, "voxel_value": 1},
     ]
     with pytest.raises(ValidationError) as e:
         ci._clean_overlay_segments()
@@ -1136,18 +1136,17 @@ def test_clean_overlay_segments_with_questions(reader_study_with_gt):
     )
     assert question.interface is None
 
-    ci = ComponentInterface(
-        kind=InterfaceKindChoices.SEGMENTATION, relative_path="images/test"
+    ci = ComponentInterfaceFactory(
+        kind=InterfaceKindChoices.SEGMENTATION,
+        relative_path="images/test",
+        overlay_segments=[{"name": "s1", "visible": True, "voxel_value": 1}],
     )
-    ci.overlay_segments = [{"name": "s1", "visible": True, "voxel_value": 1}]
     ci._clean_overlay_segments()
-    ci.save()
 
     question.interface = ci
     question.save()
     ci.overlay_segments = [
-        {"name": "s1", "visible": True, "voxel_value": 1},
-        {"name": "s2", "visible": True, "voxel_value": 2},
+        {"name": "s2", "visible": True, "voxel_value": 1},
     ]
     with pytest.raises(ValidationError) as e:
         ci._clean_overlay_segments()
@@ -1191,6 +1190,47 @@ def test_clean_overlay_segments():
     ci._clean_overlay_segments()
 
 
+@pytest.mark.parametrize(
+    "updated_segments, expectation",
+    (
+        [
+            [{"name": "s1", "visible": True, "voxel_value": 1}],
+            pytest.raises(ValidationError),
+        ],  # deletes existing voxel values
+        [
+            [
+                {"name": "sfoo", "visible": True, "voxel_value": 1},
+                {"name": "s2", "visible": True, "voxel_value": 2},
+            ],
+            pytest.raises(ValidationError),
+        ],  # changes name of existing voxel value
+        [
+            [
+                {"name": "s1", "visible": True, "voxel_value": 1},
+                {"name": "s2", "visible": True, "voxel_value": 2},
+                {"name": "s3", "visible": True, "voxel_value": 3},
+            ],
+            nullcontext(),
+        ],  # adds new voxel value
+    ),
+)
+@pytest.mark.django_db
+def test_overlay_segments_can_be_extended(updated_segments, expectation):
+    ci = ComponentInterfaceFactory(
+        kind=InterfaceKindChoices.SEGMENTATION,
+        overlay_segments=[
+            {"name": "s1", "visible": True, "voxel_value": 1},
+            {"name": "s2", "visible": True, "voxel_value": 2},
+        ],
+    )
+    ComponentInterfaceValueFactory(interface=ci)
+
+    ci.overlay_segments = updated_segments
+
+    with expectation:
+        ci._clean_overlay_segments()
+
+
 @pytest.mark.django_db
 def test_validate_voxel_values():
     ci = ComponentInterfaceFactory(kind=InterfaceKindChoices.SEGMENTATION)