logos-storage-nim/codex/streams/asyncstreamwrapper.nim
Dmitriy Ryajov 1cac3e2a11
Fix/rework async exceptions (#1130)
* cleanup imports and logs

* add BlockHandle type

* revert deps

* refactor: async error handling and future tracking improvements

- Update async procedures to use explicit raises annotation
- Modify TrackedFutures to handle futures with no raised exceptions
- Replace `asyncSpawn` with explicit future tracking
- Update test suites to use `unittest2`
- Standardize error handling across network and async components
- Remove deprecated error handling patterns

This commit introduces a more robust approach to async error handling and future management, improving type safety and reducing potential runtime errors.

* bump nim-serde

* remove asyncSpawn

* rework background downloads and prefetch

* imporove logging

* refactor: enhance async procedures with error handling and raise annotations

* misc cleanup

* misc

* refactor: implement allFinishedFailed to aggregate future results with success and failure tracking

* refactor: update error handling in reader procedures to raise ChunkerError and CancelledError

* refactor: improve error handling in wantListHandler and accountHandler procedures

* refactor: simplify LPStreamReadError creation by consolidating parameters

* refactor: enhance error handling in AsyncStreamWrapper to catch unexpected errors

* refactor: enhance error handling in advertiser and discovery loops to improve resilience

* misc

* refactor: improve code structure and readability

* remove cancellation from addSlotToQueue

* refactor: add assertion for unexpected errors in local store checks

* refactor: prevent tracking of finished futures and improve test assertions

* refactor: improve error handling in local store checks

* remove usage of msgDetail

* feat: add initial implementation of discovery engine and related components

* refactor: improve task scheduling logic by removing unnecessary break statement

* break after scheduling a task

* make taskHandler cancelable

* refactor: update async handlers to raise CancelledError

* refactor(advertiser): streamline error handling and improve task flow in advertise loops

* fix: correct spelling of "divisible" in error messages and comments

* refactor(discovery): simplify discovery task loop and improve error handling

* refactor(engine): filter peers before processing in cancelBlocks procedure
2025-03-13 07:33:15 -07:00

134 lines
3.8 KiB
Nim

## Nim-LibP2P
## Copyright (c) 2019 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/upraises
push:
{.upraises: [].}
import pkg/chronos
import pkg/libp2p
import ../logutils
logScope:
topics = "libp2p asyncstreamwrapper"
const AsyncStreamWrapperName* = "AsyncStreamWrapper"
type AsyncStreamWrapper* = ref object of LPStream
reader*: AsyncStreamReader
writer*: AsyncStreamWriter
method initStream*(self: AsyncStreamWrapper) =
if self.objName.len == 0:
self.objName = AsyncStreamWrapperName
procCall LPStream(self).initStream()
proc new*(
C: type AsyncStreamWrapper,
reader: AsyncStreamReader = nil,
writer: AsyncStreamWriter = nil,
): AsyncStreamWrapper =
## Create new instance of an asynchronous stream wrapper
##
let stream = C(reader: reader, writer: writer)
stream.initStream()
return stream
template withExceptions(body: untyped) =
try:
body
except CancelledError as exc:
raise exc
except AsyncStreamIncompleteError:
# for all intents and purposes this is an EOF
raise newLPStreamIncompleteError()
except AsyncStreamLimitError:
raise newLPStreamLimitError()
except AsyncStreamUseClosedError:
raise newLPStreamEOFError()
except AsyncStreamError as exc:
raise newException(LPStreamError, exc.msg)
except CatchableError as exc:
raise newException(Defect, "Unexpected error in AsyncStreamWrapper", exc)
method readOnce*(
self: AsyncStreamWrapper, pbytes: pointer, nbytes: int
): Future[int] {.async: (raises: [CancelledError, LPStreamError]).} =
trace "Reading bytes from reader", bytes = nbytes
if isNil(self.reader):
error "Async stream wrapper reader nil"
raiseAssert("Async stream wrapper reader nil")
if self.atEof:
raise newLPStreamEOFError()
withExceptions:
return await self.reader.readOnce(pbytes, nbytes)
proc completeWrite(
self: AsyncStreamWrapper, fut: Future[void], msgLen: int
): Future[void] {.async: (raises: [CancelledError, LPStreamError]).} =
withExceptions:
await fut
method write*(
self: AsyncStreamWrapper, msg: seq[byte]
): Future[void] {.async: (raises: [CancelledError, LPStreamError], raw: true).} =
# Avoid a copy of msg being kept in the closure created by `{.async.}` as this
# drives up memory usage
trace "Writing bytes to writer", bytes = msg.len
if isNil(self.writer):
error "Async stream wrapper writer nil"
raiseAssert("Async stream wrapper writer nil")
if self.closed:
let fut = newFuture[void]("asyncstreamwrapper.write.closed")
fut.fail(newLPStreamClosedError())
return fut
self.completeWrite(self.writer.write(msg, msg.len), msg.len)
method closed*(self: AsyncStreamWrapper): bool =
var
readerClosed = true
writerClosed = true
if not isNil(self.reader):
readerClosed = self.reader.closed
if not isNil(self.writer):
writerClosed = self.writer.closed
return readerClosed and writerClosed
method atEof*(self: AsyncStreamWrapper): bool =
self.reader.atEof()
method closeImpl*(self: AsyncStreamWrapper) {.async: (raises: []).} =
try:
trace "Shutting down async chronos stream"
if not self.closed():
if not isNil(self.reader) and not self.reader.closed():
await self.reader.closeWait()
if not isNil(self.writer) and not self.writer.closed():
await self.writer.closeWait()
trace "Shutdown async chronos stream"
except CancelledError as exc:
error "Error received cancelled error when closing chronos stream", msg = exc.msg
except CatchableError as exc:
trace "Error closing async chronos stream", msg = exc.msg
await procCall LPStream(self).closeImpl()