-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Setting up advertiser * Wires up advertiser * cleanup * test compiles * tests pass * setting up test for advertiser * Finishes advertiser tests * fixes commonstore tests * Review comments by Giuliano * Race condition found by Giuliano * Review comment by Dmitriy Co-authored-by: Dmitriy Ryajov <[email protected]> Signed-off-by: Ben Bierens <[email protected]> * fixes tests --------- Signed-off-by: Ben Bierens <[email protected]> Co-authored-by: Dmitriy Ryajov <[email protected]>
- Loading branch information
1 parent
e017b05
commit 1e2ad95
Showing
19 changed files
with
369 additions
and
235 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| import ./engine/discovery | ||
| import ./engine/advertiser | ||
| import ./engine/engine | ||
| import ./engine/payments | ||
|
|
||
| export discovery, engine, payments | ||
| export discovery, advertiser, engine, payments |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| ## Nim-Codex | ||
| ## Copyright (c) 2022 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. | ||
|
|
||
| import pkg/chronos | ||
| import pkg/libp2p/cid | ||
| import pkg/libp2p/multicodec | ||
| import pkg/metrics | ||
| import pkg/questionable | ||
| import pkg/questionable/results | ||
|
|
||
| import ../protobuf/presence | ||
| import ../peers | ||
|
|
||
| import ../../utils | ||
| import ../../discovery | ||
| import ../../stores/blockstore | ||
| import ../../logutils | ||
| import ../../manifest | ||
|
|
||
| logScope: | ||
| topics = "codex discoveryengine advertiser" | ||
|
|
||
| declareGauge(codexInflightAdvertise, "inflight advertise requests") | ||
|
|
||
| const | ||
| DefaultConcurrentAdvertRequests = 10 | ||
| DefaultAdvertiseLoopSleep = 30.minutes | ||
|
|
||
| type | ||
| Advertiser* = ref object of RootObj | ||
| localStore*: BlockStore # Local block store for this instance | ||
| discovery*: Discovery # Discovery interface | ||
|
|
||
| advertiserRunning*: bool # Indicates if discovery is running | ||
| concurrentAdvReqs: int # Concurrent advertise requests | ||
|
|
||
| advertiseLocalStoreLoop*: Future[void] # Advertise loop task handle | ||
| advertiseQueue*: AsyncQueue[Cid] # Advertise queue | ||
| advertiseTasks*: seq[Future[void]] # Advertise tasks | ||
|
|
||
| advertiseLocalStoreLoopSleep: Duration # Advertise loop sleep | ||
| inFlightAdvReqs*: Table[Cid, Future[void]] # Inflight advertise requests | ||
|
|
||
| proc addCidToQueue(b: Advertiser, cid: Cid) {.async.} = | ||
| if cid notin b.advertiseQueue: | ||
| await b.advertiseQueue.put(cid) | ||
| trace "Advertising", cid | ||
|
|
||
| proc advertiseBlock(b: Advertiser, cid: Cid) {.async.} = | ||
| without isM =? cid.isManifest, err: | ||
| warn "Unable to determine if cid is manifest" | ||
| return | ||
|
|
||
| if isM: | ||
| without blk =? await b.localStore.getBlock(cid), err: | ||
| error "Error retrieving manifest block", cid, err = err.msg | ||
| return | ||
|
|
||
| without manifest =? Manifest.decode(blk), err: | ||
| error "Unable to decode as manifest", err = err.msg | ||
| return | ||
|
|
||
| # announce manifest cid and tree cid | ||
| await b.addCidToQueue(cid) | ||
| await b.addCidToQueue(manifest.treeCid) | ||
|
|
||
| proc advertiseLocalStoreLoop(b: Advertiser) {.async.} = | ||
| while b.advertiserRunning: | ||
| if cids =? await b.localStore.listBlocks(blockType = BlockType.Manifest): | ||
| trace "Advertiser begins iterating blocks..." | ||
| for c in cids: | ||
| if cid =? await c: | ||
| await b.advertiseBlock(cid) | ||
| trace "Advertiser iterating blocks finished." | ||
|
|
||
| await sleepAsync(b.advertiseLocalStoreLoopSleep) | ||
|
|
||
| info "Exiting advertise task loop" | ||
|
|
||
| proc processQueueLoop(b: Advertiser) {.async.} = | ||
| while b.advertiserRunning: | ||
| try: | ||
| let | ||
| cid = await b.advertiseQueue.get() | ||
|
|
||
| if cid in b.inFlightAdvReqs: | ||
| continue | ||
|
|
||
| try: | ||
| let | ||
| request = b.discovery.provide(cid) | ||
|
|
||
| b.inFlightAdvReqs[cid] = request | ||
| codexInflightAdvertise.set(b.inFlightAdvReqs.len.int64) | ||
| await request | ||
|
|
||
| finally: | ||
| b.inFlightAdvReqs.del(cid) | ||
| codexInflightAdvertise.set(b.inFlightAdvReqs.len.int64) | ||
| except CancelledError: | ||
| trace "Advertise task cancelled" | ||
| return | ||
| except CatchableError as exc: | ||
| warn "Exception in advertise task runner", exc = exc.msg | ||
|
|
||
| info "Exiting advertise task runner" | ||
|
|
||
| proc start*(b: Advertiser) {.async.} = | ||
| ## Start the advertiser | ||
| ## | ||
|
|
||
| trace "Advertiser start" | ||
|
|
||
| proc onBlock(cid: Cid) {.async.} = | ||
| await b.advertiseBlock(cid) | ||
|
|
||
| doAssert(b.localStore.onBlockStored.isNone()) | ||
| b.localStore.onBlockStored = onBlock.some | ||
|
|
||
| if b.advertiserRunning: | ||
| warn "Starting advertiser twice" | ||
| return | ||
|
|
||
| b.advertiserRunning = true | ||
| for i in 0..<b.concurrentAdvReqs: | ||
| b.advertiseTasks.add(processQueueLoop(b)) | ||
|
|
||
| b.advertiseLocalStoreLoop = advertiseLocalStoreLoop(b) | ||
|
|
||
| proc stop*(b: Advertiser) {.async.} = | ||
| ## Stop the advertiser | ||
| ## | ||
|
|
||
| trace "Advertiser stop" | ||
| if not b.advertiserRunning: | ||
| warn "Stopping advertiser without starting it" | ||
| return | ||
|
|
||
| b.advertiserRunning = false | ||
| # Stop incoming tasks from callback and localStore loop | ||
| b.localStore.onBlockStored = CidCallback.none | ||
| if not b.advertiseLocalStoreLoop.isNil and not b.advertiseLocalStoreLoop.finished: | ||
| trace "Awaiting advertise loop to stop" | ||
| await b.advertiseLocalStoreLoop.cancelAndWait() | ||
| trace "Advertise loop stopped" | ||
|
|
||
| # Clear up remaining tasks | ||
| for task in b.advertiseTasks: | ||
| if not task.finished: | ||
| trace "Awaiting advertise task to stop" | ||
| await task.cancelAndWait() | ||
| trace "Advertise task stopped" | ||
|
|
||
| trace "Advertiser stopped" | ||
|
|
||
| proc new*( | ||
| T: type Advertiser, | ||
| localStore: BlockStore, | ||
| discovery: Discovery, | ||
| concurrentAdvReqs = DefaultConcurrentAdvertRequests, | ||
| advertiseLocalStoreLoopSleep = DefaultAdvertiseLoopSleep | ||
| ): Advertiser = | ||
| ## Create a advertiser instance | ||
| ## | ||
| Advertiser( | ||
| localStore: localStore, | ||
| discovery: discovery, | ||
| concurrentAdvReqs: concurrentAdvReqs, | ||
| advertiseQueue: newAsyncQueue[Cid](concurrentAdvReqs), | ||
| inFlightAdvReqs: initTable[Cid, Future[void]](), | ||
| advertiseLocalStoreLoopSleep: advertiseLocalStoreLoopSleep) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.