chore: use display title in review-changes activity + delete unused object renderer

Author: gdalcengio

bc_obps/reporting/api/report_review_changes.py

@@ -1,5 +1,6 @@
 from django.http import HttpRequest
 
+from reporting.models.reporting_field import ReportingField
 from service.error_service.custom_codes_4xx import custom_codes_4xx
 from reporting.constants import EMISSIONS_REPORT_TAGS
 from reporting.schema.generic import Message
@@ -43,4 +44,7 @@ def get_report_version_diff_data(request: HttpRequest, version_id: int) -> tuple
 
     changed = ReportReviewChangesService.get_report_version_diff_changes(previous_data, current_data)
 
-    return 200, {"changed": changed}
+    fields = ReportingField.objects.exclude(field_display_title__isnull=True)
+    reporting_fields_display_titles = {field.slug: field.field_display_title for field in fields}
+
+    return 200, {"changed": changed, "reporting_fields_display_titles": reporting_fields_display_titles}

bciers/apps/reporting/src/app/components/changeReview/ChangeReviewForm.tsx

@@ -36,14 +36,20 @@ export default function ChangeReviewForm({
   const [isSaving, setIsSaving] = useState<boolean>(false);
 
   const [changesData, setChangesData] = useState<
-    { changed: ChangeItem[] } | undefined
+    | {
+        changed: ChangeItem[];
+        reporting_fields_display_titles: Record<string, string>;
+      }
+    | undefined
   >();
   useEffect(() => {
     if (!displayChanges) return;
 
     const fetchChanges = async () => {
-      const fetchedDiffData: { changed: ChangeItem[] } =
-        await getChangeReviewData(versionId);
+      const fetchedDiffData: {
+        changed: ChangeItem[];
+        reporting_fields_display_titles: Record<string, string>;
+      } = await getChangeReviewData(versionId);
 
       setChangesData(fetchedDiffData);
     };
@@ -96,6 +102,9 @@ export default function ChangeReviewForm({
           <ReviewChanges
             changes={changesData.changed}
             registrationPurpose={registrationPurpose}
+            reportingFieldDisplayTitleBySlug={
+              changesData.reporting_fields_display_titles
+            }
           />
         )}
         {displayChanges && !changesData && <Loading />}

bciers/apps/reporting/src/app/components/changeReview/components/ActivityDiffView.tsx

@@ -8,16 +8,19 @@ import { SourceTypeDiffView } from "./SourceTypeDiffView";
 interface WholeActivityDiffViewProps {
   activityName: string;
   changeItem: ChangeItem;
+  reportingFieldDisplayTitleBySlug: Record<string, string>;
 }
 
 interface ActivityDiffViewProps {
   activityName: string;
   activityGroup: ActivityGroup;
+  reportingFieldDisplayTitleBySlug: Record<string, string>;
 }
 
 export const WholeActivityDiffView: React.FC<WholeActivityDiffViewProps> = ({
   activityName,
   changeItem,
+  reportingFieldDisplayTitleBySlug,
 }) => {
   const value = getChangeValue(changeItem);
   return (
@@ -30,6 +33,7 @@ export const WholeActivityDiffView: React.FC<WholeActivityDiffViewProps> = ({
           },
         ]}
         changeType={changeItem.change_type}
+        reportingFieldDisplayTitleBySlug={reportingFieldDisplayTitleBySlug}
       />
     </Box>
   );
@@ -38,6 +42,7 @@ export const WholeActivityDiffView: React.FC<WholeActivityDiffViewProps> = ({
 export const PartialActivityDiffView: React.FC<ActivityDiffViewProps> = ({
   activityName,
   activityGroup,
+  reportingFieldDisplayTitleBySlug,
 }) => {
   // Only some source types (or their fields) changed
   return (
@@ -59,6 +64,7 @@ export const PartialActivityDiffView: React.FC<ActivityDiffViewProps> = ({
             key={sourceTypeName}
             sourceTypeGroup={stGroup}
             sourceTypeName={sourceTypeName}
+            reportingFieldDisplayTitleBySlug={reportingFieldDisplayTitleBySlug}
           />
         ),
       )}
@@ -69,19 +75,22 @@ export const PartialActivityDiffView: React.FC<ActivityDiffViewProps> = ({
 export const ActivityDiffView: React.FC<ActivityDiffViewProps> = ({
   activityName,
   activityGroup,
+  reportingFieldDisplayTitleBySlug,
 }) => {
   if (activityGroup.whole)
     return (
       <WholeActivityDiffView
         activityName={activityName}
         changeItem={activityGroup.whole}
+        reportingFieldDisplayTitleBySlug={reportingFieldDisplayTitleBySlug}
       />
     );
 
   return (
     <PartialActivityDiffView
       activityName={activityName}
       activityGroup={activityGroup}
+      reportingFieldDisplayTitleBySlug={reportingFieldDisplayTitleBySlug}
     />
   );
 };

bciers/apps/reporting/src/app/components/changeReview/components/ObjectRenderer.tsx

@@ -9,6 +9,8 @@ export interface SimpleActivityDiffProps {
   changes: ChangeItem[];
   /** When true, facility name headers are omitted (useful when the facility is already shown in a parent). */
   hideFacilityHeaders?: boolean;
+  /** Mapping of reporting field slugs to their display titles */
+  reportingFieldDisplayTitleBySlug: Record<string, string>;
 }
 
 /**
@@ -22,6 +24,7 @@ export interface SimpleActivityDiffProps {
 export const SimpleActivityDiff: React.FC<SimpleActivityDiffProps> = ({
   changes,
   hideFacilityHeaders = false,
+  reportingFieldDisplayTitleBySlug,
 }) => {
   const grouped = groupActivityChanges(changes);
 
@@ -40,6 +43,9 @@ export const SimpleActivityDiff: React.FC<SimpleActivityDiffProps> = ({
               key={activityName}
               activityName={activityName}
               activityGroup={activityGroup}
+              reportingFieldDisplayTitleBySlug={
+                reportingFieldDisplayTitleBySlug
+              }
             />
           ))}
         </Box>

bciers/apps/reporting/src/app/components/changeReview/components/SimpleActivityDiff.tsx

@@ -15,6 +15,7 @@ interface SharedSourceTypeDiffViewProps {
   classNames: string;
   label: string;
   readonly: boolean;
+  reportingFieldDisplayTitleBySlug: Record<string, string>;
 }
 
 interface WholeSourceTypeDiffViewProps {
@@ -25,6 +26,7 @@ interface WholeSourceTypeDiffViewProps {
 interface SourceTypeDiffViewProps {
   sourceTypeGroup: SourceTypeGroup;
   sourceTypeName: string;
+  reportingFieldDisplayTitleBySlug: Record<string, string>;
 }
 
 export const WholeSourceTypeDiffView: React.FC<
@@ -41,7 +43,12 @@ export const WholeSourceTypeDiffView: React.FC<
       isDeleted={change.change_type === "removed"}
       description={
         <div style={dataCardStyle}>
-          {renderObject(value, "", change.change_type === "removed")}
+          {renderObject(
+            value,
+            "",
+            change.change_type === "removed",
+            props.reportingFieldDisplayTitleBySlug,
+          )}
         </div>
       }
     />
@@ -62,7 +69,14 @@ export const PartialSourceTypeDiffView: React.FC<
   return (
     <SourceTypeBoxTemplate
       {...props}
-      description={<Box ml={1}>{renderDiffTree(segmentedChanges)}</Box>}
+      description={
+        <Box ml={1}>
+          {renderDiffTree(
+            segmentedChanges,
+            props.reportingFieldDisplayTitleBySlug,
+          )}
+        </Box>
+      }
     />
   );
 };
@@ -75,6 +89,7 @@ export const SourceTypeDiffView: React.FC<SourceTypeDiffViewProps> = (
     classNames: "source-type-box",
     label: sourceTypeName,
     readonly: false,
+    reportingFieldDisplayTitleBySlug: props.reportingFieldDisplayTitleBySlug,
   };
 
   if (sourceTypeGroup.whole)

bciers/apps/reporting/src/app/components/changeReview/components/SourceTypeDiffView.tsx

@@ -24,6 +24,7 @@ export interface ChangeItem {
 export interface ReviewChangesProps {
   changes: ChangeItem[];
   registrationPurpose: string;
+  reportingFieldDisplayTitleBySlug: Record<string, string>;
 }
 
 export interface DisplayChangeItem extends ChangeItem {

bciers/apps/reporting/src/app/components/changeReview/constants/types.ts

@@ -47,6 +47,7 @@ function groupByFacility(changes: any[]): Record<string, any[]> {
 export const ReviewChanges: React.FC<ReviewChangesProps> = ({
   changes,
   registrationPurpose,
+  reportingFieldDisplayTitleBySlug,
 }) => {
   const normalizedChanges = normalizeChangeKeys(filterExcludedFields(changes));
 
@@ -213,6 +214,9 @@ export const ReviewChanges: React.FC<ReviewChangesProps> = ({
                   <SimpleActivityDiff
                     changes={activityChanges}
                     hideFacilityHeaders
+                    reportingFieldDisplayTitleBySlug={
+                      reportingFieldDisplayTitleBySlug
+                    }
                   />
                 </Box>
               )}

bciers/apps/reporting/src/app/components/changeReview/templates/ReviewChanges.tsx

@@ -218,7 +218,8 @@ export const ObjectLeafNode: React.FC<{
   label: string;
   changeType: string;
   value: object;
-}> = ({ label, changeType, value }) => (
+  reportingFieldDisplayTitleBySlug: Record<string, string>;
+}> = ({ label, changeType, value, reportingFieldDisplayTitleBySlug }) => (
   <Box mb={1}>
     <Typography
       sx={{
@@ -235,7 +236,12 @@ export const ObjectLeafNode: React.FC<{
       {changeType === "removed" && <StatusLabel type="removed" />}
     </Typography>
     <Box ml={2} style={dataCardStyle}>
-      {renderActivityObject(value, "", changeType === "removed")}
+      {renderActivityObject(
+        value,
+        "",
+        changeType === "removed",
+        reportingFieldDisplayTitleBySlug,
+      )}
     </Box>
   </Box>
 );
@@ -296,7 +302,10 @@ const buildGroupInfo = (
  * - Numeric second segments are treated as array indices and produce
  *   human-readable labels like "Emission Category 1".
  */
-export const renderDiffTree = (items: SegmentedChange[]): React.ReactNode => {
+export const renderDiffTree = (
+  items: SegmentedChange[],
+  reportingFieldDisplayTitleBySlug: Record<string, string>,
+): React.ReactNode => {
   if (!items.length) return null;
 
   // Group items by their leading path segment so siblings are rendered together
@@ -358,22 +367,28 @@ export const renderDiffTree = (items: SegmentedChange[]): React.ReactNode => {
                 label={label}
                 changeType={change.change_type}
                 value={value}
+                reportingFieldDisplayTitleBySlug={
+                  reportingFieldDisplayTitleBySlug
+                }
               />
             );
 
           // Scalar value → standard change row
           return (
             <ChangeItemDisplay
               key={key}
-              item={{ ...change, displayLabel: label }}
+              item={{
+                ...change,
+                displayLabel: reportingFieldDisplayTitleBySlug?.[key] ?? label,
+              }}
             />
           );
         }
 
         // Multiple children or deeper path → recurse into a branch
         return (
           <BranchNode key={key} label={label}>
-            {renderDiffTree(children)}
+            {renderDiffTree(children, reportingFieldDisplayTitleBySlug)}
           </BranchNode>
         );
       })}

bciers/apps/reporting/src/app/components/changeReview/utils/activityViewHelpers.tsx

@@ -215,7 +215,7 @@ export interface ReportData {
 
 export interface ActivitiesViewProps {
   activity_data: ActivityItem[] | Record<string, any>;
-  reporting_fields_display_titles?: Record<string, string>;
+  reportingFieldDisplayTitleBySlug?: Record<string, string>;
   isAdded?: boolean;
   isDeleted?: boolean;
   changeType?: ChangeType;