Programme Cycle - Allow deletion of cycle only if no TP / PP linked

src/frontend/src/api/programCycleApi.ts

@@ -40,6 +40,7 @@ export interface ProgramCycle {
   total_delivered_quantity_usd: number;
   frequency_of_payments: string;
   admin_url?: string;
+  can_remove_cycle: boolean;
 }
 
 export const fetchProgramCycles = async (

src/frontend/src/components/paymentmodule/PaymentPlanDetails/SupportingDocumentsSection/SupportingDocumentsSection.tsx

@@ -1,41 +1,41 @@
-import ExpandLessIcon from '@mui/icons-material/ExpandLess';
-import ExpandMoreIcon from '@mui/icons-material/ExpandMore';
-import DownloadIcon from '@mui/icons-material/Download';
-import DeleteIcon from '@mui/icons-material/Delete';
-import { PaperContainer } from '@components/targeting/PaperContainer';
-import { hasPermissions, PERMISSIONS } from 'src/config/permissions';
+import {
+  deleteSupportingDocument,
+  uploadSupportingDocument,
+} from '@api/paymentModuleApi';
+import { useConfirmation } from '@components/core/ConfirmationDialog';
+import { DropzoneField } from '@components/core/DropzoneField';
+import { GreyBox } from '@components/core/GreyBox';
 import { GreyText } from '@components/core/GreyText';
 import { LoadingButton } from '@components/core/LoadingButton';
+import { BlueText } from '@components/grievances/LookUps/LookUpStyles';
+import { PaperContainer } from '@components/targeting/PaperContainer';
+import { DialogTitleWrapper } from '@containers/dialogs/DialogTitleWrapper';
+import { PaymentPlanQuery, PaymentPlanStatus } from '@generated/graphql';
+import { useBaseUrl } from '@hooks/useBaseUrl';
+import { usePermissions } from '@hooks/usePermissions';
+import { useSnackbar } from '@hooks/useSnackBar';
+import DeleteIcon from '@mui/icons-material/Delete';
+import DownloadIcon from '@mui/icons-material/Download';
+import ExpandLessIcon from '@mui/icons-material/ExpandLess';
+import ExpandMoreIcon from '@mui/icons-material/ExpandMore';
 import {
-  Typography,
-  IconButton,
+  Box,
+  Button,
   Collapse,
   Dialog,
-  DialogTitle,
-  TextField,
   DialogActions,
-  Button,
-  Box,
-  Grid,
   DialogContent,
+  DialogTitle,
   FormHelperText,
+  Grid,
+  IconButton,
+  TextField,
+  Typography,
 } from '@mui/material';
-import { useState } from 'react';
 import { useMutation } from '@tanstack/react-query';
-import { usePermissions } from '@hooks/usePermissions';
+import { useState } from 'react';
 import { useTranslation } from 'react-i18next';
-import { PaymentPlanQuery, PaymentPlanStatus } from '@generated/graphql';
-import { DropzoneField } from '@components/core/DropzoneField';
-import { DialogTitleWrapper } from '@containers/dialogs/DialogTitleWrapper';
-import {
-  deleteSupportingDocument,
-  uploadSupportingDocument,
-} from '@api/paymentModuleApi';
-import { useSnackbar } from '@hooks/useSnackBar';
-import { useBaseUrl } from '@hooks/useBaseUrl';
-import { useConfirmation } from '@components/core/ConfirmationDialog';
-import { GreyBox } from '@components/core/GreyBox';
-import { BlueText } from '@components/grievances/LookUps/LookUpStyles';
+import { hasPermissions, PERMISSIONS } from 'src/config/permissions';
 import { useDownloadSupportingDocument } from './SupportingDocumentsSectionActions';
 
 interface SupportingDocumentsSectionProps {

src/frontend/src/containers/tables/ProgramCycle/ProgramCyclesTableProgramDetails.tsx

@@ -1,6 +1,6 @@
 import { ProgramQuery, ProgramStatus } from '@generated/graphql';
 import { UniversalRestTable } from '@components/rest/UniversalRestTable/UniversalRestTable';
-import React, { ReactElement, useState } from 'react';
+import { ReactElement, useState } from 'react';
 import { ClickableTableRow } from '@core/Table/ClickableTableRow';
 import TableCell from '@mui/material/TableCell';
 import { UniversalMoment } from '@core/UniversalMoment';
@@ -34,6 +34,10 @@ export const ProgramCyclesTableProgramDetails = ({
   const canCreateProgramCycle =
     program.status === ProgramStatus.Active &&
     hasPermissions(PERMISSIONS.PM_PROGRAMME_CYCLE_CREATE, permissions);
+  const canDeleteProgramCycle = hasPermissions(
+    PERMISSIONS.PM_PROGRAMME_CYCLE_DELETE,
+    permissions,
+  );
 
   const { data, error, isLoading } = useQuery({
     queryKey: ['programCycles', businessArea, program.id, queryVariables],
@@ -46,13 +50,15 @@ export const ProgramCyclesTableProgramDetails = ({
 
   const renderRow = (row: ProgramCycle): ReactElement => {
     const detailsUrl = `/${baseUrl}/payment-module/program-cycles/${row.id}`;
+
     const canEditProgramCycle =
       (row.status === 'Draft' || row.status === 'Active') &&
       hasPermissions(PERMISSIONS.PM_PROGRAMME_CYCLE_UPDATE, permissions);
-    const canDeleteProgramCycle =
-      row.status === 'Draft' &&
-      data.results.length > 1 &&
-      hasPermissions(PERMISSIONS.PM_PROGRAMME_CYCLE_DELETE, permissions);
+
+    const hasPermissionToDelete = hasPermissions(
+      PERMISSIONS.PM_PROGRAMME_CYCLE_DELETE,
+      permissions,
+    );
     return (
       <ClickableTableRow key={row.id} data-cy="program-cycle-row">
         <TableCell data-cy="program-cycle-title">
@@ -100,7 +106,7 @@ export const ProgramCyclesTableProgramDetails = ({
                 <EditProgramCycle program={program} programCycle={row} />
               )}
 
-              {canDeleteProgramCycle && (
+              {row.can_remove_cycle && hasPermissionToDelete && (
                 <DeleteProgramCycle program={program} programCycle={row} />
               )}
             </>

src/hct_mis_api/apps/program/api/serializers.py

@@ -45,6 +45,7 @@ class ProgramCycleListSerializer(EncodedIdSerializerMixin):
     program_start_date = serializers.DateField(format="%Y-%m-%d")
     program_end_date = serializers.DateField(format="%Y-%m-%d")
     admin_url = serializers.SerializerMethodField()
+    can_remove_cycle = serializers.SerializerMethodField()
 
     class Meta:
         model = ProgramCycle
@@ -63,6 +64,7 @@ class Meta:
             "frequency_of_payments",
             "created_by",
             "admin_url",
+            "can_remove_cycle",
         )
 
     def get_created_by(self, obj: ProgramCycle) -> str:
@@ -74,6 +76,9 @@ def get_admin_url(self, obj: ProgramCycle) -> Optional[str]:
         user = self.context["request"].user
         return obj.admin_url if user.is_superuser else None
 
+    def get_can_remove_cycle(self, obj: ProgramCycle) -> bool:
+        return obj.can_remove_cycle
+
 
 class ProgramCycleCreateSerializer(EncodedIdSerializerMixin):
     title = serializers.CharField(required=True)

src/hct_mis_api/apps/program/models.py

@@ -347,6 +347,15 @@ def save(self, *args: Any, **kwargs: Any) -> None:
     def __str__(self) -> str:
         return f"{self.title} ({self.status})"
 
+    @property
+    def can_remove_cycle(self) -> bool:
+        return (
+            not self.target_populations.exists()
+            and not self.payment_plans.exists()
+            and self.program.cycles.count() > 1
+            and self.status == ProgramCycle.DRAFT
+        )
+
     @property
     def total_entitled_quantity_usd(self) -> Decimal:
         total_entitled = self.payment_plans.aggregate(total_entitled=Sum("total_entitled_quantity_usd"))[

tests/unit/apps/program/test_program_cycle.py

@@ -69,6 +69,7 @@ def test_set_active(self) -> None:
         self.cycle.set_active()
         self.cycle.refresh_from_db()
         self.assertEqual(self.cycle.status, ProgramCycle.ACTIVE)
+        self.assertFalse(self.cycle.can_remove_cycle)
 
     def test_set_draft(self) -> None:
         with self.assertRaisesMessage(ValidationError, "Program should be within Active status."):
@@ -88,6 +89,7 @@ def test_set_draft(self) -> None:
         self.cycle.set_draft()
         self.cycle.refresh_from_db()
         self.assertEqual(self.cycle.status, ProgramCycle.DRAFT)
+        self.assertTrue(self.cycle.can_remove_cycle)
 
     def test_set_finish(self) -> None:
         with self.assertRaisesMessage(ValidationError, "Program should be within Active status."):
@@ -105,6 +107,7 @@ def test_set_finish(self) -> None:
         self.cycle.set_finish()
         self.cycle.refresh_from_db()
         self.assertEqual(self.cycle.status, ProgramCycle.FINISHED)
+        self.assertFalse(self.cycle.can_remove_cycle)
 
     def test_total_entitled_quantity_usd(self) -> None:
         self.assertEqual(self.cycle.total_entitled_quantity_usd, Decimal("0.0"))

tests/unit/apps/program/test_program_cycle_rest_api.py

@@ -99,6 +99,16 @@ def test_list_program_cycles(self) -> None:
         cycles = ProgramCycle.objects.filter(program=self.program)
         self.assertEqual(int(response.data["count"]), cycles.count())
 
+        results = response.data["results"]
+        first_cycle = results[0]
+        second_cycle = results[1]
+        last_cycle = results[2]
+        # check can_remove_cycle
+        self.assertEqual(first_cycle["can_remove_cycle"], False)
+        self.assertEqual(second_cycle["can_remove_cycle"], False)
+        self.assertEqual(last_cycle["status"], "Draft")
+        self.assertEqual(last_cycle["can_remove_cycle"], True)
+
     def test_retrieve_program_cycle(self) -> None:
         self.client.force_authenticate(user=self.user)
         response = self.client.get(self.cycle_1_detail_url)