editoast: adapt get train schedules exceptions (#15502)

fix #15428

This PR adapts the `GET /timetable/{id}/train_schedules` endpoint to
retrieve the new exceptions.

To reduce the amount of refactoring, we convert the new exceptions into
the old ones; later, we will replace them entirely.

This PR targets a feature branch and breaks e2e tests. We will fix the
tests later (normally, they should fix themselves when we complete the
refactoring).

Signed-off-by: Egor <egor@berezify.fr>

Author: Wadjetz

editoast/editoast_models/src/train_schedule_exception.rs

@@ -1,4 +1,5 @@
 use editoast_derive::Model;
+use schemas::paced_train::PacedTrainException;
 use schemas::train_schedule_exception::TrainScheduleExceptionChangeGroups;
 
 use crate as editoast_models;
@@ -31,3 +32,23 @@ impl From<TrainScheduleException> for schemas::TrainScheduleException {
         }
     }
 }
+
+impl From<TrainScheduleException> for PacedTrainException {
+    fn from(train_schedule_exception: TrainScheduleException) -> Self {
+        let exception_type = match train_schedule_exception.occurrence_index {
+            Some(occurrence_index) => schemas::paced_train::ExceptionType::Modified {
+                occurrence_index: occurrence_index as usize,
+            },
+            None => schemas::paced_train::ExceptionType::Created {},
+        };
+        Self {
+            id: Some(train_schedule_exception.id),
+            key: train_schedule_exception
+                .key
+                .unwrap_or_else(|| train_schedule_exception.id.to_string()),
+            exception_type,
+            disabled: train_schedule_exception.disabled,
+            change_groups: train_schedule_exception.change_groups,
+        }
+    }
+}

editoast/openapi.yaml

@@ -109,6 +109,7 @@ pub fn rolling_stock_with_invalid_effort_curves_json() -> &'static str {
 
 pub fn simple_created_exception_with_change_groups(key: &str) -> PacedTrainException {
     PacedTrainException {
+        id: None,
         key: key.into(),
         exception_type: ExceptionType::Created {},
         disabled: false,

editoast/schemas/src/fixtures.rs

@@ -104,6 +104,8 @@ impl<'de> Deserialize<'de> for TrainSchedule {
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, ToSchema)]
 #[cfg_attr(feature = "testing", derive(Default))]
 pub struct PacedTrainException {
+    /// TODO The new exception table id (for incremental migration)
+    pub id: Option<i64>,
     /// Unique key for the exception within the paced train, required and generated by the frontend.
     pub key: String,
     #[serde(flatten)]

editoast/schemas/src/paced_train.rs

@@ -135,6 +135,7 @@ async fn link_train_schedule_set_to_timetable(
 
 pub fn create_created_exception_with_change_groups(key: &str) -> PacedTrainException {
     PacedTrainException {
+        id: None,
         key: key.into(),
         exception_type: ExceptionType::Created {},
         disabled: false,

editoast/src/models/fixtures.rs

@@ -41,7 +41,8 @@ use editoast_models::timetable::Timetable;
 use editoast_models::timetable::TimetableWithTrains;
 use itertools::Itertools;
 use itertools::izip;
-use paced_train::TrainScheduleResponse;
+use schemas::paced_train::Paced;
+use schemas::paced_train::TrainSchedule;
 use schemas::rolling_stock::EtcsBrakeParams;
 use schemas::rolling_stock::RollingResistance;
 use schemas::rolling_stock::RollingStock;
@@ -68,6 +69,7 @@ use crate::models::train_schedule::OccurrenceId;
 use crate::models::train_schedule_set::TrainScheduleSet;
 use crate::views::AuthenticationExt;
 use crate::views::AuthorizationError;
+use crate::views::timetable::paced_train::TrainScheduleResponse;
 use crate::views::timetable::simulation::SimulationResponseSuccess;
 
 #[derive(Debug, Error, EditoastError, derive_more::From)]
@@ -226,7 +228,50 @@ pub(in crate::views) async fn get_train_schedules(
 
     let (paced_trains, stats) = models::TrainSchedule::list_paginated(conn, settings).await?;
 
-    let results = paced_trains.into_iter().map_into().collect();
+    let paced_trains_ids = paced_trains.iter().map(|t| t.id).collect::<Vec<_>>();
+    let exceptions_settings = SelectionSettings::new()
+        .filter(move || editoast_models::TrainScheduleException::TIMETABLE_ID.eq(timetable_id))
+        .filter(move || {
+            editoast_models::TrainScheduleException::TRAIN_SCHEDULE_ID
+                .eq_any(paced_trains_ids.clone())
+        });
+
+    let mut exceptions = editoast_models::TrainScheduleException::list(conn, exceptions_settings)
+        .await?
+        .into_iter()
+        .into_group_map_by(|e| e.train_schedule_id);
+
+    let results: Vec<TrainScheduleResponse> = paced_trains
+        .into_iter()
+        .map(|ts| {
+            let id = ts.id;
+            let train_schedule_set_id = ts.train_schedule_set_id;
+
+            let paced = if let (Some(interval), Some(time_window)) = (ts.interval, ts.time_window) {
+                Some(Paced {
+                    interval: interval.try_into().unwrap(),
+                    time_window: time_window.try_into().unwrap(),
+                    exceptions: exceptions
+                        .remove(&id)
+                        .unwrap_or_default()
+                        .into_iter()
+                        .map_into()
+                        .collect(),
+                })
+            } else {
+                None
+            };
+
+            TrainScheduleResponse {
+                id,
+                train_schedule_set_id,
+                train_schedule: TrainSchedule {
+                    train_occurrence: ts.into_train_occurrence(),
+                    paced,
+                },
+            }
+        })
+        .collect();
 
     Ok(Json(ListTrainSchedulesResponse { stats, results }))
 }
@@ -922,6 +967,7 @@ mod tests {
     use crate::error::InternalError;
     use crate::models::fixtures::create_timetable;
     use crate::models::fixtures::create_timetable_with_train_schedule_set;
+    use crate::models::fixtures::create_train_schedule_exception;
     use crate::models::fixtures::create_train_schedule_set;
     use crate::models::fixtures::simple_paced_train_base;
     use crate::models::train_schedule::TrainScheduleChangeset;
@@ -984,38 +1030,97 @@ mod tests {
         let app = TestAppBuilder::default_app();
         let pool = app.db_pool();
 
-        let (timetable, train_schedule_set) =
+        // Setup timetable 1 data
+        let (timetable1, train_schedule_set1) =
             create_timetable_with_train_schedule_set(&mut pool.get_ok()).await;
 
-        let train_schedule_1 = simple_paced_train_base();
-        let mut train_schedule_2 = simple_paced_train_base();
-        train_schedule_2.train_occurrence.start_time += Duration::minutes(200);
-        train_schedule_2.paced.as_mut().unwrap().time_window =
+        let train_schedule_t1_1 = simple_paced_train_base();
+        let mut train_schedule_t1_2 = simple_paced_train_base();
+        train_schedule_t1_2.train_occurrence.start_time += Duration::minutes(200);
+        train_schedule_t1_2.paced.as_mut().unwrap().time_window =
             Duration::minutes(120).try_into().unwrap();
-        train_schedule_2.paced.as_mut().unwrap().interval =
+        train_schedule_t1_2.paced.as_mut().unwrap().interval =
             Duration::seconds(30).try_into().unwrap();
 
-        let train_schedules = vec![train_schedule_1, train_schedule_2];
-
-        let changesets = train_schedules
+        let train_schedules_bases_t1 = vec![train_schedule_t1_1, train_schedule_t1_2];
+        let train_schedules_changesets_t1 = train_schedules_bases_t1
             .into_iter()
             .map(TrainScheduleChangeset::from)
-            .map(|cs| cs.train_schedule_set_id(train_schedule_set.id))
+            .map(|cs| cs.train_schedule_set_id(train_schedule_set1.id))
             .collect::<Vec<_>>();
-
-        let _train_schedules: Vec<_> =
-            models::TrainSchedule::create_batch(&mut pool.get_ok(), changesets)
+        let train_schedules_t1: Vec<_> =
+            models::TrainSchedule::create_batch(&mut pool.get_ok(), train_schedules_changesets_t1)
                 .await
                 .expect("Failed to create train schedules");
-
-        let request = app.get(format!("/timetable/{}/train_schedules", timetable.id).as_str());
+        let train_schedule_exception_t1_1 = create_train_schedule_exception(
+            &mut pool.get_ok(),
+            timetable1.id,
+            train_schedules_t1.first().unwrap().id,
+            None,
+        )
+        .await;
+
+        let _train_schedule_exception_t1_2 = create_train_schedule_exception(
+            &mut pool.get_ok(),
+            timetable1.id,
+            train_schedules_t1.get(1).unwrap().id,
+            None,
+        )
+        .await;
+
+        // Setup timetable 2 data
+        let (timetable2, train_schedule_set2) =
+            create_timetable_with_train_schedule_set(&mut pool.get_ok()).await;
+        let mut train_schedule_t2_1 = simple_paced_train_base();
+        train_schedule_t2_1.train_occurrence.start_time += Duration::minutes(200);
+        train_schedule_t2_1.paced.as_mut().unwrap().time_window =
+            Duration::minutes(120).try_into().unwrap();
+        train_schedule_t2_1.paced.as_mut().unwrap().interval =
+            Duration::seconds(30).try_into().unwrap();
+        let train_schedules_bases_t2 = vec![train_schedule_t2_1];
+        let train_schedules_changesets_t2 = train_schedules_bases_t2
+            .into_iter()
+            .map(TrainScheduleChangeset::from)
+            .map(|cs| cs.train_schedule_set_id(train_schedule_set2.id))
+            .collect::<Vec<_>>();
+        let train_schedules_t2: Vec<_> =
+            models::TrainSchedule::create_batch(&mut pool.get_ok(), train_schedules_changesets_t2)
+                .await
+                .expect("Failed to create train schedules");
+        let _train_schedule_exception_t2_1 = create_train_schedule_exception(
+            &mut pool.get_ok(),
+            timetable2.id,
+            train_schedules_t2.first().unwrap().id,
+            None,
+        )
+        .await;
+
+        let request = app.get(format!("/timetable/{}/train_schedules", timetable1.id).as_str());
         let list: ListTrainSchedulesResponse = app
             .fetch(request)
             .await
             .assert_status(StatusCode::OK)
             .json_into();
 
+        // Check if the timetable has the two train schedules
         assert_eq!(list.results.len(), 2);
+
+        // Check if the first train schedule containe only his own exception
+        assert_eq!(
+            list.results
+                .first()
+                .unwrap()
+                .clone()
+                .train_schedule
+                .paced
+                .unwrap()
+                .exceptions
+                .first()
+                .unwrap()
+                .id
+                .unwrap(),
+            train_schedule_exception_t1_1.id
+        )
     }
 
     #[tokio::test(flavor = "multi_thread", worker_threads = 1)]

editoast/src/views/timetable.rs

@@ -105,10 +105,10 @@ enum TrainScheduleError {
 
 #[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
 pub(in crate::views) struct TrainScheduleResponse {
-    id: i64,
-    train_schedule_set_id: i64,
+    pub id: i64,
+    pub train_schedule_set_id: i64,
     #[serde(flatten)]
-    train_schedule: TrainSchedule,
+    pub train_schedule: TrainSchedule,
 }
 
 impl From<models::TrainSchedule> for TrainScheduleResponse {

editoast/src/views/timetable/paced_train.rs

@@ -481,13 +481,15 @@ mod tests {
         let train_schedule_set = create_train_schedule_set(&mut pool.get_ok()).await;
         let mut paced_train_1 = simple_paced_train_base();
         let exception_1 = PacedTrainException {
+            id: None,
             key: "exception_key_1".into(),
             exception_type: ExceptionType::Created {},
             disabled: false,
             change_groups: TrainScheduleExceptionChangeGroups::default(),
         };
 
         let exception_2 = PacedTrainException {
+            id: None,
             key: "exception_key_2".into(),
             exception_type: ExceptionType::Modified {
                 occurrence_index: 1,

editoast/src/views/train_schedule_set.rs

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

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

@@ -3927,6 +3927,8 @@ export type PacedTrainException = {
   train_name?: TrainNameChangeGroup;
 } & {
   disabled?: boolean;
+  /** TODO The new exception table id (for incremental migration) */
+  id?: number | null;
   /** Unique key for the exception within the paced train, required and generated by the frontend. */
   key: string;
 };