From 630286f9431339068a4c74d5052ba29243cda469 Mon Sep 17 00:00:00 2001
From: chrispreee <117157625+chrispreee@users.noreply.github.com>
Date: Fri, 10 Jan 2025 11:22:00 +0000
Subject: [PATCH] Add display name to product serializer, see HEA-652

---
 apps/common/serializers.py         | 6 ++++++
 apps/common/tests/test_viewsets.py | 1 +
 2 files changed, 7 insertions(+)

diff --git a/apps/common/serializers.py b/apps/common/serializers.py
index 7d13730..5516b0c 100644
--- a/apps/common/serializers.py
+++ b/apps/common/serializers.py
@@ -57,12 +57,18 @@ class Meta:
             "cpc",
             "description",
             "common_name",
+            "display_name",
             "scientific_name",
             "unit_of_measure",
             "kcals_per_unit",
             "aliases",
         ]
 
+    display_name = serializers.SerializerMethodField()
+
+    def get_display_name(self, obj):
+        return obj.display_name()
+
 
 class UserSerializer(serializers.ModelSerializer):
     class Meta:
diff --git a/apps/common/tests/test_viewsets.py b/apps/common/tests/test_viewsets.py
index 285c3c1..65b9991 100644
--- a/apps/common/tests/test_viewsets.py
+++ b/apps/common/tests/test_viewsets.py
@@ -181,6 +181,7 @@ def test_filter_by_common_name(self):
         result = json.loads(response.content.decode("utf-8"))
         self.assertEqual(len(result), 1)
         self.assertEqual(result[0]["common_name"], self.product2.common_name)
+        self.assertEqual(result[0]["display_name"], self.product2.display_name())
 
     def test_search_fields(self):
         response = self.client.get(self.url, {"search": "Product Description"})