Merge pull request #21 from DoWithLogic/feat/healthcheck-and-graceful-shutdown

chore: add graceful Shutdown and healthcheck

Author: martinyonatann

README.md

@@ -65,7 +65,7 @@ The DIP promotes high-level modules (e.g., use cases) to depend on abstractions
   - [x] [Go-Standards](https://github.com/golang-standards/project-layout) Project Layout
   - [x] Environment Variable Configuration
   - [x] Health-Check and Debug API
-  - [ ] Graceful Shutdown
+  - [x] Graceful Shutdown
 - Layered architecture
   - [x] [SOLID Principle](https://en.wikipedia.org/wiki/SOLID)
   - [x] Database Transaction

cmd/api/main.go

@@ -19,8 +19,5 @@ func main() {
 		panic(err)
 	}
 
-	app := app.NewApp(context.Background(), cfg)
-	if err := app.Start(); err != nil {
-		panic(err)
-	}
+	app.NewApp(context.Background(), cfg).Run()
 }

internal/app/app.go

@@ -4,6 +4,9 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"os/signal"
+	"syscall"
+	"time"
 
 	_ "github.com/go-sql-driver/mysql"
 
@@ -13,6 +16,7 @@ import (
 	"github.com/DoWithLogic/golang-clean-architecture/pkg/otel/zerolog"
 	"github.com/jmoiron/sqlx"
 	"github.com/labstack/echo/v4"
+	"github.com/labstack/gommon/log"
 )
 
 type App struct {
@@ -36,13 +40,29 @@ func NewApp(ctx context.Context, cfg config.Config) *App {
 	}
 }
 
-func (app *App) Start() error {
-	if err := app.StartService(); err != nil {
+func (app *App) Run() error {
+	if err := app.startService(); err != nil {
 		app.log.Z().Err(err).Msg("[app]StartService")
 
 		return err
 	}
 
+	// Wait for interrupt signal to gracefully shutdown the server with a timeout of 10 seconds.
+	// Use a buffered channel to avoid missing signals as recommended for signal.Notify
+	quit := make(chan os.Signal, 1)
+	signal.Notify(quit, syscall.SIGTERM)
+	signal.Notify(quit, syscall.SIGINT)
+
+	go func() {
+		<-quit
+		log.Info("Server is shutting down...")
+
+		ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+		defer cancel()
+		app.db.Close()
+		app.echo.Shutdown(ctx)
+	}()
+
 	app.echo.Debug = app.cfg.Server.Debug
 	app.echo.Use(middleware.AppCors())
 	app.echo.Use(middleware.CacheWithRevalidation)

internal/app/service.go

@@ -1,17 +1,23 @@
 package app
 
 import (
+	"net/http"
+
 	userV1 "github.com/DoWithLogic/golang-clean-architecture/internal/users/delivery/http/v1"
 	userRepository "github.com/DoWithLogic/golang-clean-architecture/internal/users/repository"
 	userUseCase "github.com/DoWithLogic/golang-clean-architecture/internal/users/usecase"
+	"github.com/labstack/echo/v4"
 )
 
-func (app *App) StartService() error {
+func (app *App) startService() error {
 	userRepo := userRepository.NewRepository(app.db)
 	userUC := userUseCase.NewUseCase(userRepo, app.cfg)
 	userCTRL := userV1.NewHandlers(userUC)
 
 	domain := app.echo.Group("/api/v1/users")
+	domain.GET("/ping", func(c echo.Context) error {
+		return c.String(http.StatusOK, "Hello Word 👋")
+	})
 
 	userCTRL.UserRoutes(domain, app.cfg)
 

internal/users/delivery/http/v1/route.go

@@ -7,7 +7,7 @@ import (
 )
 
 func (h *handlers) UserRoutes(domain *echo.Group, cfg config.Config) {
-	domain.POST("", h.CreateUser)
+	domain.POST("/", h.CreateUser)
 	domain.POST("/login", h.Login)
 	domain.GET("/detail", h.UserDetail, middleware.AuthorizeJWT(cfg))
 	domain.PATCH("/update", h.UpdateUser, middleware.AuthorizeJWT(cfg))