Merge pull request #243 from edubadges/feature/improve-performance-of-direct-award-audit-trail-endpoint

Iso5786 · web-flow · commit 489d8932f4ae · 2026-01-20T12:02:41.000+01:00
Feature/improve performance of direct award audit trail endpoint
diff --git a/apps/directaward/api.py b/apps/directaward/api.py
@@ -4,6 +4,7 @@
 from drf_spectacular.utils import extend_schema, inline_serializer, OpenApiExample, OpenApiResponse, OpenApiParameter
 from rest_framework import serializers
 from rest_framework import status
+from rest_framework.generics import ListAPIView
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
@@ -680,8 +681,9 @@ def put(self, request, **kwargs):
         )
 
 
-class DirectAwardAuditTrailView(APIView):
+class DirectAwardAuditTrailListView(ListAPIView):
     permission_classes = (IsSuperUser,)
+    serializer_class = DirectAwardAuditTrailSerializer
 
     @extend_schema(
         description='Get all direct award audit trail entries (superuser only)',
@@ -708,7 +710,18 @@ class DirectAwardAuditTrailView(APIView):
             403: permission_denied_response,
         },
     )
-    def get(self, request, *args, **kwargs):
-        audit_trails = DirectAwardAuditTrail.objects.filter(action='CREATE').order_by('-action_datetime')
-        serializer = DirectAwardAuditTrailSerializer(audit_trails, many=True)
-        return Response(serializer.data, status=status.HTTP_200_OK)
+
+    def get_queryset(self):
+        return (
+            DirectAwardAuditTrail.objects
+            .filter(
+                action='CREATE',
+                direct_award__isnull=False,
+            )
+            .select_related(
+                'direct_award',
+                'badgeclass',
+                'badgeclass__institution',
+            )
+            .order_by('-action_datetime')
+        )
diff --git a/apps/directaward/api_urls.py b/apps/directaward/api_urls.py
@@ -7,7 +7,7 @@
     DirectAwardRevoke,
     DirectAwardDelete,
     DirectAwardBundleView,
-    DirectAwardAuditTrailView,
+    DirectAwardAuditTrailListView,
 )
 
 urlpatterns = [
@@ -16,5 +16,5 @@
     path('accept/<str:entity_id>', DirectAwardAccept.as_view(), name='direct_award_accept'),
     path('revoke-direct-awards', DirectAwardRevoke.as_view(), name='direct_award_revoke'),
     path('delete-direct-awards', DirectAwardDelete.as_view(), name='direct_award_delete'),
-    path('audittrail', DirectAwardAuditTrailView.as_view(), name='direct_award_audittrail'),
+    path('audittrail', DirectAwardAuditTrailListView.as_view(), name='direct_award_audittrail'),
 ]
diff --git a/apps/directaward/migrations/0024_directawardaudittrail_refactor_badgeclass_and_directaward_relations_and_populate.py b/apps/directaward/migrations/0024_directawardaudittrail_refactor_badgeclass_and_directaward_relations_and_populate.py
@@ -0,0 +1,85 @@
+# Generated by Django 4.2.27 on 2026-01-19 11:57
+
+from django.db import migrations, models
+
+
+def forwards_populate_audit_trail_fks(apps, schema_editor):
+    DirectAwardAuditTrail = apps.get_model('directaward', 'DirectAwardAuditTrail')
+    DirectAward = apps.get_model('directaward', 'DirectAward')
+    BadgeClass = apps.get_model('issuer', 'BadgeClass')
+
+    for audit in DirectAwardAuditTrail.objects.all().iterator():
+        if audit.direct_award_entity_id and not audit.direct_award:
+            audit.direct_award = (
+                DirectAward.objects
+                .filter(entity_id=audit.direct_award_entity_id)
+                .first()
+            )
+
+        if audit.badgeclass_entity_id and not audit.badgeclass:
+            audit.badgeclass = (
+                BadgeClass.objects
+                .filter(entity_id=audit.badgeclass_entity_id)
+                .first()
+            )
+
+        audit.save(update_fields=['direct_award', 'badgeclass'])
+
+
+def backwards_restore_entity_ids(apps, schema_editor):
+    DirectAwardAuditTrail = apps.get_model('directaward', 'DirectAwardAuditTrail')
+
+    for audit in DirectAwardAuditTrail.objects.all().iterator():
+        if audit.direct_award and not audit.direct_award_entity_id:
+            audit.direct_award_entity_id = audit.direct_award.entity_id
+
+        if audit.badgeclass and not audit.badgeclass_entity_id:
+            audit.badgeclass_entity_id = audit.badgeclass.entity_id
+
+        audit.save(update_fields=[
+            'direct_award_entity_id',
+            'badgeclass_entity_id',
+        ])
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('directaward', '0023_directawardbundle_direct_award_removed_count'),
+        ('issuer',
+         '0117_rename_badgeinstance_recipient_identifier_badgeclass_revoked_issuer_badg_recipie_6a2cd8_idx_and_more'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='directawardaudittrail',
+            old_name='badgeclass_id',
+            new_name='badgeclass_entity_id',
+        ),
+        migrations.RenameField(
+            model_name='directawardaudittrail',
+            old_name='direct_award_id',
+            new_name='direct_award_entity_id',
+        ),
+        migrations.AddField(
+            model_name='directawardaudittrail',
+            name='badgeclass',
+            field=models.ForeignKey(blank=True, null=True, on_delete=models.deletion.SET_NULL, to='issuer.badgeclass'),
+        ),
+        migrations.AddField(
+            model_name='directawardaudittrail',
+            name='direct_award',
+            field=models.ForeignKey(blank=True, null=True, on_delete=models.deletion.SET_NULL, to='directaward.directaward'),
+        ),
+        migrations.RunPython(
+            forwards_populate_audit_trail_fks,
+            backwards_restore_entity_ids,
+        ),
+        migrations.RemoveField(
+            model_name='directawardaudittrail',
+            name='badgeclass_entity_id',
+        ),
+        migrations.RemoveField(
+            model_name='directawardaudittrail',
+            name='direct_award_entity_id',
+        ),
+    ]
diff --git a/apps/directaward/models.py b/apps/directaward/models.py
@@ -263,5 +263,5 @@ class DirectAwardAuditTrail(models.Model):
     user_agent_info = models.CharField(max_length=255, blank=True)
     action = models.CharField(max_length=40)
     change_summary = models.CharField(max_length=199, blank=True)
-    direct_award_id = models.CharField(max_length=255, blank=True)
-    badgeclass_id = models.CharField(max_length=255, blank=True)
+    direct_award = models.ForeignKey('directaward.DirectAward', on_delete=models.SET_NULL, null=True, blank=True)
+    badgeclass = models.ForeignKey('issuer.BadgeClass', on_delete=models.SET_NULL, null=True, blank=True)
diff --git a/apps/directaward/serializer.py b/apps/directaward/serializer.py
@@ -168,10 +168,22 @@ def to_representation(self, instance):
 
 
 class DirectAwardAuditTrailSerializer(serializers.ModelSerializer):
-    badgeclass_name = serializers.SerializerMethodField()
-    institution_name = serializers.SerializerMethodField()
-    recipient_email = serializers.SerializerMethodField()
-    recipient_eppn = serializers.SerializerMethodField()
+    badgeclass_name = serializers.CharField(
+        source='badgeclass.name',
+        read_only=True,
+    )
+    institution_name = serializers.CharField(
+        source='badgeclass.institution.name',
+        read_only=True,
+    )
+    recipient_email = serializers.EmailField(
+        source='direct_award.recipient_email',
+        read_only=True
+    )
+    recipient_eppn = serializers.CharField(
+        source='direct_award.eppn',
+        read_only=True
+    )
 
     class Meta:
         model = DirectAwardAuditTrail
@@ -183,46 +195,3 @@ class Meta:
             'recipient_email',
             'recipient_eppn',
         ]
-
-    def get_badgeclass_name(self, obj):
-        """Get the badge class name from the badgeclass_id"""
-        if obj.badgeclass_id:
-            try:
-                badgeclass = BadgeClass.objects.get(id=obj.badgeclass_id)
-                return badgeclass.name
-            except BadgeClass.DoesNotExist:
-                return None
-        return None
-
-    def get_institution_name(self, obj):
-        """Get the institution name from the badgeclass"""
-        if obj.badgeclass_id:
-            try:
-                badgeclass = BadgeClass.objects.get(id=obj.badgeclass_id)
-                institution = badgeclass.institution
-                return institution.name if institution else None
-            except BadgeClass.DoesNotExist:
-                return None
-        return None
-
-    def get_recipient_email(self, obj):
-        """Get the recipient email from the direct award"""
-        if obj.badgeclass_id:
-            try:
-                directaward = DirectAward.objects.get(entity_id=obj.direct_award_id)
-                recipient_email = directaward.recipient_email
-                return recipient_email if directaward else None
-            except DirectAward.DoesNotExist:
-                return None
-        return None
-
-    def get_recipient_eppn(self, obj):
-        """Get the recipient eppn from the direct award"""
-        if obj.badgeclass_id:
-            try:
-                directaward = DirectAward.objects.get(entity_id=obj.direct_award_id)
-                eppn = directaward.eppn
-                return eppn if eppn else ''
-            except DirectAward.DoesNotExist:
-                return None
-        return None
diff --git a/apps/directaward/signals.py b/apps/directaward/signals.py
@@ -4,6 +4,8 @@
 from django.dispatch import receiver
 
 from .models import DirectAwardAuditTrail
+from directaward.models import DirectAward
+from issuer.models import BadgeClass
 
 # Signals doc: https://docs.djangoproject.com/en/4.2/topics/signals/
 audit_trail_signal = django.dispatch.Signal()  # creates a custom signal and specifies the args required.
@@ -25,17 +27,25 @@ def get_client_ip(request):
 def direct_award_audit_trail(sender, user, request, direct_award_id, badgeclass_id, method, summary, **kwargs):
     try:
         user_agent_info = (request.headers.get('user-agent', '<unknown>')[:255],)
+
+        direct_award = None
+        badgeclass = None
+        if direct_award_id:
+            direct_award = DirectAward.objects.filter(entity_id=direct_award_id).first()
+        if badgeclass_id:
+            badgeclass = BadgeClass.objects.filter(entity_id=badgeclass_id).first()
+
         audit_trail = DirectAwardAuditTrail.objects.create(
             user=user,
             user_agent_info=user_agent_info,
             login_IP=get_client_ip(request),
             action=method,
             change_summary=summary,
-            direct_award_id=direct_award_id,
-            badgeclass_id=badgeclass_id,
+            direct_award=direct_award,
+            badgeclass=badgeclass,
         )
         logger.info(
-            f'direct_award_audit_trail created {audit_trail.id}  for user {audit_trail.user} and directaward {audit_trail.direct_award_id}'
+            f'direct_award_audit_trail created {audit_trail.id}  for user {audit_trail.user} and directaward {direct_award_id}'
         )
     except Exception as e:
         logger.error('direct_award_audit_trail request: %s, error: %s' % (request, e))

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`DirectAwardRevoke,`
`8`	`8`	`DirectAwardDelete,`
`9`	`9`	`DirectAwardBundleView,`
`10`		`- DirectAwardAuditTrailView,`
	`10`	`+ DirectAwardAuditTrailListView,`
`11`	`11`	`)`
`12`	`12`
`13`	`13`	`urlpatterns = [`
`@@ -16,5 +16,5 @@`
`16`	`16`	`path('accept/<str:entity_id>', DirectAwardAccept.as_view(), name='direct_award_accept'),`
`17`	`17`	`path('revoke-direct-awards', DirectAwardRevoke.as_view(), name='direct_award_revoke'),`
`18`	`18`	`path('delete-direct-awards', DirectAwardDelete.as_view(), name='direct_award_delete'),`
`19`		`- path('audittrail', DirectAwardAuditTrailView.as_view(), name='direct_award_audittrail'),`
	`19`	`+ path('audittrail', DirectAwardAuditTrailListView.as_view(), name='direct_award_audittrail'),`
`20`	`20`	`]`