Feature/add email and notification

.env.example

@@ -29,3 +29,4 @@ INTRANET_BASE_URL = https://pg-stage-intranet.joshsoftware.com
 
 SENDGRID_API_KEY=sendgrid_api_key
 SENDER_EMAIL=sendgrid_email
+DEVELOPER_KEY = developer_key

.gitignore

@@ -23,4 +23,5 @@ go.work.sum
 
 .env
 .vscode
-serviceAccountKey.json
+serviceAccountKey.json
+logs/*

cmd/main.go

@@ -17,6 +17,7 @@ import (
 	"github.com/joshsoftware/peerly-backend/internal/app"
 	"github.com/joshsoftware/peerly-backend/internal/app/cronjob"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/config"
+	log "github.com/joshsoftware/peerly-backend/internal/pkg/logger"
 	"github.com/joshsoftware/peerly-backend/internal/repository"
 	script "github.com/joshsoftware/peerly-backend/scripts"
 	"github.com/rs/cors"
@@ -94,13 +95,18 @@ func startApp() (err error) {
 
 	// Context for main function
 	ctx := context.Background()
-	logger.Info("Starting Peerly Application...")
-	defer logger.Info("Shutting Down Peerly Application...")
+	lg,err := log.SetupLogger()
+	if err != nil{
+		logger.Error("logger setup failed ",err.Error())
+		return err
+	}
+	log.Info(ctx,"Starting Peerly Application...")
+	defer log.Info(ctx,"Shutting Down Peerly Application...")
 	//initialize database
 	dbInstance, err := repository.InitializeDatabase()
 	if err != nil {
-		logger.WithField("err", err.Error()).Error("Database init failed")
-		return
+		log.Error(ctx,"Database init failed")
+		return err
 	}
 
 	//cors
@@ -117,17 +123,25 @@ func startApp() (err error) {
 	// Initializing Cron Job
 	scheduler, err := gocron.NewScheduler()
 	if err != nil {
-		logger.Error(ctx, "scheduler creation failed with error: %s", err.Error())
-		return
+		log.Error(ctx, "scheduler creation failed with error: %s", err.Error())
+		return err
 	}
 
 	cronjob.InitializeJobs(services.AppreciationService, services.UserService, scheduler)
-	defer scheduler.Shutdown()
+	defer func() {
+        if err := scheduler.Shutdown(); err != nil {
+            log.Error(ctx, "Scheduler shutdown failed: %s", err.Error())
+        }
+    }()
 	//initialize router
 	router := api.NewRouter(services)
 
-	// init web server
-	server := negroni.Classic()
+	// Negroni logger setup
+	negroniLogger := negroni.NewLogger()
+	negroniLogger.ALogger = lg
+
+	// Initialize web server
+	server := negroni.New(negroniLogger)
 	server.Use(c)
 	server.UseHandler(router)
 

deploy.rb

@@ -22,7 +22,7 @@
 task :production do 
   set :deploy_to, '/www/peerly-backend'
   set :domain, ENV['PEERLY_PRODUCTIONS_IP']
-  set :branch, 'Deployment'
+  set :branch, 'main'
 end
 
 task :setup do

go.mod

@@ -97,5 +97,6 @@ require (
 	google.golang.org/grpc v1.62.1 // indirect
 	google.golang.org/protobuf v1.33.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/natefinch/lumberjack.v2 v2.2.1
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -331,6 +331,8 @@ gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntN
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
 gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA=
 gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
+gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc=
+gopkg.in/natefinch/lumberjack.v2 v2.2.1/go.mod h1:YD8tP3GAjkrDg1eZH7EGmyESg/lsYskCTPBJVb9jqSc=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

internal/api/appreciation.go

@@ -9,62 +9,68 @@ import (
 	"github.com/joshsoftware/peerly-backend/internal/app/appreciation"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/apperrors"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/dto"
+	log "github.com/joshsoftware/peerly-backend/internal/pkg/logger"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/utils"
-	logger "github.com/sirupsen/logrus"
 )
 
 func createAppreciationHandler(appreciationSvc appreciation.Service) http.HandlerFunc {
 	return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
 		var appreciation dto.Appreciation
 		err := json.NewDecoder(req.Body).Decode(&appreciation)
 		if err != nil {
-			logger.Errorf("Error while decoding request data : %v", err)
+			log.Errorf(req.Context(),"Error while decoding request data : %v", err)
 			err = apperrors.JSONParsingErrorReq
 			dto.ErrorRepsonse(rw, err)
 			return
 		}
 
+		log.Info(req.Context(),"createAppreciationHandler: request: ",req)
 		err = appreciation.ValidateCreateAppreciation()
 		if err != nil {
-			logger.Errorf("Error while validating request data : %v", err)
+			log.Errorf(req.Context(),"Error while validating request data : %v", err)
 			dto.ErrorRepsonse(rw, err)
 			return
 		}
 
 		resp, err := appreciationSvc.CreateAppreciation(req.Context(), appreciation)
 		if err != nil {
-			logger.Errorf("err : %v", err)
+			log.Errorf(req.Context(),"createAppreciationHandler: err : %v", err)
 			dto.ErrorRepsonse(rw, err)
 			return
 		}
+		log.Debug(req.Context(),"createAppreciationHandler: response: ",resp)
+		log.Info(req.Context(),"Appreciation created successfully")
 		dto.SuccessRepsonse(rw, http.StatusCreated, "Appreciation created successfully", resp)
 	})
 }
 
 func getAppreciationByIDHandler(appreciationSvc appreciation.Service) http.HandlerFunc {
 	return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
-
 		vars := mux.Vars(req)
 		apprID, err := strconv.Atoi(vars["id"])
 		if err != nil {
+			log.Errorf(req.Context(),"Error while decoding appreciation id : %v", err)
 			dto.ErrorRepsonse(rw, err)
 			return
 		}
-
+
+		log.Info(req.Context(),"getAppreciationByIDHandler: request: ",req)
 		resp, err := appreciationSvc.GetAppreciationById(req.Context(), int32(apprID))
 		if err != nil {
-			logger.Errorf("err : %v", err)
+			log.Errorf(req.Context(),"getAppreciationByIDHandler: err : %v", err)
 			dto.ErrorRepsonse(rw, err)
 			return
 		}
+
+		log.Debug(req.Context(),"getAppreciationByIDHandler: request: ",resp)
+		log.Info(req.Context(),"Appreciation data got successfully")
 		dto.SuccessRepsonse(rw, http.StatusOK, "Appreciation data got successfully", resp)
 	})
 }
 
 // getAppreciationsHandler handles HTTP requests for appreciations
 func listAppreciationsHandler(appreciationSvc appreciation.Service) http.HandlerFunc {
 	return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
-
 		var filter dto.AppreciationFilter
 
 		filter.Name = req.URL.Query().Get("name")
@@ -76,13 +82,15 @@ func listAppreciationsHandler(appreciationSvc appreciation.Service) http.Handler
 		filter.Limit = limit
 		filter.Page = page
 		filter.Self = utils.GetSelfParam(req)
-
+		log.Info(req.Context(),"listAppreciationsHandler: request: ",req)
 		appreciations, err := appreciationSvc.ListAppreciations(req.Context(), filter)
 		if err != nil {
-			logger.Errorf("err : %v", err)
+			log.Errorf(req.Context(),"listAppreciationsHandler: err : %v", err)
 			dto.ErrorRepsonse(rw, err)
 			return
 		}
+		log.Debug(req.Context(),"listAppreciationsHandler: response: ",appreciations)
+		log.Info(req.Context(),"Appreciations data got successfully")
 		dto.SuccessRepsonse(rw, http.StatusOK, "Appreciations data got successfully ", appreciations)
 	})
 }
@@ -92,17 +100,20 @@ func deleteAppreciationHandler(appreciationSvc appreciation.Service) http.Handle
 		vars := mux.Vars(req)
 		apprId, err := strconv.Atoi(vars["id"])
 		if err != nil {
-			logger.Errorf("Error while decoding request param data : %v", err)
+			log.Errorf(req.Context(),"Error while decoding request param data : %v", err)
 			dto.ErrorRepsonse(rw, apperrors.BadRequest)
 			return
 		}
 
+		log.Info(req.Context(),"deleteAppreciationHandler: request: ",req)
 		err = appreciationSvc.DeleteAppreciation(req.Context(), int32(apprId))
 		if err != nil {
-			logger.Errorf("err : %v", err)
+			log.Errorf(req.Context(),"deleteAppreciationHandler: err : %v", err)
 			dto.ErrorRepsonse(rw, err)
 			return
 		}
+		log.Debug(req.Context(),"deleteAppreciationHandler: resp: ",err)
+		log.Info(req.Context(),"Appreciation invalidate successfully")
 		dto.SuccessRepsonse(rw, http.StatusOK, "Appreciation invalidate successfully", nil)
 	})
 }

internal/api/badges.go

@@ -8,7 +8,7 @@ import (
 	"github.com/joshsoftware/peerly-backend/internal/app/badges"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/apperrors"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/dto"
-	logger "github.com/sirupsen/logrus"
+	logger "github.com/joshsoftware/peerly-backend/internal/pkg/logger"
 )
 
 func listBadgesHandler(badgeSvc badges.Service) http.HandlerFunc {
@@ -30,7 +30,7 @@ func editBadgesHandler(badgeSvc badges.Service) http.HandlerFunc {
 		var reqData dto.UpdateBadgeReq
 		err := json.NewDecoder(req.Body).Decode(&reqData)
 		if err != nil {
-			logger.Errorf("error while decoding request data, err: %s", err.Error())
+			logger.Errorf(req.Context(), "error while decoding request data, err: %s", err.Error())
 			err = apperrors.JSONParsingErrorReq
 			dto.ErrorRepsonse(rw, err)
 			return

internal/api/coreValues.go

@@ -8,7 +8,7 @@ import (
 	corevalues "github.com/joshsoftware/peerly-backend/internal/app/coreValues"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/apperrors"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/dto"
-	logger "github.com/sirupsen/logrus"
+	logger "github.com/joshsoftware/peerly-backend/internal/pkg/logger"
 )
 
 func listCoreValuesHandler(coreValueSvc corevalues.Service) http.HandlerFunc {
@@ -46,7 +46,7 @@ func createCoreValueHandler(coreValueSvc corevalues.Service) http.HandlerFunc {
 		var coreValue dto.CreateCoreValueReq
 		err := json.NewDecoder(req.Body).Decode(&coreValue)
 		if err != nil {
-			logger.Errorf("error while decoding request data, err: %s", err.Error())
+			logger.Errorf(req.Context(), "error while decoding request data, err: %s", err.Error())
 			err = apperrors.JSONParsingErrorReq
 			dto.ErrorRepsonse(rw, err)
 			return
@@ -72,7 +72,7 @@ func updateCoreValueHandler(coreValueSvc corevalues.Service) http.HandlerFunc {
 		var updateReq dto.UpdateQueryRequest
 		err := json.NewDecoder(req.Body).Decode(&updateReq)
 		if err != nil {
-			logger.Errorf("error while decoding request data, err: %s", err.Error())
+			logger.Errorf(req.Context(), "error while decoding request data, err: %s", err.Error())
 			err = apperrors.JSONParsingErrorReq
 			dto.ErrorRepsonse(rw, err)
 			return

internal/api/grades.go

@@ -8,7 +8,7 @@ import (
 	"github.com/joshsoftware/peerly-backend/internal/app/grades"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/apperrors"
 	"github.com/joshsoftware/peerly-backend/internal/pkg/dto"
-	logger "github.com/sirupsen/logrus"
+	logger "github.com/joshsoftware/peerly-backend/internal/pkg/logger"
 )
 
 func listGradesHandler(gradeSvc grades.Service) http.HandlerFunc {
@@ -30,7 +30,7 @@ func editGradesHandler(gradeSvc grades.Service) http.HandlerFunc {
 		var reqData dto.UpdateGradeReq
 		err := json.NewDecoder(req.Body).Decode(&reqData)
 		if err != nil {
-			logger.Errorf("error while decoding request data, err: %s", err.Error())
+			logger.Errorf(ctx, "error while decoding request data, err: %s", err.Error())
 			err = apperrors.JSONParsingErrorReq
 			dto.ErrorRepsonse(rw, err)
 			return

internal/api/log.go

@@ -0,0 +1,43 @@
+package api
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	"github.com/joshsoftware/peerly-backend/internal/pkg/apperrors"
+	"github.com/joshsoftware/peerly-backend/internal/pkg/config"
+	"github.com/joshsoftware/peerly-backend/internal/pkg/dto"
+	log "github.com/joshsoftware/peerly-backend/internal/pkg/logger"
+	"github.com/sirupsen/logrus"
+)
+
+
+func loggerHandler(rw http.ResponseWriter, req *http.Request) {
+
+	log.Debug(req.Context(),"loggerHandler: req: ",req)
+	var changeLogRequest dto.ChangeLogLevelRequest
+	err := json.NewDecoder(req.Body).Decode(&changeLogRequest)
+	if err != nil {
+		log.Errorf(req.Context(),"Error while decoding request data : %v", err)
+		err = apperrors.JSONParsingErrorReq
+		dto.ErrorRepsonse(rw, err)
+		return
+	}
+
+	if config.DeveloperKey() != changeLogRequest.DeveloperKey {
+		dto.ErrorRepsonse(rw,apperrors.UnauthorizedDeveloper)
+		return 
+	}
+
+	log.Info(req.Context(), "loggerHandler")
+	if changeLogRequest.LogLevel == "DebugLevel" {
+		log.Logger.SetLevel(logrus.DebugLevel)
+	}else if changeLogRequest.LogLevel == "InfoLevel" {
+		log.Logger.SetLevel(logrus.InfoLevel)
+	}else {
+		dto.ErrorRepsonse(rw, apperrors.InvalidLoggerLevel)
+		return
+	}
+	dto.SuccessRepsonse(rw, http.StatusOK, "Success", fmt.Sprintf("log level changed to %s", changeLogRequest.LogLevel))
+}