Add Redis Healthcheck & Refactor Health check (#216)

* fix sql healthcheck
* add redis health check
* remove health handler test as it is not checking functionality

---------

Co-authored-by: umang01-hash <[email protected]>
Co-authored-by: aryan-mehrotra-zs <[email protected]>
Co-authored-by: Srijan Rastogi <[email protected]>

Author: 4 people

go.mod

@@ -4,7 +4,6 @@ go 1.21
 
 require (
 	github.com/DATA-DOG/go-sqlmock v1.5.2
-	github.com/alicebob/miniredis/v2 v2.31.1
 	github.com/go-sql-driver/mysql v1.7.1
 	github.com/gorilla/mux v1.8.1
 	github.com/grpc-ecosystem/go-grpc-middleware v1.4.0
@@ -26,6 +25,7 @@ require (
 
 require (
 	github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a // indirect
+	github.com/alicebob/miniredis/v2 v2.31.1 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect

pkg/gofr/container/container.go

@@ -26,7 +26,13 @@ type Container struct {
 func (c *Container) Health() interface{} {
 	datasources := make(map[string]interface{})
 
-	datasources["sql"] = c.DB.HealthCheck()
+	if c.DB != nil {
+		datasources["sql"] = c.DB.HealthCheck()
+	}
+
+	if c.Redis != nil {
+		datasources["redis"] = c.Redis.HealthCheck()
+	}
 
 	return datasources
 }
@@ -48,6 +54,7 @@ func NewContainer(conf config.Config) *Container {
 		c.Redis, err = redis.NewClient(redis.Config{
 			HostName: host,
 			Port:     port,
+			Options:  nil,
 		}, c.Logger)
 
 		if err != nil {

pkg/gofr/datasource/health.go

@@ -1,5 +1,10 @@
 package datasource
 
+const (
+	StatusUp   = "UP"
+	StatusDown = "DOWN"
+)
+
 type Health struct {
 	Status  string                 `json:"status,omitempty"`
 	Details map[string]interface{} `json:"details,omitempty"`

pkg/gofr/datasource/redis/health.go

@@ -0,0 +1,30 @@
+package redis
+
+import (
+	"context"
+	"time"
+
+	"gofr.dev/pkg/gofr/datasource"
+)
+
+func (r *Redis) HealthCheck() datasource.Health {
+	h := datasource.Health{
+		Details: make(map[string]interface{}),
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second)
+	defer cancel()
+
+	info, err := r.InfoMap(ctx, "Stats").Result()
+	if err != nil {
+		h.Status = datasource.StatusDown
+		h.Details["error"] = err.Error()
+
+		return h
+	}
+
+	h.Status = datasource.StatusUp
+	h.Details["stats"] = info
+
+	return h
+}

pkg/gofr/datasource/sql/health.go

@@ -16,12 +16,13 @@ func (d *DB) HealthCheck() datasource.Health {
 	defer cancel()
 
 	err := d.PingContext(ctx)
-
 	if err != nil {
-		h.Status = "DOWN"
+		h.Status = datasource.StatusDown
+
+		return h
 	}
 
-	h.Status = "UP"
+	h.Status = datasource.StatusUp
 	h.Details["stats"] = d.Stats()
 
 	return h

pkg/gofr/handler_test.go

@@ -48,18 +48,6 @@ func TestHandler_ServeHTTP(t *testing.T) {
 	}
 }
 
-func TestHandler_healthHandler(t *testing.T) {
-	c := Context{
-		Context: context.Background(),
-	}
-
-	data, err := healthHandler(&c)
-
-	assert.Equal(t, "OK", data, "TEST Failed.\n")
-
-	assert.NoError(t, err, "TEST Failed.\n")
-}
-
 func TestHandler_faviconHandler(t *testing.T) {
 	c := Context{
 		Context: context.Background(),