Documentation
¶
Overview ¶
Package apperr turns internal errors into stable, reportable numeric codes.
A service wraps an internal cause with Coded(code, cause). The code travels with the error through the normal error chain, so errors.Is and errors.As keep working, and Code(err) recovers the nearest code at any boundary. At the edge, a Registry the consumer builds at startup maps each code to a sanitized, client-safe message: the caller learns a code they can quote in a bug report, never the raw internal detail.
The package is dependency-free: it imports no logging, tracing, or third-party package, only the standard library. Observability is pluggable through two small interfaces, Recorder and Logger, wired with WithRecorder and WithLogger and defaulting to no-ops. Bring any stack -- log/slog, OpenTelemetry, zap -- by writing a few-line adapter that implements them (see the examples). Nothing is bundled, so a consumer's go.mod stays free of any dependency they did not choose.
Codes are the consumer's own namespace. The first-digit-of-code convention (WithService) is one supported way to let each service own a code prefix so a code is easy to attribute at a glance; it is optional.
Index ¶
- func Code(err error) (code int, ok bool)
- func Coded(code int, cause error) error
- type Entry
- type Logger
- type Option
- type Recorder
- type Registry
- func (r *Registry) Describe(code int) (Entry, bool)
- func (r *Registry) Markdown() string
- func (r *Registry) Message(code int) string
- func (r *Registry) Present(err error, defaultCode int) (clientMsg string, code int)
- func (r *Registry) PresentContext(ctx context.Context, err error, defaultCode int) (clientMsg string, code int)
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Code ¶
Code returns the code carried by err, walking the error chain with errors.As and returning the nearest coded error's code. It reports (0, false) when err is nil or carries no code, so a caller can distinguish "no code" from a legitimately zero code.
Example ¶
ExampleCode recovers the stable code from a wrapped internal error.
package main
import (
"errors"
"fmt"
apperr "github.com/Bugs5382/go-apperr"
)
func main() {
err := apperr.Coded(1001, errors.New("database unavailable"))
code, ok := apperr.Code(err)
fmt.Println(code, ok)
}
Output: 1001 true
func Coded ¶
Coded wraps cause with a stable numeric code. The returned error's Unwrap returns cause, so errors.Is and errors.As traverse to it unchanged; the code rides alongside and is recovered with Code. A nil cause is allowed -- the result is a bare coded marker whose Error reports only the code.
Types ¶
type Entry ¶
Entry describes one code the consumer registers. Title is a short area/label for the code; Cause is a one-line internal description. Both are for the consumer's own error-codes documentation (see Markdown) and are never shown to a client -- only the code and the rendered message template are.
type Logger ¶
Logger is the neutral logging sink the observability-aware present path calls. An implementation emits one structured line carrying the code and, when the backend correlates traces, the trace_id. As with Recorder, this package ships only a no-op; a small custom shim over the consumer's logger (log/slog, zap, etc.) provides the real thing.
type Option ¶
type Option func(*Registry)
Option configures a Registry at construction. All options are optional; the zero configuration is a plain code table with the default message template and no-op observability.
func WithLogger ¶
WithLogger installs a logging sink invoked by PresentContext. A nil Logger is ignored, leaving the no-op default in place.
func WithMessageTemplate ¶
WithMessageTemplate overrides the sanitized client message. tmpl is a fmt-style template that receives the code (include a %d), e.g. "Something went wrong (ref %d)". The default is "Code %d: Internal Error".
func WithRecorder ¶
WithRecorder installs a tracing sink invoked by PresentContext. A nil Recorder is ignored, leaving the no-op default in place.
func WithService ¶
WithService validates that every registered code's first digit equals digit. It expresses the "each service owns a code prefix" convention: an app claims a leading digit so any code it emits is attributable to it at a glance.
type Recorder ¶
Recorder is the neutral tracing sink the observability-aware present path calls. An implementation records the resolved code (and, if it wants, the error) on the active span or whatever backend it wraps. This package ships only a no-op; a real Recorder is a few lines of the consumer's own code over their tracer of choice (OpenTelemetry, etc.) -- see the examples.
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry is the consumer's own set of codes plus the presentation and observability policy around them. Build one at startup with NewRegistry and share it; it is read-only afterward and safe for concurrent use.
func NewRegistry ¶
NewRegistry builds a Registry from the consumer's codes and options. It fails on a duplicate code, and -- when WithService is set -- on any code whose first digit does not match the claimed service digit.
func (*Registry) Describe ¶
Describe returns the registered Entry for code and whether it was found.
func (*Registry) Markdown ¶
Markdown renders the registry as a "Code | Area | Cause" table, sorted by code so the output is deterministic. It is meant to be written into a consumer's error-codes reference document.
Example ¶
ExampleRegistry_Markdown renders the registry as a docs table, sorted by code.
package main
import (
"fmt"
apperr "github.com/Bugs5382/go-apperr"
)
func main() {
reg, err := apperr.NewRegistry([]apperr.Entry{
{Code: 1002, Title: "upstream", Cause: "upstream timeout"},
{Code: 1001, Title: "database", Cause: "database unavailable"},
})
if err != nil {
panic(err)
}
fmt.Print(reg.Markdown())
}
Output: | Code | Area | Cause | | --- | --- | --- | | 1001 | database | database unavailable | | 1002 | upstream | upstream timeout |
func (*Registry) Message ¶
Message renders the sanitized client message for code via the template. It works for any code, registered or not, so an unexpected code still yields a safe, quotable message rather than leaking internals.
func (*Registry) Present ¶
Present resolves the code from err (the nearest coded error) or falls back to defaultCode when err carries none, and returns the sanitized client message and the resolved code. It has no side effects; use PresentContext to also drive the Recorder and Logger.
Example ¶
ExampleRegistry_Present turns an internal error into a sanitized, quotable client message and its code.
package main
import (
"errors"
"fmt"
apperr "github.com/Bugs5382/go-apperr"
)
func main() {
reg, err := apperr.NewRegistry([]apperr.Entry{
{Code: 1002, Title: "upstream", Cause: "upstream timeout"},
})
if err != nil {
panic(err)
}
msg, code := reg.Present(apperr.Coded(1002, errors.New("i/o timeout")), 1000)
fmt.Printf("%s | %d\n", msg, code)
}
Output: Code 1002: Internal Error | 1002
func (*Registry) PresentContext ¶
func (r *Registry) PresentContext(ctx context.Context, err error, defaultCode int) (clientMsg string, code int)
PresentContext is Present plus observability: after resolving the code it calls the configured Recorder and Logger with ctx, the code, and err. With the default no-op sinks it behaves exactly like Present.
Directories
¶
| Path | Synopsis |
|---|---|
|
apperrgrpc
module
|
|
|
examples
|
|
|
coded
command
Command coded shows the core primitives: wrap an internal cause with a stable code, then recover the code at a boundary while errors.Is still traverses to the original cause.
|
Command coded shows the core primitives: wrap an internal cause with a stable code, then recover the code at a boundary while errors.Is still traverses to the original cause. |
|
custom
command
Command custom shows "bring your own" observability.
|
Command custom shows "bring your own" observability. |
|
markdown
command
Command markdown renders a registry as a Markdown table, the kind you commit as an error-codes reference.
|
Command markdown renders a registry as a Markdown table, the kind you commit as an error-codes reference. |
|
registry
command
Command registry shows a consumer registering its own codes and turning internal errors into sanitized, quotable client messages.
|
Command registry shows a consumer registering its own codes and turning internal errors into sanitized, quotable client messages. |