status-im
/
nimbus-eth1
mirror of https://github.com/status-im/nimbus-eth1.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add SszError to message decoding result (#1660) 

This allows for improved error messages. Required changing the PortalResult from cstring to string for the error.
This commit is contained in:
Kim De Mey 2023-08-23 18:03:09 +02:00 committed by GitHub
parent 849c4bc785
commit 6535b39e47
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
fluffy/network/wire/messages.nim
View File

@ -142,16 +142,16 @@ func encodeMessage*[T: SomeMessage](m: T): seq[byte] =
elif T is OfferMessage: SSZ.encode(Message(kind: offer, offer: m)) elif T is OfferMessage: SSZ.encode(Message(kind: offer, offer: m))
elif T is AcceptMessage: SSZ.encode(Message(kind: accept, accept: m)) elif T is AcceptMessage: SSZ.encode(Message(kind: accept, accept: m))
func decodeMessage*(body: openArray[byte]): Result[Message, cstring] = func decodeMessage*(body: openArray[byte]): Result[Message, string] =
try: try:
if body.len < 1: # TODO: This check should probably move a layer down if body.len < 1: # TODO: This check should probably move a layer down
return err("No message data, peer might not support this talk protocol") return err("No message data, peer might not support this talk protocol")
ok(SSZ.decode(body, Message)) ok(SSZ.decode(body, Message))
except SszError: except SszError as e:
err("Invalid message encoding") err("Invalid message encoding: " & e.msg)
template innerMessage[T: SomeMessage]( template innerMessage[T: SomeMessage](
message: Message, expected: MessageKind): Result[T, cstring] = message: Message, expected: MessageKind): Result[T, string] =
if (message.kind == expected): if (message.kind == expected):
ok(message.expected) ok(message.expected)
else: else:
@ -160,7 +160,7 @@ template innerMessage[T: SomeMessage](
# Each `Message` variants corresponds to an MessageKind. Therefore, the inner # Each `Message` variants corresponds to an MessageKind. Therefore, the inner
# message can be extracted when providing the expected message type T. # message can be extracted when providing the expected message type T.
# If the message does not hold the expacted variant, return error. # If the message does not hold the expacted variant, return error.
func getInnerMessage*[T: SomeMessage](m: Message): Result[T, cstring] = func getInnerMessage*[T: SomeMessage](m: Message): Result[T, string] =
innerMessage[T](m, messageKind(T)) innerMessage[T](m, messageKind(T))
func getTalkReqOverhead*(protocolIdLen: int): int = func getTalkReqOverhead*(protocolIdLen: int): int =

9
fluffy/network/wire/portal_protocol.nim
View File

@ -171,7 +171,7 @@ type
offerQueue: AsyncQueue[OfferRequest] offerQueue: AsyncQueue[OfferRequest]
offerWorkers: seq[Future[void]] offerWorkers: seq[Future[void]]
PortalResult*[T] = Result[T, cstring] PortalResult*[T] = Result[T, string]
FoundContentKind* = enum FoundContentKind* = enum
Nodes, Nodes,
@ -495,9 +495,10 @@ proc reqResponse[Request: SomeMessage, Response: SomeMessage](
# not supporting the specific talk protocol, as according to specification # not supporting the specific talk protocol, as according to specification
# an empty response needs to be send in that case. # an empty response needs to be send in that case.
# See: https://github.com/ethereum/devp2p/blob/master/discv5/discv5-wire.md#talkreq-request-0x05 # See: https://github.com/ethereum/devp2p/blob/master/discv5/discv5-wire.md#talkreq-request-0x05
let messageResponse = talkresp
.flatMap(proc (x: seq[byte]): Result[Message, cstring] = decodeMessage(x)) let messageResponse = talkresp.mapErr(proc (x: cstring): string = $x)
.flatMap(proc (m: Message): Result[Response, cstring] = .flatMap(proc (x: seq[byte]): Result[Message, string] = decodeMessage(x))
.flatMap(proc (m: Message): Result[Response, string] =
getInnerMessage[Response](m)) getInnerMessage[Response](m))
if messageResponse.isOk(): if messageResponse.isOk():