[MDS-6328] - Select permit document to extract conditions from 🍰 (#3389)

* Add permit document selection modal for condition extraction

Enhanced the extraction process by introducing a modal to select specific permit amendment documents when multiple are available.

* Add tests and snapshot for PermitConditionsSelectDocumentModal

* update snaps

* update snaps

* remove console log and simplify column

* fixed re-extraction after delete.  Added table styling.

* update snap

Author: matbusby-fw

services/common/src/redux/slices/permitServiceSlice.ts

@@ -15,6 +15,7 @@ export enum PermitExtractionStatus {
   in_progress = "In Progress",
   complete = "Extraction Complete",
   error = "Error Extracting",
+  deleted = "Deleted",
 }
 
 const permitExtractionStatusMap = {

services/common/src/tests/mocks/dataMocks.tsx

@@ -1392,6 +1392,17 @@ export const PERMITS: IPermit[] = [
             preamble_title: "Preamble Title",
             preamble_date: "2019-04-02",
           },
+          {
+            permit_id: 1,
+            mine_guid: "8e9ca839-a28e-427e-997e-9ef23d9d97cd",
+            permit_amendment_document_guid: "31204ba5-5207-4fb5-b6c3-d47e55a0971b",
+            document_name: "Adams_amendment_2.pdf",
+            document_manager_guid: "64caef0e-060d-4875-a470-6c225b242723",
+            active_ind: true,
+            preamble_author: "Preamble Author",
+            preamble_title: "Preamble Title",
+            preamble_date: "2019-04-02",
+          },
         ],
       },
       {

services/core-api/app/api/mines/permits/permit_extraction/resources/permit_condition_extraction_resource.py

@@ -122,6 +122,12 @@ def delete(self):
         PermitConditions.delete_all_by_permit_amendment_id(args['permit_amendment_id'], commit=True)
         PermitConditionCategory.delete_all_by_permit_amendment_id(args['permit_amendment_id'])
 
+        permit_amendment = PermitAmendment.find_by_permit_amendment_id(args['permit_amendment_id'])
+        permit_extraction_tasks = PermitExtractionTask.get_by_permit_amendment_guid(permit_amendment.permit_amendment_guid)
+        if permit_extraction_tasks:
+            permit_extraction_tasks[0].task_status = 'Deleted'
+            permit_extraction_tasks[0].save()
+
 
 class PermitConditionExtractionProgressResource(Resource, UserMixin):
     api.doc('Returns the status of the permit extraction task')

services/core-web/src/components/mine/Permit/PermitConditionsSelectDocumentModal.tsx

@@ -0,0 +1,51 @@
+import { IPermitAmendmentDocument } from "@mds/common/interfaces";
+import React, { FC } from "react";
+import CoreTable from "@mds/common/components/common/CoreTable";
+import {
+  renderDateColumn,
+  renderTextColumn,
+} from "@mds/common/components/common/CoreTableCommonColumns";
+import { Button, Typography } from "antd";
+import { documentNameColumn } from "@mds/common/components/documents/DocumentColumns";
+
+const { Title, Paragraph } = Typography;
+
+interface PermitConditionsSelectDocumentModalProps {
+  documents: IPermitAmendmentDocument[];
+  onSubmit: (document: IPermitAmendmentDocument) => void;
+}
+
+const PermitConditionsSelectDocumentModal: FC<PermitConditionsSelectDocumentModalProps> = ({
+  documents,
+  onSubmit,
+}) => {
+  return (
+    <div>
+      <Title>Extract Permit Conditions</Title>
+      <Paragraph>Select the permit for permit condition extraction.</Paragraph>
+      <CoreTable
+        rowKey="document_manager_guid"
+        dataSource={documents}
+        columns={[
+          documentNameColumn("document_name", "File Name"),
+          renderTextColumn("create_user", "Created By"),
+          renderDateColumn("create_timestamp", "Uploaded"),
+          {
+            key: "action",
+            className: "actions-column",
+            width: 0,
+            render: (record: IPermitAmendmentDocument) => {
+              return (
+                <Button type="primary" onClick={() => onSubmit(record)}>
+                  Extract
+                </Button>
+              );
+            },
+          },
+        ]}
+      />
+    </div>
+  );
+};
+
+export default PermitConditionsSelectDocumentModal;

services/core-web/src/components/mine/Permit/ViewPermit.tsx

@@ -5,7 +5,7 @@ import {
   getLatestAmendmentByPermitGuid,
   getPermitByGuid,
 } from "@mds/common/redux/selectors/permitSelectors";
-import { IMine, IPermit, IPermitAmendment } from "@mds/common/interfaces";
+import { IMine, IPermit, IPermitAmendment, IPermitAmendmentDocument } from "@mds/common/interfaces";
 import ViewPermitOverview from "@/components/mine/Permit/ViewPermitOverview";
 import PermitConditions from "@/components/mine/Permit/PermitConditions";
 
@@ -30,6 +30,8 @@ import {
 import { userHasRole } from "@mds/common/redux/selectors/authenticationSelectors";
 import { USER_ROLES } from "@mds/common/constants/environment";
 import { PERMIT_CONDITION_STATUS_CODE } from "@mds/common/constants/enums";
+import { closeModal, openModal } from "@mds/common/redux/actions/modalActions";
+import PermitConditionsSelectDocumentModal from "@/components/mine/Permit/PermitConditionsSelectDocumentModal";
 
 const tabs = ["overview", "conditions"];
 
@@ -60,13 +62,14 @@ const ViewPermit: FC = () => {
   const [pollForStatus, setPollForStatus] = useState(false);
 
   const hasConditions = latestAmendment?.conditions?.length > 0;
-  const isReviewComplete = latestAmendment?.conditions?.every((con) => con.permit_condition_status_code === PERMIT_CONDITION_STATUS_CODE.COM);
-
+  const isReviewComplete = latestAmendment?.conditions?.every(
+    (con) => con.permit_condition_status_code === PERMIT_CONDITION_STATUS_CODE.COM
+  );
 
   const canStartExtraction =
-    ((documents.length > 0 && !permitExtraction?.status) ||
-      [PermitExtractionStatus.error, PermitExtractionStatus.not_started].includes(
-        permitExtraction?.status
+    ((documents.length > 0 && !permitExtraction?.task_status) ||
+      [PermitExtractionStatus.error, PermitExtractionStatus.not_started, PermitExtractionStatus.deleted].includes(
+        permitExtraction?.task_status
       )) &&
     !hasConditions;
 
@@ -167,7 +170,35 @@ const ViewPermit: FC = () => {
 
   const onConditionsTab = tab === tabs[1];
 
+  const handleSelectedDocumentExtraction = async (document: IPermitAmendmentDocument) => {
+    dispatch(closeModal());
+    await dispatch(
+      initiatePermitExtraction({
+        permit_amendment_id: latestAmendment?.permit_amendment_id,
+        permit_amendment_document_guid: document.permit_amendment_document_guid,
+      })
+    );
+  };
+
+  const handleOpenFileSelectionModal = () => {
+    dispatch(
+      openModal({
+        props: {
+          title: `Extract Permit Conditions`,
+          documents: documents,
+          onSubmit: handleSelectedDocumentExtraction,
+        },
+        content: PermitConditionsSelectDocumentModal,
+      })
+    );
+  };
+
   const handleInitiateExtraction = async () => {
+    if (documents.length > 1) {
+      handleOpenFileSelectionModal();
+      return;
+    }
+
     await dispatch(
       initiatePermitExtraction({
         permit_amendment_id: latestAmendment?.permit_amendment_id,
@@ -186,22 +217,23 @@ const ViewPermit: FC = () => {
 
   const headerActions = [
     onConditionsTab &&
-    userCanEditConditions && {
-      key: "extract",
-      label: "Extract Permit Conditions",
-      disabled: !canStartExtraction,
-      clickFunction: handleInitiateExtraction,
-    },
+      userCanEditConditions && {
+        key: "extract",
+        label: "Extract Permit Conditions",
+        disabled: !canStartExtraction,
+        clickFunction: handleInitiateExtraction,
+      },
     onConditionsTab &&
-    userCanEditConditions && {
-      key: "delete_conditions",
-      label: "Delete Permit Conditions",
-      disabled: !hasConditions,
-      clickFunction: handleDeleteConditions,
-    },
+      userCanEditConditions && {
+        key: "delete_conditions",
+        label: "Delete Permit Conditions",
+        disabled: !hasConditions,
+        clickFunction: handleDeleteConditions,
+      },
   ].filter(Boolean);
 
-  const showHeaderActions = !is_generated_in_core && enablePermitConditionsTab && headerActions.length > 0;
+  const showHeaderActions =
+    !is_generated_in_core && enablePermitConditionsTab && headerActions.length > 0;
 
   const headerActionComponent = showHeaderActions ? (
     <ActionMenuButton actions={headerActions} />

services/core-web/src/styles/components/Tables.scss

@@ -207,4 +207,10 @@ td.ant-table-cell {
   &:focus {
     background-color: $disabled-grey !important;
   }
+}
+
+// actions menu
+.actions-column {
+  text-align: right;
+  width: 0; // effectively "fit-content"
 }

services/core-web/src/tests/components/mine/Permit/PermitConditionsSelectDocumentModal.spec.tsx

@@ -0,0 +1,45 @@
+import React from "react";
+import { render } from "@testing-library/react";
+import * as MOCK from "@mds/common/tests/mocks/dataMocks";
+import { ReduxWrapper } from "@mds/common/tests/utils/ReduxWrapper";
+import { AUTHENTICATION, MINES, PERMITS, STATIC_CONTENT } from "@mds/common/constants/reducerTypes";
+import { USER_ROLES } from "@mds/common/constants/environment";
+import { BrowserRouter } from "react-router-dom";
+import PermitConditionsSelectDocumentModal from "@/components/mine/Permit/PermitConditionsSelectDocumentModal";
+
+const initialState = {
+  [PERMITS]: { permits: MOCK.PERMITS, permitAmendments: MOCK.PERMIT_AMENDMENT_STATE },
+  [MINES]: { mines: MOCK.MINES.mines },
+  [AUTHENTICATION]: {
+    userAccessData: [USER_ROLES.role_admin, USER_ROLES.role_edit_template_conditions],
+  },
+  [STATIC_CONTENT]: {
+    ...MOCK.BULK_STATIC_CONTENT_RESPONSE,
+  },
+};
+
+function mockFunction() {
+  const original = jest.requireActual("react-router-dom");
+  return {
+    ...original,
+    useParams: jest.fn().mockReturnValue({
+      id: MOCK.MINES.mineIds[0],
+      permitGuid: MOCK.PERMITS[0].permit_guid,
+    }),
+  };
+}
+
+jest.mock("react-router-dom", () => mockFunction());
+
+describe("PermitConditionsSelectDocumentModal", () => {
+  it("renders properly", () => {
+    const { container } = render(
+      <ReduxWrapper initialState={initialState}>
+        <BrowserRouter>
+          <PermitConditionsSelectDocumentModal documents={MOCK.PERMITS[0].permit_amendments[0].related_documents} onSubmit={jest.fn()}/>
+        </BrowserRouter>
+      </ReduxWrapper>
+    );
+    expect(container.firstChild).toMatchSnapshot();
+  });
+});