Skip to content

feat: Error sanitization for user-facing services #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gokutheengineer wants to merge 11 commits into
base: main
Choose a base branch
from
Open

feat: Error sanitization for user-facing services #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3f6b218
feat
gokutheengineer Jan 16, 2026
9371b93
Merge branch 'main' into gokhan/concat-error-msgs
gokutheengineer Jan 26, 2026
8e5a8bd
Merge branch 'main' into gokhan/concat-error-msgs
gokutheengineer Jan 27, 2026
8f2604e
fix tests
gokutheengineer Jan 27, 2026
f701691
fix test timeout period
gokutheengineer Jan 27, 2026
0f870c1
fix
gokutheengineer Jan 27, 2026
0f8fe03
Merge branch 'main' into gokhan/concat-error-msgs
gokutheengineer Jan 27, 2026
05297aa
fix: test
gokutheengineer Jan 28, 2026
92d8fb0
Merge branch 'main' into gokhan/concat-error-msgs
gokutheengineer Jan 28, 2026
af69431
Merge branch 'main' into gokhan/concat-error-msgs
gokutheengineer Jan 29, 2026
49ac4fe
Merge branch 'main' into gokhan/concat-error-msgs
gokutheengineer Feb 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions errors/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,87 @@ func WrapGRPC(err error) error {
}
}

// UserMessage returns a concise, user-facing error message without wrapped error chains or data.
// It is intended for external surfaces (HTTP/gRPC) where internal details should not be exposed.
func UserMessage(err error) string {
if err == nil {
return ""
}

if isGRPCWrappedError(err) {
err = UnwrapGRPC(err)
}

var tErr *Error
if errors.As(err, &tErr) && tErr != nil {
return fmt.Sprintf("%s (%d): %s", tErr.code.String(), tErr.code, tErr.message)
}

var tProtoErr *TError
if errors.As(err, &tProtoErr) && tProtoErr != nil {
return fmt.Sprintf("%s (%d): %s", tProtoErr.Code.String(), tProtoErr.Code, tProtoErr.Message)
}

return "internal error"
}

// PublicError returns a sanitized Error suitable for returning to external callers.
// It strips wrapped errors, file/line/function details, and error data.
func PublicError(err error) *Error {
if err == nil {
return nil
}

if isGRPCWrappedError(err) {
err = UnwrapGRPC(err)
}

var tErr *Error
if errors.As(err, &tErr) && tErr != nil {
return &Error{
code: tErr.code,
message: tErr.message,
}
}

var tProtoErr *TError
if errors.As(err, &tProtoErr) && tProtoErr != nil {
return &Error{
code: tProtoErr.Code,
message: tProtoErr.Message,
}
}

return &Error{
code: ERR_ERROR,
message: "internal error",
}
}

// WrapGRPCPublic wraps an error for gRPC without exposing internal details.
func WrapGRPCPublic(err error) error {
if err == nil {
return nil
}

publicErr := PublicError(err)
if publicErr == nil {
return nil
}

st := status.New(ErrorCodeToGRPCCode(publicErr.code), publicErr.message)
return st.Err()
}

// WrapPublic converts an error into a TError without wrapped details for external use.
func WrapPublic(err error) *TError {
if err == nil {
return nil
}

return Wrap(PublicError(err))
}

// UnwrapGRPC unwraps a gRPC error and returns the underlying Error type.
func UnwrapGRPC(err error) *Error {
if err == nil {
Expand Down
Loading
Loading