Merge pull request #28 from dipeshdulal/chore/struct-embedding-logger

Chore: Added struct embedding for logger.

api/controllers/jwt_auth_controller.go

@@ -28,7 +28,7 @@ func NewJWTAuthController(
 
 // SignIn signs in user
 func (jwt JWTAuthController) SignIn(c *gin.Context) {
-	jwt.logger.Zap.Info("SignIn route called")
+	jwt.logger.Info("SignIn route called")
 	// Currently not checking for username and password
 	// Can add the logic later if necessary.
 	user, _ := jwt.userService.GetOneUser(uint(1))
@@ -41,7 +41,7 @@ func (jwt JWTAuthController) SignIn(c *gin.Context) {
 
 // Register registers user
 func (jwt JWTAuthController) Register(c *gin.Context) {
-	jwt.logger.Zap.Info("Register route called")
+	jwt.logger.Info("Register route called")
 	c.JSON(200, gin.H{
 		"message": "register route",
 	})

api/controllers/user_controller.go

@@ -32,7 +32,7 @@ func (u UserController) GetOneUser(c *gin.Context) {
 
 	id, err := strconv.Atoi(paramID)
 	if err != nil {
-		u.logger.Zap.Error(err)
+		u.logger.Error(err)
 		c.JSON(http.StatusBadRequest, gin.H{
 			"error": err,
 		})
@@ -41,7 +41,7 @@ func (u UserController) GetOneUser(c *gin.Context) {
 	user, err := u.service.GetOneUser(uint(id))
 
 	if err != nil {
-		u.logger.Zap.Error(err)
+		u.logger.Error(err)
 		c.JSON(http.StatusInternalServerError, gin.H{
 			"error": err.Error(),
 		})
@@ -58,7 +58,7 @@ func (u UserController) GetOneUser(c *gin.Context) {
 func (u UserController) GetUser(c *gin.Context) {
 	users, err := u.service.GetAllUser()
 	if err != nil {
-		u.logger.Zap.Error(err)
+		u.logger.Error(err)
 	}
 	c.JSON(200, gin.H{"data": users})
 }
@@ -69,15 +69,15 @@ func (u UserController) SaveUser(c *gin.Context) {
 	trxHandle := c.MustGet(constants.DBTransaction).(*gorm.DB)
 
 	if err := c.ShouldBindJSON(&user); err != nil {
-		u.logger.Zap.Error(err)
+		u.logger.Error(err)
 		c.JSON(http.StatusInternalServerError, gin.H{
 			"error": err.Error(),
 		})
 		return
 	}
 
 	if err := u.service.WithTrx(trxHandle).CreateUser(user); err != nil {
-		u.logger.Zap.Error(err)
+		u.logger.Error(err)
 		c.JSON(http.StatusInternalServerError, gin.H{
 			"error": err.Error(),
 		})
@@ -98,15 +98,15 @@ func (u UserController) DeleteUser(c *gin.Context) {
 
 	id, err := strconv.Atoi(paramID)
 	if err != nil {
-		u.logger.Zap.Error(err)
+		u.logger.Error(err)
 		c.JSON(http.StatusBadRequest, gin.H{
 			"error": err,
 		})
 		return
 	}
 
 	if err := u.service.DeleteUser(uint(id)); err != nil {
-		u.logger.Zap.Error(err)
+		u.logger.Error(err)
 		c.JSON(http.StatusInternalServerError, gin.H{
 			"error": err.Error(),
 		})

api/middlewares/cors.go

@@ -23,7 +23,7 @@ func NewCorsMiddleware(handler lib.RequestHandler, logger lib.Logger, env lib.En
 
 // Setup sets up cors middleware
 func (m CorsMiddleware) Setup() {
-	m.logger.Zap.Info("Setting up cors middleware")
+	m.logger.Info("Setting up cors middleware")
 
 	debug := m.env.Environment == "development"
 	m.handler.Gin.Use(cors.New(cors.Options{

api/middlewares/db_trx.go

@@ -40,11 +40,11 @@ func NewDatabaseTrx(
 
 // Setup sets up database transaction middleware
 func (m DatabaseTrx) Setup() {
-	m.logger.Zap.Info("setting up database transaction middleware")
+	m.logger.Info("setting up database transaction middleware")
 
 	m.handler.Gin.Use(func(c *gin.Context) {
 		txHandle := m.db.DB.Begin()
-		m.logger.Zap.Info("beginning database transaction")
+		m.logger.Info("beginning database transaction")
 
 		defer func() {
 			if r := recover(); r != nil {
@@ -57,15 +57,15 @@ func (m DatabaseTrx) Setup() {
 
 		// rollback transaction on server errors
 		if c.Writer.Status() == http.StatusInternalServerError {
-			m.logger.Zap.Info("rolling back transaction due to status code: 500")
+			m.logger.Info("rolling back transaction due to status code: 500")
 			txHandle.Rollback()
 		}
 
 		// commit transaction on success status
 		if statusInList(c.Writer.Status(), []int{http.StatusOK, http.StatusCreated}) {
-			m.logger.Zap.Info("committing transactions")
+			m.logger.Info("committing transactions")
 			if err := txHandle.Commit().Error; err != nil {
-				m.logger.Zap.Error("trx commit error: ", err)
+				m.logger.Error("trx commit error: ", err)
 			}
 		}
 	})

api/middlewares/jwt_auth.go

@@ -44,7 +44,7 @@ func (m JWTAuthMiddleware) Handler() gin.HandlerFunc {
 			c.JSON(http.StatusInternalServerError, gin.H{
 				"error": err.Error(),
 			})
-			m.logger.Zap.Error(err)
+			m.logger.Error(err)
 			c.Abort()
 			return
 		}

api/routes/auth.go

@@ -14,7 +14,7 @@ type AuthRoutes struct {
 
 // Setup user routes
 func (s AuthRoutes) Setup() {
-	s.logger.Zap.Info("Setting up routes")
+	s.logger.Info("Setting up routes")
 	auth := s.handler.Gin.Group("/auth")
 	{
 		auth.POST("/login", s.authController.SignIn)

api/routes/user.go

@@ -16,7 +16,7 @@ type UserRoutes struct {
 
 // Setup user routes
 func (s UserRoutes) Setup() {
-	s.logger.Zap.Info("Setting up routes")
+	s.logger.Info("Setting up routes")
 	api := s.handler.Gin.Group("/api").Use(s.authMiddleware.Handler())
 	{
 		api.GET("/user", s.userController.GetUser)

bootstrap/bootstrap.go

@@ -36,10 +36,10 @@ func bootstrap(
 
 	lifecycle.Append(fx.Hook{
 		OnStart: func(context.Context) error {
-			logger.Zap.Info("Starting Application")
-			logger.Zap.Info("---------------------")
-			logger.Zap.Info("------- CLEAN -------")
-			logger.Zap.Info("---------------------")
+			logger.Info("Starting Application")
+			logger.Info("---------------------")
+			logger.Info("------- CLEAN -------")
+			logger.Info("---------------------")
 
 			conn.SetMaxOpenConns(10)
 			go func() {
@@ -50,7 +50,7 @@ func bootstrap(
 			return nil
 		},
 		OnStop: func(context.Context) error {
-			logger.Zap.Info("Stopping Application")
+			logger.Info("Stopping Application")
 			conn.Close()
 			return nil
 		},

lib/db.go

@@ -41,11 +41,11 @@ func NewDatabase(env Env, zapLogger Logger) Database {
 	})
 
 	if err != nil {
-		zapLogger.Zap.Info("Url: ", url)
-		zapLogger.Zap.Panic(err)
+		zapLogger.Info("Url: ", url)
+		zapLogger.Panic(err)
 	}
 
-	zapLogger.Zap.Info("Database connection established")
+	zapLogger.Info("Database connection established")
 
 	return Database{
 		DB: db,

lib/logger.go

@@ -7,7 +7,7 @@ import (
 
 // Logger structure
 type Logger struct {
-	Zap *zap.SugaredLogger
+	*zap.SugaredLogger
 }
 
 // NewLogger sets up logger
@@ -27,8 +27,5 @@ func NewLogger(env Env) Logger {
 
 	sugar := logger.Sugar()
 
-	return Logger{
-		Zap: sugar,
-	}
-
+	return Logger{sugar}
 }

repository/user_repository.go

@@ -22,7 +22,7 @@ func NewUserRepository(db lib.Database, logger lib.Logger) UserRepository {
 // WithTrx enables repository with transaction
 func (r UserRepository) WithTrx(trxHandle *gorm.DB) UserRepository {
 	if trxHandle == nil {
-		r.logger.Zap.Error("Transaction Database not found in gin context. ")
+		r.logger.Error("Transaction Database not found in gin context. ")
 		return r
 	}
 	r.Database.DB = trxHandle

services/jwt_auth_service.go

@@ -51,7 +51,7 @@ func (s JWTAuthService) CreateToken(user models.User) string {
 	tokenString, err := token.SignedString([]byte(s.env.JWTSecret))
 
 	if err != nil {
-		s.logger.Zap.Error("JWT validation failed: ", err)
+		s.logger.Error("JWT validation failed: ", err)
 	}
 
 	return tokenString