feat: caching for show Receipt with Redis

Author: putukrisna6

.env.example

@@ -3,4 +3,8 @@ DB_PASS=test
 DB_HOST=localhost
 DB_NAME=golang_api
 
-JWT_SECRET=jwtsecret123
+JWT_SECRET=jwtsecret123
+
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASS=""

.gitignore

@@ -1,3 +1,4 @@
 database/
 portainer-data/
 .env
+redis-data/

cache/receipt-cache.go

@@ -0,0 +1,54 @@
+package cache
+
+import (
+	"context"
+	"encoding/json"
+	"time"
+
+	"github.com/go-redis/redis/v8"
+	"github.com/putukrisna6/golang-api/entity"
+)
+
+type ReceiptCache interface {
+	Set(key string, value entity.Receipt)
+	Get(key string) entity.Receipt
+}
+
+type receiptCache struct {
+	cache   *redis.Client
+	expires time.Duration
+}
+
+func NewReceiptCache(cache *redis.Client, expires time.Duration) ReceiptCache {
+	return &receiptCache{
+		cache:   cache,
+		expires: expires,
+	}
+}
+
+func (rc *receiptCache) Set(key string, value entity.Receipt) {
+	json, err := json.Marshal(value)
+	if err != nil {
+		panic(err)
+	}
+
+	rc.cache.Set(context.TODO(), key, json, rc.expires*time.Second)
+}
+
+func (rc *receiptCache) Get(key string) entity.Receipt {
+	val, errGet := rc.cache.Get(context.TODO(), key).Result()
+
+	if errGet == redis.Nil {
+		return entity.Receipt{}
+	} else if errGet != nil {
+		panic(errGet)
+	}
+
+	receipt := entity.Receipt{}
+	err := json.Unmarshal([]byte(val), &receipt)
+	if err != nil {
+		panic(err)
+	}
+
+	return receipt
+}

config/redis-config.go

@@ -0,0 +1,28 @@
+package config
+
+import (
+	"os"
+
+	"github.com/go-redis/redis/v8"
+	"github.com/joho/godotenv"
+)
+
+func SetupRedisConnection() *redis.Client {
+	errEnv := godotenv.Load()
+
+	if errEnv != nil {
+		panic("failed to load env")
+	}
+
+	redisPort := os.Getenv("REDIS_PORT")
+	redisPass := os.Getenv("REDIS_PASS")
+	redisHost := os.Getenv("REDIS_HOST")
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     redisHost + ":" + redisPort,
+		Password: redisPass,
+		DB:       0, // use default DB
+	})
+
+	return rdb
+}

controller/receipt-controller.go

@@ -6,6 +6,7 @@ import (
 	"strconv"
 
 	"github.com/gin-gonic/gin"
+	"github.com/putukrisna6/golang-api/cache"
 	"github.com/putukrisna6/golang-api/dto"
 	"github.com/putukrisna6/golang-api/entity"
 	"github.com/putukrisna6/golang-api/helper"
@@ -22,11 +23,13 @@ type ReceiptController interface {
 
 type receiptController struct {
 	receiptService service.ReceiptService
+	receiptCache   cache.ReceiptCache
 }
 
-func NewReceiptController(receiptService service.ReceiptService) ReceiptController {
+func NewReceiptController(receiptService service.ReceiptService, receiptCache cache.ReceiptCache) ReceiptController {
 	return &receiptController{
 		receiptService: receiptService,
+		receiptCache:   receiptCache,
 	}
 }
 
@@ -44,11 +47,15 @@ func (c *receiptController) Show(context *gin.Context) {
 		return
 	}
 
-	var receipt entity.Receipt = c.receiptService.Show(id)
+	var receipt entity.Receipt = c.receiptCache.Get(strconv.FormatUint(id, 10))
 	if (receipt == entity.Receipt{}) {
-		res := helper.BuildErrorResponse("failed to retrieve Receipt", "no data with given receiptID", helper.EmptyObj{})
-		context.AbortWithStatusJSON(http.StatusNotFound, res)
-		return
+		var receipt entity.Receipt = c.receiptService.Show(id)
+		if (receipt == entity.Receipt{}) {
+			res := helper.BuildErrorResponse("failed to retrieve Receipt", "no data with given receiptID", helper.EmptyObj{})
+			context.AbortWithStatusJSON(http.StatusNotFound, res)
+			return
+		}
+		c.receiptCache.Set(strconv.FormatUint(id, 10), receipt)
 	}
 
 	res := helper.BuildValidResponse("OK", receipt)

docker-compose.yml

@@ -31,4 +31,11 @@ services:
       - /var/run/docker.sock:/var/run/docker.sock:ro
       - ./portainer-data:/data
     ports:
-      - 9000:9000
+      - 9000:9000
+  cache:
+    image: redis:alpine
+    restart: always
+    volumes:
+      - ./redis-data:/data
+    ports:
+      - 6379:6379

go.mod

@@ -14,10 +14,13 @@ require (
 )
 
 require (
+	github.com/cespare/xxhash/v2 v2.1.2 // indirect
+	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
 	github.com/gin-contrib/sse v0.1.0 // indirect
 	github.com/go-playground/locales v0.14.0 // indirect
 	github.com/go-playground/universal-translator v0.18.0 // indirect
 	github.com/go-playground/validator/v10 v10.10.1 // indirect
+	github.com/go-redis/redis/v8 v8.11.5 // indirect
 	github.com/go-sql-driver/mysql v1.6.0 // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect

go.sum

@@ -1,9 +1,13 @@
+github.com/cespare/xxhash/v2 v2.1.2 h1:YRXhKfTDauu4ajMg1TPgFO5jnlC2HCbmLXMcTG5cbYE=
+github.com/cespare/xxhash/v2 v2.1.2/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
 github.com/gin-contrib/cors v1.3.1 h1:doAsuITavI4IOcd0Y19U4B+O0dNWihRyX//nn4sEmgA=
 github.com/gin-contrib/cors v1.3.1/go.mod h1:jjEJ4268OPZUcU7k9Pm653S7lXUGcqMADzFA61xsmDk=
 github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE=
@@ -24,6 +28,8 @@ github.com/go-playground/universal-translator v0.18.0/go.mod h1:UvRDBj+xPUEGrFYl
 github.com/go-playground/validator/v10 v10.4.1/go.mod h1:nlOn6nFhuKACm19sB/8EGNn9GlaMV7XkbRSipzJ0Ii4=
 github.com/go-playground/validator/v10 v10.10.1 h1:uA0+amWMiglNZKZ9FJRKUAe9U3RX91eVn1JYXMWt7ig=
 github.com/go-playground/validator/v10 v10.10.1/go.mod h1:i+3WkQ1FvaUjjxh1kSvIA4dMGDBiPU55YFDl0WbKdWU=
+github.com/go-redis/redis/v8 v8.11.5 h1:AcZZR7igkdvfVmQTPnu9WE37LRrO/YrBH5zWyjDC0oI=
+github.com/go-redis/redis/v8 v8.11.5/go.mod h1:gREzHqY1hg6oD9ngVRbLStwAWKhA0FEgq8Jd4h5lpwo=
 github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE=
 github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
 github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=

server.go

@@ -3,6 +3,8 @@ package main
 import (
 	"github.com/gin-contrib/cors"
 	"github.com/gin-gonic/gin"
+	"github.com/go-redis/redis/v8"
+	"github.com/putukrisna6/golang-api/cache"
 	"github.com/putukrisna6/golang-api/config"
 	"github.com/putukrisna6/golang-api/controller"
 	"github.com/putukrisna6/golang-api/middleware"
@@ -17,6 +19,9 @@ var (
 	bookRepository    repository.BookRepository    = repository.NewBookRepository(db)
 	receiptRepository repository.ReceiptRepository = repository.NewReceiptRepository(db)
 
+	rd           *redis.Client      = config.SetupRedisConnection()
+	receiptCache cache.ReceiptCache = cache.NewReceiptCache(rd, 1000) // random expiration lmao
+
 	jwtService     service.JWTService     = service.NewJWTService()
 	authService    service.AuthService    = service.NewAuthService(userRepository)
 	userService    service.UserService    = service.NewUserService(userRepository)
@@ -26,7 +31,7 @@ var (
 	authController    controller.AuthController    = controller.NewAuthController(authService, jwtService)
 	userController    controller.UserController    = controller.NewUserController(userService, jwtService)
 	bookController    controller.BookController    = controller.NewBookController(bookService, jwtService)
-	receiptController controller.ReceiptController = controller.NewReceiptController(receiptService)
+	receiptController controller.ReceiptController = controller.NewReceiptController(receiptService, receiptCache)
 )
 
 func main() {