stormchaser-api 1.3.2

A robust, distributed workflow engine for event-driven and human-triggered workflows.
Documentation
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
use crate::db;
use async_nats::jetstream;
use chrono::Utc;
use std::collections::HashMap;
use std::env;
use stormchaser_model::cron;
use stormchaser_model::events::WorkflowQueuedEvent;
use stormchaser_model::events::{EventSource, EventType, SchemaVersion, WorkflowEventType};
use stormchaser_model::nats::{publish_cloudevent, NatsSubject};
use stormchaser_model::workflow::RunStatus;
use stormchaser_model::CronWorkflowId;
use stormchaser_model::RunId;

use super::{CreateCronWorkflowRequest, CronWorkflowResponse, EnqueueResponse};
use crate::{AppState, AuthClaims};
use axum::{
    extract::{Path, State},
    http::{HeaderMap, StatusCode},
    Json,
};
use k8s_openapi::api::batch::v1::{CronJob, CronJobSpec, JobSpec, JobTemplateSpec};
use k8s_openapi::api::core::v1::{Container, PodSpec, PodTemplateSpec};
use k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta;
use kube::{
    api::{DeleteParams, PostParams},
    Api, Client,
};

/// Create cron workflow.
#[utoipa::path(
    post,
    path = "/api/v1/cron-workflows",
    responses(
        (status = 200, description = "Success"),
        (status = 400, description = "Bad Request"),
        (status = 404, description = "Not Found"),
        (status = 500, description = "Internal Server Error")
    ),
    tag = "cron"
)]
pub async fn create_cron_workflow(
    AuthClaims(_claims): AuthClaims,
    State(state): State<AppState>,
    Json(payload): Json<CreateCronWorkflowRequest>,
) -> Result<Json<CronWorkflowResponse>, StatusCode> {
    let id = CronWorkflowId::new_v4();
    let secret_token = CronWorkflowId::new_v4().to_string();

    // 1. Register with external cron engine
    let external_job_id =
        register_external_cron(id, &payload.name, &payload.cronspec, &secret_token).await?;

    // 2. Save to database
    db::insert_cron_workflow(
        &state.pool,
        id,
        &payload,
        &secret_token,
        external_job_id.clone(),
    )
    .await
    .map_err(|e| {
        tracing::error!("Failed to create cron workflow: {:?}", e);
        StatusCode::INTERNAL_SERVER_ERROR
    })?;

    Ok(Json(CronWorkflowResponse {
        id,
        secret_token,
        external_job_id,
    }))
}

/// List cron workflows.
#[utoipa::path(
    get,
    path = "/api/v1/cron-workflows",
    responses(
        (status = 200, description = "Success"),
        (status = 400, description = "Bad Request"),
        (status = 404, description = "Not Found"),
        (status = 500, description = "Internal Server Error")
    ),
    tag = "cron"
)]
pub async fn list_cron_workflows(
    AuthClaims(_claims): AuthClaims,
    State(state): State<AppState>,
) -> Result<Json<Vec<cron::CronWorkflow>>, StatusCode> {
    let workflows = db::list_cron_workflows(&state.pool)
        .await
        .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    Ok(Json(workflows))
}

/// Deletes a cron workflow.
#[utoipa::path(
    delete,
    path = "/api/v1/cron-workflows/{id}",
    params(("id" = stormchaser_model::CronWorkflowId, Path, description="Cron ID")),
    responses(
        (status = 200, description = "Success"),
        (status = 400, description = "Bad Request"),
        (status = 404, description = "Not Found"),
        (status = 500, description = "Internal Server Error")
    ),
    tag = "cron"
)]
pub async fn delete_cron_workflow(
    AuthClaims(_claims): AuthClaims,
    State(state): State<AppState>,
    Path(id): Path<CronWorkflowId>,
) -> Result<StatusCode, StatusCode> {
    // 1. Fetch to get external_job_id
    let workflow = db::get_cron_workflow(&state.pool, id)
        .await
        .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    let workflow = match workflow {
        Some(w) => w,
        None => return Err(StatusCode::NOT_FOUND),
    };

    // 2. Unregister from external cron engine (K8s)
    if let Some(ext_id) = workflow.external_job_id {
        unregister_external_cron(&ext_id).await?;
    }

    // 3. Delete from DB
    db::delete_cron_workflow(&state.pool, id)
        .await
        .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    Ok(StatusCode::NO_CONTENT)
}

#[utoipa::path(
    post,
    path = "/api/v1/cron-trigger/{id}",
    params(
        ("id" = stormchaser_model::CronWorkflowId, Path, description = "Cron workflow ID")
    ),
    responses(
        (status = 200, description = "Workflow triggered", body = EnqueueResponse),
        (status = 401, description = "Unauthorized"),
        (status = 404, description = "Cron workflow not found"),
        (status = 500, description = "Internal Server Error")
    ),
    security(
        ("bearer_auth" = [])
    ),
    tag = "cron"
)]
/// Trigger cron workflow.
pub async fn trigger_cron_workflow(
    headers: HeaderMap,
    State(state): State<AppState>,
    Path(id): Path<CronWorkflowId>,
) -> Result<Json<EnqueueResponse>, StatusCode> {
    // 1. Fetch CronWorkflow
    let cron = db::get_active_cron_workflow(&state.pool, id)
        .await
        .map_err(|_| StatusCode::NOT_FOUND)?
        .ok_or(StatusCode::NOT_FOUND)?;

    // 2. Validate Token (using constant-time approach via hashing)
    let auth_header = headers
        .get(axum::http::header::AUTHORIZATION)
        .and_then(|h| h.to_str().ok())
        .ok_or(StatusCode::UNAUTHORIZED)?;

    let expected = format!("Bearer {}", cron.secret_token);

    use sha2::{Digest, Sha256};
    let mut hasher1 = Sha256::new();
    hasher1.update(auth_header.as_bytes());
    let hash1 = hasher1.finalize();

    let mut hasher2 = Sha256::new();
    hasher2.update(expected.as_bytes());
    let hash2 = hasher2.finalize();

    if hash1 != hash2 {
        return Err(StatusCode::UNAUTHORIZED);
    }

    // 3. Enqueue a new run
    let run_id = RunId::new_v4();

    tracing::info!(%run_id, "Enqueuing cron workflow: {}", cron.workflow_name);
    let fencing_token = Utc::now().timestamp_nanos_opt().unwrap_or(0);

    let mut tx = state
        .pool
        .begin()
        .await
        .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    db::insert_workflow_run(
        &mut tx,
        run_id,
        &cron.workflow_name,
        "system:cron",
        &cron.repo_url,
        &cron.workflow_path,
        &cron.git_ref,
        RunStatus::Queued,
        fencing_token,
    )
    .await
    .inspect_err(|e| tracing::error!(run_id = %run_id, "Database error inserting run: {:?}", e))
    .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    db::insert_run_context(
        &mut tx,
        run_id,
        "v1",
        serde_json::json!({}),
        "",
        &cron.inputs,
    )
    .await
    .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    db::insert_run_quotas(&mut tx, run_id, 10, "1", "4Gi", "10Gi", "1h")
        .await
        .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    tx.commit()
        .await
        .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    // Publish to NATS
    let event = WorkflowQueuedEvent {
        run_id,
        event_type: EventType::Workflow(WorkflowEventType::Queued),
        timestamp: Utc::now(),
        dsl: None,
        inputs: None,
        initiating_user: None,
    };

    publish_cloudevent(
        &jetstream::new(state.nats.clone()),
        NatsSubject::RunQueued,
        EventType::Workflow(WorkflowEventType::Queued),
        EventSource::System,
        serde_json::to_value(event).unwrap(),
        Some(SchemaVersion::new("1.0".to_string())),
        None,
    )
    .await
    .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    Ok(Json(EnqueueResponse {
        run_id,
        status: RunStatus::Queued,
    }))
}

async fn register_ofelia_cron(
    id: CronWorkflowId,
    name: &str,
    cronspec: &str,
    secret_token: &str,
) -> Result<Option<String>, StatusCode> {
    use bollard::container::{Config, CreateContainerOptions};
    use bollard::Docker;

    let docker = Docker::connect_with_local_defaults().map_err(|e| {
        tracing::error!("Failed to connect to Docker: {:?}", e);
        StatusCode::INTERNAL_SERVER_ERROR
    })?;

    let system_url = env::var("SYSTEM_URL").unwrap_or_else(|_| "http://localhost:3000".to_string());
    let trigger_url = format!("{}/api/v1/cron-trigger/{}", system_url, id);
    let container_name = format!("stormchaser-cron-{}", id);

    let mut labels = HashMap::new();
    labels.insert("ofelia.enabled".to_string(), "true".to_string());
    labels.insert(
        format!("ofelia.job-run.{}.schedule", name),
        cronspec.to_string(),
    );
    labels.insert(
        format!("ofelia.job-run.{}.image", name),
        "curlimages/curl:latest".to_string(),
    );
    labels.insert(
        format!("ofelia.job-run.{}.command", name),
        format!(
            "-X POST -H \"Authorization: Bearer {}\" {}",
            secret_token, trigger_url
        ),
    );

    let config = Config {
        image: Some("curlimages/curl:latest".to_string()),
        labels: Some(labels),
        entrypoint: Some(vec!["/bin/true".to_string()]),
        ..Default::default()
    };

    docker
        .create_container(
            Some(CreateContainerOptions {
                name: container_name.clone(),
                ..Default::default()
            }),
            config,
        )
        .await
        .map_err(|e| {
            tracing::error!("Failed to create Ofelia cron container: {:?}", e);
            StatusCode::INTERNAL_SERVER_ERROR
        })?;

    Ok(Some(container_name))
}

async fn unregister_ofelia_cron(container_name: &str) -> Result<(), StatusCode> {
    use bollard::container::RemoveContainerOptions;
    use bollard::Docker;

    let docker =
        Docker::connect_with_local_defaults().map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;

    docker
        .remove_container(
            container_name,
            Some(RemoveContainerOptions {
                force: true,
                ..Default::default()
            }),
        )
        .await
        .map_err(|e| {
            tracing::error!("Failed to remove Ofelia cron container: {:?}", e);
            StatusCode::INTERNAL_SERVER_ERROR
        })?;

    Ok(())
}

async fn register_external_cron(
    id: CronWorkflowId,
    name: &str,
    cronspec: &str,
    secret_token: &str,
) -> Result<Option<String>, StatusCode> {
    let engine = env::var("CRON_ENGINE").unwrap_or_else(|_| "kubernetes".to_string());

    if engine == "none" {
        tracing::info!(
            "Cron engine set to 'none', skipping external registration for {}",
            id
        );
        return Ok(None);
    }

    if engine == "ofelia" {
        return register_ofelia_cron(id, name, cronspec, secret_token).await;
    }

    if engine != "kubernetes" {
        tracing::error!("Unsupported CRON_ENGINE: {}", engine);
        return Err(StatusCode::INTERNAL_SERVER_ERROR);
    }

    let client = Client::try_default().await.map_err(|e| {
        tracing::error!("Failed to initialize K8s client for cron: {:?}", e);
        StatusCode::INTERNAL_SERVER_ERROR
    })?;
    let namespace = env::var("KUBERNETES_NAMESPACE").unwrap_or_else(|_| "default".to_string());
    let cronjobs: Api<CronJob> = Api::namespaced(client, &namespace);

    let system_url = env::var("SYSTEM_URL")
        .unwrap_or_else(|_| "http://stormchaser-api.default.svc.cluster.local".to_string());
    let trigger_url = format!("{}/api/v1/cron-trigger/{}", system_url, id);
    let auth_header = format!("Authorization: Bearer {}", secret_token);

    let cron_job = CronJob {
        metadata: ObjectMeta {
            name: Some(format!("stormchaser-{}", id)),
            labels: Some(std::collections::BTreeMap::from([
                (
                    "app.kubernetes.io/managed-by".to_string(),
                    "stormchaser".to_string(),
                ),
                (
                    "stormchaser.paninfracon.net/workflow-name".to_string(),
                    name.to_string(),
                ),
            ])),
            ..Default::default()
        },
        spec: Some(CronJobSpec {
            schedule: cronspec.to_string(),
            job_template: JobTemplateSpec {
                metadata: None,
                spec: Some(JobSpec {
                    template: PodTemplateSpec {
                        spec: Some(PodSpec {
                            containers: vec![Container {
                                name: "trigger".to_string(),
                                image: Some("curlimages/curl:latest".to_string()),
                                command: Some(vec![
                                    "curl".to_string(),
                                    "-X".to_string(),
                                    "POST".to_string(),
                                    "-H".to_string(),
                                    auth_header,
                                    trigger_url,
                                ]),
                                ..Default::default()
                            }],
                            restart_policy: Some("OnFailure".to_string()),
                            ..Default::default()
                        }),
                        ..Default::default()
                    },
                    ..Default::default()
                }),
            },
            ..Default::default()
        }),
        ..Default::default()
    };

    cronjobs
        .create(&PostParams::default(), &cron_job)
        .await
        .map_err(|e| {
            tracing::error!("Failed to create K8s CronJob: {:?}", e);
            StatusCode::INTERNAL_SERVER_ERROR
        })?;

    Ok(Some(format!("stormchaser-{}", id)))
}

async fn unregister_external_cron(external_job_id: &str) -> Result<(), StatusCode> {
    let engine = env::var("CRON_ENGINE").unwrap_or_else(|_| "kubernetes".to_string());

    if engine == "none" {
        return Ok(());
    }

    if engine == "ofelia" {
        return unregister_ofelia_cron(external_job_id).await;
    }

    if engine != "kubernetes" {
        return Err(StatusCode::INTERNAL_SERVER_ERROR);
    }
    let client = Client::try_default()
        .await
        .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?;
    let namespace = env::var("KUBERNETES_NAMESPACE").unwrap_or_else(|_| "default".to_string());
    let cronjobs: Api<CronJob> = Api::namespaced(client, &namespace);

    cronjobs
        .delete(external_job_id, &DeleteParams::default())
        .await
        .map_err(|e| {
            tracing::error!("Failed to delete K8s CronJob {}: {:?}", external_job_id, e);
            StatusCode::INTERNAL_SERVER_ERROR
        })?;

    Ok(())
}