Merge pull request #1571 from IFRCGo/develop

Optimistic Lock for DREF-s

Author: szabozoltan69

CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 1.1.458
+
+### Added
+ - Optimistic Lock for DREF-s
+ - Affected Figures on FR/Emergencies
+ - DREF historical data on admin page (even via frontend input)
+
 ## 1.1.457
 
 ### Added
@@ -2072,7 +2079,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## 0.1.20
 
-[Unreleased]: https://github.com/IFRCGo/go-api/compare/1.1.457...HEAD
+[Unreleased]: https://github.com/IFRCGo/go-api/compare/1.1.458...HEAD
+[1.1.458]: https://github.com/IFRCGo/go-api/compare/1.1.457...1.1.458
 [1.1.457]: https://github.com/IFRCGo/go-api/compare/1.1.456...1.1.457
 [1.1.456]: https://github.com/IFRCGo/go-api/compare/1.1.455...1.1.456
 [1.1.455]: https://github.com/IFRCGo/go-api/compare/1.1.454...1.1.455

api/drf_views.py

@@ -446,6 +446,19 @@ def retrieve(self, request, pk=None, *args, **kwargs):
             raise BadRequest('Emergency ID or Slug parameters are missing')
 
         serializer = self.get_serializer(instance)
+
+        # Hide the "affected" values that are kept only for history – see (¤) in other code parts
+        if 'field_reports' in serializer.data:
+            for j, fr in enumerate(serializer.data['field_reports']):
+                if 'recent_affected' in fr:  # should always be True
+                    for i, field in enumerate([
+                        'num_affected',             'gov_num_affected',             'other_num_affected',
+                        'num_potentially_affected', 'gov_num_potentially_affected', 'other_num_potentially_affected']):
+                        if fr['recent_affected'] - 1 != i and field in serializer.data['field_reports'][j]:
+                            del serializer.data['field_reports'][j][field]
+                    del serializer.data['field_reports'][j]['recent_affected']
+
+
         return Response(serializer.data)
 
     @action(methods=['get'], detail=False, url_path='mini')
@@ -722,7 +735,7 @@ def serialize(self, data, instance=None):
         else:
             data['visibility'] = VisibilityChoices.MEMBERSHIP
 
-        # Set RecentAffected according to the sent _affected key
+        # Set RecentAffected according to the sent _affected key – see (¤) in other code parts
         if 'status' in data and data['status'] == FieldReport.Status.EW:  # Early Warning
             if 'num_potentially_affected' in data:
                 data['recent_affected'] = FieldReport.RecentAffected.RCRC_POTENTIALLY

api/models.py

@@ -1165,7 +1165,7 @@ class RecentAffected(models.IntegerChoices):
         RCRC_POTENTIALLY = 4, _('Red Cross / Red Crescent, potentially')
         GOVERNMENT_POTENTIALLY = 5, _('Government, potentially')
         OTHER_POTENTIALLY = 6, _('Other, potentially')
-        # Take care, these values are connected to (¤) in serializers.py, search it!
+        # Take care of these values – see (¤) in other code parts
 
     user = models.ForeignKey(
         settings.AUTH_USER_MODEL, verbose_name=_('user'), related_name='user',

api/serializers.py

@@ -451,7 +451,7 @@ class Meta:
             'other_affected_pop_centres', 'epi_cases', 'epi_suspected_cases', 'epi_probable_cases', 'epi_confirmed_cases',
             'epi_figures_source', 'epi_figures_source_display', 'epi_cases_since_last_fr', 'epi_deaths_since_last_fr',
             'epi_notes_since_last_fr', 'visibility', 'visibility_display', 'request_assistance', 'ns_request_assistance',
-            'notes_health', 'notes_ns', 'notes_socioeco'
+            'notes_health', 'notes_ns', 'notes_socioeco', 'recent_affected'
         )
 
 
@@ -1067,7 +1067,7 @@ def __init__(self, *args, **kwargs):
             'num_affected',             'gov_num_affected',             'other_num_affected',
             'num_potentially_affected', 'gov_num_potentially_affected', 'other_num_potentially_affected']):
             # We allow only 1 of these _affected values ^, pointed by RecentAffected. The other 5 gets 0 on client side.
-            # Attention! This indexing is related to RecentAffected values – in models.py: (¤)
+            # About "recent_affected - 1" as index see (¤) in other code parts:
             if self.instance.recent_affected - 1 != i:
                 self.fields.pop(field)
 

deployments/snapshots/snap_tests.py

@@ -873,7 +873,7 @@
                 'is_deprecated': False,
                 'iso': 'HA',
                 'iso3': 'xcS',
-                'name': 'country-jYLXlNQGqkURvDMLeoyyigbmHGRAjMglENMcYIGWhfEQiMIaXR',
+                'name': 'country-AMjYLXlNQGqkURvDMLeoyyigbmHGRAjMglENMcYIGWhfEQiMIa',
                 'record_type': 4,
                 'record_type_display': 'Country Office',
                 'region': 3,

dref/admin.py

@@ -1,4 +1,5 @@
 from django.contrib import admin
+from reversion_compare.admin import CompareVersionAdmin
 
 from lang.admin import TranslationAdmin
 from .models import (
@@ -15,7 +16,7 @@ class DrefFileAdmin(admin.ModelAdmin):
 
 
 @admin.register(Dref)
-class DrefAdmin(TranslationAdmin, admin.ModelAdmin):
+class DrefAdmin(CompareVersionAdmin, TranslationAdmin, admin.ModelAdmin):
     search_fields = ('title',)
     list_display = ('title', 'national_society', 'disaster_type',
                     'ns_request_date', 'submission_to_geneva', 'status',)
@@ -39,7 +40,7 @@ def get_queryset(self, request):
 
 
 @admin.register(DrefOperationalUpdate)
-class DrefOperationalUpdateAdmin(admin.ModelAdmin):
+class DrefOperationalUpdateAdmin(CompareVersionAdmin, admin.ModelAdmin):
     list_display = ('title', 'national_society', 'disaster_type')
     autocomplete_fields = (
         'national_society',
@@ -62,7 +63,7 @@ def get_queryset(self, request):
         )
 
 @admin.register(DrefFinalReport)
-class DrefFinalReportAdmin(admin.ModelAdmin):
+class DrefFinalReportAdmin(CompareVersionAdmin, admin.ModelAdmin):
     list_display = ('title', 'national_society', 'disaster_type')
     autocomplete_fields = (
         'national_society',

dref/migrations/0044_alter_dref_modified_at.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.2.16 on 2022-10-18 07:32
+
+import datetime
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('dref', '0043_delete_dreffileupload'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='dref',
+            name='modified_at',
+            field=models.DateTimeField(blank=True, default=datetime.datetime.now, verbose_name='modified at'),
+        ),
+    ]

dref/migrations/0045_alter_dref_modified_at.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.16 on 2022-10-24 06:41
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('dref', '0044_alter_dref_modified_at'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='dref',
+            name='modified_at',
+            field=models.DateTimeField(auto_now=True, verbose_name='modified at'),
+        ),
+    ]

dref/models.py

@@ -1,6 +1,7 @@
 import reversion
 import os
 import copy
+from datetime import datetime
 
 from pdf2image import convert_from_bytes
 
@@ -227,7 +228,11 @@ class Status(models.IntegerChoices):
         COMPLETED = 1, _('Completed')
 
     created_at = models.DateTimeField(verbose_name=_('created at'), auto_now_add=True)
-    modified_at = models.DateTimeField(verbose_name=_('modified at'), auto_now=True)
+    modified_at = models.DateTimeField(
+        verbose_name=_('modified at'),
+        auto_now=True,
+        blank=True
+    )
     created_by = models.ForeignKey(
         settings.AUTH_USER_MODEL, verbose_name=_('created by'), on_delete=models.SET_NULL,
         null=True, related_name='created_by_dref'
@@ -653,6 +658,9 @@ def save(self, *args, **kwargs):
         self.__budget_file_id = self.budget_file_id
         super().save(*args, **kwargs)
 
+    def __str__(self):
+        return f'{self.title} – {self.created_at.date()}, {self.get_status_display()}'
+
 
 class DrefFile(models.Model):
     file = models.FileField(

dref/serializers.py

@@ -184,6 +184,7 @@ class DrefSerializer(
     ALLOWED_ASSESSMENT_REPORT_EXTENSIONS = ["pdf", "docx", "pptx"]
     MAX_OPERATION_TIMEFRAME = 30
     ASSESSMENT_REPORT_MAX_OPERATION_TIMEFRAME = 2
+    DREF_UPDATE_ERROR_MESSAGE = "OBSOLETE_PAYLOAD"
     national_society_actions = NationalSocietyActionSerializer(many=True, required=False)
     needs_identified = IdentifiedNeedSerializer(many=True, required=False)
     planned_interventions = PlannedInterventionSerializer(many=True, required=False)
@@ -206,6 +207,7 @@ class DrefSerializer(
     assessment_report_details = DrefFileSerializer(source='assessment_report', read_only=True)
     supporting_document_details = DrefFileSerializer(read_only=True, source='supporting_document')
     risk_security = RiskSecuritySerializer(many=True, required=False)
+    modified_at = serializers.DateTimeField(required=False)
 
     class Meta:
         model = Dref
@@ -349,6 +351,9 @@ def create(self, validated_data):
     def update(self, instance, validated_data):
         validated_data['modified_by'] = self.context['request'].user
         is_assessment_report = validated_data.get('is_assessment_report')
+        modified_at = validated_data.pop('modified_at', None)
+        if modified_at is None:
+            raise serializers.ValidationError({ 'modified_at': 'Modified At is required!' })
         if is_assessment_report:
             # Previous Operations
             validated_data['lessons_learned'] = None
@@ -374,12 +379,15 @@ def update(self, instance, validated_data):
             dref_assessment_report = super().update(instance, validated_data)
             dref_assessment_report.needs_identified.clear()
             return dref_assessment_report
+
         # we don't send notification again to the already notified users:
         if 'users' in validated_data:
             to = {u.email for u in validated_data['users']
                   if u.email not in {t.email for t in instance.users.iterator()}}
         else:
             to = None
+        if modified_at and instance.modified_at and modified_at < instance.modified_at:
+            raise serializers.ValidationError({ 'modified_at': self.DREF_UPDATE_ERROR_MESSAGE })
         dref = super().update(instance, validated_data)
         if to:
             transaction.on_commit(