front: add, get and delete paced trains #10966

SharglutDev · 2025-02-26T15:13:11Z

See commits (will be merged all together)

part of #10615

Warning

PR not testable yet (depend on #11022)

E2E Tests :

part of add : https://github.com/osrd-project/osrd-tests/issues/89 (7-8-10-11 parts)
duplicate/delete : https://github.com/osrd-project/osrd-tests/issues/92

codecov-commenter · 2025-02-26T15:14:52Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.58%. Comparing base (28261be) to head (7e8ff62).
Report is 6 commits behind head on dev.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff             @@
##              dev   #10966       +/-   ##
===========================================
+ Coverage   80.63%   87.58%    +6.94%     
===========================================
  Files        1101       31     -1070     
  Lines      112360     1538   -110822     
  Branches      747        0      -747     
===========================================
- Hits        90602     1347    -89255     
+ Misses      21715      191    -21524     
+ Partials       43        0       -43

Flag	Coverage Δ
editoast	`?`
front	`?`
gateway	`?`
osrdyne	`?`
railjson_generator	`87.58% <ø> (ø)`
tests	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: SharglutDev <[email protected]>

Diff for the 2 new files : - useLadyLoadTimetableItems : copy of useLadyLoadTrains. Changes are to get item ids (reduce l.72) and merge paced train and train schedule summaries in one map. - formatTimetableItemSummaries : as typescript don't get that the mapping of items work combines properly ids and items with details, had to first create 2 arrays for each type of item and then merge them in a map. Signed-off-by: SharglutDev <[email protected]>

…hem in the timetable Signed-off-by: SharglutDev <[email protected]>

Signed-off-by: SharglutDev <[email protected]>

emersion

I've looked at the first two commits! Will continue the review later.

emersion · 2025-03-07T14:18:27Z

...c/modules/trainschedule/components/ManageTrainSchedule/helpers/formatTimetableItemPayload.ts

+export default function formatTimetableItemPayload<T extends boolean>(
+  validConfig: ValidConfig,
+  { isPacedTrainMode }: { isPacedTrainMode: T }
+): T extends true ? PacedTrainBase : TrainScheduleBase {


Hm, we do really need generics here? Could we instead have a function to format the common fields, and then separate functions for each type which call the common function?

emersion · 2025-03-07T14:21:37Z

...c/modules/trainschedule/components/ManageTrainSchedule/helpers/formatTimetableItemPayload.ts

+  { isPacedTrainMode }: { isPacedTrainMode: T }
+): T extends true ? PacedTrainBase : TrainScheduleBase {
+  const {
+    baseTrainName,


It seems to me like destructuring isn't buying us much here… The function would be half shorter without it, WDYT?

emersion · 2025-03-07T14:21:54Z

...c/modules/trainschedule/components/ManageTrainSchedule/helpers/formatTimetableItemPayload.ts

@@ -0,0 +1,52 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */


Why do we need to disable this one? Which variables are unused?

emersion · 2025-03-07T14:28:04Z

front/src/modules/trainschedule/components/ManageTrainSchedule/AddTrainScheduleButton.tsx

+          upsertTrainSchedules([formattedNewTrainSchedule]);
+        }
+      } catch (e) {
+        setIsWorking(false);


To avoid repetition, this could be moved to a finally block.

emersion · 2025-03-07T14:28:47Z

front/src/modules/trainschedule/components/ManageTrainSchedule/AddTrainScheduleButton.tsx

+            })
+          );
+          setIsWorking(false);
+          dtoImport();


To avoid repetition, dtoImport() could be moved outside of the if/else.

emersion · 2025-03-07T14:31:32Z

front/src/modules/trainschedule/components/ManageTrainSchedule/helpers/checkCurrentConfig.ts

+  if (showPacedTrains) {
+    // Prevent to block the train creation if a paced train field is invalid but we want to add a train schedule
+    if (isPacedTrainMode) {
+      if (cadence.total('minute') < 1) {


Nit: adding .total('minute') belongs to the previous commit, where the type of cadence is changed. (TypeScript missed this because Duration has a valueOf() method, which makes comparison operators work between Duration values… maybe it wasn't such a bright idea to implement this method…)

clarani · 2025-03-07T16:14:57Z

front/src/applications/operationalStudies/hooks/useScenarioData.ts

@@ -49,7 +58,15 @@ const useScenarioData = (scenario: ScenarioResponse, infra: InfraWithState) => {
    osrdEditoastApi.endpoints.getAllTimetableByIdTrainSchedules.useQuery(
      { timetableId: scenario?.timetable_id },
      {
-        skip: !scenario,
+        skip: !scenario || showPacedTrains,


Hum I think you should fetch the paced trains even if we need to show the paced trains no ?

Suggested change

skip: !scenario || showPacedTrains,

skip: !scenario,

What was I thinking 🙃

clarani · 2025-03-07T16:20:16Z

front/src/applications/operationalStudies/hooks/useScenarioData.ts

@@ -58,6 +75,9 @@ const useScenarioData = (scenario: ScenarioResponse, infra: InfraWithState) => {
    [fetchedTrainSchedulesResults]
  );

+  const pacedTrainsResults = useMemo(() => fetchedPacedTrains || [], [fetchedPacedTrains]);


Hm you can replace pacedTrainResults by these formatted trains, and this way reuse it below, for instance in useEffects (same for trainScheduleResults)

Suggested change

const pacedTrainsResults = useMemo(() => fetchedPacedTrains || [], [fetchedPacedTrains]);

const pacedTrains: PacedTrainResultWithPacedTrainId[] = useMemo(

() =>

showPacedTrains

? (fetchedPacedTrains || []).map((trainSchedule) => ({

...trainSchedule,

id: formatEditoastTrainIdToPacedTrainId(trainSchedule.id),

}))

: [],

[showPacedTrains, fetchedPacedTrains]

);

clarani · 2025-03-07T16:23:14Z

front/src/applications/operationalStudies/hooks/useScenarioData.ts

+    if (showPacedTrains) {
+      const formattedRawTrainSchedules: TrainScheduleResultWithTrainId[] =
+        trainSchedulesResults.map((trainSchedule) => ({
+          ...trainSchedule,
+          id: formatEditoastTrainIdToTrainScheduleId(trainSchedule.id),
+        }));
+      const formattedRawPacedTrains: PacedTrainResultWithPacedTrainId[] = pacedTrainsResults.map(
+        (trainSchedule) => ({
+          ...trainSchedule,
+          id: formatEditoastTrainIdToPacedTrainId(trainSchedule.id),
+        })
+      );
+      const sortedTimatableItems = sortBy(
+        [...formattedRawTrainSchedules, ...formattedRawPacedTrains],
+        'start_time'
+      );
+      setTimetableItems(sortedTimatableItems);
+    }


If you have this above:

const trainSchedules: TrainScheduleResultWithTrainId[] = useMemo( () => (fetchedTrainSchedulesResults || []).map((trainSchedule) => ({ ...trainSchedule, id: formatEditoastTrainIdToTrainScheduleId(trainSchedule.id), })), [fetchedTrainSchedulesResults] );

then, you can simply do (pacedTrains will be empty if !showPacedTrains):

Suggested change

if (showPacedTrains) {

const formattedRawTrainSchedules: TrainScheduleResultWithTrainId[] =

trainSchedulesResults.map((trainSchedule) => ({

...trainSchedule,

id: formatEditoastTrainIdToTrainScheduleId(trainSchedule.id),

}));

const formattedRawPacedTrains: PacedTrainResultWithPacedTrainId[] = pacedTrainsResults.map(

(trainSchedule) => ({

...trainSchedule,

id: formatEditoastTrainIdToPacedTrainId(trainSchedule.id),

})

);

const sortedTimatableItems = sortBy(

[...formattedRawTrainSchedules, ...formattedRawPacedTrains],

'start_time'

);

setTimetableItems(sortedTimatableItems);

}

const sortedTimetableItems = sortBy([...trainSchedules, ...pacedTrains], 'start_time');

setTimetableItems(sortedTimetableItems);

}

Then, you can remove the previous useEffect

clarani · 2025-03-07T16:25:28Z

front/src/applications/operationalStudies/hooks/useScenarioData.ts

  const [trainSchedules, setTrainSchedules] = useState<TrainScheduleResultWithTrainId[]>();
-  const [trainIdsToFetch, setTrainIdsToFetch] = useState<TrainId[]>();
-  const [trainIdsToProject, setTrainIdsToProject] = useState<Set<TrainId>>(new Set());
+  const [trainIdsToFetch, setTrainIdsToFetch] = useState<TimetableItemId[]>();
+  const [trainIdsToProject, setTrainIdsToProject] = useState<Set<TimetableItemId>>(new Set());


You can remove trainSchedules and trainIdsToFetch and directly use timetableItems

Suggested change

const [trainSchedules, setTrainSchedules] = useState<TrainScheduleResultWithTrainId[]>();

const [trainIdsToFetch, setTrainIdsToFetch] = useState<TrainId[]>();

const [trainIdsToProject, setTrainIdsToProject] = useState<Set<TrainId>>(new Set());

const [trainIdsToFetch, setTrainIdsToFetch] = useState<TimetableItemId[]>();

const [trainIdsToProject, setTrainIdsToProject] = useState<Set<TimetableItemId>>(new Set());

const [trainIdsToProject, setTrainIdsToProject] = useState<Set<TimetableItemId>>(new Set());

Signed-off-by: SharglutDev <[email protected]>

SharglutDev requested a review from a team as a code owner February 26, 2025 15:13

github-actions bot added the area:front Work on Standard OSRD Interface modules label Feb 26, 2025

SharglutDev marked this pull request as draft February 26, 2025 15:14

SharglutDev self-assigned this Feb 26, 2025

SharglutDev changed the title ~~front: handle add paced trains~~ add, get and delete paced trains Feb 26, 2025

SharglutDev force-pushed the pfn/front/add-get-delete-paced-trains branch 9 times, most recently from 4cb8276 to 5cf88dd Compare March 6, 2025 17:28

SharglutDev added 2 commits March 7, 2025 09:26

front: convert paced train time range duration and cadence to Duration

3b3a555

Signed-off-by: SharglutDev <[email protected]>

front: handle add paced trains

69d5ed1

Signed-off-by: SharglutDev <[email protected]>

SharglutDev force-pushed the pfn/front/add-get-delete-paced-trains branch from 5cf88dd to 77ebbd0 Compare March 7, 2025 09:21

emersion self-requested a review March 7, 2025 10:25

emersion changed the title ~~add, get and delete paced trains~~ front: add, get and delete paced trains Mar 7, 2025

SharglutDev added 4 commits March 7, 2025 11:37

front: dispatch timetable item data accross the scenario to display t…

fda3110

…hem in the timetable Signed-off-by: SharglutDev <[email protected]>

front: handle delete paced trains

271648f

Signed-off-by: SharglutDev <[email protected]>

front: handle duplicate paced trains

5b966b2

Signed-off-by: SharglutDev <[email protected]>

SharglutDev force-pushed the pfn/front/add-get-delete-paced-trains branch from 77ebbd0 to 9d5a8e6 Compare March 7, 2025 10:37

SharglutDev requested a review from RomainValls March 7, 2025 10:38

emersion reviewed Mar 7, 2025

View reviewed changes

emersion self-requested a review March 7, 2025 16:05

clarani reviewed Mar 7, 2025

View reviewed changes

front: update e2e tests to handle paced trains

42c86a8

Signed-off-by: SharglutDev <[email protected]>

SharglutDev force-pushed the pfn/front/add-get-delete-paced-trains branch from 9d5a8e6 to 42c86a8 Compare March 7, 2025 16:44

fix naming in useOccurrences

7e8ff62

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

front: add, get and delete paced trains #10966

front: add, get and delete paced trains #10966

SharglutDev commented Feb 26, 2025 •

edited

Loading

codecov-commenter commented Feb 26, 2025 •

edited

Loading

emersion left a comment

emersion Mar 7, 2025

emersion Mar 7, 2025

emersion Mar 7, 2025

emersion Mar 7, 2025

emersion Mar 7, 2025

emersion Mar 7, 2025

clarani Mar 7, 2025

SharglutDev Mar 7, 2025

clarani Mar 7, 2025

clarani Mar 7, 2025

clarani Mar 7, 2025

		@@ -0,0 +1,52 @@
		/* eslint-disable @typescript-eslint/no-unused-vars */

front: add, get and delete paced trains #10966

Are you sure you want to change the base?

front: add, get and delete paced trains #10966

Conversation

SharglutDev commented Feb 26, 2025 • edited Loading

codecov-commenter commented Feb 26, 2025 • edited Loading

Codecov Report

emersion left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SharglutDev commented Feb 26, 2025 •

edited

Loading

codecov-commenter commented Feb 26, 2025 •

edited

Loading