rhiza-sql 0.1.1

SQLite materialized state machine for rhiza
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
use std::collections::HashSet;
use std::fs::File;
use std::io::{Read, Seek, SeekFrom, Write};
use std::path::Path;

use rhiza_core::{LogHash, LogIndex};
use serde::{Deserialize, Serialize};
#[cfg(test)]
use sha2::{Digest, Sha256};

use crate::page_state::StateIdentityV3;
#[cfg(test)]
use crate::page_state::{PageStateCacheV3, PageStatePatchV3};
use crate::{Error, Result};

pub const QWAL_V3_MAGIC: &[u8; 6] = b"QWAL\0\x04";
pub const MAX_QWAL_V3_BYTES: usize = 512 * 1024;
pub const MAX_QWAL_V3_RECEIPTS: usize = 1024;

const SQLITE_HEADER_BYTES: usize = 100;
const SQLITE_MAGIC: &[u8; 16] = b"SQLite format 3\0";
const MIN_SQLITE_PAGE_SIZE: u32 = 512;
const MAX_SQLITE_PAGE_SIZE: u32 = 65_536;
const MAX_ID_BYTES: usize = 256;
const MAX_FINGERPRINT_BYTES: usize = 4 * 1024;

/// A final page image in a closed SQLite database.
///
/// Page numbers are one-based, as they are in SQLite's file format.
#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct QwalPageV3 {
    pub page_no: u32,
    pub after_image: Vec<u8>,
}

/// One successful member of a QWAL v3 batch.
///
/// The decided entry anchor is intentionally absent: every receipt in the
/// envelope is installed at the single anchor of the log entry carrying the
/// batch.
#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct QwalReceiptV3 {
    pub request_id: String,
    pub request_digest: LogHash,
    pub result_blob: Vec<u8>,
}

/// Canonical QWAL v3 page effect decided by the replicated log.
///
/// The envelope deliberately contains no local path or WAL-index state. The
/// caller owns the control-sidecar intent and atomic installation protocol.
#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct QwalEnvelopeV3 {
    pub cluster_id: String,
    pub epoch: u64,
    pub configuration_id: u64,
    pub recovery_generation: u64,
    pub base_index: LogIndex,
    pub base_hash: LogHash,
    pub base_state: StateIdentityV3,
    pub target_state: StateIdentityV3,
    pub materializer_fingerprint: String,
    pub receipts: Vec<QwalReceiptV3>,
    pub pages: Vec<QwalPageV3>,
}

impl QwalEnvelopeV3 {
    /// Validates every structural property that does not require the base file.
    pub fn validate(&self) -> Result<()> {
        validate_nonempty_bounded("cluster_id", &self.cluster_id, MAX_ID_BYTES)?;
        validate_nonempty_bounded(
            "materializer_fingerprint",
            &self.materializer_fingerprint,
            MAX_FINGERPRINT_BYTES,
        )?;
        let base_file_bytes = state_file_bytes(&self.base_state, "base")?;
        let target_file_bytes = state_file_bytes(&self.target_state, "target")?;
        if self.base_state.page_size != self.target_state.page_size {
            return invalid("QWAL base and target page sizes differ");
        }

        if self.receipts.is_empty() || self.receipts.len() > MAX_QWAL_V3_RECEIPTS {
            return invalid(format!(
                "QWAL receipts must contain 1..={MAX_QWAL_V3_RECEIPTS} members"
            ));
        }
        let mut result_bytes = 0usize;
        let mut request_ids = HashSet::with_capacity(self.receipts.len());
        for receipt in &self.receipts {
            validate_nonempty_bounded("request_id", &receipt.request_id, MAX_ID_BYTES)?;
            if !request_ids.insert(receipt.request_id.as_str()) {
                return invalid("QWAL receipt request ids must be unique");
            }
            crate::validate_sql_result_blob_bounds(&receipt.result_blob)
                .map_err(|_| Error::InvalidEntry("QWAL receipt result is not canonical".into()))?;
            result_bytes = result_bytes
                .checked_add(receipt.result_blob.len())
                .ok_or_else(|| Error::ResourceExhausted("QWAL result bytes overflow".into()))?;
            if result_bytes > MAX_QWAL_V3_BYTES {
                return Err(Error::ResourceExhausted(format!(
                    "QWAL results exceed {MAX_QWAL_V3_BYTES} bytes"
                )));
            }
        }

        let page_size = u64::from(self.target_state.page_size);

        let mut previous = 0;
        let mut page_bytes = 0usize;
        for page in &self.pages {
            if page.page_no == 0 {
                return invalid("QWAL page number must be one-based");
            }
            if page.page_no <= previous {
                return invalid("QWAL pages must be strictly ordered without duplicates");
            }
            if page.after_image.len() != self.target_state.page_size as usize {
                return invalid("QWAL after-image length does not match page size");
            }
            let page_end = u64::from(page.page_no)
                .checked_mul(page_size)
                .ok_or_else(|| Error::InvalidEntry("QWAL page offset overflows".into()))?;
            if page_end > target_file_bytes {
                return invalid("QWAL page lies outside the target file");
            }
            if page.page_no == 1 {
                validate_sqlite_header(&page.after_image, self.target_state.page_size)?;
                validate_header_page_count(&page.after_image, target_file_bytes, page_size)?;
            }
            page_bytes = page_bytes
                .checked_add(page.after_image.len())
                .ok_or_else(|| Error::ResourceExhausted("QWAL page bytes overflow".into()))?;
            if page_bytes > MAX_QWAL_V3_BYTES {
                return Err(Error::ResourceExhausted(format!(
                    "QWAL page images exceed {MAX_QWAL_V3_BYTES} bytes"
                )));
            }
            previous = page.page_no;
        }

        // Growing via set_len alone would create an attacker-sized sparse
        // file. Every page beyond the base EOF must therefore be carried by
        // the bounded envelope. Since pages are already strictly ordered and
        // range checked, cardinality proves that the suffix is gap-free.
        let base_pages = self.base_state.page_count;
        let target_pages = self.target_state.page_count;
        debug_assert_eq!(u64::from(base_pages) * page_size, base_file_bytes);
        debug_assert_eq!(u64::from(target_pages) * page_size, target_file_bytes);
        if target_pages > base_pages {
            let first_new = self
                .pages
                .partition_point(|page| page.page_no <= base_pages);
            let supplied_new_pages = u32::try_from(self.pages.len() - first_new)
                .map_err(|_| Error::ResourceExhausted("QWAL page count overflows".into()))?;
            let required_new_pages = target_pages - base_pages;
            if supplied_new_pages != required_new_pages {
                return invalid("QWAL growth must include every newly allocated page");
            }
        }

        Ok(())
    }

    pub fn encode(&self) -> Result<Vec<u8>> {
        encode_qwal_v3(self)
    }

    pub fn decode(bytes: &[u8]) -> Result<Self> {
        decode_qwal_v3(bytes)
    }
}

pub fn encode_qwal_v3(effect: &QwalEnvelopeV3) -> Result<Vec<u8>> {
    effect.validate()?;
    let body = postcard::to_allocvec(effect)
        .map_err(|error| Error::InvalidEntry(format!("QWAL encode failed: {error}")))?;
    let encoded_len = QWAL_V3_MAGIC
        .len()
        .checked_add(body.len())
        .ok_or_else(|| Error::ResourceExhausted("QWAL encoded length overflows".into()))?;
    if encoded_len > MAX_QWAL_V3_BYTES {
        return Err(Error::ResourceExhausted(format!(
            "QWAL envelope exceeds {MAX_QWAL_V3_BYTES} bytes"
        )));
    }
    let mut encoded = Vec::with_capacity(encoded_len);
    encoded.extend_from_slice(QWAL_V3_MAGIC);
    encoded.extend_from_slice(&body);
    Ok(encoded)
}

pub fn decode_qwal_v3(bytes: &[u8]) -> Result<QwalEnvelopeV3> {
    if bytes.len() > MAX_QWAL_V3_BYTES {
        return Err(Error::ResourceExhausted(format!(
            "QWAL envelope exceeds {MAX_QWAL_V3_BYTES} bytes"
        )));
    }
    let Some(body) = bytes.strip_prefix(QWAL_V3_MAGIC) else {
        return invalid("invalid QWAL v3 magic");
    };
    if body.is_empty() {
        return invalid("empty QWAL v3 body");
    }
    let effect: QwalEnvelopeV3 = postcard::from_bytes(body)
        .map_err(|error| Error::InvalidEntry(format!("QWAL decode failed: {error}")))?;
    effect.validate()?;

    // Reject alternate integer encodings and any trailing bytes. This also
    // makes the qlog payload a unique byte representation of the envelope.
    let canonical = postcard::to_allocvec(&effect)
        .map_err(|error| Error::InvalidEntry(format!("QWAL re-encode failed: {error}")))?;
    if canonical.as_slice() != body {
        return invalid("QWAL body is not canonically encoded");
    }
    Ok(effect)
}

/// Test oracle for byte-for-byte database equality.
#[cfg(test)]
fn file_digest(path: impl AsRef<Path>) -> Result<LogHash> {
    let mut file = File::open(path.as_ref()).map_err(io_error)?;
    let mut hasher = Sha256::new();
    let mut buffer = [0u8; 64 * 1024];
    loop {
        let read = file.read(&mut buffer).map_err(io_error)?;
        if read == 0 {
            break;
        }
        hasher.update(&buffer[..read]);
    }
    Ok(LogHash::from_bytes(hasher.finalize().into()))
}

/// Reads and validates the page size in a closed SQLite database header.
pub fn sqlite_page_size(path: impl AsRef<Path>) -> Result<u32> {
    let mut file = File::open(path.as_ref()).map_err(io_error)?;
    let mut header = [0u8; SQLITE_HEADER_BYTES];
    file.read_exact(&mut header).map_err(io_error)?;
    let file_bytes = file.metadata().map_err(io_error)?.len();
    sqlite_page_size_from_header(&header, file_bytes)
}

/// Test-only byte diff oracle for closed SQLite databases.
#[cfg(test)]
fn diff_closed_databases(
    base_path: impl AsRef<Path>,
    target_path: impl AsRef<Path>,
) -> Result<Vec<QwalPageV3>> {
    let base_path = base_path.as_ref();
    let target_path = target_path.as_ref();
    let base_page_size = sqlite_page_size(base_path)?;
    let target_page_size = sqlite_page_size(target_path)?;
    if base_page_size != target_page_size {
        return invalid("SQLite base and target page sizes differ");
    }

    let page_size = base_page_size as usize;
    let mut base = File::open(base_path).map_err(io_error)?;
    let mut target = File::open(target_path).map_err(io_error)?;
    let target_bytes = target.metadata().map_err(io_error)?.len();
    let target_pages = target_bytes / u64::from(base_page_size);
    let mut base_page = vec![0; page_size];
    let mut target_page = vec![0; page_size];
    let mut pages = Vec::new();
    let mut changed_bytes = 0usize;

    for page_index in 0..target_pages {
        target.read_exact(&mut target_page).map_err(io_error)?;
        let base_has_page = read_page_or_eof(&mut base, &mut base_page)?;
        if !base_has_page || base_page != target_page {
            changed_bytes = changed_bytes
                .checked_add(page_size)
                .ok_or_else(|| Error::ResourceExhausted("QWAL diff size overflows".into()))?;
            if changed_bytes > MAX_QWAL_V3_BYTES {
                return Err(Error::ResourceExhausted(format!(
                    "QWAL changed pages exceed {MAX_QWAL_V3_BYTES} bytes"
                )));
            }
            pages.push(QwalPageV3 {
                page_no: u32::try_from(page_index + 1)
                    .map_err(|_| Error::ResourceExhausted("QWAL page count exceeds u32".into()))?,
                after_image: target_page.clone(),
            });
        }
    }
    Ok(pages)
}

/// Applies a structurally valid, preverified transition to the held canonical
/// database inode. The caller must keep SQLite connections and lifecycle gates
/// closed until this returns and the page-state binding is refreshed.
pub(crate) fn apply_preverified_qwal_in_place(
    file: &mut File,
    effect: &QwalEnvelopeV3,
    mut after_page_write: impl FnMut(u32) -> Result<()>,
) -> Result<()> {
    effect.validate()?;
    let base_bytes = file.metadata().map_err(io_error)?.len();
    if base_bytes != state_file_bytes(&effect.base_state, "base")? {
        return invalid("QWAL base file size mismatch");
    }
    if sqlite_page_size_from_file(file)? != effect.base_state.page_size {
        return invalid("QWAL base page size mismatch");
    }

    file.set_len(state_file_bytes(&effect.target_state, "target")?)
        .map_err(io_error)?;
    let page_size = u64::from(effect.target_state.page_size);
    for page in &effect.pages {
        let offset = u64::from(page.page_no - 1)
            .checked_mul(page_size)
            .ok_or_else(|| Error::InvalidEntry("QWAL page offset overflows".into()))?;
        file.seek(SeekFrom::Start(offset)).map_err(io_error)?;
        file.write_all(&page.after_image).map_err(io_error)?;
        after_page_write(page.page_no)?;
    }

    verify_installed_pages(file, effect)
}

#[cfg(test)]
fn verify_state_transition(base_state: &PageStateCacheV3, effect: &QwalEnvelopeV3) -> Result<()> {
    if base_state.identity() != effect.base_state {
        return invalid("QWAL base page state mismatch");
    }
    let patches: Vec<_> = effect
        .pages
        .iter()
        .map(|page| PageStatePatchV3::new(page.page_no, &page.after_image))
        .collect();
    let derived = base_state.overlay(effect.target_state.page_count, &patches)?;
    if derived != effect.target_state {
        return invalid("QWAL target page state mismatch");
    }
    Ok(())
}

pub(crate) fn verify_installed_pages(file: &mut File, effect: &QwalEnvelopeV3) -> Result<()> {
    if file.metadata().map_err(io_error)?.len() != state_file_bytes(&effect.target_state, "target")?
    {
        return invalid("QWAL target file size mismatch");
    }
    if sqlite_page_size_from_file(file)? != effect.target_state.page_size {
        return invalid("QWAL target page size mismatch");
    }

    let page_size = u64::from(effect.target_state.page_size);
    let mut installed = vec![0; effect.target_state.page_size as usize];
    for page in &effect.pages {
        let offset = u64::from(page.page_no - 1)
            .checked_mul(page_size)
            .ok_or_else(|| Error::InvalidEntry("QWAL page offset overflows".into()))?;
        file.seek(SeekFrom::Start(offset)).map_err(io_error)?;
        file.read_exact(&mut installed).map_err(io_error)?;
        if installed != page.after_image {
            return invalid("QWAL installed page does not match its after-image");
        }
    }
    Ok(())
}

#[cfg(test)]
fn read_page_or_eof(file: &mut File, page: &mut [u8]) -> Result<bool> {
    let mut read = 0;
    while read < page.len() {
        let count = file.read(&mut page[read..]).map_err(io_error)?;
        if count == 0 {
            if read == 0 {
                return Ok(false);
            }
            return invalid("SQLite base file ends in a partial page");
        }
        read += count;
    }
    Ok(true)
}

fn page_size_from_header(header: &[u8]) -> Result<u32> {
    if header.len() < SQLITE_HEADER_BYTES || &header[..SQLITE_MAGIC.len()] != SQLITE_MAGIC {
        return invalid("invalid SQLite database header");
    }
    let encoded = u16::from_be_bytes([header[16], header[17]]);
    let page_size = if encoded == 1 {
        MAX_SQLITE_PAGE_SIZE
    } else {
        u32::from(encoded)
    };
    validate_page_size(page_size)?;
    Ok(page_size)
}

pub(crate) fn sqlite_page_size_from_header(header: &[u8], file_bytes: u64) -> Result<u32> {
    let page_size = page_size_from_header(header)?;
    if file_bytes == 0 || !file_bytes.is_multiple_of(u64::from(page_size)) {
        return invalid("SQLite file size is not a non-zero page-size multiple");
    }
    validate_header_page_count(header, file_bytes, u64::from(page_size))?;
    Ok(page_size)
}

fn sqlite_page_size_from_file(file: &mut File) -> Result<u32> {
    let file_bytes = file.metadata().map_err(io_error)?.len();
    let mut header = [0u8; SQLITE_HEADER_BYTES];
    file.seek(SeekFrom::Start(0)).map_err(io_error)?;
    file.read_exact(&mut header).map_err(io_error)?;
    sqlite_page_size_from_header(&header, file_bytes)
}

fn validate_page_size(page_size: u32) -> Result<()> {
    if !(MIN_SQLITE_PAGE_SIZE..=MAX_SQLITE_PAGE_SIZE).contains(&page_size)
        || !page_size.is_power_of_two()
    {
        return invalid("invalid SQLite page size");
    }
    Ok(())
}

fn state_file_bytes(state: &StateIdentityV3, label: &str) -> Result<u64> {
    validate_page_size(state.page_size)?;
    if state.page_count == 0 {
        return invalid(format!("QWAL {label} page count must be positive"));
    }
    if state.state_root == LogHash::ZERO {
        return invalid(format!("QWAL {label} state root must be non-zero"));
    }
    u64::from(state.page_size)
        .checked_mul(u64::from(state.page_count))
        .ok_or_else(|| Error::ResourceExhausted(format!("QWAL {label} file size overflows")))
}

fn validate_sqlite_header(page: &[u8], expected_page_size: u32) -> Result<()> {
    let actual = page_size_from_header(page)?;
    if actual != expected_page_size {
        return invalid("QWAL page 1 changes the declared SQLite page size");
    }
    Ok(())
}

fn validate_header_page_count(header: &[u8], file_bytes: u64, page_size: u64) -> Result<()> {
    let declared = u32::from_be_bytes([header[28], header[29], header[30], header[31]]);
    // A zero page count is permitted by legacy SQLite files. When present, the
    // count must describe the closed file exactly.
    if declared != 0 && u64::from(declared) != file_bytes / page_size {
        return invalid("SQLite header page count does not match file size");
    }
    Ok(())
}

fn validate_nonempty_bounded(field: &str, value: &str, max: usize) -> Result<()> {
    if value.is_empty() || value.len() > max {
        return invalid(format!("QWAL {field} must contain 1..={max} bytes"));
    }
    Ok(())
}

fn io_error(error: std::io::Error) -> Error {
    Error::Io(error.to_string())
}

fn invalid<T>(message: impl Into<String>) -> Result<T> {
    Err(Error::InvalidEntry(message.into()))
}

#[cfg(test)]
mod tests {
    use std::fs;

    use rusqlite::{params, Connection};

    use super::*;

    #[test]
    fn generation_capacity_is_1024_receipts_and_512_kib() {
        assert_eq!(MAX_QWAL_V3_RECEIPTS, 1024);
        assert_eq!(MAX_QWAL_V3_BYTES, 512 * 1024);
    }

    fn sqlite_header(page_size: u32, page_count: u32) -> Vec<u8> {
        let mut page = vec![0; page_size as usize];
        page[..SQLITE_MAGIC.len()].copy_from_slice(SQLITE_MAGIC);
        let encoded = if page_size == MAX_SQLITE_PAGE_SIZE {
            1u16
        } else {
            page_size as u16
        };
        page[16..18].copy_from_slice(&encoded.to_be_bytes());
        page[18] = 1;
        page[19] = 1;
        page[20] = 0;
        page[21] = 64;
        page[22] = 32;
        page[23] = 32;
        page[28..32].copy_from_slice(&page_count.to_be_bytes());
        page
    }

    fn write_pages(path: &Path, page_size: u32, fills: &[u8]) {
        let mut bytes = Vec::with_capacity(page_size as usize * fills.len());
        for (index, fill) in fills.iter().enumerate() {
            let mut page = vec![*fill; page_size as usize];
            if index == 0 {
                page = sqlite_header(page_size, fills.len() as u32);
                page[100..].fill(*fill);
            }
            bytes.extend_from_slice(&page);
        }
        fs::write(path, bytes).unwrap();
    }

    fn page_state(path: &Path) -> PageStateCacheV3 {
        let page_size = sqlite_page_size(path).unwrap();
        let bytes = fs::read(path).unwrap();
        PageStateCacheV3::from_pages(page_size, bytes.chunks_exact(page_size as usize)).unwrap()
    }

    fn envelope(base: &Path, target: &Path, pages: Vec<QwalPageV3>) -> QwalEnvelopeV3 {
        QwalEnvelopeV3 {
            cluster_id: "cluster-a".into(),
            epoch: 3,
            configuration_id: 4,
            recovery_generation: 5,
            base_index: 8,
            base_hash: LogHash::digest(&[b"base-anchor"]),
            base_state: page_state(base).identity(),
            target_state: page_state(target).identity(),
            materializer_fingerprint: "sqlite-test-qwal-v3".into(),
            receipts: vec![QwalReceiptV3 {
                request_id: "request-a".into(),
                request_digest: LogHash::digest(&[b"request"]),
                result_blob: crate::encode_sql_result(&crate::SqlCommandResult {
                    statement_results: Vec::new(),
                })
                .unwrap(),
            }],
            pages,
        }
    }

    fn diff_pages(base: &Path, target: &Path) -> Vec<QwalPageV3> {
        diff_closed_databases(base, target).unwrap()
    }

    fn apply(base: &Path, temp: &Path, effect: &QwalEnvelopeV3) -> Result<()> {
        let mut cache = page_state(base);
        let patches = effect
            .pages
            .iter()
            .map(|page| PageStatePatchV3::new(page.page_no, &page.after_image))
            .collect::<Vec<_>>();
        if cache.apply_patch(effect.target_state.page_count, &patches)? != effect.target_state {
            return invalid("QWAL target page state mismatch");
        }
        fs::copy(base, temp).map_err(io_error)?;
        let mut file = File::options()
            .read(true)
            .write(true)
            .open(temp)
            .map_err(io_error)?;
        apply_preverified_qwal_in_place(&mut file, effect, |_| Ok(()))
    }

    #[test]
    fn qwal_roundtrips_through_its_only_canonical_encoding() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        let target = dir.path().join("target.db");
        write_pages(&base, 512, &[1, 2]);
        write_pages(&target, 512, &[1, 3]);
        let effect = envelope(&base, &target, diff_pages(&base, &target));

        let encoded = effect.encode().unwrap();
        assert!(encoded.starts_with(QWAL_V3_MAGIC));
        assert_eq!(QwalEnvelopeV3::decode(&encoded).unwrap(), effect);
    }

    #[test]
    fn decoder_rejects_legacy_trailing_and_corrupted_bytes() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        let target = dir.path().join("target.db");
        write_pages(&base, 512, &[1]);
        write_pages(&target, 512, &[2]);
        let effect = envelope(&base, &target, diff_pages(&base, &target));
        let mut trailing = effect.encode().unwrap();
        trailing.push(0);
        assert!(QwalEnvelopeV3::decode(&trailing).is_err());

        let mut corrupt = effect.encode().unwrap();
        corrupt[0] ^= 0xff;
        assert!(QwalEnvelopeV3::decode(&corrupt).is_err());

        for old_magic in [b"QWAL\0\x01", b"QWAL\0\x02", b"QWAL\0\x03"] {
            let mut old = old_magic.to_vec();
            old.extend_from_slice(&effect.encode().unwrap()[QWAL_V3_MAGIC.len()..]);
            assert!(QwalEnvelopeV3::decode(&old).is_err());
        }
    }

    #[test]
    fn receipts_preserve_order_and_reject_empty_duplicate_or_oversized_batches() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        write_pages(&base, 512, &[1]);
        let mut effect = envelope(&base, &base, Vec::new());
        effect.receipts = (0..MAX_QWAL_V3_RECEIPTS)
            .map(|index| QwalReceiptV3 {
                request_id: format!("request-{index:03}"),
                request_digest: LogHash::digest(&[&index.to_le_bytes()]),
                result_blob: crate::encode_sql_result(&crate::SqlCommandResult {
                    statement_results: Vec::new(),
                })
                .unwrap(),
            })
            .collect();
        let decoded = QwalEnvelopeV3::decode(&effect.encode().unwrap()).unwrap();
        assert_eq!(decoded.receipts, effect.receipts);

        effect.receipts[MAX_QWAL_V3_RECEIPTS - 1].request_id =
            effect.receipts[0].request_id.clone();
        assert!(matches!(
            effect.validate(),
            Err(Error::InvalidEntry(message)) if message.contains("unique")
        ));

        effect.receipts.clear();
        assert!(effect.validate().is_err());

        effect.receipts = vec![
            QwalReceiptV3 {
                request_id: "duplicate".into(),
                request_digest: LogHash::ZERO,
                result_blob: crate::encode_sql_result(&crate::SqlCommandResult {
                    statement_results: Vec::new(),
                })
                .unwrap(),
            },
            QwalReceiptV3 {
                request_id: "duplicate".into(),
                request_digest: LogHash::digest(&[b"different"]),
                result_blob: crate::encode_sql_result(&crate::SqlCommandResult {
                    statement_results: Vec::new(),
                })
                .unwrap(),
            },
        ];
        assert!(effect.validate().is_err());

        effect.receipts = (0..=MAX_QWAL_V3_RECEIPTS)
            .map(|index| QwalReceiptV3 {
                request_id: format!("request-{index}"),
                request_digest: LogHash::ZERO,
                result_blob: crate::encode_sql_result(&crate::SqlCommandResult {
                    statement_results: Vec::new(),
                })
                .unwrap(),
            })
            .collect();
        assert!(effect.validate().is_err());
    }

    #[test]
    fn validation_rejects_zero_duplicate_unordered_short_and_out_of_range_pages() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        let target = dir.path().join("target.db");
        write_pages(&base, 512, &[1, 2]);
        write_pages(&target, 512, &[2, 3]);
        let page = diff_pages(&base, &target)[0].clone();

        for pages in [
            vec![QwalPageV3 {
                page_no: 0,
                after_image: vec![0; 512],
            }],
            vec![page.clone(), page.clone()],
            vec![
                QwalPageV3 {
                    page_no: 2,
                    after_image: vec![0; 512],
                },
                page.clone(),
            ],
            vec![QwalPageV3 {
                page_no: 1,
                after_image: vec![0; 511],
            }],
            vec![QwalPageV3 {
                page_no: 3,
                after_image: vec![0; 512],
            }],
        ] {
            assert!(envelope(&base, &target, pages).validate().is_err());
        }
    }

    #[test]
    fn page_state_root_is_bound_to_base_contents_and_target_shape() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        let wrong = dir.path().join("wrong.db");
        let target = dir.path().join("target.db");
        write_pages(&base, 512, &[1, 2]);
        write_pages(&wrong, 512, &[9, 2]);
        write_pages(&target, 512, &[1, 3]);
        let effect = envelope(&base, &target, diff_pages(&base, &target));

        assert!(verify_state_transition(&page_state(&wrong), &effect).is_err());

        let mut reshaped = effect.clone();
        reshaped.target_state.page_count += 1;
        reshaped.pages.push(QwalPageV3 {
            page_no: 3,
            after_image: vec![7; 512],
        });
        reshaped.validate().unwrap();
        assert!(verify_state_transition(&page_state(&base), &reshaped).is_err());

        let mut wrong_page_size = effect;
        wrong_page_size.base_state.page_size = 1024;
        wrong_page_size.target_state.page_size = 1024;
        assert!(wrong_page_size.validate().is_err());
    }

    #[test]
    fn validation_rejects_zero_roots_counts_and_mixed_page_sizes() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        write_pages(&base, 512, &[1]);
        let effect = envelope(&base, &base, Vec::new());

        let mut zero_root = effect.clone();
        zero_root.base_state.state_root = LogHash::ZERO;
        assert!(zero_root.validate().is_err());

        let mut zero_count = effect.clone();
        zero_count.target_state.page_count = 0;
        assert!(zero_count.validate().is_err());

        let mut mixed_sizes = effect;
        mixed_sizes.target_state.page_size = 1024;
        assert!(mixed_sizes.validate().is_err());
    }

    #[test]
    fn page_one_must_remain_a_valid_sqlite_header() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        let target = dir.path().join("target.db");
        write_pages(&base, 512, &[1]);
        write_pages(&target, 512, &[2]);
        let mut effect = envelope(&base, &target, diff_pages(&base, &target));
        effect.pages[0].after_image[0] = b'X';
        assert!(effect.validate().is_err());
    }

    #[test]
    fn closed_file_diff_and_apply_support_growth_and_shrink() {
        for (base_fills, target_fills) in [
            (vec![1], vec![2, 3, 4]),
            (vec![1, 2, 3], vec![4]),
            (vec![1, 2, 3], vec![1, 8, 3]),
        ] {
            let dir = tempfile::tempdir().unwrap();
            let base = dir.path().join("base.db");
            let target = dir.path().join("target.db");
            let applied = dir.path().join("applied.db");
            write_pages(&base, 512, &base_fills);
            write_pages(&target, 512, &target_fills);
            let pages = diff_pages(&base, &target);
            let effect = envelope(&base, &target, pages);

            apply(&base, &applied, &effect).unwrap();
            assert_eq!(fs::read(&applied).unwrap(), fs::read(&target).unwrap());
        }
    }

    #[test]
    fn validation_rejects_sparse_growth_and_missing_new_pages_before_file_allocation() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        let target = dir.path().join("target.db");
        write_pages(&base, 512, &[1]);
        write_pages(&target, 512, &[2, 3, 4]);

        let mut gap = envelope(&base, &target, diff_pages(&base, &target));
        gap.pages.retain(|page| page.page_no != 2);
        assert!(gap.validate().is_err());

        let mut sparse = envelope(&base, &base, Vec::new());
        sparse.target_state.page_count = u32::MAX;
        let absent = dir.path().join("must-not-be-created.db");
        assert!(sparse.validate().is_err());
        assert!(apply(&base, &absent, &sparse).is_err());
        assert!(!absent.exists());
    }

    #[test]
    fn shrink_needs_no_images_for_pages_removed_by_truncation() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        let target = dir.path().join("target.db");
        let applied = dir.path().join("applied.db");
        write_pages(&base, 512, &[1, 2, 3]);
        write_pages(&target, 512, &[1]);
        let effect = envelope(&base, &target, diff_pages(&base, &target));
        assert!(effect.pages.iter().all(|page| page.page_no == 1));
        effect.validate().unwrap();
        apply(&base, &applied, &effect).unwrap();
        assert_eq!(fs::read(applied).unwrap(), fs::read(target).unwrap());
    }

    #[test]
    fn page_size_parser_accepts_every_sqlite_page_size_and_rejects_invalid_values() {
        let dir = tempfile::tempdir().unwrap();
        for exponent in 9..=16 {
            let size = 1u32 << exponent;
            let path = dir.path().join(format!("{size}.db"));
            write_pages(&path, size, &[1]);
            assert_eq!(sqlite_page_size(path).unwrap(), size);
        }
        let invalid = dir.path().join("invalid.db");
        let mut page = sqlite_header(512, 1);
        page[16..18].copy_from_slice(&768u16.to_be_bytes());
        fs::write(&invalid, page).unwrap();
        assert!(sqlite_page_size(invalid).is_err());
    }

    #[test]
    fn forged_target_root_is_rejected_before_any_write() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        let target = dir.path().join("target.db");
        let applied = dir.path().join("applied.db");
        write_pages(&base, 512, &[1]);
        write_pages(&target, 512, &[2]);
        let mut effect = envelope(&base, &target, diff_pages(&base, &target));
        effect.target_state.state_root = LogHash::digest(&[b"forged-target-root"]);

        assert!(apply(&base, &applied, &effect).is_err());
        assert!(!applied.exists());
    }

    #[test]
    fn captured_sqlite_effect_reproduces_native_features_byte_for_byte() {
        let dir = tempfile::tempdir().unwrap();
        let base = dir.path().join("base.db");
        let target = dir.path().join("target.db");
        let applied = dir.path().join("applied.db");
        {
            let connection = Connection::open(&base).unwrap();
            connection
                .execute_batch(
                    "PRAGMA page_size=4096;
                     PRAGMA journal_mode=DELETE;
                     PRAGMA foreign_keys=ON;
                     CREATE TABLE parent(id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT);
                     CREATE TABLE child(
                       id INTEGER PRIMARY KEY,
                       parent_id INTEGER REFERENCES parent(id) ON DELETE CASCADE,
                       payload BLOB,
                       created_at TEXT DEFAULT CURRENT_TIMESTAMP
                     );
                     CREATE TABLE audit(message TEXT);
                     CREATE TRIGGER child_audit AFTER INSERT ON child BEGIN
                       INSERT INTO audit VALUES ('child:' || NEW.id);
                     END;",
                )
                .unwrap();
        }
        fs::copy(&base, &target).unwrap();
        {
            let mut connection = Connection::open(&target).unwrap();
            connection.execute_batch("PRAGMA foreign_keys=ON;").unwrap();
            let transaction = connection.transaction().unwrap();
            let parent_id: i64 = transaction
                .query_row(
                    "INSERT INTO parent(name) VALUES ('native') RETURNING id",
                    [],
                    |row| row.get(0),
                )
                .unwrap();
            let returned: (i64, Vec<u8>) = transaction
                .query_row(
                    "INSERT INTO child(id, parent_id, payload)
                     VALUES (7, ?1, randomblob(32)) RETURNING id, payload",
                    params![parent_id],
                    |row| Ok((row.get(0)?, row.get(1)?)),
                )
                .unwrap();
            assert_eq!(returned.0, 7);
            assert_eq!(returned.1.len(), 32);
            transaction.commit().unwrap();
        }

        let pages = diff_pages(&base, &target);
        assert!(!pages.is_empty());
        let effect = envelope(&base, &target, pages);
        apply(&base, &applied, &effect).unwrap();

        assert_eq!(
            file_digest(&applied).unwrap(),
            file_digest(&target).unwrap()
        );
        assert_eq!(fs::read(&applied).unwrap(), fs::read(&target).unwrap());
        let inspection =
            Connection::open_with_flags(&applied, rusqlite::OpenFlags::SQLITE_OPEN_READ_ONLY)
                .unwrap();
        assert_eq!(
            inspection
                .query_row("SELECT message FROM audit", [], |row| row
                    .get::<_, String>(0))
                .unwrap(),
            "child:7"
        );
        assert_eq!(
            inspection
                .query_row("PRAGMA integrity_check", [], |row| row.get::<_, String>(0))
                .unwrap(),
            "ok"
        );
    }
}