Create execution and state developement guidelines (error handling, return values)

[ryan-lane]

We've been having a difficult time coming to a proper agreement on how our execution modules should handle return values and exceptions. If we allow exceptions to propagate, then the state modules will catch the exceptions and display them in the failed states, which is really helpful, but it also means that when you call the execution module from another module, an undocumented and unknown exception will propogate there as well. In some modules we always return a tuple with the return value and an error message, so that there's a consistent return value and the message can still be propagated.

There's pros and cons for each approach, but if would be nice if there was upstream guidelines so that we can have a known consistent behavior across modules.

[jfindlay]

@ryan-lane, although this may not be directly related to your issue, there is an open issue for normalizing exit codes in #18510 for beryllium.

[rallytime]

Yes, it would be good to define a "best-practices" here. Thanks @ryan-lane.

[arnisoph]

+1

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

[damon-atkins]

.

[stale]

Thank you for updating this issue. It is no longer marked as stale.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.