GRPC error codes, 3 new error types, auto detect context errors (#8)

[minor] added helpers for GRPC status codes and messages
[minor] introduced 3 new error types NotImplemented, ContextCanceled, ContextTimedout
[minor] context errors are automatically identified in error types
[patch] improved test coverage
[-]     updated benchmark results & version in README

Author: bnkamalesh

.github/workflows/go.yml

@@ -32,6 +32,6 @@ jobs:
           path-to-profile: covprofile
 
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v6
+        uses: golangci/golangci-lint-action@v8
         with:
-          version: v1.60
+          version: v2.1

README.md

@@ -7,7 +7,7 @@
 [![](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go#error-handling)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/creativecreature/sturdyc/blob/master/LICENSE)
 
-# Errors v1.0.0
+# Errors v1.3.1
 
 Errors package is a drop-in replacement of the built-in Go errors package. It lets you create errors of 11 different types,
 which should handle most of the use cases. Some of them are a bit too specific for web applications, but useful nonetheless.
@@ -219,30 +219,30 @@ And the `fmt.Println(err.Error())` generated output on stdout would be:
 /Users/username/go/src/errorscheck/main.go:28 /Users/username/go/src/errorscheck/main.go:20 sinking bar
 ```
 
-## Benchmark [2022-01-12]
+## Benchmark [2025-07-03]
 
-MacBook Pro (13-inch, 2020, Four Thunderbolt 3 ports), 32 GB 3733 MHz LPDDR4X
+Macbook Air 13-inch, M3, 2024, Memory: 24 GB
 
 ```bash
 $ go version
-go version go1.19.5 darwin/amd64
+go version go1.24.4 darwin/arm64
 
 $ go test -benchmem -bench .
 goos: darwin
-goarch: amd64
+goarch: arm64
 pkg: github.com/naughtygopher/errors
-cpu: Intel(R) Core(TM) i7-1068NG7 CPU @ 2.30GHz
-Benchmark_Internal-8                            	 1526194	       748.8 ns/op	    1104 B/op	       2 allocs/op
-Benchmark_Internalf-8                           	 1281465	       944.0 ns/op	    1128 B/op	       3 allocs/op
-Benchmark_InternalErr-8                         	 1494351	       806.7 ns/op	    1104 B/op	       2 allocs/op
-Benchmark_InternalGetError-8                    	  981162	      1189 ns/op	    1528 B/op	       6 allocs/op
-Benchmark_InternalGetErrorWithNestedError-8     	  896322	      1267 ns/op	    1544 B/op	       6 allocs/op
-Benchmark_InternalGetMessage-8                  	 1492812	       804.2 ns/op	    1104 B/op	       2 allocs/op
-Benchmark_InternalGetMessageWithNestedError-8   	 1362092	       886.3 ns/op	    1128 B/op	       3 allocs/op
-Benchmark_HTTPStatusCodeMessage-8               	27494096	        41.38 ns/op	      16 B/op	       1 allocs/op
-BenchmarkHasType-8                              	100000000	        10.50 ns/op	       0 B/op	       0 allocs/op
+cpu: Apple M3
+Benchmark_Internal-8                            	 3650916	       321.7 ns/op	    1104 B/op	       2 allocs/op
+Benchmark_Internalf-8                           	 3155463	       378.9 ns/op	    1128 B/op	       3 allocs/op
+Benchmark_InternalErr-8                         	 3866085	       312.2 ns/op	    1104 B/op	       2 allocs/op
+Benchmark_InternalGetError-8                    	 1983544	       608.0 ns/op	    1576 B/op	       6 allocs/op
+Benchmark_InternalGetErrorWithNestedError-8     	 2419369	       497.8 ns/op	    1592 B/op	       6 allocs/op
+Benchmark_InternalGetMessage-8                  	 3815074	       316.1 ns/op	    1104 B/op	       2 allocs/op
+Benchmark_InternalGetMessageWithNestedError-8   	 3470449	       342.2 ns/op	    1128 B/op	       3 allocs/op
+Benchmark_HTTPStatusCodeMessage-8               	40540940	        29.12 ns/op	      16 B/op	       1 allocs/op
+BenchmarkHasType-8                              	100000000	        11.44 ns/op	       0 B/op	       0 allocs/op
 PASS
-ok  	github.com/naughtygopher/errors	15.006s
+ok  	github.com/naughtygopher/errors	13.805s
 ```
 
 ## Contributing

errors.go

@@ -5,7 +5,6 @@ import (
 	"bytes"
 	"fmt"
 	"io"
-	"net/http"
 	"runtime"
 	"strconv"
 	"strings"
@@ -42,6 +41,15 @@ const (
 	TypeSubscriptionExpired
 	// TypeDownstreamDependencyTimedout is error type for when a request to a downstream dependent service times out
 	TypeDownstreamDependencyTimedout
+	// TypeNotImplemented is error type for when the requested function cannot be fullfilled because of incapability
+	TypeNotImplemented
+	// TypeContextTimedout is error type for when the Go context has timed out
+	TypeContextTimedout
+	// TypeContextCancelled is error type for when the Go context has been cancelled
+	TypeContextCancelled
+)
+
+const (
 
 	// DefaultMessage is the default user friendly message
 	DefaultMessage = "unknown error occurred"
@@ -164,54 +172,11 @@ func (e *Error) Is(err error) bool {
 	return o == e
 }
 
-// HTTPStatusCode is a convenience method used to get the appropriate HTTP response status code for the respective error type
+// Deprecated: HTTPStatusCode is a convenience method used to get the appropriate
+// HTTP response status code for the respective error type.
+// deprecated to free the Error type from protocol specific features
 func (e *Error) HTTPStatusCode() int {
-	status := http.StatusInternalServerError
-	switch e.eType {
-	case TypeValidation:
-		{
-			status = http.StatusUnprocessableEntity
-		}
-	case TypeInputBody:
-		{
-			status = http.StatusBadRequest
-		}
-
-	case TypeDuplicate:
-		{
-			status = http.StatusConflict
-		}
-
-	case TypeUnauthenticated:
-		{
-			status = http.StatusUnauthorized
-		}
-	case TypeUnauthorized:
-		{
-			status = http.StatusForbidden
-		}
-
-	case TypeEmpty:
-		{
-			status = http.StatusGone
-		}
-
-	case TypeNotFound:
-		{
-			status = http.StatusNotFound
-
-		}
-	case TypeMaximumAttempts:
-		{
-			status = http.StatusTooManyRequests
-		}
-	case TypeSubscriptionExpired:
-		{
-			status = http.StatusPaymentRequired
-		}
-	}
-
-	return status
+	return httpStatusCode(e.eType)
 }
 
 // Type returns the error type as integer
@@ -339,14 +304,14 @@ func New(msg string) *Error {
 	return newerr(nil, msg, defaultErrType, 3)
 }
 
-func Newf(fromat string, args ...interface{}) *Error {
+func Newf(fromat string, args ...any) *Error {
 	return newerrf(nil, defaultErrType, 4, fromat, args...)
 }
 
 // Errorf is a convenience method to create a new instance of Error with formatted message
 // Important: %w directive is not supported, use fmt.Errorf if you're using the %w directive or
 // use Wrap/Wrapf to wrap an error.
-func Errorf(fromat string, args ...interface{}) *Error {
+func Errorf(fromat string, args ...any) *Error {
 	return newerrf(nil, defaultErrType, 4, fromat, args...)
 }
 

go.mod

@@ -1,3 +1,9 @@
 module github.com/naughtygopher/errors
 
-go 1.19
+go 1.23.0
+
+toolchain go1.24.4
+
+require google.golang.org/grpc v1.73.0
+
+require golang.org/x/sys v0.33.0 // indirect

go.sum

@@ -0,0 +1,10 @@
+github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
+github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
+golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
+golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463 h1:e0AIkUUhxyBKh6ssZNrAMeqhA7RKUj42346d1y02i2g=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A=
+google.golang.org/grpc v1.73.0 h1:VIWSmpI2MegBtTuFt5/JWy2oXxtjJ/e89Z70ImfD2ok=
+google.golang.org/grpc v1.73.0/go.mod h1:50sbHOUqWoCQGI8V2HQLJM0B+LMlIUjNSZmow7EVBQc=
+google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY=
+google.golang.org/protobuf v1.36.6/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY=

grpc.go

@@ -0,0 +1,100 @@
+package errors
+
+import (
+	"google.golang.org/grpc/codes"
+)
+
+func grpcStatusCode(eT errType) codes.Code {
+	status := codes.Unknown
+	switch eT {
+	case TypeInternal:
+		{
+			status = codes.Internal
+		}
+	case TypeValidation, TypeInputBody:
+		{
+			status = codes.InvalidArgument
+		}
+	case TypeDuplicate:
+		{
+			status = codes.AlreadyExists
+		}
+	case TypeUnauthenticated:
+		{
+			status = codes.Unauthenticated
+		}
+	case TypeUnauthorized:
+		{
+			status = codes.PermissionDenied
+		}
+	case TypeEmpty, TypeNotFound:
+		{
+			status = codes.NotFound
+		}
+	case TypeMaximumAttempts:
+		{
+			status = codes.ResourceExhausted
+		}
+	case TypeSubscriptionExpired:
+		{
+			status = codes.Unavailable
+		}
+	case TypeNotImplemented:
+		{
+			status = codes.Unimplemented
+		}
+	case TypeContextTimedout, TypeDownstreamDependencyTimedout:
+		{
+			status = codes.DeadlineExceeded
+		}
+	case TypeContextCancelled:
+		{
+			status = codes.Canceled
+		}
+
+	}
+
+	return status
+}
+
+// GRPCStatusCodeMessage returns the appropriate GRPC status code, message, boolean for the error
+// the boolean value is true if the error was of type *Error, false otherwise.
+func GRPCStatusCodeMessage(err error) (codes.Code, string, bool) {
+	code, isErr := GRPCStatusCode(err)
+	msg, isErrMsg := Message(err)
+	if msg == "" {
+		msg = err.Error()
+	}
+	return code, msg, isErr && isErrMsg
+}
+
+// GRPCStatusCode returns appropriate GRPC response status code based on type of the error. The boolean
+// is 'true' if the provided error is of type *Err. If joined error, boolean is true if all joined errors
+// are of type *Error
+// In case of joined errors, it'll return the status code of the last *Error
+func GRPCStatusCode(err error) (codes.Code, bool) {
+	derr, _ := err.(*Error)
+	if derr != nil {
+		return grpcStatusCode(derr.Type()), true
+	}
+
+	// Since TypeInternal is the default returned by getErrType, it is ignored.
+	if et := getErrType(err); et != TypeInternal {
+		return grpcStatusCode(et), false
+	}
+
+	jerr, _ := err.(*joinError)
+	if jerr != nil {
+		elen := len(jerr.errs)
+		isErr := true
+		for i := elen - 1; i >= 0; i-- {
+			code, isE := GRPCStatusCode(jerr.errs[i])
+			isErr = isE && isErr
+			if isE {
+				return code, isErr
+			}
+		}
+	}
+
+	return codes.Unknown, false
+}