From 8286fdc4d02ba1d8ada29f85f82c3826d4da05b6 Mon Sep 17 00:00:00 2001 From: skiffer-git <44203734@qq.com> Date: Thu, 12 Jan 2023 16:31:32 +0800 Subject: [PATCH] Error code standardization --- internal/api_to_rpc/api.go | 2 +- internal/rpc/group/group.go | 42 +++++++++++------------ pkg/common/constant/error.go | 50 ++++++++++++---------------- pkg/common/http/http_client.go | 6 ++-- pkg/common/token_verify/jwt_token.go | 30 ++++++++--------- pkg/getcdv3/temp.go | 2 +- 6 files changed, 62 insertions(+), 70 deletions(-) diff --git a/internal/api_to_rpc/api.go b/internal/api_to_rpc/api.go index 26914da4a..600c08b72 100644 --- a/internal/api_to_rpc/api.go +++ b/internal/api_to_rpc/api.go @@ -23,7 +23,7 @@ func ApiToRpc(c *gin.Context, apiReq, apiResp interface{}, rpcName string, rpcCl trace_log.SetContextInfo(nCtx, logFuncName, nil, "apiReq", apiReq) etcdConn, err := getcdv3.GetConn(nCtx, rpcName) if err != nil { - trace_log.WriteErrorResponse(nCtx, "GetDefaultConn", err) + trace_log.WriteErrorResponse(nCtx, "GetConn", err) return } rpc := reflect.ValueOf(rpcClientFunc).Call([]reflect.Value{ diff --git a/internal/rpc/group/group.go b/internal/rpc/group/group.go index 9dcb4d13c..ca98ae33c 100644 --- a/internal/rpc/group/group.go +++ b/internal/rpc/group/group.go @@ -133,17 +133,17 @@ func (s *groupServer) CreateGroup(ctx context.Context, req *pbGroup.CreateGroupR userIDs = append(userIDs, req.OwnerUserID) } if groupOwnerNum != 1 { - return nil, utils.Wrap(constant.ErrArgs, "") + return nil, utils.Wrap(&constant.ErrArgs, "") } if utils.IsRepeatStringSlice(userIDs) { - return nil, utils.Wrap(constant.ErrArgs, "") + return nil, utils.Wrap(&constant.ErrArgs, "") } users, err := rocksCache.GetUserInfoFromCacheBatch(ctx, userIDs) if err != nil { return nil, err } if len(users) != len(userIDs) { - return nil, utils.Wrap(constant.ErrArgs, "") + return nil, utils.Wrap(&constant.ErrArgs, "") } userMap := make(map[string]*imdb.User) for i, user := range users { @@ -274,15 +274,15 @@ func (s *groupServer) InviteUserToGroup(ctx context.Context, req *pbGroup.Invite resp := &pbGroup.InviteUserToGroupResp{} if !imdb.IsExistGroupMember(req.GroupID, req.OpUserID) && !token_verify.IsManagerUserID(req.OpUserID) { - constant.SetErrorForResp(constant.ErrIdentity, resp.CommonResp) - return nil, utils.Wrap(constant.ErrIdentity, "") + constant.SetErrorForResp(&constant.ErrIdentity, resp.CommonResp) + return nil, utils.Wrap(&constant.ErrIdentity, "") } groupInfo, err := (*imdb.Group)(nil).Take(ctx, req.GroupID) if err != nil { return nil, err } if groupInfo.Status == constant.GroupStatusDismissed { - return nil, utils.Wrap(constant.ErrDismissedAlready, "") + return nil, utils.Wrap(&constant.ErrDismissedAlready, "") } if groupInfo.NeedVerification == constant.AllNeedVerification && !imdb.IsGroupOwnerAdmin(req.GroupID, req.OpUserID) && !token_verify.IsManagerUserID(req.OpUserID) { @@ -465,7 +465,7 @@ func (s *groupServer) KickGroupMember(ctx context.Context, req *pbGroup.KickGrou return nil, err } if opInfo.RoleLevel == constant.GroupOrdinaryUsers { - return nil, utils.Wrap(constant.ErrNoPermission, "") + return nil, utils.Wrap(&constant.ErrNoPermission, "") } else if opInfo.RoleLevel == constant.GroupOwner { opFlag = 2 //owner } else { @@ -479,7 +479,7 @@ func (s *groupServer) KickGroupMember(ctx context.Context, req *pbGroup.KickGrou if len(req.KickedUserIDList) == 0 { //log.NewError(req.OperationID, "failed, kick list 0") //return &pbGroup.KickGroupMemberResp{ErrCode: constant.ErrArgs.ErrCode, ErrMsg: constant.ErrArgs.ErrMsg}, nil - return nil, utils.Wrap(constant.ErrArgs, "") + return nil, utils.Wrap(&constant.ErrArgs, "") } if err := s.DelGroupAndUserCache(ctx, req.GroupID, req.KickedUserIDList); err != nil { return nil, err @@ -586,7 +586,7 @@ func FillGroupInfoByGroupID(operationID, groupID string, groupInfo *open_im_sdk. } if group.Status == constant.GroupStatusDismissed { log.Debug(operationID, " group constant.GroupStatusDismissed ", group.GroupID) - return utils.Wrap(constant.ErrDismissedAlready, "") + return utils.Wrap(&constant.ErrDismissedAlready, "") } return utils.Wrap(cp.GroupDBCopyOpenIM(groupInfo, group), "") } @@ -613,7 +613,7 @@ func (s *groupServer) GetGroupApplicationList(ctx context.Context, req *pbGroup. node := open_im_sdk.GroupRequest{UserInfo: &open_im_sdk.PublicUserInfo{}, GroupInfo: &open_im_sdk.GroupInfo{}} err := FillGroupInfoByGroupID(req.OperationID, v.GroupID, node.GroupInfo) if err != nil { - if !errors.Is(errors.Unwrap(err), constant.ErrDismissedAlready) { + if !errors.Is(errors.Unwrap(err), &constant.ErrDismissedAlready) { errResult = err } continue @@ -657,7 +657,7 @@ func CheckPermission(ctx context.Context, groupID string, userID string) (err er trace_log.SetContextInfo(ctx, utils.GetSelfFuncName(), err, "groupID", groupID, "userID", userID) }() if !token_verify.IsManagerUserID(userID) && !imdb.IsGroupOwnerAdmin(groupID, userID) { - return utils.Wrap(constant.ErrNoPermission, utils.GetSelfFuncName()) + return utils.Wrap(&constant.ErrNoPermission, utils.GetSelfFuncName()) } return nil } @@ -731,7 +731,7 @@ func (s *groupServer) GroupApplicationResponse(ctx context.Context, req *pbGroup } else if req.HandleResult == constant.GroupResponseRefuse { chat.GroupApplicationRejectedNotification(req) } else { - return nil, utils.Wrap(constant.ErrArgs, "") + return nil, utils.Wrap(&constant.ErrArgs, "") } return resp, nil } @@ -747,8 +747,8 @@ func (s *groupServer) JoinGroup(ctx context.Context, req *pbGroup.JoinGroupReq) return nil, err } if groupInfo.Status == constant.GroupStatusDismissed { - constant.SetErrorForResp(constant.ErrDismissedAlready, resp.CommonResp) - return nil, utils.Wrap(constant.ErrDismissedAlready, "") + constant.SetErrorForResp(&constant.ErrDismissedAlready, resp.CommonResp) + return nil, utils.Wrap(&constant.ErrDismissedAlready, "") } if groupInfo.NeedVerification == constant.Directly { @@ -797,7 +797,7 @@ func (s *groupServer) JoinGroup(ctx context.Context, req *pbGroup.JoinGroupReq) chat.MemberEnterDirectlyNotification(req.GroupID, req.OpUserID, req.OperationID) return resp, nil } else { - constant.SetErrorForResp(constant.ErrGroupTypeNotSupport, resp.CommonResp) + constant.SetErrorForResp(&constant.ErrGroupTypeNotSupport, resp.CommonResp) return resp, nil } } @@ -870,14 +870,14 @@ func (s *groupServer) SetGroupInfo(ctx context.Context, req *pbGroup.SetGroupInf resp := &pbGroup.SetGroupInfoResp{} if !hasAccess(req) { - return nil, utils.Wrap(constant.ErrIdentity, "") + return nil, utils.Wrap(&constant.ErrIdentity, "") } group, err := imdb.GetGroupInfoByGroupID(req.GroupInfoForSet.GroupID) if err != nil { return nil, err } if group.Status == constant.GroupStatusDismissed { - return nil, utils.Wrap(constant.ErrDismissedAlready, "") + return nil, utils.Wrap(&constant.ErrDismissedAlready, "") } var changedType int32 @@ -989,7 +989,7 @@ func (s *groupServer) TransferGroupOwner(ctx context.Context, req *pbGroup.Trans return nil, err } if groupInfo.Status == constant.GroupStatusDismissed { - return nil, utils.Wrap(constant.ErrDismissedAlready, "") + return nil, utils.Wrap(&constant.ErrDismissedAlready, "") } if req.OldOwnerUserID == req.NewOwnerUserID { @@ -1125,7 +1125,7 @@ func (s *groupServer) DismissGroup(ctx context.Context, req *pbGroup.DismissGrou resp := &pbGroup.DismissGroupResp{} if !token_verify.IsManagerUserID(req.OpUserID) && !imdb.IsGroupOwnerAdmin(req.GroupID, req.OpUserID) { - return nil, utils.Wrap(constant.ErrIdentity, "") + return nil, utils.Wrap(&constant.ErrIdentity, "") } if err := rocksCache.DelGroupInfoFromCache(ctx, req.GroupID); err != nil { @@ -1259,7 +1259,7 @@ func (s *groupServer) MuteGroup(ctx context.Context, req *pbGroup.MuteGroupReq) //errMsg := req.OperationID + "opFlag == 0 " + req.GroupID + req.OpUserID //log.Error(req.OperationID, errMsg) //return &pbGroup.MuteGroupResp{CommonResp: &pbGroup.CommonResp{ErrCode: constant.ErrAccess.ErrCode, ErrMsg: errMsg}}, nil - return nil, utils.Wrap(constant.ErrNoPermission, "") + return nil, utils.Wrap(&constant.ErrNoPermission, "") } //mutedInfo, err := imdb.GetGroupMemberInfoByGroupIDAndUserID(req.GroupID, req.UserID) @@ -1327,7 +1327,7 @@ func (s *groupServer) SetGroupMemberNickname(ctx context.Context, req *pbGroup.S resp := &pbGroup.SetGroupMemberNicknameResp{} if req.OpUserID != req.UserID && !token_verify.IsManagerUserID(req.OpUserID) { - return nil, utils.Wrap(constant.ErrIdentity, "") + return nil, utils.Wrap(&constant.ErrIdentity, "") } cbReq := &pbGroup.SetGroupMemberInfoReq{ GroupID: req.GroupID, diff --git a/pkg/common/constant/error.go b/pkg/common/constant/error.go index cc99534d9..5663f8614 100644 --- a/pkg/common/constant/error.go +++ b/pkg/common/constant/error.go @@ -16,17 +16,16 @@ type ErrInfo struct { DetailErrMsg string } -func (e ErrInfo) Error() string { +func (e *ErrInfo) Error() string { return e.ErrMsg } -func (e ErrInfo) Code() int32 { +func (e *ErrInfo) Code() int32 { return e.ErrCode } var ( ErrNone = ErrInfo{0, "", ""} - ErrRpcConn = ErrInfo{GRPCConnIsNil, "grpc conn is nil", ""} ErrArgs = ErrInfo{ArgsError, "ArgsError", ""} ErrDatabase = ErrInfo{DatabaseError, "DatabaseError", ""} ErrInternalServer = ErrInfo{ServerInternalError, "ServerInternalError", ""} @@ -72,42 +71,35 @@ var ( ) func NewErrNetwork(err error) error { - newErrNetwork := ErrNetwork - newErrNetwork.DetailErrMsg = err.Error() - return ErrNetwork + return toDetail(err, &ErrNetwork) } func NewErrData(err error) error { - newErrData := ErrData - newErrData.DetailErrMsg = err.Error() - return ErrNetwork + return toDetail(err, &ErrData) } -func toDetail(err error, info ErrInfo) ErrInfo { - errInfo := info +func toDetail(err error, info *ErrInfo) *ErrInfo { + errInfo := *info errInfo.DetailErrMsg = err.Error() - return errInfo + return &errInfo } -func ToAPIErrWithErr(err error) ErrInfo { +func ToAPIErrWithErr(err error) *ErrInfo { + errComm := errors.New("") + var marshalErr *json.MarshalerError + errInfo := &ErrInfo{} switch { - case errors.Is(err, gorm.ErrRecordNotFound): - return toDetail(err, ErrRecordNotFound) - case errors.Is(err, ErrArgs): - return toDetail(err, ErrArgs) - case errors.Is(err, ErrDatabase): - return ErrDatabase + case errors.As(err, &errComm): + if errors.Is(err, gorm.ErrRecordNotFound) { + return toDetail(err, &ErrRecordNotFound) + } + return toDetail(err, &ErrData) + case errors.As(err, &marshalErr): + return toDetail(err, &ErrData) + case errors.As(err, &errInfo): + return toDetail(err, errInfo) } - - errTarget := errors.New("") - var mErr *json.MarshalerError - switch { - case errors.As(err, &mErr): - return ErrData - case errors.As(err, errTarget): - return ErrDatabase - } - return ErrDefaultOther + return toDetail(err, &ErrDefaultOther) } func SetErrorForResp(err error, commonResp *sdkws.CommonResp) { diff --git a/pkg/common/http/http_client.go b/pkg/common/http/http_client.go index 721ee627f..aa515d55c 100644 --- a/pkg/common/http/http_client.go +++ b/pkg/common/http/http_client.go @@ -31,7 +31,7 @@ func Get(url string) (response []byte, err error) { return body, nil } -//application/json; charset=utf-8 +// application/json; charset=utf-8 func Post(url string, data interface{}, timeOutSecond int) (content []byte, err error) { jsonStr, err := json.Marshal(data) if err != nil { @@ -65,13 +65,13 @@ func CallBackPostReturn(url, callbackCommand string, input interface{}, output c b, err := Post(url, input, timeOut) if err != nil { if failedContinue != nil && *failedContinue { - return constant.ErrCallbackContinue + return &constant.ErrCallbackContinue } return constant.NewErrNetwork(err) } if err = json.Unmarshal(b, output); err != nil { if failedContinue != nil && *failedContinue { - return constant.ErrCallbackContinue + return &constant.ErrCallbackContinue } return constant.NewErrData(err) } diff --git a/pkg/common/token_verify/jwt_token.go b/pkg/common/token_verify/jwt_token.go index 0b041f5a8..43897d517 100644 --- a/pkg/common/token_verify/jwt_token.go +++ b/pkg/common/token_verify/jwt_token.go @@ -104,22 +104,22 @@ func GetClaimFromToken(tokensString string) (*Claims, error) { if err != nil { if ve, ok := err.(*jwt.ValidationError); ok { if ve.Errors&jwt.ValidationErrorMalformed != 0 { - return nil, utils.Wrap(constant.ErrTokenMalformed, "") + return nil, utils.Wrap(&constant.ErrTokenMalformed, "") } else if ve.Errors&jwt.ValidationErrorExpired != 0 { - return nil, utils.Wrap(constant.ErrTokenExpired, "") + return nil, utils.Wrap(&constant.ErrTokenExpired, "") } else if ve.Errors&jwt.ValidationErrorNotValidYet != 0 { - return nil, utils.Wrap(constant.ErrTokenNotValidYet, "") + return nil, utils.Wrap(&constant.ErrTokenNotValidYet, "") } else { - return nil, utils.Wrap(constant.ErrTokenUnknown, "") + return nil, utils.Wrap(&constant.ErrTokenUnknown, "") } } else { - return nil, utils.Wrap(constant.ErrTokenUnknown, "") + return nil, utils.Wrap(&constant.ErrTokenUnknown, "") } } else { if claims, ok := token.Claims.(*Claims); ok && token.Valid { return claims, nil } - return nil, utils.Wrap(constant.ErrTokenUnknown, "") + return nil, utils.Wrap(&constant.ErrTokenUnknown, "") } } @@ -162,7 +162,7 @@ func CheckAccessV2(ctx context.Context, OpUserID string, OwnerUserID string) (er if OpUserID == OwnerUserID { return nil } - return utils.Wrap(constant.ErrIdentity, open_utils.GetSelfFuncName()) + return utils.Wrap(&constant.ErrIdentity, open_utils.GetSelfFuncName()) } func GetUserIDFromToken(token string, operationID string) (bool, string, string) { @@ -211,26 +211,26 @@ func ParseToken(tokensString, operationID string) (claims *Claims, err error) { m, err := commonDB.DB.GetTokenMapByUidPid(claims.UID, claims.Platform) if err != nil { log.NewError(operationID, "get token from redis err", err.Error(), claims.UID, claims.Platform) - return nil, utils.Wrap(constant.ErrTokenNotExist, "get token from redis err") + return nil, utils.Wrap(&constant.ErrTokenNotExist, "get token from redis err") } if m == nil { log.NewError(operationID, "get token from redis err, not in redis ", "m is nil ", claims.UID, claims.Platform) - return nil, utils.Wrap(constant.ErrTokenNotExist, "get token from redis err") + return nil, utils.Wrap(&constant.ErrTokenNotExist, "get token from redis err") } if v, ok := m[tokensString]; ok { switch v { case constant.NormalToken: - log.NewDebug(operationID, "this is normal return", claims) + log.NewDebug(operationID, "this is normal return ", *claims) return claims, nil case constant.KickedToken: log.Error(operationID, "this token has been kicked by other same terminal ", constant.ErrTokenKicked) - return nil, utils.Wrap(constant.ErrTokenKicked, "this token has been kicked by other same terminal ") + return nil, utils.Wrap(&constant.ErrTokenKicked, "this token has been kicked by other same terminal ") default: - return nil, utils.Wrap(constant.ErrTokenUnknown, "") + return nil, utils.Wrap(&constant.ErrTokenUnknown, "") } } log.NewError(operationID, "redis token map not find ", constant.ErrTokenNotExist, tokensString) - return nil, utils.Wrap(constant.ErrTokenNotExist, "redis token map not find") + return nil, utils.Wrap(&constant.ErrTokenNotExist, "redis token map not find") } //func MakeTheTokenInvalid(currentClaims *Claims, platformClass string) (bool, error) { @@ -286,11 +286,11 @@ func WsVerifyToken(token, uid string, platformID string, operationID string) (bo } if claims.UID != uid { errMsg := " uid is not same to token uid " + argMsg + " claims.UID: " + claims.UID - return false, utils.Wrap(constant.ErrTokenDifferentUserID, errMsg), errMsg + return false, utils.Wrap(&constant.ErrTokenDifferentUserID, errMsg), errMsg } if claims.Platform != constant.PlatformIDToName(utils.StringToInt(platformID)) { errMsg := " platform is not same to token platform " + argMsg + " claims platformID: " + claims.Platform - return false, utils.Wrap(constant.ErrTokenDifferentPlatformID, errMsg), errMsg + return false, utils.Wrap(&constant.ErrTokenDifferentPlatformID, errMsg), errMsg } log.NewDebug(operationID, utils.GetSelfFuncName(), " check ok ", claims.UID, uid, claims.Platform) return true, nil, "" diff --git a/pkg/getcdv3/temp.go b/pkg/getcdv3/temp.go index 373870985..dde6b09f3 100644 --- a/pkg/getcdv3/temp.go +++ b/pkg/getcdv3/temp.go @@ -21,7 +21,7 @@ func GetConn(ctx context.Context, serviceName string) (conn *grpc.ClientConn, er conn = getcdv3.GetConn(config.Config.Etcd.EtcdSchema, strings.Join(config.Config.Etcd.EtcdAddr, ","), serviceName, trace_log.GetOperationID(ctx), config.Config.Etcd.UserName, config.Config.Etcd.Password) if conn == nil { - return nil, constant.ErrRpcConn + return nil, &constant.ErrInternalServer } return conn, nil }