Merge pull request #1751 from bcgov/feat/prashanth-history-save-name-…

…1693

Feat: LCFS - Update the history record to save name #1693

backend/lcfs/db/migrations/versions/2025-01-20-16-23_c306137b57ab.py

@@ -0,0 +1,66 @@
+"""Add display names to history tables.
+
+Revision ID: c306137b57ab
+Revises: 98d79870df6b
+Create Date: 2025-01-20 16:23:50.597769
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "c306137b57ab"
+down_revision = "98d79870df6b"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "admin_adjustment_history",
+        sa.Column(
+            "display_name",
+            sa.String(length=255),
+            nullable=True,
+            comment="Display name for the admin_adjustment history record",
+        ),
+    )
+    op.add_column(
+        "compliance_report_history",
+        sa.Column(
+            "display_name",
+            sa.String(length=255),
+            nullable=True,
+            comment="Display name for the compliance report history",
+        ),
+    )
+    op.add_column(
+        "initiative_agreement_history",
+        sa.Column(
+            "display_name",
+            sa.String(length=255),
+            nullable=True,
+            comment="Display name for the initiative agreement history record",
+        ),
+    )
+    op.add_column(
+        "transfer_history",
+        sa.Column(
+            "display_name",
+            sa.String(length=255),
+            nullable=True,
+            comment="Display name for the transfer history record",
+        ),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("transfer_history", "display_name")
+    op.drop_column("initiative_agreement_history", "display_name")
+    op.drop_column("compliance_report_history", "display_name")
+    op.drop_column("admin_adjustment_history", "display_name")
+    # ### end Alembic commands ###

backend/lcfs/db/migrations/versions/2025-01-21-06-31_9785f4cfa370.py

@@ -12,7 +12,7 @@
 
 # revision identifiers, used by Alembic.
 revision = "9785f4cfa370"
-down_revision = "98d79870df6b"
+down_revision = "c306137b57ab"
 branch_labels = None
 depends_on = None
 

backend/lcfs/db/models/admin_adjustment/AdminAdjustmentHistory.py

@@ -1,4 +1,4 @@
-from sqlalchemy import Column, Integer, ForeignKey
+from sqlalchemy import Column, Integer, ForeignKey, String
 from sqlalchemy.orm import relationship
 
 from lcfs.db.base import BaseModel, Auditable, EffectiveDates
@@ -27,6 +27,11 @@ class AdminAdjustmentHistory(BaseModel, Auditable, EffectiveDates):
         ForeignKey("user_profile.user_profile_id"),
         comment="Foreign key to user_profile",
     )
+    display_name = Column(
+        String(255),
+        comment="Display name for the admin_adjustment history record",
+        nullable=True
+    )
 
     admin_adjustment = relationship("AdminAdjustment", back_populates="history")
     admin_adjustment_status = relationship("AdminAdjustmentStatus")

backend/lcfs/db/models/compliance/ComplianceReportHistory.py

@@ -1,4 +1,4 @@
-from sqlalchemy import Column, Integer, ForeignKey
+from sqlalchemy import Column, Integer, ForeignKey, String
 from sqlalchemy.orm import relationship
 from lcfs.db.base import BaseModel, Auditable
 
@@ -30,6 +30,11 @@ class ComplianceReportHistory(BaseModel, Auditable):
         ForeignKey("user_profile.user_profile_id"),
         comment="Identifier for the user associated with the status change",
     )
+    display_name = Column(
+        String(255),
+        comment="Display name for the compliance report history",
+        nullable=True
+    )
 
     compliance_report = relationship("ComplianceReport", back_populates="history")
     status = relationship("ComplianceReportStatus")

backend/lcfs/db/models/initiative_agreement/InitiativeAgreementHistory.py

@@ -1,4 +1,4 @@
-from sqlalchemy import Column, Integer, ForeignKey
+from sqlalchemy import Column, Integer, ForeignKey, String
 from sqlalchemy.orm import relationship
 
 from lcfs.db.base import BaseModel, Auditable, EffectiveDates
@@ -28,7 +28,11 @@ class InitiativeAgreementHistory(BaseModel, Auditable, EffectiveDates):
         ForeignKey("user_profile.user_profile_id"),
         comment="Foreign key to user_profile",
     )
-
+    display_name = Column(
+        String(255),
+        comment="Display name for the initiative agreement history record",
+        nullable=True
+    )
     initiative_agreement = relationship("InitiativeAgreement", back_populates="history")
     initiative_agreement_status = relationship("InitiativeAgreementStatus")
     user_profile = relationship("UserProfile")

backend/lcfs/db/models/transfer/TransferHistory.py

@@ -1,4 +1,4 @@
-from sqlalchemy import Column, Integer, ForeignKey
+from sqlalchemy import Column, Integer, ForeignKey, String
 from sqlalchemy.orm import relationship
 
 from lcfs.db.base import BaseModel, Auditable, EffectiveDates
@@ -23,6 +23,11 @@ class TransferHistory(BaseModel, Auditable, EffectiveDates):
         ForeignKey("user_profile.user_profile_id"),
         comment="Foreign key to user_profile",
     )
+    display_name = Column(
+        String(255),
+        comment="Display name for the transfer history record",
+        nullable=True
+    )
 
     transfer = relationship("Transfer", back_populates="transfer_history")
     transfer_status = relationship("TransferStatus")

backend/lcfs/tests/initiative_agreement/test_initiative_agreement_repo.py

@@ -1,5 +1,8 @@
 from unittest.mock import MagicMock, AsyncMock, Mock
 
+from lcfs.web.api.initiative_agreement.schema import (
+    CreateInitiativeAgreementHistorySchema,
+)
 import pytest
 from sqlalchemy.ext.asyncio import AsyncSession
 
@@ -105,7 +108,14 @@ async def test_get_initiative_agreement_status_by_name_not_found(
 
 @pytest.mark.anyio
 async def test_add_initiative_agreement_history(repository, mock_db_session):
-    result = await repository.add_initiative_agreement_history(1, 1, 1)
+    result = await repository.add_initiative_agreement_history(
+        CreateInitiativeAgreementHistorySchema(
+            initiative_agreement_id=1,
+            initiative_agreement_status_id=1,
+            user_profile_id=1,
+            display_name="History User",
+        )
+    )
 
     assert isinstance(result, InitiativeAgreementHistory)
     mock_db_session.add.assert_called_once()
@@ -119,7 +129,14 @@ async def test_update_initiative_agreement_history(repository, mock_db_session):
     )
     mock_db_session.scalar.return_value = mock_history
 
-    result = await repository.update_initiative_agreement_history(1, 1, 2)
+    result = await repository.update_initiative_agreement_history(
+        CreateInitiativeAgreementHistorySchema(
+            initiative_agreement_id=1,
+            initiative_agreement_status_id=1,
+            user_profile_id=2,
+            display_name="History User",
+        )
+    )
 
     assert result.user_profile_id == 2
     mock_db_session.add.assert_called_once_with(mock_history)

backend/lcfs/tests/transfer/test_transfer_repo.py

@@ -4,7 +4,7 @@
 from lcfs.db.models.transfer.TransferHistory import TransferHistory
 
 from unittest.mock import MagicMock, AsyncMock
-from lcfs.web.api.transfer.schema import TransferSchema
+from lcfs.web.api.transfer.schema import CreateTransferHistorySchema, TransferSchema
 from datetime import date
 from lcfs.db.models.organization import Organization
 from lcfs.db.models.transfer import TransferStatus, TransferCategory
@@ -117,18 +117,20 @@ async def test_update_transfer_success(transfer_repo):
 
 @pytest.mark.anyio
 async def test_add_transfer_history_success(transfer_repo):
-    transfer_id = 1
-    transfer_status_id = 1
-    user_profile_id = 1
 
     result = await transfer_repo.add_transfer_history(
-        transfer_id, transfer_status_id, user_profile_id
+        CreateTransferHistorySchema(
+            transfer_id=1,
+            transfer_status_id=1,
+            user_profile_id=1,
+            display_name="History User",
+        )
     )
 
     assert isinstance(result, TransferHistory)
-    assert result.transfer_id == transfer_id
-    assert result.transfer_status_id == transfer_status_id
-    assert result.user_profile_id == user_profile_id
+    assert result.transfer_id == 1
+    assert result.transfer_status_id == 1
+    assert result.user_profile_id == 1
 
 
 @pytest.mark.anyio

backend/lcfs/web/api/admin_adjustment/repo.py

@@ -10,7 +10,7 @@
 from lcfs.db.models.admin_adjustment.AdminAdjustmentHistory import (
     AdminAdjustmentHistory,
 )
-from lcfs.web.api.admin_adjustment.schema import AdminAdjustmentSchema
+from lcfs.web.api.admin_adjustment.schema import CreateAdminAdjustmentHistorySchema
 
 from lcfs.db.dependencies import get_async_db_session
 from lcfs.web.core.decorators import repo_handler
@@ -88,10 +88,7 @@ async def get_admin_adjustment_status_by_name(
 
     @repo_handler
     async def add_admin_adjustment_history(
-        self,
-        admin_adjustment_id: int,
-        admin_adjustment_status_id: int,
-        user_profile_id: int,
+        self, history: CreateAdminAdjustmentHistorySchema
     ) -> AdminAdjustmentHistory:
         """
         Adds a new record to the admin adjustment history in the database.
@@ -105,20 +102,18 @@ async def add_admin_adjustment_history(
             AdminAdjustmentHistory: The newly created admin adjustment history record.
         """
         new_history_record = AdminAdjustmentHistory(
-            admin_adjustment_id=admin_adjustment_id,
-            admin_adjustment_status_id=admin_adjustment_status_id,
-            user_profile_id=user_profile_id,
+            admin_adjustment_id=history.admin_adjustment_id,
+            admin_adjustment_status_id=history.admin_adjustment_status_id,
+            user_profile_id=history.user_profile_id,
+            display_name=history.display_name,
         )
         self.db.add(new_history_record)
         await self.db.flush()
         return new_history_record
 
     @repo_handler
     async def update_admin_adjustment_history(
-        self,
-        admin_adjustment_id: int,
-        admin_adjustment_status_id: int,
-        user_profile_id: int,
+        self, history: CreateAdminAdjustmentHistorySchema
     ) -> AdminAdjustmentHistory:
         """
         Updates an admin adjustment history record in the database.
@@ -134,15 +129,17 @@ async def update_admin_adjustment_history(
         existing_history = await self.db.scalar(
             select(AdminAdjustmentHistory).where(
                 and_(
-                    AdminAdjustmentHistory.admin_adjustment_id == admin_adjustment_id,
+                    AdminAdjustmentHistory.admin_adjustment_id
+                    == history.admin_adjustment_id,
                     AdminAdjustmentHistory.admin_adjustment_status_id
-                    == admin_adjustment_status_id,
+                    == history.admin_adjustment_status_id,
                 )
             )
         )
         existing_history.create_date = datetime.now()
         existing_history.update_date = datetime.now()
-        existing_history.user_profile_id = user_profile_id
+        existing_history.user_profile_id = history.user_profile_id
+        existing_history.display_name = history.display_name
         self.db.add(existing_history)
         await self.db.flush()
         return existing_history

backend/lcfs/web/api/admin_adjustment/schema.py

@@ -31,6 +31,7 @@ class AdminAdjustmentHistorySchema(BaseSchema):
     create_date: datetime
     admin_adjustment_status: AdminAdjustmentStatusSchema
     user_profile: HistoryUserSchema
+    display_name: Optional[str] = None
 
     class Config:
         from_attributes = True
@@ -63,3 +64,9 @@ class AdminAdjustmentCreateSchema(AdminAdjustmentBaseSchema):
 class AdminAdjustmentUpdateSchema(AdminAdjustmentBaseSchema):
     admin_adjustment_id: int
     current_status: str
+
+class CreateAdminAdjustmentHistorySchema(BaseSchema):
+    admin_adjustment_id: int
+    admin_adjustment_status_id: int
+    user_profile_id: int
+    display_name: str

backend/lcfs/web/api/admin_adjustment/services.py

@@ -9,6 +9,7 @@
     AdminAdjustmentCreateSchema,
     AdminAdjustmentSchema,
     AdminAdjustmentUpdateSchema,
+    CreateAdminAdjustmentHistorySchema,
 )
 from lcfs.web.api.admin_adjustment.repo import AdminAdjustmentRepository
 from lcfs.web.exception.exceptions import DataNotFoundException
@@ -106,11 +107,12 @@ async def update_admin_adjustment(
             )
             # We only track history changes on Recommended and Approved, not Draft
             if new_status.status != AdminAdjustmentStatusEnum.Draft:
-                await history_method(
-                    admin_adjustment.admin_adjustment_id,
-                    new_status.admin_adjustment_status_id,
-                    self.request.user.user_profile_id,
-                )
+                await history_method(CreateAdminAdjustmentHistorySchema(
+                    admin_adjustment_id=admin_adjustment.admin_adjustment_id,
+                    admin_adjustment_status_id=new_status.admin_adjustment_status_id,
+                    user_profile_id=self.request.user.user_profile_id,
+                    display_name=(f"{self.request.user.first_name} {self.request.user.last_name}")
+                ))
 
         # Save the updated admin adjustment
         updated_admin_adjustment = await self.repo.update_admin_adjustment(
@@ -148,11 +150,12 @@ async def create_admin_adjustment(
         admin_adjustment = await self.repo.create_admin_adjustment(admin_adjustment)
 
         if current_status.status == AdminAdjustmentStatusEnum.Recommended:
-            await self.repo.add_admin_adjustment_history(
-                admin_adjustment.admin_adjustment_id,
-                current_status.admin_adjustment_status_id,
-                self.request.user.user_profile_id,
-            )
+            await self.repo.add_admin_adjustment_history(CreateAdminAdjustmentHistorySchema(
+                admin_adjustment_id=admin_adjustment.admin_adjustment_id,
+                admin_adjustment_status_id=current_status.admin_adjustment_status_id,
+                user_profile_id=self.request.user.user_profile_id,
+                display_name=(f"{self.request.user.first_name} {self.request.user.last_name}")
+            ))
 
         # Create internal comment if provided
         if admin_adjustment_data.internal_comment:

backend/lcfs/web/api/compliance_report/repo.py

@@ -341,11 +341,13 @@ async def add_compliance_report_history(
             history.create_date = datetime.now()
             history.status_id = report.current_status_id
             history.user_profile_id = user.user_profile_id
+            history.display_name = (f"{user.first_name} {user.last_name}")
         else:
             history = ComplianceReportHistory(
                 compliance_report_id=report.compliance_report_id,
                 status_id=report.current_status_id,
                 user_profile_id=user.user_profile_id,
+                display_name=(f"{user.first_name} {user.last_name}")
             )
         self.db.add(history)
         await self.db.flush()

backend/lcfs/web/api/compliance_report/schema.py

@@ -87,6 +87,7 @@ class ComplianceReportHistorySchema(BaseSchema):
     compliance_report_id: int
     status: ComplianceReportStatusSchema
     user_profile: ComplianceReportUserSchema
+    display_name: Optional[str] = None
     create_date: datetime