Update cache library, use miniredis for testing, add additional bench…

…marks. (#14)

Update cache library,
Update logging library,
use miniredis for testing, add additional benchmarks.

.github/workflows/autoupdate.yaml

@@ -0,0 +1,73 @@
+name: Test and release
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 3 * * *"
+
+env:
+  GO_VERSION: ">=1.21"
+
+jobs:
+  # This job is responsible for preparation of the build
+  # environment variables.
+  prepare:
+    name: Preparing build context
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Install Go
+        uses: actions/setup-go@v5
+        id: cache
+        with:
+          go-version: ${{env.GO_VERSION}}
+          cache-dependency-path: "**/*.sum"
+
+      - name: Go get dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          go get ./...
+
+  # This job is responsible for running tests and linting the codebase
+  test:
+    name: "Unit testing"
+    # needs: [prepare]
+    runs-on: ubuntu-latest
+    container: golang:1
+    # container: github/super-linter:v4
+    needs: [prepare]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{env.GO_VERSION}}
+          cache-dependency-path: "**/*.sum"
+
+      - name: Install dependencies
+        run: |
+          apt-get update
+          apt-get install ca-certificates make -y
+          update-ca-certificates
+          go mod tidy
+          get -u -v ./...
+          go mod tidy -v
+
+      - name: Run unit tests
+        run: |
+          CI_RUN=${CI} make test
+
+      # if go.mod or go.sum have changed then commit the changes to the repository
+      - name: Commit changes
+        run: |
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+          git add go.mod go.sum
+          git commit -m "Update go.mod and go.sum"
+          git push

.github/workflows/pr.yaml

@@ -47,20 +47,20 @@ jobs:
     # container: github/super-linter:v4
     needs: [prepare]
 
-    services:
-      # Label used to access the service container
-      redis:
-        # Docker Hub image
-        image: redis
-        # Set health checks to wait until redis has started
-        options: >-
-          --health-cmd "redis-cli ping"
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-        ports:
-          # Maps the container port to the host machine
-          - 6379:6379
+    # services:
+    #   # Label used to access the service container
+    #   redis:
+    #     # Docker Hub image
+    #     image: redis
+    #     # Set health checks to wait until redis has started
+    #     options: >-
+    #       --health-cmd "redis-cli ping"
+    #       --health-interval 10s
+    #       --health-timeout 5s
+    #       --health-retries 5
+    #     ports:
+    #       # Maps the container port to the host machine
+    #       - 6379:6379
 
     steps:
       - name: Checkout repository
@@ -80,10 +80,5 @@ jobs:
           go mod tidy
 
       - name: Run unit tests
-        env:
-          REDIS_HOST: redis
-          REDIS_PORT: 6379
-          REDIS_SERVER: "redis:6379"
         run: |
-          export REDIS_SERVER="$REDIS_HOST:$REDIS_PORT"
           CI_RUN=${CI} make test

.gitignore

@@ -1,2 +1,3 @@
 graphql-proxy
 test.sh
+banned.json*

Makefile

@@ -1,9 +1,9 @@
 CI_RUN?=false
-ADDITIONAL_BUILD_FLAGS=""
+# ADDITIONAL_BUILD_FLAGS=""
 
-ifeq ($(CI_RUN), true)
-	ADDITIONAL_BUILD_FLAGS="-test.short"
-endif
+# ifeq ($(CI_RUN), true)
+# 	ADDITIONAL_BUILD_FLAGS="-test.short"
+# endif
 
 .PHONY: help
 help:  ## display this help
@@ -19,7 +19,7 @@ build: ## build the binary
 
 .PHONY: test
 test: ## run tests on library
-	@LOG_LEVEL=debug go test $(ADDITIONAL_BUILD_FLAGS) -v -cover ./... -race
+	@LOG_LEVEL=info go test -v -cover -race ./...
 
 .PHONY: test-packages
 test-packages: ## run tests on packages

api.go

@@ -8,7 +8,9 @@ import (
 	"github.com/goccy/go-json"
 	fiber "github.com/gofiber/fiber/v2"
 	"github.com/gofrs/flock"
+	libpack_cache "github.com/lukaszraczylo/graphql-monitoring-proxy/cache"
 	libpack_config "github.com/lukaszraczylo/graphql-monitoring-proxy/config"
+	libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
 )
 
 var bannedUsersIDs map[string]string = make(map[string]string)
@@ -29,43 +31,63 @@ func enableApi() {
 		go periodicallyReloadBannedUsers()
 		err := apiserver.Listen(fmt.Sprintf(":%d", cfg.Server.ApiPort))
 		if err != nil {
-			cfg.Logger.Critical("Can't start the service", map[string]interface{}{"error": err.Error()})
+			cfg.Logger.Critical(&libpack_logger.LogMessage{
+				Message: "Can't start the service",
+				Pairs:   map[string]interface{}{"port": cfg.Server.ApiPort},
+			})
 		}
 	}
 }
 
 func periodicallyReloadBannedUsers() {
 	for {
 		loadBannedUsers()
-		cfg.Logger.Debug("Banned users reloaded", map[string]interface{}{"users": bannedUsersIDs})
+		cfg.Logger.Debug(&libpack_logger.LogMessage{
+			Message: "Banned users reloaded",
+			Pairs:   map[string]interface{}{"users": bannedUsersIDs},
+		})
 		<-time.After(10 * time.Second)
 	}
 }
 
 func checkIfUserIsBanned(c *fiber.Ctx, userID string) bool {
 	_, found := bannedUsersIDs[userID]
-	cfg.Logger.Debug("Checking if user is banned", map[string]interface{}{"user_id": userID, "found": found})
+	cfg.Logger.Debug(&libpack_logger.LogMessage{
+		Message: "Checking if user is banned",
+		Pairs:   map[string]interface{}{"user_id": userID, "found": found},
+	})
 	if found {
-		cfg.Logger.Info("User is banned", map[string]interface{}{"user_id": userID})
+		cfg.Logger.Info(&libpack_logger.LogMessage{
+			Message: "User is banned",
+			Pairs:   map[string]interface{}{"user_id": userID},
+		})
 		c.Status(403).SendString("User is banned")
 	}
 	return found
 }
 
 func apiClearCache(c *fiber.Ctx) error {
-	cfg.Logger.Debug("Clearing cache via API", nil)
-	cacheClear()
-	cfg.Logger.Info("Cache cleared via API", nil)
+	cfg.Logger.Debug(&libpack_logger.LogMessage{
+		Message: "Clearing cache via API",
+		Pairs:   nil,
+	})
+	libpack_cache.CacheClear()
+	cfg.Logger.Info(&libpack_logger.LogMessage{
+		Message: "Cache cleared via API",
+		Pairs:   nil,
+	})
 	c.Status(200).SendString("OK: cache cleared")
 	return nil
 }
 
 func apiCacheStats(c *fiber.Ctx) error {
-	stats := getCacheStats()
-	cfg.Logger.Debug("Getting cache stats via API", map[string]interface{}{"stats": stats})
+	stats := libpack_cache.GetCacheStats()
 	err := c.JSON(stats)
 	if err != nil {
-		cfg.Logger.Error("Can't marshal cache stats", map[string]interface{}{"error": err.Error()})
+		cfg.Logger.Error(&libpack_logger.LogMessage{
+			Message: "Can't marshal cache stats",
+			Pairs:   map[string]interface{}{"error": err.Error()},
+		})
 		return err
 	}
 	return nil
@@ -80,11 +102,17 @@ func apiBanUser(c *fiber.Ctx) error {
 	var req apiBanUserRequest
 	err := c.BodyParser(&req)
 	if err != nil {
-		cfg.Logger.Error("Can't parse the ban user request", map[string]interface{}{"error": err.Error()})
+		cfg.Logger.Error(&libpack_logger.LogMessage{
+			Message: "Can't parse the ban user request",
+			Pairs:   map[string]interface{}{"error": err.Error()},
+		})
 		return err
 	}
 	bannedUsersIDs[req.UserID] = req.Reason
-	cfg.Logger.Info("Banned user", map[string]interface{}{"user_id": req.UserID, "reason": req.Reason})
+	cfg.Logger.Info(&libpack_logger.LogMessage{
+		Message: "Banned user",
+		Pairs:   map[string]interface{}{"user_id": req.UserID, "reason": req.Reason},
+	})
 	storeBannedUsers()
 	c.Status(200).SendString("OK: user banned")
 	return nil
@@ -94,11 +122,17 @@ func apiUnbanUser(c *fiber.Ctx) error {
 	var req apiBanUserRequest
 	err := c.BodyParser(&req)
 	if err != nil {
-		cfg.Logger.Error("Can't parse the unban user request", map[string]interface{}{"error": err.Error()})
+		cfg.Logger.Error(&libpack_logger.LogMessage{
+			Message: "Can't parse the unban user request",
+			Pairs:   map[string]interface{}{"error": err.Error()},
+		})
 		return err
 	}
 	delete(bannedUsersIDs, req.UserID)
-	cfg.Logger.Info("Unbanned user", map[string]interface{}{"user_id": req.UserID})
+	cfg.Logger.Info(&libpack_logger.LogMessage{
+		Message: "Unbanned user",
+		Pairs:   map[string]interface{}{"user_id": req.UserID},
+	})
 	storeBannedUsers()
 	c.Status(200).SendString("OK: user unbanned")
 	return nil
@@ -108,54 +142,81 @@ func storeBannedUsers() {
 	fileLock := flock.New(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
 	err := fileLock.Lock()
 	if err != nil {
-		cfg.Logger.Error("Can't lock the file", map[string]interface{}{"error": err.Error()})
+		cfg.Logger.Error(&libpack_logger.LogMessage{
+			Message: "Can't lock the file",
+			Pairs:   map[string]interface{}{"error": err.Error()},
+		})
 		return
 	}
 	defer fileLock.Unlock()
 	data, err := json.Marshal(bannedUsersIDs)
 	if err != nil {
-		cfg.Logger.Error("Can't marshal banned users", map[string]interface{}{"error": err.Error()})
+		cfg.Logger.Error(&libpack_logger.LogMessage{
+			Message: "Can't marshal banned users",
+			Pairs:   map[string]interface{}{"error": err.Error()},
+		})
 		return
 	}
 	err = os.WriteFile(cfg.Api.BannedUsersFile, data, 0644)
 	if err != nil {
-		cfg.Logger.Error("Can't write banned users to file", map[string]interface{}{"error": err.Error()})
+		cfg.Logger.Error(&libpack_logger.LogMessage{
+			Message: "Can't write banned users to file",
+			Pairs:   map[string]interface{}{"error": err.Error()},
+		})
 		return
 	}
 }
 
 func loadBannedUsers() {
 	if _, err := os.Stat(cfg.Api.BannedUsersFile); os.IsNotExist(err) {
-		cfg.Logger.Info("Banned users file doesn't exist - creating it", map[string]interface{}{"file": cfg.Api.BannedUsersFile})
+		cfg.Logger.Info(&libpack_logger.LogMessage{
+			Message: "Banned users file doesn't exist - creating it",
+			Pairs:   map[string]interface{}{"file": cfg.Api.BannedUsersFile},
+		})
 		_, err := os.Create(cfg.Api.BannedUsersFile)
 		if err != nil {
-			cfg.Logger.Error("Can't create the file", map[string]interface{}{"error": err.Error()})
+			cfg.Logger.Error(&libpack_logger.LogMessage{
+				Message: "Can't create the file",
+				Pairs:   map[string]interface{}{"error": err.Error()},
+			})
 			return
 		}
 		// write empty json to the file
 		err = os.WriteFile(cfg.Api.BannedUsersFile, []byte("{}"), 0644)
 		if err != nil {
-			cfg.Logger.Error("Can't write to the file", map[string]interface{}{"error": err.Error()})
+			cfg.Logger.Error(&libpack_logger.LogMessage{
+				Message: "Can't write to the file",
+				Pairs:   map[string]interface{}{"error": err.Error()},
+			})
 			return
 		}
 	}
 
 	fileLock := flock.New(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
 	err := fileLock.RLock() // Use RLock for read lock
 	if err != nil {
-		cfg.Logger.Error("Can't lock the file [load]", map[string]interface{}{"error": err.Error()})
+		cfg.Logger.Error(&libpack_logger.LogMessage{
+			Message: "Can't lock the file [load]",
+			Pairs:   map[string]interface{}{"error": err.Error()},
+		})
 		return
 	}
 	defer fileLock.Unlock()
 
 	data, err := os.ReadFile(cfg.Api.BannedUsersFile)
 	if err != nil {
-		cfg.Logger.Error("Can't read banned users from file", map[string]interface{}{"error": err.Error()})
+		cfg.Logger.Error(&libpack_logger.LogMessage{
+			Message: "Can't read banned users from file",
+			Pairs:   map[string]interface{}{"error": err.Error()},
+		})
 		return
 	}
 	err = json.Unmarshal(data, &bannedUsersIDs)
 	if err != nil {
-		cfg.Logger.Error("Can't unmarshal banned users", map[string]interface{}{"error": err.Error()})
+		cfg.Logger.Error(&libpack_logger.LogMessage{
+			Message: "Can't unmarshal banned users",
+			Pairs:   map[string]interface{}{"error": err.Error()},
+		})
 		return
 	}
 }