1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
use crate::grpc::client::{get_clients, GrpcClients};
use crate::router::flight_plan::{get_sorted_flight_plans, FlightPlanSchedule};
use crate::router::schedule::Timeslot;
use crate::router::vehicle::{get_aircraft, get_aircraft_availabilities};
use crate::router::vertiport::{get_timeslot_pairs, TimeslotPair};
use crate::tasks::{Task, TaskAction, TaskBody, TaskError};
use num_traits::FromPrimitive;
use std::collections::HashSet;
use svc_gis_client_grpc::client::UpdateFlightPathRequest;
use svc_gis_client_grpc::prelude::types::AircraftType;
use svc_gis_client_grpc::prelude::GisServiceClient;
use svc_storage_client_grpc::link_service::Client as LinkClient;
use svc_storage_client_grpc::prelude::flight_plan;
use svc_storage_client_grpc::prelude::{itinerary, IdList};
use svc_storage_client_grpc::simple_service::Client as SimpleClient;

/// Register flight plans with svc-storage
async fn register_flight_plans(
    user_id: &uuid::Uuid,
    flight_plans: &[TimeslotPair],
    aircraft_id: &str,
    clients: &GrpcClients,
) -> Result<(), TaskError> {
    //
    // TODO(R5): Do this in a transaction if possible, so that flight plans
    //  are rolled back if any part of the itinerary fails to be created.

    //
    // 1) Add flight plans to `flight_plan` DB table
    //
    let mut flight_plan_ids = vec![];
    for flight_plan in flight_plans.iter() {
        let mut tmp: flight_plan::Data = flight_plan.clone().into();
        tmp.vehicle_id = aircraft_id.to_string();

        let Ok(result) = clients.storage.flight_plan.insert(tmp).await else {
            tasks_error!("(register_flight_plans) Couldn't insert flight plan into storage.");
            return Err(TaskError::Internal);
        };

        let flight_id = match result.into_inner().object {
            Some(object) => object.id,
            None => {
                tasks_error!("(register_flight_plans) Couldn't insert flight plan into storage.");
                return Err(TaskError::Internal);
            }
        };

        let request = UpdateFlightPathRequest {
            flight_identifier: Some(flight_id.clone()),
            aircraft_identifier: Some(aircraft_id.to_string()),
            simulated: false,
            path: flight_plan.path.clone(),
            aircraft_type: AircraftType::Rotorcraft as i32, // TODO(R5): Get from storage
            timestamp_start: Some(flight_plan.origin_timeslot.time_end.into()),
            timestamp_end: Some(flight_plan.target_timeslot.time_start.into()),
        };

        clients.gis.update_flight_path(request).await.map_err(|e| {
            tasks_error!(
                "(register_flight_plans) Couldn't update flight path in GIS: {}",
                e
            );

            // TODO(R5): Rollback the changes in storage
            TaskError::Internal
        })?;

        flight_plan_ids.push(flight_id);
    }

    //
    // 2) Add itinerary to `itinerary` DB table
    //
    let data = itinerary::Data {
        user_id: user_id.to_string(),
        status: itinerary::ItineraryStatus::Active as i32,
    };

    let Ok(result) = clients.storage.itinerary.insert(data).await else {
        tasks_error!("(register_flight_plans) Couldn't insert itinerary into storage.");
        return Err(TaskError::Internal);
    };

    let itinerary_id = match result.into_inner().object {
        Some(object) => object.id,
        None => {
            tasks_error!("(register_flight_plans) Couldn't insert itinerary into storage.");
            return Err(TaskError::Internal);
        }
    };

    //
    // 3) Link flight plans to itinerary in `itinerary_flight_plan`
    //
    if let Err(e) = clients
        .storage
        .itinerary_flight_plan_link
        .link(itinerary::ItineraryFlightPlans {
            id: itinerary_id.clone(),
            other_id_list: Some(IdList {
                ids: flight_plan_ids,
            }),
        })
        .await
    {
        tasks_error!(
            "(register_flight_plans) Couldn't link flight plans to itinerary in storage: {}",
            e
        );
        return Err(TaskError::Internal);
    }

    Ok(())
}

/// Creates an itinerary given a list of flight plans, if valid
pub async fn create_itinerary(task: &mut Task) -> Result<(), TaskError> {
    let Some(TaskAction::CreateItinerary) = FromPrimitive::from_i32(task.metadata.action) else {
        tasks_error!(
            "(create_itinerary) Invalid task action: {}",
            task.metadata.action
        );
        return Err(TaskError::InvalidMetadata);
    };

    let user_id = match uuid::Uuid::parse_str(&task.metadata.user_id.clone()) {
        Ok(user_id) => user_id,
        Err(e) => {
            tasks_error!("(create_itinerary) Invalid user_id: {}", e);
            return Err(TaskError::InvalidUserId);
        }
    };

    let TaskBody::CreateItinerary(ref proposed_flight_plans) = task.body else {
        tasks_error!("(create_itinerary) Invalid task body: {:?}", task.body);
        return Err(TaskError::InvalidData);
    };

    // For retrieving asset information in one go
    let mut vertipad_ids = HashSet::new();
    let mut aircraft_id = String::new();
    if let Err(e) = crate::router::itinerary::validate_itinerary(
        proposed_flight_plans,
        &mut vertipad_ids,
        &mut aircraft_id,
    ) {
        let error_msg = "Invalid itinerary provided";
        tasks_error!("(create_itinerary) {error_msg}: {e}");
        return Err(TaskError::InvalidData);
    }

    if aircraft_id.is_empty() {
        tasks_error!("(create_itinerary) No aircraft provided.");
        return Err(TaskError::InvalidData);
    };

    let vertipad_ids = vertipad_ids.into_iter().collect::<Vec<String>>();

    //
    // Get total block of time needed by the aircraft
    //
    let Some(itinerary_start) = proposed_flight_plans.first() else {
        tasks_error!("(create_itinerary) No flight plans provided.");
        return Err(TaskError::InvalidData);
    };

    let Some(itinerary_end) = proposed_flight_plans.last() else {
        tasks_error!("(create_itinerary) No flight plans provided.");
        return Err(TaskError::InvalidData);
    };

    let aircraft_time_window = Timeslot {
        time_start: itinerary_start.origin_timeslot_start,
        time_end: itinerary_end.target_timeslot_end,
    };

    //
    // Get all aircraft schedules for the time window
    //
    let clients = get_clients().await;

    // Get all flight plans from this time to latest departure time (including partially fitting flight plans)
    // - this assumes that all landed flights have updated vehicle.last_vertiport_id (otherwise we would need to look in to the past)
    let existing_flight_plans: Vec<FlightPlanSchedule> =
        match get_sorted_flight_plans(clients, &aircraft_time_window.time_end).await {
            Ok(plans) => plans,
            Err(e) => {
                let error_str = "Could not get existing flight plans.";
                tasks_error!("(create_itinerary) {} {}", error_str, e);
                return Err(TaskError::Internal);
            }
        };

    // TODO(R5): For R4 we'll manually filter out the plans we don't care about
    //  in R5 if there's a more complicated way to form (A & B) || (C & D) type queries
    //  to storage we'll replace it.
    let existing_flight_plans = existing_flight_plans
        .into_iter()
        .filter(|plan| {
            // Filter out plans that are not in the vertipad list
            vertipad_ids.contains(&plan.origin_vertiport_id)
                || vertipad_ids.contains(&plan.target_vertiport_id)
                || plan.vehicle_id == aircraft_id
        })
        .collect::<Vec<FlightPlanSchedule>>();

    //
    // Get all aircraft availabilities
    //
    let Ok(aircraft) = get_aircraft(clients, Some(aircraft_id.clone())).await else {
        tasks_error!("(create_itinerary) Could not find aircraft.");
        return Err(TaskError::Internal);
    };

    //
    // Get the availability that contains at minimum the requested flight
    // The supplied itinerary (from query_itinerary) should also include the deadhead flights
    let mut aircraft_gaps =
        get_aircraft_availabilities(&existing_flight_plans, &aircraft, &aircraft_time_window)
            .map_err(|e| {
                tasks_error!("(create_itinerary) {}", e);
                TaskError::Internal
            })?;

    let Some(aircraft_gaps) = aircraft_gaps.remove(&aircraft_id) else {
        tasks_error!("(create_itinerary) Aircraft not available for the itinerary.");
        return Err(TaskError::ScheduleConflict);
    };

    if !aircraft_gaps.into_iter().any(|gap| {
        gap.vertiport_id == itinerary_start.origin_vertiport_id
            && gap.vertiport_id == itinerary_end.target_vertiport_id
            && gap.timeslot.time_start <= aircraft_time_window.time_start
            && gap.timeslot.time_end >= aircraft_time_window.time_end
    }) {
        tasks_error!("(create_itinerary) No available aircraft.");
        return Err(TaskError::ScheduleConflict);
    };

    // Get available timeslots for departure vertiport that are large enough to
    //  fit the required loading and takeoff time.
    //
    let mut pairs = vec![];
    for flight_plan in proposed_flight_plans {
        let loading_time = flight_plan.origin_timeslot_end - flight_plan.origin_timeslot_start;
        let unloading_time = flight_plan.target_timeslot_end - flight_plan.target_timeslot_start;
        let timeslot = Timeslot {
            time_start: flight_plan.origin_timeslot_start,
            time_end: flight_plan.target_timeslot_end,
        };

        let pair = get_timeslot_pairs(
            &flight_plan.origin_vertiport_id,
            Some(&flight_plan.origin_vertipad_id),
            &flight_plan.target_vertiport_id,
            Some(&flight_plan.target_vertipad_id),
            &loading_time,
            &unloading_time,
            &timeslot,
            &existing_flight_plans,
            clients,
        )
        .await
        .map_err(|e| {
            tasks_error!("(create_itinerary) {}", e);
            TaskError::ScheduleConflict
        })?
        .first()
        .ok_or_else(|| {
            tasks_info!("(create_itinerary) No routes available for the given time.");
            TaskError::ScheduleConflict
        })?
        .clone();

        pairs.push(pair);
    }

    // If we've reached this point, the itinerary is valid
    // Register it with svc-storage
    register_flight_plans(&user_id, &pairs, &aircraft_id, clients).await
}

#[cfg(test)]
mod tests {
    use super::*;
    use cfg_if::cfg_if;

    cfg_if! {
        if #[cfg(feature = "stub_client")] {
            use crate::router::flight_plan::FlightPlanSchedule;
            use chrono::{Duration, Utc};
        }
    }

    use crate::tasks::{TaskAction, TaskBody, TaskMetadata};
    use uuid::Uuid;

    type TaskResult = Result<(), TaskError>;

    #[tokio::test]
    async fn ut_create_itinerary_invalid_task_body() -> TaskResult {
        let mut task = Task {
            metadata: TaskMetadata {
                action: TaskAction::CreateItinerary as i32,
                user_id: Uuid::new_v4().to_string(),
                ..Default::default()
            },
            body: TaskBody::CancelItinerary(Uuid::new_v4()),
        };

        let e = create_itinerary(&mut task).await.unwrap_err();
        assert_eq!(e, TaskError::InvalidData);

        Ok(())
    }

    #[tokio::test]
    async fn ut_create_itinerary_invalid_metadata() -> TaskResult {
        let mut task = Task {
            metadata: TaskMetadata {
                action: TaskAction::CancelItinerary as i32,
                user_id: Uuid::new_v4().to_string(),
                ..Default::default()
            },
            body: TaskBody::CreateItinerary(vec![]),
        };

        let e = create_itinerary(&mut task).await.unwrap_err();
        assert_eq!(e, TaskError::InvalidMetadata);

        let mut task = Task {
            metadata: TaskMetadata {
                action: TaskAction::CreateItinerary as i32,
                user_id: "invalid".to_string(),
                ..Default::default()
            },
            body: TaskBody::CreateItinerary(vec![]),
        };

        let e = create_itinerary(&mut task).await.unwrap_err();
        assert_eq!(e, TaskError::InvalidUserId);

        Ok(())
    }

    #[tokio::test]
    #[cfg(feature = "stub_client")]
    async fn ut_create_itinerary_schedule_conflict() -> TaskResult {
        let mut task = Task {
            metadata: TaskMetadata {
                action: TaskAction::CreateItinerary as i32,
                user_id: Uuid::new_v4().to_string(),
                ..Default::default()
            },
            body: TaskBody::CreateItinerary(vec![FlightPlanSchedule {
                origin_vertiport_id: Uuid::new_v4().to_string(),
                origin_vertipad_id: Uuid::new_v4().to_string(),
                origin_timeslot_start: Utc::now() + Duration::try_minutes(10).unwrap(),
                origin_timeslot_end: Utc::now() + Duration::try_minutes(11).unwrap(),
                target_vertiport_id: Uuid::new_v4().to_string(),
                target_vertipad_id: Uuid::new_v4().to_string(),
                target_timeslot_start: Utc::now() + Duration::try_minutes(30).unwrap(),
                target_timeslot_end: Utc::now() + Duration::try_minutes(31).unwrap(),
                vehicle_id: Uuid::new_v4().to_string(),
            }]),
        };

        let e = create_itinerary(&mut task).await.unwrap_err();
        assert_eq!(e, TaskError::ScheduleConflict);

        Ok(())
    }
}