feat: added in memory implementation of blockdb #4212
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR introduces an in-memory implementation of the BlockDatabase interface for testing purposes, allowing tests to avoid using on-disk storage when not necessary.
- Adds a new
MemoryDatabasestruct that implements theBlockDatabaseinterface - Provides thread-safe operations using read-write mutexes
- Includes proper error handling for closed database states and empty blocks
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
DracoLi
requested review from
a team and
joshua-kim
and removed request for
a team
x/blockdb/memory_db.go
Outdated
| } | ||
|
|
||
| // WriteBlock stores a block in memory | ||
| func (m *MemoryDatabase) WriteBlock(height BlockHeight, block BlockData) error { |
There was a problem hiding this comment.
blockData is a slice so why do we copy it and not just save the reference? This is for tests. Do we expect the original slice to be changed?
There was a problem hiding this comment.
i don't expect it to be changed in tests but it definitely could, which might cause confusion when debugging.
I opted to copy it since that mirrors the block database behaviour.
x/blockdb/memory_db.go
Outdated
| defer m.mu.Unlock() | ||
|
|
||
| m.closed = true | ||
| m.blocks = nil |
There was a problem hiding this comment.
random comment: I guess we don't technically have to clear out this db since all future operations are stopped and this operation is idempotent - but I don't think we care either way... so feel free to ignore this...
There was a problem hiding this comment.
setting to nil does allow the blocks to be garbage collected in case the db reference is still around.
Why this should be merged
For tests where we don't need to use on an on-disk block store, we can use this
blockdb.MemoryDatabase.For example, #4208 uses this MemoryDatabase to test the
meterblockdbHow this works
Use
blockdb.MemoryDatabaseto create a block database that implementsdatabase.BlockDatabase. It writes and reads blocks from memory.How this was tested
Tests that uses the MemoryDatabase. Currently just in #4208
Need to be documented in RELEASES.md?
No