editoast: stdcm: add arrival time parameters

Author: eckter

core/kt-osrd-utils/src/main/kotlin/fr/sncf/osrd/utils/json/UnitJsonAdapters.kt

@@ -75,7 +75,11 @@ class DurationAdapter : JsonAdapter<Duration?>() {
  */
 class DateAdapter : JsonAdapter<ZonedDateTime>() {
     @FromJson
-    override fun fromJson(reader: JsonReader): ZonedDateTime {
+    override fun fromJson(reader: JsonReader): ZonedDateTime? {
+        if (reader.peek() == JsonReader.Token.NULL) {
+            reader.skipValue()
+            return null
+        }
         return ZonedDateTime.parse(reader.nextString())
     }
 

core/src/main/kotlin/fr/sncf/osrd/api/api_v2/stdcm/STDCMRequestV2.kt

@@ -60,6 +60,9 @@ class STDCMRequestV2(
 class STDCMPathItem(
     val locations: List<TrackLocation>,
     @Json(name = "stop_duration") val stopDuration: Duration?,
+    @Json(name = "arrival_time") val arrivalTime: ZonedDateTime?,
+    @Json(name = "arrival_time_tolerance_before") val arrivalTimeToleranceBefore: Duration?,
+    @Json(name = "arrival_time_tolerance_after") val arrivalTimeToleranceAfter: Duration?,
 )
 
 class TrackOffset(val track: String, val offset: Offset<TrackSection>)

editoast/openapi.yaml

@@ -5202,6 +5202,23 @@ components:
       type: object
     PathfindingItem:
       properties:
+        arrival_time:
+          description: Time at which the train should arrive at the location, if specified
+          format: date-time
+          nullable: true
+          type: string
+        arrival_time_tolerance_after:
+          description: The train may arrive up to this duration after the expected arrival time
+          format: int64
+          minimum: 0
+          nullable: true
+          type: integer
+        arrival_time_tolerance_before:
+          description: The train may arrive up to this duration before the expected arrival time
+          format: int64
+          minimum: 0
+          nullable: true
+          type: integer
         duration:
           description: The stop duration in milliseconds, None if the train does not stop.
           format: int64
@@ -6894,7 +6911,9 @@ components:
           nullable: true
           type: string
         start_time:
+          description: Deprecated, first step arrival time should be used instead
           format: date-time
+          nullable: true
           type: string
         steps:
           items:
@@ -6919,7 +6938,6 @@ components:
           minimum: 0
           type: integer
       required:
-      - start_time
       - steps
       - rolling_stock_id
       - comfort
@@ -12451,7 +12469,9 @@ paths:
                   nullable: true
                   type: string
                 start_time:
+                  description: Deprecated, first step arrival time should be used instead
                   format: date-time
+                  nullable: true
                   type: string
                 steps:
                   items:
@@ -12476,7 +12496,6 @@ paths:
                   minimum: 0
                   type: integer
               required:
-              - start_time
               - steps
               - rolling_stock_id
               - comfort

editoast/src/core/v2/stdcm.rs

@@ -64,6 +64,12 @@ pub struct STDCMPathItem {
     pub locations: Vec<TrackOffset>,
     /// Stop duration in milliseconds. None if the train does not stop at this path item.
     pub stop_duration: Option<u64>,
+    /// Time the train should arrive at this point, if specified
+    pub arrival_time: Option<DateTime<Utc>>,
+    /// Tolerance for the arrival time, when it arrives before the expected time, in ms
+    pub arrival_time_tolerance_before: Option<u64>,
+    /// Tolerance for the arrival time, when it arrives after the expected time, in ms
+    pub arrival_time_tolerance_after: Option<u64>,
 }
 
 /// Lighter description of a work schedule, only contains what's relevant

editoast/src/views/v2/timetable/stdcm.rs

@@ -4,7 +4,7 @@ use actix_web::web::Json;
 use actix_web::web::Path;
 use actix_web::web::Query;
 use chrono::Utc;
-use chrono::{DateTime, NaiveDateTime, TimeZone};
+use chrono::{DateTime, Duration, NaiveDateTime, TimeZone};
 use editoast_derive::EditoastError;
 use editoast_schemas::train_schedule::MarginValue;
 use editoast_schemas::train_schedule::PathItemLocation;
@@ -70,7 +70,8 @@ enum STDCMError {
 /// An STDCM request
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, ToSchema)]
 pub struct STDCMRequestPayload {
-    start_time: DateTime<Utc>,
+    /// Deprecated, first step arrival time should be used instead
+    start_time: Option<DateTime<Utc>>,
     steps: Vec<PathfindingItem>,
     rolling_stock_id: i64,
     comfort: Comfort,
@@ -106,6 +107,12 @@ struct PathfindingItem {
     duration: Option<u64>,
     /// The associated location
     location: PathItemLocation,
+    /// Time at which the train should arrive at the location, if specified
+    arrival_time: Option<DateTime<Utc>>,
+    /// The train may arrive up to this duration before the expected arrival time
+    arrival_time_tolerance_before: Option<u64>,
+    /// The train may arrive up to this duration after the expected arrival time
+    arrival_time_tolerance_after: Option<u64>,
 }
 
 const TWO_HOURS_IN_MILLISECONDS: u64 = 2 * 60 * 60 * 60;
@@ -209,6 +216,8 @@ async fn stdcm(
         }
     };
 
+    let departure_time = get_earliest_departure_time(&data, maximum_run_time);
+
     // 3. Parse stdcm path items
     let path_items = parse_stdcm_steps(conn, &data, &infra).await?;
 
@@ -223,7 +232,7 @@ async fn stdcm(
             .clone(),
         comfort: data.comfort,
         path_items,
-        start_time: data.start_time,
+        start_time: departure_time,
         trains_requirements,
         maximum_departure_delay: Some(data.maximum_departure_delay),
         maximum_run_time,
@@ -234,7 +243,7 @@ async fn stdcm(
         time_step: Some(2000),
         work_schedules: build_work_schedules(
             conn,
-            data.start_time,
+            departure_time,
             data.maximum_departure_delay,
             maximum_run_time,
         )
@@ -246,6 +255,34 @@ async fn stdcm(
     Ok(Json(stdcm_response))
 }
 
+/// Returns the earliest time at which the train may start
+fn get_earliest_departure_time(data: &STDCMRequestPayload, maximum_run_time: u64) -> DateTime<Utc> {
+    // Prioritize: start time, or first step time, or (first specified time - max run time)
+    data.start_time.unwrap_or(
+        data.steps
+            .first()
+            .and_then(|step| step.arrival_time)
+            .unwrap_or(
+                get_earliest_step_time(data) - Duration::milliseconds(maximum_run_time as i64),
+            ),
+    )
+}
+
+/// Returns the earliest time that has been set on any step
+fn get_earliest_step_time(data: &STDCMRequestPayload) -> DateTime<Utc> {
+    // Get the earliest time that has been specified for any step
+    *data
+        .start_time
+        .as_ref()
+        .or_else(|| {
+            data.steps
+                .iter()
+                .flat_map(|step| step.arrival_time.iter())
+                .next()
+        })
+        .expect("No time specified for stdcm request")
+}
+
 /// get the maximum run time, compute it if unspecified.
 /// returns an enum with either the result or a SimulationResponse if it failed
 async fn get_maximum_run_time(
@@ -263,13 +300,16 @@ async fn get_maximum_run_time(
         });
     }
 
+    // Doesn't matter for now, but eventually it will affect tmp speed limits
+    let approx_start_time = get_earliest_step_time(data);
+
     let train_schedule = TrainSchedule {
         id: 0,
         train_name: "".to_string(),
         labels: vec![],
         rolling_stock_name: rolling_stock.name.clone(),
         timetable_id,
-        start_time: data.start_time,
+        start_time: approx_start_time,
         schedule: vec![],
         margins: build_single_margin(data.margin),
         initial_speed: 0.0,
@@ -372,21 +412,22 @@ async fn parse_stdcm_steps(
 ) -> Result<Vec<STDCMPathItem>> {
     let path_items = data.steps.clone();
     let mut locations = Vec::with_capacity(path_items.len());
-    let mut durations = Vec::with_capacity(path_items.len());
     for item in path_items {
         locations.push(item.location);
-        durations.push(item.duration);
     }
 
     let track_offsets = extract_location_from_path_items(conn, infra.id, &locations).await?;
     let track_offsets = track_offsets.map_err::<STDCMError, _>(|err| err.into())?;
 
     Ok(track_offsets
         .iter()
-        .zip(durations)
-        .map(|(track_offset, duration)| STDCMPathItem {
-            stop_duration: duration,
+        .zip(&data.steps)
+        .map(|(track_offset, path_item)| STDCMPathItem {
+            stop_duration: path_item.duration,
             locations: track_offset.to_vec(),
+            arrival_time: path_item.arrival_time,
+            arrival_time_tolerance_before: path_item.arrival_time_tolerance_before,
+            arrival_time_tolerance_after: path_item.arrival_time_tolerance_after,
         })
         .collect())
 }

front/src/common/api/generatedEditoastApi.ts

@@ -1760,7 +1760,8 @@ export type PostV2TimetableByIdStdcmApiArg = {
     rolling_stock_id: number;
     /** Train categories for speed limits */
     speed_limit_tags?: string | null;
-    start_time: string;
+    /** Deprecated, first step arrival time should be used instead */
+    start_time?: string | null;
     steps: PathfindingItem[];
     /** Margin after the train passage in milliseconds
         
@@ -3709,6 +3710,12 @@ export type PathItemLocation =
       uic: number;
     };
 export type PathfindingItem = {
+  /** Time at which the train should arrive at the location, if specified */
+  arrival_time?: string | null;
+  /** The train may arrive up to this duration after the expected arrival time */
+  arrival_time_tolerance_after?: number | null;
+  /** The train may arrive up to this duration before the expected arrival time */
+  arrival_time_tolerance_before?: number | null;
   /** The stop duration in milliseconds, None if the train does not stop. */
   duration?: number | null;
   location: PathItemLocation;