chore: fixing linter errors

dr4hcu5-jan · dr4hcu5-jan · commit 004996f662bd · 2025-03-11T11:00:37.000+01:00
diff --git a/internal/error-handler/consts.go b/internal/error-handler/consts.go
@@ -2,4 +2,4 @@ package errorHandler
 
 import "github.com/thanhpk/randstr"
 
-var ErrorChannelName = randstr.Hex(16)
+var ErrorChannelName = randstr.Hex(16) //nolint:mnd
diff --git a/middleware/gin/error-handler/handler_test.go b/middleware/gin/error-handler/handler_test.go
@@ -8,6 +8,7 @@ import (
 
 	"github.com/gin-gonic/gin"
 	"github.com/stretchr/testify/assert"
+
 	errorHandler "github.com/wisdom-oss/common-go/v3/middleware/gin/error-handler"
 )
 
diff --git a/middleware/gin/jwt/jwt_test.go b/middleware/gin/jwt/jwt_test.go
@@ -1,3 +1,4 @@
+// nolint
 package jwt
 
 import (
@@ -23,12 +24,12 @@ func Test(t *testing.T) {
 	key, err = jwk.FromRaw(jwkTestingKey)
 	assert.NoError(t, err)
 
-	jwk.AssignKeyID(key)
-	key.Set(jwk.KeyUsageKey, "sig")
-	key.Set(jwk.AlgorithmKey, jwa.HS256)
+	jwk.AssignKeyID(key)                 //nolint:errcheck
+	key.Set(jwk.KeyUsageKey, "sig")      //nolint:errcheck
+	key.Set(jwk.AlgorithmKey, jwa.HS256) //nolint:errcheck
 
 	keySet = jwk.NewSet()
-	keySet.AddKey(key)
+	keySet.AddKey(key) //nolint:errcheck
 
 	v = &Validator{}
 	err = v.Configure("test", keySet, nil)
diff --git a/middleware/gin/jwt/requirer.go b/middleware/gin/jwt/requirer.go
@@ -5,6 +5,7 @@ import (
 	"slices"
 
 	"github.com/gin-gonic/gin"
+
 	"github.com/wisdom-oss/common-go/v3/internal/jwt"
 	"github.com/wisdom-oss/common-go/v3/types"
 )
diff --git a/middleware/gin/jwt/requirer_test.go b/middleware/gin/jwt/requirer_test.go
@@ -1,3 +1,4 @@
+// nolint
 package jwt
 
 import (
@@ -9,12 +10,13 @@ import (
 
 	"github.com/lestrrat-go/jwx/v2/jwa"
 	"github.com/lestrrat-go/jwx/v2/jwt"
-	jwt2 "github.com/lestrrat-go/jwx/v2/jwt"
 	"github.com/stretchr/testify/assert"
 	"github.com/thanhpk/randstr"
-	"github.com/wisdom-oss/common-go/v3/types"
+
+	jwt2 "github.com/lestrrat-go/jwx/v2/jwt"
 
 	internal "github.com/wisdom-oss/common-go/v3/internal/jwt"
+	"github.com/wisdom-oss/common-go/v3/types"
 )
 
 const scopePrefix = "testing"
diff --git a/middleware/gin/jwt/validator_test.go b/middleware/gin/jwt/validator_test.go
@@ -1,3 +1,4 @@
+// nolint
 package jwt
 
 import (
@@ -11,9 +12,11 @@ import (
 
 	"github.com/gin-gonic/gin"
 	"github.com/lestrrat-go/jwx/v2/jwa"
-	jwt2 "github.com/lestrrat-go/jwx/v2/jwt"
 	"github.com/stretchr/testify/assert"
 	"github.com/thanhpk/randstr"
+
+	jwt2 "github.com/lestrrat-go/jwx/v2/jwt"
+
 	"github.com/wisdom-oss/common-go/v3/internal/jwt"
 	"github.com/wisdom-oss/common-go/v3/types"
 )
diff --git a/middleware/gin/recoverer/recoverer.go b/middleware/gin/recoverer/recoverer.go
@@ -2,14 +2,16 @@ package recoverer
 
 import (
 	"fmt"
+	"net/http"
 
 	"github.com/gin-gonic/gin"
+
 	errorHandler "github.com/wisdom-oss/common-go/v3/middleware/stdlib/error-handler"
 )
 
 func RecoveryHandler(c *gin.Context, err any) {
 	response := errorHandler.Panic
 	response.Errors = []error{fmt.Errorf("%v", err)}
 	c.Header("Content-Type", "application/problem+json; charset=utf-8")
-	c.AbortWithStatusJSON(500, response)
+	c.AbortWithStatusJSON(http.StatusInternalServerError, response)
 }
diff --git a/middleware/stdlib/error-handler/errors.go b/middleware/stdlib/error-handler/errors.go
@@ -1,39 +1,40 @@
 package errorHandler
 
-import "github.com/wisdom-oss/common-go/v3/types"
+import (
+	"net/http"
+
+	"github.com/wisdom-oss/common-go/v3/types"
+)
 
 // Panic is the base types.ServiceError used if the ErrorHandler catches a panic
 // during the handling of a request.
 var Panic = &types.ServiceError{
 	Type:   "https://pkg.go.dev/builtin#panic",
-	Status: 500,
+	Status: http.StatusInternalServerError,
 	Title:  "Internal Panic",
 	Detail: "The service encountered a panic state during the handling of your request.",
 }
 
-// InternalError is the base types.ServiceError if the ErrorHandler only
-// received objects implementing the Error() interface and no other errors were
-// raised during the handling of the request
+// raised during the handling of the request.
 var InternalError = &types.ServiceError{
 	Type:   "https://www.rfc-editor.org/rfc/rfc9110#section-15.6.1",
-	Status: 500,
+	Status: http.StatusInternalServerError,
 	Title:  "Internal Server Error",
 	Detail: "The service encountered an internal error during the handling of your request",
 }
 
-// InvalidTypeProvided is used in the case that an unsupported type has been
-// passed to the ErrorHandler
+// passed to the ErrorHandler.
 var InvalidTypeProvided = &types.ServiceError{
 	Type:   "https://www.rfc-editor.org/rfc/rfc9110#section-16.2",
-	Status: 999,
+	Status: 999, //nolint:mnd
 	Title:  "Invalid Error Supplied",
 	Detail: "The content provided to the error handler is invalid",
 }
 
-// NotFound is an error used in the NotFoundError handler
+// NotFound is an error used in the NotFoundError handler.
 var NotFound = &types.ServiceError{
 	Type:   "https://www.rfc-editor.org/rfc/rfc9110#section-15.5.5",
-	Status: 404,
+	Status: http.StatusNotFound,
 	Title:  "Route Not Found",
-	Detail: "The requested route was not found. Please check your request and ensure that the route is correctly set up in the service",
+	Detail: "The requested route was not found. Please check your request and ensure that the route is correctly set up in the service", //nolint:lll
 }
diff --git a/middleware/stdlib/error-handler/handler.go b/middleware/stdlib/error-handler/handler.go
@@ -22,7 +22,7 @@ func Handler(next http.Handler) http.Handler {
 			for {
 				p := recover()
 				if p != nil {
-					if p == http.ErrAbortHandler {
+					if p == http.ErrAbortHandler { //nolint:errorlint
 						panic(p)
 					}
 					panics = append(panics, p)
diff --git a/middleware/stdlib/error-handler/handler_test.go b/middleware/stdlib/error-handler/handler_test.go
@@ -8,6 +8,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+
 	errorHandler "github.com/wisdom-oss/common-go/v3/middleware/stdlib/error-handler"
 	"github.com/wisdom-oss/common-go/v3/types"
 )
@@ -53,7 +54,7 @@ func _recover_panic(t *testing.T) {
 	r.ServeHTTP(rec, req)
 	res := rec.Result()
 
-	assert.Equal(t, int(expectedError.Status), res.StatusCode)
+	assert.Equal(t, int(expectedError.Status), res.StatusCode) //nolint:gosec
 
 	var receviedError types.ServiceError
 	err := json.NewDecoder(res.Body).Decode(&receviedError)
@@ -79,7 +80,7 @@ func _native_error(t *testing.T) {
 	r.ServeHTTP(rec, req)
 	res := rec.Result()
 
-	assert.Equal(t, int(expectedError.Status), res.StatusCode)
+	assert.Equal(t, int(expectedError.Status), res.StatusCode) //nolint:gosec
 
 	var receviedError types.ServiceError
 	err := json.NewDecoder(res.Body).Decode(&receviedError)
@@ -105,7 +106,7 @@ func _service_error(t *testing.T) {
 	r.ServeHTTP(rec, req)
 	res := rec.Result()
 
-	assert.Equal(t, int(expectedError.Status), res.StatusCode)
+	assert.Equal(t, int(expectedError.Status), res.StatusCode) //nolint:gosec
 
 	var receviedError types.ServiceError
 	err := json.NewDecoder(res.Body).Decode(&receviedError)
@@ -130,7 +131,7 @@ func _invalid_type(t *testing.T) {
 	r.ServeHTTP(rec, req)
 	res := rec.Result()
 
-	assert.Equal(t, int(expectedError.Status), res.StatusCode)
+	assert.Equal(t, int(expectedError.Status), res.StatusCode) //nolint:gosec
 
 	var receviedError types.ServiceError
 	err := json.NewDecoder(res.Body).Decode(&receviedError)
diff --git a/middleware/stdlib/jwt/validator_stdlib_test.go b/middleware/stdlib/jwt/validator_stdlib_test.go
@@ -1,3 +1,4 @@
+// nolint
 package jwt
 
 import (
@@ -10,9 +11,11 @@ import (
 
 	"github.com/lestrrat-go/jwx/v2/jwa"
 	"github.com/lestrrat-go/jwx/v2/jwk"
-	jwt2 "github.com/lestrrat-go/jwx/v2/jwt"
 	"github.com/stretchr/testify/assert"
 	"github.com/thanhpk/randstr"
+
+	jwt2 "github.com/lestrrat-go/jwx/v2/jwt"
+
 	"github.com/wisdom-oss/common-go/v3/internal/jwt"
 	"github.com/wisdom-oss/common-go/v3/types"
 )
diff --git a/types/error.go b/types/error.go
@@ -2,6 +2,7 @@ package types
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"net/http"
 	"os"
@@ -11,7 +12,7 @@ import (
 	"github.com/iancoleman/strcase"
 )
 
-// ErrorContentType is used as the media type when sending an error response
+// ErrorContentType is used as the media type when sending an error response.
 const ErrorContentType = "application/problem+json; charset=utf-8"
 
 const tagFormattingString = `tag:%s,%s:%s:%d`
@@ -61,8 +62,7 @@ type ServiceError struct {
 	Host string
 }
 
-// SetInstance generates a URI of the TAG format containing a unique identifier
-// for this error and assigns it to the Instance field
+// for this error and assigns it to the Instance field.
 func (se *ServiceError) SetInstance() error {
 	if se.Host == "" {
 		hostname, err := os.Hostname()
@@ -76,27 +76,21 @@ func (se *ServiceError) SetInstance() error {
 	return nil
 }
 
-// Emit allows sending the error contained as a response.
-//
-// The emitter may currently be one of the following types:
-//   - http.ResponseWriter
-//   - *gin.Context
-//
-// If an unknown or unsupported emitter is supplied, the function will panic
+// If an unknown or unsupported emitter is supplied, the function will panic.
 func (se ServiceError) Emit(emitter any) {
-	switch emitter.(type) {
+	switch emitter := emitter.(type) {
 	case http.ResponseWriter:
-		se.emit_responseWriter(emitter.(http.ResponseWriter))
+		se.emit_responseWriter(emitter)
 	case *gin.Context:
-		se.emit_gin(emitter.(*gin.Context))
+		se.emit_gin(emitter)
 	default:
 		panic(fmt.Sprintf("unknown error emitter. expected one of: http.ResponseWriter, *gin.Context. got: %T", emitter))
 	}
 }
 
 func (se *ServiceError) emit_responseWriter(w http.ResponseWriter) {
 	w.Header().Set("Content-Type", ErrorContentType)
-	w.WriteHeader(int(se.Status))
+	w.WriteHeader(int(se.Status)) //nolint:gosec
 
 	err := json.NewEncoder(w).Encode(se)
 	if err != nil {
@@ -106,10 +100,10 @@ func (se *ServiceError) emit_responseWriter(w http.ResponseWriter) {
 
 func (se *ServiceError) emit_gin(c *gin.Context) {
 	c.Header("Content-Type", ErrorContentType)
-	c.JSON(int(se.Status), se)
+	c.JSON(int(se.Status), se) //nolint:gosec
 }
 
-// MarshalJSON is used to change the serialization of the Errors
+// MarshalJSON is used to change the serialization of the Errors.
 func (se ServiceError) MarshalJSON() ([]byte, error) {
 	_ = se.SetInstance()
 	se.Host, _ = os.Hostname()
@@ -123,7 +117,7 @@ func (se ServiceError) MarshalJSON() ([]byte, error) {
 		Host     string   `json:"host"`
 	}{
 		Type:     se.Type,
-		Status:   int(se.Status),
+		Status:   int(se.Status), //nolint:gosec
 		Title:    se.Title,
 		Detail:   se.Detail,
 		Instance: se.Instance,
@@ -149,16 +143,16 @@ func (se *ServiceError) UnmarshalJSON(src []byte) error {
 	if err != nil {
 		return err
 	}
-	var errors []error
-	for _, err := range input.Errors {
-		errors = append(errors, fmt.Errorf(err))
+	errs := make([]error, len(input.Errors))
+	for idx, err := range input.Errors {
+		errs[idx] = errors.New(err)
 	}
 	*se = ServiceError{
 		Type:     input.Type,
-		Status:   uint(input.Status),
+		Status:   uint(input.Status), //nolint:gosec
 		Title:    input.Title,
 		Detail:   input.Detail,
-		Errors:   errors,
+		Errors:   errs,
 		Host:     input.Host,
 		Instance: input.Instance,
 	}

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@ package errorHandler`
`2`	`2`
`3`	`3`	`import "github.com/thanhpk/randstr"`
`4`	`4`
`5`		`-var ErrorChannelName = randstr.Hex(16)`
	`5`	`+var ErrorChannelName = randstr.Hex(16) //nolint:mnd`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ import (`
`8`	`8`
`9`	`9`	`"github.com/gin-gonic/gin"`
`10`	`10`	`"github.com/stretchr/testify/assert"`
	`11`	`+`
`11`	`12`	`errorHandler "github.com/wisdom-oss/common-go/v3/middleware/gin/error-handler"`
`12`	`13`	`)`
`13`	`14`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import (`
`5`	`5`	`"slices"`
`6`	`6`
`7`	`7`	`"github.com/gin-gonic/gin"`
	`8`	`+`
`8`	`9`	`"github.com/wisdom-oss/common-go/v3/internal/jwt"`
`9`	`10`	`"github.com/wisdom-oss/common-go/v3/types"`
`10`	`11`	`)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ func Handler(next http.Handler) http.Handler {`
`22`	`22`	`for {`
`23`	`23`	`p := recover()`
`24`	`24`	`if p != nil {`
`25`		`- if p == http.ErrAbortHandler {`
	`25`	`+ if p == http.ErrAbortHandler { //nolint:errorlint`
`26`	`26`	`panic(p)`
`27`	`27`	`}`
`28`	`28`	`panics = append(panics, p)`