athena_rs 3.5.0

Hyper performant polyglot Database driver
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
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
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
use actix_web::{Responder, get, post, web};
use serde_json::{Value, json};
use sqlx::Row;
use std::sync::atomic::{AtomicBool, Ordering};
use tracing::{error, info, warn};

use crate::AppState;
pub use crate::api::gateway::contracts::{
    GATEWAY_DEFERRED_KIND_DELETE as DEFERRED_KIND_GATEWAY_DELETE,
    GATEWAY_DEFERRED_KIND_FETCH as DEFERRED_KIND_GATEWAY_FETCH,
    GATEWAY_DEFERRED_KIND_INSERT as DEFERRED_KIND_GATEWAY_INSERT,
    GATEWAY_DEFERRED_KIND_QUERY as DEFERRED_KIND_GATEWAY_QUERY,
    GATEWAY_DEFERRED_KIND_UPDATE as DEFERRED_KIND_GATEWAY_UPDATE,
};
use crate::api::gateway::contracts::{
    GatewayDeferredRequest, GatewayDeleteRequest, GatewayFetchRequest, GatewayInsertRequest,
    extract_update_payload, parse_conditions_from_body,
};
use crate::api::gateway::GatewayOperationKind;
use crate::api::gateway::update::table_id_map::get_resource_id_key;
use crate::api::provision::ensure_deferred_queue_table_initialized;
use crate::api::response::{api_success, conflict, not_found, service_unavailable};
use crate::config_validation::runtime_env_settings;
use crate::drivers::postgresql::column_resolver::resolve_information_schema_targets;
use crate::drivers::postgresql::raw_sql::{PostgresSqlExecutionResult, execute_postgres_sql};
use crate::drivers::postgresql::sqlx_driver::{
    PostgresInsertError, delete_rows, fetch_rows_with_columns, insert_row, update_rows,
};
use crate::parser::query_builder::Condition;
use crate::utils::format::normalize_column_name;

const DEFAULT_MAX_DEFERRED_ATTEMPTS: i32 = 3;

/// Back off the deferred worker when the logging pool is under pressure so a short network
/// blip or mass connection loss does not tight-loop claim attempts against an empty pool.
fn deferred_worker_sleep_after_error(
    err: &str,
    poll_interval: std::time::Duration,
) -> std::time::Duration {
    const POOL_EXHAUST_BACKOFF: std::time::Duration = std::time::Duration::from_secs(5);
    let lower: String = err.to_ascii_lowercase();
    let pool_pressure: bool = lower.contains("pool timed out")
        || lower.contains("waiting for an open connection")
        || lower.contains("forcibly closed by the remote host")
        || lower.contains("broken pipe")
        || lower.contains("connection reset");
    if pool_pressure {
        poll_interval.max(POOL_EXHAUST_BACKOFF)
    } else {
        poll_interval
    }
}

/// ## `max_deferred_attempts`
/// Get the maximum number of deferred attempts.
///
/// # Returns
/// The maximum number of deferred attempts.
///
///
fn max_deferred_attempts() -> i32 {
    let attempts = runtime_env_settings().deferred_max_attempts;
    attempts.max(DEFAULT_MAX_DEFERRED_ATTEMPTS)
}

/// ## `is_supported_deferred_kind`
/// Check if the deferred kind is supported.
///
/// # Arguments
/// * `kind` - The deferred kind.
///
/// # Returns
/// The deferred kind is supported.
///
fn is_supported_deferred_kind(kind: &str) -> bool {
    GatewayOperationKind::from_deferred_kind(kind).is_some()
}

/// ## `deferred_request_should_invalidate_cache`
/// Check if the deferred request should invalidate the cache.
///
/// # Arguments
/// * `value` - The value.
///
/// # Returns
/// The deferred request should invalidate the cache.
///
fn deferred_request_should_invalidate_cache(value: &Value) -> bool {
    match value {
        Value::Null => false,
        Value::Object(map) => !map.is_empty(),
        _ => true,
    }
}

/// ## `invalidate_deferred_gateway_cache`
/// Invalidate the deferred gateway cache.
///
/// # Arguments
/// * `state` - The state.
/// * `client_name` - The client name.
/// * `table_name` - The table name.
///
/// # Returns
/// The deferred gateway cache invalidated.
///
async fn invalidate_deferred_gateway_cache(state: &AppState, _client_name: &str, table_name: &str) {
    if state.cache.entry_count() == 0 {
        return;
    }
    let table_for_predicate = table_name.trim().to_string();
    let _ = state.cache.invalidate_entries_if(move |key, _value| {
        crate::api::cache::invalidation::gateway_cache_entry_matches_table_invalidation(
            key.as_str(),
            &table_for_predicate,
        )
    });
    state.cache.run_pending_tasks().await;
}

/// ## `parse_fetch_sort_options_from_body`
/// Parse the fetch sort options from the body.
///
/// # Arguments
/// * `body` - The body.
/// * `force_snake_case` - Whether to force snake case.
///
/// # Returns
/// The fetch sort options.
///
fn parse_fetch_sort_options_from_body(
    body: &Value,
    force_snake_case: bool,
) -> Option<(String, bool)> {
    let sort_object: &serde_json::Map<String, Value> = body
        .get("sort_by")
        .or_else(|| body.get("sortBy"))
        .and_then(Value::as_object)?;
    let field: &str = sort_object
        .get("field")
        .or_else(|| sort_object.get("column"))
        .and_then(Value::as_str)?;
    let column: String = normalize_column_name(field, force_snake_case);
    if column.is_empty() {
        return None;
    }
    let ascending: bool = sort_object
        .get("direction")
        .and_then(Value::as_str)
        .map(|value| matches!(value.to_ascii_lowercase().as_str(), "asc" | "ascending"))
        .unwrap_or(true);
    Some((column, ascending))
}

/// ## `normalize_table_name_for_resource_id_lookup`
/// Normalize the table name for resource id lookup.
///
/// # Arguments
/// * `table_name` - The table name.
/// * `allow_schema_names_prefixed_as_table_name` - Whether to allow schema names prefixed as table name.
///
/// # Returns
/// The normalized table name.
///
fn normalize_table_name_for_resource_id_lookup(
    table_name: &str,
    allow_schema_names_prefixed_as_table_name: bool,
) -> String {
    let trimmed: &str = table_name.trim();
    if trimmed.is_empty() {
        return String::new();
    }
    if !allow_schema_names_prefixed_as_table_name {
        return trimmed.to_string();
    }
    match resolve_information_schema_targets(trimmed, true) {
        Ok((schema, table)) if schema.eq_ignore_ascii_case("public") => table,
        _ => trimmed.to_string(),
    }
}

/// ## `postgres_insert_error_message`
/// Get the postgres insert error message.
///
/// # Arguments
/// * `err` - The error.
///
/// # Returns
/// The postgres insert error message.
///
fn postgres_insert_error_message(err: PostgresInsertError) -> String {
    match err {
        PostgresInsertError::InvalidTableName => "invalid table name".to_string(),
        PostgresInsertError::InvalidPayload(reason) => format!("invalid payload: {reason}"),
        PostgresInsertError::InvalidJsonString { column, reason } => {
            format!("invalid JSON string for JSON column '{column}': {reason}")
        }
        PostgresInsertError::NoValidColumns => "no valid columns provided".to_string(),
        PostgresInsertError::MissingReturnColumn => {
            "insert succeeded without returned row".to_string()
        }
        PostgresInsertError::SqlExecution { message, sql_state } => {
            if let Some(sql_state) = sql_state {
                format!("{message} (sql_state={sql_state})")
            } else {
                message
            }
        }
    }
}

/// ## `deferred_client_name`
/// Get the deferred client name.
///
/// # Arguments
/// * `request` - The request.
///
/// # Returns
/// The deferred client name.
fn deferred_client_name(request: &GatewayDeferredRequest) -> Result<String, String> {
    let client_name: String = request.client_name.trim().to_string();
    if client_name.is_empty() {
        Err("deferred payload missing client_name".to_string())
    } else {
        Ok(client_name)
    }
}

fn deferred_request_body(request: &GatewayDeferredRequest) -> Result<Value, String> {
    request
        .request_body
        .clone()
        .ok_or_else(|| "deferred payload missing request_body".to_string())
}

/// Cleared when the logging client is ready again so we re-warn if it drops later.
static DEFERRED_WORKER_WARNED_NO_STORAGE: AtomicBool = AtomicBool::new(false);

fn deferred_worker_no_storage_poll_ms() -> u64 {
    runtime_env_settings()
        .deferred_worker_no_storage_poll_ms
        .max(1_000)
}

/// True when the configured logging Postgres client has an active pool (local registry).
pub fn deferred_logging_storage_ready(state: &AppState) -> bool {
    state
        .logging_client_name
        .as_ref()
        .is_some_and(|name| state.pg_registry.get_pool(name).is_some())
}

/// ## `ensure_deferred_queue_table`
/// Ensure the deferred queue table is initialized.
///
/// # Arguments
/// * `state` - The state.
///
/// # Returns
/// The deferred queue table ensured.
///
async fn ensure_deferred_queue_table(state: &AppState) -> Result<(), String> {
    let Some(logging_client_name) = state.logging_client_name.as_ref() else {
        return Err("logging client is not configured".to_string());
    };
    let Some(pool) = state.pg_registry.get_pool(logging_client_name) else {
        return Err(format!(
            "logging client '{}' is not connected",
            logging_client_name
        ));
    };

    let initialized_now: bool = ensure_deferred_queue_table_initialized(&pool).await?;
    if initialized_now {
        for kind in [
            GatewayOperationKind::Query,
            GatewayOperationKind::Fetch,
            GatewayOperationKind::Insert,
            GatewayOperationKind::Update,
            GatewayOperationKind::Delete,
        ] {
            state
                .metrics_state
                .record_deferred_event(kind.deferred_kind(), "storage_ready");
        }
        info!(
            client = %logging_client_name,
            "Deferred queue table initialization completed"
        );
    }

    Ok(())
}
/// ## `enqueue_deferred_request`
/// Enqueue a deferred request.
///
/// # Arguments
/// * `state` - The state.
/// * `request_id` - The request id.
/// * `method` - The method.
/// * `route` - The route.
/// * `client_name` - The client name.
/// * `request_bytes` - The request bytes.
/// * `payload` - The payload.
///
/// # Returns
/// The deferred request enqueued.
///
pub async fn enqueue_deferred_request(
    state: &AppState,
    request_id: &str,
    method: &str,
    route: &str,
    client_name: Option<&str>,
    request_bytes: Option<u64>,
    payload: &Value,
) -> Result<(), String> {
    let deferred_kind: &str = payload
        .get("kind")
        .and_then(Value::as_str)
        .unwrap_or("unknown");
    if !is_supported_deferred_kind(deferred_kind) {
        return Err(format!(
            "unsupported deferred payload kind '{}'",
            deferred_kind
        ));
    }

    let Some(logging_client_name) = state.logging_client_name.as_ref() else {
        return Err("logging client is not configured".to_string());
    };
    let Some(pool) = state.pg_registry.get_pool(logging_client_name) else {
        return Err(format!(
            "logging client '{}' is not connected",
            logging_client_name
        ));
    };

    ensure_deferred_queue_table(state).await?;

    let request_bytes_i64: Option<i64> = request_bytes.map(|value| value as i64);
    let deferred_reason: Option<&str> = payload.get("reason").and_then(Value::as_str);
    sqlx::query(
        r#"
        INSERT INTO public.gateway_deferred_request_queue (
            request_id,
            method,
            route,
            client_name,
            request_bytes,
            payload,
            deferred_reason,
            status,
            created_at,
            updated_at
        )
        VALUES ($1, $2, $3, $4, $5, $6, $7, 'queued', now(), now())
        ON CONFLICT (request_id)
        DO UPDATE SET
            payload = EXCLUDED.payload,
            deferred_reason = EXCLUDED.deferred_reason,
            request_bytes = EXCLUDED.request_bytes,
            updated_at = now()
        "#,
    )
    .bind(request_id)
    .bind(method)
    .bind(route)
    .bind(client_name)
    .bind(request_bytes_i64)
    .bind(payload)
    .bind(deferred_reason)
    .execute(&pool)
    .await
    .map_err(|err| format!("failed to persist deferred request: {err}"))?;

    state
        .metrics_state
        .record_deferred_event(deferred_kind, "queued");

    Ok(())
}
/// ## `enqueue_gateway_deferred_request`
/// Enqueue a gateway deferred request.
///
/// # Arguments
/// * `state` - The state.
/// * `method` - The method.
/// * `route` - The route.
/// * `request_bytes` - The request bytes.
/// * `deferred_request` - The deferred request.
///
/// # Returns
/// The deferred request enqueued.
///
pub async fn enqueue_gateway_deferred_request(
    state: &AppState,
    method: &str,
    route: &str,
    request_bytes: Option<u64>,
    deferred_request: &GatewayDeferredRequest,
) -> Result<(), String> {
    let payload: Value = serde_json::to_value(deferred_request)
        .map_err(|err| format!("failed to serialize deferred request payload: {err}"))?;
    enqueue_deferred_request(
        state,
        &deferred_request.request_id,
        method,
        route,
        Some(&deferred_request.client_name),
        request_bytes,
        &payload,
    )
    .await
}

/// ## `parse_deferred_request`
/// Parse a deferred request.
///
/// # Arguments
/// * `payload` - The payload.
///
/// # Returns
/// The deferred request parsed.
fn parse_deferred_request(payload: &Value) -> Result<GatewayDeferredRequest, String> {
    let request: GatewayDeferredRequest = serde_json::from_value(payload.clone())
        .map_err(|err| format!("invalid deferred payload contract: {err}"))?;
    if request.kind.trim().is_empty() {
        return Err("deferred payload missing kind".to_string());
    }
    if request.request_id.trim().is_empty() {
        return Err("deferred payload missing request_id".to_string());
    }
    if request.client_name.trim().is_empty() {
        return Err("deferred payload missing client_name".to_string());
    }
    Ok(request)
}
/// ## `claim_next_deferred_job`
/// Claim the next deferred job.
///
/// # Arguments
/// * `state` - The state.
///
/// # Returns
/// The next deferred job claimed.
///
async fn claim_next_deferred_job(state: &AppState) -> Result<Option<(String, Value)>, String> {
    let Some(logging_client_name) = state.logging_client_name.as_ref() else {
        return Ok(None);
    };
    let Some(pool) = state.pg_registry.get_pool(logging_client_name) else {
        return Ok(None);
    };

    ensure_deferred_queue_table(state).await?;

    let row: Option<sqlx::postgres::PgRow> = sqlx::query(
        r#"
        WITH candidate AS (
            SELECT request_id
            FROM public.gateway_deferred_request_queue
            WHERE status = 'queued'
              AND (next_attempt_at IS NULL OR next_attempt_at <= now())
            ORDER BY created_at ASC
            FOR UPDATE SKIP LOCKED
            LIMIT 1
        )
        UPDATE public.gateway_deferred_request_queue q
        SET status = 'running',
            updated_at = now(),
            attempts = q.attempts + 1,
            error_message = NULL
        FROM candidate
        WHERE q.request_id = candidate.request_id
        RETURNING q.request_id, q.payload
        "#,
    )
    .fetch_optional(&pool)
    .await
    .map_err(|err| format!("failed to claim deferred job: {err}"))?;

    Ok(row.map(|row| {
        let request_id: String = row.try_get("request_id").unwrap_or_default();
        let payload: Value = row.try_get("payload").unwrap_or_else(|_| json!({}));
        (request_id, payload)
    }))
}

/// ## `mark_deferred_job_failed`
/// Mark a deferred job as failed.
///
/// # Arguments
/// * `state` - The state.
/// * `request_id` - The request id.
/// * `deferred_kind` - The deferred kind.
/// * `message` - The message.
///
async fn mark_deferred_job_failed(
    state: &AppState,
    request_id: &str,
    deferred_kind: &str,
    message: &str,
) -> Result<(), String> {
    let Some(logging_client_name) = state.logging_client_name.as_ref() else {
        return Ok(());
    };
    let Some(pool) = state.pg_registry.get_pool(logging_client_name) else {
        return Ok(());
    };

    let max_attempts: i32 = max_deferred_attempts();
    sqlx::query(
        r#"
        UPDATE public.gateway_deferred_request_queue
        SET status = CASE WHEN attempts >= $3 THEN 'dead_letter' ELSE 'queued' END,
            error_message = $2,
            updated_at = now(),
            completed_at = CASE WHEN attempts >= $3 THEN now() ELSE NULL END,
            next_attempt_at = CASE
                WHEN attempts >= $3 THEN NULL
                ELSE now() + make_interval(secs => LEAST(300, CAST(power(2, GREATEST(0, attempts - 1)) AS int)))
            END
        WHERE request_id = $1
        "#,
    )
    .bind(request_id)
    .bind(message)
    .bind(max_attempts)
    .execute(&pool)
    .await
    .map_err(|err| format!("failed to mark deferred job failed: {err}"))?;

    if let Ok(status_row) = sqlx::query(
        r#"
        SELECT status
        FROM public.gateway_deferred_request_queue
        WHERE request_id = $1
        "#,
    )
    .bind(request_id)
    .fetch_one(&pool)
    .await
    {
        let status: String = status_row.try_get("status").unwrap_or_default();
        if status == "dead_letter" {
            state
                .metrics_state
                .record_deferred_event(deferred_kind, "dead_letter");
        } else {
            state
                .metrics_state
                .record_deferred_event(deferred_kind, "retry_scheduled");
        }
    }

    Ok(())
}

/// ## `mark_deferred_job_completed`
/// Mark a deferred job as completed.
///
/// # Arguments
/// * `state` - The state.
/// * `request_id` - The request id.
/// * `deferred_kind` - The deferred kind.
/// * `summary` - The summary.
///
/// # Returns
/// The deferred job marked as completed.
///
async fn mark_deferred_job_completed(
    state: &AppState,
    request_id: &str,
    deferred_kind: &str,
    summary: Value,
) -> Result<(), String> {
    let Some(logging_client_name) = state.logging_client_name.as_ref() else {
        return Ok(());
    };
    let Some(pool) = state.pg_registry.get_pool(logging_client_name) else {
        return Ok(());
    };

    sqlx::query(
        r#"
        UPDATE public.gateway_deferred_request_queue
        SET status = 'completed',
            result_summary = $2,
            updated_at = now(),
            completed_at = now()
        WHERE request_id = $1
        "#,
    )
    .bind(request_id)
    .bind(summary)
    .execute(&pool)
    .await
    .map_err(|err| format!("failed to mark deferred job completed: {err}"))?;

    state
        .metrics_state
        .record_deferred_event(deferred_kind, "completed");

    Ok(())
}

/// ## `execute_deferred_gateway_query`
/// Execute a deferred gateway query.
///
/// # Arguments
/// * `state` - The state.
/// * `request` - The request.
///
/// # Returns
/// The deferred gateway query executed.
///
async fn execute_deferred_gateway_query(
    state: &AppState,
    request: &GatewayDeferredRequest,
) -> Result<Value, String> {
    let client_name: String = deferred_client_name(request)?;
    let query: String = request.query_text().unwrap_or_default().trim().to_string();
    if query.is_empty() {
        return Err("deferred payload missing query".to_string());
    }

    let Some(pool) = state.pg_registry.get_pool(&client_name) else {
        return Err(format!(
            "postgres client '{}' unavailable for deferred execution",
            client_name
        ));
    };

    let result: PostgresSqlExecutionResult = execute_postgres_sql(&pool, &query)
        .await
        .map_err(|err| format!("deferred query execution failed: {err}"))?;
    Ok(json!({
        "kind": DEFERRED_KIND_GATEWAY_QUERY,
        "client_name": client_name,
        "statement_count": result.summary.statement_count,
        "rows_affected": result.summary.rows_affected,
        "returned_row_count": result.summary.returned_row_count,
        "rows_preview": result.rows.into_iter().take(25).collect::<Vec<_>>()
    }))
}

/// ## `execute_deferred_gateway_fetch`
/// Execute a deferred gateway fetch.
///
/// # Arguments
/// * `state` - The state.
/// * `request` - The request.
///
/// # Returns
/// The deferred gateway fetch executed.
///
async fn execute_deferred_gateway_fetch(
    state: &AppState,
    request: &GatewayDeferredRequest,
) -> Result<Value, String> {
    let client_name: String = deferred_client_name(request)?;
    let request_body: Value = deferred_request_body(request)?;
    let request: GatewayFetchRequest =
        GatewayFetchRequest::from_body(&request_body, state.gateway_force_camel_case_to_snake_case);
    if request.table_name.trim().is_empty() {
        return Err("deferred fetch payload missing table_name".to_string());
    }

    let Some(pool) = state.pg_registry.get_pool(&client_name) else {
        return Err(format!(
            "postgres client '{}' unavailable for deferred execution",
            client_name
        ));
    };

    let mut columns: Vec<String> = request.columns.clone();
    if columns.is_empty() {
        columns.push("*".to_string());
    }
    let columns_refs: Vec<&str> = columns.iter().map(|column| column.as_str()).collect();
    let conditions: Vec<super::GatewayRequestCondition> = parse_conditions_from_body(&request_body);
    let pg_conditions: Vec<Condition> = conditions
        .iter()
        .map(|condition| {
            let column_name = normalize_column_name(
                &condition.eq_column,
                state.gateway_force_camel_case_to_snake_case,
            );
            Condition::eq(column_name, condition.eq_value.clone())
                .with_uuid_value_text_cast(state.gateway_auto_cast_uuid_filter_values_to_text)
        })
        .collect();
    let limit: i64 = request.limit.or(request.page_size).unwrap_or(100);
    let current_page: i64 = request.current_page.unwrap_or(1).max(1);
    let page_size: i64 = request.page_size.unwrap_or(100);
    let offset: i64 = request.offset.unwrap_or(0);
    let calculated_offset: i64 = (current_page - 1) * page_size + offset;
    let sort_options: Option<(String, bool)> = parse_fetch_sort_options_from_body(
        &request_body,
        state.gateway_force_camel_case_to_snake_case,
    );
    let order_by: Option<(&str, bool)> = sort_options
        .as_ref()
        .map(|(column, ascending)| (column.as_str(), *ascending));

    let rows: Vec<Value> = fetch_rows_with_columns(
        &pool,
        &request.table_name,
        &columns_refs,
        &pg_conditions,
        limit,
        calculated_offset,
        order_by,
        state.gateway_allow_schema_names_prefixed_as_table_name,
    )
    .await
    .map_err(|err| format!("deferred fetch execution failed: {err}"))?;

    Ok(json!({
        "kind": DEFERRED_KIND_GATEWAY_FETCH,
        "client_name": client_name,
        "table_name": request.table_name,
        "returned_row_count": rows.len(),
        "rows_preview": rows.into_iter().take(25).collect::<Vec<_>>()
    }))
}

async fn execute_deferred_gateway_insert(
    state: &AppState,
    request: &GatewayDeferredRequest,
) -> Result<Value, String> {
    let client_name: String = deferred_client_name(request)?;
    let request_body: Value = deferred_request_body(request)?;
    let request: GatewayInsertRequest = GatewayInsertRequest::from_body(&request_body)
        .ok_or_else(|| "deferred insert payload missing table_name or insert_body".to_string())?;
    let Some(pool) = state.pg_registry.get_pool(&client_name) else {
        return Err(format!(
            "postgres client '{}' unavailable for deferred execution",
            client_name
        ));
    };

    let inserted_row: Value = insert_row(&pool, &request.table_name, &request.insert_body)
        .await
        .map_err(postgres_insert_error_message)?;
    if deferred_request_should_invalidate_cache(&inserted_row) {
        invalidate_deferred_gateway_cache(state, &client_name, &request.table_name).await;
    }

    Ok(json!({
        "kind": DEFERRED_KIND_GATEWAY_INSERT,
        "client_name": client_name,
        "table_name": request.table_name,
        "inserted_row": inserted_row
    }))
}

async fn execute_deferred_gateway_update(
    state: &AppState,
    request: &GatewayDeferredRequest,
) -> Result<Value, String> {
    let client_name: String = deferred_client_name(request)?;
    let request_body: Value = deferred_request_body(request)?;
    let table_name: String = request_body
        .get("table_name")
        .and_then(Value::as_str)
        .unwrap_or_default()
        .trim()
        .to_string();
    if table_name.is_empty() {
        return Err("deferred update payload missing table_name".to_string());
    }
    let set_payload: serde_json::Map<String, Value> =
        extract_update_payload(&request_body, state.gateway_force_camel_case_to_snake_case)
            .ok_or_else(|| "deferred update payload missing data/set/columns values".to_string())?;
    let conditions: Vec<super::GatewayRequestCondition> = parse_conditions_from_body(&request_body);
    if conditions.is_empty() {
        return Err("deferred update requires at least one condition".to_string());
    }
    let pg_conditions: Vec<Condition> = conditions
        .iter()
        .map(|condition| {
            let column_name = normalize_column_name(
                &condition.eq_column,
                state.gateway_force_camel_case_to_snake_case,
            );
            Condition::eq(column_name, condition.eq_value.clone())
                .with_uuid_value_text_cast(state.gateway_auto_cast_uuid_filter_values_to_text)
        })
        .collect();
    let Some(pool) = state.pg_registry.get_pool(&client_name) else {
        return Err(format!(
            "postgres client '{}' unavailable for deferred execution",
            client_name
        ));
    };

    let rows: Vec<Value> = update_rows(
        &pool,
        &table_name,
        &pg_conditions,
        &Value::Object(set_payload),
    )
    .await
    .map_err(|err| format!("deferred update execution failed: {err}"))?;
    if !rows.is_empty() {
        invalidate_deferred_gateway_cache(state, &client_name, &table_name).await;
    }

    Ok(json!({
        "kind": DEFERRED_KIND_GATEWAY_UPDATE,
        "client_name": client_name,
        "table_name": table_name,
        "updated_count": rows.len(),
        "rows_preview": rows.into_iter().take(25).collect::<Vec<_>>()
    }))
}

/// ## `execute_deferred_gateway_delete`
/// Execute a deferred gateway delete.
///
/// # Arguments
/// * `state` - The state.
/// * `request` - The request.
///
/// # Returns
/// The deferred gateway delete executed.
///
async fn execute_deferred_gateway_delete(
    state: &AppState,
    request: &GatewayDeferredRequest,
) -> Result<Value, String> {
    let client_name: String = deferred_client_name(request)?;
    let request_body: Value = deferred_request_body(request)?;
    let request: GatewayDeleteRequest = serde_json::from_value(request_body)
        .map_err(|err| format!("invalid deferred delete payload: {err}"))?;
    if request.table_name.trim().is_empty() || request.resource_id.trim().is_empty() {
        return Err("deferred delete payload missing table_name or resource_id".to_string());
    }
    let Some(pool) = state.pg_registry.get_pool(&client_name) else {
        return Err(format!(
            "postgres client '{}' unavailable for deferred execution",
            client_name
        ));
    };

    let id_lookup_table: String = normalize_table_name_for_resource_id_lookup(
        &request.table_name,
        state.gateway_allow_schema_names_prefixed_as_table_name,
    );
    let resource_id_key: String = get_resource_id_key(&id_lookup_table).await;
    let conditions: Vec<Condition> = vec![
        Condition::eq(resource_id_key, request.resource_id.clone())
            .with_uuid_value_text_cast(state.gateway_auto_cast_uuid_filter_values_to_text),
    ];
    let rows: Vec<Value> = delete_rows(&pool, &request.table_name, &conditions)
        .await
        .map_err(|err| format!("deferred delete execution failed: {err}"))?;
    if !rows.is_empty() {
        invalidate_deferred_gateway_cache(state, &client_name, &request.table_name).await;
    }

    Ok(json!({
        "kind": DEFERRED_KIND_GATEWAY_DELETE,
        "client_name": client_name,
        "table_name": request.table_name,
        "resource_id": request.resource_id,
        "deleted_count": rows.len(),
        "rows_preview": rows.into_iter().take(25).collect::<Vec<_>>()
    }))
}

/// ## `process_one_deferred_job`
/// Process one deferred job.
///
/// # Arguments
/// * `state` - The state.
///
/// # Returns
/// The deferred job processed.
///
async fn process_one_deferred_job(state: &AppState) -> Result<bool, String> {
    let Some((request_id, payload)) = claim_next_deferred_job(state).await? else {
        return Ok(false);
    };

    let deferred_request: GatewayDeferredRequest = match parse_deferred_request(&payload) {
        Ok(value) => value,
        Err(reason) => {
            let _ = mark_deferred_job_failed(state, &request_id, "unknown", &reason).await;
            return Ok(true);
        }
    };
    if deferred_request.request_id != request_id {
        let reason = format!(
            "deferred payload request_id mismatch: row='{}' payload='{}'",
            request_id, deferred_request.request_id
        );
        let _ = mark_deferred_job_failed(state, &request_id, "unknown", &reason).await;
        return Ok(true);
    }
    let deferred_kind: String = deferred_request.kind.clone();
    let Some(operation_kind) = GatewayOperationKind::from_deferred_kind(&deferred_kind) else {
        let reason = format!("unsupported deferred payload kind '{}'", deferred_kind);
        let _ = mark_deferred_job_failed(state, &request_id, "unknown", &reason).await;
        return Ok(true);
    };

    state
        .metrics_state
        .record_deferred_event(operation_kind.deferred_kind(), "running");

    let execution_result: Result<Value, String> = match operation_kind {
        GatewayOperationKind::Query => {
            execute_deferred_gateway_query(state, &deferred_request).await
        }
        GatewayOperationKind::Fetch => {
            execute_deferred_gateway_fetch(state, &deferred_request).await
        }
        GatewayOperationKind::Insert => {
            execute_deferred_gateway_insert(state, &deferred_request).await
        }
        GatewayOperationKind::Update => {
            execute_deferred_gateway_update(state, &deferred_request).await
        }
        GatewayOperationKind::Delete => {
            execute_deferred_gateway_delete(state, &deferred_request).await
        }
        GatewayOperationKind::Rpc => Err(format!(
            "unsupported deferred payload kind '{}'",
            deferred_kind
        )),
    };

    match execution_result {
        Ok(summary) => {
            let _ = mark_deferred_job_completed(
                state,
                &request_id,
                operation_kind.deferred_kind(),
                summary,
            )
            .await;
            Ok(true)
        }
        Err(reason) => {
            let _ = mark_deferred_job_failed(
                state,
                &request_id,
                operation_kind.deferred_kind(),
                &reason,
            )
            .await;
            Ok(true)
        }
    }
}

/// ## `run_deferred_gateway_worker_once`
/// Run the deferred gateway worker once.
///
/// # Arguments
/// * `state` - The state.
///
/// # Returns
/// The deferred gateway worker once.
pub async fn run_deferred_gateway_worker_once(state: &AppState) -> Result<bool, String> {
    process_one_deferred_job(state).await
}

/// ## `run_deferred_query_worker_once`
/// Run the deferred query worker once.
///
/// # Arguments
/// * `state` - The state.
///
/// # Returns
/// The deferred query worker once.
///
pub async fn run_deferred_query_worker_once(state: &AppState) -> Result<bool, String> {
    run_deferred_gateway_worker_once(state).await
}

/// ## `spawn_deferred_query_worker`
/// Spawn the deferred query worker.
///
/// # Arguments
/// * `app_state` - The app state.
/// * `enabled` - Whether the deferred query worker is enabled.
/// * `poll_interval` - The poll interval.
///
/// # Returns
/// The deferred query worker spawned.
///
pub fn spawn_deferred_query_worker(
    app_state: web::Data<AppState>,
    enabled: bool,
    poll_interval: std::time::Duration,
) {
    if !enabled {
        info!("Deferred query worker disabled");
        return;
    }

    let state: web::Data<AppState> = app_state.clone();
    tokio::spawn(async move {
        info!(
            poll_ms = poll_interval.as_millis() as u64,
            "Deferred query worker started"
        );
        let no_storage_poll: u64 = deferred_worker_no_storage_poll_ms();
        loop {
            let st = state.get_ref();
            if st.logging_client_name.is_none() {
                if !DEFERRED_WORKER_WARNED_NO_STORAGE.swap(true, Ordering::Relaxed) {
                    warn!(
                        poll_ms = no_storage_poll,
                        "Deferred query worker idle: gateway.logging_client is not set in the \
                         loaded configuration; deferred queue storage is unavailable (retrying on interval)"
                    );
                }
                tokio::time::sleep(std::time::Duration::from_millis(no_storage_poll)).await;
                continue;
            }
            let logging_client: &str = st.logging_client_name.as_deref().expect("checked above");
            if st.pg_registry.get_pool(logging_client).is_none() {
                if !DEFERRED_WORKER_WARNED_NO_STORAGE.swap(true, Ordering::Relaxed) {
                    warn!(
                        client = %logging_client,
                        poll_ms = no_storage_poll,
                        "Deferred query worker idle: logging Postgres client has no connected pool; \
                         deferred queue storage is unavailable (check POSTGRES_* env vars, \
                         gateway.logging_pg_uri, and startup connection errors; retrying on interval)"
                    );
                }
                tokio::time::sleep(std::time::Duration::from_millis(no_storage_poll)).await;
                continue;
            }
            DEFERRED_WORKER_WARNED_NO_STORAGE.store(false, Ordering::Relaxed);

            match run_deferred_gateway_worker_once(st).await {
                Ok(processed) => {
                    if !processed {
                        tokio::time::sleep(poll_interval).await;
                    }
                }
                Err(err) => {
                    error!(error = %err, "Deferred query worker loop failed");
                    let backoff: std::time::Duration =
                        deferred_worker_sleep_after_error(&err, poll_interval);
                    tokio::time::sleep(backoff).await;
                }
            }
        }
    });
}

/// ## `gateway_deferred_requeue`
/// Requeue a deferred request.
///
/// # Arguments
/// * `request_id` - The request id.
/// * `app_state` - The app state.
///
/// # Returns
/// The deferred request requeued.
#[post("/gateway/deferred/{request_id}/requeue")]
pub async fn gateway_deferred_requeue(
    request_id: web::Path<String>,
    app_state: web::Data<AppState>,
) -> impl Responder {
    let request_id: String = request_id.into_inner();

    if let Some(logging_client_name) = app_state.logging_client_name.as_ref()
        && let Some(pool) = app_state.pg_registry.get_pool(logging_client_name)
    {
        if let Err(err) = ensure_deferred_queue_table(app_state.get_ref()).await {
            return service_unavailable(
                "Deferred queue unavailable",
                format!("Failed to prepare deferred queue storage: {err}"),
            );
        }

        let current = sqlx::query(
            r#"
            SELECT status, payload
            FROM public.gateway_deferred_request_queue
            WHERE request_id = $1
            "#,
        )
        .bind(&request_id)
        .fetch_optional(&pool)
        .await;

        let Some(row) = (match current {
            Ok(row) => row,
            Err(err) => {
                return service_unavailable(
                    "Deferred queue unavailable",
                    format!("Failed to read deferred request: {err}"),
                );
            }
        }) else {
            return not_found(
                "Deferred request not found",
                format!("No deferred request exists for '{}'.", request_id),
            );
        };

        let status: String = row
            .try_get("status")
            .unwrap_or_else(|_| "queued".to_string());
        if status == "queued" || status == "running" {
            return conflict(
                "Deferred request is not requeueable",
                format!(
                    "Request '{}' is currently '{}' and cannot be requeued.",
                    request_id, status
                ),
            );
        }

        let payload: Value = row.try_get("payload").unwrap_or_else(|_| json!({}));
        let deferred_kind = payload
            .get("kind")
            .and_then(Value::as_str)
            .unwrap_or("unknown");

        if let Err(err) = sqlx::query(
            r#"
            UPDATE public.gateway_deferred_request_queue
            SET status = 'queued',
                updated_at = now(),
                completed_at = NULL,
                error_message = NULL,
                result_summary = NULL
            WHERE request_id = $1
            "#,
        )
        .bind(&request_id)
        .execute(&pool)
        .await
        {
            return service_unavailable(
                "Deferred queue unavailable",
                format!("Failed to requeue deferred request: {err}"),
            );
        }

        app_state
            .metrics_state
            .record_deferred_event(deferred_kind, "requeued");

        return api_success(
            "Deferred request requeued",
            json!({
                "request_id": request_id,
                "status": "queued"
            }),
        );
    }

    service_unavailable(
        "Deferred queue unavailable",
        "Logging client is not configured or not connected",
    )
}

/// ## `gateway_deferred_status`
/// Get the status of a deferred request.
///
/// # Arguments
/// * `request_id` - The request id.
/// * `app_state` - The app state.
///
/// # Returns
/// The deferred request status.
///
#[get("/gateway/deferred/{request_id}")]
pub async fn gateway_deferred_status(
    request_id: web::Path<String>,
    app_state: web::Data<AppState>,
) -> impl Responder {
    let request_id: String = request_id.into_inner();

    if let Some(logging_client_name) = app_state.logging_client_name.as_ref()
        && let Some(pool) = app_state.pg_registry.get_pool(logging_client_name)
    {
        let row = sqlx::query(
            r#"
            SELECT
                request_id,
                method,
                route,
                client_name,
                deferred_reason,
                attempts,
                status,
                created_at,
                updated_at,
                completed_at,
                next_attempt_at,
                error_message,
                result_summary
            FROM public.gateway_deferred_request_queue
            WHERE request_id = $1
            "#,
        )
        .bind(&request_id)
        .fetch_optional(&pool)
        .await;

        match row {
            Ok(Some(row)) => {
                let status: String = row.try_get("status").unwrap_or_else(|_| "queued".into());
                let method: Option<String> = row.try_get("method").ok();
                let route: Option<String> = row.try_get("route").ok();
                let client_name: Option<String> = row.try_get("client_name").ok();
                let deferred_reason: Option<String> = row.try_get("deferred_reason").ok();
                let attempts: Option<i32> = row.try_get("attempts").ok();
                let created_at: Option<chrono::DateTime<chrono::Utc>> =
                    row.try_get("created_at").ok();
                let updated_at: Option<chrono::DateTime<chrono::Utc>> =
                    row.try_get("updated_at").ok();
                let completed_at: Option<chrono::DateTime<chrono::Utc>> =
                    row.try_get("completed_at").ok();
                let next_attempt_at: Option<chrono::DateTime<chrono::Utc>> =
                    row.try_get("next_attempt_at").ok();
                let error_message: Option<String> = row.try_get("error_message").ok();
                let result_summary: Option<Value> = row.try_get("result_summary").ok();

                return api_success(
                    "Deferred request status",
                    json!({
                        "request_id": request_id,
                        "status": status,
                        "method": method,
                        "route": route,
                        "client": client_name,
                        "deferred_reason": deferred_reason,
                        "attempts": attempts,
                        "created_at": created_at,
                        "updated_at": updated_at,
                        "completed_at": completed_at,
                        "next_attempt_at": next_attempt_at,
                        "error_message": error_message,
                        "result_summary": result_summary,
                        "storage": "postgres"
                    }),
                );
            }
            Ok(None) => {}
            Err(err) => {
                warn!(error = %err, request_id = %request_id, "Deferred status query failed");
                return service_unavailable(
                    "Deferred status unavailable",
                    format!("failed to query deferred queue: {err}"),
                );
            }
        }
    }

    not_found(
        "Deferred request not found",
        format!("No deferred request exists for '{}'.", request_id),
    )
}

#[cfg(test)]
mod deferred_worker_backoff_tests {
    use super::deferred_worker_sleep_after_error;

    #[test]
    fn pool_timeout_triggers_minimum_backoff() {
        let poll: std::time::Duration = std::time::Duration::from_millis(100);
        let backoff: std::time::Duration = deferred_worker_sleep_after_error(
            "pool timed out while waiting for an open connection",
            poll,
        );
        assert!(backoff >= std::time::Duration::from_secs(5));
    }

    #[test]
    fn unrelated_errors_use_poll_interval() {
        let poll: std::time::Duration = std::time::Duration::from_millis(250);
        let backoff: std::time::Duration =
            deferred_worker_sleep_after_error("syntax error at or near \"foo\"", poll);
        assert_eq!(backoff, poll);
    }
}