COMP-775 prevent editing of requirements/details before IR reopened (#675)

Author: tom0827

compliance-api/src/compliance_api/models/inspection_record.py

@@ -7,6 +7,8 @@
 from sqlalchemy import ForeignKey, Integer, String
 from sqlalchemy.orm import relationship
 
+from compliance_api.models.inspection.inspection_enum import InspectionStatusEnum
+
 from .base_model import BaseModelVersioned
 from .utils import with_session
 
@@ -161,3 +163,8 @@ def get_by_inspection_id(cls, inspection_id):
         return cls.query.filter_by(
             inspection_id=inspection_id, is_deleted=False, is_active=True
         ).first()
+
+    @property
+    def is_open_for_editing(self):
+        """Check if the associated inspection has been reopened."""
+        return self.inspection.inspection_status == InspectionStatusEnum.OPEN and self.date_issued is None

compliance-api/src/compliance_api/schemas/inspection_record.py

@@ -42,18 +42,17 @@ class Meta(AutoSchemaBase.Meta):  # pylint: disable=too-few-public-methods
     )
     record_prepared_by_position = fields.Nested(KeyValueSchema, dump_only=True)
 
-    @post_dump
-    def post_dump_actions(
-        self, data, many, **kwargs
-    ):  # pylint: disable=no-self-use, unused-argument
-        """Extract the value of the inspection record status enum."""
+    @post_dump(pass_original=True)
+    def post_dump_actions(self, data, original, many, **kwargs):  # pylint: disable=no-self-use, unused-argument
+        """Post dump actions."""
         if "ir_progress" in data and data["ir_progress"] is not None:
             data["ir_progress"] = {
                 "id": data["ir_progress"].name,
                 "name": data["ir_progress"].value,
             }
         else:
             data["ir_progress"] = ""
+        data["is_open_for_editing"] = getattr(original, "is_open_for_editing", False)
         return data
 
 

compliance-web/cypress/components/_components/_App/_Inspections/_Profile/InspectionRequirements.cy.tsx

@@ -1,5 +1,6 @@
 /// <reference types="cypress" />
 import { mount } from "cypress/react";
+import { useReportStore } from "@/components/App/Inspections/Profile/Reports/reportStore";
 import InspectionRequirements from "@/components/App/Inspections/Profile/InspectionRequirements";
 import { Inspection } from "@/models/Inspection";
 import { InspectionRequirement } from "@/models/InspectionRequirement";
@@ -60,6 +61,11 @@ describe("InspectionRequirements", () => {
       },
     });
 
+    // Set Zustand store state for useReportStore
+    useReportStore.setState({
+      inspectionReportsData: { is_open_for_editing: true }
+    });
+
     // Default mock inspection data
     mockInspection = {
       id: 1,
@@ -346,6 +352,14 @@ describe("InspectionRequirements", () => {
   });
 
   describe("Action Button Functionality", () => {
+      it("does not show action buttons when is_open_for_editing is false", () => {
+        useReportStore.setState({
+          inspectionReportsData: { is_open_for_editing: false },
+        });
+        mountComponent();
+        cy.contains("New Requirement").should("not.exist");
+        cy.contains("Regulatory Consideration").should("not.exist");
+      });
     beforeEach(() => {
       mockInspection.inspection_status = "Open";
       queryClient.setQueryData(["inspection-requirement-images", mockInspection.id], mockImages);

compliance-web/cypress/components/_components/_App/_Inspections/_Requirements/RequirementDrawer.cy.tsx

@@ -2,6 +2,7 @@ import RequirementDrawer from "@/components/App/Inspections/Profile/Requirements
 import { baseRequirement, mockInspection } from "./mockData";
 import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
 import { InspectionRequirement } from "@/models/InspectionRequirement";
+import { useReportStore } from "@/components/App/Inspections/Profile/Reports/reportStore";
 
 describe("RequirementDrawer Component", () => {
   const queryClient = new QueryClient();
@@ -31,6 +32,19 @@ describe("RequirementDrawer Component", () => {
           { id: "REG", name: "Regulatory Consideration" },
         ]),
     });
+    // Set Zustand store state for useReportStore
+    useReportStore.setState({
+      inspectionReportsData: { is_open_for_editing: true },
+    });
+  });
+  it("does not show action buttons when is_open_for_editing is false", () => {
+    useReportStore.setState({
+      inspectionReportsData: { is_open_for_editing: false },
+    });
+    mountComponent(baseRequirement);
+    cy.contains("Delete").should("not.exist");
+    cy.contains("Edit Requirement #1").should("not.exist");
+    // If there are other action buttons, add similar checks here
   });
 
   it("renders create requirement drawer correctly", () => {
@@ -54,7 +68,7 @@ describe("RequirementDrawer Component", () => {
 
     // Confirm deletion
     cy.contains("button", "Delete").click();
-    
+
   });
 
 });

compliance-web/src/components/App/Inspections/Profile/InspectionRequirements.tsx

@@ -27,6 +27,7 @@ import { useRequirementStore } from "./Requirements/requirementStore";
 import RequirementLoading from "./Requirements/RequirementLoading";
 import DynamicHeightBox from "@/components/Shared/DynamicHeightBox";
 import useResponsiveDrawerWidth from "@/hooks/useResponsiveDrawerWidth";
+import { useReportStore } from "./Reports/reportStore";
 
 interface InspectionRequirementsProps {
   inspectionData: Inspection;
@@ -44,6 +45,7 @@ const InspectionRequirements: React.FC<InspectionRequirementsProps> = ({
     setRequirementFigures,
     setRequirementsList,
   } = useRequirementStore();
+  const { inspectionReportsData } = useReportStore();
   const [activeRequirementId, setActiveRequirementId] = React.useState<
     number | null
   >(null);
@@ -303,30 +305,32 @@ const InspectionRequirements: React.FC<InspectionRequirementsProps> = ({
     >
       <Box display={"flex"} justifyContent={"space-between"} mt={3} mb={2}>
         <Typography variant="h6">Requirements</Typography>
-        {!isDataLoading && isRequirementsAllowed && (
-          <Box display={"flex"} gap={2}>
-            <Button
-              variant="text"
-              color="primary"
-              size="small"
-              onClick={handleOpenAddRegulatoryConsiderationModal}
-              startIcon={<AddRounded />}
-              data-cy="new-regulatory-consideration-button"
-              disabled={!!regulatoryConsideration}
-            >
-              Regulatory Consideration
-            </Button>
-            <Button
-              color="secondary"
-              size="small"
-              onClick={handleOpenAddRequirementModal}
-              startIcon={<AddRounded />}
-              data-cy="new-requirement-button"
-            >
-              New Requirement
-            </Button>
-          </Box>
-        )}
+        {!isDataLoading &&
+          isRequirementsAllowed &&
+          inspectionReportsData?.is_open_for_editing && (
+            <Box display={"flex"} gap={2}>
+              <Button
+                variant="text"
+                color="primary"
+                size="small"
+                onClick={handleOpenAddRegulatoryConsiderationModal}
+                startIcon={<AddRounded />}
+                data-cy="new-regulatory-consideration-button"
+                disabled={!!regulatoryConsideration}
+              >
+                Regulatory Consideration
+              </Button>
+              <Button
+                color="secondary"
+                size="small"
+                onClick={handleOpenAddRequirementModal}
+                startIcon={<AddRounded />}
+                data-cy="new-requirement-button"
+              >
+                New Requirement
+              </Button>
+            </Box>
+          )}
       </Box>
       {isDataLoading ? (
         <RequirementLoading />

compliance-web/src/components/App/Inspections/Profile/Reports/ReportTopSection.tsx

@@ -339,7 +339,7 @@ export default function ReportTopSection() {
           </Box>
           {!isReportsReadOnly &&
             !isHistorical &&
-            !inspectionReportsData?.date_issued && (
+            inspectionReportsData?.is_open_for_editing && (
               <Box sx={{ display: "flex", alignItems: "center", gap: 0.5 }}>
                 <Typography variant="body2">Wrong Version?</Typography>
                 <Link

compliance-web/src/components/App/Inspections/Profile/Requirements/RequirementDrawer.tsx

@@ -34,6 +34,8 @@ import * as yup from "yup";
 import { useRequirementStore } from "./requirementStore";
 import { useQueryClient } from "@tanstack/react-query";
 import { MQ } from "@/styles/responsive";
+import { useReportStore } from "../Reports/reportStore";
+import { InspectionStatusEnum } from "@/utils/constants";
 
 type RequirementDrawerProps = {
   inspectionData: Inspection;
@@ -81,12 +83,16 @@ const RequirementDrawer: React.FC<RequirementDrawerProps> = ({
     restoreRequirementStoreFromSnapshot,
   } = useRequirementStore();
 
+  const { inspectionReportsData } = useReportStore();
+
   const { data: inspectionRequirementTypesList } =
     useInspectionRequirementTypesData();
 
   const isRequirementEditable = useMemo(
-    () => inspectionData?.inspection_status?.toLowerCase() === "open",
-    [inspectionData]
+    () =>
+      inspectionData?.inspection_status === InspectionStatusEnum.OPEN &&
+      inspectionReportsData?.is_open_for_editing,
+    [inspectionData, inspectionReportsData]
   );
 
   const GeneratedFormSchema = RequirementFormSchema(isRegulatoryConsideration);
@@ -114,7 +120,13 @@ const RequirementDrawer: React.FC<RequirementDrawerProps> = ({
       }
     );
   }, [inspectionRequirementData, resetForm, inspectionRequirementTypesList]);
-  const isInspectionClosed = useMemo(() => inspectionData?.inspection_status?.toLowerCase() === "closed", [inspectionData]);
+
+  const isInspectionClosed = useMemo(
+    () =>
+      inspectionData?.inspection_status === InspectionStatusEnum.CLOSED ||
+      !inspectionReportsData?.is_open_for_editing,
+    [inspectionData, inspectionReportsData]
+  );
   const onCreateSuccess = useCallback(() => {
     onSubmit("Requirement created successfully!", true);
     resetForm();

compliance-web/src/models/InspectionRecord.ts

@@ -24,6 +24,7 @@ export interface InspectionRecord {
   record_prepared_by_position_id?: number;
   record_prepared_by?: StaffUser;
   record_prepared_by_position?: Position;
+  is_open_for_editing?: boolean;
   field_change_info?: {
     inspection_scope_changed?: boolean;
     finding_statement_changed?: boolean;

compliance-web/src/routes/_authenticated/ce-database/inspections/$inspectionNumber.tsx

@@ -23,9 +23,11 @@ import {
   CR_CONTEXT_TYPE,
   DRAWER_WIDTHS,
   FILE_PROFILE_CONTEXT,
+  InspectionStatusEnum,
 } from "@/utils/constants";
 import InspectionEnforcements from "@/components/App/Inspections/Profile/InspectionEnforcements";
 import useResponsiveDrawerWidth from "@/hooks/useResponsiveDrawerWidth";
+import { useReportStore } from "@/components/App/Inspections/Profile/Reports/reportStore";
 
 export const Route = createFileRoute(
   "/_authenticated/ce-database/inspections/$inspectionNumber"
@@ -53,6 +55,7 @@ function InspectionProfilePage() {
     error,
     isLoading,
   } = useInspectionByNumber(inspectionNumber!);
+  const { inspectionReportsData } = useReportStore();
 
   const { data: caseFileData } = useCaseFileByNumber(
     inspectionData?.case_file.case_file_number ?? ""
@@ -71,9 +74,11 @@ function InspectionProfilePage() {
 
   const isInspectionEditable = useMemo(() => {
     return (
-      isUserEditAllowed && inspectionData?.inspection_status?.toLowerCase() === "open"
+      isUserEditAllowed &&
+      inspectionData?.inspection_status === InspectionStatusEnum.OPEN &&
+      inspectionReportsData?.is_open_for_editing
     );
-  }, [inspectionData, isUserEditAllowed]);
+  }, [inspectionData, isUserEditAllowed, inspectionReportsData]);
 
   // Event handlers
   const handleOnSubmit = useCallback(