Add explicit exceptions during command calls / handling #210
Conversation
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
Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
# Conflicts: # lib/everest.cpp Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
Handle cmd timeout with new cmd error mechanism Add HandlerException and CmdTimeout exceptions that modules can specifically handle Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
…tain an id Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
hikinggrass
changed the title
hikinggrass
commented
Jan 24, 2025
| @@ -34,6 +34,49 @@ using TelemetryEntry = std::variant<std::string, const char*, bool, int32_t, uin | |||
| using TelemetryMap = std::map<std::string, TelemetryEntry>; | |||
| using UnsubscribeToken = std::function<void()>; | |||
|
|
|||
| enum class ErrorType { | |||
There was a problem hiding this comment.
ErrorType might be a bit vague and could lead to confusions with the "error framework"
There was a problem hiding this comment.
Maybe call this CallCmdEvent or CmdEvent
3 tasks
hikinggrass
commented
Feb 28, 2025
| HandlerException, | ||
| Timeout, | ||
| Shutdown, | ||
| Unknown |
| @@ -34,6 +34,49 @@ using TelemetryEntry = std::variant<std::string, const char*, bool, int32_t, uin | |||
| using TelemetryMap = std::map<std::string, TelemetryEntry>; | |||
| using UnsubscribeToken = std::function<void()>; | |||
|
|
|||
| enum class ErrorType { | |||
There was a problem hiding this comment.
Maybe call this CallCmdEvent or CmdEvent
| }; | ||
|
|
||
| struct ErrorMessage { | ||
| ErrorType type; |
| Unknown | ||
| }; | ||
|
|
||
| struct ErrorMessage { |
Comment on lines
+65
to
+79
| class CmdError : public Everest::EverestBaseRuntimeError { | ||
| public: | ||
| using EverestBaseRuntimeError::EverestBaseRuntimeError; | ||
| }; | ||
|
|
||
| class HandlerException : public CmdError { | ||
| public: | ||
| using CmdError::CmdError; | ||
| }; | ||
|
|
||
| class CmdTimeout : public CmdError { | ||
| public: | ||
| using CmdError::CmdError; | ||
| }; | ||
|
|
There was a problem hiding this comment.
Maybe already define exceptions for the other CallCmdEvents
Comment on lines
+910
to
+913
| EVLOG_verbose << fmt::format("Exception during handling of: {}->{}({}): {}", | ||
| this->config.printable_identifier(this->module_id, impl_id), cmd_name, | ||
| fmt::join(arg_names, ","), e.what()); | ||
| error = ErrorMessage{ErrorType::HandlerException, e.what()}; |
There was a problem hiding this comment.
re-throw after result has been sent to caller so the handler still crashes
|
TODO: add test-cases |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allow exceptions thrown in cmd handlers to be propagated to the calling module
This allows the caller to handle certain error conditions more gracefully (and could be extended for shutdown handling during cmd callc in the future as well)
A module could handle these new exceptions in the following way:
HandlerExceptionsandCmdTimeoutinherit fromCmdErrorso a caller could also just catch this.(naming still up for debate)