fix(api): deprecate related.id in favour of related.ids (#486)

* fix(api): deprecate related.id in favour of related.ids

* one other test

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Update api/howler/odm/models/ecs/related.py

Co-authored-by: cccs-hxp <xuan.pham@cyber.gc.ca>

---------

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: cccs-hxp <xuan.pham@cyber.gc.ca>

Author: 3 people

api/howler/odm/models/ecs/related.py

@@ -33,7 +33,13 @@ class Related(odm.Model):
     )
 
     # Extra fields not defined in ECS but added for outline purposes
-    id = odm.Optional(odm.Keyword(description="The id related to the event."))
+    id = odm.Optional(
+        odm.Keyword(
+            description="The id related to the event.",
+            deprecated=True,
+            deprecated_description="related.ids should be used instead of related.id.",
+        )
+    )
 
     uri = odm.Optional(odm.List(odm.URI(), description="All of the URIs related to the event."))
 
@@ -43,3 +49,23 @@ class Related(odm.Model):
             description="All the signatures/rules that were triggered by the event.",
         )
     )
+
+    def __init__(self, data: dict = None, *args, **kwargs):
+        if data is not None and data.get("id") is not None:
+            # Avoid mutating the caller-provided dict
+            data = dict(data)
+
+            existing_ids = data.get("ids")
+            if isinstance(existing_ids, (list, tuple)):
+                merged_ids = list(existing_ids)
+            elif existing_ids is None:
+                merged_ids = []
+            else:
+                merged_ids = [existing_ids]
+
+            if data["id"] not in merged_ids:
+                merged_ids.append(data["id"])
+
+            data["ids"] = merged_ids
+
+        super().__init__(data, *args, **kwargs)

api/test/unit/odm/test_related.py

@@ -0,0 +1,29 @@
+from howler.odm.models.ecs.related import Related
+from howler.odm.models.hit import Hit
+
+
+class TestRelated:
+    def test_related_id_is_copied_to_ids(self):
+        related = Related({"id": "indicator-1"})
+
+        assert related.id == "indicator-1"
+        assert related.ids == ["indicator-1"]
+
+    def test_related_id_merges_into_existing_ids_without_duplicates(self):
+        related = Related({"id": "indicator-2", "ids": ["indicator-1", "indicator-2"]})
+
+        assert related.id == "indicator-2"
+        assert related.ids == ["indicator-1", "indicator-2"]
+
+    def test_related_id_merges_into_existing_ids_tuple(self):
+        related = Related({"id": "indicator-2", "ids": ("indicator-1", "indicator-2")})
+
+        assert related.id == "indicator-2"
+        assert related.ids == ["indicator-1", "indicator-2"]
+
+    def test_parent_odm_related_id_key_is_copied_to_related_ids(self):
+        hit = Hit({"howler.analytic": "Test Analytic", "howler.hash": "a", "related.id": "indicator-3"})
+
+        assert hit.related is not None
+        assert hit.related.id == "indicator-3"
+        assert hit.related.ids == ["indicator-3"]