-
Notifications
You must be signed in to change notification settings - Fork 347
Expand file tree
/
Copy pathdb_internal_test.go
More file actions
2291 lines (1974 loc) · 62.4 KB
/
db_internal_test.go
File metadata and controls
2291 lines (1974 loc) · 62.4 KB
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
package litestream
import (
"bytes"
"context"
"database/sql"
"encoding/binary"
"errors"
"fmt"
"io"
"log/slog"
"os"
"path/filepath"
"testing"
"time"
"github.com/prometheus/client_golang/prometheus/testutil"
"github.com/superfly/ltx"
_ "modernc.org/sqlite"
"github.com/benbjohnson/litestream/internal"
)
// testReplicaClient is a minimal mock for testing that doesn't cause import cycles.
type testReplicaClient struct {
dir string
}
func (c *testReplicaClient) Init(_ context.Context) error { return nil }
func (c *testReplicaClient) Type() string { return "test" }
func (c *testReplicaClient) LTXFiles(_ context.Context, level int, afterTXID ltx.TXID, _ bool) (ltx.FileIterator, error) {
internal.OperationTotalCounterVec.WithLabelValues(c.Type(), "LIST").Inc()
levelDir := filepath.Join(c.dir, fmt.Sprintf("l%d", level))
entries, err := os.ReadDir(levelDir)
if os.IsNotExist(err) {
return ltx.NewFileInfoSliceIterator(nil), nil
} else if err != nil {
return nil, err
}
var infos []*ltx.FileInfo
for _, entry := range entries {
minTXID, maxTXID, err := ltx.ParseFilename(entry.Name())
if err != nil {
continue
}
if maxTXID <= afterTXID {
continue
}
fi, _ := entry.Info()
var size int64
if fi != nil {
size = fi.Size()
}
infos = append(infos, <x.FileInfo{
Level: level,
MinTXID: minTXID,
MaxTXID: maxTXID,
Size: size,
})
}
return ltx.NewFileInfoSliceIterator(infos), nil
}
func (c *testReplicaClient) OpenLTXFile(_ context.Context, level int, minTXID, maxTXID ltx.TXID, _, _ int64) (io.ReadCloser, error) {
internal.OperationTotalCounterVec.WithLabelValues(c.Type(), "GET").Inc()
path := filepath.Join(c.dir, fmt.Sprintf("l%d", level), ltx.FormatFilename(minTXID, maxTXID))
return os.Open(path)
}
func (c *testReplicaClient) WriteLTXFile(_ context.Context, level int, minTXID, maxTXID ltx.TXID, r io.Reader) (*ltx.FileInfo, error) {
data, err := io.ReadAll(r)
if err != nil {
return nil, err
}
levelDir := filepath.Join(c.dir, fmt.Sprintf("l%d", level))
if err := os.MkdirAll(levelDir, 0o755); err != nil {
return nil, err
}
path := filepath.Join(levelDir, ltx.FormatFilename(minTXID, maxTXID))
if err := os.WriteFile(path, data, 0o600); err != nil {
return nil, err
}
internal.OperationTotalCounterVec.WithLabelValues(c.Type(), "PUT").Inc()
internal.OperationBytesCounterVec.WithLabelValues(c.Type(), "PUT").Add(float64(len(data)))
return <x.FileInfo{Level: level, MinTXID: minTXID, MaxTXID: maxTXID, Size: int64(len(data))}, nil
}
func (c *testReplicaClient) DeleteLTXFiles(_ context.Context, infos []*ltx.FileInfo) error {
internal.OperationTotalCounterVec.WithLabelValues(c.Type(), "DELETE").Add(float64(len(infos)))
return nil
}
func (c *testReplicaClient) DeleteAll(_ context.Context) error {
return nil
}
// TestCalcWALSize ensures calcWALSize doesn't overflow with large page sizes.
// Regression test for uint32 overflow bug where large page sizes (>=16KB)
// caused incorrect WAL size calculations, triggering checkpoints too early.
func TestCalcWALSize(t *testing.T) {
tests := []struct {
name string
pageSize uint32
pageN uint32
expected int64
}{
{
name: "4KB pages, 121359 pages (default TruncatePageN)",
pageSize: 4096,
pageN: 121359,
expected: int64(WALHeaderSize) + (int64(WALFrameHeaderSize+4096) * 121359),
},
{
name: "16KB pages, 121359 pages",
pageSize: 16384,
pageN: 121359,
expected: int64(WALHeaderSize) + (int64(WALFrameHeaderSize+16384) * 121359),
},
{
name: "32KB pages, 121359 pages",
pageSize: 32768,
pageN: 121359,
// Expected: ~4.0 GB with 32KB pages. Bug previously overflowed.
expected: int64(WALHeaderSize) + (int64(WALFrameHeaderSize+32768) * 121359),
},
{
name: "64KB pages, 121359 pages",
pageSize: 65536,
pageN: 121359,
expected: int64(WALHeaderSize) + (int64(WALFrameHeaderSize+65536) * 121359),
},
{
name: "1KB pages, 1k pages (min checkpoint)",
pageSize: 1024,
pageN: 1000,
expected: int64(WALHeaderSize) + (int64(WALFrameHeaderSize+1024) * 1000),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := calcWALSize(tt.pageSize, tt.pageN)
if got != tt.expected {
t.Errorf("calcWALSize(%d, %d) = %d, want %d (%.2f GB vs %.2f GB)",
tt.pageSize, tt.pageN, got, tt.expected,
float64(got)/(1024*1024*1024), float64(tt.expected)/(1024*1024*1024))
}
if got <= 0 {
t.Errorf("calcWALSize(%d, %d) = %d, should be positive", tt.pageSize, tt.pageN, got)
}
if tt.pageSize >= 32768 && tt.pageN >= 100000 {
// Sanity check: ensure result is at least (page_size * page_count)
minExpected := int64(tt.pageSize) * int64(tt.pageN)
if got < minExpected {
t.Errorf("calcWALSize(%d, %d) = %d (%.2f GB), suspiciously small, possible overflow",
tt.pageSize, tt.pageN, got, float64(got)/(1024*1024*1024))
}
}
})
}
}
// TestDB_Sync_UpdatesMetrics verifies that DB size, WAL size, and total WAL bytes
// metrics are properly updated during sync operations.
// Regression test for issue #876: metrics were defined but never updated.
func TestDB_Sync_UpdatesMetrics(t *testing.T) {
// Set up database manually (can't use testingutil due to import cycle)
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
// Create and open litestream DB
db := NewDB(dbPath)
db.MonitorInterval = 0 // disable background goroutine
db.Replica = NewReplica(db)
db.Replica.Client = &testReplicaClient{dir: t.TempDir()}
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() {
if err := db.Close(context.Background()); err != nil {
t.Fatal(err)
}
}()
// Open SQL connection
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`PRAGMA journal_mode = wal;`); err != nil {
t.Fatal(err)
}
// Insert data to create DB and WAL content
if _, err := sqldb.Exec(`CREATE TABLE t (id INT, data TEXT)`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`INSERT INTO t VALUES (1, 'test data')`); err != nil {
t.Fatal(err)
}
// Sync to trigger metric updates
if err := db.Sync(context.Background()); err != nil {
t.Fatal(err)
}
// Verify DB size metric matches actual file size
dbSizeMetric := dbSizeGaugeVec.WithLabelValues(db.Path())
dbSizeValue := testutil.ToFloat64(dbSizeMetric)
dbFileInfo, err := os.Stat(db.Path())
if err != nil {
t.Fatalf("failed to stat db file: %v", err)
}
if dbSizeValue != float64(dbFileInfo.Size()) {
t.Fatalf("litestream_db_size=%v, want %v", dbSizeValue, dbFileInfo.Size())
}
// Verify WAL size metric matches actual file size
walSizeMetric := walSizeGaugeVec.WithLabelValues(db.Path())
walSizeValue := testutil.ToFloat64(walSizeMetric)
walFileInfo, err := os.Stat(db.WALPath())
if err != nil {
t.Fatalf("failed to stat wal file: %v", err)
}
if walSizeValue != float64(walFileInfo.Size()) {
t.Fatalf("litestream_wal_size=%v, want %v", walSizeValue, walFileInfo.Size())
}
// Verify total WAL bytes counter was incremented
totalWALMetric := totalWALBytesCounterVec.WithLabelValues(db.Path())
totalWALValue := testutil.ToFloat64(totalWALMetric)
if totalWALValue <= 0 {
t.Fatalf("litestream_total_wal_bytes=%v, want > 0", totalWALValue)
}
// Verify txid metric was updated (should be > 0 after writes)
txidMetric := txIDIndexGaugeVec.WithLabelValues(db.Path())
txidValue := testutil.ToFloat64(txidMetric)
if txidValue <= 0 {
t.Fatalf("litestream_txid=%v, want > 0", txidValue)
}
// Verify sync count was incremented
syncCountMetric := syncNCounterVec.WithLabelValues(db.Path())
syncCountValue := testutil.ToFloat64(syncCountMetric)
if syncCountValue <= 0 {
t.Fatalf("litestream_sync_count=%v, want > 0", syncCountValue)
}
// Verify sync seconds was recorded
syncSecondsMetric := syncSecondsCounterVec.WithLabelValues(db.Path())
syncSecondsValue := testutil.ToFloat64(syncSecondsMetric)
if syncSecondsValue <= 0 {
t.Fatalf("litestream_sync_seconds=%v, want > 0", syncSecondsValue)
}
}
// TestDB_Checkpoint_UpdatesMetrics verifies that checkpoint metrics are updated.
func TestDB_Checkpoint_UpdatesMetrics(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
db := NewDB(dbPath)
db.MonitorInterval = 0
db.Replica = NewReplica(db)
db.Replica.Client = &testReplicaClient{dir: t.TempDir()}
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() {
if err := db.Close(context.Background()); err != nil {
t.Fatal(err)
}
}()
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`PRAGMA journal_mode = wal;`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`CREATE TABLE t (id INT, data TEXT)`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`INSERT INTO t VALUES (1, 'test data')`); err != nil {
t.Fatal(err)
}
// Sync first to initialize database state
if err := db.Sync(context.Background()); err != nil {
t.Fatal(err)
}
// Get baseline checkpoint metrics
baselineCount := testutil.ToFloat64(checkpointNCounterVec.WithLabelValues(db.Path(), "PASSIVE"))
baselineSeconds := testutil.ToFloat64(checkpointSecondsCounterVec.WithLabelValues(db.Path(), "PASSIVE"))
// Force checkpoint
if err := db.Checkpoint(context.Background(), "PASSIVE"); err != nil {
t.Fatal(err)
}
// Verify checkpoint_count was incremented
checkpointCountMetric := checkpointNCounterVec.WithLabelValues(db.Path(), "PASSIVE")
checkpointCountValue := testutil.ToFloat64(checkpointCountMetric)
if checkpointCountValue <= baselineCount {
t.Fatalf("litestream_checkpoint_count=%v, want > %v", checkpointCountValue, baselineCount)
}
// Verify checkpoint_seconds was recorded
checkpointSecondsMetric := checkpointSecondsCounterVec.WithLabelValues(db.Path(), "PASSIVE")
checkpointSecondsValue := testutil.ToFloat64(checkpointSecondsMetric)
if checkpointSecondsValue <= baselineSeconds {
t.Fatalf("litestream_checkpoint_seconds=%v, want > %v", checkpointSecondsValue, baselineSeconds)
}
}
// TestDB_ReplicaSync_OperationMetrics verifies that replica operation metrics
// (PUT total and bytes) are incremented when Replica.Sync() uploads LTX files.
func TestDB_ReplicaSync_OperationMetrics(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
db := NewDB(dbPath)
db.MonitorInterval = 0
db.Replica = NewReplica(db)
db.Replica.Client = &testReplicaClient{dir: t.TempDir()}
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() {
if err := db.Close(context.Background()); err != nil {
t.Fatal(err)
}
}()
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`PRAGMA journal_mode = wal`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`CREATE TABLE t (id INT, data TEXT)`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`INSERT INTO t VALUES (1, 'test data')`); err != nil {
t.Fatal(err)
}
if err := db.Sync(context.Background()); err != nil {
t.Fatal(err)
}
baselinePutTotal := testutil.ToFloat64(
internal.OperationTotalCounterVec.WithLabelValues("test", "PUT"))
baselinePutBytes := testutil.ToFloat64(
internal.OperationBytesCounterVec.WithLabelValues("test", "PUT"))
if err := db.Replica.Sync(context.Background()); err != nil {
t.Fatal(err)
}
putTotal := testutil.ToFloat64(
internal.OperationTotalCounterVec.WithLabelValues("test", "PUT"))
putBytes := testutil.ToFloat64(
internal.OperationBytesCounterVec.WithLabelValues("test", "PUT"))
if putTotal <= baselinePutTotal {
t.Fatalf("litestream_replica_operation_total[test,PUT]=%v, want > %v", putTotal, baselinePutTotal)
}
if putBytes <= baselinePutBytes {
t.Fatalf("litestream_replica_operation_bytes[test,PUT]=%v, want > %v", putBytes, baselinePutBytes)
}
}
// TestDB_Sync_ErrorMetrics verifies that sync error counter is incremented on failure.
func TestDB_Sync_ErrorMetrics(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
workingClient := &testReplicaClient{dir: t.TempDir()}
db := NewDB(dbPath)
db.MonitorInterval = 0
db.Replica = NewReplica(db)
db.Replica.Client = workingClient
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() { _ = db.Close(context.Background()) }()
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`CREATE TABLE t (id INT, data TEXT)`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`INSERT INTO t VALUES (1, 'test data')`); err != nil {
t.Fatal(err)
}
if err := db.Sync(context.Background()); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`INSERT INTO t VALUES (2, 'more data')`); err != nil {
t.Fatal(err)
}
baselineErrors := testutil.ToFloat64(syncErrorNCounterVec.WithLabelValues(db.Path()))
if err := os.Remove(db.WALPath()); err != nil {
t.Fatal(err)
}
if err := db.Sync(context.Background()); err == nil {
t.Fatal("expected error from sync with missing WAL")
}
syncErrorValue := testutil.ToFloat64(syncErrorNCounterVec.WithLabelValues(db.Path()))
if syncErrorValue <= baselineErrors {
t.Fatalf("litestream_sync_error_count=%v, want > %v", syncErrorValue, baselineErrors)
}
}
// TestDB_Checkpoint_ErrorMetrics verifies that checkpoint error counter is incremented on failure.
func TestDB_Checkpoint_ErrorMetrics(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
db := NewDB(dbPath)
db.MonitorInterval = 0
db.Replica = NewReplica(db)
db.Replica.Client = &testReplicaClient{dir: t.TempDir()}
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() { _ = db.Close(context.Background()) }()
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`CREATE TABLE t (id INT, data TEXT)`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`INSERT INTO t VALUES (1, 'test data')`); err != nil {
t.Fatal(err)
}
if err := db.Sync(context.Background()); err != nil {
t.Fatal(err)
}
baselineErrors := testutil.ToFloat64(checkpointErrorNCounterVec.WithLabelValues(db.Path(), "PASSIVE"))
db.db.Close()
if err := db.execCheckpoint(context.Background(), "PASSIVE"); err == nil {
t.Fatal("expected error from checkpoint with closed db")
}
checkpointErrorValue := testutil.ToFloat64(checkpointErrorNCounterVec.WithLabelValues(db.Path(), "PASSIVE"))
if checkpointErrorValue <= baselineErrors {
t.Fatalf("litestream_checkpoint_error_count=%v, want > %v", checkpointErrorValue, baselineErrors)
}
}
// TestDB_L0RetentionMetrics verifies that L0 retention gauges are set during enforcement.
func TestDB_L0RetentionMetrics(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
client := &testReplicaClient{dir: t.TempDir()}
db := NewDB(dbPath)
db.MonitorInterval = 0
db.L0Retention = 1 * time.Nanosecond
db.Replica = NewReplica(db)
db.Replica.Client = client
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() { _ = db.Close(context.Background()) }()
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`CREATE TABLE t (id INT, data TEXT)`); err != nil {
t.Fatal(err)
}
for i := range 3 {
if _, err := sqldb.Exec(`INSERT INTO t VALUES (?, 'data')`, i); err != nil {
t.Fatal(err)
}
if err := db.Sync(context.Background()); err != nil {
t.Fatal(err)
}
if err := db.Replica.Sync(context.Background()); err != nil {
t.Fatal(err)
}
}
compactor := NewCompactor(client, slog.Default())
if _, err := compactor.Compact(context.Background(), 1); err != nil {
t.Fatal(err)
}
dbName := filepath.Base(db.Path())
if err := db.EnforceL0RetentionByTime(context.Background()); err != nil {
t.Fatal(err)
}
eligible := testutil.ToFloat64(internal.L0RetentionGaugeVec.WithLabelValues(dbName, "eligible"))
notCompacted := testutil.ToFloat64(internal.L0RetentionGaugeVec.WithLabelValues(dbName, "not_compacted"))
tooRecent := testutil.ToFloat64(internal.L0RetentionGaugeVec.WithLabelValues(dbName, "too_recent"))
if eligible+notCompacted+tooRecent == 0 {
t.Fatalf("expected at least one L0 retention gauge > 0, got eligible=%v not_compacted=%v too_recent=%v",
eligible, notCompacted, tooRecent)
}
}
// TestDB_Verify_WALOffsetAtHeader tests that verify() handles the edge case where
// an LTX file has WALOffset=WALHeaderSize and WALSize=0, which means we're at the
// beginning of the WAL with no frames written yet.
// Regression test for issue #900: prev WAL offset is less than the header size: -4088
func TestDB_Verify_WALOffsetAtHeader(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
db := NewDB(dbPath)
db.MonitorInterval = 0
db.Replica = NewReplica(db)
db.Replica.Client = &testReplicaClient{dir: t.TempDir()}
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() {
if err := db.Close(context.Background()); err != nil {
t.Fatal(err)
}
}()
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`PRAGMA journal_mode = wal;`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`CREATE TABLE t (id INT)`); err != nil {
t.Fatal(err)
}
// Perform initial sync to set up page size and initial state
if err := db.Sync(context.Background()); err != nil {
t.Fatal(err)
}
// Read the WAL header to get current salt values
walHdr, err := readWALHeader(db.WALPath())
if err != nil {
t.Fatal(err)
}
salt1 := binary.BigEndian.Uint32(walHdr[16:])
salt2 := binary.BigEndian.Uint32(walHdr[20:])
// Create an LTX file with WALOffset=WALHeaderSize (32) and WALSize=0
// This simulates the condition in issue #900
ltxDir := db.LTXLevelDir(0)
if err := os.MkdirAll(ltxDir, 0o755); err != nil {
t.Fatal(err)
}
// Get current position to determine next TXID
pos, err := db.Pos()
if err != nil {
t.Fatal(err)
}
nextTXID := pos.TXID + 1
ltxPath := db.LTXPath(0, nextTXID, nextTXID)
f, err := os.Create(ltxPath)
if err != nil {
t.Fatal(err)
}
enc, err := ltx.NewEncoder(f)
if err != nil {
f.Close()
t.Fatal(err)
}
// Create header with WALOffset=32 (WALHeaderSize) and WALSize=0
hdr := ltx.Header{
Version: ltx.Version,
Flags: ltx.HeaderFlagNoChecksum,
PageSize: uint32(db.pageSize),
Commit: 2,
MinTXID: nextTXID,
MaxTXID: nextTXID,
Timestamp: 1000000,
WALOffset: WALHeaderSize, // 32 - at start of WAL
WALSize: 0, // No WAL data - this triggers the bug
WALSalt1: salt1,
WALSalt2: salt2,
}
if err := enc.EncodeHeader(hdr); err != nil {
f.Close()
t.Fatal(err)
}
if err := enc.Close(); err != nil {
f.Close()
t.Fatal(err)
}
if err := f.Close(); err != nil {
t.Fatal(err)
}
// Now call verify - before the fix, this would fail with:
// "prev WAL offset is less than the header size: -4088"
info, err := db.verify(context.Background())
if err != nil {
t.Fatalf("verify() returned error: %v", err)
}
// Verify the returned info is sensible
if info.offset != WALHeaderSize {
t.Errorf("expected offset=%d, got %d", WALHeaderSize, info.offset)
}
// Salt matches, so snapshotting should be false
if info.snapshotting {
t.Errorf("expected snapshotting=false when salt matches, got true")
}
}
// TestDB_Verify_WALOffsetAtHeader_SaltMismatch tests that verify() correctly
// triggers a snapshot when WALOffset=WALHeaderSize, WALSize=0, and the salt
// values don't match the current WAL header.
// Companion test to TestDB_Verify_WALOffsetAtHeader for full branch coverage.
func TestDB_Verify_WALOffsetAtHeader_SaltMismatch(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
db := NewDB(dbPath)
db.MonitorInterval = 0
db.Replica = NewReplica(db)
db.Replica.Client = &testReplicaClient{dir: t.TempDir()}
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() {
if err := db.Close(context.Background()); err != nil {
t.Fatal(err)
}
}()
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`PRAGMA journal_mode = wal;`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`CREATE TABLE t (id INT)`); err != nil {
t.Fatal(err)
}
// Perform initial sync to set up page size and initial state
if err := db.Sync(context.Background()); err != nil {
t.Fatal(err)
}
// Read the WAL header to get current salt values
walHdr, err := readWALHeader(db.WALPath())
if err != nil {
t.Fatal(err)
}
salt1 := binary.BigEndian.Uint32(walHdr[16:])
salt2 := binary.BigEndian.Uint32(walHdr[20:])
// Create an LTX file with WALOffset=WALHeaderSize (32) and WALSize=0
// but with DIFFERENT salt values to simulate a salt reset
ltxDir := db.LTXLevelDir(0)
if err := os.MkdirAll(ltxDir, 0o755); err != nil {
t.Fatal(err)
}
// Get current position to determine next TXID
pos, err := db.Pos()
if err != nil {
t.Fatal(err)
}
nextTXID := pos.TXID + 1
ltxPath := db.LTXPath(0, nextTXID, nextTXID)
f, err := os.Create(ltxPath)
if err != nil {
t.Fatal(err)
}
enc, err := ltx.NewEncoder(f)
if err != nil {
f.Close()
t.Fatal(err)
}
// Create header with WALOffset=32 (WALHeaderSize) and WALSize=0
// Use different salt values to trigger salt mismatch branch
hdr := ltx.Header{
Version: ltx.Version,
Flags: ltx.HeaderFlagNoChecksum,
PageSize: uint32(db.pageSize),
Commit: 2,
MinTXID: nextTXID,
MaxTXID: nextTXID,
Timestamp: 1000000,
WALOffset: WALHeaderSize, // 32 - at start of WAL
WALSize: 0, // No WAL data
WALSalt1: salt1 + 1, // Different salt to trigger mismatch
WALSalt2: salt2 + 1, // Different salt to trigger mismatch
}
if err := enc.EncodeHeader(hdr); err != nil {
f.Close()
t.Fatal(err)
}
if err := enc.Close(); err != nil {
f.Close()
t.Fatal(err)
}
if err := f.Close(); err != nil {
t.Fatal(err)
}
// Call verify - should succeed but indicate snapshotting due to salt mismatch
info, err := db.verify(context.Background())
if err != nil {
t.Fatalf("verify() returned error: %v", err)
}
// Verify the returned info indicates snapshotting due to salt reset
if info.offset != WALHeaderSize {
t.Errorf("expected offset=%d, got %d", WALHeaderSize, info.offset)
}
if !info.snapshotting {
t.Errorf("expected snapshotting=true when salt mismatches, got false")
}
if info.reason != "wal header salt reset, snapshotting" {
t.Errorf("expected reason='wal header salt reset, snapshotting', got %q", info.reason)
}
}
// TestDB_releaseReadLock_DoubleRollback verifies that calling releaseReadLock()
// after the read transaction has already been rolled back does not return an error.
// This can happen during shutdown when concurrent checkpoint and close operations
// both attempt to release the read lock.
// Regression test for issue #934.
func TestDB_releaseReadLock_DoubleRollback(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
db := NewDB(dbPath)
db.MonitorInterval = 0
db.Replica = NewReplica(db)
db.Replica.Client = &testReplicaClient{dir: t.TempDir()}
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
// Open SQL connection to create a WAL database
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`PRAGMA journal_mode = wal;`); err != nil {
t.Fatal(err)
}
if _, err := sqldb.Exec(`CREATE TABLE t (id INT)`); err != nil {
t.Fatal(err)
}
// Sync to initialize the database and acquire read lock
if err := db.Sync(context.Background()); err != nil {
t.Fatal(err)
}
// Verify read transaction exists
if db.rtx == nil {
t.Fatal("expected read transaction to exist after Sync")
}
// First rollback - simulates what happens in execCheckpoint()
if err := db.rtx.Rollback(); err != nil {
t.Fatalf("first rollback failed: %v", err)
}
// Second call to releaseReadLock() - simulates what happens in Close()
// This should NOT return an error even though the transaction is already rolled back.
// Before the fix, this would return "sql: transaction has already been committed or rolled back"
if err := db.releaseReadLock(); err != nil {
t.Fatalf("releaseReadLock() returned error after double rollback: %v", err)
}
// Clean up - set rtx to nil since we manually rolled it back
db.rtx = nil
// Close should work without error
if err := db.Close(context.Background()); err != nil {
t.Fatalf("Close() failed: %v", err)
}
}
// TestDB_CheckpointDoesNotTriggerSnapshot verifies that a checkpoint
// followed by a sync does not trigger an unnecessary full snapshot.
// This is a regression test for issue #927 (runaway disk usage).
//
// The bug: After checkpoint truncates WAL, verify() sees old LTX position
// is beyond new WAL size and triggers snapshotting=true unnecessarily.
func TestDB_CheckpointDoesNotTriggerSnapshot(t *testing.T) {
t.Run("TruncateMode", func(t *testing.T) {
testCheckpointSnapshot(t, CheckpointModeTruncate)
})
t.Run("PassiveMode", func(t *testing.T) {
testCheckpointSnapshot(t, CheckpointModePassive)
})
}
func testCheckpointSnapshot(t *testing.T, mode string) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
db := NewDB(dbPath)
db.MonitorInterval = 0 // Disable background monitor
db.CheckpointInterval = 0 // Disable time-based checkpoints
db.Replica = NewReplica(db)
db.Replica.Client = &testReplicaClient{dir: t.TempDir()}
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() {
if err := db.Close(context.Background()); err != nil {
t.Fatal(err)
}
}()
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)
}
defer sqldb.Close()
if _, err := sqldb.Exec(`PRAGMA journal_mode = wal;`); err != nil {
t.Fatal(err)
}
// Create initial data
if _, err := sqldb.Exec(`CREATE TABLE t (id INT, data TEXT)`); err != nil {
t.Fatal(err)
}
// Insert enough data to have a meaningful WAL
for i := 0; i < 100; i++ {
data := fmt.Sprintf("test data padding row %d with extra content", i)
if _, err := sqldb.Exec(`INSERT INTO t VALUES (?, ?)`, i, data); err != nil {
t.Fatal(err)
}
}
ctx := context.Background()
// Perform initial sync
if err := db.Sync(ctx); err != nil {
t.Fatal(err)
}
pos1, _ := db.Pos()
t.Logf("After initial sync: TXID=%d", pos1.TXID)
// Make a change and sync to establish "normal" state
if _, err := sqldb.Exec(`INSERT INTO t VALUES (9999, 'before checkpoint')`); err != nil {
t.Fatal(err)
}
if err := db.Sync(ctx); err != nil {
t.Fatal(err)
}
pos2, _ := db.Pos()
t.Logf("After pre-checkpoint sync: TXID=%d", pos2.TXID)
// Call verify() BEFORE checkpoint to confirm snapshotting=false
info1, err := db.verify(ctx)
if err != nil {
t.Fatal(err)
}
t.Logf("Before checkpoint: verify() snapshotting=%v reason=%q", info1.snapshotting, info1.reason)
// Perform checkpoint - this may restart the WAL with new salt
if err := db.Checkpoint(ctx, mode); err != nil {
t.Fatal(err)
}
t.Logf("Checkpoint mode=%s completed", mode)
posAfterChk, _ := db.Pos()
t.Logf("After checkpoint: TXID=%d", posAfterChk.TXID)
// Make a small change to create some WAL data
if _, err := sqldb.Exec(`INSERT INTO t VALUES (10000, 'after checkpoint')`); err != nil {
t.Fatal(err)
}
// Call verify() AFTER checkpoint - THIS IS THE BUG CHECK
// With the bug, snapshotting=true because verify() sees:
// - Old LTX has WALOffset+WALSize pointing to old (larger) WAL
// - New WAL is truncated (smaller)
// - Line 973: info.offset > fi.Size() → "wal truncated" → snapshotting=true
info2, err := db.verify(ctx)
if err != nil {
t.Fatal(err)
}
t.Logf("After checkpoint: verify() snapshotting=%v reason=%q", info2.snapshotting, info2.reason)
// The key assertion: after OUR checkpoint (not external process),
// we should NOT require a full snapshot.
if info2.snapshotting {
t.Errorf("verify() returned snapshotting=true after checkpoint, reason=%q. "+
"This is the bug: checkpoint followed by sync should NOT require full snapshot.",
info2.reason)
}
}
// TestDB_MultipleCheckpointsWithWrites tests that multiple checkpoint cycles
// don't trigger excessive snapshots. This simulates the scenario from issue #927
// where users reported 5GB snapshots every 3-4 minutes.
func TestDB_MultipleCheckpointsWithWrites(t *testing.T) {
dir := t.TempDir()
dbPath := filepath.Join(dir, "db")
db := NewDB(dbPath)
db.MonitorInterval = 0
db.CheckpointInterval = 0
db.Replica = NewReplica(db)
db.Replica.Client = &testReplicaClient{dir: t.TempDir()}
db.Replica.MonitorEnabled = false
if err := db.Open(); err != nil {
t.Fatal(err)
}
defer func() {
if err := db.Close(context.Background()); err != nil {
t.Fatal(err)
}
}()
sqldb, err := sql.Open("sqlite", dbPath)
if err != nil {
t.Fatal(err)