runledger-postgres 0.4.0

PostgreSQL persistence layer for the Runledger durable job and workflow system
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
use std::collections::HashSet;

use runledger_core::jobs::{
    JobType, StepKey, WorkflowDependencyReleaseMode, WorkflowRunEnqueueBuilder,
    WorkflowStepEnqueueBuilder, WorkflowType,
};
use runledger_postgres::jobs::{
    JOB_LIST_PAGE_LIMIT_MAX, JobDefinitionListFilter, JobDefinitionUpsert, JobListFilter,
    JobRuntimeConfigListFilter, WorkflowRunListFilter, count_workflow_step_dependencies,
    count_workflow_steps, enqueue_workflow_run, list_job_definitions, list_job_events,
    list_job_logs, list_job_runtime_configs, list_jobs, list_workflow_runs,
    list_workflow_step_dependencies_page, list_workflow_steps, list_workflow_steps_page,
    upsert_job_definition_tx,
};
use runledger_postgres::{DbPool, Error, QueryErrorCategory};
use runledger_test_support::{setup_ephemeral_pool, teardown_ephemeral_pool};
use serde_json::json;
use sqlx::postgres::PgPoolOptions;
use sqlx::types::Uuid;

fn disconnected_pool() -> DbPool {
    PgPoolOptions::new()
        .max_connections(1)
        .connect_lazy("postgres://runledger:runledger@127.0.0.1:1/runledger")
        .expect("create lazy pool")
}

async fn register_job_definition(pool: &DbPool, job_type: JobType<'static>) {
    let mut tx = pool.begin().await.expect("begin setup tx");
    upsert_job_definition_tx(
        &mut tx,
        &JobDefinitionUpsert {
            job_type,
            version: 1,
            max_attempts: 3,
            default_timeout_seconds: 60,
            default_priority: 100,
            is_enabled: true,
        },
    )
    .await
    .expect("upsert job definition");
    tx.commit().await.expect("commit setup tx");
}

fn assert_invalid_pagination<T>(result: runledger_postgres::Result<T>) {
    match result {
        Err(Error::QueryError(query_error)) => {
            assert_eq!(query_error.category(), QueryErrorCategory::Validation);
            assert_eq!(query_error.code(), "job.invalid_pagination");
            assert_eq!(
                query_error.client_message(),
                "Pagination limit and offset are invalid."
            );
            assert!(
                query_error.source_arc().is_none(),
                "pagination validation should run before SQL execution"
            );
        }
        Err(other) => panic!("expected pagination validation error, got {other:?}"),
        Ok(_) => panic!("expected pagination validation error, got Ok"),
    }
}

#[tokio::test]
async fn invalid_pagination_rejects_before_database_access() {
    let pool = disconnected_pool();
    let job_id = Uuid::nil();

    assert_invalid_pagination(
        list_jobs(
            &pool,
            &JobListFilter {
                organization_id: None,
                status: None,
                job_type: None,
                limit: 0,
                offset: 0,
            },
        )
        .await,
    );
    assert_invalid_pagination(
        list_jobs(
            &pool,
            &JobListFilter {
                organization_id: None,
                status: None,
                job_type: None,
                limit: -1,
                offset: 0,
            },
        )
        .await,
    );
    assert_invalid_pagination(
        list_jobs(
            &pool,
            &JobListFilter {
                organization_id: None,
                status: None,
                job_type: None,
                limit: JOB_LIST_PAGE_LIMIT_MAX + 1,
                offset: 0,
            },
        )
        .await,
    );
    assert_invalid_pagination(
        list_jobs(
            &pool,
            &JobListFilter {
                organization_id: None,
                status: None,
                job_type: None,
                limit: 1,
                offset: -1,
            },
        )
        .await,
    );

    assert_invalid_pagination(list_job_events(&pool, None, job_id, 0, None).await);
    assert_invalid_pagination(
        list_job_events(&pool, None, job_id, JOB_LIST_PAGE_LIMIT_MAX + 1, None).await,
    );
    assert_invalid_pagination(list_job_logs(&pool, None, job_id, 0, None).await);
    assert_invalid_pagination(
        list_job_logs(&pool, None, job_id, JOB_LIST_PAGE_LIMIT_MAX + 1, None).await,
    );

    assert_invalid_pagination(
        list_workflow_runs(
            &pool,
            &WorkflowRunListFilter {
                organization_id: None,
                status: None,
                workflow_type: None,
                limit: 0,
                offset: 0,
            },
        )
        .await,
    );
    assert_invalid_pagination(
        list_workflow_runs(
            &pool,
            &WorkflowRunListFilter {
                organization_id: None,
                status: None,
                workflow_type: None,
                limit: JOB_LIST_PAGE_LIMIT_MAX + 1,
                offset: 0,
            },
        )
        .await,
    );
    assert_invalid_pagination(
        list_workflow_runs(
            &pool,
            &WorkflowRunListFilter {
                organization_id: None,
                status: None,
                workflow_type: None,
                limit: 1,
                offset: -1,
            },
        )
        .await,
    );

    assert_invalid_pagination(
        list_job_definitions(
            &pool,
            &JobDefinitionListFilter {
                job_type: None,
                limit: 0,
                offset: 0,
            },
        )
        .await,
    );
    assert_invalid_pagination(
        list_job_definitions(
            &pool,
            &JobDefinitionListFilter {
                job_type: None,
                limit: JOB_LIST_PAGE_LIMIT_MAX + 1,
                offset: 0,
            },
        )
        .await,
    );
    assert_invalid_pagination(
        list_job_definitions(
            &pool,
            &JobDefinitionListFilter {
                job_type: None,
                limit: 1,
                offset: -1,
            },
        )
        .await,
    );

    assert_invalid_pagination(
        list_job_runtime_configs(
            &pool,
            &JobRuntimeConfigListFilter {
                job_type: None,
                limit: 0,
                offset: 0,
            },
        )
        .await,
    );
    assert_invalid_pagination(
        list_job_runtime_configs(
            &pool,
            &JobRuntimeConfigListFilter {
                job_type: None,
                limit: JOB_LIST_PAGE_LIMIT_MAX + 1,
                offset: 0,
            },
        )
        .await,
    );
    assert_invalid_pagination(
        list_job_runtime_configs(
            &pool,
            &JobRuntimeConfigListFilter {
                job_type: None,
                limit: 1,
                offset: -1,
            },
        )
        .await,
    );

    assert_invalid_pagination(list_workflow_steps_page(&pool, None, job_id, 0, 0).await);
    assert_invalid_pagination(
        list_workflow_steps_page(&pool, None, job_id, JOB_LIST_PAGE_LIMIT_MAX + 1, 0).await,
    );
    assert_invalid_pagination(list_workflow_steps_page(&pool, None, job_id, 1, -1).await);

    assert_invalid_pagination(
        list_workflow_step_dependencies_page(&pool, None, job_id, 0, 0).await,
    );
    assert_invalid_pagination(
        list_workflow_step_dependencies_page(&pool, None, job_id, JOB_LIST_PAGE_LIMIT_MAX + 1, 0)
            .await,
    );
    assert_invalid_pagination(
        list_workflow_step_dependencies_page(&pool, None, job_id, 1, -1).await,
    );
}

#[tokio::test]
async fn valid_pagination_limits_still_execute_list_queries() {
    let (pool, database) = setup_ephemeral_pool("postgres_pagination_validation", 4).await;
    let job_id = Uuid::nil();

    let jobs = list_jobs(
        &pool,
        &JobListFilter {
            organization_id: None,
            status: None,
            job_type: None,
            limit: 1,
            offset: 0,
        },
    )
    .await
    .expect("list jobs with valid pagination");
    assert!(jobs.is_empty());

    let events = list_job_events(&pool, None, job_id, 1, None)
        .await
        .expect("list job events with valid pagination");
    assert!(events.is_empty());

    let logs = list_job_logs(&pool, None, job_id, 1, None)
        .await
        .expect("list job logs with valid pagination");
    assert!(logs.is_empty());

    let workflow_runs = list_workflow_runs(
        &pool,
        &WorkflowRunListFilter {
            organization_id: None,
            status: None,
            workflow_type: None,
            limit: 1,
            offset: 0,
        },
    )
    .await
    .expect("list workflow runs with valid pagination");
    assert!(workflow_runs.is_empty());

    let definitions = list_job_definitions(
        &pool,
        &JobDefinitionListFilter {
            job_type: None,
            limit: 1,
            offset: 0,
        },
    )
    .await
    .expect("list job definitions with valid pagination");
    assert!(definitions.is_empty());

    let runtime_configs = list_job_runtime_configs(
        &pool,
        &JobRuntimeConfigListFilter {
            job_type: None,
            limit: 1,
            offset: 0,
        },
    )
    .await
    .expect("list runtime configs with valid pagination");
    assert!(runtime_configs.is_empty());

    let workflow_steps = list_workflow_steps_page(&pool, None, job_id, 1, 0)
        .await
        .expect("list workflow steps with valid pagination");
    assert!(workflow_steps.is_empty());

    let workflow_step_dependencies =
        list_workflow_step_dependencies_page(&pool, None, job_id, 1, 0)
            .await
            .expect("list workflow step dependencies with valid pagination");
    assert!(workflow_step_dependencies.is_empty());

    teardown_ephemeral_pool(pool, database).await;
}

#[tokio::test]
async fn workflow_detail_page_readers_decode_populated_rows() {
    let (pool, database) = setup_ephemeral_pool("postgres_workflow_detail_page_rows", 4).await;
    let job_type = JobType::new("jobs.test.workflow_detail_page");
    register_job_definition(&pool, job_type).await;

    let payload = json!({"case": "workflow-detail-page"});
    let root = WorkflowStepEnqueueBuilder::new(StepKey::new("root"), job_type, &payload)
        .priority(25)
        .try_build()
        .expect("build root step");
    let gate = WorkflowStepEnqueueBuilder::new_external(StepKey::new("gate"), &payload)
        .depends_on_success(&[StepKey::new("root")])
        .try_build()
        .expect("build gate step");
    let child = WorkflowStepEnqueueBuilder::new(StepKey::new("child"), job_type, &payload)
        .depends_on_success(&[StepKey::new("root")])
        .depends_on_terminal(&[StepKey::new("gate")])
        .try_build()
        .expect("build child step");
    let metadata = json!({"case": "workflow-detail-page"});
    let workflow = WorkflowRunEnqueueBuilder::new(
        WorkflowType::new("workflow.test.workflow_detail_page"),
        &metadata,
    )
    .step(root)
    .step(gate)
    .step(child)
    .try_build()
    .expect("build workflow");
    let run = enqueue_workflow_run(&pool, &workflow)
        .await
        .expect("enqueue workflow");

    let workflow_step_count = count_workflow_steps(&pool, None, run.id)
        .await
        .expect("count workflow steps");
    assert_eq!(workflow_step_count, 3);
    assert_eq!(
        count_workflow_step_dependencies(&pool, None, run.id)
            .await
            .expect("count workflow step dependencies"),
        3
    );

    let all_steps = list_workflow_steps_page(&pool, None, run.id, 3, 0)
        .await
        .expect("list workflow step page");
    assert_eq!(all_steps.len(), 3);
    let root_step = all_steps
        .iter()
        .find(|step| step.step_key.as_str() == "root")
        .expect("root step should decode");
    assert_eq!(
        root_step.job_type.as_ref().map(|value| value.as_str()),
        Some(job_type.as_str())
    );
    assert_eq!(root_step.priority, Some(25));
    let gate_step = all_steps
        .iter()
        .find(|step| step.step_key.as_str() == "gate")
        .expect("gate step should decode");
    assert!(gate_step.job_type.is_none());
    let child_step = all_steps
        .iter()
        .find(|step| step.step_key.as_str() == "child")
        .expect("child step should decode");
    assert_eq!(
        child_step.job_type.as_ref().map(|value| value.as_str()),
        Some(job_type.as_str())
    );

    let first_two_steps = list_workflow_steps_page(&pool, None, run.id, 2, 0)
        .await
        .expect("list partial workflow step page");
    assert_eq!(first_two_steps.len(), 2);

    let legacy_steps = list_workflow_steps(&pool, None, run.id)
        .await
        .expect("list legacy workflow steps");
    assert_eq!(
        legacy_steps.iter().map(|step| step.id).collect::<Vec<_>>(),
        all_steps.iter().map(|step| step.id).collect::<Vec<_>>(),
        "legacy and paged workflow step readers should use the same stable ordering"
    );

    let mut single_step_page_ids = Vec::new();
    for offset in 0..workflow_step_count {
        let page = list_workflow_steps_page(&pool, None, run.id, 1, offset)
            .await
            .expect("list single workflow step page");
        assert_eq!(page.len(), 1);
        single_step_page_ids.push(page[0].id);
    }
    let unique_single_step_page_ids = single_step_page_ids.iter().copied().collect::<HashSet<_>>();
    assert_eq!(
        unique_single_step_page_ids.len(),
        workflow_step_count as usize
    );
    assert_eq!(
        unique_single_step_page_ids,
        all_steps.iter().map(|step| step.id).collect::<HashSet<_>>(),
        "one-row pages should cover each workflow step exactly once"
    );

    let dependencies = list_workflow_step_dependencies_page(&pool, None, run.id, 3, 0)
        .await
        .expect("list workflow dependency page");
    assert_eq!(dependencies.len(), 3);
    let has_success = dependencies
        .iter()
        .any(|dependency| dependency.release_mode == WorkflowDependencyReleaseMode::OnSuccess);
    let has_terminal = dependencies
        .iter()
        .any(|dependency| dependency.release_mode == WorkflowDependencyReleaseMode::OnTerminal);
    assert!(has_success, "dependency page should decode OnSuccess rows");
    assert!(
        has_terminal,
        "dependency page should decode OnTerminal rows"
    );

    teardown_ephemeral_pool(pool, database).await;
}