front: use Duration instead of string in SuggestedOP.arrival

Signed-off-by: Simon Ser <[email protected]>

Author: emersion

front/src/modules/pathfinding/utils.ts

@@ -12,6 +12,7 @@ import { getSupportedElectrification, isThermal } from 'modules/rollingStock/hel
 import type { SuggestedOP } from 'modules/trainschedule/components/ManageTrainSchedule/types';
 import type { PathStep } from 'reducers/osrdconf/types';
 import { addElementAtIndex } from 'utils/array';
+import { Duration } from 'utils/duration';
 import { getPointCoordinates } from 'utils/geometry';
 
 import getStepLocation from './helpers/getStepLocation';
@@ -93,7 +94,8 @@ export const getPathfindingQuery = ({
 export const upsertPathStepsInOPs = (ops: SuggestedOP[], pathSteps: PathStep[]): SuggestedOP[] => {
   let updatedOPs = [...ops];
   pathSteps.forEach((step) => {
-    const { stopFor, arrival, receptionSignal, theoreticalMargin } = step;
+    const { stopFor, receptionSignal, theoreticalMargin } = step;
+    const arrival = step.arrival ? Duration.parse(step.arrival) : null;
     // We check only for pathSteps added by map click
     if ('track' in step) {
       const formattedStep: SuggestedOP = {

front/src/modules/timesStops/helpers/__tests__/utils.spec.ts

@@ -1,6 +1,7 @@
 import { describe, it, expect } from 'vitest';
 
 import { type TimesStopsInputRow } from 'modules/timesStops/types';
+import { Duration } from 'utils/duration';
 
 import {
   updateRowTimesAndMargin,
@@ -820,7 +821,7 @@ describe('durationSinceStartTime', () => {
 
     const result = durationSinceStartTime(startTime, stepTimeDays);
 
-    expect(result).toBe('PT36000S');
+    expect(result).toEqual(Duration.parse('PT36000S'));
   });
 
   it('should return the correct duration. daySinceDeparture 1', () => {
@@ -832,14 +833,14 @@ describe('durationSinceStartTime', () => {
 
     const result = durationSinceStartTime(startTime, stepTimeDays);
 
-    expect(result).toBe('PT90000S');
+    expect(result).toEqual(Duration.parse('PT90000S'));
   });
 });
 
 describe('calculateStepTimeDays', () => {
   it('should return correct time and daySinceDeparture', () => {
     const startTime = new Date('2023-09-01T10:00:00Z');
-    const isoDuration = 'PT36000S'; // 10 hours
+    const isoDuration = Duration.parse('PT36000S'); // 10 hours
 
     const result = calculateStepTimeAndDays(startTime, isoDuration);
 
@@ -851,7 +852,7 @@ describe('calculateStepTimeDays', () => {
 
   it('should return correct time and daySinceDeparture, daySinceDeparture 1', () => {
     const startTime = new Date('2023-09-01T10:00:00Z');
-    const isoDuration = 'PT122400S'; // 1 day 10 hours
+    const isoDuration = Duration.parse('PT122400S'); // 1 day 10 hours
 
     const result = calculateStepTimeAndDays(startTime, isoDuration);
 

front/src/modules/timesStops/helpers/utils.ts

@@ -5,16 +5,16 @@ import { round, isEqual, isNil } from 'lodash';
 import { keyColumn, createTextColumn } from 'react-datasheet-grid';
 
 import type { ReceptionSignal } from 'common/api/osrdEditoastApi';
-import type { IsoDurationString, TimeString } from 'common/types';
+import type { TimeString } from 'common/types';
 import { matchPathStepAndOp } from 'modules/pathfinding/utils';
 import type { SuggestedOP } from 'modules/trainschedule/components/ManageTrainSchedule/types';
 import type { PathStep } from 'reducers/osrdconf/types';
+import { Duration } from 'utils/duration';
+import { msToS } from 'utils/physics';
 import { NO_BREAK_SPACE } from 'utils/strings';
 import {
-  calculateTimeDifferenceInSeconds,
   datetime2sec,
   durationInSeconds,
-  formatDurationAsISO8601,
   sec2time,
   SECONDS_IN_A_DAY,
   secToHoursString,
@@ -79,10 +79,15 @@ export const formatSuggestedViasToRowVias = (
     const { arrival, receptionSignal, stopFor, theoreticalMargin } = objectToUse || {};
 
     const isMarginValid = theoreticalMargin ? marginRegExValidation.test(theoreticalMargin) : true;
-    const durationArrivalTime = i === 0 ? 'PT0S' : arrival;
-    const arrivalInSeconds = durationArrivalTime ? time2sec(durationArrivalTime) : null;
+    const rawArrivalDuration = i === 0 ? Duration.zero : arrival;
+    // TODO: turn PathStep.arrival into a Duration instead of a string
+    const arrivalDuration =
+      typeof rawArrivalDuration === 'string'
+        ? Duration.parse(rawArrivalDuration)
+        : rawArrivalDuration;
+    const arrivalInSeconds = arrivalDuration ? msToS(arrivalDuration.ms) : null;
 
-    const formattedArrival = calculateStepTimeAndDays(startTime, durationArrivalTime);
+    const formattedArrival = calculateStepTimeAndDays(startTime, arrivalDuration);
 
     const departureTime =
       stopFor && arrivalInSeconds
@@ -281,7 +286,7 @@ export function updateDaySinceDeparture(
 export function durationSinceStartTime(
   startTime?: Date,
   stepTimeDays?: TimeExtraDays
-): IsoDurationString | null {
+): Duration | null {
   if (!startTime || !stepTimeDays?.time || stepTimeDays?.daySinceDeparture === undefined) {
     return null;
   }
@@ -290,23 +295,21 @@ export function durationSinceStartTime(
     stepTimeDays.daySinceDeparture,
     'day'
   );
-  return formatDurationAsISO8601(
-    calculateTimeDifferenceInSeconds(start.toISOString(), step.toISOString())
-  );
+  return Duration.subtractDate(step.toDate(), startTime);
 }
 
 export function calculateStepTimeAndDays(
   startTime?: Date | null,
-  isoDuration?: IsoDurationString | null
+  duration?: Duration | null
 ): TimeExtraDays | undefined {
-  if (!startTime || !isoDuration) {
+  if (!startTime || !duration) {
     return undefined;
   }
 
   const start = dayjs(startTime);
-  const duration = dayjs.duration(isoDuration);
+  const dur = dayjs.duration(duration.ms);
 
-  const waypointArrivalTime = start.add(duration);
+  const waypointArrivalTime = start.add(dur);
   const daySinceDeparture = waypointArrivalTime.diff(start, 'day');
   const time: TimeString = waypointArrivalTime.format('HH:mm:ss');
 

front/src/modules/trainschedule/components/ManageTrainSchedule/types.ts

@@ -1,7 +1,7 @@
 import type { Feature, Position } from 'geojson';
 
 import type { ReceptionSignal, TrainScheduleBase } from 'common/api/osrdEditoastApi';
-import type { IsoDurationString } from 'common/types';
+import type { Duration } from 'utils/duration';
 
 export type SuggestedOP = {
   pathStepId?: string;
@@ -21,7 +21,7 @@ export type SuggestedOP = {
         It's useful for soft deleting the point (waiting to fix / remove all references)
         If true, the train schedule is consider as invalid and must be edited */
   deleted?: boolean;
-  arrival?: IsoDurationString | null; // value asked by user, number of seconds since departure
+  arrival?: Duration | null; // value asked by user, number of seconds since departure
   locked?: boolean;
   stopFor?: string | null; // value asked by user
   theoreticalMargin?: string; // value asked by user

front/src/reducers/osrdconf/helpers.ts

@@ -61,13 +61,13 @@ export function upsertPathStep(statePathSteps: (PathStep | null)[], op: Suggeste
       'name',
       'kp',
       'stopFor',
-      'arrival',
       'locked',
       'deleted',
       'receptionSignal',
       'theoreticalMargin',
     ]),
     id: nextId(),
+    arrival: op.arrival?.toISOString(),
     ...(op.uic
       ? { uic: op.uic, secondary_code: op.ch }
       : {

front/src/reducers/osrdconf/operationalStudiesConf/__tests__/operationalStudiesConfReducer.spec.ts

@@ -148,7 +148,6 @@ describe('simulationConfReducer', () => {
         offset: 426.443,
         stopFor: 'PT5M',
         coordinates: [47.99542250806296, 0.1918181738752042],
-        arrival: newVia.arrival,
         locked: newVia.locked,
         deleted: newVia.deleted,
         name: newVia.name,