chore: update dashboard tiles

chore: cleanup

chore:  cleanup

chore: cleanup

chore: cleanup

chore: cleanup

chore: cleanup

chore: cleanup

chore: cleanup

Author: shon-button

bc_obps/common/fixtures/dashboard/bciers/external.json

@@ -177,11 +177,11 @@
             ],
             "links": [
               {
-                "title": "View Annual Reports",
+                "title": "Current Reporting Year",
                 "href": "/reporting/reports/current-reports"
               },
               {
-                "title": "View Past Reports",
+                "title": "Previous Reporting Years",
                 "href": "/reporting/reports/previous-years"
               }
             ]

bc_obps/common/migrations/0131_update_dashboard_data.py

@@ -0,0 +1,30 @@
+from django.db import migrations
+
+
+def load_dashboard_fixtures(apps, schema_editor):
+    from django.core.management import call_command
+
+    fixture_files = [
+        'common/fixtures/dashboard/bciers/external.json',
+        'common/fixtures/dashboard/bciers/internal.json',
+        'common/fixtures/dashboard/operators/internal.json',
+    ]
+
+    # Delete all existing DashboardData objects
+    DashboardData = apps.get_model('common', 'DashboardData')
+    DashboardData.objects.all().delete()
+
+    # Load the fixtures
+    for fixture in fixture_files:
+        call_command('loaddata', fixture)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('common', '0130_V5_15_0'),
+    ]
+
+    operations = [
+        migrations.RunPython(load_dashboard_fixtures, elidable=True),
+    ]

bc_obps/reporting/api/reports.py

@@ -10,7 +10,7 @@
 from reporting.constants import EMISSIONS_REPORT_TAGS
 from reporting.schema.generic import Message
 from reporting.schema.report import StartReportIn, CreateReportVersionIn, CreateReportForReportingYearIn
-from service.report_service import ReportService
+from service.report_service import CreateReportForReportingYearData, ReportService
 from service.report_version_service import ReportVersionService, ReportVersionData
 from service.reporting_year_service import ReportingYearService
 from service.error_service.custom_codes_4xx import custom_codes_4xx
@@ -55,9 +55,14 @@ def create_report_for_reporting_year(
     request: HttpRequest,
     payload: CreateReportForReportingYearIn,
 ) -> Tuple[Literal[201], int]:
+    data = CreateReportForReportingYearData(
+        operation_id=payload.operation_id,
+        reporting_year=payload.reporting_year,
+        registration_purpose=payload.registration_purpose,
+    )
     report_version_id = ReportService.create_report_for_reporting_year(
         user_guid=get_current_user_guid(request),
-        data=payload,
+        data=data,
     )
 
     return 201, report_version_id

bc_obps/reporting/tests/service/test_reporting_year_service.py

@@ -38,3 +38,27 @@ def test_get_reporting_year_by_version_id(self):
         report_version = make_recipe('reporting.tests.utils.report_version', report=report)
         reporting_year = ReportingYearService.get_reporting_year_by_version_id(report_version.id)
         assert reporting_year == self.reporting_year
+
+    @patch("service.reporting_year_service.ReportingYearService.get_current_reporting_year")
+    def test_get_previous_reporting_years(self, mock_get_current_reporting_year):
+        # Arrange
+        for year in [2023, 2024, 2025]:
+            ReportingYear.objects.get_or_create(
+                reporting_year=year,
+                defaults={
+                    "reporting_window_start": f"{year + 1}-01-01T00:00:00.000Z",
+                    "reporting_window_end": f"{year + 1}-12-31T23:59:59.999Z",
+                    "report_due_date": f"{year + 1}-05-31T23:59:59.999Z",
+                    "description": f"{year} reporting year",
+                },
+            )
+
+        mock_get_current_reporting_year.return_value = ReportingYear(
+            reporting_year=2025,
+        )
+
+        # Act
+        reporting_years = ReportingYearService.get_previous_reporting_years()
+
+        # Assert
+        assert list(reporting_years.values_list("reporting_year", flat=True)) == [2024]

bc_obps/service/operation_service.py

@@ -64,7 +64,6 @@
 class OperationService:
 
     OPERATION_DEFAULT_START_DATE = datetime(2024, 1, 1, tzinfo=ZoneInfo("America/Vancouver"))
-    MIN_REPORTING_YEAR = 2024
 
     @classmethod
     def get_if_authorized(
@@ -770,6 +769,8 @@ def get_valid_operation_regulated_products(operation: Operation, reporting_year:
         return operation.regulated_products.filter(
             valid_from__lte=reporting_year_date, valid_to__gte=reporting_year_date
         )
+
+    @staticmethod
     def _is_reportable_operation_year(
         operation_year: tuple[UUID, int],
         added_operation_years: set[tuple[UUID, int]],
@@ -788,21 +789,6 @@ def _is_designated_to_user_operator(
             and designated_operator_timeline.operator.id == user_operator.operator_id
         )
 
-    @classmethod
-    def _get_previous_reporting_years(cls) -> QuerySet[ReportingYear]:
-        """
-        Returns reporting years that are eligible for the Start Past Report workflow
-
-        Only reporting years from MIN_REPORTING_YEAR up to (but not including) the current
-        reporting year are returned.
-        """
-        current_reporting_year = ReportingYearService.get_current_reporting_year()
-
-        return ReportingYear.objects.filter(
-            reporting_year__gte=cls.MIN_REPORTING_YEAR,
-            reporting_year__lt=current_reporting_year.reporting_year,
-        ).order_by("-reporting_year")
-
     @staticmethod
     def _get_registration_purposes_for_operation_type(
         operation_type: str,
@@ -887,7 +873,7 @@ def list_previous_reportable_operations(
 
         user_operator = UserDataAccessService.get_user_operator_by_user(user_guid)
 
-        reporting_years = cls._get_previous_reporting_years()
+        reporting_years = ReportingYearService.get_previous_reporting_years()
         year_values = {reporting_year.reporting_year for reporting_year in reporting_years}
 
         timelines = list(

bc_obps/service/report_service.py

@@ -18,6 +18,14 @@
 from service.facility_report_service import FacilityReportService, SaveFacilityReportData
 from typing import Any, List, Optional
 from service.data_access_service.user_service import UserDataAccessService
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class CreateReportForReportingYearData:
+    operation_id: UUID
+    reporting_year: int
+    registration_purpose: str
 
 
 class SaveReportOperationData:
@@ -89,7 +97,7 @@ def create_report(cls, operation_id: UUID, reporting_year: int) -> int:
     def create_report_for_reporting_year(
         cls,
         user_guid: UUID,
-        data: Any,
+        data: CreateReportForReportingYearData,
     ) -> int:
         operation_id = data.operation_id
         reporting_year = data.reporting_year
@@ -115,7 +123,7 @@ def create_report_for_reporting_year(
             # the designated operator for the selected reporting year
             if designated_operator_timeline.operator.id != user_operator.operator_id:
                 raise UserError(
-                    f"This operation was owned by another operation in {reporting_year}, "
+                    f"This operation was owned by another operator in {reporting_year}, "
                     "you do not need to report on this operation. "
                     "If you believe this is incorrect, please contact ghgregulator@gov.bc.ca."
                 )

bc_obps/service/reporting_year_service.py

@@ -6,6 +6,8 @@
 
 
 class ReportingYearService:
+    MIN_REPORTING_YEAR = 2024
+
     @classmethod
     def get_current_reporting_year(cls) -> ReportingYear:
         now = timezone.now()
@@ -43,3 +45,18 @@ def get_report_reporting_year(cls, report_id: int) -> ReportingYear:
     def get_reporting_year_by_version_id(cls, version_id: int) -> ReportingYear:
         report_version = ReportVersion.objects.get(id=version_id)
         return report_version.report.reporting_year
+
+    @classmethod
+    def get_previous_reporting_years(cls) -> QuerySet[ReportingYear]:
+        """
+        Returns reporting years that are eligible for the Start Past Report workflow
+
+        Only reporting years from MIN_REPORTING_YEAR up to (but not including) the current
+        reporting year are returned.
+        """
+        current_reporting_year = cls.get_current_reporting_year()
+
+        return ReportingYear.objects.filter(
+            reporting_year__gte=cls.MIN_REPORTING_YEAR,
+            reporting_year__lt=current_reporting_year.reporting_year,
+        ).order_by("-reporting_year")

bc_obps/service/tests/operation_service/test_operation_service_reportable.py

@@ -18,26 +18,6 @@ def test_is_reportable_operation_year():
         assert OperationService._is_reportable_operation_year(operation_year, {operation_year}, set()) is False
         assert OperationService._is_reportable_operation_year(operation_year, set(), {operation_year}) is False
 
-    @staticmethod
-    @patch("service.reporting_year_service.ReportingYearService.get_current_reporting_year")
-    def test_get_previous_reporting_years(mock_get_current_reporting_year: MagicMock):
-        baker.make_recipe("reporting.tests.utils.reporting_year", reporting_year=2091)
-        baker.make_recipe("reporting.tests.utils.reporting_year", reporting_year=2092)
-        current_year = baker.make_recipe(
-            "reporting.tests.utils.reporting_year",
-            reporting_year=2093,
-        )
-
-        mock_get_current_reporting_year.return_value = current_year
-
-        results = OperationService._get_previous_reporting_years().filter(
-            reporting_year__in=[2091, 2092, 2093],
-        )
-
-        assert results.count() == 2
-        assert results[0].reporting_year == 2092
-        assert results[1].reporting_year == 2091
-
     @staticmethod
     def test_get_registration_purposes_for_operation_type_sfo_lfo():
         expected_purposes = [
@@ -90,7 +70,7 @@ def test_build_reportable_operation_row(mock_get_purposes: MagicMock):
         "service.operation_designated_operator_timeline_service."
         "OperationDesignatedOperatorTimelineService.get_operation_designated_operators_for_reporting_years"
     )
-    @patch.object(OperationService, "_get_previous_reporting_years")
+    @patch("service.reporting_year_service.ReportingYearService.get_previous_reporting_years")
     def test_list_previous_reportable_operations(
         mock_get_previous_reporting_years: MagicMock,
         mock_get_designations: MagicMock,

bc_obps/service/tests/test_report_service.py

@@ -743,7 +743,7 @@ def test_create_report_for_reporting_year_rejects_wrong_historical_designated_op
 
         self.assertEqual(
             str(exception_context.exception),
-            "This operation was owned by another operation in 2023, "
+            "This operation was owned by another operator in 2023, "
             "you do not need to report on this operation. "
             "If you believe this is incorrect, please contact ghgregulator@gov.bc.ca.",
         )

bciers/apps/dashboard-e2e/utils/enums.ts

@@ -42,8 +42,8 @@ export enum ExternalDashboardLinks {
   CONTACTS = "Contacts",
   USERS_AND_ACCESS_REQUESTS = "Users and Access Requests",
   REGISTER_AN_OPERATION = "Register an Operation",
-  VIEW_ANNUAL_REPORTS = "View Annual Reports",
-  VIEW_PAST_REPORTS = "View Past Reports",
+  VIEW_ANNUAL_REPORTS = "Current Reporting Year",
+  VIEW_PAST_REPORTS = "Previous Reporting Years",
   MY_COMPLIANCE = "My Compliance",
   BC_CARBON_REGISTRY = "B.C. Carbon Registry",
   REPORT_PROBLEM = "Report problems to GHGRegulator@gov.bc.ca",