storage-kit 0.0.1

Portable database and transactional state-store Kit.
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
use std::{
    collections::BTreeSet,
    io,
    net::SocketAddr,
    panic::AssertUnwindSafe,
    sync::{Arc, Mutex},
    time::Duration,
};

use futures::FutureExt;
use storage_kit::{
    StateStore, StateStoreBackend, StateStoreError, StateTransaction, StateTransactionBackend,
    state::{
        config::{PostgresStateStoreConfig, StateStoreConfig},
        record::StateRecord,
    },
};
use tokio::{
    io::{AsyncReadExt, AsyncWriteExt},
    net::{TcpListener, TcpStream, tcp::OwnedReadHalf, tcp::OwnedWriteHalf},
    sync::watch,
    task::{JoinHandle, JoinSet},
    time::{Instant, sleep, timeout, timeout_at},
};

use super::PostgresCases;

#[derive(Clone, Copy)]
enum RollbackReceipt {
    Forward,
    Lose,
}

#[derive(Default)]
struct RelayEvidence {
    conflicts: usize,
    rollbacks: usize,
    lost_receipts: usize,
    backend_pids: BTreeSet<i32>,
}

// This bridge never manufactures a PostgreSQL reply. The negative case cuts
// only after the real server reports ROLLBACK on the connection that emitted
// SQLSTATE 40001. It proves lost cleanup acknowledgment, not failed rollback.
struct RollbackRelay {
    address: SocketAddr,
    stop: watch::Sender<bool>,
    task: Option<JoinHandle<Vec<String>>>,
    evidence: Arc<Mutex<RelayEvidence>>,
}

impl RollbackRelay {
    async fn start(host: String, port: u16, receipt: RollbackReceipt) -> io::Result<Self> {
        let listener = TcpListener::bind(("127.0.0.1", 0)).await?;
        let address = listener.local_addr()?;
        let (stop, stopping) = watch::channel(false);
        let evidence = Arc::new(Mutex::new(RelayEvidence::default()));
        let observed = Arc::clone(&evidence);
        let task = tokio::spawn(Self::run(listener, host, port, receipt, stopping, observed));
        Ok(Self {
            address,
            stop,
            task: Some(task),
            evidence,
        })
    }

    async fn run(
        listener: TcpListener,
        host: String,
        port: u16,
        receipt: RollbackReceipt,
        mut stopping: watch::Receiver<bool>,
        evidence: Arc<Mutex<RelayEvidence>>,
    ) -> Vec<String> {
        let mut connections = JoinSet::new();
        let mut errors = Vec::new();
        loop {
            tokio::select! {
                _ = stopping.changed() => break,
                accepted = listener.accept() => match accepted {
                    Ok((client, _)) => {
                        connections.spawn(Self::connection(
                            client, host.clone(), port, receipt, stopping.clone(), Arc::clone(&evidence),
                        ));
                    }
                    Err(error) => { errors.push(format!("relay accept: {error}")); break; }
                },
                joined = connections.join_next(), if !connections.is_empty() => {
                    Self::record_join(joined, &mut errors);
                }
            }
        }
        // The sender remains on the fixture while every connection observes
        // stop and is joined. No relay task is detached on the normal path.
        while let Some(joined) = connections.join_next().await {
            Self::record_join(Some(joined), &mut errors);
        }
        errors
    }

    fn record_join(
        result: Option<Result<io::Result<()>, tokio::task::JoinError>>,
        errors: &mut Vec<String>,
    ) {
        match result {
            Some(Ok(Ok(()))) | None => {}
            Some(Ok(Err(error))) => errors.push(format!("relay connection: {error}")),
            Some(Err(error)) => errors.push(format!("relay connection task: {error}")),
        }
    }

    async fn connection(
        client: TcpStream,
        host: String,
        port: u16,
        receipt: RollbackReceipt,
        mut stopping: watch::Receiver<bool>,
        evidence: Arc<Mutex<RelayEvidence>>,
    ) -> io::Result<()> {
        if *stopping.borrow() {
            return Ok(());
        }
        let backend = tokio::select! {
            result = timeout(Duration::from_secs(5), TcpStream::connect((host.as_str(), port))) => {
                result.map_err(|_| io::Error::new(io::ErrorKind::TimedOut, "relay connect deadline"))??
            }
            _ = stopping.changed() => return Ok(()),
        };
        let (mut client_read, client_write) = client.into_split();
        let (backend_read, mut backend_write) = backend.into_split();
        tokio::select! {
            _ = stopping.changed() => Ok(()),
            copied = tokio::io::copy(&mut client_read, &mut backend_write) => copied.map(|_| ()),
            copied = Self::backend_frames(backend_read, client_write, receipt, evidence) => copied,
        }
    }

    async fn backend_frames(
        mut backend: OwnedReadHalf,
        mut client: OwnedWriteHalf,
        receipt: RollbackReceipt,
        evidence: Arc<Mutex<RelayEvidence>>,
    ) -> io::Result<()> {
        let mut conflict = false;
        loop {
            let mut tag = [0_u8; 1];
            if backend.read(&mut tag).await? == 0 {
                return Ok(());
            }
            let mut length = [0_u8; 4];
            backend.read_exact(&mut length).await?;
            let length_value = u32::from_be_bytes(length) as usize;
            if !(4..=1024 * 1024).contains(&length_value) {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidData,
                    "unexpected native frame size",
                ));
            }
            let mut payload = vec![0; length_value - 4];
            backend.read_exact(&mut payload).await?;
            let lose = {
                let mut observed = evidence.lock().expect("relay evidence");
                if tag[0] == b'K' && payload.len() >= 4 {
                    observed.backend_pids.insert(i32::from_be_bytes(
                        payload[..4].try_into().expect("PID bytes"),
                    ));
                }
                if tag[0] == b'E'
                    && payload
                        .split(|byte| *byte == 0)
                        .any(|field| field == b"C40001")
                {
                    conflict = true;
                    observed.conflicts += 1;
                }
                if conflict && tag[0] == b'C' && payload == b"ROLLBACK\0" {
                    observed.rollbacks += 1;
                    if matches!(receipt, RollbackReceipt::Lose) {
                        observed.lost_receipts += 1;
                        true
                    } else {
                        false
                    }
                } else {
                    false
                }
            };
            if lose {
                return Ok(());
            }
            client.write_all(&tag).await?;
            client.write_all(&length).await?;
            client.write_all(&payload).await?;
        }
    }

    async fn finish(&mut self) -> Vec<String> {
        self.stop.send_replace(true);
        let Some(task) = self.task.as_mut() else {
            return Vec::new();
        };
        let mut errors = match timeout(Duration::from_secs(5), &mut *task).await {
            Ok(Ok(errors)) => {
                self.task.take();
                return errors;
            }
            Ok(Err(error)) => {
                self.task.take();
                return vec![format!("relay owner: {error}")];
            }
            Err(_) => vec!["relay owner did not join before cleanup deadline".to_owned()],
        };
        task.abort();
        match timeout(Duration::from_secs(5), &mut *task).await {
            Ok(Err(error)) if error.is_cancelled() => {
                self.task.take();
            }
            Ok(result) => {
                self.task.take();
                errors.push(format!("relay fallback: {result:?}"));
            }
            Err(_) => errors.push("relay fallback join remains unconfirmed".to_owned()),
        }
        errors
    }
}

impl Drop for RollbackRelay {
    fn drop(&mut self) {
        self.stop.send_replace(true);
        if let Some(task) = &self.task {
            task.abort();
        }
    }
}

struct CleanupReceiptCase {
    case: PostgresCases,
    receipt: RollbackReceipt,
    relay: Option<RollbackRelay>,
    client: Option<tokio_postgres::Client>,
    driver: Option<JoinHandle<Result<(), tokio_postgres::Error>>>,
    stores: Vec<StateStore>,
    stale: Option<StateTransaction>,
    runtime_baseline: usize,
}

impl CleanupReceiptCase {
    async fn run(receipt: RollbackReceipt) {
        let mut case = Self {
            case: PostgresCases::from_env(),
            receipt,
            relay: None,
            client: None,
            driver: None,
            stores: Vec::new(),
            stale: None,
            runtime_baseline: 0,
        };
        let observed = AssertUnwindSafe(timeout(Duration::from_secs(30), case.observe()))
            .catch_unwind()
            .await;
        let cleanup = case.cleanup().await;
        if !cleanup.is_empty() {
            eprintln!("PostgreSQL cleanup receipt fixture cleanup: {cleanup:?}");
        }
        let result = match observed {
            Ok(Ok(result)) => result,
            Ok(Err(error)) => {
                panic!("PostgreSQL receipt observation timed out: {error}; cleanup={cleanup:?}")
            }
            Err(panic) => std::panic::resume_unwind(panic),
        };
        let (primary, rollback) = result;
        assert!(
            matches!(&primary, StateStoreError::TransactionConflict { operation, .. } if operation == "load"),
            "{primary:?}"
        );
        match receipt {
            RollbackReceipt::Forward => assert_eq!(rollback, Ok(()), "confirmed native rollback"),
            RollbackReceipt::Lose => assert!(
                matches!(&rollback, Err(StateStoreError::Unavailable { operation, .. }) if operation == "rollback"),
                "lost cleanup acknowledgment must remain unknown; primary={primary:?}, rollback={rollback:?}"
            ),
        }
        assert!(cleanup.is_empty(), "{cleanup:?}");
    }

    async fn observe(&mut self) -> (StateStoreError, Result<(), StateStoreError>) {
        let (client, connection) = self
            .case
            .native_config
            .connect(tokio_postgres::NoTls)
            .await
            .expect("native observer");
        self.client = Some(client);
        self.driver = Some(tokio::spawn(connection));
        self.runtime_baseline = tokio::runtime::Handle::current()
            .metrics()
            .num_alive_tasks();
        self.relay = Some(
            RollbackRelay::start(
                self.case.config.host().to_owned(),
                self.case.config.port(),
                self.receipt,
            )
            .await
            .expect("native relay"),
        );
        let relay = self.relay.as_ref().expect("relay");
        let mut config = PostgresStateStoreConfig::new(
            "127.0.0.1",
            self.case.config.database(),
            self.case.config.username(),
        )
        .with_port(relay.address.port());
        if let Some(password) = self.case.config.password() {
            config = config.with_password(password.clone());
        }
        for _ in 0..2 {
            self.stores.push(
                StateStore::connect(StateStoreConfig::postgres(config.clone()))
                    .await
                    .expect("public PostgreSQL store through native relay"),
            );
        }
        let head = self.case.key("head");
        let anchor = self.case.key("snapshot-anchor");
        let losing = self.case.key("losing-write");
        let mut seed = self.stores[0].begin_transaction().await.expect("seed");
        seed.put(StateRecord::new(head.clone(), serde_json::json!(0)))
            .await
            .expect("seed head");
        seed.put(StateRecord::new(anchor.clone(), serde_json::json!(0)))
            .await
            .expect("seed anchor");
        seed.commit().await.expect("seed commit");
        self.stale = Some(self.stores[1].begin_transaction().await.expect("stale"));
        let stale = self.stale.as_mut().expect("stale");
        stale
            .load(anchor)
            .await
            .expect("establish old native snapshot")
            .expect("anchor");
        stale
            .put(StateRecord::new(losing.clone(), serde_json::json!(true)))
            .await
            .expect("stage losing write");
        let mut winner = self.stores[0].begin_transaction().await.expect("winner");
        winner
            .put(StateRecord::new(head.clone(), serde_json::json!(1)))
            .await
            .expect("winner write");
        winner.commit().await.expect("winner commit");
        let primary = stale
            .load(head.clone())
            .await
            .expect_err("real PostgreSQL serialization conflict");
        let rollback = self.stale.take().expect("stale").rollback().await;
        assert!(
            self.stores[0]
                .load(losing)
                .await
                .expect("losing write readback")
                .is_none()
        );
        assert_eq!(
            self.stores[0]
                .load(head)
                .await
                .expect("winner readback")
                .expect("winner")
                .record
                .value
                .as_ref(),
            &serde_json::json!(1)
        );
        let evidence = self
            .relay
            .as_ref()
            .expect("relay")
            .evidence
            .lock()
            .expect("relay evidence");
        assert_eq!(evidence.conflicts, 1, "actual SQLSTATE 40001");
        assert_eq!(evidence.rollbacks, 1, "actual native ROLLBACK completion");
        assert_eq!(
            evidence.lost_receipts,
            usize::from(matches!(self.receipt, RollbackReceipt::Lose))
        );
        assert!(
            !evidence.backend_pids.is_empty(),
            "real native connection identities"
        );
        (primary, rollback)
    }

    async fn cleanup(&mut self) -> Vec<String> {
        self.stale.take();
        let initialized = !self.stores.is_empty();
        self.stores.clear();
        let mut errors = Vec::new();
        let pids = if let Some(relay) = self.relay.as_mut() {
            errors.extend(relay.finish().await);
            relay
                .evidence
                .lock()
                .expect("relay evidence")
                .backend_pids
                .iter()
                .copied()
                .collect::<Vec<_>>()
        } else {
            Vec::new()
        };
        self.relay.take();
        if let Some(client) = &self.client {
            let deadline = Instant::now() + Duration::from_secs(5);
            let absent = timeout_at(deadline, async {
                loop {
                    let count: i64 = client
                        .query_one(
                            "SELECT count(*) FROM pg_stat_activity WHERE pid = ANY($1)",
                            &[&pids],
                        )
                        .await?
                        .get(0);
                    if count == 0 {
                        return Ok::<(), tokio_postgres::Error>(());
                    }
                    sleep(Duration::from_millis(10)).await;
                }
            })
            .await;
            if !matches!(absent, Ok(Ok(()))) {
                errors.push(format!("relay backend sessions did not settle: {absent:?}"));
            }
            if initialized {
                let removed = timeout(
                    Duration::from_secs(5),
                    client.execute(
                        "DELETE FROM storage_kit_state_records WHERE namespace = $1",
                        &[&self.case.namespace],
                    ),
                )
                .await;
                if !matches!(removed, Ok(Ok(_))) {
                    errors.push(format!("owned namespace cleanup: {removed:?}"));
                }
            }
            // Relative task quiescence is supplementary lifetime evidence,
            // not a claim that the test possesses private actor JoinHandles.
            let quiet = timeout(Duration::from_secs(5), async {
                while tokio::runtime::Handle::current()
                    .metrics()
                    .num_alive_tasks()
                    > self.runtime_baseline
                {
                    sleep(Duration::from_millis(10)).await;
                }
            })
            .await;
            if quiet.is_err() {
                errors.push(
                    "public store tasks did not return to the stable observer baseline".to_owned(),
                );
            }
        }
        self.client.take();
        if let Some(driver) = self.driver.as_mut() {
            match timeout(Duration::from_secs(5), &mut *driver).await {
                Ok(Ok(Ok(()))) => {
                    self.driver.take();
                }
                Ok(result) => {
                    errors.push(format!("native observer driver: {result:?}"));
                    self.driver.take();
                }
                Err(_) => {
                    errors.push("native observer driver cleanup deadline".to_owned());
                    driver.abort();
                    match timeout(Duration::from_secs(5), &mut *driver).await {
                        Ok(Err(error)) if error.is_cancelled() => {
                            self.driver.take();
                        }
                        Ok(result) => {
                            errors.push(format!("native observer fallback: {result:?}"));
                            self.driver.take();
                        }
                        Err(_) => errors
                            .push("native observer fallback join remains unconfirmed".to_owned()),
                    }
                }
            }
        }
        errors
    }
}

impl Drop for CleanupReceiptCase {
    fn drop(&mut self) {
        if let Some(driver) = &self.driver {
            driver.abort();
        }
    }
}

#[tokio::test]
async fn postgres_conflict_preserves_confirmed_cleanup_receipt() {
    CleanupReceiptCase::run(RollbackReceipt::Forward).await;
}

#[tokio::test]
async fn postgres_conflict_preserves_lost_cleanup_receipt() {
    CleanupReceiptCase::run(RollbackReceipt::Lose).await;
}