fixup! editoast: add train_schedule object to search endpoint

Author: EthanPERRUZZA

editoast/editoast_schemas/src/train_schedule/train_schedule_options.rs

@@ -9,7 +9,6 @@ editoast_common::schemas! {
 
 #[derive(Debug, Derivative, Clone, Serialize, Deserialize, ToSchema, Hash)]
 #[serde(deny_unknown_fields)]
-#[schema(as = TrainScheduleOptionsV2)] // Avoiding conflict with v1. TODO: remove after migration to v2
 #[derivative(Default)]
 pub struct TrainScheduleOptions {
     #[derivative(Default(value = "true"))]

editoast/openapi.yaml

@@ -9000,16 +9000,15 @@ components:
       - comfort
       - path
       - constraint_distribution
-      - speed_limit_tag
       - power_restrictions
       - options
       properties:
         comfort:
           type: integer
-          format: int32
+          format: int64
         constraint_distribution:
           type: integer
-          format: int32
+          format: int64
         id:
           type: integer
           format: int64
@@ -9021,38 +9020,34 @@ components:
           type: array
           items:
             type: string
+            nullable: true
         margins:
-          type: array
-          items:
-            type: string
+          $ref: '#/components/schemas/Margins'
         options:
-          type: array
-          items:
-            type: string
+          $ref: '#/components/schemas/TrainScheduleOptions'
         path:
           type: array
           items:
-            type: string
+            $ref: '#/components/schemas/PathItem'
         power_restrictions:
           type: array
           items:
-            type: string
+            $ref: '#/components/schemas/PowerRestrictionItem'
         rolling_stock_name:
           type: string
         schedule:
           type: array
           items:
-            type: string
+            $ref: '#/components/schemas/ScheduleItem'
         speed_limit_tag:
-          type: array
-          items:
-            type: string
+          type: string
+          nullable: true
         start_time:
           type: string
+          format: date-time
         timetable_id:
           type: integer
           format: int64
-          minimum: 0
         train_name:
           type: string
     Side:
@@ -10258,7 +10253,7 @@ components:
             format: int64
             description: Timetable attached to the train schedule
             nullable: true
-    TrainScheduleOptionsV2:
+    TrainScheduleOptions:
       type: object
       properties:
         use_electrical_profiles:

editoast/src/views/search.rs

@@ -203,7 +203,9 @@ use axum::extract::Json;
 use axum::extract::Query;
 use axum::extract::State;
 use axum::Extension;
+use chrono::DateTime;
 use chrono::NaiveDateTime;
+use chrono::Utc;
 use diesel::pg::Pg;
 use diesel::sql_query;
 use diesel::sql_types::Jsonb;
@@ -215,6 +217,11 @@ use editoast_common::geometry::GeoJsonPoint;
 use editoast_derive::EditoastError;
 use editoast_derive::Search;
 use editoast_derive::SearchConfigStore;
+use editoast_schemas::train_schedule::Margins;
+use editoast_schemas::train_schedule::PathItem;
+use editoast_schemas::train_schedule::PowerRestrictionItem;
+use editoast_schemas::train_schedule::ScheduleItem;
+use editoast_schemas::train_schedule::TrainScheduleOptions;
 use editoast_search::query_into_sql;
 use editoast_search::SearchConfigStore as _;
 use editoast_search::SearchError;
@@ -344,9 +351,8 @@ async fn search(
     Json(SearchPayload { object, query, dry }): Json<SearchPayload>,
 ) -> Result<Json<serde_json::Value>> {
     let roles: HashSet<BuiltinRole> = match object.as_str() {
-        "track" | "operationalpoint" | "signal" | "trainschedule" => {
-            HashSet::from([BuiltinRole::InfraRead])
-        }
+        "track" | "operationalpoint" | "signal" => HashSet::from([BuiltinRole::InfraRead]),
+        "trainschedule" => HashSet::from([BuiltinRole::TimetableRead]),
         "project" | "study" | "scenario" => HashSet::from([BuiltinRole::OpsRead]),
         _ => {
             return Err(SearchApiError::ObjectType {
@@ -659,6 +665,7 @@ pub(super) struct SearchResultItemStudy {
 )]
 #[allow(unused)]
 /// A search result item for a query with `object = "scenario"`
+#[derive(serde::Deserialize)]
 pub(super) struct SearchResultItemScenario {
     #[search(sql = "scenario.id")]
     id: u64,
@@ -693,37 +700,38 @@ pub(super) struct SearchResultItemScenario {
 )]
 #[allow(unused)]
 /// A search result item for a query with `object = "trainschedule"`
+#[derive(serde::Deserialize)]
 pub(super) struct SearchResultItemTrainSchedule {
     #[search(sql = "train_schedule.id")]
     id: u64,
     #[search(sql = "train_schedule.train_name")]
-    train_name: String, // useless puisqu'on en a besoin pour la request?
+    train_name: String,
     #[search(sql = "train_schedule.labels")]
-    labels: Vec<String>,
+    labels: Vec<Option<String>>,
     #[search(sql = "train_schedule.rolling_stock_name")]
     rolling_stock_name: String,
     #[search(sql = "train_schedule.timetable_id")]
-    timetable_id: u64, // useless puisqu'on en a besoin pour la request?
+    timetable_id: i64,
     #[search(sql = "train_schedule.start_time")]
-    start_time: String,
+    start_time: DateTime<Utc>,
     #[search(sql = "train_schedule.schedule")]
-    schedule: Vec<String>,
+    schedule: Vec<ScheduleItem>,
     #[search(sql = "train_schedule.margins")]
-    margins: Vec<String>,
+    margins: Margins,
     #[search(sql = "train_schedule.initial_speed")]
     initial_speed: f64,
     #[search(sql = "train_schedule.comfort")]
-    comfort: i16,
+    comfort: i64,
     #[search(sql = "train_schedule.path")]
-    path: Vec<String>,
+    path: Vec<PathItem>,
     #[search(sql = "train_schedule.constraint_distribution")]
-    constraint_distribution: i16,
+    constraint_distribution: i64,
     #[search(sql = "train_schedule.speed_limit_tag")]
-    speed_limit_tag: Vec<String>,
+    speed_limit_tag: Option<String>,
     #[search(sql = "train_schedule.power_restrictions")]
-    power_restrictions: Vec<String>,
+    power_restrictions: Vec<PowerRestrictionItem>,
     #[search(sql = "train_schedule.options")]
-    options: Vec<String>,
+    options: TrainScheduleOptions,
 }
 
 /// See [editoast_search::SearchConfigStore::find]
@@ -738,3 +746,70 @@ pub(super) struct SearchResultItemTrainSchedule {
     object(name = "trainschedule", config = SearchResultItemTrainSchedule),
 )]
 pub struct SearchConfigFinder;
+
+#[cfg(test)]
+pub mod test {
+
+    use axum::http::StatusCode;
+    use pretty_assertions::assert_eq;
+    use rstest::rstest;
+    use serde_json::json;
+
+    use super::*;
+    use crate::models::fixtures::{create_simple_train_schedule, create_timetable};
+    use crate::models::train_schedule::TrainSchedule;
+    use crate::views::test_app::TestAppBuilder;
+
+    #[rstest]
+    async fn search_trainschedule_post() {
+        let app = TestAppBuilder::default_app();
+        let pool = app.db_pool();
+
+        // Create the timetable in the database
+        let timetable = create_timetable(&mut pool.get_ok()).await;
+        let timetable_id = timetable.id;
+
+        // Load data of the json file
+        #[derive(serde::Deserialize)]
+        struct TrainScheduleInfo {
+            pub train_name: String,
+        }
+        let train_schedule_info: TrainScheduleInfo =
+            serde_json::from_str(include_str!("../tests/train_schedules/simple.json"))
+                .expect("Unable to parse");
+        let train_name = train_schedule_info.train_name;
+
+        // Add a train_schedule in the database
+        let train_schedule: TrainSchedule =
+            create_simple_train_schedule(&mut pool.get_ok(), timetable_id).await;
+        assert_eq!(train_schedule.train_name, train_name);
+
+        // The body
+        let request = app.post("/search").json(&json!({
+            "object": "trainschedule",
+            "query": [
+                "and",
+                [
+                    "search",
+                    [
+                        "train_name"
+                    ],
+                    train_name
+                ],
+                [
+                    "=",
+                    [
+
+                        "timetable_id"
+                    ],
+                    timetable_id
+                ]
+            ],
+        }));
+
+        let response: Vec<SearchResultItemTrainSchedule> =
+            app.fetch(request).assert_status(StatusCode::OK).json_into();
+
+        assert_eq!(response[0].train_name, train_name);
+    }
+}

front/src/common/api/generatedEditoastApi.ts

@@ -2846,19 +2846,55 @@ export type SearchResultItemScenario = {
   tags: string[];
   trains_count: number;
 };
+export type Margins = {
+  boundaries: string[];
+  /** The values of the margins. Must contains one more element than the boundaries
+    Can be a percentage `X%` or a time in minutes per 100 kilometer `Xmin/100km` */
+  values: string[];
+};
+export type TrainScheduleOptions = {
+  use_electrical_profiles?: boolean;
+};
+export type PathItem = PathItemLocation & {
+  /** Metadata given to mark a point as wishing to be deleted by the user.
+    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;
+  id: string;
+};
+export type PowerRestrictionItem = {
+  from: string;
+  to: string;
+  value: string;
+};
+export type ReceptionSignal = 'OPEN' | 'STOP' | 'SHORT_SLIP_STOP';
+export type ScheduleItem = {
+  /** The expected arrival time at the stop.
+    This will be used to compute the final simulation time. */
+  arrival?: string | null;
+  at: string;
+  /** Whether the schedule item is locked (only for display purposes) */
+  locked?: boolean;
+  reception_signal?: ReceptionSignal;
+  /** Duration of the stop.
+    Can be `None` if the train does not stop.
+    If `None`, `reception_signal` must be `Open`.
+    `Some("PT0S")` means the train stops for 0 seconds. */
+  stop_for?: string | null;
+};
 export type SearchResultItemTrainSchedule = {
   comfort: number;
   constraint_distribution: number;
   id: number;
   initial_speed: number;
-  labels: string[];
-  margins: string[];
-  options: string[];
-  path: string[];
-  power_restrictions: string[];
+  labels: (string | null)[];
+  margins: Margins;
+  options: TrainScheduleOptions;
+  path: PathItem[];
+  power_restrictions: PowerRestrictionItem[];
   rolling_stock_name: string;
-  schedule: string[];
-  speed_limit_tag: string[];
+  schedule: ScheduleItem[];
+  speed_limit_tag?: string | null;
   start_time: string;
   timetable_id: number;
   train_name: string;
@@ -3048,7 +3084,6 @@ export type PathfindingItem = {
   timing_data?: StepTimingData | null;
 };
 export type Distribution = 'STANDARD' | 'MARECO';
-export type ReceptionSignal = 'OPEN' | 'STOP' | 'SHORT_SLIP_STOP';
 export type TrainScheduleBase = {
   comfort?: Comfort;
   constraint_distribution: Distribution;