ratchjob 0.2.1

一个rust实现的分布式任务调度平台服务。计划完全兼容xxl-job协议,然后再增强一些任务调度平台能力。
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
use crate::common::constant::{EMPTY_ARC_STR, SEQ_JOB_ID};
use crate::common::datetime_utils::{now_millis, now_second_u32};
use crate::common::model::{ApiResult, PageResult, UserSession};
use crate::common::share_data::ShareData;
use crate::console::model::job::{
    JobInfoParam, JobQueryListRequest, JobTaskLogQueryListRequest, TriggerJobParam,
};
use crate::console::v1::{
    ERROR_CODE_JOB_KEY_DUPLICATE, ERROR_CODE_NO_APP_PERMISSION, ERROR_CODE_SYSTEM_ERROR,
};
use crate::job::model::actor_model::{
    JobManagerRaftReq, JobManagerRaftResult, JobManagerReq, JobManagerResult,
};
use crate::job::model::job::{JobKey, JobParam};
use crate::raft::store::{ClientRequest, ClientResponse};
use crate::schedule::model::actor_model::{ScheduleManagerReq, ScheduleManagerResult};
use crate::sequence::{SequenceRequest, SequenceResult};
use crate::task::model::actor_model::{TaskManagerReq, TriggerItem};
use actix_http::HttpMessage;
use actix_web::web::Data;
use actix_web::{web, HttpResponse, Responder};
use std::sync::Arc;

pub(crate) async fn query_job_list(
    req: actix_web::HttpRequest,
    share_data: Data<Arc<ShareData>>,
    web::Query(request): web::Query<JobQueryListRequest>,
) -> impl Responder {
    let session = if let Some(session) = req.extensions().get::<Arc<UserSession>>() {
        session.clone()
    } else {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("user session is invalid".to_string()),
        ));
    };
    let param = request.to_param_with_session(&session);
    if let Ok(Ok(JobManagerResult::JobPageInfo(total_count, list))) = share_data
        .job_manager
        .send(JobManagerReq::QueryJob(param))
        .await
    {
        HttpResponse::Ok().json(ApiResult::success(Some(PageResult { total_count, list })))
    } else {
        HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("query_job_list error".to_string()),
        ))
    }
}

pub(crate) async fn query_job_info(
    req: actix_web::HttpRequest,
    share_data: Data<Arc<ShareData>>,
    web::Query(param): web::Query<JobInfoParam>,
) -> impl Responder {
    let id = param.id.unwrap_or_default();
    if id == 0 {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("query_job_info error,the job id is invalid".to_string()),
        ));
    }
    let app_privilege = if let Some(session) = req.extensions().get::<Arc<UserSession>>() {
        session.app_privilege.clone()
    } else {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("user session is invalid".to_string()),
        ));
    };

    if let Ok(Ok(JobManagerResult::JobInfo(Some(info)))) =
        share_data.job_manager.send(JobManagerReq::GetJob(id)).await
    {
        if !app_privilege.check_permission(&info.app_name) {
            return HttpResponse::Ok().json(ApiResult::<()>::error(
                ERROR_CODE_NO_APP_PERMISSION.to_string(),
                Some(format!("user no app permission:{}", &info.app_name)),
            ));
        }
        HttpResponse::Ok().json(ApiResult::success(Some(info)))
    } else {
        HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("query_job_info error".to_string()),
        ))
    }
}

async fn do_create_job(
    share_data: Data<Arc<ShareData>>,
    mut param: JobParam,
) -> anyhow::Result<HttpResponse> {
    param.check_valid()?;

    if param.key.is_none() || param.key.as_ref().unwrap().is_empty() {
        param.key = Some(Arc::new(uuid::Uuid::new_v4().to_string().replace('-', "")));
    }

    if let Some(ref key) = param.key {
        if !key.is_empty() {
            let job_key = JobKey::new(
                &param.namespace.as_ref().unwrap(),
                &param.app_name.as_ref().unwrap(),
                key,
            );

            if let Ok(Ok(JobManagerResult::JobId(Some(_)))) = share_data
                .job_manager
                .send(JobManagerReq::GetJobIdByKey(job_key))
                .await
            {
                return Err(anyhow::anyhow!(
                    "job key already exists: namespace={}, app_name={}, key={}",
                    param.namespace.as_ref().unwrap(),
                    param.app_name.as_ref().unwrap(),
                    key
                ));
            }
        }
    }

    if let SequenceResult::NextId(id) = share_data
        .sequence_manager
        .send(SequenceRequest::GetNextId(SEQ_JOB_ID.clone()))
        .await??
    {
        param.id = Some(id);
        param.update_time = Some(now_millis());
        if let ClientResponse::JobResp {
            resp: JobManagerRaftResult::JobInfo(job),
        } = share_data
            .raft_request_route
            .request(ClientRequest::JobReq {
                req: JobManagerRaftReq::AddJob(param),
            })
            .await?
        {
            Ok(HttpResponse::Ok().json(ApiResult::success(Some(job))))
        } else {
            Err(anyhow::anyhow!("create job result type error!"))
        }
    } else {
        Err(anyhow::anyhow!("get job id error!"))
    }
}

pub(crate) async fn create_job(
    req: actix_web::HttpRequest,
    share_data: Data<Arc<ShareData>>,
    web::Json(param): web::Json<JobInfoParam>,
) -> impl Responder {
    let param = param.to_param();
    let app_privilege = if let Some(session) = req.extensions().get::<Arc<UserSession>>() {
        session.app_privilege.clone()
    } else {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("user session is invalid".to_string()),
        ));
    };
    if let Some(app_name) = param.app_name.as_ref() {
        if !app_privilege.check_permission(app_name) {
            return HttpResponse::Ok().json(ApiResult::<()>::error(
                ERROR_CODE_NO_APP_PERMISSION.to_string(),
                Some(format!("user no app permission:{}", app_name)),
            ));
        }
    }
    match do_create_job(share_data, param).await {
        Ok(v) => v,
        Err(e) => {
            let error_msg = format!("create_job error,{}", e);
            let error_code = if error_msg.find("job key already exists").is_some() {
                ERROR_CODE_JOB_KEY_DUPLICATE.to_string()
            } else {
                ERROR_CODE_SYSTEM_ERROR.to_string()
            };
            //log::error!("{}", &error_msg);
            HttpResponse::Ok().json(ApiResult::<()>::error(error_code, Some(error_msg)))
        }
    }
}

pub(crate) async fn update_job(
    req: actix_web::HttpRequest,
    share_data: Data<Arc<ShareData>>,
    web::Json(param): web::Json<JobInfoParam>,
) -> impl Responder {
    let param = param.to_param();
    let id = param.id.clone().unwrap_or_default();
    if id == 0 {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("update_job error,the job id is invalid".to_string()),
        ));
    }
    let app_privilege = if let Some(session) = req.extensions().get::<Arc<UserSession>>() {
        session.app_privilege.clone()
    } else {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("user session is invalid".to_string()),
        ));
    };
    if let Some(app_name) = param.app_name.as_ref() {
        if !app_privilege.check_permission(app_name) {
            return HttpResponse::Ok().json(ApiResult::<()>::error(
                ERROR_CODE_NO_APP_PERMISSION.to_string(),
                Some(format!("user no app permission:{}", app_name)),
            ));
        }
    }

    let original_job_info = if let Ok(Ok(JobManagerResult::JobInfo(Some(info)))) =
        share_data.job_manager.send(JobManagerReq::GetJob(id)).await
    {
        if !app_privilege.check_permission(&info.app_name) {
            return HttpResponse::Ok().json(ApiResult::<()>::error(
                ERROR_CODE_NO_APP_PERMISSION.to_string(),
                Some(format!("user no app permission:{}", &info.app_name)),
            ));
        }
        Some(info)
    } else {
        None
    };

    if let Some(ref key) = param.key {
        if !key.is_empty() {
            let (namespace, app_name) = match (&param.namespace, &param.app_name) {
                (Some(ns), Some(app)) => (ns.clone(), app.clone()),
                _ => {
                    if let Some(ref info) = original_job_info {
                        (info.namespace.clone(), info.app_name.clone())
                    } else {
                        return HttpResponse::Ok().json(ApiResult::<()>::error(
                            ERROR_CODE_SYSTEM_ERROR.to_string(),
                            Some(
                                "update_job error,namespace/app_name is required when key is set"
                                    .to_string(),
                            ),
                        ));
                    }
                }
            };

            let job_key = JobKey::new(&namespace, &app_name, key);

            if let Ok(Ok(JobManagerResult::JobId(Some(existing_id)))) = share_data
                .job_manager
                .send(JobManagerReq::GetJobIdByKey(job_key))
                .await
            {
                if existing_id != id {
                    return HttpResponse::Ok().json(ApiResult::<()>::error(
                        ERROR_CODE_JOB_KEY_DUPLICATE.to_string(),
                        Some(format!(
                            "job key already exists: namespace={}, app_name={}, key={}",
                            namespace, app_name, key
                        )),
                    ));
                }
            }
        }
    }

    if let Err(e) = param.check_valid() {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some(format!("update_job error,{}", e)),
        ));
    }
    if let Ok(_) = share_data
        .raft_request_route
        .request(ClientRequest::JobReq {
            req: JobManagerRaftReq::UpdateJob(param),
        })
        .await
    {
        HttpResponse::Ok().json(ApiResult::success(Some(())))
    } else {
        HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("update_job error".to_string()),
        ))
    }
}

pub(crate) async fn remove_job(
    req: actix_web::HttpRequest,
    share_data: Data<Arc<ShareData>>,
    web::Json(param): web::Json<JobInfoParam>,
) -> impl Responder {
    let id = param.id.unwrap_or_default();
    if id == 0 {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("remove_job error,the job id is invalid".to_string()),
        ));
    }
    let app_privilege = if let Some(session) = req.extensions().get::<Arc<UserSession>>() {
        session.app_privilege.clone()
    } else {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("user session is invalid".to_string()),
        ));
    };
    if let Ok(Ok(JobManagerResult::JobInfo(Some(info)))) =
        share_data.job_manager.send(JobManagerReq::GetJob(id)).await
    {
        if !app_privilege.check_permission(&info.app_name) {
            return HttpResponse::Ok().json(ApiResult::<()>::error(
                ERROR_CODE_NO_APP_PERMISSION.to_string(),
                Some(format!("user no app permission:{}", &info.app_name)),
            ));
        }
    }
    if let Ok(_) = share_data
        .raft_request_route
        .request(ClientRequest::JobReq {
            req: JobManagerRaftReq::Remove(id),
        })
        .await
    {
        HttpResponse::Ok().json(ApiResult::success(Some(())))
    } else {
        HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("remove_job error".to_string()),
        ))
    }
}

pub(crate) async fn trigger_job(
    req: actix_web::HttpRequest,
    share_data: Data<Arc<ShareData>>,
    web::Json(param): web::Json<TriggerJobParam>,
) -> impl Responder {
    let id = param.job_id.unwrap_or_default();
    if id == 0 {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("trigger_job error,the job id is invalid".to_string()),
        ));
    }
    let session = if let Some(session) = req.extensions().get::<Arc<UserSession>>() {
        session.clone()
    } else {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("user session is invalid".to_string()),
        ));
    };
    let app_privilege = &session.app_privilege;
    let job_info = if let Ok(Ok(JobManagerResult::JobInfo(Some(job_info)))) =
        share_data.job_manager.send(JobManagerReq::GetJob(id)).await
    {
        if !app_privilege.check_permission(&job_info.app_name) {
            return HttpResponse::Ok().json(ApiResult::<()>::error(
                ERROR_CODE_NO_APP_PERMISSION.to_string(),
                Some(format!("user no app permission:{}", &job_info.app_name)),
            ));
        }
        job_info
    } else {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("query_job_info error".to_string()),
        ));
    };
    let task_item = TriggerItem::new_with_user(
        now_second_u32(),
        job_info,
        param.instance_addr.unwrap_or(EMPTY_ARC_STR.clone()),
        session.username.clone(),
    );
    log::info!("trigger_job task_item:{:?}", &task_item);
    if let Ok(Ok(_)) = share_data
        .task_manager
        .send(TaskManagerReq::TriggerTaskList(vec![task_item]))
        .await
    {
        HttpResponse::Ok().json(ApiResult::success(Some(())))
    } else {
        HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("trigger_job error".to_string()),
        ))
    }
}

pub(crate) async fn query_job_task_logs(
    req: actix_web::HttpRequest,
    share_data: Data<Arc<ShareData>>,
    web::Query(request): web::Query<JobTaskLogQueryListRequest>,
) -> impl Responder {
    let param = request.to_param();
    let app_privilege = if let Some(session) = req.extensions().get::<Arc<UserSession>>() {
        session.app_privilege.clone()
    } else {
        return HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("user session is invalid".to_string()),
        ));
    };
    if let Ok(Ok(JobManagerResult::JobInfo(Some(info)))) = share_data
        .job_manager
        .send(JobManagerReq::GetJob(param.job_id))
        .await
    {
        if !app_privilege.check_permission(&info.app_name) {
            return HttpResponse::Ok().json(ApiResult::<()>::error(
                ERROR_CODE_NO_APP_PERMISSION.to_string(),
                Some(format!("user no app permission:{}", &info.app_name)),
            ));
        }
    }
    if let Ok(Ok(JobManagerResult::JobTaskLogPageInfo(total_count, list))) = share_data
        .job_manager
        .send(JobManagerReq::QueryJobTaskLog(param))
        .await
    {
        HttpResponse::Ok().json(ApiResult::success(Some(PageResult { total_count, list })))
    } else {
        HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("query_job_task_logs error".to_string()),
        ))
    }
}

pub(crate) async fn query_latest_task(
    share_data: Data<Arc<ShareData>>,
    web::Query(request): web::Query<JobTaskLogQueryListRequest>,
) -> impl Responder {
    let param = request.to_param();
    if let Ok(Ok(ScheduleManagerResult::JobTaskLogPageInfo(total_count, list))) = share_data
        .schedule_manager
        .send(ScheduleManagerReq::QueryJobTaskLog(param))
        .await
    {
        HttpResponse::Ok().json(ApiResult::success(Some(PageResult { total_count, list })))
    } else {
        HttpResponse::Ok().json(ApiResult::<()>::error(
            ERROR_CODE_SYSTEM_ERROR.to_string(),
            Some("query_latest_task error".to_string()),
        ))
    }
}