mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-12 07:47:32 +00:00
chore(database): enhance error handling (#10279)
This PR enhances error handling in the database package by introducing custom error types that wrap dialect-specific errors, providing better abstraction and context for error handling across the application. * Introduces standardized custom error types for common database errors (no rows found, integrity violations, etc.) * Wraps all PostgreSQL-specific errors at the dialect layer to provide consistent error handling # Which Problems Are Solved The database package didn't wrap the errors from dialect specifc packages. # How the Problems Are Solved Custom errors were added which wrap the dialect specifc errors. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
227
backend/v3/storage/database/errors.go
Normal file
227
backend/v3/storage/database/errors.go
Normal file
@@ -0,0 +1,227 @@
|
||||
package database
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// NoRowFoundError is returned when QueryRow does not find any row.
|
||||
// It wraps the dialect specific original error to provide more context.
|
||||
type NoRowFoundError struct {
|
||||
original error
|
||||
}
|
||||
|
||||
func NewNoRowFoundError(original error) error {
|
||||
return &NoRowFoundError{
|
||||
original: original,
|
||||
}
|
||||
}
|
||||
|
||||
func (e *NoRowFoundError) Error() string {
|
||||
return "no row found"
|
||||
}
|
||||
|
||||
func (e *NoRowFoundError) Is(target error) bool {
|
||||
_, ok := target.(*NoRowFoundError)
|
||||
return ok
|
||||
}
|
||||
|
||||
func (e *NoRowFoundError) Unwrap() error {
|
||||
return e.original
|
||||
}
|
||||
|
||||
// MultipleRowsFoundError is returned when QueryRow finds multiple rows.
|
||||
// It wraps the dialect specific original error to provide more context.
|
||||
type MultipleRowsFoundError struct {
|
||||
original error
|
||||
count int
|
||||
}
|
||||
|
||||
func NewMultipleRowsFoundError(original error, count int) error {
|
||||
return &MultipleRowsFoundError{
|
||||
original: original,
|
||||
count: count,
|
||||
}
|
||||
}
|
||||
|
||||
func (e *MultipleRowsFoundError) Error() string {
|
||||
return fmt.Sprintf("multiple rows found: %d", e.count)
|
||||
}
|
||||
|
||||
func (e *MultipleRowsFoundError) Is(target error) bool {
|
||||
_, ok := target.(*MultipleRowsFoundError)
|
||||
return ok
|
||||
}
|
||||
|
||||
func (e *MultipleRowsFoundError) Unwrap() error {
|
||||
return e.original
|
||||
}
|
||||
|
||||
type IntegrityType string
|
||||
|
||||
const (
|
||||
IntegrityTypeCheck IntegrityType = "check"
|
||||
IntegrityTypeUnique IntegrityType = "unique"
|
||||
IntegrityTypeForeign IntegrityType = "foreign"
|
||||
IntegrityTypeNotNull IntegrityType = "not null"
|
||||
)
|
||||
|
||||
// IntegrityViolationError represents a generic integrity violation error.
|
||||
// It wraps the dialect specific original error to provide more context.
|
||||
type IntegrityViolationError struct {
|
||||
integrityType IntegrityType
|
||||
table string
|
||||
constraint string
|
||||
original error
|
||||
}
|
||||
|
||||
func NewIntegrityViolationError(typ IntegrityType, table, constraint string, original error) error {
|
||||
return &IntegrityViolationError{
|
||||
integrityType: typ,
|
||||
table: table,
|
||||
constraint: constraint,
|
||||
original: original,
|
||||
}
|
||||
}
|
||||
|
||||
func (e *IntegrityViolationError) Error() string {
|
||||
return fmt.Sprintf("integrity violation of type %q on %q (constraint: %q): %v", e.integrityType, e.table, e.constraint, e.original)
|
||||
}
|
||||
|
||||
func (e *IntegrityViolationError) Is(target error) bool {
|
||||
_, ok := target.(*IntegrityViolationError)
|
||||
return ok
|
||||
}
|
||||
|
||||
// CheckError is returned when a check constraint fails.
|
||||
// It wraps the [IntegrityViolationError] to provide more context.
|
||||
// It is used to indicate that a check constraint was violated during an insert or update operation.
|
||||
type CheckError struct {
|
||||
IntegrityViolationError
|
||||
}
|
||||
|
||||
func NewCheckError(table, constraint string, original error) error {
|
||||
return &CheckError{
|
||||
IntegrityViolationError: IntegrityViolationError{
|
||||
integrityType: IntegrityTypeCheck,
|
||||
table: table,
|
||||
constraint: constraint,
|
||||
original: original,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (e *CheckError) Is(target error) bool {
|
||||
_, ok := target.(*CheckError)
|
||||
return ok
|
||||
}
|
||||
|
||||
func (e *CheckError) Unwrap() error {
|
||||
return &e.IntegrityViolationError
|
||||
}
|
||||
|
||||
// UniqueError is returned when a unique constraint fails.
|
||||
// It wraps the [IntegrityViolationError] to provide more context.
|
||||
// It is used to indicate that a unique constraint was violated during an insert or update operation.
|
||||
type UniqueError struct {
|
||||
IntegrityViolationError
|
||||
}
|
||||
|
||||
func NewUniqueError(table, constraint string, original error) error {
|
||||
return &UniqueError{
|
||||
IntegrityViolationError: IntegrityViolationError{
|
||||
integrityType: IntegrityTypeUnique,
|
||||
table: table,
|
||||
constraint: constraint,
|
||||
original: original,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (e *UniqueError) Is(target error) bool {
|
||||
_, ok := target.(*UniqueError)
|
||||
return ok
|
||||
}
|
||||
|
||||
func (e *UniqueError) Unwrap() error {
|
||||
return &e.IntegrityViolationError
|
||||
}
|
||||
|
||||
// ForeignKeyError is returned when a foreign key constraint fails.
|
||||
// It wraps the [IntegrityViolationError] to provide more context.
|
||||
// It is used to indicate that a foreign key constraint was violated during an insert or update operation
|
||||
type ForeignKeyError struct {
|
||||
IntegrityViolationError
|
||||
}
|
||||
|
||||
func NewForeignKeyError(table, constraint string, original error) error {
|
||||
return &ForeignKeyError{
|
||||
IntegrityViolationError: IntegrityViolationError{
|
||||
integrityType: IntegrityTypeForeign,
|
||||
table: table,
|
||||
constraint: constraint,
|
||||
original: original,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (e *ForeignKeyError) Is(target error) bool {
|
||||
_, ok := target.(*ForeignKeyError)
|
||||
return ok
|
||||
}
|
||||
|
||||
func (e *ForeignKeyError) Unwrap() error {
|
||||
return &e.IntegrityViolationError
|
||||
}
|
||||
|
||||
// NotNullError is returned when a not null constraint fails.
|
||||
// It wraps the [IntegrityViolationError] to provide more context.
|
||||
// It is used to indicate that a not null constraint was violated during an insert or update operation.
|
||||
type NotNullError struct {
|
||||
IntegrityViolationError
|
||||
}
|
||||
|
||||
func NewNotNullError(table, constraint string, original error) error {
|
||||
return &NotNullError{
|
||||
IntegrityViolationError: IntegrityViolationError{
|
||||
integrityType: IntegrityTypeNotNull,
|
||||
table: table,
|
||||
constraint: constraint,
|
||||
original: original,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (e *NotNullError) Is(target error) bool {
|
||||
_, ok := target.(*NotNullError)
|
||||
return ok
|
||||
}
|
||||
|
||||
func (e *NotNullError) Unwrap() error {
|
||||
return &e.IntegrityViolationError
|
||||
}
|
||||
|
||||
// UnknownError is returned when an unknown error occurs.
|
||||
// It wraps the dialect specific original error to provide more context.
|
||||
// It is used to indicate that an error occurred that does not fit into any of the other categories.
|
||||
type UnknownError struct {
|
||||
original error
|
||||
}
|
||||
|
||||
func NewUnknownError(original error) error {
|
||||
return &UnknownError{
|
||||
original: original,
|
||||
}
|
||||
}
|
||||
|
||||
func (e *UnknownError) Error() string {
|
||||
return fmt.Sprintf("unknown database error: %v", e.original)
|
||||
}
|
||||
|
||||
func (e *UnknownError) Is(target error) bool {
|
||||
_, ok := target.(*UnknownError)
|
||||
return ok
|
||||
}
|
||||
|
||||
func (e *UnknownError) Unwrap() error {
|
||||
return e.original
|
||||
}
|
Reference in New Issue
Block a user