chronon-backend-sql-common 0.1.4

Shared SQL SchedulerStore for SQLite and PostgreSQL
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
//! Run persistence and worker claim helpers.
//!
//! Internal — used by [`SqlSchedulerStore`](crate::SqlSchedulerStore); not a stable public API.

use chrono::{DateTime, Duration, Utc};

use chronon_core::error::{ChrononError, Result};
use chronon_core::models::{Run, RunStatus};

use crate::backend::SqlDialect;
use crate::error_map::map_err;
use crate::row::{row_to_run, run_status_to_str, RunRow};
use crate::{bind_sql, sql_execute, sql_fetch_all_map, sql_fetch_optional_map, SqlSchedulerStore};

pub(crate) async fn create_run(store: &SqlSchedulerStore, run: &Run) -> Result<()> {
    let row = RunRow::from_model(run)?;
    let sql = bind_sql(
        store.dialect,
        "INSERT INTO chronon_run (
            run_id, job_id, script_name, parent_run_id, root_run_id, child_index,
            scheduled_for, started_at, finished_at, duration_ms, status, attempt,
            instance_id, placement_json, pool_id, actor_json, params_json, stdout_text,
            stderr_text, error_json, stats_json, claimed_by, claim_lease_until
        ) VALUES (
            ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?
        )",
    );
    match sql_execute!(store, &sql, |q| {
        q.bind(&row.run_id)
            .bind(&row.job_id)
            .bind(&row.script_name)
            .bind(&row.parent_run_id)
            .bind(&row.root_run_id)
            .bind(row.child_index)
            .bind(row.scheduled_for)
            .bind(row.started_at)
            .bind(row.finished_at)
            .bind(row.duration_ms)
            .bind(&row.status)
            .bind(row.attempt)
            .bind(&row.instance_id)
            .bind(&row.placement_json)
            .bind(&row.pool_id)
            .bind(&row.actor_json)
            .bind(&row.params_json)
            .bind(&row.stdout_text)
            .bind(&row.stderr_text)
            .bind(&row.error_json)
            .bind(&row.stats_json)
            .bind(&row.claimed_by)
            .bind(row.claim_lease_until)
    }) {
        Ok(()) => Ok(()),
        Err(ChrononError::StorageError { message, .. })
            if message.contains("UNIQUE")
                || message.contains("unique")
                || message.contains("duplicate") =>
        {
            Err(ChrononError::storage(format!(
                "duplicate run_id: {}",
                run.run_id
            )))
        }
        Err(e) => Err(e),
    }
}

pub(crate) async fn update_run(store: &SqlSchedulerStore, run: &Run) -> Result<()> {
    let row = RunRow::from_model(run)?;
    let sql = bind_sql(
        store.dialect,
        "UPDATE chronon_run SET
            job_id = ?, script_name = ?, parent_run_id = ?, root_run_id = ?, child_index = ?,
            scheduled_for = ?, started_at = ?, finished_at = ?, duration_ms = ?, status = ?,
            attempt = ?, instance_id = ?, placement_json = ?, pool_id = ?, actor_json = ?,
            params_json = ?, stdout_text = ?, stderr_text = ?, error_json = ?, stats_json = ?,
            claimed_by = ?, claim_lease_until = ?
         WHERE run_id = ?",
    );
    sql_execute!(store, &sql, |q| {
        q.bind(&row.job_id)
            .bind(&row.script_name)
            .bind(&row.parent_run_id)
            .bind(&row.root_run_id)
            .bind(row.child_index)
            .bind(row.scheduled_for)
            .bind(row.started_at)
            .bind(row.finished_at)
            .bind(row.duration_ms)
            .bind(&row.status)
            .bind(row.attempt)
            .bind(&row.instance_id)
            .bind(&row.placement_json)
            .bind(&row.pool_id)
            .bind(&row.actor_json)
            .bind(&row.params_json)
            .bind(&row.stdout_text)
            .bind(&row.stderr_text)
            .bind(&row.error_json)
            .bind(&row.stats_json)
            .bind(&row.claimed_by)
            .bind(row.claim_lease_until)
            .bind(&row.run_id)
    })?;
    if get_run(store, &run.run_id).await?.is_none() {
        return Err(ChrononError::RunNotFound(run.run_id.clone()));
    }
    Ok(())
}

pub(crate) async fn get_run(store: &SqlSchedulerStore, run_id: &str) -> Result<Option<Run>> {
    let sql = bind_sql(store.dialect, "SELECT * FROM chronon_run WHERE run_id = ?");
    sql_fetch_optional_map!(store, &sql, |q| q.bind(run_id), |r| row_to_run(&r))
}

pub(crate) async fn list_runs_for_job(
    store: &SqlSchedulerStore,
    job_id: &str,
    limit: usize,
) -> Result<Vec<Run>> {
    let sql = bind_sql(
        store.dialect,
        "SELECT * FROM chronon_run WHERE job_id = ? ORDER BY scheduled_for DESC LIMIT ?",
    );
    let limit = i64::try_from(limit).unwrap_or(i64::MAX);
    sql_fetch_all_map!(store, &sql, |q| q.bind(job_id).bind(limit), |r| row_to_run(
        r
    ))
}

pub(crate) async fn list_runs_filtered(
    store: &SqlSchedulerStore,
    job_id: Option<&str>,
    status: Option<RunStatus>,
    offset: usize,
    limit: usize,
) -> Result<Vec<Run>> {
    let offset = i64::try_from(offset).unwrap_or(i64::MAX);
    let limit = i64::try_from(limit).unwrap_or(i64::MAX);
    match (job_id, status) {
        (Some(job_id), Some(status)) => {
            let sql = bind_sql(
                store.dialect,
                "SELECT * FROM chronon_run WHERE job_id = ? AND status = ?
                 ORDER BY scheduled_for DESC LIMIT ? OFFSET ?",
            );
            sql_fetch_all_map!(
                store,
                &sql,
                |q| {
                    q.bind(job_id)
                        .bind(run_status_to_str(status))
                        .bind(limit)
                        .bind(offset)
                },
                |r| row_to_run(r)
            )
        }
        (Some(job_id), None) => {
            let sql = bind_sql(
                store.dialect,
                "SELECT * FROM chronon_run WHERE job_id = ?
                 ORDER BY scheduled_for DESC LIMIT ? OFFSET ?",
            );
            sql_fetch_all_map!(
                store,
                &sql,
                |q| q.bind(job_id).bind(limit).bind(offset),
                |r| { row_to_run(r) }
            )
        }
        (None, Some(status)) => {
            let sql = bind_sql(
                store.dialect,
                "SELECT * FROM chronon_run WHERE status = ?
                 ORDER BY scheduled_for DESC LIMIT ? OFFSET ?",
            );
            sql_fetch_all_map!(
                store,
                &sql,
                |q| { q.bind(run_status_to_str(status)).bind(limit).bind(offset) },
                |r| row_to_run(r)
            )
        }
        (None, None) => {
            let sql = bind_sql(
                store.dialect,
                "SELECT * FROM chronon_run ORDER BY scheduled_for DESC LIMIT ? OFFSET ?",
            );
            sql_fetch_all_map!(store, &sql, |q| q.bind(limit).bind(offset), |r| row_to_run(
                r
            ))
        }
    }
}

fn claim_next_queued_sql(dialect: SqlDialect) -> String {
    let skip = match dialect {
        SqlDialect::Postgres => " FOR UPDATE SKIP LOCKED",
        SqlDialect::Sqlite => "",
    };
    bind_sql(
        dialect,
        &format!(
            "UPDATE chronon_run SET
                status = 'claimed',
                claimed_by = ?,
                claim_lease_until = ?
             WHERE run_id = (
                SELECT run_id FROM chronon_run
                WHERE status = 'queued'
                  AND scheduled_for <= ?
                  AND (claim_lease_until IS NULL OR claim_lease_until <= ?)
                  AND (
                    pool_id = ?
                    OR (? = 'general' AND (pool_id IS NULL OR pool_id = 'general'))
                  )
                ORDER BY scheduled_for ASC
                LIMIT 1{skip}
             )
             RETURNING *"
        ),
    )
}

pub(crate) async fn claim_next_queued(
    store: &SqlSchedulerStore,
    pool_id: &str,
    worker_id: &str,
    now: DateTime<Utc>,
    lease_ttl_secs: i64,
) -> Result<Option<Run>> {
    let lease_until = now + Duration::seconds(lease_ttl_secs);
    let sql = claim_next_queued_sql(store.dialect);
    sql_fetch_optional_map!(
        store,
        &sql,
        |q| {
            q.bind(worker_id)
                .bind(lease_until)
                .bind(now)
                .bind(now)
                .bind(pool_id)
                .bind(pool_id)
        },
        |r| row_to_run(&r)
    )
}

fn claim_run_by_id_sql(dialect: SqlDialect) -> String {
    bind_sql(
        dialect,
        "UPDATE chronon_run SET
            status = 'claimed',
            claimed_by = ?,
            claim_lease_until = ?
         WHERE run_id = ?
           AND status = 'queued'
           AND scheduled_for <= ?
           AND (claim_lease_until IS NULL OR claim_lease_until <= ?)
           AND (
             pool_id = ?
             OR (? = 'general' AND (pool_id IS NULL OR pool_id = 'general'))
           )
         RETURNING *",
    )
}

pub(crate) async fn claim_run_by_id(
    store: &SqlSchedulerStore,
    run_id: &str,
    pool_id: &str,
    worker_id: &str,
    now: DateTime<Utc>,
    lease_ttl_secs: i64,
) -> Result<Option<Run>> {
    let lease_until = now + Duration::seconds(lease_ttl_secs);
    let sql = claim_run_by_id_sql(store.dialect);
    sql_fetch_optional_map!(
        store,
        &sql,
        |q| {
            q.bind(worker_id)
                .bind(lease_until)
                .bind(run_id)
                .bind(now)
                .bind(now)
                .bind(pool_id)
                .bind(pool_id)
        },
        |r| row_to_run(&r)
    )
}

fn claim_runs_by_ids_postgres_sql() -> &'static str {
    "UPDATE chronon_run SET
            status = 'claimed',
            claimed_by = $1,
            claim_lease_until = $2
         WHERE run_id = ANY($3)
           AND status = 'queued'
           AND scheduled_for <= $4
           AND (claim_lease_until IS NULL OR claim_lease_until <= $4)
           AND (
             pool_id = $5
             OR ($6 = 'general' AND (pool_id IS NULL OR pool_id = 'general'))
           )
         RETURNING *"
}

pub(crate) async fn claim_runs_by_ids(
    store: &SqlSchedulerStore,
    run_ids: &[&str],
    pool_id: &str,
    worker_id: &str,
    now: DateTime<Utc>,
    lease_ttl_secs: i64,
) -> Result<Vec<Run>> {
    if run_ids.is_empty() {
        return Ok(Vec::new());
    }
    if store.dialect != SqlDialect::Postgres || run_ids.len() == 1 {
        let mut claimed = Vec::new();
        for run_id in run_ids {
            if let Some(run) =
                claim_run_by_id(store, run_id, pool_id, worker_id, now, lease_ttl_secs).await?
            {
                claimed.push(run);
            }
        }
        return Ok(claimed);
    }
    let lease_until = now + Duration::seconds(lease_ttl_secs);
    let ids: Vec<String> = run_ids.iter().map(|s| (*s).to_string()).collect();
    let sql = claim_runs_by_ids_postgres_sql();
    match &store.pool {
        crate::SqlPool::Postgres(pool) => {
            let rows = sqlx::query(sql)
                .bind(worker_id)
                .bind(lease_until)
                .bind(ids)
                .bind(now)
                .bind(pool_id)
                .bind(pool_id)
                .fetch_all(pool)
                .await
                .map_err(map_err)?;
            rows.iter().map(row_to_run).collect()
        }
        crate::SqlPool::Sqlite(_) => {
            let mut claimed = Vec::new();
            for run_id in run_ids {
                if let Some(run) =
                    claim_run_by_id(store, run_id, pool_id, worker_id, now, lease_ttl_secs).await?
                {
                    claimed.push(run);
                }
            }
            Ok(claimed)
        }
    }
}

pub(crate) async fn renew_run_lease(
    store: &SqlSchedulerStore,
    run_id: &str,
    worker_id: &str,
    now: DateTime<Utc>,
    lease_ttl_secs: i64,
) -> Result<bool> {
    let lease_until = now + Duration::seconds(lease_ttl_secs);
    let sql = bind_sql(
        store.dialect,
        "UPDATE chronon_run SET claim_lease_until = ?
         WHERE run_id = ?
           AND claimed_by = ?
           AND status IN ('claimed', 'running')",
    );
    let rows = match &store.pool {
        crate::SqlPool::Sqlite(pool) => sqlx::query(&sql)
            .bind(lease_until)
            .bind(run_id)
            .bind(worker_id)
            .execute(pool)
            .await
            .map_err(map_err)?
            .rows_affected(),
        crate::SqlPool::Postgres(pool) => sqlx::query(&sql)
            .bind(lease_until)
            .bind(run_id)
            .bind(worker_id)
            .execute(pool)
            .await
            .map_err(map_err)?
            .rows_affected(),
    };
    Ok(rows > 0)
}

pub(crate) async fn reclaim_expired_run_leases(
    store: &SqlSchedulerStore,
    now: DateTime<Utc>,
) -> Result<Vec<String>> {
    let sql = bind_sql(
        store.dialect,
        "UPDATE chronon_run SET
            status = 'queued',
            claimed_by = NULL,
            claim_lease_until = NULL,
            started_at = NULL
         WHERE status IN ('claimed', 'running')
           AND claim_lease_until IS NOT NULL
           AND claim_lease_until <= ?
         RETURNING run_id",
    );
    let rows: Vec<(String,)> = match &store.pool {
        crate::SqlPool::Sqlite(pool) => sqlx::query_as(&sql)
            .bind(now)
            .fetch_all(pool)
            .await
            .map_err(map_err)?,
        crate::SqlPool::Postgres(pool) => sqlx::query_as(&sql)
            .bind(now)
            .fetch_all(pool)
            .await
            .map_err(map_err)?,
    };
    Ok(rows.into_iter().map(|(id,)| id).collect())
}