front: create exception when train is duplicate

Signed-off-by: theocrsb <theo_crosbie@yahoo.fr>

Author: theocrsb

front/src/applications/operationalStudies/views/Scenario/components/ManageTimetableItem/CreateTimetableItemButton.tsx

@@ -63,13 +63,42 @@ const CreateTimetableItemButton = ({
         await createPacedTrains(dispatch, sandboxId, [newTrainSchedulePayload])
       )[0];
 
+      let timetableItemToUpsert = formattedNewTrainSchedule;
+
       if (updatedExceptions.length > 0) {
-        await createExceptions(
+        const newExceptions = await createExceptions(
           dispatch,
           updatedExceptions,
           formattedNewTrainSchedule.id,
           timetableId
         );
+
+        // TODO : remove this part when the back will be done inserting the new exception format in TrainSchedule
+        const formattedExceptions = newExceptions.map((exceptionNewModel) => {
+          const {
+            change_groups,
+            train_schedule_id: _train_schedule_id,
+            timetable_id: _timetable_id,
+            ...restExceptions
+          } = exceptionNewModel;
+          return {
+            ...change_groups,
+            ...restExceptions,
+            // TODO: drop this when drop key in the model
+            key: restExceptions.key ?? restExceptions.id.toString(),
+          };
+        });
+
+        // Add the new exceptions to the timetable item so they contain their new exception ids
+        timetableItemToUpsert = {
+          ...formattedNewTrainSchedule,
+          ...(formattedNewTrainSchedule.paced && {
+            paced: {
+              ...formattedNewTrainSchedule.paced,
+              exceptions: formattedExceptions,
+            },
+          }),
+        };
       }
 
       dispatch(
@@ -81,7 +110,7 @@ const CreateTimetableItemButton = ({
       if (simulationConf.editingItemType === 'pacedTrain') {
         dispatch(clearAddedExceptionsList());
       }
-      upsertTimetableItems([formattedNewTrainSchedule]);
+      upsertTimetableItems([timetableItemToUpsert]);
     } catch (e) {
       dispatch(setFailure(castErrorToFailure(e)));
     } finally {

front/src/applications/operationalStudies/views/Scenario/components/ManageTimetableItem/helpers/__tests__/formatTimetableItemPayload.spec.ts

@@ -200,8 +200,11 @@ describe('formatTimetableItemPayload', () => {
         ...rawOsrdconf,
         ...userChanges,
       };
-      const result = formatPacedTrainPayload(osrdconfWithUserChanges, rollingStockName);
-      expect(result).toEqual({
+      const { newTrainSchedulePayload } = formatPacedTrainPayload(
+        osrdconfWithUserChanges,
+        rollingStockName
+      );
+      expect(newTrainSchedulePayload).toEqual({
         category: {
           main_category: 'FREIGHT_TRAIN',
         },
@@ -299,12 +302,12 @@ describe('formatTimetableItemPayload', () => {
             },
           },
         };
-        const result = formatPacedTrainPayload(
+        const { newTrainSchedulePayload } = formatPacedTrainPayload(
           osrdconfWithUserChanges,
           rollingStockName,
           itemDataWithPREVIOUSLYAddedException
         );
-        expect(result).toEqual({
+        expect(newTrainSchedulePayload).toEqual({
           category: {
             main_category: 'FREIGHT_TRAIN',
           },

front/src/applications/operationalStudies/views/Scenario/components/ManageTimetableItem/helpers/formatTimetableItemPayload.ts

@@ -133,6 +133,7 @@ export function formatPacedTrainPayload(
     paced: {
       time_window: osrdconf.timeWindow.toISOString(),
       interval: osrdconf.interval.toISOString(),
+      // TODO: remove exceptions when the migration is done
       exceptions,
     },
   };
@@ -180,6 +181,7 @@ export function formatPacedTrainPayload(
       // with only its exceptions updated
       newPacedTrain = {
         ...originalPacedTrain,
+        // TODO: remove exceptions when the migration is done
         paced: { ...originalPacedTrain.paced, exceptions: updatedExceptions },
       };
       // ========== user modified the whole paced train ==========
@@ -204,6 +206,7 @@ export function formatPacedTrainPayload(
 
       newPacedTrain = {
         ...newPacedTrain,
+        // TODO: remove exceptions when the migration is done
         paced: { ...newPacedTrain.paced, exceptions: newExceptionList },
       };
     }

front/src/applications/operationalStudies/views/Scenario/components/Timetable/CalendarTrainList.tsx

@@ -60,7 +60,7 @@ const CalendarTrainList = ({
 }: CalendarTrainListProps) => {
   const dateTimeLocale = useDateTimeLocale();
 
-  const { workerStatus } = useScenarioContext();
+  const { workerStatus, timetableId } = useScenarioContext();
   const subCategories = useSubCategoryContext();
 
   const [expandedTimetableItemIds, setExpandedTimetableItemIds] = useState<Set<TimetableItemId>>(
@@ -183,6 +183,7 @@ const CalendarTrainList = ({
               isSelectMode={isSelectMode}
               moveTimetableItem={() => moveTimetableItem?.([timetableItem.id])}
               showMovebutton={timetableMode === 'trainScheduleSet'}
+              timetableId={timetableId}
             />
           )}
         </div>

front/src/applications/operationalStudies/views/Scenario/components/Timetable/PacedTrain/OccurrenceIndicator.tsx

@@ -42,9 +42,11 @@ const OccurrenceIndicator = ({ occurrence, subCategories }: OccurrenceIndicatorP
 
   const categoryValue = occurrence.category;
 
+  const exceptionChangeGroups = occurrence.exception?.exceptionChangeGroups;
+
   const displayedChangeGroups =
-    occurrence.exceptionChangeGroups &&
-    Object.entries(occurrence.exceptionChangeGroups)
+    exceptionChangeGroups &&
+    Object.entries(exceptionChangeGroups)
       .filter(([_, isPresent]) => isPresent !== null)
       .map(([changeGroup]) => changeGroup as keyof ExceptionChangeGroups)
       .map((changeGroup) => {
@@ -95,7 +97,7 @@ const OccurrenceIndicator = ({ occurrence, subCategories }: OccurrenceIndicatorP
         setIsHovering(false);
       }}
     >
-      {isHovering && (occurrence.disabled || !isEmpty(occurrence.exceptionChangeGroups)) && (
+      {isHovering && (occurrence.disabled || !isEmpty(exceptionChangeGroups)) && (
         <OSRDTooltip
           containerRef={dotRef}
           header={tooltipHeader()}
@@ -105,7 +107,7 @@ const OccurrenceIndicator = ({ occurrence, subCategories }: OccurrenceIndicatorP
       )}
       <span
         className={cx('icon', getTrainCategoryClassName(occurrence.category, 'bg'), {
-          exception: !isEmpty(occurrence.exceptionChangeGroups),
+          exception: !isEmpty(exceptionChangeGroups),
           disabled: occurrence.disabled,
         })}
         style={{

front/src/applications/operationalStudies/views/Scenario/components/Timetable/PacedTrain/OccurrenceItem.tsx

@@ -93,8 +93,8 @@ const OccurrenceItem = ({
 
   const trainIdUsedForProjection = useSelector(getTrainIdUsedForProjection);
 
-  const { trainName, rollingStock, startTime, disabled, exceptionChangeGroups, summary } =
-    occurrence;
+  const { trainName, rollingStock, startTime, disabled, exception, summary } = occurrence;
+  const exceptionChangeGroups = exception?.exceptionChangeGroups;
 
   let arrivalTime: Date | undefined;
   let isAfterMidnight = false;

front/src/applications/operationalStudies/views/Scenario/components/Timetable/PacedTrain/PacedTrainItem.tsx

@@ -23,6 +23,7 @@ import { useRollingStockContext } from 'common/RollingStockContext';
 import isMainCategory from 'modules/rollingStock/helpers/category';
 import { getOccurrencesWorstStatus } from 'modules/timetableItem/helpers/pacedTrain';
 import {
+  createExceptions,
   createPacedTrains,
   deleteTrainSchedules,
   storePacedTrain,
@@ -82,6 +83,7 @@ type PacedTrainItemProps = {
   isSelectMode: boolean;
   moveTimetableItem: () => void;
   showMovebutton: boolean;
+  timetableId: number;
 };
 
 const PacedTrainItem = ({
@@ -102,6 +104,7 @@ const PacedTrainItem = ({
   isSelectMode,
   moveTimetableItem,
   showMovebutton,
+  timetableId,
 }: PacedTrainItemProps) => {
   const { editedElementContainer } = useContext(EditedElementContainerContext);
   const { t } = useTranslation('operational-studies', { keyPrefix: 'main' });
@@ -220,10 +223,54 @@ const PacedTrainItem = ({
       train_name: pacedTrainName,
     };
 
+    // We don't want to send summary to create exceptions
+    const payloadExceptions = pacedTrain.paced?.exceptions.map((exception) => {
+      const { summary: _summary, ...changeGroups } = exception;
+      return changeGroups;
+    });
+
     const formattedPacedTrainResponse: TimetableItem = (
       await createPacedTrains(dispatch, pacedTrainDetail.train_schedule_set_id, [newPacedTrain])
     )[0];
-    upsertTimetableItems([formattedPacedTrainResponse]);
+
+    const newExceptions =
+      payloadExceptions.length > 0
+        ? await createExceptions(
+            dispatch,
+            payloadExceptions,
+            formattedPacedTrainResponse.id,
+            timetableId
+          )
+        : [];
+
+    // TODO : remove this part when the back will be done inserting the new exception format in TrainSchedule
+    const formattedExceptions = newExceptions.map((exceptionNewModel) => {
+      const {
+        change_groups,
+        train_schedule_id: _train_schedule_id,
+        timetable_id: _timetable_id,
+        ...restExceptions
+      } = exceptionNewModel;
+      return {
+        ...change_groups,
+        ...restExceptions,
+        // TODO: drop this when drop key in the model
+        key: restExceptions.key ?? restExceptions.id.toString(),
+      };
+    });
+
+    // We add the new exceptions to the duplicate paced train, so they contain their new exception ids
+    upsertTimetableItems([
+      {
+        ...formattedPacedTrainResponse,
+        ...(formattedPacedTrainResponse.paced && {
+          paced: {
+            ...formattedPacedTrainResponse.paced,
+            exceptions: formattedExceptions,
+          },
+        }),
+      },
+    ]);
     dispatch(
       setSuccess({
         title: t('timetable.pacedTrainAdded'),

front/src/applications/operationalStudies/views/Scenario/components/Timetable/PacedTrain/hooks/useOccurrences.ts

@@ -66,9 +66,20 @@ const useOccurrences = (
           ? correspondingException.rolling_stock_category.value
           : pacedTrainCategory,
         occurrenceIndex: i,
-        exceptionChangeGroups: correspondingException
-          ? omit(correspondingException, ['key', 'occurrence_index', 'disabled', 'id', 'summary'])
-          : undefined,
+        exception:
+          correspondingException && correspondingException.id
+            ? {
+                id: correspondingException.id,
+                exceptionChangeGroups: omit(correspondingException, [
+                  'key',
+                  'occurrence_index',
+                  'disabled',
+                  'summary',
+                  'id',
+                ]),
+              }
+            : undefined,
+
         summary: correspondingException?.summary ?? summary,
       });
     }
@@ -98,13 +109,20 @@ const useOccurrences = (
         category: exception.rolling_stock_category
           ? exception.rolling_stock_category.value
           : pacedTrainCategory,
-        exceptionChangeGroups: omit(exception, [
-          'key',
-          'disabled',
-          'occurrence_index',
-          'id',
-          'summary',
-        ]),
+
+        exception: exception.id
+          ? {
+              id: exception.id,
+              exceptionChangeGroups: omit(exception, [
+                'key',
+                'disabled',
+                'occurrence_index',
+                'summary',
+                'id',
+              ]),
+            }
+          : undefined,
+
         summary: exception.summary ?? summary,
       });
     });

front/src/modules/timetableItem/types.ts

@@ -125,7 +125,7 @@ export type Occurrence = {
   rollingStock?: LightRollingStockWithLiveries;
   startTime: Date;
   stopsCount: number;
-  exceptionChangeGroups?: ExceptionChangeGroups;
+  exception?: { id: number; exceptionChangeGroups: ExceptionChangeGroups };
   summary?: SimulationSummary;
 };
 

front/src/utils/trainId.ts

@@ -30,7 +30,8 @@ export const isTrainId = (id: string): id is TrainId => isOccurrenceId(id) || is
  * - An added exception that has been modified is still considered as an added exception.
  */
 export const getExceptionType = (occurrence: Occurrence): 'added' | 'modified' | null => {
-  const { id, exceptionChangeGroups } = occurrence;
+  const { id, exception } = occurrence;
+  const exceptionChangeGroups = exception && exception.exceptionChangeGroups;
   if (isAddedExceptionId(id)) {
     return 'added';
   }
@@ -45,14 +46,18 @@ export const isException = (occurrence: Occurrence) => !!getExceptionType(occurr
 /**
  * Checks if an exception is related to the path or simulation.
  */
-export const isExceptionFromPathOrSimulation = ({ exceptionChangeGroups }: Occurrence) =>
-  exceptionChangeGroups &&
-  (exceptionChangeGroups.path_and_schedule ||
-    exceptionChangeGroups.options ||
-    exceptionChangeGroups.constraint_distribution ||
-    exceptionChangeGroups.speed_limit_tag ||
-    exceptionChangeGroups.initial_speed ||
-    exceptionChangeGroups.rolling_stock);
+export const isExceptionFromPathOrSimulation = ({ exception }: Occurrence) => {
+  const exceptionChangeGroups = exception?.exceptionChangeGroups;
+  return (
+    exceptionChangeGroups &&
+    (exceptionChangeGroups.path_and_schedule ||
+      exceptionChangeGroups.options ||
+      exceptionChangeGroups.constraint_distribution ||
+      exceptionChangeGroups.speed_limit_tag ||
+      exceptionChangeGroups.initial_speed ||
+      exceptionChangeGroups.rolling_stock)
+  );
+};
 
 /**
  * Given a train id in the Editoast format (used for api),