fix: metadata-incorrectly-linked-to-entity (#57)

* fix: reviewed-metadata-update-or-create-parameter-and-moved-in-shared-serializer

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: replaced-ids-with-pks

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* feat: removed-redundant-checks

* feat: bumped-version

* fix: reviewed-validation-to-delete-metadata-without-value

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: reverted-to-delete-before-update-behavior

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update src/common/metadata/serializers.py

Co-authored-by: Kim Gustyr <[email protected]>

* fix: typed-dict-metadata-item

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix: fix-incorrect-comparison

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Kim Gustyr <[email protected]>

Author: 3 people

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flagsmith-common"
-version = "1.12.0"
+version = "1.12.1"
 description = "Flagsmith's common library"
 requires-python = ">=3.11,<4.0"
 dependencies = [

src/common/metadata/serializers.py

@@ -5,6 +5,8 @@
 from django.db import models
 from rest_framework import serializers
 
+from common.metadata.types import MetadataItem
+
 if typing.TYPE_CHECKING:
     from common.types import (
         Metadata,  # noqa: F401
@@ -56,6 +58,43 @@ def get_required_for_object(
             )
         return instance
 
+    def update_metadata(
+        self,
+        instance: models.Model,
+        metadata_data: list[MetadataItem],
+    ) -> None:
+        Metadata = apps.get_model("metadata", "Metadata")
+        ContentType = apps.get_model("contenttypes", "ContentType")
+
+        content_type = ContentType.objects.get_for_model(instance.__class__)
+
+        if not metadata_data:
+            Metadata.objects.filter(
+                object_id=instance.pk, content_type=content_type
+            ).delete()
+            return
+
+        incoming_updated_fields = {
+            item["model_field"].id for item in metadata_data if not item.get("delete")
+        }
+
+        Metadata.objects.filter(
+            object_id=instance.pk,
+            content_type=content_type,
+        ).exclude(model_field__id__in=incoming_updated_fields).delete()
+
+        for metadata_item in metadata_data:
+            metadata_model_field = metadata_item.pop("model_field", None)
+            if metadata_model_field is not None and metadata_model_field.id is not None:
+                Metadata.objects.update_or_create(
+                    model_field=metadata_model_field,
+                    content_type=content_type,
+                    object_id=instance.pk,
+                    defaults={
+                        **metadata_item,
+                    },
+                )
+
     def validate_required_metadata(
         self,
         data: dict[str, typing.Any],

src/common/metadata/types.py

@@ -0,0 +1,11 @@
+from typing import Any, NotRequired, Protocol, TypedDict
+
+
+class HasId(Protocol):
+    id: int
+
+
+class MetadataItem(TypedDict, total=False):
+    model_field: HasId
+    field_value: Any
+    delete: NotRequired[bool]

src/common/segments/serializers.py

@@ -3,7 +3,6 @@
 
 from django.apps import apps
 from django.conf import settings
-from django.contrib.contenttypes.models import ContentType
 from django.db import models
 from flag_engine.segments.constants import PERCENTAGE_SPLIT
 from rest_framework import serializers
@@ -118,7 +117,8 @@ def create(self, validated_data: dict[str, Any]) -> "Segment":
         self._update_or_create_segment_rules(
             rules_data, segment=segment, is_create=True
         )
-        self._update_or_create_metadata(metadata_data, segment=segment)
+        self.update_metadata(segment, metadata_data)
+        segment.refresh_from_db()
         return segment
 
     def update(
@@ -139,7 +139,7 @@ def update(
 
         try:
             self._update_segment_rules(rules_data, segment=instance)
-            self._update_or_create_metadata(metadata_data, segment=instance)
+            self.update_metadata(instance, metadata_data)
 
             # remove rules from validated data to prevent error trying to create segment with nested rules
             del validated_data["rules"]
@@ -250,33 +250,6 @@ def _update_or_create_segment_rules(
                 child_rules, rule=child_rule, is_create=is_create
             )
 
-    def _update_or_create_metadata(
-        self,
-        metadata_data: list[dict[str, Any]],
-        segment: "Segment | None" = None,
-    ) -> None:
-        Metadata = apps.get_model("metadata", "Metadata")
-        Segment = apps.get_model("segments", "Segment")
-        assert segment
-        if len(metadata_data) == 0:
-            Metadata.objects.filter(object_id=segment.id).delete()
-            return
-        if metadata_data is not None:
-            for metadata_item in metadata_data:
-                metadata_model_field = metadata_item.pop("model_field", None)
-                if metadata_item.get("delete"):
-                    Metadata.objects.filter(model_field=metadata_model_field).delete()
-                    continue
-
-                Metadata.objects.update_or_create(
-                    model_field=metadata_model_field,
-                    defaults={
-                        **metadata_item,
-                        "content_type": ContentType.objects.get_for_model(Segment),
-                        "object_id": segment.id,
-                    },
-                )
-
     @staticmethod
     def _update_or_create_segment_rule(
         rule_data: dict[str, Any],