fix(nodeprocess): asyncspawn capture output (#1045)

- Ensures no exceptions are raised from `captureOutput`
- Asyncspawns the future to ensure errors are not silently swallowed
This commit is contained in:
Eric 2024-12-17 16:51:38 +07:00 committed by GitHub
parent f0f04ddf1d
commit c498e2f53b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 12 additions and 8 deletions

View File

@ -34,10 +34,10 @@ method startedOutput(node: CodexProcess): string =
method processOptions(node: CodexProcess): set[AsyncProcessOption] = method processOptions(node: CodexProcess): set[AsyncProcessOption] =
return {AsyncProcessOption.StdErrToStdOut} return {AsyncProcessOption.StdErrToStdOut}
method outputLineEndings(node: CodexProcess): string = method outputLineEndings(node: CodexProcess): string {.raises: [].} =
return "\n" return "\n"
method onOutputLineCaptured(node: CodexProcess, line: string) = method onOutputLineCaptured(node: CodexProcess, line: string) {.raises: [].} =
discard discard
proc dataDir(node: CodexProcess): string = proc dataDir(node: CodexProcess): string =

View File

@ -37,7 +37,7 @@ method startedOutput(node: HardhatProcess): string =
method processOptions(node: HardhatProcess): set[AsyncProcessOption] = method processOptions(node: HardhatProcess): set[AsyncProcessOption] =
return {} return {}
method outputLineEndings(node: HardhatProcess): string = method outputLineEndings(node: HardhatProcess): string {.raises: [].} =
return "\n" return "\n"
proc openLogFile(node: HardhatProcess, logFilePath: string): IoHandle = proc openLogFile(node: HardhatProcess, logFilePath: string): IoHandle =

View File

@ -38,10 +38,10 @@ method startedOutput(node: NodeProcess): string {.base.} =
method processOptions(node: NodeProcess): set[AsyncProcessOption] {.base.} = method processOptions(node: NodeProcess): set[AsyncProcessOption] {.base.} =
raiseAssert "not implemented" raiseAssert "not implemented"
method outputLineEndings(node: NodeProcess): string {.base.} = method outputLineEndings(node: NodeProcess): string {.base, raises: [].} =
raiseAssert "not implemented" raiseAssert "not implemented"
method onOutputLineCaptured(node: NodeProcess, line: string) {.base.} = method onOutputLineCaptured(node: NodeProcess, line: string) {.base, raises: [].} =
raiseAssert "not implemented" raiseAssert "not implemented"
method start*(node: NodeProcess) {.base, async.} = method start*(node: NodeProcess) {.base, async.} =
@ -74,7 +74,7 @@ proc captureOutput(
node: NodeProcess, node: NodeProcess,
output: string, output: string,
started: Future[void] started: Future[void]
) {.async.} = ) {.async: (raises: []).} =
logScope: logScope:
nodeName = node.name nodeName = node.name
@ -98,7 +98,10 @@ proc captureOutput(
await sleepAsync(1.millis) await sleepAsync(1.millis)
await sleepAsync(1.millis) await sleepAsync(1.millis)
except AsyncStreamReadError as e: except CancelledError:
discard # do not propagate as captureOutput was asyncSpawned
except AsyncStreamError as e:
error "error reading output stream", error = e.msgDetail error "error reading output stream", error = e.msgDetail
proc startNode*[T: NodeProcess]( proc startNode*[T: NodeProcess](
@ -155,7 +158,8 @@ proc waitUntilStarted*(node: NodeProcess) {.async.} =
let started = newFuture[void]() let started = newFuture[void]()
try: try:
discard node.captureOutput(node.startedOutput, started).track(node) let fut = node.captureOutput(node.startedOutput, started).track(node)
asyncSpawn fut
await started.wait(60.seconds) # allow enough time for proof generation await started.wait(60.seconds) # allow enough time for proof generation
trace "node started" trace "node started"
except AsyncTimeoutError: except AsyncTimeoutError: