logos-storage/nim-datastore
1
0
Fork 0
mirror of https://github.com/logos-storage/nim-datastore.git synced 2026-02-18 12:43:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

This commit is the first step in automatic disposing of leveldb iterators. It:

Browse Source 
1. disposes of iterators automatically when the iterator is finished;
2. does a bit of test refactoring to reflect that.
This commit is contained in:
gmega 2026-02-05 10:43:56 -03:00
parent a7ee4b170a
commit 6c9e790521
No known key found for this signature in database
GPG Key ID: 6290D34EAD824B18
3 changed files with 120 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
datastore/leveldb/leveldbds.nim
View File

@ -98,6 +98,11 @@ method query*(
limit = query.limit limit = query.limit
) )
proc dispose(): Future[?!void] {.async: (raises: [CancelledError]).} =
dbIter.dispose()
iter.disposed = true
return success()
proc next(): Future[?!QueryResponse] {.async: (raises: [CancelledError]).} = proc next(): Future[?!QueryResponse] {.async: (raises: [CancelledError]).} =
if iter.finished: if iter.finished:
return failure(newException(QueryEndedError, "Calling next on a finished query!")) return failure(newException(QueryEndedError, "Calling next on a finished query!"))
@ -107,6 +112,9 @@ method query*(
if dbIter.finished: if dbIter.finished:
iter.finished = true iter.finished = true
if err =? (await dispose()).errorOption:
return failure(err)
return success (Key.none, EmptyBytes) return success (Key.none, EmptyBytes)
else: else:
let key = Key.init(keyStr).expect("LevelDbDatastore.query (next) Failed to create key.") let key = Key.init(keyStr).expect("LevelDbDatastore.query (next) Failed to create key.")
@ -114,10 +122,6 @@ method query*(
except LevelDbException as e: except LevelDbException as e:
return failure("LevelDbDatastore.query -> next exception: " & $e.msg) return failure("LevelDbDatastore.query -> next exception: " & $e.msg)
proc dispose(): Future[?!void] {.async: (raises: [CancelledError]).} =
dbIter.dispose()
return success()
iter.next = next iter.next = next
iter.dispose = dispose iter.dispose = dispose
return success iter return success iter

1
datastore/query.nim
View File

@ -27,6 +27,7 @@ type
IterDispose* = proc(): Future[?!void] {.async: (raises: [CancelledError]), gcsafe.} IterDispose* = proc(): Future[?!void] {.async: (raises: [CancelledError]), gcsafe.}
QueryIter* = ref object QueryIter* = ref object
finished*: bool finished*: bool
disposed*: bool
next*: GetNext next*: GetNext
dispose*: IterDispose dispose*: IterDispose

186
tests/datastore/leveldb/testleveldbds.nim
View File

@ -16,58 +16,58 @@ import ../modifycommontests
import ../querycommontests import ../querycommontests
import ../typeddscommontests import ../typeddscommontests
suite "Test Basic LevelDbDatastore": # suite "Test Basic LevelDbDatastore":
let # let
tempDir = getTempDir() / "testleveldbds" # tempDir = getTempDir() / "testleveldbds"
ds = LevelDbDatastore.new(tempDir).tryGet() # ds = LevelDbDatastore.new(tempDir).tryGet()
key = Key.init("a:b/c/d:e").tryGet() # key = Key.init("a:b/c/d:e").tryGet()
bytes = "some bytes".toBytes # bytes = "some bytes".toBytes
otherBytes = "some other bytes".toBytes # otherBytes = "some other bytes".toBytes
setupAll: # setupAll:
createDir(tempDir) # createDir(tempDir)
teardownAll: # teardownAll:
(await ds.close()).tryGet() # (await ds.close()).tryGet()
removeDir(tempDir) # removeDir(tempDir)
basicStoreTests(ds, key, bytes, otherBytes) # basicStoreTests(ds, key, bytes, otherBytes)
modifyTests(ds, key) # modifyTests(ds, key)
typedDsTests(ds, key) # typedDsTests(ds, key)
suite "Test LevelDB Query": # suite "Test LevelDB Query":
let tempDir = getTempDir() / "testleveldbds" # let tempDir = getTempDir() / "testleveldbds"
var ds: LevelDbDatastore # var ds: LevelDbDatastore
setup: # setup:
createDir(tempDir) # createDir(tempDir)
ds = LevelDbDatastore.new(tempDir).tryGet() # ds = LevelDbDatastore.new(tempDir).tryGet()
teardown: # teardown:
(await ds.close()).tryGet # (await ds.close()).tryGet
removeDir(tempDir) # removeDir(tempDir)
queryTests(ds, # queryTests(ds,
testLimitsAndOffsets = true, # testLimitsAndOffsets = true,
testSortOrder = false # testSortOrder = false
) # )
suite "Test LevelDB Typed Query": # suite "Test LevelDB Typed Query":
let tempDir = getTempDir() / "testleveldbds" # let tempDir = getTempDir() / "testleveldbds"
var ds: LevelDbDatastore # var ds: LevelDbDatastore
setup: # setup:
createDir(tempDir) # createDir(tempDir)
ds = LevelDbDatastore.new(tempDir).tryGet() # ds = LevelDbDatastore.new(tempDir).tryGet()
teardown: # teardown:
(await ds.close()).tryGet # (await ds.close()).tryGet
removeDir(tempDir) # removeDir(tempDir)
test "Typed Queries": # test "Typed Queries":
typedDsQueryTests(ds) # typedDsQueryTests(ds)
suite "LevelDB Query: keys should disregard trailing wildcards": suite "LevelDB Query":
let tempDir = getTempDir() / "testleveldbds" let tempDir = getTempDir() / "testleveldbds"
var var
ds: LevelDbDatastore ds: LevelDbDatastore
@ -97,44 +97,80 @@ suite "LevelDB Query: keys should disregard trailing wildcards":
(await ds.close()).tryGet (await ds.close()).tryGet
removeDir(tempDir) removeDir(tempDir)
test "Forward": # test "should query by prefix":
# let
# q = Query.init(Key.init("/a/*").tryGet)
# iter = (await ds.query(q)).tryGet
# res = (await allFinished(toSeq(iter)))
# .mapIt( it.read.tryGet )
# .filterIt( it.key.isSome )
# check:
# res.len == 3
# res[0].key.get == key1
# res[0].data == val1
# res[1].key.get == key2
# res[1].data == val2
# res[2].key.get == key3
# res[2].data == val3
# (await iter.dispose()).tryGet
# test "should disregard forward trailing wildcards in keys":
# let
# q = Query.init(Key.init("/a/*").tryGet)
# iter = (await ds.query(q)).tryGet
# res = (await allFinished(toSeq(iter)))
# .mapIt( it.read.tryGet )
# .filterIt( it.key.isSome )
# check:
# res.len == 3
# res[0].key.get == key1
# res[0].data == val1
# res[1].key.get == key2
# res[1].data == val2
# res[2].key.get == key3
# res[2].data == val3
# test "should disregard backward trailing wildcards in key":
# let
# q = Query.init(Key.init("/a\\*").tryGet)
# iter = (await ds.query(q)).tryGet
# res = (await allFinished(toSeq(iter)))
# .mapIt( it.read.tryGet )
# .filterIt( it.key.isSome )
# check:
# res.len == 3
# res[0].key.get == key1
# res[0].data == val1
# res[1].key.get == key2
# res[1].data == val2
# res[2].key.get == key3
# res[2].data == val3
test "should dispose automatically when iterator is finished":
let let
q = Query.init(Key.init("/a/*").tryGet) q = Query.init(Key.init("/a/b/c").tryGet)
iter = (await ds.query(q)).tryGet iter = (await ds.query(q)).tryGet
res = (await allFinished(toSeq(iter)))
.mapIt( it.read.tryGet )
.filterIt( it.key.isSome )
check: let val = (await iter.next()).tryGet()
res.len == 3 check val.key.get == key3
res[0].key.get == key1 check val.data == val3
res[0].data == val1
res[1].key.get == key2 check iter.finished == false
res[1].data == val2 check iter.disposed == false
res[2].key.get == key3 let val2 = (await iter.next()).tryGet()
res[2].data == val3 check val2.key == Key.none
check val2.data == EmptyBytes
(await iter.dispose()).tryGet check iter.finished == true
check iter.disposed == true
test "Backwards":
let
q = Query.init(Key.init("/a\\*").tryGet)
iter = (await ds.query(q)).tryGet
res = (await allFinished(toSeq(iter)))
.mapIt( it.read.tryGet )
.filterIt( it.key.isSome )
check:
res.len == 3
res[0].key.get == key1
res[0].data == val1
res[1].key.get == key2
res[1].data == val2
res[2].key.get == key3
res[2].data == val3
(await iter.dispose()).tryGet