editoast, front: import, filter and send to core temporary speed limits

  - Add a temporary_speed_limits table creation migration script.
  - Add a temporary speed limit creation endpoint.
  - Add the active temporary speed limits which are active during
    an stdcm search to the stdcm request sent to core.

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

editoast/editoast_models/src/tables.rs

@@ -640,6 +640,34 @@ diesel::table! {
     }
 }
 
+diesel::table! {
+    use diesel::sql_types::*;
+    use postgis_diesel::sql_types::*;
+
+    temporary_speed_limit (id) {
+        id -> Int8,
+        start_date_time -> Timestamptz,
+        end_date_time -> Timestamptz,
+        speed_limit -> Float8,
+        track_ranges -> Jsonb,
+        #[max_length = 255]
+        obj_id -> Varchar,
+        temporary_speed_limit_group_id -> Int8,
+    }
+}
+
+diesel::table! {
+    use diesel::sql_types::*;
+    use postgis_diesel::sql_types::*;
+
+    temporary_speed_limit_group (id) {
+        id -> Int8,
+        creation_date -> Timestamptz,
+        #[max_length = 255]
+        name -> Varchar,
+    }
+}
+
 diesel::table! {
     use diesel::sql_types::*;
     use postgis_diesel::sql_types::*;
@@ -749,6 +777,7 @@ diesel::joinable!(stdcm_search_environment -> infra (infra_id));
 diesel::joinable!(stdcm_search_environment -> timetable (timetable_id));
 diesel::joinable!(stdcm_search_environment -> work_schedule_group (work_schedule_group_id));
 diesel::joinable!(study -> project (project_id));
+diesel::joinable!(temporary_speed_limit -> temporary_speed_limit_group (temporary_speed_limit_group_id));
 diesel::joinable!(train_schedule -> timetable (timetable_id));
 diesel::joinable!(work_schedule -> work_schedule_group (work_schedule_group_id));
 
@@ -797,6 +826,8 @@ diesel::allow_tables_to_appear_in_same_query!(
     search_track,
     stdcm_search_environment,
     study,
+    temporary_speed_limit,
+    temporary_speed_limit_group,
     timetable,
     train_schedule,
     work_schedule,

editoast/editoast_schemas/src/infra.rs

@@ -109,4 +109,6 @@ editoast_common::schemas! {
     track_location::schemas(),
     track_offset::schemas(),
     track_section::schemas(),
+    track_range::schemas(),
+    directional_track_range::schemas(),
 }

editoast/editoast_schemas/src/infra/track_range.rs

@@ -4,6 +4,10 @@ use serde::Deserialize;
 use serde::Serialize;
 use utoipa::ToSchema;
 
+editoast_common::schemas! {
+    TrackRange,
+}
+
 #[derive(Debug, Derivative, Clone, Deserialize, Serialize, PartialEq, ToSchema)]
 #[serde(deny_unknown_fields)]
 #[derivative(Default)]

editoast/migrations/2024-09-06-153144_add_ltv_table/down.sql

@@ -0,0 +1,2 @@
+DROP TABLE temporary_speed_limit;
+DROP TABLE temporary_speed_limit_group;

editoast/migrations/2024-09-06-153144_add_ltv_table/up.sql

@@ -0,0 +1,19 @@
+CREATE TABLE temporary_speed_limit_group(
+    id int8 PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY,
+    creation_date timestamptz NOT NULL,
+    name varchar(255) NOT NULL UNIQUE
+);
+
+CREATE TABLE temporary_speed_limit (
+    id int8 PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY,
+    start_date_time timestamptz NOT NULL,
+    end_date_time timestamptz NOT NULL,
+    speed_limit float8 NOT NULL,
+    track_ranges jsonb NOT NULL,
+    obj_id VARCHAR(255) NOT NULL,
+    temporary_speed_limit_group_id int8 NOT NULL REFERENCES temporary_speed_limit_group(id) ON DELETE CASCADE,
+    CONSTRAINT valid_time_period CHECK (start_date_time < end_date_time)
+);
+
+CREATE INDEX "temporary_speed_limit_date_time" ON "temporary_speed_limit" ("start_date_time");
+CREATE INDEX "temporary_speed_limit_end_date_time" ON "temporary_speed_limit" ("end_date_time");

editoast/openapi.yaml

@@ -2229,6 +2229,61 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/StdcmSearchEnvironment'
+  /temporary_speed_limit_group:
+    post:
+      tags:
+      - temporary_speed_limits
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - speed_limit_group_name
+              - speed_limits
+              properties:
+                speed_limit_group_name:
+                  type: string
+                speed_limits:
+                  type: array
+                  items:
+                    type: object
+                    required:
+                    - start_date_time
+                    - end_date_time
+                    - track_ranges
+                    - speed_limit
+                    - obj_id
+                    properties:
+                      end_date_time:
+                        type: string
+                        format: date-time
+                      obj_id:
+                        type: string
+                      speed_limit:
+                        type: number
+                        format: double
+                      start_date_time:
+                        type: string
+                        format: date-time
+                      track_ranges:
+                        type: array
+                        items:
+                          $ref: '#/components/schemas/DirectionalTrackRange'
+        required: true
+      responses:
+        '201':
+          description: The id of the created temporary speed limit group.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                - group_id
+                properties:
+                  group_id:
+                    type: integer
+                    format: int64
   /timetable:
     post:
       tags:
@@ -2393,6 +2448,10 @@ paths:
                   type: array
                   items:
                     $ref: '#/components/schemas/PathfindingItem'
+                temporary_speed_limit_group_id:
+                  type: integer
+                  format: int64
+                  nullable: true
                 time_gap_after:
                   type: integer
                   format: int64
@@ -3880,6 +3939,7 @@ components:
       - $ref: '#/components/schemas/EditoastSpriteErrorsUnknownSignalingSystem'
       - $ref: '#/components/schemas/EditoastStudyErrorNotFound'
       - $ref: '#/components/schemas/EditoastStudyErrorStartDateAfterEndDate'
+      - $ref: '#/components/schemas/EditoastTemporarySpeedLimitErrorNameAlreadyUsed'
       - $ref: '#/components/schemas/EditoastTimetableErrorInfraNotFound'
       - $ref: '#/components/schemas/EditoastTimetableErrorNotFound'
       - $ref: '#/components/schemas/EditoastTrainScheduleErrorBatchTrainScheduleNotFound'
@@ -5048,6 +5108,30 @@ components:
           type: string
           enum:
           - editoast:study:StartDateAfterEndDate
+    EditoastTemporarySpeedLimitErrorNameAlreadyUsed:
+      type: object
+      required:
+      - type
+      - status
+      - message
+      properties:
+        context:
+          type: object
+          required:
+          - name
+          properties:
+            name:
+              type: string
+        message:
+          type: string
+        status:
+          type: integer
+          enum:
+          - 400
+        type:
+          type: string
+          enum:
+          - editoast:temporary_speed_limit:NameAlreadyUsed
     EditoastTimetableErrorInfraNotFound:
       type: object
       required:
@@ -8199,6 +8283,10 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/PathfindingItem'
+        temporary_speed_limit_group_id:
+          type: integer
+          format: int64
+          nullable: true
         time_gap_after:
           type: integer
           format: int64

editoast/src/core/conflict_detection.rs

@@ -9,7 +9,7 @@ use crate::core::{AsCoreRequest, Json};
 
 use super::simulation::RoutingRequirement;
 use super::simulation::SpacingRequirement;
-use super::stdcm::LightWorkSchedule;
+use super::stdcm::WorkSchedule;
 
 editoast_common::schemas! {
     ConflictDetectionResponse,
@@ -39,7 +39,7 @@ pub struct TrainRequirements {
 #[derive(Debug, Serialize)]
 pub struct WorkSchedulesRequest {
     pub start_time: DateTime<Utc>,
-    pub work_schedule_requirements: HashMap<i64, LightWorkSchedule>,
+    pub work_schedule_requirements: HashMap<i64, WorkSchedule>,
 }
 
 #[derive(Debug, Deserialize, ToSchema)]

editoast/src/core/pathfinding.rs

@@ -130,6 +130,17 @@ pub struct TrackRange {
     pub direction: Direction,
 }
 
+impl From<editoast_schemas::infra::DirectionalTrackRange> for TrackRange {
+    fn from(value: editoast_schemas::infra::DirectionalTrackRange) -> Self {
+        TrackRange {
+            track_section: value.track,
+            begin: (value.begin * 1000.).round() as u64,
+            end: (value.end * 1000.).round() as u64,
+            direction: value.direction,
+        }
+    }
+}
+
 impl TrackRange {
     #[cfg(test)]
     /// Creates a new `TrackRange`.

editoast/src/core/stdcm.rs

@@ -14,6 +14,7 @@ use serde::Serialize;
 use utoipa::ToSchema;
 
 use super::pathfinding::PathfindingResultSuccess;
+use super::pathfinding::TrackRange;
 use super::simulation::PhysicsRollingStock;
 use super::simulation::SimulationResponse;
 use crate::core::{AsCoreRequest, Json};
@@ -55,7 +56,9 @@ pub struct STDCMRequest {
     /// Margin to apply to the whole train
     pub margin: Option<MarginValue>,
     /// List of planned work schedules
-    pub work_schedules: Vec<LightWorkSchedule>,
+    pub work_schedules: Vec<WorkSchedule>,
+    /// List of applicable temporary speed limits between the train departure and arrival
+    pub temporary_speed_limits: Vec<TemporarySpeedLimit>,
 }
 
 #[derive(Debug, Serialize)]
@@ -79,9 +82,9 @@ pub struct STDCMStepTimingData {
     pub arrival_time_tolerance_after: u64,
 }
 
-/// Lighter description of a work schedule, only contains what's relevant
+/// Lighter description of a work schedule, with only the relevant information for core
 #[derive(Debug, Serialize)]
-pub struct LightWorkSchedule {
+pub struct WorkSchedule {
     /// Start time as a time delta from the stdcm start time in ms
     pub start_time: u64,
     /// End time as a time delta from the stdcm start time in ms
@@ -90,6 +93,15 @@ pub struct LightWorkSchedule {
     pub track_ranges: Vec<UndirectedTrackRange>,
 }
 
+/// Lighter description of a work schedule with only the relevant information for core
+#[derive(Debug, Serialize)]
+pub struct TemporarySpeedLimit {
+    /// Speed limitation in m/s
+    pub speed_limit: f64,
+    /// Track ranges on which the speed limitation applies
+    pub track_ranges: Vec<TrackRange>,
+}
+
 /// A range on a track section.
 /// `begin` is always less than `end`.
 #[derive(Serialize, Deserialize, Clone, Debug, ToSchema, Hash, PartialEq, Eq)]

editoast/src/models/mod.rs

@@ -19,6 +19,7 @@ pub mod rolling_stock_model;
 pub mod scenario;
 pub mod stdcm_search_environment;
 pub mod study;
+pub mod temporary_speed_limits;
 pub mod timetable;
 pub mod train_schedule;
 pub mod work_schedules;

editoast/src/models/temporary_speed_limits.rs

@@ -0,0 +1,43 @@
+use chrono::NaiveDateTime;
+use editoast_derive::Model;
+use editoast_models::tables::{temporary_speed_limit, temporary_speed_limit_group};
+use editoast_schemas::infra::DirectionalTrackRange;
+use serde::Serialize;
+
+use crate::core::stdcm::TemporarySpeedLimit as CoreTemporarySpeedLimit;
+
+#[derive(Debug, Clone, Model)]
+#[model(table = temporary_speed_limit_group)]
+#[model(gen(ops = crd, batch_ops = c, list))]
+pub struct TemporarySpeedLimitGroup {
+    pub id: i64,
+    pub creation_date: NaiveDateTime,
+    pub name: String,
+}
+
+#[derive(Debug, Serialize, Clone, Model)]
+#[model(table = temporary_speed_limit)]
+#[model(gen(ops = cr, batch_ops = c, list))]
+pub struct TemporarySpeedLimit {
+    pub id: i64,
+    pub start_date_time: NaiveDateTime,
+    pub end_date_time: NaiveDateTime,
+    pub speed_limit: f64,
+    #[model(json)]
+    pub track_ranges: Vec<DirectionalTrackRange>,
+    pub obj_id: String,
+    pub temporary_speed_limit_group_id: i64,
+}
+
+impl From<TemporarySpeedLimit> for CoreTemporarySpeedLimit {
+    fn from(value: TemporarySpeedLimit) -> Self {
+        CoreTemporarySpeedLimit {
+            speed_limit: value.speed_limit,
+            track_ranges: value
+                .track_ranges
+                .into_iter()
+                .map(|track_range| track_range.into())
+                .collect(),
+        }
+    }
+}

editoast/src/views/mod.rs

@@ -15,6 +15,7 @@ pub mod speed_limit_tags;
 pub mod sprites;
 pub mod stdcm_search_environment;
 pub mod study;
+pub mod temporary_speed_limits;
 pub mod timetable;
 pub mod train_schedule;
 pub mod work_schedules;
@@ -77,6 +78,7 @@ crate::routes! {
     &sprites,
     &stdcm_search_environment,
     &work_schedules,
+    &temporary_speed_limits,
     &train_schedule,
     &timetable,
     &path,

editoast/src/views/path.rs

@@ -23,7 +23,6 @@ editoast_common::schemas! {
     pathfinding::schemas(),
     projection::schemas(),
     properties::schemas(),
-    TrackRange,
 }
 
 #[derive(Debug, Error, EditoastError)]