Merge pull request #3984 from bcgov/372-supp-report-increases-emissions-past-deadline

Compliance/Automatic Emails - Supplementary Report Submitted after Deadline with increased emissions #372

Author: BCerki

bc_obps/common/migrations/0097_supplementary_report_submitted_after_deadline_template_template.py

@@ -0,0 +1,59 @@
+# Generated by Django 5.1.10 on 2025-10-07 21:57
+
+from django.db import migrations
+
+
+def supplementary_report_submitted_after_deadline_template(apps, schema_editor):
+    EmailNotificationTemplate = apps.get_model('common', 'EmailNotificationTemplate')
+    EmailNotificationTemplate.objects.create(
+        name='Supplementary Report Submitted after Deadline',
+        subject='BCIERS Notification – Supplementary Report Submitted after Deadline',
+        body='''
+            <p style="text-align: center;">Province of British Columbia</p>
+            <p style="text-align: center;">B.C. Industrial Emissions Reporting System (BCIERS)</p>
+            <br/>
+            <p>Dear {{operator_legal_name}},</p>
+            <br/>
+            <p>Thank you for submitting a supplementary report through the BC Industrial Emissions Reporting System (BCIERS).
+            </p>
+            <br/>
+            <p>Because your supplementary report results in an increased amount of excess emissions, <b>you must meet an additional compliance obligation</b>. Based on the information submitted in <b>{{operation_name}}</b>’s supplementary report and the applicable compliance charge rate, an additional compliance obligation for excess emissions of {{tonnes_of_co2}} at an equivalent amount of {{outstanding_balance}} is now payable.   </p>
+            <br/>
+            <p><b>Because the supplementary report was submitted after the compliance obligation deadline</b>, the additional compliance obligation is subject to interest under the Greenhouse Gas Emission Administrative Penalty and Appeals Regulation (GGEAPAR). Interest is calculated at the prime lending rate + 3%, compounded monthly from the compliance obligation deadline of November 30, {{year_due}} and applies until you resolve the overdue obligation.</p>
+            <br/><p>To review your compliance obligation and how it was calculated, please log-into BCIERS at <a
+              href="https://industrialemissions.gov.bc.ca/onboarding">https://industrialemissions.gov.bc.ca/onboarding</a>.</p><br/>
+            <p>To meet your compliance obligation:  </p>
+            <ol>
+            <li>Navigate to the Compliance module and click <em>My Compliance > Compliance Summaries</em>.</li>
+            <li>Find your operation in the grid and click <em>Manage Obligation</em>.</li>
+            </ol>
+            <p>If you do not meet the additional compliance obligation <b>within 30 days</b>, the additional obligation will be subject to daily compounding penalties, as well as interest under the <i>Financial Administration Act</i> (FAA). We strongly encourage you to make your payment on time to avoid these additional charges. Please refer to the B.C. OBPS compliance module guidance document on our website for further information. </p><br/>
+            <p><em>Please do not reply to this email. This email is auto-generated. If you have any questions, or need further assistance, please reach out to our support team at <a href="mailto:GHGRegulator@gov.bc.ca">GHGRegulator@gov.bc.ca</a></em></p>
+            <br/>
+            <p>Best Regards,</p>
+            <p>Ministry of Energy and Climate Solutions</p>
+            <p>Email: <a href="mailto:GHGRegulator@gov.bc.ca">GHGRegulator@gov.bc.ca</a></p>
+            <p>Website: <a href="https://www2.gov.bc.ca/gov/content/environment/climate-change/industry/bc-output-based-pricing-system">BC
+              Government Website Link</a>
+            </p>
+        ''',
+    )
+
+
+def reverse_supplementary_report_submitted_after_deadline_template(apps, schema_editor):
+    EmailNotificationTemplate = apps.get_model('common', 'EmailNotificationTemplate')
+    EmailNotificationTemplate.objects.filter(name='Supplementary Report Submitted after Deadline').delete()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('common', '0096_V4_4_0'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            supplementary_report_submitted_after_deadline_template,
+            reverse_supplementary_report_submitted_after_deadline_template,
+            elidable=True,
+        )
+    ]

bc_obps/compliance/emails.py

@@ -209,8 +209,8 @@ def send_notice_of_obligation_met_email(obligation_id: int) -> None:
     """
     Sends an email to every operator's industry user when their obligation is met.
 
-     Args:
-        compliance_report_version_id: The id of the compliance_report_version instance for which to send notification emails.
+    Args:
+        obligation_id: The id of the obligation instance for which to send notification emails.
     """
     obligation = ComplianceObligation.objects.get(id=obligation_id)
     template = EmailNotificationTemplateService.get_template_by_name('Notice of Obligation Met')
@@ -239,3 +239,19 @@ def send_notice_of_penalty_accrual_email(obligation_id: int) -> None:
         template,
         email_context,
     )
+
+
+def send_supplementary_report_submitted_after_deadline(obligation_id: int) -> None:
+    """
+    Sends an email to every operator's industry user when they submit a supplementary report after the deadline that increases their emissions and results in a new obligation.
+
+    Args:
+        obligation_id: The id of the obligation instance for which to send notification emails.
+    """
+    obligation = ComplianceObligation.objects.get(id=obligation_id)
+    template = EmailNotificationTemplateService.get_template_by_name('Supplementary Report Submitted after Deadline')
+    email_context = _prepare_obligation_context(obligation)
+
+    _send_email_to_operators_approved_users_or_raise(
+        obligation.compliance_report_version.compliance_report.report.operator, template, email_context
+    )

bc_obps/compliance/service/elicensing/elicensing_obligation_service.py

@@ -1,4 +1,4 @@
-from datetime import timedelta
+from datetime import timedelta, date
 import logging
 import uuid
 from typing import Dict, Any
@@ -45,6 +45,13 @@ def _is_invoice_generation_date_today(cls, compliance_period: CompliancePeriod)
         current_date = timezone.now().astimezone(vancouver_timezone).date()
         return current_date == compliance_period.invoice_generation_date
 
+    @classmethod
+    def _has_obligation_deadline_passed(cls, obligation_deadline: date) -> bool:
+        # Convert current UTC time to Vancouver timezone before extracting date to ensure proper comparison
+        vancouver_timezone = ZoneInfo("America/Vancouver")
+        current_date = timezone.now().astimezone(vancouver_timezone).date()
+        return current_date > obligation_deadline
+
     @classmethod
     def handle_obligation_integration(cls, obligation_id: int, compliance_period: CompliancePeriod) -> None:
         """
@@ -84,7 +91,10 @@ def process_obligation_integration(cls, obligation_id: int) -> None:
             requests.RequestException: If there's an API error
         """
         from compliance.service.compliance_report_version_service import ComplianceReportVersionService
-        from compliance.tasks import retryable_send_notice_of_obligation_due_email
+        from compliance.tasks import (
+            retryable_send_notice_of_obligation_due_email,
+            retryable_notice_of_supplementary_report_post_deadline_increases_emissions,
+        )
 
         obligation = ComplianceObligation.objects.get(id=obligation_id)
         try:
@@ -129,7 +139,13 @@ def process_obligation_integration(cls, obligation_id: int) -> None:
 
                 # If successful, update the compliance status
                 ComplianceReportVersionService.update_compliance_status(obligation.compliance_report_version)
-                retryable_send_notice_of_obligation_due_email.execute(obligation.id)
+                # If the new obligation was created by a supplementary report and the obligation deadline has passed, we send a specific email. Otherwise, we send the general one about the obligation being due.
+                if obligation.compliance_report_version.is_supplementary and cls._has_obligation_deadline_passed(
+                    obligation.obligation_deadline
+                ):
+                    retryable_notice_of_supplementary_report_post_deadline_increases_emissions.execute(obligation.id)
+                else:
+                    retryable_send_notice_of_obligation_due_email.execute(obligation.id)
 
         except Exception:
             obligation.compliance_report_version.status = (

bc_obps/compliance/tasks.py

@@ -11,6 +11,7 @@
     send_notice_of_penalty_accrual_email,
     send_reminder_of_obligation_due_email,
     send_notice_of_obligation_met_email,
+    send_supplementary_report_submitted_after_deadline,
 )
 from task_scheduler.service.retry_task.factories import create_retryable
 from task_scheduler.service.scheduled_task.dataclass import ScheduledTaskConfig
@@ -89,6 +90,12 @@
     retry_delay_minutes=10,
 )
 
+retryable_notice_of_supplementary_report_post_deadline_increases_emissions = create_retryable(
+    func=send_supplementary_report_submitted_after_deadline,
+    tag="past_deadline_increased_emissions_email_notifications",
+    max_retries=5,
+    retry_delay_minutes=10,
+)
 
 ###################
 # Scheduled tasks #

bc_obps/compliance/tests/service/elicensing/test_elicensing_obligation_service.py

@@ -42,6 +42,8 @@
 
 OBLIGATION_DUE_EMAIL_PATH = 'compliance.tasks.retryable_send_notice_of_obligation_due_email'
 
+PAST_DEADLINE_EMAIL_PATH = 'compliance.tasks.retryable_notice_of_supplementary_report_post_deadline_increases_emissions'
+
 SYNC_WITH_ELICENSING_PATH = (
     f"{ELICENSING_OBLIGATION_SERVICE_PATH}.ElicensingOperatorService.sync_client_with_elicensing"
 )
@@ -133,6 +135,12 @@ def mock_retryable_obligation_due_email():
         yield mock
 
 
+@pytest.fixture
+def mock_retryable_notice_of_supplementary_report_post_deadline_increases_emissions():
+    with patch(PAST_DEADLINE_EMAIL_PATH) as mock:
+        yield mock
+
+
 @pytest.fixture
 def mock_update_status():
     with patch(UPDATE_COMPLIANCE_STATUS_PATH) as mock:
@@ -257,17 +265,19 @@ def test_map_obligation_to_invoice_data(self, mock_obligation: MagicMock) -> Non
         assert result["businessAreaCode"] == "OBPS"
         assert result["fees"] == [fee_id]
 
-    def test_process_obligation_integration_success(
+    def test_process_obligation_integration_success_before_deadline(
         self,
         mock_update_status,
         mock_refresh_by_invoice,
         mock_create_invoice,
         mock_create_fees,
         mock_retryable_obligation_due_email,
+        mock_retryable_notice_of_supplementary_report_post_deadline_increases_emissions,
+        mock_timezone,
     ) -> None:
         """Test successful full obligation integration process"""
         # Setup mocks
-
+        self._set_vancouver_today(mock_timezone, date(2025, 11, 30))
         obligation = make_recipe('compliance.tests.utils.compliance_obligation')
         client_operator = make_recipe(
             'compliance.tests.utils.elicensing_client_operator',
@@ -301,6 +311,63 @@ def test_process_obligation_integration_success(
 
         mock_update_status.assert_called_once_with(obligation.compliance_report_version)
         mock_retryable_obligation_due_email.execute.assert_called_once_with(obligation.pk)
+        mock_retryable_notice_of_supplementary_report_post_deadline_increases_emissions.execute.assert_not_called()
+
+    def test_process_obligation_integration_success_after_deadline(
+        self,
+        mock_update_status,
+        mock_refresh_by_invoice,
+        mock_create_invoice,
+        mock_create_fees,
+        mock_retryable_obligation_due_email,
+        mock_retryable_notice_of_supplementary_report_post_deadline_increases_emissions,
+        mock_timezone,
+    ) -> None:
+        """Test successful full obligation integration process if a supplmentary report has been submitted after the deadline."""
+        # Setup mocks
+        self._set_vancouver_today(mock_timezone, date(2025, 12, 1))
+
+        obligation = make_recipe('compliance.tests.utils.compliance_obligation')
+        compliance_report_version = obligation.compliance_report_version
+        compliance_report_version.is_supplementary = True
+        compliance_report_version.save()
+
+        client_operator = make_recipe(
+            'compliance.tests.utils.elicensing_client_operator',
+            operator_id=obligation.compliance_report_version.compliance_report.report.operator_id,
+        )
+
+        # Setup API responses
+        mock_fee_response = FeeResponse(
+            clientObjectId=client_operator.client_object_id,
+            clientGUID=client_operator.client_guid,
+            fees=[FeeItem(feeGUID=str(uuid.uuid4()), feeObjectId="1")],
+        )
+
+        mock_create_fees.return_value = mock_fee_response
+
+        mock_invoice_response = TestInvoiceResponse(invoiceNumber='inv-001')
+        mock_create_invoice.return_value = mock_invoice_response
+
+        mock_refresh_by_invoice.return_value = None
+        mock_update_status.return_value = None
+
+        invoice = make_recipe('compliance.tests.utils.elicensing_invoice', invoice_number='inv-001')
+
+        # Call the method
+        ElicensingObligationService.process_obligation_integration(obligation.id)
+
+        obligation.refresh_from_db()
+
+        # Invoice has been assigned to obligation
+        assert obligation.elicensing_invoice_id == invoice.id
+
+        mock_update_status.assert_called_once_with(obligation.compliance_report_version)
+        # brianna
+        mock_retryable_obligation_due_email.execute.assert_not_called()
+        mock_retryable_notice_of_supplementary_report_post_deadline_increases_emissions.execute.assert_called_once_with(
+            obligation.pk
+        )
 
     def test_process_obligation_integration_failure_sets_pending_status_and_does_not_email(
         self, mock_sync_client, mock_create_fees, mock_retryable_obligation_due_email

bc_obps/compliance/tests/test_emails.py

@@ -17,6 +17,7 @@
     send_notice_of_no_obligation_no_credits_generated_email,
     send_notice_of_obligation_due_email,
     send_notice_of_obligation_generated_email,
+    send_supplementary_report_submitted_after_deadline,
     send_reminder_of_obligation_due_email,
     send_notice_of_obligation_met_email,
     send_notice_of_penalty_accrual_email,
@@ -608,3 +609,60 @@ def test_penalty_accrual_email(
         template_instance,
         expected_context,
     )
+
+    @patch(SEND_EMAIL_TO_OPERATORS_USERS_PATH)
+    @patch('compliance.emails._prepare_obligation_context')
+    def test_supplementary_report_creates_obligation_email(
+        self, mock_prepare_obligation_context, mock_send_email_to_operators_approved_users_or_raise
+    ):
+        # admin user
+        approved_user_operator = baker.make_recipe(
+            'registration.tests.utils.approved_user_operator',
+        )
+
+        # Create mock data
+        report = baker.make_recipe('reporting.tests.utils.report', operator=approved_user_operator.operator)
+        compliance_report = baker.make_recipe('compliance.tests.utils.compliance_report', report=report)
+        report_version = baker.make_recipe('reporting.tests.utils.report_version', report=report)
+        report_operation = baker.make_recipe('reporting.tests.utils.report_operation', report_version=report_version)
+        report_compliance_summary = baker.make_recipe(
+            'compliance.tests.utils.report_compliance_summary', report_version=report_version
+        )
+        compliance_report_version = baker.make_recipe(
+            'compliance.tests.utils.compliance_report_version',
+            compliance_report=compliance_report,
+            report_compliance_summary=report_compliance_summary,
+        )
+        invoice = baker.make_recipe('compliance.tests.utils.elicensing_invoice')
+        obligation = baker.make_recipe(
+            'compliance.tests.utils.compliance_obligation',
+            compliance_report_version=compliance_report_version,
+            elicensing_invoice=invoice,
+        )
+
+        template_instance = EmailNotificationTemplateService.get_template_by_name(
+            'Supplementary Report Submitted after Deadline'
+        )
+
+        report_version = obligation.compliance_report_version
+        report = report_version.compliance_report.report
+        report_operation = report_version.report_compliance_summary.report_version.report_operation
+        reporting_year = report.reporting_year.reporting_year
+        expected_context = {
+            "operator_legal_name": report_operation.operator_legal_name,
+            "operation_name": report_operation.operation_name,
+            "compliance_period": reporting_year,
+            # the following properties aren't used in the email, but we're reusing the helper function that includes them
+            "year_due": reporting_year + 1,
+            "tonnes_of_co2": '1,000.1234',
+            "outstanding_balance": '$0.00',
+        }
+        mock_prepare_obligation_context.return_value = expected_context
+
+        # Call the function with the obligcation id
+        send_supplementary_report_submitted_after_deadline(obligation.id)
+        mock_send_email_to_operators_approved_users_or_raise.assert_called_once_with(
+            approved_user_operator.operator,
+            template_instance,
+            expected_context,
+        )