Merge pull request #4233 from bcgov/chore/966-update-product-name-and-pwaei

chore: 966 renaming product and adding pwaei

Author: pbastia

bc_obps/registration/migrations/0158_add_pulp_and_paper_product.py

@@ -1,23 +1,35 @@
 # Generated by Django 5.1.15 on 2026-02-03 21:41
 
+from decimal import Decimal
 from django.db import migrations
 
 
-def add_product(apps, schema_monitor):
+def add_product_and_pwaei(apps, schema_monitor):
     '''
     Add the new Pulp & Paper: Lime Revovery Kiln
     '''
     RegulatedProduct = apps.get_model('registration', 'RegulatedProduct')
+    ProductEmissionIntensity = apps.get_model('reporting', 'ProductEmissionIntensity')
+
     RegulatedProduct.objects.create(
-        name="Pulp and paper: lime recovery kiln",
+        name="Pulp and paper: lime recovered by kiln",
         unit="Tonnes dry recovered lime (calcium oxide)",
         is_regulated=True,
     )
+    ProductEmissionIntensity.objects.create(
+        product_id=RegulatedProduct.objects.get(name="Pulp and paper: lime recovered by kiln").id,
+        product_weighted_average_emission_intensity=Decimal("0.3822"),
+        valid_from='2023-01-01',
+        valid_to='9999-12-31',
+    )
 
 
-def reverse_add_product(apps, schema_monitor):
+def reverse_add_product_and_pwaei(apps, schema_monitor):
     RegulatedProduct = apps.get_model('registration', 'RegulatedProduct')
-    RegulatedProduct.objects.filter(name="Pulp and paper: lime recovery kiln").delete()
+    ProductEmissionIntensity = apps.get_model('reporting', 'ProductEmissionIntensity')
+
+    ProductEmissionIntensity.objects.filter(product__name="Pulp and paper: lime recovered by kiln").delete()
+    RegulatedProduct.objects.filter(name="Pulp and paper: lime recovered by kiln").delete()
 
 
 class Migration(migrations.Migration):
@@ -27,5 +39,5 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.RunPython(add_product, reverse_add_product),
+        migrations.RunPython(add_product_and_pwaei, reverse_add_product_and_pwaei),
     ]

bc_obps/registration/tests/models/test_initial_data.py

@@ -144,7 +144,7 @@ def test_regulated_product_initial_data(self):
                 'Processing sour gas - oil equivalent',
                 'Processing sweet gas - oil equivalent',
                 'Pulp and paper: chemical pulp',
-                'Pulp and paper: lime recovery kiln',
+                'Pulp and paper: lime recovered by kiln',
                 'Pulp and paper: non-chemical pulp',
                 'Pulp and paper: paper (except newsprint and tissue paper)',
                 'Pulp and paper: tissue Paper',

bc_obps/reporting/tests/models/test_product_emission_intensity.py

@@ -1,15 +1,22 @@
 from common.tests.utils.helpers import BaseTestCase
+from django.db.models import Count
 from reporting.models import ProductEmissionIntensity
 from registration.models import RegulatedProduct
 from django.test import TestCase
 
 
 class TestInitialData(TestCase):
-    def test_all_products_have_emission_intensity(self):
-        product_list = RegulatedProduct.objects.all().values_list('id', flat=True)
-        missing_records = ProductEmissionIntensity.objects.all().exclude(id__in=product_list).count()
-
-        self.assertEqual(missing_records, 0)
+    def test_all_regulated_products_have_emission_intensity(self):
+        """
+        Assert that every regulated product has at least one ProductEmissionIntensity record defined
+        """
+        assert (
+            not RegulatedProduct.objects.prefetch_related("productemissionintensity")
+            .filter(is_regulated=True)
+            .annotate(emission_intensity_count=Count("productemissionintensity"))
+            .filter(emission_intensity_count=0)
+            .exists()
+        )
 
 
 class EmissionCategoryModelTest(BaseTestCase):

bciers/apps/reporting/src/app/components/facility/FacilityEmissionAllocationForm.tsx

@@ -131,17 +131,29 @@ const validateFormData = (
       industrialEmissionAllocations?.products?.find(
         (p) => p.product_name === "Pulp and paper: chemical pulp",
       );
+    const limeRecoveredByKilnAllocation =
+      industrialEmissionAllocations?.products?.find(
+        (p) => p.product_name === "Pulp and paper: lime recovered by kiln",
+      );
     if (!chemicalPulpAllocation)
       newErrors.push(
         "Missing Product: 'Pulp and paper: chemical pulp'. Please add the product on the operation review page",
       );
+    else if (!limeRecoveredByKilnAllocation)
+      newErrors.push(
+        "Missing Product: 'Pulp and paper: lime recovered by kiln'. Please add the product on the operation review page",
+      );
     else if (
-      chemicalPulpAllocation.allocated_quantity -
+      // overlapping industrial process emissions are necessarily allocated to either of these products,
+      // we can give the user an early warning if they didn't allocate enough at this stage
+      chemicalPulpAllocation.allocated_quantity +
+        limeRecoveredByKilnAllocation.allocated_quantity -
         overlappingIndustrialProcessEmissions <
       0
     )
       newErrors.push(
-        "Invalid allocation: Industrial Process quantity allocated to product 'Pulp and paper: chemical pulp' is too low",
+        `Invalid allocation: Industrial Process quantity allocated betwen 'Pulp and paper:
+        chemical pulp' and 'Pulp and paper: lime recovered by kiln' is too low`,
       );
   }
 

bciers/apps/reporting/src/app/components/operations/OperationReviewForm.tsx

@@ -162,7 +162,7 @@ export default function OperationReviewForm({
   };
 
   // Regulated product IDs 16 and 43 are the Pulp and paper: chemical pulp
-  // and Pulp and paper: lime recovery kiln, respectively
+  // and Pulp and paper: lime recovered by kiln, respectively
   const selectedProductIds: number[] = formDataState.regulated_products;
   const displayPulpAndPaperHelpText =
     (selectedProductIds.includes(16) && !selectedProductIds.includes(43)) ||
@@ -207,7 +207,7 @@ export default function OperationReviewForm({
             regulated_products: {
               ...uiSchema.regulated_products,
               "ui:help": `If this is a chemical pulp mill that recovered lime by kiln,
-                select both 'Pulp and paper: chemical pulp' and 'Pulp and paper: lime recovery kiln'`,
+                select both 'Pulp and paper: chemical pulp' and 'Pulp and paper: lime recovered by kiln'`,
             },
           }),
         }}

bciers/apps/reporting/src/tests/components/operations/OperationReviewForm.test.tsx

@@ -465,14 +465,14 @@ describe("OperationReviewForm Component", () => {
     ).toBeInTheDocument();
   });
 
-  it("displays a help text when either chemical pulp / lime recovery kiln are selected, but not both", async () => {
+  it("displays a help text when either chemical pulp / lime recovered by kiln are selected, but not both", async () => {
     async function renderWithProductIds(productIds: number[]) {
       const allRegulatedProducts = [
         { id: 1, name: "Product 1", unit: "BCRCT", is_regulated: true },
         { id: 16, name: "chemical pulp", unit: "BCRCT", is_regulated: true },
         {
           id: 43,
-          name: "lime recovery kiln",
+          name: "lime recovered by kiln",
           is_regulated: true,
         },
       ];

bciers/libs/components/src/form/fields/FieldHelpTemplate.tsx

@@ -1,22 +1,16 @@
 "use client";
 
-import { BC_GOV_BACKGROUND_COLOR_BLUE } from "@bciers/styles/colors";
-import { Typography } from "@mui/material";
 import { FieldHelpProps } from "@rjsf/utils";
 
 function FieldHelpTemplate(props: FieldHelpProps) {
   const { help } = props;
   return (
-    <span>
-      <Typography
-        variant="body2"
-        color={BC_GOV_BACKGROUND_COLOR_BLUE}
-        fontStyle="italic"
-        fontSize={16}
-      >
+    help && (
+      <small>
+        <b>Note: </b>
         {help}
-      </Typography>
-    </span>
+      </small>
+    )
   );
 }