Fix silent hang when custom debug_server is not found
#3756
Conversation
| # pylint: disable=no-member | ||
| GDBClient(project_dir, __unprocessed, debug_options, env_options) \ | ||
| .spawn(ide_data["gdb_path"], ide_data["prog_path"]) \ | ||
| .addErrback(handleFailure) |
There was a problem hiding this comment.
This new errback catches exception DebugInvalidOptionsError asynchronously raised by DebugServer::spawn()
when server_executable cannot be found. The exception was being suppressed because (a) there was no errback and (b) as a result of being raised from a Deferred, the exception couldn't bubble up into the main try...except handler in platformio/__main__.py.
|
|
||
| # pylint: disable=import-outside-toplevel | ||
| from platformio.commands.debug.process.client import reactor | ||
| reactor.callWhenRunning(reactor.stop) |
There was a problem hiding this comment.
Stopping the reactor fixes the hang, allowing cli() to terminate and return control to platformio/__main__.py which will now gracefully print the exception and exit with the appropriate error code.
| return True | ||
|
|
||
| def handleFailure(failure): | ||
| handleFailure.exception = failure.value |
There was a problem hiding this comment.
We store the asynchronous exception so that it can be retrieved synchronously in cli() once the call to reactor.run() returns (after the reactor is stopped by handleFailure()).
|
|
||
| signal.signal(signal.SIGINT, lambda *args, **kwargs: None) | ||
| reactor.run() | ||
|
|
||
| if handleFailure.exception: | ||
| raise handleFailure.exception |
There was a problem hiding this comment.
By synchronously raising the asynchronously caught exception here, we allow it to be handled by the main try...except block in platformio/__main__.py which will now gracefully print the exception and exit with the appropriate error code.
|
Thanks for the PRs! We made huge refactoring of PlatformIO Unified Debugger. See https://github.com/platformio/platformio-core/blob/develop/HISTORY.rst Please re-retest the latest development version via |
With
debug_tool = customanddebug_serverset to an invalid path,pio debugwould hang indefinitely, not surface any errors, and ignoreSIGINT (i.e. it couldn't even be killed with Ctrl+C).
This change attaches an errback to the
GDBClient::spawn()call inplatformio/commands/debug/command.py::cli(). The errback catches exceptionDebugInvalidOptionsErrorasynchronously raised byDebugServer::spawn()when
server_executablecannot be found. This exception was being suppressedbecause (a) there was no errback and (b) as a result of being raised from
a Deferred, the exception couldn't bubble up into the main
try...excepthandler in
platformio/__main__.py.The new errback stores the asynchronously caught exception and stops the
reactor. When the
reactor.run()call incli()then returns, we retrievethe stored exception and raise it synchronously, allowing it to be caught by
the main
try...excepthandler inplatformio/__main__.pywhich gracefullyprints the error message and terminates the script with an error exit code.