-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwriter_test.go
More file actions
910 lines (750 loc) · 23.7 KB
/
writer_test.go
File metadata and controls
910 lines (750 loc) · 23.7 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
package ethwal
import (
"context"
"fmt"
"io"
"os"
"path"
"strings"
"sync"
"testing"
"github.com/0xsequence/ethkit/go-ethereum/common"
"github.com/0xsequence/ethwal/storage"
"github.com/0xsequence/ethwal/storage/local"
gostorage "github.com/Shopify/go-storage"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestWriter_Write(t *testing.T) {
blocksFile := Blocks[int]{
{
Hash: common.BytesToHash([]byte{0x01}),
Number: 1,
TS: 0,
Data: 0,
},
{
Hash: common.BytesToHash([]byte{0x02}),
Number: 2,
TS: 0,
Data: 0,
},
{
Hash: common.BytesToHash([]byte{0x03}),
Number: 3,
TS: 0,
Data: 0,
},
{
Hash: common.BytesToHash([]byte{0x04}),
Number: 4,
TS: 0,
Data: 0,
},
}
testCase := []struct {
name string
options Options
}{
{
name: "json",
options: Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewJSONEncoder,
NewDecoder: NewJSONDecoder,
},
},
{
name: "json-zstd",
options: Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewJSONEncoder,
NewDecoder: NewJSONDecoder,
NewCompressor: NewZSTDCompressor,
NewDecompressor: NewZSTDDecompressor,
},
},
{
name: "cbor",
options: Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewCBOREncoder,
NewDecoder: NewCBORDecoder,
},
},
{
name: "cbor-zstd",
options: Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewCBOREncoder,
NewDecoder: NewCBORDecoder,
NewCompressor: NewZSTDCompressor,
NewDecompressor: NewZSTDDecompressor,
},
},
}
for _, tc := range testCase {
t.Run(tc.name, func(t *testing.T) {
defer testTeardown(t)
tc.options = tc.options.WithDefaults()
w, err := NewWriter[int](tc.options)
require.NoError(t, err)
for _, block := range blocksFile {
err := w.Write(context.Background(), block)
require.NoError(t, err)
}
// flush the in-memory buffer to disk
w_, ok := w.(*writer[int])
require.True(t, ok)
err = w_.rollFile(context.Background())
require.NoError(t, err)
err = w.Close(context.Background())
require.NoError(t, err)
// check WAL files
filePath := path.Join(buildETHWALPath(tc.options.Dataset.Name, tc.options.Dataset.Version, tc.options.Dataset.Path), (&File{FirstBlockNum: 1, LastBlockNum: 4}).Path())
_, err = os.Stat(filePath)
require.NoError(t, err)
f, err := os.Open(filePath)
require.NoError(t, err)
var r io.ReadCloser = f
if tc.options.NewDecompressor != nil {
r = tc.options.NewDecompressor(r)
}
var dec = tc.options.NewDecoder(r)
var blocks Blocks[int]
for {
var block Block[int]
err := dec.Decode(&block)
if err != nil {
break
}
blocks = append(blocks, block)
}
require.Equal(t, blocksFile, blocks)
})
}
}
func TestWriter_Continue(t *testing.T) {
defer testTeardown(t)
// 1st writer
w, err := NewWriter[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
})
require.NoError(t, err)
err = w.Write(context.Background(), Block[int]{Number: 1})
require.NoError(t, err)
// flush the in-memory buffer to disk
w_, ok := w.(*writer[int])
require.True(t, ok)
err = w_.rollFile(context.Background())
require.NoError(t, err)
err = w.Close(context.Background())
require.NoError(t, err)
// 2nd writer
w, err = NewWriter[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
})
require.NoError(t, err)
assert.Equal(t, uint64(1), w.BlockNum())
err = w.Write(context.Background(), Block[int]{Number: 2})
require.NoError(t, err)
assert.Equal(t, uint64(2), w.BlockNum())
err = w.Close(context.Background())
require.NoError(t, err)
}
func TestNoGapWriter_BlockNum(t *testing.T) {
defer testTeardown(t)
w, err := NewWriter[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewJSONEncoder,
})
require.NoError(t, err)
ngw := NewWriterNoGap[int](w)
require.NotNil(t, w)
err = ngw.Write(context.Background(), Block[int]{Number: 1})
require.NoError(t, err)
err = ngw.Write(context.Background(), Block[int]{Number: 2})
require.NoError(t, err)
err = ngw.Write(context.Background(), Block[int]{Number: 3})
require.NoError(t, err)
err = ngw.Close(context.Background())
require.NoError(t, err)
require.Equal(t, uint64(3), w.BlockNum())
}
func TestNoGapWriter_FileRollOnClose(t *testing.T) {
defer testTeardown(t)
opt := Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewJSONEncoder,
FileRollOnClose: true,
}
w, err := NewWriter[int](opt)
require.NoError(t, err)
ngw := NewWriterNoGap[int](w)
require.NotNil(t, w)
err = ngw.Write(context.Background(), Block[int]{Number: 1})
require.NoError(t, err)
err = ngw.Write(context.Background(), Block[int]{Number: 2})
require.NoError(t, err)
err = ngw.Write(context.Background(), Block[int]{Number: 3})
require.NoError(t, err)
err = ngw.Close(context.Background())
require.NoError(t, err)
require.Equal(t, uint64(3), w.BlockNum())
// check WAL files
filePath := path.Join(buildETHWALPath(opt.Dataset.Name, opt.Dataset.Version, opt.Dataset.Path), (&File{FirstBlockNum: 1, LastBlockNum: 3}).Path())
_, err = os.Stat(filePath)
require.NoError(t, err)
}
func Test_WriterStoragePathSuffix(t *testing.T) {
defer testTeardown(t)
options := Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
}
w, err := NewWriter[int](options)
require.NoError(t, err)
writer, ok := w.(*writer[int])
require.True(t, ok)
require.Equal(t, string(writer.path[len(writer.path)-1]), string(os.PathSeparator))
}
func Test_WriterFileIndexAhead(t *testing.T) {
testSetup(t, NewCBOREncoder, nil)
defer testTeardown(t)
fs := local.NewLocalFS(path.Join(testPath, "int-wal", defaultDatasetVersion))
files, err := ListFiles(context.Background(), fs)
require.NoError(t, err)
fi := NewFileIndexFromFiles(fs, files)
require.NotNil(t, fi)
err = fi.AddFile(&File{
FirstBlockNum: 13,
LastBlockNum: 14,
})
require.Nil(t, err)
err = fi.Save(context.Background())
require.Nil(t, err)
// test
w, err := NewWriter[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
})
defer w.Close(context.Background())
require.NoError(t, err)
assert.Equal(t, uint64(12), w.BlockNum())
}
func Test_WriterFileIndexBehind(t *testing.T) {
testSetup(t, NewCBOREncoder, nil)
defer testTeardown(t)
fs := local.NewLocalFS(path.Join(testPath, "int-wal", defaultDatasetVersion))
files, err := ListFiles(context.Background(), fs)
require.NoError(t, err)
fi := NewFileIndexFromFiles(fs, files)
require.NotNil(t, fi)
fi.files = fi.files[:len(fi.files)-1]
err = fi.Save(context.Background())
require.Nil(t, err)
// test
w, err := NewWriter[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
})
defer w.Close(context.Background())
require.NoError(t, err)
assert.Equal(t, uint64(8), w.BlockNum())
err = w.Write(context.Background(), Block[int]{Number: 11, Data: 0x0123})
require.NoError(t, err)
assert.Equal(t, uint64(11), w.BlockNum())
err = w.Write(context.Background(), Block[int]{Number: 12, Data: 0x1234})
require.NoError(t, err)
assert.Equal(t, uint64(12), w.BlockNum())
err = w.RollFile(context.Background())
require.NoError(t, err)
rdr, err := NewReader[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
})
defer rdr.Close()
require.NoError(t, err)
err = rdr.Seek(context.Background(), 11)
require.NoError(t, err)
b11, err := rdr.Read(context.Background())
require.NoError(t, err)
assert.Equal(t, uint64(11), b11.Number)
assert.Equal(t, 0x0123, b11.Data)
b12, err := rdr.Read(context.Background())
require.NoError(t, err)
assert.Equal(t, uint64(12), b12.Number)
assert.Equal(t, 0x1234, b12.Data)
}
// Test_WriterFileIndexSavedButFileNotWritten tests the scenario where the FileIndex is saved
// but the actual data file is not written (e.g., due to a crash between FileIndex.Save() and
// the file write completing). This can happen because in writer.writeFile(), the FileIndex is
// saved before the actual file is written.
//
// The test verifies that when a Writer is restarted after such a failure, it correctly:
// 1. Detects that the last file in the index doesn't exist on disk
// 2. Removes that entry from the FileIndex (via the logic in common.go FileIndex.readFiles())
// 3. Starts writing from the correct block number (last valid block, not the phantom file's block)
func Test_WriterFileIndexSavedButFileNotWritten(t *testing.T) {
defer testTeardown(t)
// Setup: Write some initial blocks and roll the file
w, err := NewWriter[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
FileRollOnClose: true,
})
require.NoError(t, err)
// Write blocks 1-4
for i := uint64(1); i <= 4; i++ {
err = w.Write(context.Background(), Block[int]{Number: i, Data: int(i * 100)})
require.NoError(t, err)
}
// Roll the file to persist blocks 1-4
w_, ok := w.(*writer[int])
require.True(t, ok)
err = w_.rollFile(context.Background())
require.NoError(t, err)
// Write blocks 5-8
for i := uint64(5); i <= 8; i++ {
err = w.Write(context.Background(), Block[int]{Number: i, Data: int(i * 100)})
require.NoError(t, err)
}
// Close will roll the file for blocks 5-8 because FileRollOnClose=true
err = w.Close(context.Background())
require.NoError(t, err)
// Simulate scenario where FileIndex is saved but file is NOT written:
// Manually add a file entry to FileIndex without creating the actual file
fs := local.NewLocalFS(path.Join(testPath, "int-wal", defaultDatasetVersion))
fileIndex := NewFileIndex(fs)
err = fileIndex.Load(context.Background())
require.NoError(t, err)
// Add a phantom file entry (blocks 9-12) that doesn't exist on disk
phantomFile := &File{
FirstBlockNum: 9,
LastBlockNum: 12,
}
err = fileIndex.AddFile(phantomFile)
require.NoError(t, err)
// Save the FileIndex with the phantom entry
err = fileIndex.Save(context.Background())
require.NoError(t, err)
// Verify that the phantom file doesn't actually exist
require.False(t, phantomFile.Exist(context.Background(), fs))
// Now create a new Writer - it should detect that the last file doesn't exist
// and start from the correct position (block 8, the last valid block)
w2, err := NewWriter[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
})
require.NoError(t, err)
// The Writer should have corrected its position to block 8 (last valid block)
// because the phantom file (9-12) doesn't exist
assert.Equal(t, uint64(8), w2.BlockNum(), "Writer should start from last valid block (8), not from phantom file (12)")
// Write the next block (9) - this should succeed
err = w2.Write(context.Background(), Block[int]{Number: 9, Data: 900})
require.NoError(t, err)
assert.Equal(t, uint64(9), w2.BlockNum())
// Write more blocks
err = w2.Write(context.Background(), Block[int]{Number: 10, Data: 1000})
require.NoError(t, err)
assert.Equal(t, uint64(10), w2.BlockNum())
// Roll and close
w2_, ok := w2.(*writer[int])
require.True(t, ok)
err = w2_.rollFile(context.Background())
require.NoError(t, err)
err = w2.Close(context.Background())
require.NoError(t, err)
// Verify we can read all blocks correctly
rdr, err := NewReader[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
})
require.NoError(t, err)
defer rdr.Close()
// Read blocks 1-10 and verify they are correct
err = rdr.Seek(context.Background(), 1)
require.NoError(t, err)
for i := uint64(1); i <= 10; i++ {
blk, err := rdr.Read(context.Background())
require.NoError(t, err)
assert.Equal(t, i, blk.Number)
assert.Equal(t, int(i*100), blk.Data)
}
}
// TestWriter_RecoverFromWriteFileError tests that the Writer can recover from an error
// in writeFile. This simulates a scenario where writeFile fails during file creation
// (after FileIndex is saved but before the actual file is written), and then the
// application is restarted. The new Writer should detect the inconsistency and recover.
func TestWriter_RecoverFromWriteFileError(t *testing.T) {
defer testTeardown(t)
// Create the directory structure first
walDir := path.Join(testPath, "int-wal", defaultDatasetVersion)
err := os.MkdirAll(walDir, 0755)
require.NoError(t, err)
// Create a failing filesystem that will fail on the first Create call
failingFS := &failOnceFS{
FS: local.NewLocalFS(""),
failOnCount: 1,
}
options := Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
FileSystem: failingFS,
}
// Phase 1: Write blocks and encounter a failure during rollFile
w, err := NewWriter[int](options)
require.NoError(t, err)
// Write some blocks
err = w.Write(context.Background(), Block[int]{Number: 1, Data: 100})
require.NoError(t, err)
err = w.Write(context.Background(), Block[int]{Number: 2, Data: 200})
require.NoError(t, err)
// Try to roll the file - this should fail because of the failing FS
// Note: This will partially complete writeFile (FileIndex is saved, but file creation fails)
w_, ok := w.(*writer[int])
require.True(t, ok)
err = w_.rollFile(context.Background())
require.Error(t, err, "Expected error from writeFile due to failing filesystem")
require.Contains(t, err.Error(), "injected error")
// Verify the writer still has the blocks in memory
assert.Equal(t, uint64(2), w.BlockNum())
// Close the writer (simulating application shutdown after error)
// Don't check for error here as the state might be inconsistent
_ = w.Close(context.Background())
// Phase 2: Create a new Writer (simulating application restart)
// The filesystem now works (failOnCount has been exhausted)
// The new Writer should detect that the FileIndex references a non-existent file
// and recover by removing that entry from the index
w2, err := NewWriter[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
FileSystem: failingFS, // Same filesystem, but now it won't fail
})
require.NoError(t, err, "New Writer should recover from the inconsistent state")
// The Writer should have recovered to block 0 (since no files were successfully written)
assert.Equal(t, uint64(0), w2.BlockNum())
// Phase 3: Write new blocks and verify everything works
err = w2.Write(context.Background(), Block[int]{Number: 1, Data: 100})
require.NoError(t, err)
err = w2.Write(context.Background(), Block[int]{Number: 2, Data: 200})
require.NoError(t, err)
err = w2.Write(context.Background(), Block[int]{Number: 3, Data: 300})
require.NoError(t, err)
err = w2.Write(context.Background(), Block[int]{Number: 4, Data: 400})
require.NoError(t, err)
// Roll and close successfully
w2_, ok := w2.(*writer[int])
require.True(t, ok)
err = w2_.rollFile(context.Background())
require.NoError(t, err, "Should successfully write file after recovery")
err = w2.Close(context.Background())
require.NoError(t, err)
// Phase 4: Verify we can read all the blocks that were successfully written
rdr, err := NewReader[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
})
require.NoError(t, err)
defer rdr.Close()
// Read blocks 1-4 and verify they are correct
err = rdr.Seek(context.Background(), 1)
require.NoError(t, err)
for i := uint64(1); i <= 4; i++ {
blk, err := rdr.Read(context.Background())
require.NoError(t, err)
assert.Equal(t, i, blk.Number)
assert.Equal(t, int(i*100), blk.Data)
}
}
// TestWriter_RecoverFromWriteError tests the new in-place recovery mechanism
// that was added to writeFile. When f.Write() fails (after FileIndex is saved),
// the Writer should roll back the FileIndex entry in memory and continue operating
// WITHOUT requiring an application restart.
func TestWriter_RecoverFromWriteError(t *testing.T) {
defer testTeardown(t)
// Create the directory structure first
walDir := path.Join(testPath, "int-wal", defaultDatasetVersion)
err := os.MkdirAll(walDir, 0755)
require.NoError(t, err)
// Create a filesystem that returns a failing WriteCloser on the first WAL file write
failingFS := &failOnWriteFS{
FS: local.NewLocalFS(""),
failOnCount: 1,
}
options := Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
FileSystem: failingFS,
}
w, err := NewWriter[int](options)
require.NoError(t, err)
// Write some blocks
err = w.Write(context.Background(), Block[int]{Number: 1, Data: 100})
require.NoError(t, err)
err = w.Write(context.Background(), Block[int]{Number: 2, Data: 200})
require.NoError(t, err)
w_, ok := w.(*writer[int])
require.True(t, ok)
// Try to roll the file - this should fail during f.Write()
// The recovery mechanism should roll back the FileIndex entry in memory
err = w_.rollFile(context.Background())
require.Error(t, err, "Expected error from f.Write() due to failing WriteCloser")
require.Contains(t, err.Error(), "write failed")
// Verify the writer state: blocks are still in buffer, lastBlockNum still reflects written blocks
assert.Equal(t, uint64(2), w.BlockNum())
// Check that the FileIndex was rolled back in memory
fileIndexFiles := w_.fileIndex.Files()
fileCountAfterRollback := len(fileIndexFiles)
t.Logf("FileIndex count after rollback: %d", fileCountAfterRollback)
// The rollback removes the last entry from memory.
// However, the FileIndex on disk still has the phantom entry.
// For in-memory recovery to work, we verify that the in-memory count decreased
// (or is at a safe state to continue)
// Verify the writer's internal state is still consistent
assert.Equal(t, uint64(1), w_.firstBlockNum, "firstBlockNum should not change after failed write")
// The key test: The rollback mechanism prevents corrupt data from being written
// After the failure, the FileIndex was rolled back in memory.
// Now we attempt to roll the file again to continue writing.
err = w_.rollFile(context.Background())
require.NoError(t, err, "Should be able to roll file after rollback")
// Write blocks 3-4
err = w.Write(context.Background(), Block[int]{Number: 3, Data: 300})
require.NoError(t, err)
err = w.Write(context.Background(), Block[int]{Number: 4, Data: 400})
require.NoError(t, err)
// Roll and close successfully
err = w_.rollFile(context.Background())
require.NoError(t, err)
// Verify the FileIndex now has one file with blocks 3-4
fileIndexFiles = w_.fileIndex.Files()
assert.Equal(t, fileCountAfterRollback+2, len(fileIndexFiles), "FileIndex should have one more file after successful write")
lastFile := fileIndexFiles[len(fileIndexFiles)-1]
assert.Equal(t, uint64(3), lastFile.FirstBlockNum)
assert.Equal(t, uint64(4), lastFile.LastBlockNum)
// Continue writing more blocks to demonstrate the writer is fully operational
err = w.Write(context.Background(), Block[int]{Number: 5, Data: 500})
require.NoError(t, err)
err = w.Write(context.Background(), Block[int]{Number: 6, Data: 600})
require.NoError(t, err)
// Roll and close successfully
err = w_.rollFile(context.Background())
require.NoError(t, err)
err = w.Close(context.Background())
require.NoError(t, err)
// Verify we can read the blocks that were successfully written
rdr, err := NewReader[int](Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
})
require.NoError(t, err)
defer rdr.Close()
// Read blocks 3-6 and verify they are correct
// (Blocks 1-2 were lost due to the write failure)
err = rdr.Seek(context.Background(), 3)
require.NoError(t, err)
expectedData := map[uint64]int{
3: 300, 4: 400, 5: 500, 6: 600,
}
for i := uint64(3); i <= 6; i++ {
blk, err := rdr.Read(context.Background())
require.NoError(t, err)
assert.Equal(t, i, blk.Number)
assert.Equal(t, expectedData[i], blk.Data)
}
}
// failOnceFS is a filesystem wrapper that fails on the Nth Create call
type failOnceFS struct {
storage.FS
failOnCount int
createCount int
mu sync.Mutex
}
func (f *failOnceFS) Create(ctx context.Context, path string, options *gostorage.WriterOptions) (io.WriteCloser, error) {
f.mu.Lock()
defer f.mu.Unlock()
f.createCount++
if f.createCount == f.failOnCount {
return nil, fmt.Errorf("injected error on Create call #%d for path: %s", f.createCount, path)
}
return f.FS.Create(ctx, path, options)
}
// failOnWriteFS is a filesystem wrapper that returns a failing WriteCloser for WAL files only
type failOnWriteFS struct {
storage.FS
failOnCount int
createCount int
mu sync.Mutex
}
func (f *failOnWriteFS) Create(ctx context.Context, path string, options *gostorage.WriterOptions) (io.WriteCloser, error) {
f.mu.Lock()
defer f.mu.Unlock()
wc, err := f.FS.Create(ctx, path, options)
if err != nil {
return nil, err
}
// Only fail on WAL files, not on FileIndex (which is named ".index")
// WAL files are stored as hex hashes in directory structure
if !strings.Contains(path, ".index") {
f.createCount++
if f.createCount == f.failOnCount {
// Return a WriteCloser that fails on Write
return &failingWriteCloser{WriteCloser: wc}, nil
}
}
return wc, nil
}
// failingWriteCloser wraps a WriteCloser and fails on the first Write call
type failingWriteCloser struct {
io.WriteCloser
}
func (f *failingWriteCloser) Write(p []byte) (n int, err error) {
// Close the underlying writer to clean up
_ = f.WriteCloser.Close()
return 0, fmt.Errorf("write failed: injected error")
}
func BenchmarkWriter_Write(b *testing.B) {
defer func() {
_ = os.RemoveAll(testPath)
}()
testCase := []struct {
name string
options Options
}{
{
name: "json",
options: Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewJSONEncoder,
NewDecoder: NewJSONDecoder,
},
},
{
name: "json-zstd",
options: Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewJSONEncoder,
NewDecoder: NewJSONDecoder,
NewCompressor: NewZSTDCompressor,
NewDecompressor: NewZSTDDecompressor,
},
},
{
name: "cbor",
options: Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewCBOREncoder,
NewDecoder: NewCBORDecoder,
},
},
{
name: "cbor-zstd",
options: Options{
Dataset: Dataset{
Name: "int-wal",
Path: testPath,
Version: defaultDatasetVersion,
},
NewEncoder: NewCBOREncoder,
NewDecoder: NewCBORDecoder,
NewCompressor: NewZSTDCompressor,
NewDecompressor: NewZSTDDecompressor,
},
},
}
for _, tc := range testCase {
b.Run(tc.name, func(b *testing.B) {
w, err := NewWriter[int](tc.options)
require.NoError(b, err)
b.ReportAllocs()
for i := 0; i < b.N; i++ {
for j := 0; j < 1000000; j++ {
err := w.Write(context.Background(), Block[int]{Number: uint64(i)})
require.NoError(b, err)
}
}
err = w.Close(context.Background())
require.NoError(b, err)
})
}
}