Bob Lail
a86adbbb25
* feat: Allow Kong to exit with semantic exit codes At Block, we've instrumented a number of commandline tools and set SLOs on some tools' reliability. To do that effectively, we had to partition usage errors from reliability issues. We looked at [prior art](https://github.com/square/exit?tab=readme-ov-file#reserved-codes-and-prior-art) and, taking inspiration from HTTP, defined [a set of semantic exit codes](https://github.com/square/exit?tab=readme-ov-file#about) in ranges: 80-99 for user errors, 100-119 for system errors. We've been wrapping errors in `exit.Error` at whatever level of the stack can tell which class an error is and unwrapping them at exit (`os.Exit(exit.FromError(err))`). This adds support for semantic exit codes to Kong, to `FatalIfErrorf`, which is used internally by `kong.Parse` and often used in Kong applications. * feat: Exit 80 (Usage Error) when usage is syntactically or semantically invalid * refactor: Always exit 80 (Usage Error) on a `ParseError` but don't wrap errors from hooks in `ParseError`
33 lines
832 B
Go
33 lines
832 B
Go
package kong
|
|
|
|
import "errors"
|
|
|
|
const (
|
|
exitOk = 0
|
|
exitNotOk = 1
|
|
|
|
// Semantic exit codes from https://github.com/square/exit?tab=readme-ov-file#about
|
|
exitUsageError = 80
|
|
)
|
|
|
|
// ExitCoder is an interface that may be implemented by an error value to
|
|
// provide an integer exit code. The method ExitCode should return an integer
|
|
// that is intended to be used as the exit code for the application.
|
|
type ExitCoder interface {
|
|
ExitCode() int
|
|
}
|
|
|
|
// exitCodeFromError returns the exit code for the given error.
|
|
// If err implements the exitCoder interface, the ExitCode method is called.
|
|
// Otherwise, exitCodeFromError returns 0 if err is nil, and 1 if it is not.
|
|
func exitCodeFromError(err error) int {
|
|
var e ExitCoder
|
|
if errors.As(err, &e) {
|
|
return e.ExitCode()
|
|
} else if err == nil {
|
|
return exitOk
|
|
}
|
|
|
|
return exitNotOk
|
|
}
|