Merge pull request #3554 from LiteFarmOrg/LF-4528/Hide_Created_in_Err…

…or_option_for_animals_with_completed_Tasks LF-4528: Hide created in error option for animals with completed tasks
LiteFarmOrg · Dec 4, 2024 · ee6c16a · ee6c16a
2 parents fc62aaa + 0d60991
commit ee6c16a
Show file tree

Hide file tree

Showing 13 changed files with 70 additions and 17 deletions.
diff --git a/packages/api/src/controllers/animalBatchController.js b/packages/api/src/controllers/animalBatchController.js
@@ -34,6 +34,7 @@ const animalBatchController = {
             group_ids: true,
             sex_detail: true,
             animal_batch_use_relationships: true,
+            tasks: true,
           });
         return res.status(200).send(
           rows.map(({ animal_union_batch, group_ids, ...rest }) => ({

diff --git a/packages/api/src/controllers/animalController.js b/packages/api/src/controllers/animalController.js
@@ -37,6 +37,7 @@ const animalController = {
             animal_union_batch: true,
             group_ids: true,
             animal_use_relationships: true,
+            tasks: true,
           });
         return res.status(200).send(
           rows.map(({ animal_union_batch, group_ids, ...rest }) => ({

diff --git a/packages/api/src/models/animalBatchModel.js b/packages/api/src/models/animalBatchModel.js
@@ -176,6 +176,7 @@ class AnimalBatchModel extends baseModel {
           },
           to: 'task.task_id',
         },
+        modify: (query) => query.select('task.task_id').where('deleted', false),
       },
       default_type: {
         modelClass: DefaultAnimalTypeModel,

diff --git a/packages/api/src/models/animalModel.js b/packages/api/src/models/animalModel.js
@@ -170,6 +170,7 @@ class Animal extends baseModel {
           },
           to: 'task.task_id',
         },
+        modify: (query) => query.select('task.task_id').where('deleted', false),
       },
       default_type: {
         modelClass: DefaultAnimalTypeModel,

diff --git a/packages/api/tests/animal.test.js b/packages/api/tests/animal.test.js
@@ -186,12 +186,14 @@ describe('Animal Tests', () => {
           internal_identifier: res.body[0].internal_identifier,
           group_ids: [],
           animal_use_relationships: [],
+          tasks: [],
         }).toMatchObject(res.body[0]);
         expect({
           ...secondAnimal,
           internal_identifier: res.body[1].internal_identifier,
           group_ids: [],
           animal_use_relationships: [],
+          tasks: [],
         }).toMatchObject(res.body[1]);
       }
     });

diff --git a/packages/api/tests/animal_batch.test.js b/packages/api/tests/animal_batch.test.js
@@ -207,12 +207,14 @@ describe('Animal Batch Tests', () => {
           internal_identifier: 1,
           group_ids: [],
           animal_batch_use_relationships: [],
+          tasks: [],
         }).toMatchObject(res.body[0]);
         expect({
           ...secondAnimalBatch,
           internal_identifier: 2,
           group_ids: [],
           animal_batch_use_relationships: [],
+          tasks: [],
         }).toMatchObject(res.body[1]);
       }
     });

diff --git a/packages/webapp/src/components/Animals/RemoveAnimalsModal/index.tsx b/packages/webapp/src/components/Animals/RemoveAnimalsModal/index.tsx
@@ -12,7 +12,7 @@
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  *  GNU General Public License for more details, see <https://www.gnu.org/licenses/>.
  */
-import { useEffect, useMemo } from 'react';
+import { useMemo } from 'react';
 import Drawer from '../../Drawer';
 import Button from '../../Form/Button';
 import ReactSelect from '../../Form/ReactSelect';
@@ -24,7 +24,6 @@ import Input, { getInputErrors } from '../../Form/Input';
 import { ReactComponent as WarningIcon } from '../../../assets/images/warning.svg';
 import { ReactComponent as CheckIcon } from '../../../assets/images/check-circle.svg';
 import { useTranslation } from 'react-i18next';
-import { ClassNamesConfig } from 'react-select';
 import { getLocalDateInYYYYDDMM } from '../../../util/date';
 import { useGetAnimalRemovalReasonsQuery } from '../../../store/api/apiSlice';
 import type { AnimalRemovalReasonKeys } from '../../../store/api/types';
@@ -54,6 +53,7 @@ type RemoveAnimalsModalProps = {
   onClose: () => void;
   onConfirm: SubmitHandler<FormFields>;
   showSuccessMessage: boolean;
+  hideDeleteOption?: boolean;
 };
 
 export default function RemoveAnimalsModal(props: RemoveAnimalsModalProps) {
@@ -62,7 +62,6 @@ export default function RemoveAnimalsModal(props: RemoveAnimalsModalProps) {
     handleSubmit,
     control,
     watch,
-    reset,
     formState: { errors, isValid },
   } = useForm<FormFields>({
     mode: 'onChange',
@@ -110,10 +109,14 @@ export default function RemoveAnimalsModal(props: RemoveAnimalsModalProps) {
       label: t('common:OTHER'),
       value: RemovalReasons.OTHER,
     },
-    {
-      label: t('REMOVE_ANIMALS.CREATED_IN_ERROR'),
-      value: RemovalReasons.CREATED_IN_ERROR,
-    },
+    ...(props.hideDeleteOption
+      ? []
+      : [
+          {
+            label: t('REMOVE_ANIMALS.CREATED_IN_ERROR'),
+            value: RemovalReasons.CREATED_IN_ERROR,
+          },
+        ]),
   ];
 
   const selectedOption = watch(REASON);

diff --git a/packages/webapp/src/containers/Animals/Inventory/index.tsx b/packages/webapp/src/containers/Animals/Inventory/index.tsx
@@ -279,10 +279,8 @@ export default function AnimalInventory({
     [updateSelectedTypeIds],
   );
 
-  const { onConfirmRemoveAnimals, removalModalOpen, setRemovalModalOpen } = useAnimalOrBatchRemoval(
-    selectedInventoryIds,
-    setSelectedInventoryIds,
-  );
+  const { onConfirmRemoveAnimals, removalModalOpen, setRemovalModalOpen, hasFinalizedTasks } =
+    useAnimalOrBatchRemoval(selectedInventoryIds, inventory, setSelectedInventoryIds);
 
   const animalsColumns = useMemo(
     () => [
@@ -463,6 +461,7 @@ export default function AnimalInventory({
         onClose={() => setRemovalModalOpen(false)}
         onConfirm={onConfirmRemoveAnimals}
         showSuccessMessage={false}
+        hideDeleteOption={hasFinalizedTasks}
       />
     </>
   );

diff --git a/packages/webapp/src/containers/Animals/Inventory/useAnimalInventory.tsx b/packages/webapp/src/containers/Animals/Inventory/useAnimalInventory.tsx
@@ -62,6 +62,7 @@ export type AnimalInventory = {
   custom_breed_id: number | null;
   default_breed_id: number | null;
   location_id?: string | null;
+  tasks: Animal['tasks'];
 };
 
 const { t } = i18n;
@@ -172,6 +173,7 @@ const formatAnimalsData = (
         custom_breed_id: animal.custom_breed_id,
         default_breed_id: animal.default_breed_id,
         location_id: animal.location_id,
+        tasks: animal.tasks,
       };
     });
 };
@@ -211,6 +213,7 @@ const formatAnimalBatchesData = (
         custom_breed_id: batch.custom_breed_id,
         default_breed_id: batch.default_breed_id,
         location_id: batch.location_id,
+        tasks: batch.tasks,
       };
     });
 };

diff --git a/packages/webapp/src/containers/Animals/Inventory/useAnimalOrBatchRemoval.ts b/packages/webapp/src/containers/Animals/Inventory/useAnimalOrBatchRemoval.ts
@@ -13,7 +13,7 @@
  *  GNU General Public License for more details, see <https://www.gnu.org/licenses/>.
  */
 
-import { Dispatch, SetStateAction, useState } from 'react';
+import { Dispatch, SetStateAction, useState, useCallback, useMemo } from 'react';
 import {
   useDeleteAnimalBatchesMutation,
   useDeleteAnimalsMutation,
@@ -26,15 +26,20 @@ import { CREATED_IN_ERROR_ID, FormFields } from '../../../components/Animals/Rem
 import useMutations from '../../../hooks/api/useMutations';
 import { enqueueErrorSnackbar, enqueueSuccessSnackbar } from '../../Snackbar/snackbarSlice';
 import { AnimalOrBatchKeys } from '../types';
-import { useDispatch } from 'react-redux';
+import { useDispatch, useSelector } from 'react-redux';
 import { useTranslation } from 'react-i18next';
+import { completedTasksSelector, abandonedTasksSelector } from '../../taskSlice';
+import { Animal } from '../../../store/api/types';
 
 const useAnimalOrBatchRemoval = (
   selectedInventoryIds: string[],
+  animalTasksWithInventoryIds: { id: string; tasks: Animal['tasks'] }[],
   setSelectedInventoryIds?: Dispatch<SetStateAction<string[]>>,
 ) => {
   const dispatch = useDispatch();
   const { t } = useTranslation(['message']);
+  const completedTasks = useSelector(completedTasksSelector) || [];
+  const abandonedTasks = useSelector(abandonedTasksSelector) || [];
 
   const { mutations } = useMutations([
     { label: 'deleteAnimals', hook: useDeleteAnimalsMutation },
@@ -164,7 +169,35 @@ const useAnimalOrBatchRemoval = (
     }
   };
 
-  return { onConfirmRemoveAnimals, removalModalOpen, setRemovalModalOpen };
+  const getFinalizedTaskIdsSet = useCallback(() => {
+    return new Set([...completedTasks, ...abandonedTasks].map(({ task_id }) => task_id));
+  }, [completedTasks, abandonedTasks]);
+
+  const hasFinalizedTasks = useMemo(() => {
+    if (!removalModalOpen) {
+      return false;
+    }
+
+    const selectedInventoryIdsSet = new Set(selectedInventoryIds);
+    const finalizedTaskIdsSet = getFinalizedTaskIdsSet();
+
+    let inventoryFoundCount = 0;
+    for (let { id, tasks } of animalTasksWithInventoryIds) {
+      if (selectedInventoryIdsSet.has(id)) {
+        inventoryFoundCount++;
+
+        if (tasks.some(({ task_id }) => finalizedTaskIdsSet.has(task_id))) {
+          return true;
+        }
+      }
+      // Stop iterating once all selected inventory IDs have been processed.
+      if (inventoryFoundCount === selectedInventoryIdsSet.size) {
+        return false;
+      }
+    }
+  }, [removalModalOpen, completedTasks, abandonedTasks, selectedInventoryIds]);
+
+  return { onConfirmRemoveAnimals, removalModalOpen, setRemovalModalOpen, hasFinalizedTasks };
 };
 
 export default useAnimalOrBatchRemoval;
diff --git a/packages/webapp/src/containers/Animals/SingleAnimalView/index.tsx b/packages/webapp/src/containers/Animals/SingleAnimalView/index.tsx
@@ -179,9 +179,11 @@ function SingleAnimalView({ isCompactSideMenu, history, match, location }: AddAn
     return generateInventoryId(animalOrBatch, (selectedAnimal || selectedBatch)!);
   };
 
-  const { onConfirmRemoveAnimals, removalModalOpen, setRemovalModalOpen } = useAnimalOrBatchRemoval(
-    [getInventoryId()],
-  );
+  const { onConfirmRemoveAnimals, removalModalOpen, setRemovalModalOpen, hasFinalizedTasks } =
+    useAnimalOrBatchRemoval(
+      [getInventoryId()],
+      [{ ...(selectedAnimal || selectedBatch)!, id: getInventoryId() }],
+    );
 
   const onConfirmRemoval = async (formData: FormFields) => {
     const result = await onConfirmRemoveAnimals(formData);
@@ -241,6 +243,7 @@ function SingleAnimalView({ isCompactSideMenu, history, match, location }: AddAn
           onClose={() => setRemovalModalOpen(false)}
           onConfirm={onConfirmRemoval}
           showSuccessMessage={false}
+          hideDeleteOption={hasFinalizedTasks}
         />
       </FixedHeaderContainer>
     </div>

diff --git a/packages/webapp/src/store/api/types/index.ts b/packages/webapp/src/store/api/types/index.ts
@@ -54,6 +54,7 @@ export interface Animal {
   removal_explanation: string | null;
   removal_date: string | null;
   location_id: string | null;
+  tasks: { task_id: number }[];
   type_name?: string; // request only
   breed_name?: string; // request only
 }
@@ -94,6 +95,7 @@ export interface AnimalBatch {
   removal_explanation: string | null;
   removal_date: string | null;
   location_id: string | null;
+  tasks: { task_id: number }[];
   type_name?: string; // request only
   breed_name?: string; // request only
 }

diff --git a/packages/webapp/src/stories/Animals/mockData.ts b/packages/webapp/src/stories/Animals/mockData.ts
@@ -77,6 +77,7 @@ export const mockAnimal1: Animal = {
   internal_identifier: 12,
   group_ids: [],
   location_id: 'xxxxx',
+  tasks: [],
 };
 
 export const mockAnimal2: Animal = {
@@ -120,4 +121,5 @@ export const mockBatch1: AnimalBatch = {
     { sex_id: 2, count: 40 },
   ],
   location_id: 'xxxxx',
+  tasks: [],
 };