fixup! editoast: stdcm: add arrival time parameters

Author: eckter

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

@@ -60,9 +60,13 @@ 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?,
+    @Json(name = "step_timing_data") val stepTimingData: StepTimingData?,
+)
+
+data class StepTimingData(
+    @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,23 +5202,6 @@ 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
@@ -5227,6 +5210,10 @@ components:
           type: integer
         location:
           $ref: '#/components/schemas/PathItemLocation'
+        timing_data:
+          allOf:
+          - $ref: '#/components/schemas/StepTimingData'
+          nullable: true
       required:
       - location
       type: object
@@ -6893,7 +6880,9 @@ components:
           type: string
         maximum_departure_delay:
           default: 432000
-          description: By how long we can shift the departure time in milliseconds
+          description: |-
+            By how long we can shift the departure time in milliseconds
+            Deprecated, first step data should be used instead
           format: int64
           minimum: 0
           type: integer
@@ -8193,6 +8182,27 @@ components:
       - ranges
       - distribution
       type: object
+    StepTimingData:
+      properties:
+        arrival_time:
+          description: Time at which the train should arrive at the location
+          format: date-time
+          type: string
+        arrival_time_tolerance_after:
+          description: The train may arrive up to this duration after the expected arrival time
+          format: int64
+          minimum: 0
+          type: integer
+        arrival_time_tolerance_before:
+          description: The train may arrive up to this duration before the expected arrival time
+          format: int64
+          minimum: 0
+          type: integer
+      required:
+      - arrival_time
+      - arrival_time_tolerance_before
+      - arrival_time_tolerance_after
+      type: object
     Study:
       properties:
         actual_end_date:
@@ -12451,7 +12461,9 @@ paths:
                   type: string
                 maximum_departure_delay:
                   default: 432000
-                  description: By how long we can shift the departure time in milliseconds
+                  description: |-
+                    By how long we can shift the departure time in milliseconds
+                    Deprecated, first step data should be used instead
                   format: int64
                   minimum: 0
                   type: integer

editoast/src/core/v2/stdcm.rs

@@ -64,12 +64,19 @@ 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>>,
+    /// If specified, describes when the train may arrive at the location
+    pub step_timing_data: Option<STDCMStepTimingData>,
+}
+
+/// Contains the data of a step timing, when it is specified
+#[derive(Debug, Serialize)]
+pub struct STDCMStepTimingData {
+    /// Time the train should arrive at this point
+    pub arrival_time: DateTime<Utc>,
     /// Tolerance for the arrival time, when it arrives before the expected time, in ms
-    pub arrival_time_tolerance_before: Option<u64>,
+    pub arrival_time_tolerance_before: u64,
     /// Tolerance for the arrival time, when it arrives after the expected time, in ms
-    pub arrival_time_tolerance_after: Option<u64>,
+    pub arrival_time_tolerance_after: u64,
 }
 
 /// Lighter description of a work schedule, only contains what's relevant

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

@@ -19,10 +19,10 @@ use utoipa::IntoParams;
 use utoipa::ToSchema;
 
 use crate::core::v2::simulation::SimulationResponse;
-use crate::core::v2::stdcm::STDCMRequest;
 use crate::core::v2::stdcm::STDCMResponse;
 use crate::core::v2::stdcm::TrainRequirement;
 use crate::core::v2::stdcm::{STDCMPathItem, STDCMWorkSchedule, UndirectedTrackRange};
+use crate::core::v2::stdcm::{STDCMRequest, STDCMStepTimingData};
 use crate::core::AsCoreRequest;
 use crate::core::CoreClient;
 use crate::error::Result;
@@ -48,6 +48,7 @@ crate::routes! {
 editoast_common::schemas! {
     STDCMRequestPayload,
     PathfindingItem,
+    StepTimingData,
 }
 
 #[derive(Debug, Error, EditoastError, Serialize)]
@@ -76,6 +77,7 @@ pub struct STDCMRequestPayload {
     rolling_stock_id: i64,
     comfort: Comfort,
     /// By how long we can shift the departure time in milliseconds
+    /// Deprecated, first step data should be used instead
     #[serde(default = "default_maximum_departure_delay")]
     #[schema(default = default_maximum_departure_delay)]
     maximum_departure_delay: u64,
@@ -108,11 +110,17 @@ struct PathfindingItem {
     /// The associated location
     location: PathItemLocation,
     /// Time at which the train should arrive at the location, if specified
-    arrival_time: Option<DateTime<Utc>>,
+    timing_data: Option<StepTimingData>,
+}
+
+#[derive(Debug, Serialize, Deserialize, PartialEq, Clone, ToSchema)]
+struct StepTimingData {
+    /// Time at which the train should arrive at the location
+    arrival_time: DateTime<Utc>,
     /// The train may arrive up to this duration before the expected arrival time
-    arrival_time_tolerance_before: Option<u64>,
+    arrival_time_tolerance_before: u64,
     /// The train may arrive up to this duration after the expected arrival time
-    arrival_time_tolerance_after: Option<u64>,
+    arrival_time_tolerance_after: u64,
 }
 
 const TWO_HOURS_IN_MILLISECONDS: u64 = 2 * 60 * 60 * 60;
@@ -261,7 +269,8 @@ fn get_earliest_departure_time(data: &STDCMRequestPayload, maximum_run_time: u64
     data.start_time.unwrap_or(
         data.steps
             .first()
-            .and_then(|step| step.arrival_time)
+            .and_then(|step| step.timing_data.clone())
+            .and_then(|data| Option::from(data.arrival_time))
             .unwrap_or(
                 get_earliest_step_time(data) - Duration::milliseconds(maximum_run_time as i64),
             ),
@@ -271,13 +280,12 @@ fn get_earliest_departure_time(data: &STDCMRequestPayload, maximum_run_time: u64
 /// 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()
+    data.start_time
         .or_else(|| {
             data.steps
                 .iter()
-                .flat_map(|step| step.arrival_time.iter())
+                .flat_map(|step| step.timing_data.iter())
+                .map(|data| data.arrival_time)
                 .next()
         })
         .expect("No time specified for stdcm request")
@@ -425,9 +433,13 @@ async fn parse_stdcm_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,
+            step_timing_data: path_item.timing_data.as_ref().map(|timing_data| {
+                STDCMStepTimingData {
+                    arrival_time: timing_data.arrival_time,
+                    arrival_time_tolerance_before: timing_data.arrival_time_tolerance_before,
+                    arrival_time_tolerance_after: timing_data.arrival_time_tolerance_after,
+                }
+            }),
         })
         .collect())
 }

front/src/common/api/generatedEditoastApi.ts

@@ -1753,7 +1753,8 @@ export type PostV2TimetableByIdStdcmApiArg = {
     comfort: Comfort;
     /** Can be a percentage `X%`, a time in minutes per 100 kilometer `Xmin/100km` or `None` */
     margin?: string | null;
-    /** By how long we can shift the departure time in milliseconds */
+    /** By how long we can shift the departure time in milliseconds
+        Deprecated, first step data should be used instead */
     maximum_departure_delay?: number;
     /** Specifies how long the total run time can be in milliseconds */
     maximum_run_time?: number | null;
@@ -3709,16 +3710,19 @@ export type PathItemLocation =
       /** The [UIC](https://en.wikipedia.org/wiki/List_of_UIC_country_codes) code of an operational point */
       uic: number;
     };
-export type PathfindingItem = {
-  /** Time at which the train should arrive at the location, if specified */
-  arrival_time?: string | null;
+export type StepTimingData = {
+  /** Time at which the train should arrive at the location */
+  arrival_time: string;
   /** The train may arrive up to this duration after the expected arrival time */
-  arrival_time_tolerance_after?: number | null;
+  arrival_time_tolerance_after: number;
   /** The train may arrive up to this duration before the expected arrival time */
-  arrival_time_tolerance_before?: number | null;
+  arrival_time_tolerance_before: number;
+};
+export type PathfindingItem = {
   /** The stop duration in milliseconds, None if the train does not stop. */
   duration?: number | null;
   location: PathItemLocation;
+  timing_data?: StepTimingData | null;
 };
 export type Distribution = 'STANDARD' | 'MARECO';
 export type TrainScheduleBase = {