refactor: decouple errors from gmicro package in the jwt logic

coderi421 · coderi421 · commit c0e0ae52ca7c · 2023-05-31T14:00:47.000+08:00
diff --git a/app/pkg/code/base.go b/app/pkg/code/base.go
@@ -25,12 +25,6 @@ const (
 	ErrPageNotFound
 )
 
-// common: database errors.
-const (
-	// ErrDatabase - 500: Database error.
-	ErrDatabase int = iota + 100101
-)
-
 // common: authorization and authentication errors.
 const (
 	// ErrEncrypt - 401: Error occurred while encrypting the user password.
diff --git a/app/pkg/code/db.go b/app/pkg/code/db.go
@@ -2,9 +2,11 @@ package code
 
 //go:generate codeg -type=int
 const (
-	// ErrConnectDB - 500: Init db error.
-	ErrConnectDB int = iota + 100101
+	// ErrDatabase - 500: Database error.
+	ErrDatabase int = iota + 100101
 
+	// ErrConnectDB - 500: Init db error.
+	ErrConnectDB
 	// ErrConnectGRPC - 500: Connect to grpc error.
 	ErrConnectGRPC
 )
diff --git a/app/pkg/code/error_code_generated.md b/app/pkg/code/error_code_generated.md
@@ -21,8 +21,24 @@
 
 | Identifier | Code | HTTP Code | Description |
 | ---------- | ---- | --------- | ----------- |
-| ErrConnectDB | 100601 | 500 | Init db error |
-| ErrConnectGRPC | 100602 | 500 | Connect to grpc error |
+| ErrEncrypt | 100201 | 401 | Error occurred while encrypting the user password |
+| ErrSignatureInvalid | 100202 | 401 | Signature is invalid |
+| ErrExpired | 100203 | 401 | Token expired |
+| ErrInvalidAuthHeader | 100204 | 401 | Invalid authorization header |
+| ErrMissingHeader | 100205 | 401 | The `Authorization` header was empty |
+| ErrPasswordIncorrect | 100206 | 401 | Password was incorrect |
+| ErrPermissionDenied | 100207 | 403 | Permission denied |
+| ErrEncodingFailed | 100301 | 500 | Encoding failed due to an error with the data |
+| ErrDecodingFailed | 100302 | 500 | Decoding failed due to an error with the data |
+| ErrInvalidJSON | 100303 | 500 | Data is not valid JSON |
+| ErrEncodingJSON | 100304 | 500 | JSON data could not be encoded |
+| ErrDecodingJSON | 100305 | 500 | JSON data could not be decoded |
+| ErrInvalidYaml | 100306 | 500 | Data is not valid Yaml |
+| ErrEncodingYaml | 100307 | 500 | Yaml data could not be encoded |
+| ErrDecodingYaml | 100308 | 500 | Yaml data could not be decoded |
+| ErrDatabase | 100101 | 500 | Database error |
+| ErrConnectDB | 100102 | 500 | Init db error |
+| ErrConnectGRPC | 100103 | 500 | Connect to grpc error |
 | ErrGoodsNotFound | 100501 | 404 | Goods not found |
 | ErrCategoryNotFound | 100502 | 404 | Category not found |
 | ErrEsUnmarshal | 100503 | 500 | Es unmarshal error |
diff --git a/gmicro/code/code.go b/gmicro/code/code.go
diff --git a/gmicro/code/code_generated.go b/gmicro/code/code_generated.go
diff --git a/gmicro/code/error_code_generated.md b/gmicro/code/error_code_generated.md
diff --git a/gmicro/server/restserver/middlewares/auth/auto.go b/gmicro/server/restserver/middlewares/auth/auto.go
@@ -1,15 +1,13 @@
 package auth
 
 import (
+	"net/http"
 	"strings"
 
 	"github.com/coderi421/gframework/pkg/common/core"
 
-	"github.com/coderi421/gframework/gmicro/code"
 	"github.com/coderi421/gframework/gmicro/server/restserver/middlewares"
 
-	"github.com/coderi421/gframework/pkg/errors"
-
 	"github.com/gin-gonic/gin"
 )
 
@@ -39,11 +37,15 @@ func (a AutoStrategy) AuthFunc() gin.HandlerFunc {
 		authHeader := strings.SplitN(c.Request.Header.Get("Authorization"), " ", 2)
 
 		if len(authHeader) != authHeaderCount {
-			core.WriteResponse(
-				c,
-				errors.WithCode(code.ErrInvalidAuthHeader, "Authorization header format is wrong."),
-				nil,
-			)
+			//core.WriteResponse(
+			//	c,
+			//	errors.WithCode(code.ErrInvalidAuthHeader, "Authorization header format is wrong."),
+			//	nil,
+			//)
+
+			c.JSON(http.StatusUnauthorized, core.ErrResponse{
+				Message: "Invalid authorization header.",
+			})
 			c.Abort()
 
 			return
@@ -56,7 +58,10 @@ func (a AutoStrategy) AuthFunc() gin.HandlerFunc {
 			operator.SetStrategy(a.jwt)
 			// a.JWT.MiddlewareFunc()(c)
 		default:
-			core.WriteResponse(c, errors.WithCode(code.ErrSignatureInvalid, "unrecognized Authorization header."), nil)
+			//core.WriteResponse(c, errors.WithCode(code.ErrSignatureInvalid, "unrecognized Authorization header."), nil)
+			c.JSON(http.StatusUnauthorized, core.ErrResponse{
+				Message: "unrecognized Authorization header.",
+			})
 			c.Abort()
 
 			return
diff --git a/gmicro/server/restserver/middlewares/auth/basic.go b/gmicro/server/restserver/middlewares/auth/basic.go
@@ -2,15 +2,13 @@ package auth
 
 import (
 	"encoding/base64"
+	"net/http"
 	"strings"
 
 	"github.com/coderi421/gframework/pkg/common/core"
 
-	"github.com/coderi421/gframework/gmicro/code"
 	"github.com/coderi421/gframework/gmicro/server/restserver/middlewares"
 
-	"github.com/coderi421/gframework/pkg/errors"
-
 	"github.com/gin-gonic/gin"
 )
 
@@ -32,13 +30,16 @@ func NewBasicStrategy(compare func(username string, password string) bool) Basic
 func (b BasicStrategy) AuthFunc() gin.HandlerFunc {
 	return func(c *gin.Context) {
 		auth := strings.SplitN(c.Request.Header.Get("Authorization"), " ", 2)
-
 		if len(auth) != 2 || auth[0] != "Basic" {
-			core.WriteResponse(
-				c,
-				errors.WithCode(code.ErrSignatureInvalid, "Authorization header format is wrong."),
-				nil,
-			)
+			//core.WriteResponse(
+			//	c,
+			//	errors.WithCode(code.ErrSignatureInvalid, "Authorization header format is wrong."),
+			//	nil,
+			//)
+
+			c.JSON(http.StatusUnauthorized, core.ErrResponse{
+				Message: "Authorization header format is wrong.",
+			})
 			c.Abort()
 
 			return
@@ -49,11 +50,14 @@ func (b BasicStrategy) AuthFunc() gin.HandlerFunc {
 
 		//在这一步实现自己注入的compare
 		if len(pair) != 2 || !b.compare(pair[0], pair[1]) {
-			core.WriteResponse(
-				c,
-				errors.WithCode(code.ErrSignatureInvalid, "Authorization header format is wrong."),
-				nil,
-			)
+			//core.WriteResponse(
+			//	c,
+			//	errors.WithCode(code.ErrSignatureInvalid, "Authorization header format is wrong."),
+			//	nil,
+			//)
+			c.JSON(http.StatusUnauthorized, core.ErrResponse{
+				Message: "Authorization header format is wrong.",
+			})
 			c.Abort()
 
 			return
diff --git a/gmicro/server/restserver/middlewares/auth/cache.go b/gmicro/server/restserver/middlewares/auth/cache.go
@@ -2,11 +2,11 @@ package auth
 
 import (
 	"fmt"
+	"net/http"
 	"time"
 
 	jwt "github.com/dgrijalva/jwt-go/v4"
 
-	"github.com/coderi421/gframework/gmicro/code"
 	"github.com/coderi421/gframework/gmicro/server/restserver/middlewares"
 	"github.com/coderi421/gframework/pkg/common/core"
 	"github.com/coderi421/gframework/pkg/errors"
@@ -46,7 +46,10 @@ func (cache CacheStrategy) AuthFunc() gin.HandlerFunc {
 	return func(c *gin.Context) {
 		header := c.Request.Header.Get("Authorization")
 		if len(header) == 0 {
-			core.WriteResponse(c, errors.WithCode(code.ErrMissingHeader, "Authorization header cannot be empty."), nil)
+			//core.WriteResponse(c, errors.WithCode(code.ErrMissingHeader, "Authorization header cannot be empty."), nil)
+			c.JSON(http.StatusUnauthorized, core.ErrResponse{
+				Message: "Authorization header cannot be empty.",
+			})
 			c.Abort()
 
 			return
@@ -84,15 +87,21 @@ func (cache CacheStrategy) AuthFunc() gin.HandlerFunc {
 			return []byte(secret.Key), nil
 		}, jwt.WithAudience(AuthzAudience))
 		if err != nil || !parsedT.Valid {
-			core.WriteResponse(c, errors.WithCode(code.ErrSignatureInvalid, err.Error()), nil)
+			c.JSON(http.StatusUnauthorized, core.ErrResponse{
+				Message: err.Error(),
+			})
+			//core.WriteResponse(c, errors.WithCode(code.ErrSignatureInvalid, err.Error()), nil)
 			c.Abort()
 
 			return
 		}
 
 		if KeyExpired(secret.Expires) {
 			tm := time.Unix(secret.Expires, 0).Format("2006-01-02 15:04:05")
-			core.WriteResponse(c, errors.WithCode(code.ErrExpired, "expired at: %s", tm), nil)
+			c.JSON(http.StatusUnauthorized, core.ErrResponse{
+				Message: fmt.Sprintf("expired at: %s", tm),
+			})
+			//core.WriteResponse(c, errors.WithCode(code.ErrExpired, "expired at: %s", tm), nil)
 			c.Abort()
 
 			return
diff --git a/gmicro/server/restserver/middlewares/auth/jwt.go b/gmicro/server/restserver/middlewares/auth/jwt.go
@@ -8,7 +8,7 @@ import (
 )
 
 // AuthzAudience defines the value of jwt audience field.
-const AuthzAudience = "mxshop.imooc.com"
+const AuthzAudience = "gmicro.com"
 
 // JWTStrategy defines jwt bearer authentication strategy.
 type JWTStrategy struct {
diff --git a/go.mod b/go.mod
@@ -21,14 +21,15 @@ require (
 	cloud.google.com/go/firestore v1.9.0 // indirect
 	cloud.google.com/go/longrunning v0.4.1 // indirect
 	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
+	github.com/PaulXu-cn/go-mod-graph-chart v0.5.3 // indirect
+	github.com/appleboy/gin-jwt/v2 v2.9.1 // indirect
 	github.com/armon/go-metrics v0.4.0 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/bits-and-blooms/bitset v1.2.0 // indirect
 	github.com/bytedance/sonic v1.8.0 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
 	github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect
 	github.com/coreos/go-semver v0.3.0 // indirect
-	github.com/coreos/go-systemd/v22 v22.3.2 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dgrijalva/jwt-go v3.2.0+incompatible // indirect
@@ -47,6 +48,7 @@ require (
 	github.com/go-sql-driver/mysql v1.7.0 // indirect
 	github.com/goccy/go-json v0.10.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang-jwt/jwt/v4 v4.4.3 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/go-cmp v0.5.9 // indirect
diff --git a/go.sum b/go.sum

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`// AuthzAudience defines the value of jwt audience field.`
`11`		`-const AuthzAudience = "mxshop.imooc.com"`
	`11`	`+const AuthzAudience = "gmicro.com"`
`12`	`12`
`13`	`13`	`// JWTStrategy defines jwt bearer authentication strategy.`
`14`	`14`	`type JWTStrategy struct {`