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
use std::time::Duration;
use clap::{Parser, Subcommand};
use sqlx::postgres::PgPoolOptions;
#[derive(Parser)]
#[command(
name = "awa",
version,
about = "Awa — Postgres-native background job queue"
)]
struct Cli {
/// Database URL (not required for migrate --sql without --pending)
#[arg(long, env = "DATABASE_URL")]
database_url: Option<String>,
#[command(subcommand)]
command: Commands,
}
#[derive(Subcommand)]
enum Commands {
/// Run database migrations
Migrate {
/// Extract migration SQL to a directory instead of applying
#[arg(long)]
extract_to: Option<String>,
/// Print migration SQL to stdout instead of applying
#[arg(long)]
sql: bool,
/// Only include migrations after this version (exclusive)
#[arg(long)]
from: Option<i32>,
/// Only include migrations up to this version (inclusive)
#[arg(long)]
to: Option<i32>,
/// Show a single migration version
#[arg(long, conflicts_with_all = ["from", "to"])]
version: Option<i32>,
/// Auto-detect: from=current DB version, to=latest
#[arg(long, conflicts_with_all = ["from", "version"])]
pending: bool,
},
/// Job management
Job {
#[command(subcommand)]
command: JobCommands,
},
/// Queue management
Queue {
#[command(subcommand)]
command: QueueCommands,
},
/// Cron/periodic job management
Cron {
#[command(subcommand)]
command: CronCommands,
},
/// Storage transition management
Storage {
#[command(subcommand)]
command: StorageCommands,
},
/// Start the web UI server
Serve {
/// Host to bind to
#[arg(long, default_value = "127.0.0.1")]
host: String,
/// Port to listen on
#[arg(long, default_value = "3000")]
port: u16,
/// Maximum number of database connections
#[arg(long, default_value = "10", env = "AWA_POOL_MAX")]
pool_max: u32,
/// Minimum idle connections kept open
#[arg(long, default_value = "2", env = "AWA_POOL_MIN")]
pool_min: u32,
/// Seconds before an idle connection is closed
#[arg(long, default_value = "300", env = "AWA_POOL_IDLE_TIMEOUT")]
pool_idle_timeout: u64,
/// Maximum lifetime of a connection in seconds
#[arg(long, default_value = "1800", env = "AWA_POOL_MAX_LIFETIME")]
pool_max_lifetime: u64,
/// Seconds to wait when acquiring a connection
#[arg(long, default_value = "10", env = "AWA_POOL_ACQUIRE_TIMEOUT")]
pool_acquire_timeout: u64,
/// Cache TTL for dashboard queries in seconds
#[arg(long, default_value = "5", env = "AWA_CACHE_TTL")]
cache_ttl: u64,
/// Hex-encoded 32-byte key used to verify callback signatures.
#[arg(long, env = "AWA_CALLBACK_HMAC_SECRET")]
callback_hmac_secret: Option<String>,
/// Force the server into read-only mode regardless of DB privilege.
///
/// By default the server probes the Postgres connection and enables
/// read-only mode only when the DB reports `transaction_read_only =
/// on` (e.g. a read replica). Setting this flag forces read-only —
/// mutation endpoints return 503 and `/api/capabilities` reports
/// `read_only: true`. Useful for incident read-outs, shared debug
/// instances, or public UI sessions against a writable DB.
#[arg(long, env = "AWA_READ_ONLY")]
read_only: bool,
},
}
fn parse_callback_hmac_secret(secret: &str) -> Result<[u8; 32], String> {
let bytes =
hex::decode(secret).map_err(|_| "callback HMAC secret must be valid hex".to_string())?;
<[u8; 32]>::try_from(bytes.as_slice())
.map_err(|_| "callback HMAC secret must be exactly 32 bytes (64 hex characters)".into())
}
#[derive(Subcommand)]
enum JobCommands {
/// Dump a single job as a detailed JSON inspection snapshot
Dump { id: i64 },
/// Dump one attempt as a detailed JSON inspection snapshot
DumpRun {
id: i64,
/// Attempt number to inspect. Defaults to the current attempt.
#[arg(long)]
attempt: Option<i16>,
},
/// Retry a failed or cancelled job
Retry { id: i64 },
/// Cancel a job
Cancel { id: i64 },
/// Retry all failed jobs by kind
RetryFailed {
#[arg(long)]
kind: Option<String>,
#[arg(long)]
queue: Option<String>,
},
/// Discard failed jobs by kind
Discard {
#[arg(long)]
kind: String,
},
/// List jobs
List {
#[arg(long)]
state: Option<String>,
#[arg(long)]
kind: Option<String>,
#[arg(long)]
queue: Option<String>,
#[arg(long, default_value = "20")]
limit: i64,
},
}
#[derive(Subcommand)]
enum CronCommands {
/// List all registered cron job schedules
List,
/// Remove a cron job schedule by name
Remove { name: String },
}
#[derive(Subcommand)]
enum StorageCommands {
/// Show the current storage transition state
Status,
/// Prepare a future storage engine without changing execution routing
Prepare {
#[arg(long)]
engine: String,
/// Optional JSON details recorded alongside the prepared engine
#[arg(long)]
details: Option<String>,
},
/// Abort a prepared or mixed-transition storage rollout before final activation
Abort,
}
#[derive(Subcommand)]
enum QueueCommands {
/// Pause a queue
Pause { queue: String },
/// Resume a queue
Resume { queue: String },
/// Drain a queue (cancel all pending jobs)
Drain { queue: String },
/// Show queue statistics
Stats,
}
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
tracing_subscriber::fmt()
.with_env_filter(
tracing_subscriber::EnvFilter::try_from_default_env()
.unwrap_or_else(|_| tracing_subscriber::EnvFilter::new("info")),
)
.init();
let cli = Cli::parse();
// Build the pool lazily — some commands (migrate --sql) don't need a DB.
let require_pool = |url: &Option<String>| -> Result<String, Box<dyn std::error::Error>> {
url.clone().ok_or_else(|| {
"DATABASE_URL is required for this command. Set --database-url or DATABASE_URL env var."
.into()
})
};
match cli.command {
Commands::Migrate {
extract_to,
sql,
from,
to,
version,
pending,
} => {
// Resolve the version range.
let current_version = awa_model::migrations::CURRENT_VERSION;
let (range_from, range_to) = if let Some(v) = version {
if v < 1 || v > current_version {
eprintln!("Version {v} is out of range. Valid versions: 1..{current_version}");
std::process::exit(1);
}
(v - 1, v)
} else if pending {
let db_url = require_pool(&cli.database_url)?;
let pool = PgPoolOptions::new()
.max_connections(2)
.connect(&db_url)
.await?;
let db_version = awa_model::migrations::current_version(&pool).await?;
(db_version, current_version)
} else {
(from.unwrap_or(0), to.unwrap_or(current_version))
};
if range_from >= range_to {
if pending {
println!("Schema is up to date (version {range_from}).");
} else {
eprintln!("No migrations in range ({range_from}, {range_to}].");
}
return Ok(());
}
let selected = awa_model::migrations::migration_sql_range(range_from, range_to);
if selected.is_empty() {
println!("No migrations matched the selected range.");
return Ok(());
}
if sql {
// Print to stdout — no DB required.
for (v, description, sql_text) in &selected {
println!("-- Migration V{v}: {description}\n{sql_text}\n");
}
} else if let Some(dir) = extract_to {
std::fs::create_dir_all(&dir)?;
for (v, description, sql_text) in &selected {
let filename = format!("{dir}/V{v}__{description}.sql");
let filename = filename.replace(' ', "_");
std::fs::write(&filename, sql_text)?;
println!("Extracted: {filename}");
}
} else {
// Default: apply migrations to DB (sequential DDL).
let db_url = require_pool(&cli.database_url)?;
let pool = PgPoolOptions::new()
.max_connections(1)
.connect(&db_url)
.await?;
awa_model::migrations::run(&pool).await?;
println!("Migrations applied successfully.");
}
}
// Serve gets its own tuned pool — handle it before the generic CLI pool.
Commands::Serve {
host,
port,
pool_max,
pool_min,
pool_idle_timeout,
pool_max_lifetime,
pool_acquire_timeout,
cache_ttl,
callback_hmac_secret,
read_only,
} => {
let db_url = require_pool(&cli.database_url)?;
let pool = PgPoolOptions::new()
.max_connections(pool_max)
.min_connections(pool_min)
.idle_timeout(Duration::from_secs(pool_idle_timeout))
.max_lifetime(Duration::from_secs(pool_max_lifetime))
.acquire_timeout(Duration::from_secs(pool_acquire_timeout))
.connect(&db_url)
.await?;
let cache_duration = Duration::from_secs(cache_ttl);
let callback_hmac_secret = callback_hmac_secret
.as_deref()
.map(parse_callback_hmac_secret)
.transpose()
.map_err(|err| format!("invalid callback HMAC secret: {err}"))?;
let read_only_mode = if read_only {
awa_ui::state::ReadOnlyMode::ReadOnly
} else {
awa_ui::state::ReadOnlyMode::Auto
};
let app =
awa_ui::router_with(pool, cache_duration, callback_hmac_secret, read_only_mode)
.await?;
let addr = format!("{host}:{port}");
let listener = tokio::net::TcpListener::bind(&addr).await?;
if read_only {
tracing::info!("AWA UI listening on http://{addr} (forced read-only)");
} else {
tracing::info!("AWA UI listening on http://{addr}");
}
axum::serve(listener, app).await?;
}
// All remaining CLI commands are single-shot (one query, then exit)
// so a single connection is sufficient.
command => {
let db_url = require_pool(&cli.database_url)?;
let pool = PgPoolOptions::new()
.max_connections(1)
.connect(&db_url)
.await?;
match command {
Commands::Migrate { .. } | Commands::Serve { .. } => unreachable!(),
Commands::Job { command } => match command {
JobCommands::Dump { id } => {
let dump = awa_model::admin::dump_job(&pool, id).await?;
println!("{}", serde_json::to_string_pretty(&dump)?);
}
JobCommands::DumpRun { id, attempt } => {
let dump = awa_model::admin::dump_run(&pool, id, attempt).await?;
println!("{}", serde_json::to_string_pretty(&dump)?);
}
JobCommands::Retry { id } => {
awa_model::admin::retry(&pool, id).await?;
println!("Retried job {id}");
}
JobCommands::Cancel { id } => {
awa_model::admin::cancel(&pool, id).await?;
println!("Cancelled job {id}");
}
JobCommands::RetryFailed { kind, queue } => {
let count = if let Some(kind) = kind {
let jobs = awa_model::admin::retry_failed_by_kind(&pool, &kind).await?;
jobs.len()
} else if let Some(queue) = queue {
let jobs =
awa_model::admin::retry_failed_by_queue(&pool, &queue).await?;
jobs.len()
} else {
eprintln!("Must specify --kind or --queue");
std::process::exit(1);
};
println!("Retried {count} failed jobs");
}
JobCommands::Discard { kind } => {
let count = awa_model::admin::discard_failed(&pool, &kind).await?;
println!("Discarded {count} failed jobs of kind '{kind}'");
}
JobCommands::List {
state,
kind,
queue,
limit,
} => {
let state = state.map(|s| {
s.parse::<awa_model::JobState>().unwrap_or_else(|e| {
eprintln!("{e}");
std::process::exit(1);
})
});
let filter = awa_model::admin::ListJobsFilter {
state,
kind,
queue,
limit: Some(limit),
..Default::default()
};
let jobs = awa_model::admin::list_jobs(&pool, &filter).await?;
if jobs.is_empty() {
println!("No jobs found.");
} else {
println!(
"{:<8} {:<25} {:<10} {:<10} {:<5} {:<5}",
"ID", "KIND", "QUEUE", "STATE", "ATT", "MAX"
);
for job in &jobs {
println!(
"{:<8} {:<25} {:<10} {:<10} {:<5} {:<5}",
job.id,
&job.kind,
&job.queue,
job.state,
job.attempt,
job.max_attempts,
);
}
println!("\n{} jobs listed.", jobs.len());
}
}
},
Commands::Cron { command } => match command {
CronCommands::List => {
let schedules = awa_model::cron::list_cron_jobs(&pool).await?;
if schedules.is_empty() {
println!("No cron job schedules found.");
} else {
println!(
"{:<25} {:<20} {:<12} {:<25} {:<10}",
"NAME", "CRON", "TIMEZONE", "KIND", "QUEUE"
);
for s in &schedules {
println!(
"{:<25} {:<20} {:<12} {:<25} {:<10}",
s.name, s.cron_expr, s.timezone, s.kind, s.queue,
);
}
println!("\n{} schedules listed.", schedules.len());
}
}
CronCommands::Remove { name } => {
let deleted = awa_model::cron::delete_cron_job(&pool, &name).await?;
if deleted {
println!("Removed cron schedule '{name}'");
} else {
println!("No cron schedule found with name '{name}'");
}
}
},
Commands::Storage { command } => match command {
StorageCommands::Status => {
let report = awa_model::storage::status_report(&pool).await?;
println!("{}", serde_json::to_string_pretty(&report)?);
}
StorageCommands::Prepare { engine, details } => {
let details = match details {
Some(raw) => serde_json::from_str(&raw)?,
None => serde_json::json!({}),
};
awa_model::storage::prepare(&pool, &engine, details).await?;
let report = awa_model::storage::status_report(&pool).await?;
println!("{}", serde_json::to_string_pretty(&report)?);
}
StorageCommands::Abort => {
awa_model::storage::abort(&pool).await?;
let report = awa_model::storage::status_report(&pool).await?;
println!("{}", serde_json::to_string_pretty(&report)?);
}
},
Commands::Queue { command } => match command {
QueueCommands::Pause { queue } => {
awa_model::admin::pause_queue(&pool, &queue, Some("cli")).await?;
println!("Paused queue '{queue}'");
}
QueueCommands::Resume { queue } => {
awa_model::admin::resume_queue(&pool, &queue).await?;
println!("Resumed queue '{queue}'");
}
QueueCommands::Drain { queue } => {
let count = awa_model::admin::drain_queue(&pool, &queue).await?;
println!("Drained {count} jobs from queue '{queue}'");
}
QueueCommands::Stats => {
let stats = awa_model::admin::queue_overviews(&pool).await?;
if stats.is_empty() {
println!("No queues found.");
} else {
println!(
"{:<15} {:<10} {:<10} {:<10} {:<15} {:<10} {:<8}",
"QUEUE",
"AVAIL",
"RUNNING",
"FAILED",
"COMPLETED/1H",
"LAG(s)",
"PAUSED"
);
for stat in &stats {
println!(
"{:<15} {:<10} {:<10} {:<10} {:<15} {:<10} {:<8}",
stat.queue,
stat.available,
stat.running,
stat.failed,
stat.completed_last_hour,
stat.lag_seconds
.map(|s| format!("{:.1}", s))
.unwrap_or_else(|| "-".to_string()),
if stat.paused { "yes" } else { "no" },
);
}
}
}
},
}
}
}
Ok(())
}