Merge pull request bcgov#139 from tom0827/ENGAGE-106

[ENGAGE-106] Ability to delete engagements

Author: tom0827

met-api/src/met_api/models/engagement.py

@@ -336,3 +336,14 @@ def get_assigned_engagements(user_id: int) -> List[Engagement]:
                 )) \
             .all()
         return engagements
+
+    @classmethod
+    def delete_engagement(cls, engagement_id: int) -> bool:
+        """Delete engagement."""
+        query = Engagement.query.filter_by(id=engagement_id)
+        record = query.first()
+        if not record:
+            return False
+        query.delete()
+        db.session.commit()
+        return True

met-api/src/met_api/resources/engagement.py

@@ -57,6 +57,19 @@ def get(engagement_id):
         except ValueError as err:
             return str(err), HTTPStatus.INTERNAL_SERVER_ERROR
 
+    @staticmethod
+    @cross_origin(origins=allowedorigins())
+    @_jwt.requires_auth
+    def delete(engagement_id):
+        """Delete the engagement associated with the provided id."""
+        try:
+            EngagementService().delete(engagement_id)
+            return {'message': 'Engagement deleted successfully'}, HTTPStatus.OK
+        except KeyError:
+            return 'Engagement was not found', HTTPStatus.NOT_FOUND
+        except ValueError as err:
+            return str(err), HTTPStatus.BAD_REQUEST
+
 
 @cors_preflight('GET, POST, PATCH, OPTIONS')
 @API.route('/')

met-api/src/met_api/services/engagement_service.py

@@ -326,3 +326,20 @@ def _get_dashboard_path(engagement: EngagementModel):
                 format(slug=engagement_slug.slug)
         return current_app.config.get('ENGAGEMENT_DASHBOARD_PATH'). \
             format(engagement_id=engagement.id)
+
+    @staticmethod
+    def delete(engagement_id: int) -> None:
+        """Delete engagement by id."""
+        authorization.check_auth(
+            one_of_roles=(
+                MembershipType.TEAM_MEMBER.name,
+                Role.CREATE_ADMIN_USER.value
+            ),
+            engagement_id=engagement_id
+        )
+        engagement = EngagementModel.find_by_id(engagement_id)
+
+        if not engagement:
+            raise ValueError('Engagement to delete was not found')
+
+        EngagementModel.delete_engagement(engagement_id)

met-web/src/apiManager/endpoints/index.ts

@@ -6,6 +6,7 @@ const Endpoints = {
         CREATE: `${AppConfig.apiUrl}/engagements/`,
         UPDATE: `${AppConfig.apiUrl}/engagements/`,
         GET: `${AppConfig.apiUrl}/engagements/engagement_id`,
+        DELETE: `${AppConfig.apiUrl}/engagements/engagement_id`,
     },
     EngagementMetadata: {
         CREATE: `${AppConfig.apiUrl}/engagementsmetadata/`,

met-web/src/components/admin/engagement/listing/ActionsDropDown.tsx

@@ -10,17 +10,25 @@ import { getFormsSheet } from 'services/FormCAC';
 import { openNotification } from 'services/notificationService/notificationSlice';
 import { formatToUTC } from 'utils/helpers/dateHelper';
 import { downloadFile } from 'utils';
+import { DeleteEngagementModal } from './DeleteEngagementModal';
 
 interface ActionDropDownItem {
     value: number;
     label: string;
     action?: () => void;
     condition?: boolean;
 }
-export const ActionsDropDown = ({ engagement }: { engagement: Engagement }) => {
+export const ActionsDropDown = ({
+    engagement,
+    onEngagementDeleted,
+}: {
+    engagement: Engagement;
+    onEngagementDeleted: (id: number) => void;
+}) => {
     const navigate = useNavigate();
     const dispatch = useAppDispatch();
     const [isExportingCacForms, setIsExportingCacForms] = useState(false);
+    const [deleteModalOpen, setDeleteModalOpen] = useState(false);
     const { roles, assignedEngagements } = useAppSelector((state) => state.user);
     const submissionHasBeenOpened = [SubmissionStatus.Open, SubmissionStatus.Closed].includes(
         engagement.submission_status,
@@ -89,6 +97,23 @@ export const ActionsDropDown = ({ engagement }: { engagement: Engagement }) => {
         }
     };
 
+    const canDeleteEngagement: boolean = useMemo(() => {
+        if (!roles.includes(USER_ROLES.CREATE_ADMIN_USER)) {
+            return false;
+        }
+
+        const today = new Date().toISOString().slice(0, 10);
+        if (engagement.engagement_status.id === EngagementStatus.Unpublished && today < engagement.start_date) {
+            return true;
+        }
+
+        return false;
+    }, [engagement.engagement_status.id, engagement.start_date, roles]);
+
+    const handleEngagementDeleted = () => {
+        onEngagementDeleted(engagement.id);
+    };
+
     const ITEMS: ActionDropDownItem[] = useMemo(
         () => [
             {
@@ -151,6 +176,14 @@ export const ActionsDropDown = ({ engagement }: { engagement: Engagement }) => {
                     (roles.includes(USER_ROLES.EXPORT_CAC_FORM_TO_SHEET) &&
                         assignedEngagements.includes(engagement.id)),
             },
+            {
+                value: 7,
+                label: 'Delete Engagement',
+                action: () => {
+                    setDeleteModalOpen(true);
+                },
+                condition: canDeleteEngagement,
+            },
         ],
         [engagement.id],
     );
@@ -160,21 +193,29 @@ export const ActionsDropDown = ({ engagement }: { engagement: Engagement }) => {
     }
 
     return (
-        <Select
-            id={`action-drop-down-${engagement.id}`}
-            value={0}
-            fullWidth
-            size="small"
-            sx={{ backgroundColor: 'white', color: Palette.info.main }}
-        >
-            <MenuItem value={0} sx={{ fontStyle: 'italic', height: '2em' }} color="info" disabled>
-                {'(Select One)'}
-            </MenuItem>
-            {ITEMS.filter((item) => item.condition).map((item) => (
-                <MenuItem key={item.value} value={item.value} onClick={item.action}>
-                    {item.label}
+        <>
+            <Select
+                id={`action-drop-down-${engagement.id}`}
+                value={0}
+                fullWidth
+                size="small"
+                sx={{ backgroundColor: 'white', color: Palette.info.main }}
+            >
+                <MenuItem value={0} sx={{ fontStyle: 'italic', height: '2em' }} color="info" disabled>
+                    {'(Select One)'}
                 </MenuItem>
-            ))}
-        </Select>
+                {ITEMS.filter((item) => item.condition).map((item) => (
+                    <MenuItem key={item.value} value={item.value} onClick={item.action}>
+                        {item.label}
+                    </MenuItem>
+                ))}
+            </Select>
+            <DeleteEngagementModal
+                open={deleteModalOpen}
+                onClose={() => setDeleteModalOpen(false)}
+                onDelete={handleEngagementDeleted}
+                engagement={engagement}
+            />
+        </>
     );
 };

met-web/src/components/admin/engagement/listing/DeleteEngagementModal.tsx

@@ -0,0 +1,75 @@
+import React from 'react';
+import { Modal, Paper, Grid, Stack } from '@mui/material';
+import { PrimaryButton, SecondaryButton } from 'components/shared/common';
+import { Engagement } from 'models/engagement';
+import { deleteEngagement } from 'services/engagementService';
+
+interface DeleteEngagementModalProps {
+    open: boolean;
+    onClose: () => void;
+    onDelete: () => void;
+    engagement: Engagement;
+}
+
+export const DeleteEngagementModal: React.FC<DeleteEngagementModalProps> = ({
+    open,
+    onClose,
+    onDelete,
+    engagement,
+}) => {
+    const [isDeleting, setIsDeleting] = React.useState(false);
+
+    const handleClose = () => {
+        onClose();
+    };
+
+    const onDeleteHandler = async () => {
+        try {
+            setIsDeleting(true);
+            await deleteEngagement(engagement.id);
+            setIsDeleting(false);
+            onDelete();
+            handleClose();
+        } catch (error) {
+            setIsDeleting(false);
+            console.error('Failed to delete engagement:', error);
+        }
+    };
+
+    return (
+        <Modal open={open} onClose={handleClose}>
+            <Paper
+                sx={{
+                    position: 'absolute',
+                    top: '50%',
+                    left: '50%',
+                    transform: 'translate(-50%, -50%)',
+                    p: 4,
+                    minWidth: 400,
+                }}
+            >
+                <Grid container spacing={2}>
+                    <Grid item xs={12}>
+                        <h2>Delete Engagement</h2>
+                    </Grid>
+
+                    <Grid item xs={12}>
+                        This will permanently delete <strong>{engagement.name}</strong> and cannot be undone. Do you
+                        want to continue?
+                    </Grid>
+
+                    <Grid item xs={12}>
+                        <Stack direction="row" spacing={1} justifyContent="flex-end">
+                            <SecondaryButton type="button" onClick={handleClose}>
+                                Cancel
+                            </SecondaryButton>
+                            <PrimaryButton type="button" onClick={onDeleteHandler} disabled={isDeleting}>
+                                {isDeleting ? 'Deleting...' : 'Delete'}
+                            </PrimaryButton>
+                        </Stack>
+                    </Grid>
+                </Grid>
+            </Paper>
+        </Modal>
+    );
+};

met-web/src/components/admin/engagement/listing/index.tsx

@@ -132,6 +132,10 @@ const EngagementListing = () => {
         });
     };
 
+    const handleEngagementDeleted = (engagementId: number) => {
+        setEngagements((prev) => prev.filter((e) => e.id !== engagementId));
+    };
+
     const headCells: HeadCell<Engagement>[] = [
         {
             key: 'name',
@@ -384,7 +388,7 @@ const EngagementListing = () => {
             label: 'Actions',
             allowSort: false,
             renderCell: (row: Engagement) => {
-                return <ActionsDropDown engagement={row} />;
+                return <ActionsDropDown engagement={row} onEngagementDeleted={handleEngagementDeleted} />;
             },
             customStyle: {
                 minWidth: '200px',

met-web/src/services/engagementService/index.ts

@@ -78,3 +78,8 @@ export const patchEngagement = async (data: PatchEngagementRequest): Promise<Eng
     }
     return Promise.reject('Failed to update engagement');
 };
+
+export const deleteEngagement = async (engagementId: number): Promise<void> => {
+    const url = replaceUrl(Endpoints.Engagement.DELETE, 'engagement_id', String(engagementId));
+    await http.DeleteRequest<void>(url);
+};