|
1 | 1 | package keeper |
2 | 2 |
|
3 | 3 | import ( |
| 4 | + "encoding/binary" |
4 | 5 | "encoding/json" |
| 6 | + "path/filepath" |
5 | 7 | "sync/atomic" |
6 | 8 | "testing" |
7 | 9 |
|
| 10 | + "github.com/cockroachdb/pebble/v2" |
8 | 11 | "github.com/ethereum/go-ethereum/common" |
9 | 12 | "github.com/stretchr/testify/require" |
10 | 13 | ) |
@@ -156,6 +159,121 @@ func TestTraceDBPruneCoversBothKeyspaces(t *testing.T) { |
156 | 159 | } |
157 | 160 | } |
158 | 161 |
|
| 162 | +// writeTraceRows stores a per-tx row, a per-block row and a last baked height at |
| 163 | +// height 7 in the trace DB under home. |
| 164 | +func writeTraceRows(t *testing.T, home string) { |
| 165 | + t.Helper() |
| 166 | + c, err := NewTraceDB(home) |
| 167 | + require.NoError(t, err) |
| 168 | + require.NoError(t, c.Put(7, "callTracer", common.HexToHash("0x07"), json.RawMessage(`{"calls":[]}`))) |
| 169 | + require.NoError(t, c.PutBlock(7, "callTracer", json.RawMessage(`[{"txHash":"0x07"}]`))) |
| 170 | + require.NoError(t, c.SetLastBakedHeight(7)) |
| 171 | + require.NoError(t, c.Close()) |
| 172 | +} |
| 173 | + |
| 174 | +// setFormatStamp replaces the format stamp of the trace DB under home with stamp, |
| 175 | +// or removes it when stamp is nil, writing to pebble directly as another build would. |
| 176 | +func setFormatStamp(t *testing.T, home string, stamp []byte) { |
| 177 | + t.Helper() |
| 178 | + db, err := pebble.Open(filepath.Join(home, "data", "trace_db"), &pebble.Options{}) |
| 179 | + require.NoError(t, err) |
| 180 | + if stamp == nil { |
| 181 | + require.NoError(t, db.Delete([]byte(traceDBFormatVersionKey), pebble.Sync)) |
| 182 | + } else { |
| 183 | + require.NoError(t, db.Set([]byte(traceDBFormatVersionKey), stamp, pebble.Sync)) |
| 184 | + } |
| 185 | + require.NoError(t, db.Close()) |
| 186 | +} |
| 187 | + |
| 188 | +func formatStamp(version uint64) []byte { |
| 189 | + var b [8]byte |
| 190 | + binary.BigEndian.PutUint64(b[:], version) |
| 191 | + return b[:] |
| 192 | +} |
| 193 | + |
| 194 | +func TestTraceDBDiscardsRowsFromOtherFormatVersions(t *testing.T) { |
| 195 | + cases := []struct { |
| 196 | + name string |
| 197 | + stamp []byte |
| 198 | + }{ |
| 199 | + {"no stamp", nil}, |
| 200 | + {"other version", formatStamp(traceDBFormatVersion + 1)}, |
| 201 | + {"malformed stamp", []byte{0x01}}, |
| 202 | + } |
| 203 | + for _, tc := range cases { |
| 204 | + t.Run(tc.name, func(t *testing.T) { |
| 205 | + home := t.TempDir() |
| 206 | + writeTraceRows(t, home) |
| 207 | + setFormatStamp(t, home, tc.stamp) |
| 208 | + |
| 209 | + c, err := NewTraceDB(home) |
| 210 | + require.NoError(t, err) |
| 211 | + |
| 212 | + _, ok, err := c.Get(7, "callTracer", common.HexToHash("0x07")) |
| 213 | + require.NoError(t, err) |
| 214 | + require.False(t, ok, "per-tx row stored under another format version must not be served") |
| 215 | + _, ok, err = c.GetBlock(7, "callTracer") |
| 216 | + require.NoError(t, err) |
| 217 | + require.False(t, ok, "per-block row stored under another format version must not be served") |
| 218 | + last, err := c.LastBakedHeight() |
| 219 | + require.NoError(t, err) |
| 220 | + require.Equal(t, int64(0), last, "last baked height must reset so the baker bakes again") |
| 221 | + stored, err := c.storedFormatVersion() |
| 222 | + require.NoError(t, err) |
| 223 | + require.Equal(t, traceDBFormatVersion, stored) |
| 224 | + |
| 225 | + // Rows baked after the reset are kept by the next open. |
| 226 | + require.NoError(t, c.Put(8, "callTracer", common.HexToHash("0x08"), json.RawMessage(`{"calls":[1]}`))) |
| 227 | + require.NoError(t, c.Close()) |
| 228 | + c, err = NewTraceDB(home) |
| 229 | + require.NoError(t, err) |
| 230 | + defer c.Close() |
| 231 | + got, ok, err := c.Get(8, "callTracer", common.HexToHash("0x08")) |
| 232 | + require.NoError(t, err) |
| 233 | + require.True(t, ok) |
| 234 | + require.JSONEq(t, `{"calls":[1]}`, string(got)) |
| 235 | + }) |
| 236 | + } |
| 237 | +} |
| 238 | + |
| 239 | +func TestTraceDBKeepsRowsOfCurrentFormatVersion(t *testing.T) { |
| 240 | + home := t.TempDir() |
| 241 | + writeTraceRows(t, home) |
| 242 | + |
| 243 | + c, err := NewTraceDB(home) |
| 244 | + require.NoError(t, err) |
| 245 | + defer c.Close() |
| 246 | + |
| 247 | + got, ok, err := c.Get(7, "callTracer", common.HexToHash("0x07")) |
| 248 | + require.NoError(t, err) |
| 249 | + require.True(t, ok) |
| 250 | + require.JSONEq(t, `{"calls":[]}`, string(got)) |
| 251 | + got, ok, err = c.GetBlock(7, "callTracer") |
| 252 | + require.NoError(t, err) |
| 253 | + require.True(t, ok) |
| 254 | + require.JSONEq(t, `[{"txHash":"0x07"}]`, string(got)) |
| 255 | + last, err := c.LastBakedHeight() |
| 256 | + require.NoError(t, err) |
| 257 | + require.Equal(t, int64(7), last) |
| 258 | +} |
| 259 | + |
| 260 | +func TestTraceDBPruneSparesFormatStamp(t *testing.T) { |
| 261 | + home := t.TempDir() |
| 262 | + c, err := NewTraceDB(home) |
| 263 | + require.NoError(t, err) |
| 264 | + require.NoError(t, c.Put(1, "callTracer", common.HexToHash("0x1"), json.RawMessage(`"x"`))) |
| 265 | + require.NoError(t, c.Prune(1_000_000)) |
| 266 | + require.NoError(t, c.Put(2_000_000, "callTracer", common.HexToHash("0x2"), json.RawMessage(`"y"`))) |
| 267 | + require.NoError(t, c.Close()) |
| 268 | + |
| 269 | + c, err = NewTraceDB(home) |
| 270 | + require.NoError(t, err) |
| 271 | + defer c.Close() |
| 272 | + _, ok, err := c.Get(2_000_000, "callTracer", common.HexToHash("0x2")) |
| 273 | + require.NoError(t, err) |
| 274 | + require.True(t, ok, "a pruned DB must still carry the format stamp, or its next open would discard its rows") |
| 275 | +} |
| 276 | + |
159 | 277 | type recordingEnqueuer struct{ heights atomic.Value } |
160 | 278 |
|
161 | 279 | func (r *recordingEnqueuer) Enqueue(h int64) { |
|
0 commit comments