Implement benchmark for Redis backend

Author: VojtechVitek

.github/workflows/benchmark.yml

@@ -0,0 +1,50 @@
+name: Bechmark
+
+on:
+  pull_request:
+
+jobs:
+  benchmark:
+    name: Benchmark
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ^1.17
+
+      - name: Git clone (master)
+        uses: actions/checkout@v4
+        with:
+          ref: master
+
+      - name: Run benchmark (master)
+        run: go test -bench=. -count=10 -benchmem | tee /tmp/master.txt
+
+      - name: Git clone (PR)
+        uses: actions/checkout@v4
+
+      - name: Run benchmark (PR)
+        run: go test -bench=. -count=10 -benchmem | tee /tmp/pr.txt
+
+      - name: Install benchstat
+        run: go install golang.org/x/perf/cmd/benchstat@latest
+
+      - name: Run benchstat
+        run: cd /tmp && benchstat master.txt pr.txt | tee /tmp/result.txt
+
+      - name: Comment on PR with benchmark results
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const fs = require('fs');
+            const results = fs.readFileSync('/tmp/result.txt', 'utf8');
+            const issue_number = context.payload.pull_request.number;
+            const { owner, repo } = context.repo;
+
+            await github.rest.issues.createComment({
+              owner,
+              repo,
+              issue_number,
+              body: `### Benchmark Results\n\n\`\`\`\n${results}\n\`\`\``
+            });

README.md

@@ -22,7 +22,7 @@ import (
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/chi/v5/middleware"
 	"github.com/go-chi/httprate"
-    httprateredis "github.com/go-chi/httprate-redis"
+	httprateredis "github.com/go-chi/httprate-redis"
 )
 
 func main() {

httprateredis_test.go

@@ -3,6 +3,7 @@ package httprateredis_test
 import (
 	"fmt"
 	"math/rand"
+	"sync"
 	"testing"
 	"time"
 
@@ -150,3 +151,46 @@ func TestRedisCounter(t *testing.T) {
 		}
 	}
 }
+
+func BenchmarkLocalCounter(b *testing.B) {
+	limitCounter, err := httprateredis.NewRedisLimitCounter(&httprateredis.Config{
+		Host:       "localhost",
+		Port:       6379,
+		MaxIdle:    500,
+		MaxActive:  500,
+		DBIndex:    0,
+		ClientName: "httprateredis_test",
+		PrefixKey:  fmt.Sprintf("httprate:test:%v", rand.Int31n(100000)), // Unique key for each test
+	})
+	if err != nil {
+		b.Fatalf("redis not available: %v", err)
+	}
+
+	limitCounter.Config(1000, time.Minute)
+
+	currentWindow := time.Now().UTC().Truncate(time.Minute)
+	previousWindow := currentWindow.Add(-time.Minute)
+
+	b.ResetTimer()
+
+	for i := 0; i < b.N; i++ {
+		for i := range []int{0, 1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 3, 0, 0, 0, 0, 1, 0} {
+			// Simulate time.
+			currentWindow.Add(time.Duration(i) * time.Minute)
+			previousWindow.Add(time.Duration(i) * time.Minute)
+
+			wg := sync.WaitGroup{}
+			wg.Add(1000)
+			for i := 0; i < 1000; i++ {
+				// Simulate concurrent requests with different rate-limit keys.
+				go func(i int) {
+					defer wg.Done()
+
+					_, _, _ = limitCounter.Get(fmt.Sprintf("key:%v", i), currentWindow, previousWindow)
+					_ = limitCounter.IncrementBy(fmt.Sprintf("key:%v", i), currentWindow, rand.Intn(100))
+				}(i)
+			}
+			wg.Wait()
+		}
+	}
+}