fix: enhance error handling by adding context to custom error creation for logging

Author: FarhanSaleh

app/users/delivery/http/register_users.go

@@ -38,7 +38,7 @@ func (h Handler) Register(w http.ResponseWriter, r *http.Request) {
 	}
 
 	if user.Password != user.ConfirmPassword {
-		err := utils.NewBadRequestError("Confirm password doesn't match", nil)
+		err := utils.NewBadRequestError(r.Context(), "Confirm password doesn't match", nil)
 		resp := utils.CustomErrorResponse(err)
 		utils.Response(resp, w)
 		return

app/users/usecase/login_users.go

@@ -5,22 +5,19 @@ import (
 
 	"github.com/hammer-code/lms-be/domain"
 	"github.com/hammer-code/lms-be/utils"
-	"github.com/sirupsen/logrus"
 	"golang.org/x/crypto/bcrypt"
 )
 
 func (us *usecase) Login(ctx context.Context, userReq domain.Login) (user domain.User, token string, err error) {
 	err = us.dbTX.StartTransaction(ctx, func(txCtx context.Context) error {
 		user, err = us.userRepo.FindByEmail(ctx, userReq.Email)
 		if err != nil {
-			logrus.Error("us.LoginUser: failed to find user by email", err)
-			err = utils.NewInternalServerError(err)
+			err = utils.NewInternalServerError(ctx, err)
 			return err
 		}
 
 		if err = bcrypt.CompareHashAndPassword([]byte(user.Password), []byte(userReq.Password)); err != nil {
-			logrus.Error("us.Login: invalid password")
-			err = utils.NewBadRequestError("Email or Password is invalid", err)
+			err = utils.NewBadRequestError(ctx, "Email or Password is invalid", err)
 			return err
 		}
 
@@ -29,28 +26,24 @@ func (us *usecase) Login(ctx context.Context, userReq domain.Login) (user domain
 		token = *tokenPtr
 
 		if err != nil {
-			logrus.Error("us.Login: failed to generate token", err)
-			err = utils.NewInternalServerError(err)
+			err = utils.NewInternalServerError(ctx, err)
 			return err
 		}
 
 		if err = us.userRepo.UnactivateTokenByUser(ctx, user.ID); err != nil {
-			logrus.Error("us.Login: failed to unactivate token", err)
-			err = utils.NewInternalServerError(err)
+			err = utils.NewInternalServerError(ctx, err)
 			return err
 		}
 		if err = us.userRepo.StoreToken(ctx, token, expiredTime, user.ID); err != nil {
-			logrus.Error("us.Login: failed to store token", err)
-			err = utils.NewInternalServerError(err)
+			err = utils.NewInternalServerError(ctx, err)
 			return err
 		}
 
 		return nil
 	})
 
 	if err != nil {
-		logrus.Error("us.Login: failed to login", err)
-		err = utils.NewInternalServerError(err)
+		err = utils.NewInternalServerError(ctx, err)
 		return
 	}
 

app/users/usecase/logout_users.go

@@ -4,21 +4,18 @@ import (
 	"context"
 
 	"github.com/hammer-code/lms-be/utils"
-	"github.com/sirupsen/logrus"
 )
 
 func (us *usecase) Logout(ctx context.Context, token string) error {
 	jwtData, err := us.jwt.VerifyToken(token)
 	if err != nil {
-		logrus.Error("us.LogoutUser: failed to varify token", err)
-		err = utils.NewInternalServerError(err)
+		err = utils.NewInternalServerError(ctx, err)
 		return err
 	}
 
 	err = us.userRepo.LogoutUser(ctx, token, jwtData.ExpiresAt.Time)
 	if err != nil {
-		logrus.Error("us.LogoutUser: failed to logout", err)
-		err = utils.NewInternalServerError(err)
+		err = utils.NewInternalServerError(ctx, err)
 		return err
 	}
 	return err

app/users/usecase/register_users.go

@@ -6,7 +6,6 @@ import (
 	"github.com/hammer-code/lms-be/constants"
 	"github.com/hammer-code/lms-be/domain"
 	"github.com/hammer-code/lms-be/utils"
-	"github.com/sirupsen/logrus"
 	"golang.org/x/crypto/bcrypt"
 )
 
@@ -15,26 +14,23 @@ func (us *usecase) Register(ctx context.Context, userReq domain.User) (domain.Us
 	err := us.dbTX.StartTransaction(ctx, func(txCtx context.Context) error {
 		hashPassword, err := bcrypt.GenerateFromPassword([]byte(userReq.Password), bcrypt.DefaultCost)
 		if err != nil {
-			logrus.Error("us.Register: failed to hash password", err)
-			err = utils.NewInternalServerError(err)
+			err = utils.NewInternalServerError(ctx, err)
 			return err
 		}
 
 		userReq.Password = string(hashPassword)
 		userReq.Role = constants.RoleUser
 		user, err = us.userRepo.CreateUser(ctx, userReq)
 		if err != nil {
-			logrus.Error("us.Register: failed to register users. ", err)
-			err = utils.NewInternalServerError(err)
+			err = utils.NewInternalServerError(ctx, err)
 			return err
 		}
 		return nil
 
 	})
 
 	if err != nil {
-		logrus.Error("us.Register: failed to register users. ", err)
-		err = utils.NewInternalServerError(err)
+		err = utils.NewInternalServerError(ctx, err)
 		return domain.User{}, err
 	}
 

utils/costum_error.go

@@ -1,11 +1,13 @@
 package utils
 
 import (
+	"context"
 	"fmt"
 	"net/http"
 	"strings"
 
 	"github.com/hammer-code/lms-be/domain"
+	"github.com/hammer-code/lms-be/pkg/ngelog"
 )
 
 const (
@@ -27,23 +29,26 @@ func (e *CustomHttpError) Error() string {
 	return e.Message
 }
 
-func NewBadRequestError(msg string, err error) *CustomHttpError {
+func NewBadRequestError(ctx context.Context, msg string, err error) *CustomHttpError {
+	ngelog.Error(ctx, msg, err)
 	return &CustomHttpError{
 		Code:    http.StatusBadRequest,
 		Message: msg,
 		OriginError: err,
 	}
 }
 
-func NewUnauthorizedError(msg string, err error) *CustomHttpError {
+func NewUnauthorizedError(ctx context.Context, msg string, err error) *CustomHttpError {
+	ngelog.Error(ctx, msg, err)
 	return &CustomHttpError{
 		Code:    http.StatusUnauthorized,
 		Message: msg,
 		OriginError: err,
 	}
 }
 
-func NewInternalServerError(err error) *CustomHttpError {
+func NewInternalServerError(ctx context.Context, err error) *CustomHttpError {
+	ngelog.Error(ctx, "Internal server error", err)
 	return &CustomHttpError{
 		Code:    http.StatusInternalServerError,
 		Message: "Internal server error",
@@ -62,18 +67,17 @@ func CheckError(errStr, containsStr, message string, code int) (domain.HttpRespo
 }
 
 func CustomErrorResponse(err error) domain.HttpResponse {
-	fmt.Println("YOW", err)
 	if customErr, ok := err.(*CustomHttpError); ok {
 		var errStr string
 		if customErr.OriginError != nil {
 			errStr = customErr.OriginError.Error()
 		}
-		resp, ok := CheckError(errStr, ErrDuplicateEmail, "User already exist", 400)
+		resp, ok := CheckError(errStr, ErrDuplicateEmail, "User already exist", http.StatusBadRequest)
 		if ok {
 			return resp
 		}
 
-		resp, ok = CheckError(errStr, ErrWrongPassword, "Sorry, your password is incorrect", 400)
+		resp, ok = CheckError(errStr, ErrWrongPassword, "Sorry, your password is incorrect", http.StatusBadRequest)
 		if ok {
 			return resp
 		}