mirror of
https://github.com/codex-storage/nim-codex.git
synced 2025-01-10 04:55:40 +00:00
9c8a59d150
* setting up * Implements timer utility * applies async and cancellation to timer loop * Sets up mocktimer and mockblockstore to set up first maintenance module test * wip: first test that calls blockChecker * wip: adding user type to timer callback * Chronicles doesn't like type-arguments? Disables logging in timer module for now * Implementing block check test for blockMaintainer module * Sets up additional tests for blockmaintainer * Removes generic from timer module. Implements numberOfBlocks per interval in blockMaintainer. * Implements blockMaintainer * Sets up tests for blockChecker * Some comments by Mark * Cleanup repostore tests * Setting up the use of std/times for block TTL tracking * repostore adds expiration timestamp * Defaults the repostore clock to the system clock * Applies updates to repostore interface. * Implements retrieving of block expiration information from repostore * Sets up tests for maintenance module behavior * Implements block maintenance module * Wires maintenance module into codex. Sets up integration tests for block expiration * Sets up test for missing behavior: removing timestamp metadata on block delete * Implements removing of expiration metadata in repoStore * Fixes integration tests for block expiration * Adds block expiration tests to integration test run * Handled some comments by Dmitriy * Review comment by Dmitriy: Removes seq[cid] from runBlockCheck * Review comment by Dmitriy: Moves key formatting methods to keyutils. * Review comment by Dmitriy: Encodes durations using chronos * Fixes conversion of TTL type in conf. * Review comments by Dmitriy * Adds unit tests for keyUtils. * Adds test coverage for exception in maintenance module
93 lines
2.6 KiB
Nim
93 lines
2.6 KiB
Nim
## Nim-Codex
|
|
## Copyright (c) 2023 Status Research & Development GmbH
|
|
## Licensed under either of
|
|
## * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
|
|
## * MIT license ([LICENSE-MIT](LICENSE-MIT))
|
|
## at your option.
|
|
## This file may not be copied, modified, or distributed except according to
|
|
## those terms.
|
|
|
|
## Store maintenance module
|
|
## Looks for and removes expired blocks from blockstores.
|
|
|
|
import pkg/chronos
|
|
import pkg/chronicles
|
|
import pkg/questionable
|
|
import pkg/questionable/results
|
|
|
|
import ./repostore
|
|
import ../utils/timer
|
|
import ../clock
|
|
import ../systemclock
|
|
|
|
const
|
|
DefaultBlockMaintenanceInterval* = 10.minutes
|
|
DefaultNumberOfBlocksToMaintainPerInterval* = 1000
|
|
|
|
type
|
|
BlockMaintainer* = ref object of RootObj
|
|
repoStore: RepoStore
|
|
interval: Duration
|
|
timer: Timer
|
|
clock: Clock
|
|
numberOfBlocksPerInterval: int
|
|
offset: int
|
|
|
|
proc new*(T: type BlockMaintainer,
|
|
repoStore: RepoStore,
|
|
interval: Duration,
|
|
numberOfBlocksPerInterval = 100,
|
|
timer = Timer.new(),
|
|
clock: Clock = SystemClock.new()
|
|
): T =
|
|
T(
|
|
repoStore: repoStore,
|
|
interval: interval,
|
|
numberOfBlocksPerInterval: numberOfBlocksPerInterval,
|
|
timer: timer,
|
|
clock: clock,
|
|
offset: 0)
|
|
|
|
proc deleteExpiredBlock(self: BlockMaintainer, cid: Cid): Future[void] {.async.} =
|
|
if isErr (await self.repoStore.delBlock(cid)):
|
|
trace "Unable to delete block from repoStore"
|
|
|
|
proc processBlockExpiration(self: BlockMaintainer, be: BlockExpiration): Future[void] {.async} =
|
|
if be.expiration < self.clock.now:
|
|
await self.deleteExpiredBlock(be.cid)
|
|
else:
|
|
inc self.offset
|
|
|
|
proc runBlockCheck(self: BlockMaintainer): Future[void] {.async.} =
|
|
let expirations = await self.repoStore.getBlockExpirations(
|
|
maxNumber = self.numberOfBlocksPerInterval,
|
|
offset = self.offset
|
|
)
|
|
|
|
without iter =? expirations, err:
|
|
trace "Unable to obtain blockExpirations iterator from repoStore"
|
|
return
|
|
|
|
var numberReceived = 0
|
|
for maybeBeFuture in iter:
|
|
if be =? await maybeBeFuture:
|
|
inc numberReceived
|
|
await self.processBlockExpiration(be)
|
|
|
|
# If we received fewer blockExpirations from the iterator than we asked for,
|
|
# We're at the end of the dataset and should start from 0 next time.
|
|
if numberReceived < self.numberOfBlocksPerInterval:
|
|
self.offset = 0
|
|
|
|
proc start*(self: BlockMaintainer) =
|
|
proc onTimer(): Future[void] {.async.} =
|
|
try:
|
|
await self.runBlockCheck()
|
|
except CatchableError as exc:
|
|
error "Unexpected exception in BlockMaintainer.onTimer(): ", msg=exc.msg
|
|
|
|
self.timer.start(onTimer, self.interval)
|
|
|
|
proc stop*(self: BlockMaintainer): Future[void] {.async.} =
|
|
await self.timer.stop()
|