Merge pull request #2934 from bcgov/feat/daniel-sync-compliance-reports

feat: Sync Reports TFRS -> LCFS

backend/api/serializers/ComplianceReport.py

@@ -42,7 +42,6 @@
     ExclusionAgreementRecord
 from api.models.Organization import Organization
 from api.permissions.ComplianceReport import ComplianceReportPermissions
-from api.serializers import CreditTradeMinSerializer
 from api.serializers.CompliancePeriod import CompliancePeriodSerializer
 from api.serializers.ComplianceReportSchedules import \
     ScheduleCDetailSerializer, ScheduleADetailSerializer, \
@@ -51,6 +50,7 @@
 from api.serializers.Organization import OrganizationMinSerializer, \
     OrganizationDisplaySerializer
 from api.serializers.constants import ComplianceReportValidation
+from api.services import TransactionMessageService
 from api.services.ComplianceReportService import ComplianceReportService
 from api.services.OrganizationService import OrganizationService
 from api.services.ComplianceReportSummaryService import ComplianceReportSummaryService
@@ -1161,6 +1161,16 @@ def create(self, validated_data):
             new_compliance_report.root_report = new_compliance_report
             new_compliance_report.latest_report = new_compliance_report
         new_compliance_report.save()
+
+        # Send a transaction message to the LCFS/TFRS message queue
+        request = self.context['request']
+        TransactionMessageService.TransactionMessageService.sync_compliance_report_to_lcfs(
+            new_compliance_report,
+            "Created",
+            request.user,
+            None
+        )
+
         return new_compliance_report
 
     def save(self, **kwargs):
@@ -1633,6 +1643,10 @@ def update(self, instance, validated_data):
                 create_timestamp=datetime.now(),
                 snapshot=snap
             )
+            # Send a transaction message to the LCFS/TFRS message queue
+            TransactionMessageService.TransactionMessageService.sync_compliance_report_to_lcfs(
+                instance, "Submitted", request.user, snap["summary"]["lines"]["25"]
+            )
 
         if previous_director_status not in ['Accepted'] and \
                 instance.status.director_status.status in ['Accepted']:
@@ -1641,9 +1655,15 @@ def update(self, instance, validated_data):
                 instance, request.user
             )
 
+            # Send a transaction message to the LCFS/TFRS message queue
+            TransactionMessageService.TransactionMessageService.sync_compliance_report_to_lcfs(
+                instance, "Approved", request.user, None
+            )
+
+
         instance.update_user = request.user
         instance.save()
-        
+
         # all other fields are read-only
         return instance
 

backend/api/services/ComplianceReportService.py

@@ -14,7 +14,6 @@
 from api.models.CreditTradeType import CreditTradeType
 from api.models.Organization import Organization
 from api.services.CreditTradeService import CreditTradeService
-from api.services.TransactionMessageService import TransactionMessageService
 
 from api.notifications.notification_types import NotificationType
 from api.async_tasks import async_send_notifications
@@ -331,13 +330,6 @@ def create_director_transactions(compliance_report, creating_user):
             compliance_report.credit_transaction = credit_transaction
             compliance_report.save()
             CreditTradeService.pvr_notification(None, credit_transaction)
-
-            # **Send a transaction message to the LCFS/TFRS message queue**
-            TransactionMessageService.send_transaction_message(
-                tfrs_id=compliance_report.id,
-                organization_id=compliance_report.organization.id,
-                compliance_units_amount=required_credit_transaction,
-            )
         else:
             if required_credit_transaction < Decimal(0):
                 if COMPLIANCE_PERIOD_2023_AND_ABOVE:
@@ -372,13 +364,6 @@ def create_director_transactions(compliance_report, creating_user):
                 compliance_report.save()
                 CreditTradeService.pvr_notification(None, credit_transaction)
 
-                # **Send a transaction message to the LCFS/TFRS message queue**
-                TransactionMessageService.send_transaction_message(
-                    tfrs_id=compliance_report.id,
-                    organization_id=compliance_report.organization.id,
-                    compliance_units_amount=required_credit_transaction,
-                )
-
     @staticmethod
     def dispatch_notifications(
             previous_status,

backend/api/services/TransactionMessageService.py

@@ -1,8 +1,12 @@
 import json
 from decimal import Decimal
+from typing import Optional
 
 import pika
 from pika.exceptions import AMQPError
+
+from api.models.ComplianceReport import ComplianceReport
+from api.models.User import User
 from tfrs.settings import AMQP_CONNECTION_PARAMETERS
 
 
@@ -14,10 +18,12 @@ class TransactionDeliveryFailure(Exception):
 
 class TransactionMessageService:
     @staticmethod
-    def send_transaction_message(
-            tfrs_id: int, organization_id: int, compliance_units_amount: Decimal
+    def sync_compliance_report_to_lcfs(
+        compliance_report: ComplianceReport,
+        action: str,
+        user: User,
+        credits: Optional[Decimal],
     ):
-
         try:
             # Use existing AMQP connection parameters from settings
             parameters = AMQP_CONNECTION_PARAMETERS
@@ -29,11 +35,17 @@ def send_transaction_message(
 
             # Create the message body
             message = {
-                "tfrs_id": tfrs_id,
-                "organization_id": organization_id,
-                "compliance_units_amount": int(compliance_units_amount.to_integral_value()),
+                "tfrs_id": compliance_report.original_report_id,
+                "organization_id": compliance_report.organization_id,
+                "compliance_period": compliance_report.compliance_period.description,
+                "nickname": compliance_report.nickname,
+                "action": action,
+                "user_id": user.id,
             }
 
+            if credits is not None:
+                message["credits"] = int(credits.to_integral_value())
+
             # Publish the message to the queue
             channel.basic_publish(
                 exchange="",