feat(core): initial implementation — launcher, logz, xerrors, valid
Introduces `code.nochebuena.dev/einherjar/core` — the foundational implementation module of the Einherjar framework. Provides four sub-packages that together cover every service's baseline needs: lifecycle management, structured logging, typed errors, and struct validation. - launcher: Launcher interface — three-phase managed lifecycle (OnInit → BeforeStart hooks → OnStart → OS signal wait → OnStop in reverse). Accepts lifecycle.Component and logging.Logger from contracts. Prints an ASCII art banner at startup (EINHERJAR_BANNER=off to suppress). Banner includes core version via runtime/debug.ReadBuildInfo() and a loaded-module list for every registered component that implements observability.Identifiable. Config struct with EINHERJAR_COMPONENT_STOP_TIMEOUT env tag (caarlos0/env syntax, default 15s). - logz: Logger implementation backed by log/slog. Returns contracts/logging.Logger. Detects errs.CodedError and errs.ContextualError (from contracts/errs) to enrich log records automatically — replaces the private duck-typed bridge from micro-lib. Context helpers: WithRequestID, WithField, WithFields, GetRequestID. Config struct with EINHERJAR_LOG_LEVEL (default INFO) and EINHERJAR_LOG_JSON (default false) env tags (caarlos0/env syntax); programmatic-only fields StaticArgs and Writer carry no tags. - xerrors: Typed error codes with context enrichment. Complete gRPC canonical set (16 codes) plus HTTP 410 ErrGone. Adds ErrOutOfRange, ErrAborted, ErrDataLoss over micro-lib. One convenience constructor per code. *Err declares compile-time satisfaction of errs.CodedError and errs.ContextualError. - valid: Struct validation wrapping go-playground/validator/v10. Validator interface + MessageProvider interface with full built-in tag coverage (~150 tags) in both DefaultMessages (English) and SpanishMessages (Spanish). Backend fully hidden; returns *xerrors.Err with ErrInvalidInput or ErrInternal. FieldLevel interface abstracts the backend's field-level access for custom validators. WithCustomValidator registers custom validation tags at construction time; OverrideProvider chains a tag→handler map with a fallback MessageProvider for custom tag messages without re-implementing built-ins. Compliance test enforces CT-6 (at most one exported TypeSpec per file via AST) and verifies behavioural correctness of all four sub-packages, including custom validator registration and OverrideProvider composition. Compile-time var _ assertions prove interface satisfaction. docs: ADR-001 (core module composition), ADR-002 (logz contracts/errs adoption), ADR-003 (Config naming convention and caarlos0/env tag standard)
This commit is contained in:
124
xerrors/code.go
Normal file
124
xerrors/code.go
Normal file
@@ -0,0 +1,124 @@
|
||||
package xerrors
|
||||
|
||||
// Code is the machine-readable error category.
|
||||
// Wire values are stable across versions and are identical to gRPC status code
|
||||
// names. HTTP mapping is the responsibility of the transport layer, not this package.
|
||||
type Code string
|
||||
|
||||
const (
|
||||
// ErrInvalidInput indicates the request contains malformed or invalid data.
|
||||
// HTTP 400 / gRPC INVALID_ARGUMENT.
|
||||
ErrInvalidInput Code = "INVALID_ARGUMENT"
|
||||
|
||||
// ErrOutOfRange indicates a parameter or index exceeds the valid bounds.
|
||||
// Use when the value itself is well-formed but falls outside accepted limits
|
||||
// (e.g. page number past the last page, offset past end of file).
|
||||
// HTTP 400 / gRPC OUT_OF_RANGE.
|
||||
ErrOutOfRange Code = "OUT_OF_RANGE"
|
||||
|
||||
// ErrUnauthorized indicates the request lacks valid authentication credentials.
|
||||
// HTTP 401 / gRPC UNAUTHENTICATED.
|
||||
ErrUnauthorized Code = "UNAUTHENTICATED"
|
||||
|
||||
// ErrPermissionDenied indicates the authenticated caller lacks permission for
|
||||
// the operation. Authentication is not the issue.
|
||||
// HTTP 403 / gRPC PERMISSION_DENIED.
|
||||
ErrPermissionDenied Code = "PERMISSION_DENIED"
|
||||
|
||||
// ErrNotFound indicates the requested resource does not exist.
|
||||
// HTTP 404 / gRPC NOT_FOUND.
|
||||
ErrNotFound Code = "NOT_FOUND"
|
||||
|
||||
// ErrAlreadyExists indicates a resource with the same identifier already exists.
|
||||
// Use for creation conflicts (e.g. duplicate email on sign-up).
|
||||
// HTTP 409 / gRPC ALREADY_EXISTS.
|
||||
ErrAlreadyExists Code = "ALREADY_EXISTS"
|
||||
|
||||
// ErrAborted indicates the operation was aborted due to a concurrent modification
|
||||
// or transaction conflict. Unlike ErrAlreadyExists (creation conflict) and
|
||||
// ErrPreconditionFailed (business rule), this signals the caller may retry.
|
||||
// HTTP 409 / gRPC ABORTED.
|
||||
ErrAborted Code = "ABORTED"
|
||||
|
||||
// ErrGone indicates the resource existed but has been permanently removed.
|
||||
// Unlike ErrNotFound, this signals the caller should not retry.
|
||||
// HTTP 410 / non-standard gRPC extension.
|
||||
ErrGone Code = "GONE"
|
||||
|
||||
// ErrPreconditionFailed indicates a required business condition was not met.
|
||||
// The input is valid but a rule blocks the action (e.g. "cannot delete an
|
||||
// account with active subscriptions").
|
||||
// HTTP 412 / gRPC FAILED_PRECONDITION.
|
||||
ErrPreconditionFailed Code = "FAILED_PRECONDITION"
|
||||
|
||||
// ErrRateLimited indicates the caller has exceeded a rate limit or quota.
|
||||
// HTTP 429 / gRPC RESOURCE_EXHAUSTED.
|
||||
ErrRateLimited Code = "RESOURCE_EXHAUSTED"
|
||||
|
||||
// ErrCancelled indicates the operation was cancelled by the caller.
|
||||
// HTTP 499 / gRPC CANCELLED.
|
||||
ErrCancelled Code = "CANCELLED"
|
||||
|
||||
// ErrInternal indicates an unexpected server-side failure.
|
||||
// Use a more specific code when one applies.
|
||||
// HTTP 500 / gRPC INTERNAL.
|
||||
ErrInternal Code = "INTERNAL"
|
||||
|
||||
// ErrDataLoss indicates unrecoverable data loss or corruption.
|
||||
// Reserved for storage-layer integrity failures.
|
||||
// HTTP 500 / gRPC DATA_LOSS.
|
||||
ErrDataLoss Code = "DATA_LOSS"
|
||||
|
||||
// ErrNotImplemented indicates the requested operation has not been implemented.
|
||||
// HTTP 501 / gRPC UNIMPLEMENTED.
|
||||
ErrNotImplemented Code = "UNIMPLEMENTED"
|
||||
|
||||
// ErrUnavailable indicates the service is temporarily unable to handle requests.
|
||||
// HTTP 503 / gRPC UNAVAILABLE.
|
||||
ErrUnavailable Code = "UNAVAILABLE"
|
||||
|
||||
// ErrDeadlineExceeded indicates the operation timed out before completing.
|
||||
// HTTP 504 / gRPC DEADLINE_EXCEEDED.
|
||||
ErrDeadlineExceeded Code = "DEADLINE_EXCEEDED"
|
||||
)
|
||||
|
||||
// Description returns a human-readable description for the code.
|
||||
// Unknown codes return their raw string value.
|
||||
func (c Code) Description() string {
|
||||
switch c {
|
||||
case ErrInvalidInput:
|
||||
return "Invalid input provided"
|
||||
case ErrOutOfRange:
|
||||
return "Value out of valid range"
|
||||
case ErrUnauthorized:
|
||||
return "Authentication required"
|
||||
case ErrPermissionDenied:
|
||||
return "Insufficient permissions"
|
||||
case ErrNotFound:
|
||||
return "Resource not found"
|
||||
case ErrAlreadyExists:
|
||||
return "Resource already exists"
|
||||
case ErrAborted:
|
||||
return "Operation aborted due to concurrent modification"
|
||||
case ErrGone:
|
||||
return "Resource permanently deleted"
|
||||
case ErrPreconditionFailed:
|
||||
return "Precondition not met"
|
||||
case ErrRateLimited:
|
||||
return "Rate limit exceeded"
|
||||
case ErrCancelled:
|
||||
return "Request cancelled"
|
||||
case ErrInternal:
|
||||
return "Internal error"
|
||||
case ErrDataLoss:
|
||||
return "Unrecoverable data loss or corruption"
|
||||
case ErrNotImplemented:
|
||||
return "Not implemented"
|
||||
case ErrUnavailable:
|
||||
return "Service unavailable"
|
||||
case ErrDeadlineExceeded:
|
||||
return "Deadline exceeded"
|
||||
default:
|
||||
return string(c)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user