[Part-2] [OSDEV-2065] Update v1 production locations POST/PATCH endpoint to save partner field to extended field model

doc/release/RELEASE-NOTES.md

@@ -23,6 +23,11 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 * [OSDEV-2065](https://opensupplyhub.atlassian.net/browse/OSDEV-2065) - Updated v1 production locations `POST/PATCH` endpoints to include partner fields:
     * Added `unit` field to `PartnerField` model
     * Added type validation for submitted partner fields
+    * Added `create_partner_extendedfields_for_single_item()` function for bulk partner field processing
+    * Enhanced `all_values_empty()` function to handle dictionaries and improve list processing
+    * Integrated partner field creation into the moderation event approval workflow
+    * Added `label` field to `PartnerField` model
+    * Added functionality to display `estimated_emissions_activity` & `estimated_annual_energy_consumption` in Production Location Profile page
 
 ### Release instructions
 * Ensure that the following commands are included in the `post_deployment` command:

src/django/api/admin.py

@@ -242,8 +242,8 @@ def get_ordering(self, request):
 
 
 class PartnerFieldAdmin(admin.ModelAdmin):
-    list_display = ('name', 'type', 'unit', 'created_at')
-    search_fields = ('name', 'type', 'unit')
+    list_display = ('name', 'type', 'label', 'unit', 'created_at')
+    search_fields = ('name', 'type', 'label', 'unit')
     readonly_fields = ('uuid', 'created_at', 'updated_at')
 
 

src/django/api/extended_fields.py

@@ -79,9 +79,20 @@ def get_product_type_extendedfield_value(field_value):
 
 
 def all_values_empty(value):
-    if value is not None and isinstance(value, list):
-        values = [v for v in value if v is not None and v != ""]
-        return len(values) == 0
+    if value is not None:
+        if isinstance(value, list):
+            values = [
+                v for v in value
+                if v is not None and v != ""
+            ]
+            return len(values) == 0
+        if isinstance(value, dict):
+            values = [
+                v for v in value.values()
+                if v is not None and v != ""
+            ]
+            return len(values) == 0
+
     return False
 
 
@@ -123,6 +134,35 @@ def create_extendedfield(field, field_value, item, contributor):
         )
 
 
+OBJECT_FIELD_TYPE = "object"
+
+
+def create_partner_extendedfield(
+        field,
+        field_value,
+        field_type,
+        item,
+        contributor
+):
+    if field_value is not None and field_value != "" \
+            and not all_values_empty(field_value):
+        if field_type == OBJECT_FIELD_TYPE:
+            field_value = {
+                'raw_values': field_value,
+            }
+        else:
+            field_value = {
+                'raw_value': field_value,
+            }
+
+        ExtendedField.objects.create(
+            contributor=contributor,
+            facility_list_item=item,
+            field_name=field,
+            value=field_value
+        )
+
+
 RAW_DATA_FIELDS = (
     ExtendedField.NUMBER_OF_WORKERS,
     ExtendedField.NATIVE_LANGUAGE_NAME,
@@ -137,7 +177,10 @@ def create_extendedfield(field, field_value, item, contributor):
 )
 
 
-def create_extendedfields_for_single_item(item, raw_data):
+def create_extendedfields_for_single_item(
+        item,
+        raw_data
+):
     if item.id is None:
         return False
     contributor = item.source.contributor
@@ -147,6 +190,29 @@ def create_extendedfields_for_single_item(item, raw_data):
         create_extendedfield(field, field_value, item, contributor)
 
 
+def create_partner_extendedfields_for_single_item(
+    item,
+    raw_data
+):
+    if item.id is None:
+        return False
+    contributor = item.source.contributor
+
+    for partner_field in item.source.contributor \
+            .partner_fields.all():
+        field = partner_field.name
+        field_type = partner_field.type
+        field_value = raw_data.get(field)
+
+        create_partner_extendedfield(
+            field,
+            field_value,
+            field_type,
+            item,
+            contributor
+        )
+
+
 def update_extendedfields_for_list_item(list_item):
     for extended_field in ExtendedField.objects.filter(
             facility_list_item=list_item):

src/django/api/migrations/0180_add_unit_to_partner_field.py

@@ -1,5 +1,4 @@
 from django.db import migrations, models
-import uuid
 
 class Migration(migrations.Migration):
     """

src/django/api/migrations/0181_add_label_to_partner_field.py

@@ -0,0 +1,22 @@
+from django.db import migrations, models
+
+class Migration(migrations.Migration):
+    """
+    Migration add unit field to PartnerField model.
+    """
+
+    dependencies = [
+        ('api', '0180_add_unit_to_partner_field'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='partnerfield',
+            name='label',
+            field=models.CharField(
+                max_length=200,
+                blank=True,
+                help_text=('The partner field label.')
+            ),
+        ),
+    ]

src/django/api/models/extended_field.py

@@ -22,6 +22,8 @@ class ExtendedField(models.Model):
     DUNS_ID = 'duns_id'
     LEI_ID = 'lei_id'
     RBA_ID = 'rba_id'
+    ESTIMATED_EMISSIONS_ACTIVITY = 'estimated_emissions_activity'
+    ESTIMATED_ANNUAL_ENERGY_CONSUMPTION = 'estimated_annual_energy_consumption'
 
     FIELD_CHOICES = (
         (NAME, NAME),
@@ -36,6 +38,14 @@ class ExtendedField(models.Model):
         (DUNS_ID, DUNS_ID),
         (LEI_ID, LEI_ID),
         (RBA_ID, RBA_ID),
+        (
+            ESTIMATED_EMISSIONS_ACTIVITY,
+            ESTIMATED_EMISSIONS_ACTIVITY
+        ),
+        (
+            ESTIMATED_ANNUAL_ENERGY_CONSUMPTION,
+            ESTIMATED_ANNUAL_ENERGY_CONSUMPTION
+        )
     )
 
     uuid = models.UUIDField(

src/django/api/models/partner_field.py

@@ -42,6 +42,10 @@ class Meta:
         max_length=200,
         blank=True,
         help_text=('The partner field unit.'))
+    label = models.CharField(
+        max_length=200,
+        blank=True,
+        help_text=('The partner field label.'))
 
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)

src/django/api/moderation_event_actions/approval/event_approval_template.py

@@ -12,6 +12,7 @@
 )
 from api.extended_fields import (
     create_extendedfields_for_single_item,
+    create_partner_extendedfields_for_single_item,
     update_extendedfields_for_list_item,
 )
 from api.models.contributor.contributor import Contributor
@@ -83,12 +84,24 @@ def process_moderation_event(self) -> FacilityListItem:
             f'created. Id: {item.id}'
         )
 
-        create_extendedfields_for_single_item(item, data["fields"])
+        create_extendedfields_for_single_item(
+            item,
+            data["fields"]
+        )
         log.info(
             f'{LOCATION_CONTRIBUTION_APPROVAL_LOG_PREFIX} Extended fields '
             'created.'
         )
 
+        create_partner_extendedfields_for_single_item(
+            item,
+            data["fields"]
+        )
+        log.info(
+            f'{LOCATION_CONTRIBUTION_APPROVAL_LOG_PREFIX} Partner extended '
+            'fields created.'
+        )
+
         self.__set_geocoded_location(item, data, self.__event)
         log.info(
             f'{LOCATION_CONTRIBUTION_APPROVAL_LOG_PREFIX} Geocoded '

src/django/api/moderation_event_actions/creation/location_contribution/processors/permission_processor.py

@@ -98,8 +98,8 @@ def __transform_type_errors(
             'errors': [
                 {
                     'field': name,
-                    'detail': f'Field {name} must be of type {expected}, '
-                    f'but received {type(value).__name__}',
+                    'detail': f'Field {name} must be a {expected}, '
+                    f'not a {type(value).__name__}.',
                 }
                 for name, expected, value in invalid_type_fields
             ],