[OSDEV-2329] Show MIT Living Wage and WageIndicator data in GET v1/production-locations

doc/release/RELEASE-NOTES.md

@@ -3,6 +3,21 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). The format is based on the `RELEASE-NOTES-TEMPLATE.md` file.
 
+## Release 2.19.0
+
+## Introduction
+* Product name: Open Supply Hub
+* Release date: *Provide release date*
+
+### Code/API changes
+* [OSDEV-2329](https://opensupplyhub.atlassian.net/browse/OSDEV-2329) - Pass `wage_indicator` and `mit_living_wage` fields to `GET api/v1/production-locations/?os_id` endpoint.
+
+### Release instructions
+* Ensure that the following commands are included in the `post_deployment` command:
+    * `migrate`
+    * `reindex_database`
+
+
 ## Release 2.18.0
 
 ## Introduction

src/django/api/tests/test_production_locations_get.py

@@ -1,8 +1,19 @@
 import unittest.mock
+from django.contrib.gis.geos import Point, MultiPolygon
+from django.core.cache import cache
 from rest_framework.test import APITestCase
 from rest_framework import status
 from api.views.v1.response_mappings.production_locations_response \
     import ProductionLocationsResponseMapping
+from api.models.partner_field import PartnerField
+from api.models.contributor.contributor import Contributor
+from api.models.facility.facility import Facility
+from api.models.facility.facility_list import FacilityList
+from api.models.facility.facility_list_item import FacilityListItem
+from api.models.source import Source
+from api.models.user import User
+from api.models.us_county_tigerline import USCountyTigerline
+from api.models.wage_indicator_country_data import WageIndicatorCountryData
 
 
 OPEN_SEARCH_SERVICE = "api.views.v1.production_locations.OpenSearchService"
@@ -132,3 +143,151 @@ def test_single_production_location_response_mapping(self):
             query_body["_source"],
             ProductionLocationsResponseMapping.PRODUCTION_LOCATION_BY_OS_ID,
         )
+
+    def _create_facility_with_partner_data(self):
+        cache.clear()
+        user = User.objects.create(email="[email protected]")
+        contributor = Contributor.objects.create(
+            admin=user,
+            name="Test Contributor",
+            description="",
+            website="",
+            contrib_type=Contributor.OTHER_CONTRIB_TYPE,
+        )
+
+        wage_indicator_field, _ = PartnerField.objects.get_or_create(
+            name="wage_indicator",
+            defaults={
+                "type": PartnerField.OBJECT,
+                "system_field": True,
+                "base_url": "https://wageindicator.example/",
+            }
+        )
+        mit_living_wage_field, _ = PartnerField.objects.get_or_create(
+            name="mit_living_wage",
+            defaults={
+                "type": PartnerField.OBJECT,
+                "system_field": True,
+                "base_url": "https://livingwage.mit.edu/counties/",
+            }
+        )
+
+        contributor.partner_fields.add(
+            wage_indicator_field,
+            mit_living_wage_field,
+        )
+
+        facility_list = FacilityList.objects.create(
+            name="Test List",
+            file_name="test.csv",
+            header="name,address,country",
+        )
+        source = Source.objects.create(
+            source_type=Source.LIST,
+            facility_list=facility_list,
+            contributor=contributor,
+        )
+        facility_list_item = FacilityListItem.objects.create(
+            name="Test Facility",
+            address="123 Example St",
+            country_code="US",
+            sector=["Apparel"],
+            row_index=0,
+            status=FacilityListItem.CONFIRMED_MATCH,
+            source=source,
+            raw_data="Test Facility,123 Example St,US",
+            raw_header="name,address,country",
+            raw_json={},
+            processing_results=[],
+        )
+
+        location = Point(-73.935242, 40.73061, srid=4326)
+        facility = Facility.objects.create(
+            id=self.os_id,
+            name="Test Facility",
+            address="123 Example St",
+            country_code="US",
+            location=location,
+            created_from=facility_list_item,
+        )
+
+        WageIndicatorCountryData.objects.update_or_create(
+            country_code=facility.country_code,
+            defaults={
+                "living_wage_link_national": (
+                    "https://paywizard.org/salary/living-wages"
+                ),
+                "minimum_wage_link_english": (
+                    "https://wageindicator.org/salary/minimum-wage/"
+                    "united-states-of-america"
+                ),
+                "minimum_wage_link_national": (
+                    "https://paywizard.org/salary/minimum-wage"
+                ),
+            },
+        )
+
+        point_5070 = location.transform(5070, clone=True)
+        county_geometry = point_5070.buffer(1)
+        if county_geometry.geom_type != "MultiPolygon":
+            county_geometry = MultiPolygon(county_geometry)
+
+        USCountyTigerline.objects.create(
+            geoid="12345",
+            name="Test County",
+            geometry=county_geometry,
+        )
+
+        return facility
+
+    def test_get_single_production_location_includes_partner_fields(self):
+        facility = self._create_facility_with_partner_data()
+
+        self.search_index_mock.return_value = {
+            "count": 1,
+            "data": [
+                {
+                    "os_id": facility.id,
+                    "name": "location1",
+                }
+            ],
+        }
+
+        url = f"/api/v1/production-locations/{facility.id}/"
+        api_res = self.client.get(url)
+
+        self.assertEqual(api_res.status_code, status.HTTP_200_OK)
+        self.assertIn("wage_indicator", api_res.data)
+        self.assertIn("mit_living_wage", api_res.data)
+
+        wage_indicator = api_res.data["wage_indicator"]
+        mit_living_wage = api_res.data["mit_living_wage"]
+
+        self.assertIsInstance(wage_indicator, list)
+        self.assertIsInstance(mit_living_wage, list)
+        self.assertGreaterEqual(len(wage_indicator), 1)
+        self.assertGreaterEqual(len(mit_living_wage), 1)
+
+        wi_entry = wage_indicator[0]
+        mit_entry = mit_living_wage[0]
+
+        self.assertEqual(
+            wi_entry["value"]["raw_values"]["living_wage_link_national"],
+            "https://paywizard.org/salary/living-wages",
+        )
+        self.assertEqual(
+            wi_entry["value"]["raw_values"]["minimum_wage_link_english"],
+            "https://wageindicator.org/salary/minimum-wage/"
+            "united-states-of-america",
+        )
+        self.assertEqual(
+            wi_entry["value"]["raw_values"]["minimum_wage_link_national"],
+            "https://paywizard.org/salary/minimum-wage",
+        )
+        self.assertEqual(wi_entry["field_name"], "wage_indicator")
+
+        self.assertEqual(
+            mit_entry["value"]["raw_values"]["county_id"],
+            "12345",
+        )
+        self.assertEqual(mit_entry["field_name"], "mit_living_wage")

src/django/api/views/v1/production_locations.py

@@ -40,7 +40,8 @@
 from api.constants import (
     APIV1CommonErrorMessages,
     NON_FIELD_ERRORS_KEY,
-    APIV1LocationContributionErrorMessages
+    APIV1LocationContributionErrorMessages,
+    PARTNER_FIELD_NAMES_KEY,
 )
 from api.exceptions import ServiceUnavailableException
 from api.mail import (
@@ -49,6 +50,7 @@
 )
 from api.views.v1.response_mappings.production_locations_response import \
     ProductionLocationsResponseMapping
+from api.partner_fields.registry import system_partner_field_registry
 
 
 class ProductionLocations(ViewSet):
@@ -65,6 +67,22 @@ def __init_opensearch() -> Tuple[OpenSearchService,
 
         return (opensearch_service, opensearch_query_director)
 
+    @staticmethod
+    def __add_partner_field_value(partner_extended_fields, field_name, value):
+        """
+        Extract and add partner field value to the response dictionary.
+        """
+        if not field_name or not isinstance(value, dict):
+            return
+
+        raw_values = value.get('raw_values')
+        raw_value = value.get('raw_value')
+
+        if isinstance(raw_values, (list, dict)):
+            partner_extended_fields[field_name] = raw_values
+        elif raw_value is not None:
+            partner_extended_fields[field_name] = raw_value
+
     def get_permissions(self):
         '''
         Redefines the parent method and returns the list of permissions for
@@ -280,7 +298,7 @@ def partial_update(self, request, pk=None):
     def __get_partner_fields(self, pk):
         """
         Checks and returns partner extended fields for a
-        facility object by its ID.
+        facility object by its ID or by the provided Facility instance.
 
         Caches the list of partner field names for one hour.
         Returns a dictionary of the form:
@@ -290,7 +308,7 @@ def __get_partner_fields(self, pk):
                 ...
             }
         """
-        cache_key = 'partner_field_names'
+        cache_key = PARTNER_FIELD_NAMES_KEY
         partner_field_names = cache.get(cache_key)
 
         if partner_field_names is None:
@@ -299,27 +317,39 @@ def __get_partner_fields(self, pk):
             )
             cache.set(cache_key, partner_field_names, 60 * 60)
 
-        if not partner_field_names:
-            return {}
+        partner_extended_fields = {}
 
-        partner_field_values = ExtendedField.objects.filter(
-            facility__id=pk,
-            field_name__in=partner_field_names
-        ).values('field_name', 'value')
+        if partner_field_names:
+            partner_field_values = ExtendedField.objects.filter(
+                facility__id=pk,
+                field_name__in=partner_field_names
+            ).values('field_name', 'value')
 
-        partner_extended_fields = {}
+            for field in partner_field_values:
+                self.__add_partner_field_value(
+                    partner_extended_fields,
+                    field.get('field_name'),
+                    field.get('value'),
+                )
+
+        facility = Facility.objects.filter(id=pk).only(
+            'id',
+            'country_code',
+            'location',
+        ).first()
+
+        if facility:
+            for provider in system_partner_field_registry.providers:
+                provider_data = provider.fetch_data(facility)
+
+                if provider_data is None:
+                    continue
 
-        for field in partner_field_values:
-            field_name = field['field_name']
-            value = field['value']
+                field_name = provider_data.get('field_name')
+                if not field_name:
+                    continue
 
-            if not isinstance(value, dict):
-                continue
+                # Use the rich provider payload (list entry) for system fields.
+                partner_extended_fields[field_name] = [provider_data]
 
-            if 'raw_values' in value and isinstance(
-                value['raw_values'], (list, dict)
-            ):
-                partner_extended_fields[field_name] = value['raw_values']
-            elif 'raw_value' in value:
-                partner_extended_fields[field_name] = value['raw_value']
         return partner_extended_fields