torc 0.23.0

Workflow management system
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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
//! Resource requirements-related API endpoints

#![allow(clippy::too_many_arguments)]

use crate::server::transport_types::context_types::{ApiError, Has, XSpanIdString};
use async_trait::async_trait;
use log::{debug, error, info};
use sqlx::Row;

use crate::server::api_responses::{
    CreateResourceRequirementsResponse, DeleteAllResourceRequirementsResponse,
    DeleteResourceRequirementsResponse, GetResourceRequirementsResponse,
    ListResourceRequirementsResponse, UpdateResourceRequirementsResponse,
};

use crate::memory_utils::memory_string_to_bytes;
use crate::models;
use crate::time_utils::duration_string_to_seconds;

use super::{ApiContext, MAX_RECORD_TRANSFER_COUNT, SqlQueryBuilder, database_error_with_msg};

/// Trait defining resource requirements-related API operations
#[async_trait]
pub trait ResourceRequirementsApi<C> {
    /// Store one resource requirements record.
    async fn create_resource_requirements(
        &self,
        mut body: models::ResourceRequirementsModel,
        context: &C,
    ) -> Result<CreateResourceRequirementsResponse, ApiError>;

    /// Delete all resource requirements for one workflow.
    async fn delete_all_resource_requirements(
        &self,
        workflow_id: i64,
        context: &C,
    ) -> Result<DeleteAllResourceRequirementsResponse, ApiError>;

    /// Retrieve a resource requirements record by ID.
    async fn get_resource_requirements(
        &self,
        id: i64,
        context: &C,
    ) -> Result<GetResourceRequirementsResponse, ApiError>;

    /// Retrieve all resource requirements records for one workflow.
    async fn list_resource_requirements(
        &self,
        workflow_id: i64,
        job_id: Option<i64>,
        name: Option<String>,
        memory: Option<String>,
        num_cpus: Option<i64>,
        num_gpus: Option<i64>,
        num_nodes: Option<i64>,
        runtime: Option<i64>,
        offset: i64,
        limit: i64,
        sort_by: Option<String>,
        reverse_sort: Option<bool>,
        context: &C,
    ) -> Result<ListResourceRequirementsResponse, ApiError>;

    /// Update a resource requirements record.
    async fn update_resource_requirements(
        &self,
        id: i64,
        body: models::ResourceRequirementsModel,
        context: &C,
    ) -> Result<UpdateResourceRequirementsResponse, ApiError>;

    /// Delete a resource requirements record.
    async fn delete_resource_requirements(
        &self,
        id: i64,
        context: &C,
    ) -> Result<DeleteResourceRequirementsResponse, ApiError>;
}

/// Implementation of resource requirements API for the server
#[derive(Clone)]
pub struct ResourceRequirementsApiImpl {
    pub context: ApiContext,
}

const RESOURCE_REQUIREMENTS_COLUMNS: &[&str] = &[
    "id",
    "workflow_id",
    "name",
    "num_cpus",
    "num_gpus",
    "num_nodes",
    "memory",
    "runtime",
];

impl ResourceRequirementsApiImpl {
    pub fn new(context: ApiContext) -> Self {
        Self { context }
    }
}

#[async_trait]
impl<C> ResourceRequirementsApi<C> for ResourceRequirementsApiImpl
where
    C: Has<XSpanIdString> + Send + Sync,
{
    /// Store one resource requirements record.
    async fn create_resource_requirements(
        &self,
        mut body: models::ResourceRequirementsModel,
        context: &C,
    ) -> Result<CreateResourceRequirementsResponse, ApiError> {
        debug!(
            "create_resource_requirements - X-Span-ID: {:?}",
            context.get().0.clone()
        );

        let memory_bytes = match memory_string_to_bytes(&body.memory) {
            Ok(bytes) => bytes,
            Err(e) => {
                let error_response = models::ErrorResponse::new(serde_json::json!({
                    "message": format!("Invalid memory format '{}': {}", body.memory, e),
                    "field": "memory",
                    "value": body.memory
                }));
                return Ok(
                    CreateResourceRequirementsResponse::UnprocessableContentErrorResponse(
                        error_response,
                    ),
                );
            }
        };

        let runtime_seconds = match duration_string_to_seconds(&body.runtime) {
            Ok(seconds) => seconds,
            Err(e) => {
                let error_response = models::ErrorResponse::new(serde_json::json!({
                    "message": format!("Invalid runtime format '{}': {}", body.runtime, e),
                    "field": "runtime",
                    "value": body.runtime
                }));
                return Ok(
                    CreateResourceRequirementsResponse::UnprocessableContentErrorResponse(
                        error_response,
                    ),
                );
            }
        };

        if body.num_cpus <= 0 {
            let error_response = models::ErrorResponse::new(serde_json::json!({
                "message": format!("num_cpus must be > 0, got {}", body.num_cpus),
                "field": "num_cpus",
                "value": body.num_cpus
            }));
            return Ok(
                CreateResourceRequirementsResponse::UnprocessableContentErrorResponse(
                    error_response,
                ),
            );
        }

        if body.num_nodes <= 0 {
            let error_response = models::ErrorResponse::new(serde_json::json!({
                "message": format!("num_nodes must be > 0, got {}", body.num_nodes),
                "field": "num_nodes",
                "value": body.num_nodes
            }));
            return Ok(
                CreateResourceRequirementsResponse::UnprocessableContentErrorResponse(
                    error_response,
                ),
            );
        }

        let result = match sqlx::query!(
            r#"
            INSERT INTO resource_requirements
            (
                workflow_id
                ,name
                ,num_cpus
                ,num_gpus
                ,num_nodes
                ,memory
                ,runtime
                ,memory_bytes
                ,runtime_s
            )
            VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9)
            RETURNING rowid
        "#,
            body.workflow_id,
            body.name,
            body.num_cpus,
            body.num_gpus,
            body.num_nodes,
            body.memory,
            body.runtime,
            memory_bytes,
            runtime_seconds,
        )
        .fetch_one(self.context.pool.as_ref())
        .await
        {
            Ok(result) => result,
            Err(e) => {
                return Err(database_error_with_msg(
                    e,
                    "Failed to create resource requirements record",
                ));
            }
        };
        body.id = Some(result.id);
        Ok(CreateResourceRequirementsResponse::SuccessfulResponse(body))
    }

    /// Delete all resource requirements for one workflow.
    async fn delete_all_resource_requirements(
        &self,
        workflow_id: i64,
        context: &C,
    ) -> Result<DeleteAllResourceRequirementsResponse, ApiError> {
        debug!(
            "delete_all_resource_requirements({}) - X-Span-ID: {:?}",
            workflow_id,
            context.get().0.clone()
        );

        let result = match sqlx::query!(
            "DELETE FROM resource_requirements WHERE workflow_id = $1",
            workflow_id
        )
        .execute(self.context.pool.as_ref())
        .await
        {
            Ok(result) => result,
            Err(e) => {
                return Err(database_error_with_msg(
                    e,
                    "Failed to delete all resource requirements",
                ));
            }
        };

        let deleted_count = result.rows_affected() as i64;

        info!(
            "Deleted {} resource requirements for workflow {}",
            deleted_count, workflow_id
        );

        Ok(DeleteAllResourceRequirementsResponse::SuccessfulResponse(
            serde_json::json!({
                "count": deleted_count
            }),
        ))
    }

    /// Retrieve a resource requirements record by ID.
    async fn get_resource_requirements(
        &self,
        id: i64,
        context: &C,
    ) -> Result<GetResourceRequirementsResponse, ApiError> {
        debug!(
            "get_resource_requirements({}) - X-Span-ID: {:?}",
            id,
            context.get().0.clone()
        );

        let record = match sqlx::query!(
            r#"
                SELECT id, workflow_id, name, num_cpus, num_gpus, num_nodes, memory, runtime
                FROM resource_requirements
                WHERE id = $1
            "#,
            id
        )
        .fetch_optional(self.context.pool.as_ref())
        .await
        {
            Ok(Some(rec)) => rec,
            Ok(None) => {
                let error_response = models::ErrorResponse::new(serde_json::json!({
                    "message": format!("Resource requirements not found with ID: {}", id)
                }));
                return Ok(GetResourceRequirementsResponse::NotFoundErrorResponse(
                    error_response,
                ));
            }
            Err(e) => {
                return Err(database_error_with_msg(
                    e,
                    "Failed to fetch resource requirements",
                ));
            }
        };

        let resource_requirements = models::ResourceRequirementsModel {
            id: Some(record.id),
            workflow_id: record.workflow_id,
            name: record.name,
            num_cpus: record.num_cpus,
            num_gpus: record.num_gpus,
            num_nodes: record.num_nodes,
            memory: record.memory,
            runtime: record.runtime,
        };

        Ok(GetResourceRequirementsResponse::SuccessfulResponse(
            resource_requirements,
        ))
    }

    /// Retrieve all resource requirements records for one workflow.
    async fn list_resource_requirements(
        &self,
        workflow_id: i64,
        job_id: Option<i64>,
        name: Option<String>,
        memory: Option<String>,
        num_cpus: Option<i64>,
        num_gpus: Option<i64>,
        num_nodes: Option<i64>,
        runtime: Option<i64>,
        offset: i64,
        limit: i64,
        sort_by: Option<String>,
        reverse_sort: Option<bool>,
        context: &C,
    ) -> Result<ListResourceRequirementsResponse, ApiError> {
        debug!(
            "list_resource_requirements({}, {:?}, {:?}, {:?}, {:?}, {:?}, {:?}, {:?}, {}, {}, {:?}, {:?}) - X-Span-ID: {:?}",
            workflow_id,
            job_id,
            name,
            memory,
            num_cpus,
            num_gpus,
            num_nodes,
            runtime,
            offset,
            limit,
            sort_by,
            reverse_sort,
            context.get().0.clone()
        );

        // Build base query
        let base_query = "SELECT id, workflow_id, name, num_cpus, num_gpus, num_nodes, memory, runtime FROM resource_requirements".to_string();

        // Build WHERE clause conditions
        let mut where_conditions = vec!["workflow_id = ?".to_string()];

        if job_id.is_some() {
            where_conditions
                .push("id IN (SELECT resource_requirements_id FROM jobs WHERE id = ?)".to_string());
        }

        if name.is_some() {
            where_conditions.push("name = ?".to_string());
        }

        if memory.is_some() {
            where_conditions.push("memory = ?".to_string());
        }

        if num_cpus.is_some() {
            where_conditions.push("num_cpus = ?".to_string());
        }

        if num_gpus.is_some() {
            where_conditions.push("num_gpus = ?".to_string());
        }

        if num_nodes.is_some() {
            where_conditions.push("num_nodes = ?".to_string());
        }

        if runtime.is_some() {
            where_conditions.push("runtime_s = ?".to_string());
        }

        let where_clause = where_conditions.join(" AND ");

        // Validate sort_by against whitelist
        let validated_sort_by = if let Some(ref col) = sort_by {
            if RESOURCE_REQUIREMENTS_COLUMNS.contains(&col.as_str()) {
                Some(col.clone())
            } else {
                debug!("Invalid sort column requested: {}", col);
                None // Fall back to default
            }
        } else {
            None
        };

        // Build the complete query with pagination and sorting
        let query = SqlQueryBuilder::new(base_query)
            .with_where(where_clause.clone())
            .with_pagination_and_sorting(
                offset,
                limit,
                validated_sort_by,
                reverse_sort,
                "id",
                RESOURCE_REQUIREMENTS_COLUMNS,
            )
            .build();

        debug!("Executing query: {}", query);

        // Execute the query
        let mut sqlx_query = sqlx::query(&query);

        // Bind workflow_id first
        sqlx_query = sqlx_query.bind(workflow_id);

        // Bind optional parameters in order they appear in the WHERE clause
        if let Some(job_id_val) = job_id {
            sqlx_query = sqlx_query.bind(job_id_val);
        }

        if let Some(name_filter) = &name {
            sqlx_query = sqlx_query.bind(name_filter);
        }

        if let Some(memory_filter) = &memory {
            sqlx_query = sqlx_query.bind(memory_filter);
        }

        if let Some(num_cpus_filter) = num_cpus {
            sqlx_query = sqlx_query.bind(num_cpus_filter);
        }

        if let Some(num_gpus_filter) = num_gpus {
            sqlx_query = sqlx_query.bind(num_gpus_filter);
        }

        if let Some(num_nodes_filter) = num_nodes {
            sqlx_query = sqlx_query.bind(num_nodes_filter);
        }

        if let Some(runtime_filter) = runtime {
            sqlx_query = sqlx_query.bind(runtime_filter);
        }

        let records = match sqlx_query.fetch_all(self.context.pool.as_ref()).await {
            Ok(recs) => recs,
            Err(e) => {
                return Err(database_error_with_msg(
                    e,
                    "Failed to list resource requirements",
                ));
            }
        };

        let mut items: Vec<models::ResourceRequirementsModel> = Vec::new();
        for record in records {
            items.push(models::ResourceRequirementsModel {
                id: Some(record.get("id")),
                workflow_id: record.get("workflow_id"),
                name: record.get("name"),
                num_cpus: record.get("num_cpus"),
                num_gpus: record.get("num_gpus"),
                num_nodes: record.get("num_nodes"),
                memory: record.get("memory"),
                runtime: record.get("runtime"),
            });
        }

        // For proper pagination, we should get the total count without LIMIT/OFFSET
        let count_query =
            SqlQueryBuilder::new("SELECT COUNT(*) as total FROM resource_requirements".to_string())
                .with_where(where_clause)
                .build();

        let mut count_sqlx_query = sqlx::query(&count_query);
        count_sqlx_query = count_sqlx_query.bind(workflow_id);

        if let Some(job_id_val) = job_id {
            count_sqlx_query = count_sqlx_query.bind(job_id_val);
        }

        if let Some(name_filter) = &name {
            count_sqlx_query = count_sqlx_query.bind(name_filter);
        }

        if let Some(memory_filter) = &memory {
            count_sqlx_query = count_sqlx_query.bind(memory_filter);
        }

        if let Some(num_cpus_filter) = num_cpus {
            count_sqlx_query = count_sqlx_query.bind(num_cpus_filter);
        }

        if let Some(num_gpus_filter) = num_gpus {
            count_sqlx_query = count_sqlx_query.bind(num_gpus_filter);
        }

        if let Some(num_nodes_filter) = num_nodes {
            count_sqlx_query = count_sqlx_query.bind(num_nodes_filter);
        }

        if let Some(runtime_filter) = runtime {
            count_sqlx_query = count_sqlx_query.bind(runtime_filter);
        }

        let total_count = match count_sqlx_query.fetch_one(self.context.pool.as_ref()).await {
            Ok(row) => row.get::<i64, _>("total"),
            Err(e) => {
                return Err(database_error_with_msg(
                    e,
                    "Failed to list resource requirements",
                ));
            }
        };

        let current_count = items.len() as i64;
        let offset_val = offset;
        let has_more = offset_val + current_count < total_count;

        debug!(
            "list_resource_requirements({}, {}/{}) - X-Span-ID: {:?}",
            workflow_id,
            current_count,
            total_count,
            context.get().0.clone()
        );

        Ok(ListResourceRequirementsResponse::SuccessfulResponse(
            models::ListResourceRequirementsResponse {
                items,
                offset: offset_val,
                max_limit: MAX_RECORD_TRANSFER_COUNT,
                count: current_count,
                total_count,
                has_more,
            },
        ))
    }

    /// Update a resource requirements record.
    async fn update_resource_requirements(
        &self,
        id: i64,
        body: models::ResourceRequirementsModel,
        context: &C,
    ) -> Result<UpdateResourceRequirementsResponse, ApiError> {
        debug!(
            "update_resource_requirements({}) - X-Span-ID: {:?}",
            id,
            context.get().0.clone()
        );

        let memory_bytes = match memory_string_to_bytes(&body.memory) {
            Ok(bytes) => bytes,
            Err(e) => {
                let error_response = models::ErrorResponse::new(serde_json::json!({
                    "message": format!("Invalid memory format '{}': {}", body.memory, e),
                    "field": "memory",
                    "value": body.memory
                }));
                return Ok(
                    UpdateResourceRequirementsResponse::UnprocessableContentErrorResponse(
                        error_response,
                    ),
                );
            }
        };

        let runtime_seconds = match duration_string_to_seconds(&body.runtime) {
            Ok(seconds) => seconds,
            Err(e) => {
                let error_response = models::ErrorResponse::new(serde_json::json!({
                    "message": format!("Invalid runtime format '{}': {}", body.runtime, e),
                    "field": "runtime",
                    "value": body.runtime
                }));
                return Ok(
                    UpdateResourceRequirementsResponse::UnprocessableContentErrorResponse(
                        error_response,
                    ),
                );
            }
        };

        // First check if the record exists
        match self.get_resource_requirements(id, context).await? {
            GetResourceRequirementsResponse::SuccessfulResponse(_) => {}
            GetResourceRequirementsResponse::ForbiddenErrorResponse(err) => {
                return Ok(UpdateResourceRequirementsResponse::ForbiddenErrorResponse(
                    err,
                ));
            }
            GetResourceRequirementsResponse::NotFoundErrorResponse(err) => {
                return Ok(UpdateResourceRequirementsResponse::NotFoundErrorResponse(
                    err,
                ));
            }
            GetResourceRequirementsResponse::DefaultErrorResponse(_) => {
                return Err(ApiError("Failed to get resource requirements".to_string()));
            }
        };

        if body.num_cpus <= 0 {
            let error_response = models::ErrorResponse::new(serde_json::json!({
                "message": format!("num_cpus must be > 0, got {}", body.num_cpus),
                "field": "num_cpus",
                "value": body.num_cpus
            }));
            return Ok(
                UpdateResourceRequirementsResponse::UnprocessableContentErrorResponse(
                    error_response,
                ),
            );
        }

        if body.num_nodes <= 0 {
            let error_response = models::ErrorResponse::new(serde_json::json!({
                "message": format!("num_nodes must be > 0, got {}", body.num_nodes),
                "field": "num_nodes",
                "value": body.num_nodes
            }));
            return Ok(
                UpdateResourceRequirementsResponse::UnprocessableContentErrorResponse(
                    error_response,
                ),
            );
        }

        // Update the record
        match sqlx::query!(
            r#"
            UPDATE resource_requirements
            SET workflow_id = $1,
                name = $2,
                num_cpus = $3,
                num_gpus = $4,
                num_nodes = $5,
                memory = $6,
                runtime = $7,
                memory_bytes = $8,
                runtime_s = $9
            WHERE id = $10
            "#,
            body.workflow_id,
            body.name,
            body.num_cpus,
            body.num_gpus,
            body.num_nodes,
            body.memory,
            body.runtime,
            memory_bytes,
            runtime_seconds,
            id,
        )
        .execute(self.context.pool.as_ref())
        .await
        {
            Ok(_) => {
                info!(
                    "Updated resource requirements with id: {} (name: {:?})",
                    id, body.name
                );
                let mut updated_body = body;
                updated_body.id = Some(id);
                Ok(UpdateResourceRequirementsResponse::SuccessfulResponse(
                    updated_body,
                ))
            }
            Err(e) => Err(database_error_with_msg(
                e,
                "Failed to update resource requirements",
            )),
        }
    }

    /// Delete a resource requirements record.
    async fn delete_resource_requirements(
        &self,
        id: i64,
        context: &C,
    ) -> Result<DeleteResourceRequirementsResponse, ApiError> {
        debug!(
            "delete_resource_requirements({}) - X-Span-ID: {:?}",
            id,
            context.get().0.clone()
        );

        // First get the resource requirements to ensure it exists and extract the ResourceRequirementsModel
        let resource_requirements = match self.get_resource_requirements(id, context).await? {
            GetResourceRequirementsResponse::SuccessfulResponse(resource_requirements) => {
                resource_requirements
            }
            GetResourceRequirementsResponse::ForbiddenErrorResponse(err) => {
                return Ok(DeleteResourceRequirementsResponse::ForbiddenErrorResponse(
                    err,
                ));
            }
            GetResourceRequirementsResponse::NotFoundErrorResponse(err) => {
                return Ok(DeleteResourceRequirementsResponse::NotFoundErrorResponse(
                    err,
                ));
            }
            GetResourceRequirementsResponse::DefaultErrorResponse(_) => {
                return Err(ApiError("Failed to get resource requirements".to_string()));
            }
        };

        match sqlx::query!(r#"DELETE FROM resource_requirements WHERE id = $1"#, id)
            .execute(self.context.pool.as_ref())
            .await
        {
            Ok(res) => {
                if res.rows_affected() > 1 {
                    Err(ApiError(format!(
                        "Database error: Unexpected number of rows affected: {}",
                        res.rows_affected()
                    )))
                } else if res.rows_affected() == 0 {
                    Err(ApiError("Database error: No rows affected".to_string()))
                } else {
                    info!("Deleted resource requirements with id: {}", id);
                    Ok(DeleteResourceRequirementsResponse::SuccessfulResponse(
                        resource_requirements,
                    ))
                }
            }
            Err(e) => {
                error!("Database error: {}", e);
                return Err(database_error_with_msg(
                    e,
                    "Failed to delete resource requirements",
                ));
            }
        }
    }
}

// Tests for memory_string_to_bytes are in src/memory_utils.rs