Merge pull request #3845 from bcgov/338-2-internal-earned-credit-email

338 2 internal earned credit email

Author: BCerki

bc_obps/common/migrations/0084_notice_of_credits_requested_notification_email_template.py

@@ -0,0 +1,48 @@
+# Generated by Django 5.1.10 on 2025-09-18 21:57
+
+from django.db import migrations
+
+
+def create_credits_requested_email_template(apps, schema_editor):
+    EmailNotificationTemplate = apps.get_model('common', 'EmailNotificationTemplate')
+    EmailNotificationTemplate.objects.create(
+        name='Notice of Credits Requested',
+        subject='BCIERS Notification – Earned Credits Requested ',
+        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>Hi there,</p>
+            <br>
+            <p><b>{{operator_legal_name}}</b> has requested issuance of earned credits on behalf of <b>{{operation_name}}</b>. Please log-in to <a href="https://industrialemissions.gov.bc.ca/onboarding">BCIERS</a> to see the details of this request.
+            <br>
+            </p>
+            <p><em>Please do not reply to this email. This email is auto-generated and sent from an unmonitored address.</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_credits_requested_email_template(apps, schema_editor):
+    EmailNotificationTemplate = apps.get_model('common', 'EmailNotificationTemplate')
+    EmailNotificationTemplate.objects.filter(name='Notice of Credits Requested').delete()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('common', '0083_update_dashboard_data'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            create_credits_requested_email_template,
+            reverse_credits_requested_email_template,
+            elidable=True,
+        )
+    ]

bc_obps/compliance/emails.py

@@ -4,7 +4,7 @@
 from registration.models.operator import Operator
 from registration.models.user_operator import UserOperator
 from reporting.models.report import Report
-from service.email.email_service import EmailService
+from service.email.email_service import GHG_REGULATOR_EMAIL, EmailService
 from service.email.utils import Recipient
 import logging
 from django.conf import settings
@@ -17,6 +17,28 @@
 email_service = EmailService()
 
 
+def _send_email_or_raise(
+    template: EmailNotificationTemplate, email_context: Dict[str, object], recipient_emails: List[str]
+) -> None:
+    try:
+
+        response_json = email_service.send_email_by_template(template, email_context, recipient_emails)
+        # Create an email notification record to store transaction and message IDs
+        if response_json:
+            email_service.create_email_notification_record(
+                response_json['txId'],
+                response_json['messages'][0]['msgId'],
+                recipient_emails,
+                template.pk,
+            )
+    except Exception as exc:
+        logger.error(f'Exception sending {template} email to recipients - {str(exc)}')
+        # If we're in the local environment, we don't need to send emails, so we shouldn't raise an error if they fail
+        environment = settings.ENVIRONMENT
+        if environment != 'local':
+            raise  # raise exception because we want to use this function as a retryable task
+
+
 def _send_email_to_operators_approved_users_or_raise(
     operator: Operator, template: EmailNotificationTemplate, email_context: Dict[str, object]
 ) -> None:
@@ -30,24 +52,8 @@ def _send_email_to_operators_approved_users_or_raise(
         )
 
     if recipients:
-        try:
-            recipient_emails = [recipient.email_address for recipient in recipients]
-
-            response_json = email_service.send_email_by_template(template, email_context, recipient_emails)
-            # Create an email notification record to store transaction and message IDs
-            if response_json:
-                email_service.create_email_notification_record(
-                    response_json['txId'],
-                    response_json['messages'][0]['msgId'],
-                    recipient_emails,
-                    template.pk,
-                )
-        except Exception as exc:
-            logger.error(f'Exception sending {template} email to recipients - {str(exc)}')
-            # If we're in the local environment, we don't need to send emails, so we shouldn't raise an error if they fail
-            environment = settings.ENVIRONMENT
-            if environment != 'local':
-                raise  # raise exception because we want to use this function as a retryable task
+        recipient_emails = [recipient.email_address for recipient in recipients]
+        _send_email_or_raise(template, email_context, recipient_emails)
 
 
 def send_notice_of_earned_credits_generated_email(compliance_earned_credit_id: int) -> None:
@@ -107,3 +113,26 @@ def send_notice_of_obligation_generated_email(report_id: int) -> None:
     }
 
     _send_email_to_operators_approved_users_or_raise(report.operator, template, email_context)
+
+
+def send_notice_of_credits_requested_generated_email(compliance_earned_credit_id: int) -> None:
+    """
+    Sends an email to ghg regulator, notifying that an operation has requested earned credits. We only send this email when in prod so we don't confuse internal users.
+
+     Args:
+        compliance_earned_credit_id: The ID of the ComplianceEarnedCredit instance for which to send notification emails.
+    """
+    if settings.ENVIRONMENT != 'prod':
+        return
+    earned_credit = ComplianceEarnedCredit.objects.get(id=compliance_earned_credit_id)
+    report = earned_credit.compliance_report_version.compliance_report.report
+    template = EmailNotificationTemplateService.get_template_by_name('Notice of Credits Requested')
+
+    email_context: Dict[str, object] = {
+        "operator_legal_name": report.operator.legal_name,
+        "operation_name": report.operation.name,
+    }
+
+    recipient_emails = [GHG_REGULATOR_EMAIL]
+
+    _send_email_or_raise(template, email_context, recipient_emails)

bc_obps/compliance/service/earned_credits_service.py

@@ -5,7 +5,10 @@
 from common.exceptions import UserError
 from compliance.service.bc_carbon_registry.project_service import BCCarbonRegistryProjectService
 from compliance.service.bc_carbon_registry.credit_issuance_service import BCCarbonRegistryCreditIssuanceService
-from compliance.tasks import retryable_send_notice_of_earned_credits_email
+from compliance.tasks import (
+    retryable_send_notice_of_earned_credits_email,
+    retryable_send_notice_of_credits_requested_email,
+)
 from registration.models.user import User
 
 
@@ -216,6 +219,6 @@ def update_earned_credit(
             cls._handle_cas_director_update(earned_credit, update_payload)
         else:
             raise UserError("This user is not authorized to update earned credit")
-
         earned_credit.refresh_from_db()
+        retryable_send_notice_of_credits_requested_email.execute(earned_credit.id)
         return earned_credit

bc_obps/compliance/tasks.py

@@ -2,6 +2,7 @@
 from compliance.service.elicensing.elicensing_obligation_service import ElicensingObligationService
 from compliance.service.automated_process.automated_process_service import AutomatedProcessService
 from compliance.emails import (
+    send_notice_of_credits_requested_generated_email,
     send_notice_of_earned_credits_generated_email,
     send_notice_of_no_obligation_no_credits_generated_email,
     send_notice_of_obligation_generated_email,
@@ -45,6 +46,12 @@
     max_retries=5,
     retry_delay_minutes=10,
 )
+retryable_send_notice_of_credits_requested_email = create_retryable(
+    func=send_notice_of_credits_requested_generated_email,
+    tag="credits_requested_email_notifications",
+    max_retries=5,
+    retry_delay_minutes=10,
+)
 
 ###################
 # Scheduled tasks #

bc_obps/compliance/tests/service/test_compliance_earned_credits_service.py

@@ -57,7 +57,8 @@ def test_create_earned_credits_record(self, mock_send_email):
         assert result.earned_credits_amount == 100
         mock_send_email.execute.assert_called_once_with(result.pk)
 
-    def test_update_earned_credit_industry_user_success(self):
+    @patch('compliance.service.earned_credits_service.retryable_send_notice_of_credits_requested_email')
+    def test_update_earned_credit_industry_user_success(self, mock_send_email):
         # Arrange
         earned_credit = self.earned_credit_no_bccr_fields
         earned_credit.issuance_status = ComplianceEarnedCredit.IssuanceStatus.CREDITS_NOT_ISSUED
@@ -76,6 +77,7 @@ def test_update_earned_credit_industry_user_success(self):
         assert earned_credit.bccr_holding_account_id == self.bccr_holding_account_id
         assert earned_credit.issuance_status == ComplianceEarnedCredit.IssuanceStatus.ISSUANCE_REQUESTED
         assert result == earned_credit
+        mock_send_email.execute.assert_called_once_with(result.pk)
 
     def test_update_earned_credit_industry_user_invalid_status(self):
         # Arrange

bc_obps/compliance/tests/test_emails.py

@@ -9,7 +9,9 @@
 from service.data_access_service.email_template_service import EmailNotificationTemplateService
 from model_bakery import baker
 from compliance.emails import (
+    _send_email_or_raise,
     _send_email_to_operators_approved_users_or_raise,
+    send_notice_of_credits_requested_generated_email,
     send_notice_of_earned_credits_generated_email,
     send_notice_of_no_obligation_no_credits_generated_email,
     send_notice_of_obligation_generated_email,
@@ -18,6 +20,7 @@
 pytestmark = pytest.mark.django_db
 email_service = EmailService()
 SEND_EMAIL_TO_OPERATORS_USERS_PATH = 'compliance.emails._send_email_to_operators_approved_users_or_raise'
+SEND_EMAIL_OR_RAISE_PATH = 'compliance.emails._send_email_or_raise'
 
 
 def mock_email_service(mocker):
@@ -29,6 +32,48 @@ def mock_email_service(mocker):
 
 
 class TestComplianceEmailHelpers:
+    def test_send_email_or_raise_success(self, mocker):
+        mocked_send_email = mock_email_service(mocker)
+        template_instance = EmailNotificationTemplateService.get_template_by_name('Notice of Earned Credits Generated')
+        recipients = ['email@email.com', 'email2@email.com']
+        context = {"foo": "bar"}
+        _send_email_or_raise(template_instance, context, recipients)
+        # Assert that send_email_by_template is called exactly once
+        mocked_send_email.assert_called_once_with(
+            template_instance,
+            context,
+            recipients,
+        )
+
+        # Assert that only one email notification record is created
+        assert EmailNotification.objects.filter(template=template_instance).count() == 1
+
+        # Get the created email notification record
+        email_notification = EmailNotification.objects.get(template=template_instance)
+
+        # Assert the notification record has the correct recipients
+        assert set(email_notification.recipients_email) == set(recipients)
+
+        # Assert the notification record has the correct template
+        assert email_notification.template == template_instance
+
+        # Assert that the notification record has transaction and message IDs
+        assert email_notification.transaction_id is not None
+        assert email_notification.message_id is not None
+
+        # Assert that all expected recipients are included in the single email
+        assert len(email_notification.recipients_email) == 2
+
+    def test_send_email_or_raise_fail(self, mocker):
+
+        template_instance = EmailNotificationTemplateService.get_template_by_name('Notice of Earned Credits Generated')
+        mocked_send_email = mock_email_service(mocker)
+
+        mocked_send_email.side_effect = Exception("Whoops")
+        with patch('django.conf.settings.ENVIRONMENT', 'test'):
+            with pytest.raises(Exception, match="Whoops"):
+                _send_email_or_raise(template_instance, {"foo": "bar"}, ['email@email.com'])
+
     def test_send_email_to_operators_approved_users_or_raise_success(self, mocker):
         # admin user - should receive email
         approved_user_operator = baker.make_recipe(
@@ -226,3 +271,34 @@ def test_obligation_email(self, mock_send_email_to_operators_approved_users_or_r
             template_instance,
             expected_context,
         )
+
+    @patch(SEND_EMAIL_OR_RAISE_PATH)
+    def test_credits_requested_email(
+        self,
+        mock_send_email_or_raise,
+        settings,
+    ):
+        settings.ENVIRONMENT = 'prod'
+        # Create a report with earned credits
+        report = baker.make_recipe('reporting.tests.utils.report')
+        compliance_report = baker.make_recipe('compliance.tests.utils.compliance_report', report=report)
+        compliance_report_version = baker.make_recipe(
+            'compliance.tests.utils.compliance_report_version', compliance_report=compliance_report
+        )
+        earned_credit = baker.make_recipe(
+            'compliance.tests.utils.compliance_earned_credit',
+            compliance_report_version=compliance_report_version,
+            earned_credits_amount=100,
+        )
+
+        template_instance = EmailNotificationTemplateService.get_template_by_name('Notice of Credits Requested')
+        expected_context = {
+            "operator_legal_name": report.operator.legal_name,
+            "operation_name": report.operation.name,
+        }
+
+        # Call the function with the earned credit id
+        send_notice_of_credits_requested_generated_email(earned_credit.id)
+        mock_send_email_or_raise.assert_called_once_with(
+            template_instance, expected_context, ['GHGRegulator@gov.bc.ca']
+        )