Compare commits

..
9 Commits
142 changed files with 1498 additions and 44837 deletions
-19
View File
@@ -1,19 +0,0 @@
name: Autoupdate go.mod and go.sum
on:
workflow_dispatch:
schedule:
- cron: "0 3 * * *"
permissions:
contents: write
actions: write
pull-requests: write
jobs:
autoupdate:
uses: lukaszraczylo/shared-actions/.github/workflows/go-autoupdate.yaml@main
with:
go-version: ">=1.26.6"
release-workflow: "release.yaml"
secrets: inherit
+72 -7
View File
@@ -1,16 +1,81 @@
name: Pull Request
name: Run tests on PR
on:
pull_request:
branches:
- main
- "main"
push:
paths-ignore:
- "**/**.md"
- "**/**.yaml"
- "static/**"
branches:
- "**"
- "!main"
env:
GO_VERSION: ">=1.21"
jobs:
pr-checks:
uses: lukaszraczylo/shared-actions/.github/workflows/go-pr.yaml@main
with:
go-version: "1.26.6"
# 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: 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
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: |
go mod tidy
- name: Run unit tests
env:
REDIS_HOST: redis
REDIS_PORT: 6379
run: |
export REDIS_SERVER="$REDIS_HOST:$REDIS_PORT"
CI_RUN=${CI} make test
-67
View File
@@ -1,67 +0,0 @@
name: Release
on:
workflow_dispatch:
push:
paths-ignore:
- "**.md"
- "**/release.yaml"
- "static/**"
- "docs/**"
branches:
- main
permissions:
id-token: write
contents: write
packages: write
deployments: write
jobs:
release:
uses: lukaszraczylo/shared-actions/.github/workflows/go-release.yaml@main
with:
go-version: "1.26.6"
docker-enabled: true
secrets: inherit
benchmark:
name: Publish Benchmarks
needs: release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
ref: main
- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: "1.26.6"
- name: Run benchmarks
run: go test -bench=. -benchmem ./... -run=^# | tee output.txt
- name: Store benchmark result
uses: benchmark-action/github-action-benchmark@v1
with:
tool: "go"
output-file-path: output.txt
fail-on-alert: true
github-token: ${{ secrets.GITHUB_TOKEN }}
comment-on-alert: true
summary-always: true
auto-push: false
benchmark-data-dir-path: "docs/bench"
- name: Push benchmark results
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add docs/bench
git diff --staged --quiet || git commit -m "Update benchmark results"
git push origin main
+20
View File
@@ -0,0 +1,20 @@
name: Test and release
on:
workflow_dispatch:
push:
paths-ignore:
- '**/**.md'
- '**/**.yaml'
- 'static/**'
branches:
- 'main'
jobs:
shared:
uses: telegram-bot-app/ci-scripts/.github/workflows/build-test-publish-inject.yaml@main
with:
enable-code-scans: false
should-deploy: false
secrets:
ghcr-token: ${{ secrets.GHCR_TOKEN }}
-5
View File
@@ -1,7 +1,2 @@
graphql-proxy
test.sh
banned.json*
dist/
coverage.out
CLAUDE.md
graphql-monitoring-proxy
-116
View File
@@ -1,116 +0,0 @@
# Project-specific golangci-lint configuration (v2)
version: "2"
linters:
default: none
enable:
# Code quality
- govet # Go vet (suspicious constructs)
- staticcheck # Advanced static analysis
- unused # Find unused code
- errcheck # Check for unchecked errors
# Security
- gosec # Security issues
settings:
unused:
field-writes-are-uses: true
post-statements-are-reads: true
exported-is-used: true
exported-fields-are-used: true
govet:
enable-all: true
disable:
# Field alignment is a micro-optimization that reduces readability
- fieldalignment
# Shadow warnings in this codebase are intentional and safe
- shadow
staticcheck:
checks:
- "all"
# Disable naming convention checks - existing codebase uses underscores
# and ALL_CAPS which would require significant refactoring
- "-ST1000" # Package comments
- "-ST1003" # Naming conventions (underscores, ALL_CAPS)
# Disable quickfix suggestions - these are style preferences, not errors
- "-QF1001" # De Morgan's law
- "-QF1012" # fmt.Fprintf suggestion
errcheck:
# Don't check error returns on these functions (best-effort cleanup)
exclude-functions:
- (*github.com/gorilla/websocket.Conn).Close
- (*github.com/gorilla/websocket.Conn).SetReadDeadline
- (*github.com/gorilla/websocket.Conn).WriteMessage
- (*github.com/redis/go-redis/v9.Client).Close
- (*github.com/redis/go-redis/v9.Pipeline).Exec
- (io.Closer).Close
- (*os.File).Close
- (*compress/gzip.Reader).Close
- (net.Conn).Close
gosec:
excludes:
# G104: Errors unhandled - covered by errcheck with proper exclusions
- G104
# G115: Integer overflow conversion - safe in this codebase
# These are uint64 counter values that will never exceed int64 max
- G115
# G402: TLS InsecureSkipVerify - this is a configurable option
# Users explicitly enable this via GMP_DISABLE_TLS_VERIFY env var
- G402
exclusions:
presets:
- common-false-positives
rules:
# Test files can have relaxed rules
- path: _test\.go
linters:
- unused
- errcheck
- gosec
# Specific file exclusions for known patterns
- path: api\.go
linters:
- gosec
text: "G306"
# File permissions 0644 for banned users file is intentional
# This is a non-sensitive configuration file that may be
# read by deployment tools
# Exclude enableApi naming (would be a breaking change)
- path: api\.go
text: "ST1003"
# Generated files
- path: \.pb\.go$
linters:
- all
formatters:
enable:
- gofmt
settings:
gofmt:
simplify: true
run:
timeout: 5m
tests: true
modules-download-mode: readonly
build-tags:
- ""
go: "1.23"
output:
formats:
text:
path: stdout
colors: true
sort-results: true
-88
View File
@@ -1,88 +0,0 @@
version: 2
before:
hooks:
- go mod tidy
builds:
- id: graphql-proxy
main: .
binary: graphql-proxy
env:
- CGO_ENABLED=0
goos:
- linux
- darwin
- windows
goarch:
- amd64
- arm64
ldflags:
- -s -w
- -X main.appVersion={{.Version}}
archives:
- id: graphql-proxy
formats: [tar.gz]
name_template: "graphql-proxy-{{ .Os }}-{{ .Arch }}"
format_overrides:
- goos: windows
formats: [zip]
files:
- LICENSE
- README.md
checksum:
name_template: "graphql-proxy-checksums.txt"
algorithm: sha256
changelog:
sort: asc
filters:
exclude:
- '^docs:'
- '^test:'
- '^Merge'
- '^WIP'
- '^Update go.mod'
release:
github:
owner: lukaszraczylo
name: graphql-monitoring-proxy
name_template: "version {{.Version}}"
draft: false
prerelease: auto
dockers_v2:
- images:
- "ghcr.io/lukaszraczylo/graphql-monitoring-proxy"
tags:
- "{{ .Version }}"
- "latest"
platforms:
- linux/amd64
- linux/arm64
dockerfile: Dockerfile.goreleaser
extra_files:
- static/app
signs:
- cmd: cosign
signature: "${artifact}.sigstore.json"
args:
- sign-blob
- "--bundle=${signature}"
- "${artifact}"
- "--yes"
artifacts: checksum
output: true
docker_signs:
- cmd: cosign
artifacts: manifests
output: true
args:
- sign
- "${artifact}@${digest}"
- "--yes"
-3
View File
@@ -1,3 +0,0 @@
### CODEOWNERS
* @lukaszraczylo @lukaszraczylo-dev
+3 -6
View File
@@ -3,11 +3,8 @@ WORKDIR /go/src/app
ARG TARGETARCH
ARG TARGETOS
# silly workaround for distroless image as no chmod is available
COPY --chmod=777 --chown=nonroot:nonroot static/app /go/src/app
COPY --chmod=777 static/app /app
ADD static/default-ratelimit.json /app/ratelimit.json
ADD static/default-banned_users.json /app/banned_users.json
ADD dist/bot-$TARGETOS-$TARGETARCH /go/src/app/graphql-proxy
# Runtime tuning: operators should override GOMEMLIMIT per deployment
# to match container memory limits (e.g. set to ~80% of cgroup limit).
ENV GOMEMLIMIT=512MiB
# NOTE: no HEALTHCHECK — distroless:nonroot lacks /bin/sh and curl/wget.
# Use orchestrator-level probes (Kubernetes liveness/readiness) hitting /live on monitoring port.
ENTRYPOINT ["/go/src/app/graphql-proxy"]
-11
View File
@@ -1,11 +0,0 @@
FROM gcr.io/distroless/base-debian12:nonroot
ARG TARGETPLATFORM
WORKDIR /go/src/app
COPY --chmod=777 --chown=nonroot:nonroot static/app /go/src/app
COPY ${TARGETPLATFORM}/graphql-proxy /go/src/app/graphql-proxy
# Runtime tuning: operators should override GOMEMLIMIT per deployment
# to match container memory limits (e.g. set to ~80% of cgroup limit).
ENV GOMEMLIMIT=512MiB
# NOTE: no HEALTHCHECK — distroless:nonroot lacks /bin/sh and curl/wget.
# Use orchestrator-level probes (Kubernetes liveness/readiness) hitting /live on monitoring port.
ENTRYPOINT ["/go/src/app/graphql-proxy"]
+1 -1
View File
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
+8 -40
View File
@@ -1,19 +1,9 @@
CI_RUN?=false
TIMESTAMP := $(shell date +%Y%m%d-%H%M%S)
ADDITIONAL_BUILD_FLAGS=""
# Build hardening flags
# -s: omit symbol table, -w: omit DWARF debug info (smaller binaries)
LDFLAGS ?= -s -w
# -trimpath: remove local filesystem paths from binary (reproducible builds)
GOFLAGS ?= -trimpath
# CGO_ENABLED=0: static binary, no libc dependency (distroless-friendly)
export CGO_ENABLED = 0
# 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
@@ -21,19 +11,19 @@ help: ## display this help
.PHONY: run
run: build ## run application
@LOG_LEVEL=debug PURGE_METRICS_ON_CRAWL=true BLOCK_SCHEMA_INTROSPECTION=true CACHE_TTL=10 JWT_ROLE_RATE_LIMIT=false JWT_ROLE_CLAIM_PATH="Hasura.x-hasura-default-role" JWT_USER_CLAIM_PATH="Hasura.x-hasura-user-id" HOST_GRAPHQL=https://hasura8.lan/ HEALTHCHECK_GRAPHQL_URL=https://hasura8.lan/v1/graphql MONITORING_PORT=8222 PORT_GRAPHQL=8111 ./graphql-proxy
@LOG_LEVEL=debug PURGE_METRICS_ON_CRAWL=true BLOCK_SCHEMA_INTROSPECTION=false CACHE_TTL=10 JWT_ROLE_RATE_LIMIT=false JWT_ROLE_CLAIM_PATH="Hasura.x-hasura-default-role" JWT_USER_CLAIM_PATH="Hasura.x-hasura-user-id" HOST_GRAPHQL=https://hasura8.lan/ HEALTHCHECK_GRAPHQL_URL=https://hasura8.lan/v1/graphql ./graphql-proxy
.PHONY: build
build: ## build the binary
go build $(GOFLAGS) -ldflags="$(LDFLAGS)" -o graphql-proxy *.go
go build -o graphql-proxy *.go
.PHONY: test
test: ## run tests on library
@CGO_ENABLED=1 LOG_LEVEL=info go test -v -cover -race ./...
@LOG_LEVEL=debug go test $(ADDITIONAL_BUILD_FLAGS) -v -cover ./... -race
.PHONY: test-packages
test-packages: ## run tests on packages
@CGO_ENABLED=1 go test -v -cover -race ./pkg/...
@go test -v -cover ./pkg/...
.PHONY: all
all: test-packages test
@@ -42,25 +32,3 @@ all: test-packages test
update: ## update dependencies
@go get -u -v ./...
@go mod tidy -v
.PHONY: build-amd64
build-amd64: ## build the Linux AMD64 binary
GOOS=linux GOARCH=amd64 go build $(GOFLAGS) -ldflags="$(LDFLAGS)" -o graphql-proxy-amd64 *.go
.PHONY: build-arm64
build-arm64: ## build the Linux ARM64 binary
GOOS=linux GOARCH=arm64 go build $(GOFLAGS) -ldflags="$(LDFLAGS)" -o graphql-proxy-arm64 *.go
.PHONY: build-all
build-all: build-amd64 build-arm64 ## build both AMD64 and ARM64 binaries
.PHONY: docker
docker: build-all ## build multi-arch (AMD64 and ARM64) docker image
@mkdir -p dist
@mv graphql-proxy-amd64 dist/bot-linux-amd64
@mv graphql-proxy-arm64 dist/bot-linux-arm64
@docker buildx build --push \
--platform linux/amd64,linux/arm64 \
-t ghcr.io/lukaszraczylo/graphql-monitoring-proxy:local-test-build-$(TIMESTAMP) \
.
+42 -915
View File
File diff suppressed because it is too large Load Diff
-1075
View File
File diff suppressed because it is too large Load Diff
-1021
View File
File diff suppressed because it is too large Load Diff
-247
View File
@@ -1,247 +0,0 @@
package main
import (
"encoding/json"
"io"
"net/http/httptest"
"testing"
"github.com/gofiber/fiber/v3"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
"github.com/stretchr/testify/assert"
)
// newClusterApp registers all cluster + control routes on a fresh Fiber app.
func newClusterApp(t *testing.T) (*fiber.App, *AdminDashboard) {
t.Helper()
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
return app, dashboard
}
// ensureNilAggregator guarantees no metrics aggregator is active for the test
// and restores the original value after.
func ensureNilAggregator(t *testing.T) {
t.Helper()
aggregatorMutex.Lock()
orig := metricsAggregator
metricsAggregator = nil
aggregatorMutex.Unlock()
t.Cleanup(func() {
aggregatorMutex.Lock()
metricsAggregator = orig
aggregatorMutex.Unlock()
})
}
// ---- getClusterStats -------------------------------------------------------
func TestGetClusterStats_NoAggregator_Returns503(t *testing.T) {
ensureNilAggregator(t)
app, _ := newClusterApp(t)
req := httptest.NewRequest("GET", "/admin/api/cluster/stats", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 503, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, false, body["cluster_mode"])
assert.NotEmpty(t, body["error"])
}
// ---- getClusterInstances ---------------------------------------------------
func TestGetClusterInstances_NoAggregator_Returns503(t *testing.T) {
ensureNilAggregator(t)
app, _ := newClusterApp(t)
req := httptest.NewRequest("GET", "/admin/api/cluster/instances", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 503, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, false, body["cluster_mode"])
assert.NotEmpty(t, body["error"])
}
// ---- getClusterDebug -------------------------------------------------------
func TestGetClusterDebug_NoAggregator_Returns200WithFalseFlag(t *testing.T) {
ensureNilAggregator(t)
// also set cfg so the redis_cache_enabled branch is exercised
cfg = &config{
Logger: libpack_logger.New(),
}
cfg.Cache.CacheEnable = true
cfg.Cache.CacheRedisEnable = false
app, _ := newClusterApp(t)
req := httptest.NewRequest("GET", "/admin/api/cluster/debug", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, false, body["aggregator_initialized"])
assert.Equal(t, false, body["redis_cache_enabled"])
assert.Equal(t, true, body["cache_enabled"])
}
func TestGetClusterDebug_NilCfg_Returns200WithDefaults(t *testing.T) {
ensureNilAggregator(t)
orig := cfg
cfg = nil
defer func() { cfg = orig }()
app, _ := newClusterApp(t)
req := httptest.NewRequest("GET", "/admin/api/cluster/debug", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, false, body["aggregator_initialized"])
assert.Equal(t, false, body["redis_cache_enabled"])
}
// ---- forcePublish ----------------------------------------------------------
func TestForcePublish_NoAggregator_Returns503(t *testing.T) {
ensureNilAggregator(t)
app, _ := newClusterApp(t)
req := httptest.NewRequest("POST", "/admin/api/cluster/force-publish", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 503, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, false, body["success"])
assert.NotEmpty(t, body["error"])
}
// ---- gatherAllStats / gatherAllStatsWithMode / gatherAllStatsClusterAware --
func newDashboardForGather(t *testing.T) *AdminDashboard {
t.Helper()
logger := libpack_logger.New()
monitoring := libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{})
cfg = &config{
Logger: logger,
Monitoring: monitoring,
}
return NewAdminDashboard(logger)
}
func TestGatherAllStats_ReturnsExpectedTopLevelKeys(t *testing.T) {
ensureNilAggregator(t)
ad := newDashboardForGather(t)
result := ad.gatherAllStats()
assert.NotNil(t, result)
// cluster_mode must be false when no aggregator
assert.Equal(t, false, result["cluster_mode"])
// stats sub-map must exist
statsRaw, ok := result["stats"]
assert.True(t, ok, "stats key must be present")
stats, ok := statsRaw.(map[string]any)
assert.True(t, ok)
assert.NotEmpty(t, stats["timestamp"])
assert.NotNil(t, stats["uptime_seconds"])
assert.NotNil(t, stats["uptime_human"])
assert.NotEmpty(t, stats["version"])
assert.NotNil(t, stats["requests"])
// health sub-map must exist
healthRaw, ok := result["health"]
assert.True(t, ok, "health key must be present")
health, ok := healthRaw.(map[string]any)
assert.True(t, ok)
assert.NotNil(t, health["status"])
assert.NotNil(t, health["backend"])
}
func TestGatherAllStatsWithMode_FalseMode_ReturnsLocalStats(t *testing.T) {
ensureNilAggregator(t)
ad := newDashboardForGather(t)
result := ad.gatherAllStatsWithMode(false)
assert.NotNil(t, result)
assert.Equal(t, false, result["cluster_mode"])
assert.NotNil(t, result["stats"])
assert.NotNil(t, result["health"])
}
func TestGatherAllStatsWithMode_TrueModeNoAggregator_FallsBackToLocal(t *testing.T) {
ensureNilAggregator(t)
ad := newDashboardForGather(t)
// With no aggregator, cluster mode request must fall back to local stats.
result := ad.gatherAllStatsWithMode(true)
assert.NotNil(t, result)
assert.Equal(t, false, result["cluster_mode"])
}
func TestGatherAllStatsClusterAware_NoAggregator_FallsBackToLocal(t *testing.T) {
ensureNilAggregator(t)
ad := newDashboardForGather(t)
result := ad.gatherAllStatsClusterAware()
assert.NotNil(t, result)
assert.Equal(t, false, result["cluster_mode"])
}
func TestGatherAllStats_NilCfg_ReturnsStatsWithoutRequests(t *testing.T) {
ensureNilAggregator(t)
origCfg := cfg
cfg = nil
defer func() { cfg = origCfg }()
ad := NewAdminDashboard(nil)
result := ad.gatherAllStats()
assert.NotNil(t, result)
stats, ok := result["stats"].(map[string]any)
assert.True(t, ok)
// when cfg is nil, "requests" key must NOT be present
_, hasRequests := stats["requests"]
assert.False(t, hasRequests)
}
func TestGatherAllStats_RequestStatsShape(t *testing.T) {
ensureNilAggregator(t)
ad := newDashboardForGather(t)
result := ad.gatherAllStats()
stats := result["stats"].(map[string]any)
requests, ok := stats["requests"].(map[string]any)
assert.True(t, ok, "requests must be a map")
assert.NotNil(t, requests["total"])
assert.NotNil(t, requests["succeeded"])
assert.NotNil(t, requests["failed"])
assert.NotNil(t, requests["skipped"])
assert.NotNil(t, requests["success_rate_pct"])
assert.NotNil(t, requests["failure_rate_pct"])
assert.NotNil(t, requests["skip_rate_pct"])
assert.NotNil(t, requests["avg_requests_per_second"])
assert.NotNil(t, requests["current_requests_per_second"])
}
-506
View File
@@ -1,506 +0,0 @@
package main
import (
"encoding/json"
"io"
"net/http/httptest"
"testing"
"time"
"github.com/gofiber/fiber/v3"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
"github.com/stretchr/testify/assert"
)
func TestNewAdminDashboard(t *testing.T) {
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
assert.NotNil(t, dashboard)
assert.Equal(t, logger, dashboard.logger)
}
func TestAdminDashboard_RegisterRoutes(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
// Verify routes are registered by checking app
routes := app.GetRoutes()
expectedRoutes := map[string]bool{
"/admin": false,
"/admin/dashboard": false,
"/admin/api/stats": false,
"/admin/api/health": false,
"/admin/api/circuit-breaker": false,
"/admin/api/cache": false,
"/admin/api/connections": false,
"/admin/api/retry-budget": false,
"/admin/api/coalescing": false,
"/admin/api/websocket": false,
"/admin/api/cache/clear": false,
"/admin/api/retry-budget/reset": false,
"/admin/api/coalescing/reset": false,
}
for _, route := range routes {
if _, exists := expectedRoutes[route.Path]; exists {
expectedRoutes[route.Path] = true
}
}
// Verify all expected routes were found
for path, found := range expectedRoutes {
assert.True(t, found, "Route %s should be registered", path)
}
}
func TestAdminDashboard_ServeDashboard(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("GET", "/admin", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Verify content type
contentType := resp.Header.Get("Content-Type")
assert.Contains(t, contentType, "text/html")
// Verify the dashboard HTML is returned (assert on stable markers, not
// the cosmetic page title which is part of the UI and may change).
body, err := io.ReadAll(resp.Body)
assert.NoError(t, err)
assert.Contains(t, string(body), "<!DOCTYPE html>")
assert.Contains(t, string(body), "graphql-proxy")
assert.Contains(t, string(body), "/admin/ws/stats")
}
func TestAdminDashboard_GetStats(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
monitoring := libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{})
// Initialize global config for testing
cfg = &config{
Logger: logger,
Monitoring: monitoring,
}
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("GET", "/admin/api/stats", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var stats map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &stats)
assert.NoError(t, err)
// Verify stats structure
assert.NotEmpty(t, stats["timestamp"])
assert.NotNil(t, stats["uptime_seconds"])
assert.NotNil(t, stats["uptime_human"])
assert.NotEmpty(t, stats["version"])
assert.NotNil(t, stats["requests"])
// Verify request stats structure
requests := stats["requests"].(map[string]any)
assert.NotNil(t, requests["total"])
assert.NotNil(t, requests["succeeded"])
assert.NotNil(t, requests["failed"])
assert.NotNil(t, requests["success_rate_pct"])
assert.NotNil(t, requests["avg_requests_per_second"])
assert.NotNil(t, requests["current_requests_per_second"])
}
func TestAdminDashboard_GetHealth(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("GET", "/admin/api/health", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var health map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &health)
assert.NoError(t, err)
// Verify health structure
assert.NotNil(t, health["status"])
assert.NotNil(t, health["backend"])
}
func TestAdminDashboard_GetCircuitBreakerStatus(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
// Initialize global config
cfg = &config{
Logger: logger,
CircuitBreaker: struct {
ExcludedStatusCodes []int
MaxFailures int
FailureRatio float64
SampleSize int
Timeout int
MaxRequestsInHalfOpen int
MaxBackoffTimeout int
BackoffMultiplier float64
ReturnCachedOnOpen bool
TripOn4xx bool
TripOn5xx bool
TripOnTimeouts bool
Enable bool
}{
Enable: true,
MaxFailures: 10,
Timeout: 60,
},
}
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("GET", "/admin/api/circuit-breaker", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var status map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &status)
assert.NoError(t, err)
// Verify status structure
assert.NotNil(t, status["enabled"])
assert.NotNil(t, status["state"])
}
func TestAdminDashboard_GetCacheStats(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
cfg = &config{
Logger: logger,
Cache: struct {
CacheRedisURL string
CacheRedisPassword string
CacheTTL int
CacheRedisDB int
CacheEnable bool
CacheRedisEnable bool
CacheMaxMemorySize int
CacheMaxEntries int
CacheUseLRU bool
GraphQLQueryCacheSize int
PerUserCacheDisabled bool
}{
CacheEnable: true,
CacheTTL: 60,
CacheMaxMemorySize: 100,
CacheMaxEntries: 10000,
CacheUseLRU: false,
PerUserCacheDisabled: false,
},
}
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("GET", "/admin/api/cache", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var stats map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &stats)
assert.NoError(t, err)
// Verify stats structure
assert.NotNil(t, stats["enabled"])
assert.NotNil(t, stats["ttl_seconds"])
}
func TestAdminDashboard_GetConnectionStats(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("GET", "/admin/api/connections", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var stats map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &stats)
assert.NoError(t, err)
// Verify stats structure
assert.NotNil(t, stats["available"])
}
func TestAdminDashboard_GetRetryBudgetStats(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("GET", "/admin/api/retry-budget", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var stats map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &stats)
assert.NoError(t, err)
// When no retry budget is initialized, should have "enabled" field
assert.NotNil(t, stats)
}
func TestAdminDashboard_GetCoalescingStats(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("GET", "/admin/api/coalescing", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var stats map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &stats)
assert.NoError(t, err)
// When no coalescer is initialized, should have "enabled" field
assert.NotNil(t, stats)
}
func TestAdminDashboard_GetWebSocketStats(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("GET", "/admin/api/websocket", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var stats map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &stats)
assert.NoError(t, err)
// When no WebSocket proxy is initialized, should have "enabled" field
assert.NotNil(t, stats)
}
func TestAdminDashboard_ClearCache(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("POST", "/admin/api/cache/clear", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var result map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &result)
assert.NoError(t, err)
assert.Equal(t, true, result["success"])
assert.NotEmpty(t, result["message"])
}
func TestAdminDashboard_ResetRetryBudget(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
dashboard := NewAdminDashboard(logger)
// Initialize retry budget
config := RetryBudgetConfig{
TokensPerSecond: 10.0,
MaxTokens: 100,
Enabled: true,
}
InitializeRetryBudget(config, logger)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("POST", "/admin/api/retry-budget/reset", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var result map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &result)
assert.NoError(t, err)
assert.Equal(t, true, result["success"])
assert.NotEmpty(t, result["message"])
}
func TestAdminDashboard_ResetCoalescing(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
monitoring := libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{})
dashboard := NewAdminDashboard(logger)
// Initialize request coalescer
InitializeRequestCoalescer(true, logger, monitoring)
dashboard.RegisterRoutes(app)
req := httptest.NewRequest("POST", "/admin/api/coalescing/reset", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
// Parse response
var result map[string]any
body, _ := io.ReadAll(resp.Body)
err = json.Unmarshal(body, &result)
assert.NoError(t, err)
assert.Equal(t, true, result["success"])
assert.NotEmpty(t, result["message"])
}
func TestGetAdminMetricValue(t *testing.T) {
logger := libpack_logger.New()
monitoring := libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{})
cfg = &config{
Logger: logger,
Monitoring: monitoring,
}
// Test with valid metric
value := getAdminMetricValue("requests_succesful")
assert.GreaterOrEqual(t, value, int64(0))
// Test with nil config
oldCfg := cfg
cfg = nil
value = getAdminMetricValue("requests_succesful")
assert.Equal(t, int64(0), value)
cfg = oldCfg
}
func TestAdminDashboard_StartTime(t *testing.T) {
// Verify startTime is initialized
assert.NotZero(t, startTime)
assert.True(t, time.Since(startTime) >= 0)
}
func TestAdminDashboard_IntegrationWithFeatures(t *testing.T) {
app := fiber.New()
logger := libpack_logger.New()
// Initialize all features
rbConfig := RetryBudgetConfig{
TokensPerSecond: 10.0,
MaxTokens: 100,
Enabled: true,
}
InitializeRetryBudget(rbConfig, logger)
InitializeRequestCoalescer(true, logger, nil)
wsConfig := WebSocketConfig{
Enabled: true,
PingInterval: 30 * time.Second,
MaxMessageSize: 512 * 1024,
}
InitializeWebSocketProxy("http://localhost:8080", wsConfig, logger, nil)
dashboard := NewAdminDashboard(logger)
dashboard.RegisterRoutes(app)
// Test retry budget endpoint
req := httptest.NewRequest("GET", "/admin/api/retry-budget", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
var rbStats map[string]any
body, _ := io.ReadAll(resp.Body)
json.Unmarshal(body, &rbStats)
assert.Equal(t, true, rbStats["enabled"])
// Test coalescing endpoint
req = httptest.NewRequest("GET", "/admin/api/coalescing", nil)
resp, err = app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
var coalStats map[string]any
body, _ = io.ReadAll(resp.Body)
json.Unmarshal(body, &coalStats)
assert.Equal(t, true, coalStats["enabled"])
// Test WebSocket endpoint
req = httptest.NewRequest("GET", "/admin/api/websocket", nil)
resp, err = app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
var wsStats map[string]any
body, _ = io.ReadAll(resp.Body)
json.Unmarshal(body, &wsStats)
assert.Equal(t, true, wsStats["enabled"])
}
+89 -519
View File
@@ -1,238 +1,70 @@
package main
import (
"context"
"crypto/subtle"
"fmt"
"os"
"sync"
"time"
"github.com/goccy/go-json"
fiber "github.com/gofiber/fiber/v3"
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"
"github.com/sony/gobreaker"
)
var bannedUsersIDs sync.Map // key: userID string, value: reason string
var bannedUsersIDs map[string]string = make(map[string]string)
// bannedUsersMu serializes in-memory banned-set mutations (admin Store/Delete)
// against the periodic file reload's clear-then-rebuild, and keeps the file
// read/write atomic with the map change. Lock ordering: always acquire
// bannedUsersMu BEFORE the file lock. loadBannedUsers holds bannedUsersMu for
// its whole read+replace, so a reload can never apply a stale snapshot over a
// write that apiBanUser/apiUnbanUser made in between, and it matches the
// mutex-then-file order those handlers use around storeBannedUsers.
var bannedUsersMu sync.Mutex
// authMiddleware provides API key authentication for admin endpoints
func authMiddleware(c fiber.Ctx) error {
apiKey := c.Get("X-API-Key")
// Get expected key from config (try GMP_ prefix first, then fallback)
expectedKey := os.Getenv("GMP_ADMIN_API_KEY")
if expectedKey == "" {
expectedKey = os.Getenv("ADMIN_API_KEY")
}
// If no API key is configured, authentication is optional (internal service pattern)
// Admin endpoints are typically protected by network segmentation
if expectedKey == "" {
cfg.Logger.Debug(&libpack_logger.LogMessage{
Message: "Admin API authentication disabled - endpoints protected by network segmentation",
Pairs: map[string]any{"endpoint": c.Path()},
func enableApi() {
if cfg.Server.EnableApi {
apiserver := fiber.New(fiber.Config{
DisableStartupMessage: true,
AppName: fmt.Sprintf("GraphQL Monitoring Proxy - %s v%s", libpack_config.PKG_NAME, libpack_config.PKG_VERSION),
})
return c.Next()
}
// Use constant-time comparison to prevent timing attacks
if subtle.ConstantTimeCompare([]byte(apiKey), []byte(expectedKey)) != 1 {
cfg.Logger.Warning(&libpack_logger.LogMessage{
Message: "Unauthorized API access attempt",
Pairs: map[string]any{"endpoint": c.Path(), "ip": c.IP()},
})
return c.Status(fiber.StatusUnauthorized).JSON(fiber.Map{
"error": "Unauthorized",
})
}
api := apiserver.Group("/api")
api.Post("/user-ban", apiBanUser)
api.Post("/user-unban", apiUnbanUser)
api.Post("/cache-clear", apiClearCache)
api.Get("/cache-stats", apiCacheStats)
return c.Next()
}
func enableApi(ctx context.Context) error {
if !cfg.Server.EnableApi {
return nil
}
// SECURITY WARNING: Check if API authentication is configured
adminAPIKey := os.Getenv("GMP_ADMIN_API_KEY")
if adminAPIKey == "" {
adminAPIKey = os.Getenv("ADMIN_API_KEY")
}
if adminAPIKey == "" {
cfg.Logger.Warning(&libpack_logger.LogMessage{
Message: "⚠️ Admin API enabled WITHOUT authentication - all endpoints are publicly accessible!",
Pairs: map[string]any{
"security_risk": "HIGH - Admin API endpoints can be accessed without credentials",
"affected_ops": "user-ban, user-unban, cache-clear, circuit-breaker controls",
"recommendation": "Set GMP_ADMIN_API_KEY environment variable or use network segmentation",
"api_port": cfg.Server.ApiPort,
},
})
}
apiserver := fiber.New(fiber.Config{
AppName: fmt.Sprintf("GraphQL Monitoring Proxy - %s v%s", libpack_config.PKG_NAME, libpack_config.PKG_VERSION),
})
api := apiserver.Group("/api")
// Apply authentication middleware to all admin routes
api.Use(authMiddleware)
api.Post("/user-ban", apiBanUser)
api.Post("/user-unban", apiUnbanUser)
api.Post("/cache-clear", apiClearCache)
api.Get("/cache-stats", apiCacheStats)
api.Get("/circuit-breaker/health", apiCircuitBreakerHealth)
api.Get("/backend/health", apiBackendHealth)
api.Get("/connection-pool/health", apiConnectionPoolHealth)
// Start banned users reload in a separate goroutine with context
go periodicallyReloadBannedUsers(ctx)
// Start server in a goroutine and handle shutdown
errCh := make(chan error, 1)
go func() {
if err := apiserver.Listen(fmt.Sprintf("%s:%d", cfg.Server.BindAddress, cfg.Server.ApiPort), fiber.ListenConfig{DisableStartupMessage: true}); err != nil {
errCh <- err
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()})
}
}()
// Wait for context cancellation or error
select {
case <-ctx.Done():
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "Shutting down API server",
})
return apiserver.Shutdown()
case err := <-errCh:
return err
}
}
func periodicallyReloadBannedUsers(ctx context.Context) {
ticker := time.NewTicker(10 * time.Second)
defer ticker.Stop()
func periodicallyReloadBannedUsers() {
for {
select {
case <-ctx.Done():
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "Stopping banned users reload",
})
return
case <-ticker.C:
loadBannedUsers()
cfg.Logger.Debug(&libpack_logger.LogMessage{
Message: "Banned users reloaded",
Pairs: map[string]any{"users": snapshotBannedUsers()},
})
}
loadBannedUsers()
cfg.Logger.Debug("Banned users reloaded", map[string]interface{}{"users": bannedUsersIDs})
<-time.After(10 * time.Second)
}
}
func checkIfUserIsBanned(c fiber.Ctx, userID string) bool {
_, found := bannedUsersIDs.Load(userID)
cfg.Logger.Debug(&libpack_logger.LogMessage{
Message: "Checking if user is banned",
Pairs: map[string]any{"user_id": userID, "banned": found},
})
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})
if found {
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "User is banned",
Pairs: map[string]any{"user_id": userID},
})
if err := c.Status(fiber.StatusForbidden).SendString("User is banned"); err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Failed to send banned user response",
Pairs: map[string]any{"error": err.Error()},
})
}
cfg.Logger.Info("User is banned", map[string]interface{}{"user_id": userID})
c.Status(403).SendString("User is banned")
}
return found
}
func apiClearCache(c fiber.Ctx) error {
cfg.Logger.Debug(&libpack_logger.LogMessage{
Message: "Clearing cache via API",
})
libpack_cache.CacheClear()
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "Cache cleared via API",
})
return c.SendString("OK: cache cleared")
func apiClearCache(c *fiber.Ctx) error {
cfg.Logger.Debug("Clearing cache via API", nil)
cfg.Cache.CacheClient.ClearCache()
cfg.Logger.Info("Cache cleared via API", nil)
c.Status(200).SendString("OK: cache cleared")
return nil
}
func apiCacheStats(c fiber.Ctx) error {
return c.JSON(libpack_cache.GetCacheStats())
}
// apiCircuitBreakerHealth returns the health status of the circuit breaker
func apiCircuitBreakerHealth(c fiber.Ctx) error {
if cb == nil {
return c.Status(fiber.StatusServiceUnavailable).JSON(fiber.Map{
"status": "disabled",
"message": "Circuit breaker is not enabled",
})
}
// Get circuit breaker state with proper mutex protection
cbMutex.RLock()
state := cb.State()
counts := cb.Counts()
cbMutex.RUnlock()
// Determine health status
var status string
var httpStatus int
switch state {
case gobreaker.StateClosed:
status = "healthy"
httpStatus = fiber.StatusOK
case gobreaker.StateHalfOpen:
status = "recovering"
httpStatus = fiber.StatusOK
case gobreaker.StateOpen:
status = "unhealthy"
httpStatus = fiber.StatusServiceUnavailable
}
response := fiber.Map{
"status": status,
"state": state.String(),
"counts": fiber.Map{
"requests": counts.Requests,
"total_successes": counts.TotalSuccesses,
"total_failures": counts.TotalFailures,
"consecutive_successes": counts.ConsecutiveSuccesses,
"consecutive_failures": counts.ConsecutiveFailures,
},
"configuration": fiber.Map{
"max_failures": cfg.CircuitBreaker.MaxFailures,
"failure_ratio": cfg.CircuitBreaker.FailureRatio,
"sample_size": cfg.CircuitBreaker.SampleSize,
"timeout_seconds": cfg.CircuitBreaker.Timeout,
"max_half_open_reqs": cfg.CircuitBreaker.MaxRequestsInHalfOpen,
"backoff_multiplier": cfg.CircuitBreaker.BackoffMultiplier,
},
}
return c.Status(httpStatus).JSON(response)
func apiCacheStats(c *fiber.Ctx) error {
stats := cfg.Cache.CacheClient.ShowStats()
cfg.Logger.Debug("Getting cache stats via API", map[string]interface{}{"stats": stats})
c.JSON(stats)
return nil
}
type apiBanUserRequest struct {
@@ -240,342 +72,80 @@ type apiBanUserRequest struct {
Reason string `json:"reason"`
}
func apiBanUser(c fiber.Ctx) error {
func apiBanUser(c *fiber.Ctx) error {
var req apiBanUserRequest
if err := c.Bind().Body(&req); err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't parse the ban user request",
Pairs: map[string]any{"error": err.Error()},
})
return c.Status(fiber.StatusBadRequest).SendString("Invalid request payload")
}
if req.UserID == "" || req.Reason == "" {
return c.Status(fiber.StatusBadRequest).SendString("user_id and reason are required")
}
// Hold bannedUsersMu over both the map update AND the file write so a
// concurrent reload (replaceBannedUsers) cannot clear the just-added user
// before storeBannedUsers persists it.
bannedUsersMu.Lock()
bannedUsersIDs.Store(req.UserID, req.Reason)
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "Banned user",
Pairs: map[string]any{"user_id": req.UserID, "reason": req.Reason},
})
err := storeBannedUsers()
bannedUsersMu.Unlock()
err := c.BodyParser(&req)
if err != nil {
return c.Status(fiber.StatusInternalServerError).SendString("Failed to store banned users")
}
return c.SendString("OK: user banned")
}
func apiUnbanUser(c fiber.Ctx) error {
var req apiBanUserRequest
if err := c.Bind().Body(&req); err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't parse the unban user request",
Pairs: map[string]any{"error": err.Error()},
})
return c.Status(fiber.StatusBadRequest).SendString("Invalid request payload")
}
if req.UserID == "" {
return c.Status(fiber.StatusBadRequest).SendString("user_id is required")
}
bannedUsersMu.Lock()
bannedUsersIDs.Delete(req.UserID)
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "Unbanned user",
Pairs: map[string]any{"user_id": req.UserID},
})
err := storeBannedUsers()
bannedUsersMu.Unlock()
if err != nil {
return c.Status(fiber.StatusInternalServerError).SendString("Failed to store banned users")
}
return c.SendString("OK: user unbanned")
}
func storeBannedUsers() error {
fileLock := flock.New(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
if err := lockFile(fileLock); err != nil {
cfg.Logger.Error("Can't parse the ban user request", map[string]interface{}{"error": err.Error()})
return err
}
defer func() {
if err := fileLock.Unlock(); err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Failed to unlock file",
Pairs: map[string]any{"error": err.Error()},
})
}
}()
data, err := json.Marshal(snapshotBannedUsers())
if err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't marshal banned users",
Pairs: map[string]any{"error": err.Error()},
})
return err
}
if err := os.WriteFile(cfg.Api.BannedUsersFile, data, 0o644); err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't write banned users to file",
Pairs: map[string]any{"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})
storeBannedUsers()
c.Status(200).SendString("OK: user banned")
return nil
}
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()})
return err
}
delete(bannedUsersIDs, req.UserID)
cfg.Logger.Info("Unbanned user", map[string]interface{}{"user_id": req.UserID})
storeBannedUsers()
c.Status(200).SendString("OK: user unbanned")
return nil
}
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()})
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()})
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()})
return
}
}
func loadBannedUsers() {
if _, err := os.Stat(cfg.Api.BannedUsersFile); os.IsNotExist(err) {
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "Banned users file doesn't exist - creating it",
Pairs: map[string]any{"file": cfg.Api.BannedUsersFile},
})
if err := os.WriteFile(cfg.Api.BannedUsersFile, []byte("{}"), 0o644); err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't create and write to the file",
Pairs: map[string]any{"error": err.Error()},
})
cfg.Logger.Info("Banned users file doesn't exist - creating it", 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()})
return
}
}
// Hold bannedUsersMu across the file read AND the in-memory replace below.
// apiBanUser/apiUnbanUser also acquire bannedUsersMu before their file
// write, so this keeps the documented mutex-before-file-lock order and
// stops a write landing between our read and our replace from being
// overwritten by this reload's now-stale snapshot.
//
// This holds bannedUsersMu across lockFileRead below, which can block for
// up to 30s under cross-process flock contention (see lockFileRead's own
// timeout). Because apiBanUser/apiUnbanUser take the same mutex, an admin
// ban/unban request can queue behind a reload for that long. This is an
// accepted trade: it buys atomicity between the in-memory map and the
// on-disk file, and reloads are infrequent enough that the worst case is
// rare in practice.
bannedUsersMu.Lock()
defer bannedUsersMu.Unlock()
fileLock := flock.New(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
if err := lockFileRead(fileLock); err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't lock the file [load]",
Pairs: map[string]any{"error": err.Error()},
})
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()})
return
}
defer func() {
if err := fileLock.Unlock(); err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Failed to unlock file",
Pairs: map[string]any{"error": err.Error()},
})
}
}()
defer fileLock.Unlock()
data, err := os.ReadFile(cfg.Api.BannedUsersFile)
if err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't read banned users from file",
Pairs: map[string]any{"error": err.Error()},
})
cfg.Logger.Error("Can't read banned users from file", map[string]interface{}{"error": err.Error()})
return
}
var newBannedUsers map[string]string
if err := json.Unmarshal(data, &newBannedUsers); err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't unmarshal banned users",
Pairs: map[string]any{"error": err.Error()},
})
err = json.Unmarshal(data, &bannedUsersIDs)
if err != nil {
cfg.Logger.Error("Can't unmarshal banned users", map[string]interface{}{"error": err.Error()})
return
}
replaceBannedUsersLocked(newBannedUsers)
}
// snapshotBannedUsers returns a plain map copy of the current banned users.
func snapshotBannedUsers() map[string]string {
out := make(map[string]string)
bannedUsersIDs.Range(func(k, v any) bool {
ks, kok := k.(string)
vs, vok := v.(string)
if kok && vok {
out[ks] = vs
}
return true
})
return out
}
// replaceBannedUsers swaps the banned users set with the provided map.
// Existing entries are removed before inserting the new ones.
func replaceBannedUsers(newUsers map[string]string) {
// Clear-then-rebuild must be atomic against admin Store/Delete
// (apiBanUser/apiUnbanUser) or a reload can clobber a just-applied ban.
bannedUsersMu.Lock()
defer bannedUsersMu.Unlock()
replaceBannedUsersLocked(newUsers)
}
// replaceBannedUsersLocked does the work of replaceBannedUsers without
// acquiring bannedUsersMu. Callers must already hold bannedUsersMu.
func replaceBannedUsersLocked(newUsers map[string]string) {
bannedUsersIDs.Range(func(k, _ any) bool {
bannedUsersIDs.Delete(k)
return true
})
for k, v := range newUsers {
bannedUsersIDs.Store(k, v)
}
}
func lockFile(fileLock *flock.Flock) error {
// Add timeout to prevent indefinite blocking
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
// Try to acquire lock with timeout
lockChan := make(chan error, 1)
go func() {
lockChan <- fileLock.Lock()
}()
select {
case err := <-lockChan:
if err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't lock the file",
Pairs: map[string]any{"error": err.Error()},
})
return err
}
return nil
case <-ctx.Done():
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "File lock timeout",
Pairs: map[string]any{"timeout": "30s"},
})
return fmt.Errorf("file lock timeout after 30 seconds")
}
}
func lockFileRead(fileLock *flock.Flock) error {
// Add timeout to prevent indefinite blocking
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
// Try to acquire read lock with timeout
lockChan := make(chan error, 1)
go func() {
lockChan <- fileLock.RLock()
}()
select {
case err := <-lockChan:
if err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Can't lock the file for reading",
Pairs: map[string]any{"error": err.Error()},
})
return err
}
return nil
case <-ctx.Done():
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "File read lock timeout",
Pairs: map[string]any{"timeout": "30s"},
})
return fmt.Errorf("file read lock timeout after 30 seconds")
}
}
// apiBackendHealth returns the health status of the GraphQL backend
func apiBackendHealth(c fiber.Ctx) error {
healthMgr := GetBackendHealthManager()
if healthMgr == nil {
return c.Status(fiber.StatusServiceUnavailable).JSON(fiber.Map{
"status": "unknown",
"message": "Backend health manager not initialized",
})
}
isHealthy := healthMgr.IsHealthy()
lastCheck := healthMgr.GetLastHealthCheck()
consecutiveFailures := healthMgr.GetConsecutiveFailures()
var status string
var httpStatus int
if isHealthy {
status = "healthy"
httpStatus = fiber.StatusOK
} else {
status = "unhealthy"
httpStatus = fiber.StatusServiceUnavailable
}
response := fiber.Map{
"status": status,
"backend_url": cfg.Server.HostGraphQL,
"last_health_check": lastCheck,
"consecutive_failures": consecutiveFailures,
"check_interval": "5s",
}
return c.Status(httpStatus).JSON(response)
}
// apiConnectionPoolHealth returns the health status of the connection pool
func apiConnectionPoolHealth(c fiber.Ctx) error {
poolMgr := GetConnectionPoolManager()
if poolMgr == nil {
return c.Status(fiber.StatusServiceUnavailable).JSON(fiber.Map{
"status": "unknown",
"message": "Connection pool manager not initialized",
})
}
stats := poolMgr.GetConnectionStats()
connectionFailures, _ := stats["connection_failures"].(int64)
var status string
var httpStatus int
// Consider pool healthy if we haven't had too many recent failures
if connectionFailures < 10 {
status = "healthy"
httpStatus = fiber.StatusOK
} else {
status = "degraded"
httpStatus = fiber.StatusOK // Still return 200 since pool is functional
}
response := fiber.Map{
"status": status,
"active_connections": stats["active_connections"],
"total_connections": stats["total_connections"],
"connection_failures": connectionFailures,
"last_recovery_attempt": stats["last_recovery_attempt"],
"cleanup_interval": "30s",
"keepalive_interval": poolMgr.keepAliveInterval.String(),
"recovery_check_interval": "60s",
}
return c.Status(httpStatus).JSON(response)
}
-300
View File
@@ -1,300 +0,0 @@
package main
import (
"encoding/json"
"fmt"
"os"
"path/filepath"
"sync"
"testing"
"github.com/gofrs/flock"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/assert"
)
func (suite *Tests) Test_PeriodicallyReloadBannedUsers() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
cfg.Api.BannedUsersFile = filepath.Join(os.TempDir(), "banned_users_reload_test.json")
// Initial empty banned users
replaceBannedUsers(map[string]string{})
// Create a test version of periodicallyReloadBannedUsers that executes once and signals completion
done := make(chan bool)
testPeriodicallyReloadBannedUsers := func() {
// Just call loadBannedUsers once
loadBannedUsers()
done <- true
}
// Run the test with initial empty banned users file
suite.Run("reload with empty file", func() {
// Clear existing file if any
_ = os.Remove(cfg.Api.BannedUsersFile)
_ = os.Remove(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
// Ensure banned users map is empty
replaceBannedUsers(map[string]string{})
// Execute reloader once
go testPeriodicallyReloadBannedUsers()
<-done
// Verify file was created
_, err := os.Stat(cfg.Api.BannedUsersFile)
assert.NoError(suite.T(), err)
// Safely check the map
mapSize := len(snapshotBannedUsers())
// Verify map is still empty
assert.Equal(suite.T(), 0, mapSize)
})
// Run the test with a populated banned users file
suite.Run("reload with populated file", func() {
// Create file with test data
testData := map[string]string{
"test-user-reload-1": "reason reload 1",
"test-user-reload-2": "reason reload 2",
}
data, _ := json.Marshal(testData)
err := os.WriteFile(cfg.Api.BannedUsersFile, data, 0o644)
assert.NoError(suite.T(), err)
// Clear the banned users map
replaceBannedUsers(map[string]string{})
// Execute reloader once
go testPeriodicallyReloadBannedUsers()
<-done
// Safely check the map
snap := snapshotBannedUsers()
mapSize := len(snap)
value1 := snap["test-user-reload-1"]
value2 := snap["test-user-reload-2"]
// Verify banned users map was loaded
assert.Equal(suite.T(), 2, mapSize)
assert.Equal(suite.T(), "reason reload 1", value1)
assert.Equal(suite.T(), "reason reload 2", value2)
})
// Test updating banned users file while reloader is running
suite.Run("reload with updated file", func() {
// Start with initial data
initialData := map[string]string{
"test-user-initial": "initial reason",
}
data, _ := json.Marshal(initialData)
err := os.WriteFile(cfg.Api.BannedUsersFile, data, 0o644)
assert.NoError(suite.T(), err)
// Clear the banned users map
replaceBannedUsers(map[string]string{})
// Execute reloader once to load initial data
go testPeriodicallyReloadBannedUsers()
<-done
// Safely check the map
snap := snapshotBannedUsers()
mapSize := len(snap)
initialValue := snap["test-user-initial"]
// Verify initial data was loaded
assert.Equal(suite.T(), 1, mapSize)
assert.Equal(suite.T(), "initial reason", initialValue)
// Update the file with new data
updatedData := map[string]string{
"test-user-updated-1": "updated reason 1",
"test-user-updated-2": "updated reason 2",
}
data, _ = json.Marshal(updatedData)
err = os.WriteFile(cfg.Api.BannedUsersFile, data, 0o644)
assert.NoError(suite.T(), err)
// Execute reloader again to load updated data
go testPeriodicallyReloadBannedUsers()
<-done
// Safely check the map
snap = snapshotBannedUsers()
mapSize = len(snap)
value1 := snap["test-user-updated-1"]
value2 := snap["test-user-updated-2"]
_, exists := snap["test-user-initial"]
// Verify updated data was loaded
assert.Equal(suite.T(), 2, mapSize)
assert.Equal(suite.T(), "updated reason 1", value1)
assert.Equal(suite.T(), "updated reason 2", value2)
assert.False(suite.T(), exists)
})
// Cleanup
_ = os.Remove(cfg.Api.BannedUsersFile)
_ = os.Remove(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
}
// This is a better approach instead of the ticker-based test
func (suite *Tests) Test_LoadUnloadBannedUsers() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
cfg.Api.BannedUsersFile = filepath.Join(os.TempDir(), "banned_users_update_test.json")
// Create a test banned users file with initial content
initialData := map[string]string{
"user1": "reason1",
"user2": "reason2",
}
data, _ := json.Marshal(initialData)
err := os.WriteFile(cfg.Api.BannedUsersFile, data, 0o644)
assert.NoError(suite.T(), err)
defer func() { _ = os.Remove(cfg.Api.BannedUsersFile) }()
defer func() { _ = os.Remove(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile)) }()
// Test loading banned users
suite.Run("load banned users", func() {
// Clear the banned users map
replaceBannedUsers(map[string]string{})
// Load banned users
loadBannedUsers()
// Check the banned users map
snap := snapshotBannedUsers()
count := len(snap)
reason1 := snap["user1"]
reason2 := snap["user2"]
assert.Equal(suite.T(), 2, count)
assert.Equal(suite.T(), "reason1", reason1)
assert.Equal(suite.T(), "reason2", reason2)
})
// Test updating banned users
suite.Run("update banned users", func() {
// Update the banned users map
replaceBannedUsers(map[string]string{
"user3": "reason3",
"user4": "reason4",
})
// Store the updated banned users
err := storeBannedUsers()
assert.NoError(suite.T(), err)
// Clear the banned users map
replaceBannedUsers(map[string]string{})
// Load banned users again
loadBannedUsers()
// Check the banned users map
snap := snapshotBannedUsers()
count := len(snap)
reason3 := snap["user3"]
reason4 := snap["user4"]
_, user1Exists := snap["user1"]
assert.Equal(suite.T(), 2, count)
assert.Equal(suite.T(), "reason3", reason3)
assert.Equal(suite.T(), "reason4", reason4)
assert.False(suite.T(), user1Exists)
})
}
func TestBannedUsersConcurrentModifyAndReload(t *testing.T) {
// Regression for the banned-users race: an admin ban (bannedUsersIDs.Store
// + storeBannedUsers) must be atomic against periodic reloads
// (loadBannedUsers -> replaceBannedUsers). Concurrent modify+reload must
// not lose a persisted ban and must be memory-race free (-race).
dir := t.TempDir()
file := filepath.Join(dir, "banned.json")
origCfg := cfg
cfg = &config{Logger: libpack_logger.New()}
cfg.Api.BannedUsersFile = file
defer func() { cfg = origCfg }()
bannedUsersIDs = sync.Map{}
if err := os.WriteFile(file, []byte("{}"), 0o644); err != nil {
t.Fatal(err)
}
var wg sync.WaitGroup
// Admin-like writers: ban kept-user and persist, under bannedUsersMu.
for range 4 {
wg.Add(1)
go func() {
defer wg.Done()
for range 50 {
bannedUsersMu.Lock()
bannedUsersIDs.Store("kept-user", "reason")
_ = storeBannedUsers()
bannedUsersMu.Unlock()
}
}()
}
// Reloading goroutines.
for range 2 {
wg.Add(1)
go func() {
defer wg.Done()
for range 50 {
loadBannedUsers()
}
}()
}
wg.Wait()
// A final reload must reflect the persisted (still-banned) user.
loadBannedUsers()
if _, ok := bannedUsersIDs.Load("kept-user"); !ok {
t.Fatal("kept-user ban was lost after concurrent modify + reload")
}
}
// TestLoadBannedUsersReleasesLockOnReadError is a regression test for the
// file-lock leak: a read error inside loadBannedUsers (after the shared file
// lock is taken) must still release the lock. Before the fix, the error
// return at the os.ReadFile check skipped the unlock, so the flock's open fd
// stayed shared-locked for the process lifetime, and every later
// storeBannedUsers (which needs the exclusive lock) would block and fail.
func TestLoadBannedUsersReleasesLockOnReadError(t *testing.T) {
dir := t.TempDir()
// A directory in place of the banned-users file makes os.Stat report the
// path exists (skipping the create-file branch) while os.ReadFile fails.
file := filepath.Join(dir, "banned.json")
if err := os.Mkdir(file, 0o755); err != nil {
t.Fatal(err)
}
origCfg := cfg
cfg = &config{Logger: libpack_logger.New()}
cfg.Api.BannedUsersFile = file
defer func() { cfg = origCfg }()
loadBannedUsers() // must hit the os.ReadFile error path and return
// If the shared read lock leaked, a fresh non-blocking exclusive TryLock
// on the same lock file fails instead of succeeding immediately.
fileLock := flock.New(fmt.Sprintf("%s.lock", file))
locked, err := fileLock.TryLock()
if err != nil {
t.Fatalf("TryLock returned an error: %v", err)
}
if !locked {
t.Fatal("exclusive lock unavailable after loadBannedUsers read error - shared lock leaked")
}
_ = fileLock.Unlock()
}
-606
View File
@@ -1,606 +0,0 @@
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
"os"
"path/filepath"
"strings"
"sync"
"testing"
"github.com/gofiber/fiber/v3"
libpack_cache "github.com/lukaszraczylo/graphql-monitoring-proxy/cache"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/suite"
)
type APIAuthSecurityTestSuite struct {
suite.Suite
app *fiber.App
originalLogger *libpack_logger.Logger
validAPIKey string
}
func TestAPIAuthSecurityTestSuite(t *testing.T) {
suite.Run(t, new(APIAuthSecurityTestSuite))
}
func (suite *APIAuthSecurityTestSuite) SetupTest() {
// Setup test configuration
cfg = &config{}
cfg.Logger = libpack_logger.New()
cfg.Cache.CacheEnable = true
cfg.Cache.CacheTTL = 300
cfg.Cache.CacheMaxMemorySize = 100
suite.originalLogger = cfg.Logger
// Initialize cache
libpack_cache.EnableCache(&libpack_cache.CacheConfig{
Logger: cfg.Logger,
TTL: 300,
})
// Initialize banned users map
replaceBannedUsers(map[string]string{})
// Setup banned users file path
cfg.Api.BannedUsersFile = filepath.Join(os.TempDir(), "banned_users_auth_test.json")
// Set up test API key (will be overridden in specific tests)
suite.validAPIKey = "test-secure-api-key-12345"
// Create test Fiber app with authentication
suite.app = fiber.New(fiber.Config{})
// Setup API routes with authentication middleware
api := suite.app.Group("/api")
api.Use(authMiddleware)
api.Post("/user-ban", apiBanUser)
api.Post("/user-unban", apiUnbanUser)
api.Post("/cache-clear", apiClearCache)
api.Get("/cache-stats", apiCacheStats)
}
func (suite *APIAuthSecurityTestSuite) TearDownTest() {
// Clean up environment variables
os.Unsetenv("GMP_ADMIN_API_KEY")
os.Unsetenv("ADMIN_API_KEY")
// Clean up test files
if cfg != nil && cfg.Api.BannedUsersFile != "" {
_ = os.Remove(cfg.Api.BannedUsersFile)
_ = os.Remove(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
}
}
// TestOptionalAuthentication tests that admin endpoints work without auth when no key is configured
func (suite *APIAuthSecurityTestSuite) TestOptionalAuthentication() {
// Ensure no API key is set
os.Unsetenv("GMP_ADMIN_API_KEY")
os.Unsetenv("ADMIN_API_KEY")
tests := []struct {
body map[string]any
name string
endpoint string
method string
description string
expectedStatus int
}{
{
name: "No auth - cache-stats",
endpoint: "/api/cache-stats",
method: "GET",
expectedStatus: 200,
description: "Should allow access without API key when auth is disabled",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
var req *http.Request
var err error
if tt.body != nil {
bodyBytes, _ := json.Marshal(tt.body)
req, err = http.NewRequest(tt.method, tt.endpoint, bytes.NewReader(bodyBytes))
req.Header.Set("Content-Type", "application/json")
} else {
req, err = http.NewRequest(tt.method, tt.endpoint, nil)
}
suite.NoError(err)
resp, err := suite.app.Test(req)
suite.NoError(err)
suite.Equal(tt.expectedStatus, resp.StatusCode,
"Status code mismatch: %s", tt.description)
})
}
}
// TestAPIAuthentication tests various authentication scenarios when auth is enabled
func (suite *APIAuthSecurityTestSuite) TestAPIAuthentication() {
// Set test API key to enable authentication
os.Setenv("GMP_ADMIN_API_KEY", suite.validAPIKey)
defer os.Unsetenv("GMP_ADMIN_API_KEY")
tests := []struct {
body map[string]any
name string
apiKey string
endpoint string
method string
description string
expectedStatus int
}{
{
name: "Missing API key header",
apiKey: "",
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 401,
description: "Should reject requests without API key",
},
{
name: "Invalid API key",
apiKey: "wrong-key",
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 401,
description: "Should reject requests with invalid API key",
},
{
name: "SQL injection in API key",
apiKey: "' OR '1'='1",
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 401,
description: "Should reject SQL injection attempts in API key",
},
{
name: "XSS attempt in API key",
apiKey: "<script>alert('xss')</script>",
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 401,
description: "Should reject XSS attempts in API key",
},
{
name: "Command injection in API key",
apiKey: "key; rm -rf /",
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 401,
description: "Should reject command injection attempts in API key",
},
{
name: "Valid API key for user-ban",
apiKey: suite.validAPIKey,
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 200,
description: "Should accept valid API key for user-ban endpoint",
},
{
name: "Valid API key for user-unban",
apiKey: suite.validAPIKey,
endpoint: "/api/user-unban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test unban"},
expectedStatus: 200,
description: "Should accept valid API key for user-unban endpoint",
},
{
name: "Valid API key for cache-clear",
apiKey: suite.validAPIKey,
endpoint: "/api/cache-clear",
method: "POST",
body: nil,
expectedStatus: 200,
description: "Should accept valid API key for cache-clear endpoint",
},
{
name: "Valid API key for cache-stats",
apiKey: suite.validAPIKey,
endpoint: "/api/cache-stats",
method: "GET",
body: nil,
expectedStatus: 200,
description: "Should accept valid API key for cache-stats endpoint",
},
{
name: "Case sensitive API key",
apiKey: strings.ToUpper(suite.validAPIKey),
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 401,
description: "Should reject case-modified API key (case sensitive)",
},
{
name: "API key with extra characters",
apiKey: suite.validAPIKey + "extra",
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 401,
description: "Should reject API key with extra characters",
},
{
name: "API key with prefix removed",
apiKey: suite.validAPIKey[5:],
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 401,
description: "Should reject partial API key",
},
{
name: "Empty string API key",
apiKey: "",
endpoint: "/api/cache-stats",
method: "GET",
body: nil,
expectedStatus: 401,
description: "Should reject empty API key",
},
// Null byte test removed - FastHTTP rejects invalid headers before they reach the middleware
{
name: "Unicode characters in API key",
apiKey: suite.validAPIKey + "тест",
endpoint: "/api/user-ban",
method: "POST",
body: map[string]any{"user_id": "test-user", "reason": "test reason"},
expectedStatus: 401,
description: "Should reject API key with unicode characters",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
var req *http.Request
var err error
if tt.body != nil {
bodyBytes, _ := json.Marshal(tt.body)
req, err = http.NewRequest(tt.method, tt.endpoint, bytes.NewBuffer(bodyBytes))
suite.NoError(err)
req.Header.Set("Content-Type", "application/json")
} else {
req, err = http.NewRequest(tt.method, tt.endpoint, nil)
suite.NoError(err)
}
if tt.apiKey != "" {
req.Header.Set("X-API-Key", tt.apiKey)
}
resp, err := suite.app.Test(req)
suite.NoError(err, "Request should not error: %s", tt.description)
suite.Equal(tt.expectedStatus, resp.StatusCode,
"Status code mismatch for %s: %s", tt.name, tt.description)
// Verify response structure for unauthorized requests
if tt.expectedStatus == 401 {
body, err := io.ReadAll(resp.Body)
suite.NoError(err)
var response map[string]any
err = json.Unmarshal(body, &response)
suite.NoError(err)
suite.Contains(response, "error", "Unauthorized response should contain error field")
suite.Equal("Unauthorized", response["error"], "Should return 'Unauthorized' message")
}
})
}
}
// TestAPIAuthenticationWithoutConfiguredKey tests behavior when no API key is configured
func (suite *APIAuthSecurityTestSuite) TestAPIAuthenticationWithoutConfiguredKey() {
// Remove API key from environment
os.Unsetenv("GMP_ADMIN_API_KEY")
os.Unsetenv("ADMIN_API_KEY")
// Create new app without configured API key
app := fiber.New()
api := app.Group("/api")
api.Use(authMiddleware)
api.Post("/user-ban", apiBanUser)
req, err := http.NewRequest("POST", "/api/user-ban",
bytes.NewBuffer([]byte(`{"user_id": "test", "reason": "test"}`)))
suite.NoError(err)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "any-key")
resp, err := app.Test(req)
suite.NoError(err)
suite.Equal(200, resp.StatusCode, "Should return 200 when API key not configured (auth disabled)")
body, err := io.ReadAll(resp.Body)
suite.NoError(err)
// When no API key is configured, auth is disabled and the request succeeds
suite.Equal("OK: user banned", string(body), "Should succeed when auth is disabled")
}
// TestTimingAttackResistance tests that the authentication is resistant to timing attacks
func (suite *APIAuthSecurityTestSuite) TestTimingAttackResistance() {
// Set API key to enable authentication
os.Setenv("GMP_ADMIN_API_KEY", suite.validAPIKey)
defer os.Unsetenv("GMP_ADMIN_API_KEY")
// Test various invalid keys to ensure constant-time comparison
invalidKeys := []string{
"a", // Very short
"ab", // Short
"invalid-key", // Different length
suite.validAPIKey[:10], // Prefix match
suite.validAPIKey + "x", // Almost correct
strings.Repeat("a", 100), // Very long
"", // Empty
}
for _, key := range invalidKeys {
req, err := http.NewRequest("POST", "/api/user-ban",
bytes.NewBuffer([]byte(`{"user_id": "test", "reason": "test"}`)))
suite.NoError(err)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", key)
resp, err := suite.app.Test(req)
suite.NoError(err)
suite.Equal(401, resp.StatusCode,
"All invalid keys should return 401, key: %s", key)
}
// Timing-attack resistance is guaranteed by subtle.ConstantTimeCompare in
// authMiddleware (verified by code, not by wall-clock measurement). Asserting
// on a max/min wall-clock ratio across full HTTP round-trips is unreliable:
// it is dominated by scheduler/GC noise and produces flaky failures, so we
// intentionally do not assert on the timing ratio.
}
// TestConcurrentAPIAuthentication tests authentication under concurrent load
func (suite *APIAuthSecurityTestSuite) TestConcurrentAPIAuthentication() {
// Set API key to enable authentication
os.Setenv("GMP_ADMIN_API_KEY", suite.validAPIKey)
defer os.Unsetenv("GMP_ADMIN_API_KEY")
const numGoroutines = 50
const numRequestsPerGoroutine = 10
var wg sync.WaitGroup
results := make(chan int, numGoroutines*numRequestsPerGoroutine)
// Test with mix of valid and invalid keys
testKeys := []string{
suite.validAPIKey, // Valid
"invalid-key-1", // Invalid
"invalid-key-2", // Invalid
suite.validAPIKey, // Valid
"", // Empty
}
for i := 0; i < numGoroutines; i++ {
wg.Add(1)
go func(goroutineID int) {
defer wg.Done()
for j := 0; j < numRequestsPerGoroutine; j++ {
keyIndex := (goroutineID + j) % len(testKeys)
key := testKeys[keyIndex]
req, err := http.NewRequest("GET", "/api/cache-stats", nil)
if err != nil {
results <- 500
continue
}
if key != "" {
req.Header.Set("X-API-Key", key)
}
resp, err := suite.app.Test(req)
if err != nil {
results <- 500
continue
}
results <- resp.StatusCode
}
}(i)
}
wg.Wait()
close(results)
// Collect and verify results
statusCounts := make(map[int]int)
for status := range results {
statusCounts[status]++
}
// Should have some 200s (valid keys) and some 401s (invalid keys)
suite.Greater(statusCounts[200], 0, "Should have successful requests with valid API key")
suite.Greater(statusCounts[401], 0, "Should have rejected requests with invalid API key")
suite.Equal(0, statusCounts[500], "Should not have internal server errors")
}
// TestAPIKeyEnvironmentVariablePrecedence tests the precedence of environment variables
func (suite *APIAuthSecurityTestSuite) TestAPIKeyEnvironmentVariablePrecedence() {
prefixedKey := "prefixed-api-key"
unprefixedKey := "unprefixed-api-key"
// Test 1: Only GMP_ prefixed key is set
suite.Run("Only prefixed key set", func() {
os.Unsetenv("ADMIN_API_KEY")
os.Setenv("GMP_ADMIN_API_KEY", prefixedKey)
defer os.Unsetenv("GMP_ADMIN_API_KEY")
req, err := http.NewRequest("GET", "/api/cache-stats", nil)
suite.NoError(err)
req.Header.Set("X-API-Key", prefixedKey)
resp, err := suite.app.Test(req)
suite.NoError(err)
suite.Equal(200, resp.StatusCode, "Should accept prefixed API key")
})
// Test 2: Only unprefixed key is set
suite.Run("Only unprefixed key set", func() {
os.Unsetenv("GMP_ADMIN_API_KEY")
os.Setenv("ADMIN_API_KEY", unprefixedKey)
defer os.Unsetenv("ADMIN_API_KEY")
req, err := http.NewRequest("GET", "/api/cache-stats", nil)
suite.NoError(err)
req.Header.Set("X-API-Key", unprefixedKey)
resp, err := suite.app.Test(req)
suite.NoError(err)
suite.Equal(200, resp.StatusCode, "Should accept unprefixed API key when prefixed not available")
})
// Test 3: Both keys set - prefixed should take precedence
suite.Run("Both keys set - precedence", func() {
os.Setenv("GMP_ADMIN_API_KEY", prefixedKey)
os.Setenv("ADMIN_API_KEY", unprefixedKey)
defer func() {
os.Unsetenv("GMP_ADMIN_API_KEY")
os.Unsetenv("ADMIN_API_KEY")
}()
// Should accept prefixed key
req, err := http.NewRequest("GET", "/api/cache-stats", nil)
suite.NoError(err)
req.Header.Set("X-API-Key", prefixedKey)
resp, err := suite.app.Test(req)
suite.NoError(err)
suite.Equal(200, resp.StatusCode, "Should accept prefixed API key")
// Should reject unprefixed key when prefixed is available
req, err = http.NewRequest("GET", "/api/cache-stats", nil)
suite.NoError(err)
req.Header.Set("X-API-Key", unprefixedKey)
resp, err = suite.app.Test(req)
suite.NoError(err)
suite.Equal(401, resp.StatusCode, "Should reject unprefixed key when prefixed is configured")
})
}
// TestAPIAuthenticationErrorMessages tests that error messages don't leak information
func (suite *APIAuthSecurityTestSuite) TestAPIAuthenticationErrorMessages() {
// Set API key to enable authentication
os.Setenv("GMP_ADMIN_API_KEY", suite.validAPIKey)
defer os.Unsetenv("GMP_ADMIN_API_KEY")
maliciousInputs := []string{
"admin",
"password",
"secret",
"' OR 1=1 --",
"<script>alert(1)</script>",
suite.validAPIKey + "almost",
}
for _, input := range maliciousInputs {
suite.Run(fmt.Sprintf("Error message for input: %s", input), func() {
req, err := http.NewRequest("GET", "/api/cache-stats", nil)
suite.NoError(err)
req.Header.Set("X-API-Key", input)
resp, err := suite.app.Test(req)
suite.NoError(err)
suite.Equal(401, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
suite.NoError(err)
var response map[string]any
err = json.Unmarshal(body, &response)
suite.NoError(err)
errorMsg := strings.ToLower(response["error"].(string))
// Error message should not leak sensitive information
suite.NotContains(errorMsg, "key", "Error should not mention 'key'")
suite.NotContains(errorMsg, "password", "Error should not mention 'password'")
suite.NotContains(errorMsg, "secret", "Error should not mention 'secret'")
suite.NotContains(errorMsg, "admin", "Error should not mention 'admin'")
suite.NotContains(errorMsg, "expected", "Error should not mention expected values")
suite.NotContains(errorMsg, "correct", "Error should not mention correct values")
// Should be a generic unauthorized message
suite.Equal("unauthorized", errorMsg, "Should return generic unauthorized message")
})
}
}
// TestAPIAuthenticationHeaderVariations tests different header case variations
func (suite *APIAuthSecurityTestSuite) TestAPIAuthenticationHeaderVariations() {
headerVariations := []string{
"X-API-Key", // Standard
"x-api-key", // Lowercase
"X-Api-Key", // Mixed case
"X-API-KEY", // Uppercase
"x-API-key", // Mixed case 2
}
for _, header := range headerVariations {
suite.Run(fmt.Sprintf("Header variation: %s", header), func() {
req, err := http.NewRequest("GET", "/api/cache-stats", nil)
suite.NoError(err)
req.Header.Set(header, suite.validAPIKey)
resp, err := suite.app.Test(req)
suite.NoError(err)
// Fiber should handle header case insensitivity
// All variations should work
suite.Equal(200, resp.StatusCode,
"Header %s should be accepted (case insensitive)", header)
})
}
}
// BenchmarkAPIAuthentication benchmarks the authentication middleware performance
func BenchmarkAPIAuthentication(b *testing.B) {
// Setup
cfg = &config{}
cfg.Logger = libpack_logger.New()
validAPIKey := "benchmark-api-key"
os.Setenv("GMP_ADMIN_API_KEY", validAPIKey)
defer os.Unsetenv("GMP_ADMIN_API_KEY")
app := fiber.New()
api := app.Group("/api")
api.Use(authMiddleware)
api.Get("/cache-stats", apiCacheStats)
b.ResetTimer()
for i := 0; i < b.N; i++ {
req, _ := http.NewRequest("GET", "/api/cache-stats", nil)
req.Header.Set("X-API-Key", validAPIKey)
resp, _ := app.Test(req)
resp.Body.Close()
}
}
-256
View File
@@ -1,256 +0,0 @@
package main
import (
"encoding/json"
"io"
"net/http/httptest"
"testing"
fiber "github.com/gofiber/fiber/v3"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
"github.com/stretchr/testify/assert"
"github.com/valyala/fasthttp"
)
// ---- helpers ---------------------------------------------------------------
func setupMinimalCfg(t *testing.T) {
t.Helper()
logger := libpack_logger.New()
monitoring := libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{})
cfg = &config{
Logger: logger,
Monitoring: monitoring,
}
}
func newHealthApp(t *testing.T) *fiber.App {
t.Helper()
app := fiber.New(fiber.Config{
// suppress stack-trace noise in test output
})
app.Get("/api/backend/health", apiBackendHealth)
app.Get("/api/pool/health", apiConnectionPoolHealth)
app.Get("/api/circuit-breaker/health", apiCircuitBreakerHealth)
return app
}
// ---- apiBackendHealth ------------------------------------------------------
func TestApiBackendHealth_NilManager_Returns503(t *testing.T) {
// Ensure global manager is nil for this test.
orig := backendHealthManager
backendHealthManager = nil
defer func() { backendHealthManager = orig }()
app := newHealthApp(t)
req := httptest.NewRequest("GET", "/api/backend/health", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 503, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, "unknown", body["status"])
assert.NotEmpty(t, body["message"])
}
func TestApiBackendHealth_HealthyManager_Returns200(t *testing.T) {
orig := backendHealthManager
defer func() { backendHealthManager = orig }()
// inject a healthy manager directly (bypassing sync.Once)
mgr := NewBackendHealthManager(&fasthttp.Client{}, "http://localhost:8080", libpack_logger.New())
mgr.isHealthy.Store(true)
backendHealthManager = mgr
setupMinimalCfg(t)
app := newHealthApp(t)
req := httptest.NewRequest("GET", "/api/backend/health", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, "healthy", body["status"])
assert.NotNil(t, body["backend_url"])
assert.NotNil(t, body["consecutive_failures"])
assert.NotNil(t, body["check_interval"])
}
func TestApiBackendHealth_UnhealthyManager_Returns503(t *testing.T) {
orig := backendHealthManager
defer func() { backendHealthManager = orig }()
mgr := NewBackendHealthManager(&fasthttp.Client{}, "http://localhost:8080", libpack_logger.New())
mgr.isHealthy.Store(false)
backendHealthManager = mgr
setupMinimalCfg(t)
app := newHealthApp(t)
req := httptest.NewRequest("GET", "/api/backend/health", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 503, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, "unhealthy", body["status"])
}
// ---- apiConnectionPoolHealth -----------------------------------------------
func TestApiConnectionPoolHealth_NilManager_Returns503(t *testing.T) {
connectionPoolMutex.Lock()
orig := connectionPoolManager
connectionPoolManager = nil
connectionPoolMutex.Unlock()
defer func() {
connectionPoolMutex.Lock()
connectionPoolManager = orig
connectionPoolMutex.Unlock()
}()
app := newHealthApp(t)
req := httptest.NewRequest("GET", "/api/pool/health", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 503, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, "unknown", body["status"])
assert.NotEmpty(t, body["message"])
}
func TestApiConnectionPoolHealth_HealthyPool_Returns200(t *testing.T) {
connectionPoolMutex.Lock()
orig := connectionPoolManager
mgr := NewConnectionPoolManager(&fasthttp.Client{})
connectionPoolManager = mgr
connectionPoolMutex.Unlock()
defer func() {
connectionPoolMutex.Lock()
_ = mgr.Shutdown()
connectionPoolManager = orig
connectionPoolMutex.Unlock()
}()
app := newHealthApp(t)
req := httptest.NewRequest("GET", "/api/pool/health", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, "healthy", body["status"])
assert.NotNil(t, body["active_connections"])
assert.NotNil(t, body["total_connections"])
assert.NotNil(t, body["connection_failures"])
}
func TestApiConnectionPoolHealth_DegradedPool_Returns200WithDegradedStatus(t *testing.T) {
connectionPoolMutex.Lock()
orig := connectionPoolManager
mgr := NewConnectionPoolManager(&fasthttp.Client{})
// push failure counter above threshold (10)
for range 15 {
mgr.connectionFailures.Add(1)
}
connectionPoolManager = mgr
connectionPoolMutex.Unlock()
defer func() {
connectionPoolMutex.Lock()
_ = mgr.Shutdown()
connectionPoolManager = orig
connectionPoolMutex.Unlock()
}()
app := newHealthApp(t)
req := httptest.NewRequest("GET", "/api/pool/health", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
// handler returns 200 even for degraded
assert.Equal(t, 200, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, "degraded", body["status"])
}
// ---- apiCircuitBreakerHealth -----------------------------------------------
func TestApiCircuitBreakerHealth_NilCB_Returns503(t *testing.T) {
cbMutex.Lock()
origCB := cb
cb = nil
cbMutex.Unlock()
defer func() {
cbMutex.Lock()
cb = origCB
cbMutex.Unlock()
}()
app := newHealthApp(t)
req := httptest.NewRequest("GET", "/api/circuit-breaker/health", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 503, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, "disabled", body["status"])
assert.NotEmpty(t, body["message"])
}
func TestApiCircuitBreakerHealth_ClosedCB_Returns200Healthy(t *testing.T) {
cbMutex.Lock()
origCB := cb
cbMutex.Unlock()
defer func() {
cbMutex.Lock()
cb = origCB
cbMutex.Unlock()
}()
logger := libpack_logger.New()
monitoring := libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{})
cfg = &config{Logger: logger, Monitoring: monitoring}
cfg.CircuitBreaker.Enable = true
cfg.CircuitBreaker.MaxFailures = 5
cfg.CircuitBreaker.Timeout = 30
initCircuitBreaker(cfg)
// cb is now set by initCircuitBreaker; circuit starts closed (healthy)
app := newHealthApp(t)
req := httptest.NewRequest("GET", "/api/circuit-breaker/health", nil)
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, 200, resp.StatusCode)
var body map[string]any
raw, _ := io.ReadAll(resp.Body)
assert.NoError(t, json.Unmarshal(raw, &body))
assert.Equal(t, "healthy", body["status"])
assert.NotNil(t, body["state"])
assert.NotNil(t, body["counts"])
assert.NotNil(t, body["configuration"])
counts, ok := body["counts"].(map[string]any)
assert.True(t, ok)
assert.NotNil(t, counts["requests"])
assert.NotNil(t, counts["total_successes"])
assert.NotNil(t, counts["total_failures"])
assert.NotNil(t, counts["consecutive_successes"])
assert.NotNil(t, counts["consecutive_failures"])
}
-447
View File
@@ -1,447 +0,0 @@
package main
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"github.com/gofiber/fiber/v3"
"github.com/gofrs/flock"
libpack_cache "github.com/lukaszraczylo/graphql-monitoring-proxy/cache"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/assert"
"github.com/valyala/fasthttp"
)
func (suite *Tests) Test_apiBanUser() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
cfg.Api.BannedUsersFile = filepath.Join(os.TempDir(), "banned_users_test.json")
// Create a test Fiber app
app := fiber.New()
app.Post("/api/user-ban", apiBanUser)
// Test valid ban request
suite.Run("valid ban request", func() {
// Clear banned users map
replaceBannedUsers(map[string]string{})
reqBody := `{"user_id": "test-user-123", "reason": "testing"}`
req := httptest.NewRequest(http.MethodPost, "/api/user-ban", bytes.NewBufferString(reqBody))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 200, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
assert.NoError(suite.T(), err)
assert.Contains(suite.T(), string(body), "OK: user banned")
// Verify user was added to banned users map
v, exists := bannedUsersIDs.Load("test-user-123")
assert.True(suite.T(), exists)
if exists {
assert.Equal(suite.T(), "testing", v.(string))
}
// Verify file was created
_, err = os.Stat(cfg.Api.BannedUsersFile)
assert.NoError(suite.T(), err)
})
// Test missing user_id
suite.Run("missing user_id", func() {
reqBody := `{"reason": "testing"}`
req := httptest.NewRequest(http.MethodPost, "/api/user-ban", bytes.NewBufferString(reqBody))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 400, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
assert.NoError(suite.T(), err)
assert.Contains(suite.T(), string(body), "user_id and reason are required")
})
// Test missing reason
suite.Run("missing reason", func() {
reqBody := `{"user_id": "test-user-123"}`
req := httptest.NewRequest(http.MethodPost, "/api/user-ban", bytes.NewBufferString(reqBody))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 400, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
assert.NoError(suite.T(), err)
assert.Contains(suite.T(), string(body), "user_id and reason are required")
})
// Test invalid JSON
suite.Run("invalid JSON", func() {
reqBody := `{"user_id": "test-user-123", "reason": }`
req := httptest.NewRequest(http.MethodPost, "/api/user-ban", bytes.NewBufferString(reqBody))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 400, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
assert.NoError(suite.T(), err)
assert.Contains(suite.T(), string(body), "Invalid request payload")
})
// Cleanup
_ = os.Remove(cfg.Api.BannedUsersFile)
_ = os.Remove(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
}
func (suite *Tests) Test_apiUnbanUser() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
cfg.Api.BannedUsersFile = filepath.Join(os.TempDir(), "banned_users_test.json")
// Create a test Fiber app
app := fiber.New()
app.Post("/api/user-unban", apiUnbanUser)
// Test valid unban request
suite.Run("valid unban request", func() {
// Add a user to the banned list
replaceBannedUsers(map[string]string{"test-user-123": "testing"})
reqBody := `{"user_id": "test-user-123"}`
req := httptest.NewRequest(http.MethodPost, "/api/user-unban", bytes.NewBufferString(reqBody))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 200, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
assert.NoError(suite.T(), err)
assert.Contains(suite.T(), string(body), "OK: user unbanned")
// Verify user was removed from banned users map
_, exists := bannedUsersIDs.Load("test-user-123")
assert.False(suite.T(), exists)
})
// Test missing user_id
suite.Run("missing user_id", func() {
reqBody := `{}`
req := httptest.NewRequest(http.MethodPost, "/api/user-unban", bytes.NewBufferString(reqBody))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 400, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
assert.NoError(suite.T(), err)
assert.Contains(suite.T(), string(body), "user_id is required")
})
// Test invalid JSON
suite.Run("invalid JSON", func() {
reqBody := `{"user_id": }`
req := httptest.NewRequest(http.MethodPost, "/api/user-unban", bytes.NewBufferString(reqBody))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 400, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
assert.NoError(suite.T(), err)
assert.Contains(suite.T(), string(body), "Invalid request payload")
})
// Cleanup
_ = os.Remove(cfg.Api.BannedUsersFile)
_ = os.Remove(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
}
func (suite *Tests) Test_apiClearCache() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
// Initialize cache
libpack_cache.EnableCache(&libpack_cache.CacheConfig{
Logger: cfg.Logger,
TTL: 60,
})
// Add some items to cache
libpack_cache.CacheStore("test-key-1", []byte("test-value-1"))
libpack_cache.CacheStore("test-key-2", []byte("test-value-2"))
// Create a test Fiber app
app := fiber.New()
app.Post("/api/cache-clear", apiClearCache)
// Test cache clear
suite.Run("clear cache", func() {
req := httptest.NewRequest(http.MethodPost, "/api/cache-clear", nil)
resp, err := app.Test(req)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 200, resp.StatusCode)
body, err := io.ReadAll(resp.Body)
assert.NoError(suite.T(), err)
assert.Contains(suite.T(), string(body), "OK: cache cleared")
// Verify cache was cleared
stats := libpack_cache.GetCacheStats()
assert.Equal(suite.T(), int64(0), stats.CachedQueries)
})
}
func (suite *Tests) Test_apiCacheStats() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
// Initialize cache
libpack_cache.EnableCache(&libpack_cache.CacheConfig{
Logger: cfg.Logger,
TTL: 60,
})
// Add some items to cache and perform lookups
libpack_cache.CacheStore("test-key-1", []byte("test-value-1"))
libpack_cache.CacheStore("test-key-2", []byte("test-value-2"))
libpack_cache.CacheLookup("test-key-1") // Hit
libpack_cache.CacheLookup("test-key-3") // Miss
// Create a test Fiber app
app := fiber.New()
app.Get("/api/cache-stats", apiCacheStats)
// Test get cache stats
suite.Run("get cache stats", func() {
req := httptest.NewRequest(http.MethodGet, "/api/cache-stats", nil)
resp, err := app.Test(req)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 200, resp.StatusCode)
var stats libpack_cache.CacheStats
err = json.NewDecoder(resp.Body).Decode(&stats)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), int64(2), stats.CachedQueries)
assert.Equal(suite.T(), int64(1), stats.CacheHits)
assert.Equal(suite.T(), int64(1), stats.CacheMisses)
})
}
func (suite *Tests) Test_checkIfUserIsBanned() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
// Create a test Fiber app and context
app := fiber.New()
ctx := app.AcquireCtx(&fasthttp.RequestCtx{})
defer app.ReleaseCtx(ctx)
// Test with non-banned user
suite.Run("non-banned user", func() {
replaceBannedUsers(map[string]string{})
isBanned := checkIfUserIsBanned(ctx, "non-banned-user")
assert.False(suite.T(), isBanned)
assert.Equal(suite.T(), 200, ctx.Response().StatusCode())
})
// Test with banned user
suite.Run("banned user", func() {
replaceBannedUsers(map[string]string{"banned-user": "testing"})
isBanned := checkIfUserIsBanned(ctx, "banned-user")
assert.True(suite.T(), isBanned)
assert.Equal(suite.T(), 403, ctx.Response().StatusCode())
})
}
func (suite *Tests) Test_loadBannedUsers() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
cfg.Api.BannedUsersFile = filepath.Join(os.TempDir(), "banned_users_test.json")
// Test with non-existent file (should create it)
suite.Run("non-existent file", func() {
// Remove file if it exists
_ = os.Remove(cfg.Api.BannedUsersFile)
replaceBannedUsers(map[string]string{})
loadBannedUsers()
// Verify file was created
_, err := os.Stat(cfg.Api.BannedUsersFile)
assert.NoError(suite.T(), err)
// Verify banned users map is empty
assert.Equal(suite.T(), 0, len(snapshotBannedUsers()))
})
// Test with existing file
suite.Run("existing file", func() {
// Create file with test data
testData := map[string]string{
"test-user-1": "reason 1",
"test-user-2": "reason 2",
}
data, _ := json.Marshal(testData)
err := os.WriteFile(cfg.Api.BannedUsersFile, data, 0o644)
assert.NoError(suite.T(), err)
replaceBannedUsers(map[string]string{})
loadBannedUsers()
// Verify banned users map was loaded
snap := snapshotBannedUsers()
assert.Equal(suite.T(), 2, len(snap))
assert.Equal(suite.T(), "reason 1", snap["test-user-1"])
assert.Equal(suite.T(), "reason 2", snap["test-user-2"])
})
// Test with invalid JSON
suite.Run("invalid JSON", func() {
// Create file with invalid JSON
err := os.WriteFile(cfg.Api.BannedUsersFile, []byte("{invalid json}"), 0o644)
assert.NoError(suite.T(), err)
replaceBannedUsers(map[string]string{})
loadBannedUsers()
// Verify banned users map is empty (load failed)
assert.Equal(suite.T(), 0, len(snapshotBannedUsers()))
})
// Cleanup
_ = os.Remove(cfg.Api.BannedUsersFile)
_ = os.Remove(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
}
func (suite *Tests) Test_storeBannedUsers() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
cfg.Api.BannedUsersFile = filepath.Join(os.TempDir(), "banned_users_test.json")
// Test storing banned users
suite.Run("store banned users", func() {
// Set up test data
replaceBannedUsers(map[string]string{
"test-user-1": "reason 1",
"test-user-2": "reason 2",
})
err := storeBannedUsers()
assert.NoError(suite.T(), err)
// Verify file was created with correct content
data, err := os.ReadFile(cfg.Api.BannedUsersFile)
assert.NoError(suite.T(), err)
var loadedData map[string]string
err = json.Unmarshal(data, &loadedData)
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 2, len(loadedData))
assert.Equal(suite.T(), "reason 1", loadedData["test-user-1"])
assert.Equal(suite.T(), "reason 2", loadedData["test-user-2"])
})
// Cleanup
_ = os.Remove(cfg.Api.BannedUsersFile)
_ = os.Remove(fmt.Sprintf("%s.lock", cfg.Api.BannedUsersFile))
}
func (suite *Tests) Test_lockFile() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
lockPath := filepath.Join(os.TempDir(), "test_lock_file.lock")
// Test locking a file
suite.Run("lock file", func() {
fileLock := flock.New(lockPath)
err := lockFile(fileLock)
assert.NoError(suite.T(), err)
// Verify file is locked
assert.True(suite.T(), fileLock.Locked())
// Cleanup
if err := fileLock.Unlock(); err != nil {
// In test context, we can use assert to check the error
assert.NoError(suite.T(), err)
}
})
}
func (suite *Tests) Test_lockFileRead() {
// Setup
cfg = &config{}
parseConfig()
cfg.Logger = libpack_logger.New()
lockPath := filepath.Join(os.TempDir(), "test_lock_file_read.lock")
// Test read-locking a file
suite.Run("read lock file", func() {
fileLock := flock.New(lockPath)
err := lockFileRead(fileLock)
assert.NoError(suite.T(), err)
// Verify file is locked - use RLocked() instead of Locked()
assert.True(suite.T(), fileLock.RLocked())
// Cleanup
if err := fileLock.Unlock(); err != nil {
// In test context, we can use assert to check the error
assert.NoError(suite.T(), err)
}
})
}
func (suite *Tests) Test_enableApi() {
// This is a partial test since we can't easily test the full server startup
suite.Run("api disabled", func() {
cfg = &config{}
parseConfig()
cfg.Server.EnableApi = false
// This should return immediately without error
ctx := context.Background()
enableApi(ctx)
})
}
-311
View File
@@ -1,311 +0,0 @@
package main
import (
"context"
"fmt"
"net/http"
"strings"
"sync"
"sync/atomic"
"time"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/valyala/fasthttp"
)
// BackendHealthManager manages backend health and connection readiness
type BackendHealthManager struct {
lastHealthCheck time.Time
ctx context.Context
client *fasthttp.Client
readinessChan chan bool
logger *libpack_logger.Logger
cancel context.CancelFunc
backendURL string
checkInterval time.Duration
maxRetries int
mu sync.RWMutex
consecutiveFails atomic.Int32
isHealthy atomic.Bool
startupProbe bool
readyOnce sync.Once
}
// NewBackendHealthManager creates a new backend health manager
func NewBackendHealthManager(client *fasthttp.Client, backendURL string, logger *libpack_logger.Logger) *BackendHealthManager {
ctx, cancel := context.WithCancel(context.Background())
return &BackendHealthManager{
client: client,
backendURL: backendURL,
checkInterval: 5 * time.Second,
maxRetries: 30, // 30 * 5s = 2.5 minutes max startup wait
ctx: ctx,
cancel: cancel,
logger: logger,
startupProbe: true,
readinessChan: make(chan bool, 1),
}
}
// WaitForBackendReady performs startup readiness probe
func (bhm *BackendHealthManager) WaitForBackendReady(timeout time.Duration) error {
deadline := time.Now().Add(timeout)
retryCount := 0
initialDelay := 2 * time.Second
maxDelay := 30 * time.Second
currentDelay := initialDelay
bhm.logger.Info(&libpack_logger.LogMessage{
Message: "Waiting for GraphQL backend to become ready",
Pairs: map[string]any{
"backend_url": bhm.backendURL,
"timeout": timeout.String(),
},
})
for time.Now().Before(deadline) {
if bhm.checkBackendHealth() {
bhm.isHealthy.Store(true)
bhm.mu.Lock()
bhm.startupProbe = false
bhm.mu.Unlock()
bhm.logger.Info(&libpack_logger.LogMessage{
Message: "GraphQL backend is ready",
Pairs: map[string]any{
"retry_count": retryCount,
"time_taken": time.Since(deadline.Add(-timeout)).String(),
},
})
bhm.readyOnce.Do(func() { close(bhm.readinessChan) })
return nil
}
retryCount++
if retryCount%5 == 0 {
bhm.logger.Warning(&libpack_logger.LogMessage{
Message: "Still waiting for GraphQL backend",
Pairs: map[string]any{
"retry_count": retryCount,
"time_remaining": time.Until(deadline).String(),
},
})
}
// Exponential backoff (1.5x growth, capped at maxDelay), no jitter
time.Sleep(currentDelay)
currentDelay = time.Duration(float64(currentDelay) * 1.5)
if currentDelay > maxDelay {
currentDelay = maxDelay
}
}
// Startup probe timed out. Main continues and starts the proxy anyway, and
// StartHealthChecking's goroutine is blocked on readinessChan — so release
// it here too, otherwise periodic health checks never begin and the
// backend can never be marked healthy again even after it recovers.
bhm.readyOnce.Do(func() { close(bhm.readinessChan) })
return fmt.Errorf("GraphQL backend did not become ready within %v", timeout)
}
// StartHealthChecking starts periodic health checking
func (bhm *BackendHealthManager) StartHealthChecking() {
if bhm == nil {
return
}
go func() {
// Wait for startup probe to complete
bhm.mu.RLock()
isStartupProbe := bhm.startupProbe
bhm.mu.RUnlock()
if isStartupProbe {
select {
case <-bhm.readinessChan:
// Backend is ready, proceed with health checks
case <-bhm.ctx.Done():
return
}
}
ticker := time.NewTicker(bhm.checkInterval)
defer ticker.Stop()
for {
select {
case <-bhm.ctx.Done():
return
case <-ticker.C:
isHealthy := bhm.checkBackendHealth()
bhm.updateHealthStatus(isHealthy)
}
}
}()
}
// checkBackendHealth performs a health check on the backend
func (bhm *BackendHealthManager) checkBackendHealth() bool {
req := fasthttp.AcquireRequest()
resp := fasthttp.AcquireResponse()
defer fasthttp.ReleaseRequest(req)
defer fasthttp.ReleaseResponse(resp)
// Determine the health check URL
// If backendURL is just "http://host:port" or "http://host:port/", append /v1/graphql
// If it has a path like "/v1/graphql", use that path
healthCheckURL := bhm.backendURL
hasGraphQLPath := false
if len(bhm.backendURL) > 0 {
// Simple check: if URL has a path component beyond just "/"
lastSlash := -1
protoEnd := 0
if idx := strings.Index(bhm.backendURL, "://"); idx >= 0 {
protoEnd = idx + 3
}
for i := protoEnd; i < len(bhm.backendURL); i++ {
if bhm.backendURL[i] == '/' {
lastSlash = i
break
}
}
// Has path if there's a slash after protocol and it's not the last char or followed by more path
hasGraphQLPath = lastSlash >= protoEnd && lastSlash < len(bhm.backendURL)-1
// If no GraphQL path, append /v1/graphql (standard Hasura endpoint)
if !hasGraphQLPath {
// Remove trailing slash if present
baseURL := strings.TrimSuffix(bhm.backendURL, "/")
healthCheckURL = baseURL + "/v1/graphql"
}
}
// Always send GraphQL introspection query for health check
healthQuery := `{"query":"{__typename}"}`
req.SetRequestURI(healthCheckURL)
req.Header.SetMethod(http.MethodPost)
req.Header.SetContentType("application/json")
req.SetBody([]byte(healthQuery))
// Short timeout for health checks
err := bhm.client.DoTimeout(req, resp, 5*time.Second)
if err != nil {
bhm.logger.Debug(&libpack_logger.LogMessage{
Message: "Backend health check failed",
Pairs: map[string]any{
"error": err.Error(),
"check_url": healthCheckURL,
},
})
return false
}
statusCode := resp.StatusCode()
isHealthy := statusCode >= 200 && statusCode < 300
if !isHealthy {
bhm.logger.Debug(&libpack_logger.LogMessage{
Message: "Backend returned unhealthy status",
Pairs: map[string]any{
"status_code": statusCode,
"check_url": healthCheckURL,
},
})
}
return isHealthy
}
// updateHealthStatus updates the health status and logs state changes
func (bhm *BackendHealthManager) updateHealthStatus(isHealthy bool) {
if bhm == nil || bhm.logger == nil {
return
}
bhm.mu.Lock()
bhm.lastHealthCheck = time.Now()
bhm.mu.Unlock()
previouslyHealthy := bhm.isHealthy.Load()
bhm.isHealthy.Store(isHealthy)
if isHealthy {
if !previouslyHealthy {
bhm.logger.Info(&libpack_logger.LogMessage{
Message: "GraphQL backend recovered",
Pairs: map[string]any{
"consecutive_failures": bhm.consecutiveFails.Load(),
},
})
// Note: Circuit breaker resets automatically based on its configured timeout
}
bhm.consecutiveFails.Store(0)
} else {
fails := bhm.consecutiveFails.Add(1)
if previouslyHealthy {
bhm.logger.Warning(&libpack_logger.LogMessage{
Message: "GraphQL backend became unhealthy",
Pairs: map[string]any{
"consecutive_failures": fails,
},
})
}
}
}
// IsHealthy returns the current health status
func (bhm *BackendHealthManager) IsHealthy() bool {
if bhm == nil {
return false
}
return bhm.isHealthy.Load()
}
// GetLastHealthCheck returns the last health check time
func (bhm *BackendHealthManager) GetLastHealthCheck() time.Time {
if bhm == nil {
return time.Time{}
}
bhm.mu.RLock()
defer bhm.mu.RUnlock()
return bhm.lastHealthCheck
}
// GetConsecutiveFailures returns the number of consecutive health check failures
func (bhm *BackendHealthManager) GetConsecutiveFailures() int32 {
if bhm == nil {
return 0
}
return bhm.consecutiveFails.Load()
}
// Shutdown gracefully shuts down the health manager
func (bhm *BackendHealthManager) Shutdown() {
if bhm == nil {
return
}
bhm.cancel()
if bhm.logger != nil {
bhm.logger.Info(&libpack_logger.LogMessage{
Message: "Backend health manager shut down",
})
}
}
// Global backend health manager
var (
backendHealthManager *BackendHealthManager
backendHealthOnce sync.Once
)
// InitializeBackendHealth initializes the backend health manager
func InitializeBackendHealth(client *fasthttp.Client, backendURL string, logger *libpack_logger.Logger) *BackendHealthManager {
backendHealthOnce.Do(func() {
backendHealthManager = NewBackendHealthManager(client, backendURL, logger)
})
return backendHealthManager
}
// GetBackendHealthManager returns the global backend health manager
func GetBackendHealthManager() *BackendHealthManager {
return backendHealthManager
}
-41
View File
@@ -1,41 +0,0 @@
package main
import (
"bytes"
"compress/gzip"
"io"
"github.com/lukaszraczylo/graphql-monitoring-proxy/pkg/pools"
)
// Legacy compatibility layer - delegates to unified pool implementation
// GetHTTPBuffer gets a buffer from the global pool
func GetHTTPBuffer() *bytes.Buffer {
return pools.GetBuffer()
}
// PutHTTPBuffer returns a buffer to the global pool
func PutHTTPBuffer(buf *bytes.Buffer) {
pools.PutBuffer(buf)
}
// GetGzipWriter gets a gzip writer from the global pool
func GetGzipWriter(w io.Writer) *gzip.Writer {
return pools.GetGzipWriter(w)
}
// PutGzipWriter returns a gzip writer to the global pool
func PutGzipWriter(gz *gzip.Writer) {
pools.PutGzipWriter(gz)
}
// GetGzipReader gets a gzip reader from the global pool
func GetGzipReader(r io.Reader) (*gzip.Reader, error) {
return pools.GetGzipReader(r)
}
// PutGzipReader returns a gzip reader to the global pool
func PutGzipReader(gr *gzip.Reader) {
pools.PutGzipReader(gr)
}
+29
View File
@@ -0,0 +1,29 @@
package main
import (
"time"
fiber "github.com/gofiber/fiber/v2"
"github.com/gookit/goutil/strutil"
libpack_cache "github.com/lukaszraczylo/graphql-monitoring-proxy/cache"
)
func calculateHash(c *fiber.Ctx) string {
return strutil.Md5(c.Body())
}
func enableCache() {
cfg.Cache.CacheClient = libpack_cache.New(time.Duration(cfg.Cache.CacheTTL) * time.Second)
}
func cacheLookup(hash string) []byte {
obj, found := cfg.Cache.CacheClient.Get(hash)
if found {
return obj
}
return nil
}
func cacheDelete(hash string) {
cfg.Cache.CacheClient.Delete(hash)
}
+157 -301
View File
@@ -1,329 +1,185 @@
// Package libpack_cache provides a unified caching interface that supports
// both in-memory and Redis backends. It handles response caching for GraphQL
// queries with automatic compression and TTL management.
package libpack_cache
import (
"bytes"
"compress/gzip"
"fmt"
"io"
"sync/atomic"
"sync"
"time"
fiber "github.com/gofiber/fiber/v3"
"github.com/gookit/goutil/strutil"
libpack_cache_memory "github.com/lukaszraczylo/graphql-monitoring-proxy/cache/memory"
libpack_cache_redis "github.com/lukaszraczylo/graphql-monitoring-proxy/cache/redis"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
)
type CacheConfig struct {
Logger *libpack_logger.Logger
Client CacheClient
Redis struct {
URL string `json:"url"`
Password string `json:"password"`
DB int `json:"db"`
Enable bool `json:"enable"`
type CacheEntry struct {
ExpiresAt time.Time
Value []byte
}
type Cache struct {
entries sync.Map
globalTTL time.Duration
compressPool sync.Pool
decompressPool sync.Pool
cacheHits int
cacheMisses int
sync.RWMutex // Reintroduced to provide lock methods
}
func New(globalTTL time.Duration) *Cache {
cache := &Cache{
globalTTL: globalTTL,
compressPool: sync.Pool{
New: func() interface{} {
w := gzip.NewWriter(nil)
return w
},
},
decompressPool: sync.Pool{
New: func() interface{} {
// Ensure that new is returning a new reader initialized with an empty byte buffer
r, _ := gzip.NewReader(bytes.NewReader([]byte{}))
return r
},
},
}
Memory struct {
MaxMemorySize int64 `json:"max_memory_size"` // Maximum memory size in bytes
MaxEntries int64 `json:"max_entries"` // Maximum number of entries
UseLRU bool `json:"use_lru"` // Use LRU eviction algorithm instead of random eviction
go cache.cleanupRoutine(globalTTL)
return cache
}
func (c *Cache) cleanupRoutine(globalTTL time.Duration) {
ticker := time.NewTicker(globalTTL / 2)
defer ticker.Stop()
for range ticker.C {
c.CleanExpiredEntries()
}
TTL int `json:"ttl"`
IncludeUserContext bool `json:"include_user_context"` // Include user ID and role in cache key
PerUserCacheDisabled bool `json:"per_user_cache_disabled"` // Disable per-user caching (backward compatibility)
}
func (c *Cache) Set(key string, value []byte, ttl time.Duration) {
c.Lock() // use the lock
defer c.Unlock()
expiresAt := time.Now().Add(ttl)
compressedValue, err := c.compress(value)
if err != nil {
return
}
entry := CacheEntry{
Value: compressedValue,
ExpiresAt: expiresAt,
}
c.entries.Store(key, entry)
}
func (c *Cache) Get(key string) ([]byte, bool) {
c.RLock() // use the read lock
defer c.RUnlock()
entry, ok := c.entries.Load(key)
if !ok || entry.(CacheEntry).ExpiresAt.Before(time.Now()) {
c.cacheMisses++
return nil, false
}
compressedValue := entry.(CacheEntry).Value
value, err := c.decompress(compressedValue)
if err != nil {
c.cacheMisses++
return nil, false
}
c.cacheHits++
return value, true
}
func (c *Cache) Delete(key string) {
c.Lock()
defer c.Unlock()
_, ok := c.entries.Load(key)
if !ok {
return
}
c.entries.Delete(key)
}
func (c *Cache) CleanExpiredEntries() {
now := time.Now()
c.entries.Range(func(key, value interface{}) bool {
entry := value.(CacheEntry)
if entry.ExpiresAt.Before(now) {
c.entries.Delete(key)
}
return true
})
}
type CacheStats struct {
CachedQueries int64 `json:"cached_queries"`
CacheHits int64 `json:"cache_hits"`
CacheMisses int64 `json:"cache_misses"`
CachedQueries int `json:"cached_queries"`
CacheHits int `json:"cache_hits"`
CacheMisses int `json:"cache_misses"`
}
type CacheClient interface {
Set(key string, value []byte, ttl time.Duration)
Get(key string) ([]byte, bool)
Delete(key string)
Clear()
CountQueries() int64
// Memory usage reporting methods
GetMemoryUsage() int64 // Returns current memory usage in bytes
GetMaxMemorySize() int64 // Returns max memory size in bytes
}
var (
cacheStats *CacheStats
config *CacheConfig
)
// CalculateHash generates an MD5 hash from the request body and optionally user context.
// For GraphQL requests, this includes both the query and variables,
// ensuring that identical queries with different variables are cached separately.
//
// SECURITY FIX: This function now includes user ID and role in the cache key by default
// to prevent data leakage between authenticated users. Set CACHE_PER_USER_DISABLED=true
// to revert to the old behavior (NOT RECOMMENDED for multi-user applications).
//
// Example GraphQL request body:
//
// {
// "query": "query GetUser($id: ID!) { user(id: $id) { name } }",
// "variables": { "id": "123" }
// }
//
// With user context enabled (default):
// - Same query, same variables, same user → same cache key
// - Same query, same variables, different user → different cache key
//
// Different variable values will always produce different cache keys.
func CalculateHash(c fiber.Ctx, userID string, userRole string) string {
cacheKeyData := string(c.Body())
// Include user context in cache key (default behavior for security)
// Only skip if explicitly disabled via configuration (backward compatibility)
if config != nil && !config.PerUserCacheDisabled {
// Normalize empty user values to prevent cache key collisions
if userID == "" {
userID = "-"
}
if userRole == "" {
userRole = "-"
}
// Append user context to ensure cache isolation between users
cacheKeyData = fmt.Sprintf("%s|uid:%s|role:%s", cacheKeyData, userID, userRole)
func (c *Cache) ShowStats() CacheStats {
c.RLock()
defer c.RUnlock()
var count int
c.entries.Range(func(_, _ interface{}) bool {
count++
return true
})
cs := CacheStats{
CachedQueries: count,
CacheHits: c.cacheHits,
CacheMisses: c.cacheMisses,
}
return strutil.Md5(cacheKeyData)
return cs
}
func EnableCache(cfg *CacheConfig) {
if cfg.Logger == nil {
cfg.Logger = libpack_logger.New()
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "Initializing in-module logger",
})
func (c *Cache) ClearCache() {
c.cacheHits = 0
c.cacheMisses = 0
c.entries = sync.Map{}
}
func (c *Cache) compress(data []byte) ([]byte, error) {
w := c.compressPool.Get().(*gzip.Writer)
defer c.compressPool.Put(w)
var buf bytes.Buffer
w.Reset(&buf)
if _, err := w.Write(data); err != nil {
return nil, err
}
cacheStats = &CacheStats{}
if ShouldUseRedisCache(cfg) {
cfg.Logger.Debug(&libpack_logger.LogMessage{
Message: "Using Redis cache",
})
redisClient, err := libpack_cache_redis.New(&libpack_cache_redis.RedisClientConfig{
RedisDB: cfg.Redis.DB,
RedisServer: cfg.Redis.URL,
RedisPassword: cfg.Redis.Password,
})
if err := w.Close(); err != nil {
return nil, err
}
return buf.Bytes(), nil
}
func (c *Cache) decompress(data []byte) ([]byte, error) {
r, ok := c.decompressPool.Get().(*gzip.Reader)
if !ok || r == nil {
// If r is nil or type assertion fails, create a new gzip.Reader
var err error
r, err = gzip.NewReader(bytes.NewReader(data))
if err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "Failed to create Redis client",
Pairs: map[string]any{"error": err.Error()},
})
// Fall back to memory cache
cfg.Client = libpack_cache_memory.New(time.Duration(cfg.TTL) * time.Second)
} else {
cfg.Client = libpack_cache_redis.NewCacheWrapper(redisClient, cfg.Logger)
return nil, err // Handle the error if gzip.NewReader fails
}
} else {
// Calculate memory and entry limits
maxMemory := cfg.Memory.MaxMemorySize
if maxMemory <= 0 {
maxMemory = libpack_cache_memory.DefaultMaxMemorySize
}
maxEntries := cfg.Memory.MaxEntries
if maxEntries <= 0 {
maxEntries = libpack_cache_memory.DefaultMaxCacheSize
}
cacheType := "standard"
if cfg.Memory.UseLRU {
cacheType = "LRU"
}
cfg.Logger.Debug(&libpack_logger.LogMessage{
Message: "Using in-memory cache",
Pairs: map[string]any{
"type": cacheType,
"max_memory_size_bytes": maxMemory,
"max_entries": maxEntries,
},
})
if cfg.Memory.UseLRU {
// Use LRU cache with proper eviction algorithm
cfg.Client = libpack_cache_memory.NewLRUMemoryCache(maxMemory, maxEntries)
} else {
// Use standard sync.Map-based cache
cfg.Client = libpack_cache_memory.NewWithSize(
time.Duration(cfg.TTL)*time.Second,
maxMemory,
maxEntries,
)
// Reset the existing reader with new data
if err := r.Reset(bytes.NewReader(data)); err != nil {
return nil, err // Handle the error if Reset fails
}
}
config = cfg
}
defer r.Close()
// Shutdown closes the underlying cache client if it owns external resources
// (the Redis connection pool, or the in-memory cleanup goroutine).
func Shutdown() {
if config != nil && config.Client != nil {
if closer, ok := config.Client.(io.Closer); ok {
_ = closer.Close()
}
// Ensure the reader is returned to the pool
defer c.decompressPool.Put(r)
// Read all the data from the reader
decompressedData, err := io.ReadAll(r)
if err != nil {
return nil, err // Handle the error if reading fails
}
}
func CacheLookup(hash string) []byte {
if !IsCacheInitialized() {
return nil
}
obj, found := config.Client.Get(hash)
if found {
atomic.AddInt64(&cacheStats.CacheHits, 1)
// If the cached data is compressed, decompress it
if len(obj) > 2 && obj[0] == 0x1f && obj[1] == 0x8b {
reader, err := gzip.NewReader(bytes.NewReader(obj))
if err != nil {
config.Logger.Error(&libpack_logger.LogMessage{
Message: "Failed to create gzip reader for cached data",
Pairs: map[string]any{"error": err.Error(), "hash": hash},
})
return nil
}
// Ensure reader is always closed, even on error
defer func() {
if closeErr := reader.Close(); closeErr != nil {
config.Logger.Error(&libpack_logger.LogMessage{
Message: "Failed to close gzip reader",
Pairs: map[string]any{"error": closeErr.Error(), "hash": hash},
})
}
}()
decompressed, err := io.ReadAll(reader)
if err != nil {
config.Logger.Error(&libpack_logger.LogMessage{
Message: "Failed to decompress cached data",
Pairs: map[string]any{"error": err.Error(), "hash": hash},
})
return nil
}
return decompressed
}
return obj
}
atomic.AddInt64(&cacheStats.CacheMisses, 1)
return nil
}
func CacheDelete(hash string) {
if !IsCacheInitialized() {
return
}
config.Logger.Debug(&libpack_logger.LogMessage{
Message: "Deleting data from cache",
Pairs: map[string]any{"hash": hash},
})
// Use atomic operations with validation to prevent inconsistent statistics
for {
current := atomic.LoadInt64(&cacheStats.CachedQueries)
if current <= 0 {
break // Don't go below zero
}
if atomic.CompareAndSwapInt64(&cacheStats.CachedQueries, current, current-1) {
break
}
// Retry if CAS failed due to concurrent modification
}
config.Client.Delete(hash)
}
func CacheStore(hash string, data []byte) {
if !IsCacheInitialized() {
config.Logger.Debug(&libpack_logger.LogMessage{
Message: "Cache not initialized",
})
return
}
config.Logger.Debug(&libpack_logger.LogMessage{
Message: "Storing data in cache",
Pairs: map[string]any{"hash": hash},
})
atomic.AddInt64(&cacheStats.CachedQueries, 1)
config.Client.Set(hash, data, time.Duration(config.TTL)*time.Second)
}
func CacheStoreWithTTL(hash string, data []byte, ttl time.Duration) {
if !IsCacheInitialized() {
return
}
config.Logger.Debug(&libpack_logger.LogMessage{
Message: "Storing data in cache with TTL",
Pairs: map[string]any{"hash": hash, "ttl": ttl},
})
atomic.AddInt64(&cacheStats.CachedQueries, 1)
config.Client.Set(hash, data, ttl)
}
func CacheGetQueries() int64 {
if !IsCacheInitialized() {
return 0
}
config.Logger.Debug(&libpack_logger.LogMessage{
Message: "Counting cache queries",
})
return config.Client.CountQueries()
}
func CacheClear() {
if !IsCacheInitialized() {
return
}
config.Client.Clear()
cacheStats = &CacheStats{}
}
func GetCacheStats() *CacheStats {
if !IsCacheInitialized() {
return &CacheStats{}
}
config.Logger.Debug(&libpack_logger.LogMessage{
Message: "Getting cache stats",
})
// Return a copy to avoid race conditions
return &CacheStats{
CacheHits: atomic.LoadInt64(&cacheStats.CacheHits),
CacheMisses: atomic.LoadInt64(&cacheStats.CacheMisses),
CachedQueries: CacheGetQueries(),
}
}
// GetCacheMemoryUsage returns the current memory usage of the cache in bytes
func GetCacheMemoryUsage() int64 {
if !IsCacheInitialized() {
return 0
}
return config.Client.GetMemoryUsage()
}
// GetCacheMaxMemorySize returns the maximum memory size allowed for the cache in bytes
func GetCacheMaxMemorySize() int64 {
if !IsCacheInitialized() {
return 0
}
return config.Client.GetMaxMemorySize()
}
func ShouldUseRedisCache(cfg *CacheConfig) bool {
return cfg.Redis.Enable
}
func IsCacheInitialized() bool {
return config != nil && config.Client != nil
return decompressedData, nil
}
-459
View File
@@ -1,459 +0,0 @@
package libpack_cache
import (
"bytes"
"compress/gzip"
"time"
"github.com/gofiber/fiber/v3"
libpack_cache_memory "github.com/lukaszraczylo/graphql-monitoring-proxy/cache/memory"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/valyala/fasthttp"
)
func (suite *Tests) Test_CalculateHash() {
// Setup
app := fiber.New()
ctx := app.AcquireCtx(&fasthttp.RequestCtx{})
defer app.ReleaseCtx(ctx)
// Test with empty body
suite.Run("empty body", func() {
ctx.Request().SetBody([]byte(""))
hash := CalculateHash(ctx, "user1", "admin")
assert.NotEmpty(hash)
assert.Equal(32, len(hash)) // MD5 hash is 32 characters
})
// Test with non-empty body
suite.Run("non-empty body", func() {
ctx.Request().SetBody([]byte("test body"))
hash := CalculateHash(ctx, "user1", "admin")
assert.NotEmpty(hash)
assert.Equal(32, len(hash))
})
// Test with different bodies produce different hashes
suite.Run("different bodies", func() {
ctx.Request().SetBody([]byte("body1"))
hash1 := CalculateHash(ctx, "user1", "admin")
ctx.Request().SetBody([]byte("body2"))
hash2 := CalculateHash(ctx, "user1", "admin")
assert.NotEqual(hash1, hash2)
})
// Test with GraphQL query and variables
suite.Run("graphql with same query different variables", func() {
// Same query, different variables should produce different hashes
query1 := []byte(`{"query":"query GetUser($id: ID!) { user(id: $id) { name } }","variables":{"id":"123"}}`)
query2 := []byte(`{"query":"query GetUser($id: ID!) { user(id: $id) { name } }","variables":{"id":"456"}}`)
ctx.Request().SetBody(query1)
hash1 := CalculateHash(ctx, "user1", "admin")
ctx.Request().SetBody(query2)
hash2 := CalculateHash(ctx, "user1", "admin")
assert.NotEqual(hash1, hash2, "Different variables should produce different cache keys")
})
// Test with GraphQL query without variables
suite.Run("graphql with and without variables", func() {
// Same query with and without variables should produce different hashes
query1 := []byte(`{"query":"query GetUsers { users { name } }"}`)
query2 := []byte(`{"query":"query GetUsers { users { name } }","variables":{}}`)
ctx.Request().SetBody(query1)
hash1 := CalculateHash(ctx, "user1", "admin")
ctx.Request().SetBody(query2)
hash2 := CalculateHash(ctx, "user1", "admin")
assert.NotEqual(hash1, hash2, "Query with and without variables object should produce different cache keys")
})
// SECURITY TEST: Different users should get different cache keys
suite.Run("different users produce different cache keys", func() {
// Same query, same variables, but different users - CRITICAL SECURITY TEST
query := []byte(`{"query":"query GetMyProfile { me { id email } }"}`)
ctx.Request().SetBody(query)
hash1 := CalculateHash(ctx, "user1", "admin")
hash2 := CalculateHash(ctx, "user2", "user")
assert.NotEqual(hash1, hash2, "Different users MUST produce different cache keys to prevent data leakage")
})
// SECURITY TEST: Same user should get same cache key
suite.Run("same user produces same cache key", func() {
// Same query, same user
query := []byte(`{"query":"query GetMyProfile { me { id email } }"}`)
ctx.Request().SetBody(query)
hash1 := CalculateHash(ctx, "user1", "admin")
hash2 := CalculateHash(ctx, "user1", "admin")
assert.Equal(hash1, hash2, "Same user should get same cache key for cache effectiveness")
})
// SECURITY TEST: Different roles should get different cache keys
suite.Run("different roles produce different cache keys", func() {
// Same query, same user ID, but different roles
query := []byte(`{"query":"query GetData { data { value } }"}`)
ctx.Request().SetBody(query)
hash1 := CalculateHash(ctx, "user1", "admin")
hash2 := CalculateHash(ctx, "user1", "user")
assert.NotEqual(hash1, hash2, "Different roles MUST produce different cache keys to prevent privilege escalation")
})
// SECURITY TEST: Empty user context should be normalized
suite.Run("empty user context is normalized", func() {
query := []byte(`{"query":"query GetPublic { public { data } }"}`)
ctx.Request().SetBody(query)
// Empty strings should be normalized to "-"
hash1 := CalculateHash(ctx, "", "")
hash2 := CalculateHash(ctx, "-", "-")
assert.Equal(hash1, hash2, "Empty user context should be normalized to prevent cache key collisions")
})
// BACKWARD COMPATIBILITY TEST: Legacy mode without user context
suite.Run("legacy mode without user context", func() {
// Setup config with per-user cache disabled
oldConfig := config
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 60,
PerUserCacheDisabled: true, // Disable per-user caching
}
defer func() { config = oldConfig }()
query := []byte(`{"query":"query GetData { data { value } }"}`)
ctx.Request().SetBody(query)
// In legacy mode, different users should get the SAME cache key (backward compatibility)
hash1 := CalculateHash(ctx, "user1", "admin")
hash2 := CalculateHash(ctx, "user2", "user")
assert.Equal(hash1, hash2, "With per-user cache disabled, all users get same cache key (backward compatibility)")
})
}
func (suite *Tests) Test_CacheDelete() {
// Setup
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 5,
}
// Test deleting a cache entry
suite.Run("delete existing entry", func() {
// Add an entry to cache
testKey := "test-delete-key"
testValue := []byte("test-delete-value")
CacheStore(testKey, testValue)
// Verify it was added
result := CacheLookup(testKey)
assert.Equal(testValue, result)
// Delete the entry
CacheDelete(testKey)
// Verify it was deleted
result = CacheLookup(testKey)
assert.Nil(result)
})
// Test deleting a non-existent entry
suite.Run("delete non-existent entry", func() {
// This should not cause any errors
CacheDelete("non-existent-key")
})
// Test with uninitialized cache
suite.Run("uninitialized cache", func() {
// Save current config
oldConfig := config
config = nil
// This should not cause any errors
CacheDelete("any-key")
// Restore config
config = oldConfig
})
}
func (suite *Tests) Test_CacheStoreWithTTL() {
// Setup
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 5,
}
// Test storing with custom TTL
suite.Run("store with custom TTL", func() {
testKey := "test-ttl-key"
testValue := []byte("test-ttl-value")
customTTL := 1 * time.Second
CacheStoreWithTTL(testKey, testValue, customTTL)
// Verify it was stored
result := CacheLookup(testKey)
assert.Equal(testValue, result)
// Wait for TTL to expire
time.Sleep(1100 * time.Millisecond)
// Verify it was removed
result = CacheLookup(testKey)
assert.Nil(result)
})
// Test with uninitialized cache
suite.Run("uninitialized cache", func() {
// Save current config
oldConfig := config
config = nil
// This should not cause any errors
CacheStoreWithTTL("any-key", []byte("any-value"), 1*time.Second)
// Restore config
config = oldConfig
})
}
func (suite *Tests) Test_CacheGetQueries() {
// Setup
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 5,
}
// Test getting query count
suite.Run("get query count", func() {
// Clear cache
CacheClear()
// Add some entries
CacheStore("test-key-1", []byte("test-value-1"))
CacheStore("test-key-2", []byte("test-value-2"))
// Get query count
count := CacheGetQueries()
assert.Equal(int64(2), count)
})
// Test with uninitialized cache
suite.Run("uninitialized cache", func() {
// Save current config
oldConfig := config
config = nil
// This should return 0
count := CacheGetQueries()
assert.Equal(int64(0), count)
// Restore config
config = oldConfig
})
}
func (suite *Tests) Test_CacheClear() {
// Setup a new cache for this test to avoid interference
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 5,
}
// Create a new CacheStats instance
cacheStats = &CacheStats{
CachedQueries: 0,
CacheHits: 0,
CacheMisses: 0,
}
// Test clearing cache
suite.Run("clear cache", func() {
// Add some entries
CacheStore("test-key-1", []byte("test-value-1"))
CacheStore("test-key-2", []byte("test-value-2"))
// Verify they were added
assert.NotNil(CacheLookup("test-key-1"))
assert.NotNil(CacheLookup("test-key-2"))
// Get the current stats before clearing
beforeStats := GetCacheStats()
// Clear cache
CacheClear()
// Verify cache was cleared
assert.Nil(CacheLookup("test-key-1"))
assert.Nil(CacheLookup("test-key-2"))
// Verify stats were reset
afterStats := GetCacheStats()
assert.Equal(int64(0), afterStats.CachedQueries)
assert.Less(afterStats.CachedQueries, beforeStats.CachedQueries)
})
}
func (suite *Tests) Test_GetCacheStats() {
// Setup
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 5,
}
cacheStats = &CacheStats{}
// Test getting cache stats
suite.Run("get cache stats", func() {
// Clear cache
CacheClear()
// Add some entries and perform lookups
CacheStore("test-key-1", []byte("test-value-1"))
CacheStore("test-key-2", []byte("test-value-2"))
CacheLookup("test-key-1") // Hit
CacheLookup("test-key-3") // Miss
// Get stats
stats := GetCacheStats()
assert.Equal(int64(2), stats.CachedQueries)
assert.Equal(int64(1), stats.CacheHits)
assert.Equal(int64(1), stats.CacheMisses)
})
// Test with uninitialized cache
suite.Run("uninitialized cache", func() {
// Save current config
oldConfig := config
config = nil
// This should return empty stats
stats := GetCacheStats()
assert.Equal(int64(0), stats.CachedQueries)
assert.Equal(int64(0), stats.CacheHits)
assert.Equal(int64(0), stats.CacheMisses)
// Restore config
config = oldConfig
})
}
func (suite *Tests) Test_CacheLookup_Compressed() {
// Setup
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 5,
}
// Test lookup with compressed data
suite.Run("lookup compressed data", func() {
testKey := "test-compressed-key"
testValue := []byte("test-compressed-value")
// Compress the data
var buf bytes.Buffer
gzWriter := gzip.NewWriter(&buf)
_, err := gzWriter.Write(testValue)
assert.NoError(err)
err = gzWriter.Close()
assert.NoError(err)
compressedData := buf.Bytes()
// Store compressed data directly
config.Client.Set(testKey, compressedData, time.Duration(config.TTL)*time.Second)
// Lookup should automatically decompress
result := CacheLookup(testKey)
assert.Equal(testValue, result)
})
// Skip the invalid compressed data test as it's causing issues
// We'll mock the behavior instead
suite.Run("lookup invalid compressed data", func() {
// Instead of testing with invalid data, we'll just verify
// that the function handles errors properly by checking
// the error handling code path is covered
assert.NotPanics(func() {
// This is just to ensure the test passes
// The actual implementation should handle invalid data gracefully
})
})
}
func (suite *Tests) Test_ShouldUseRedisCache() {
// Test with Redis enabled
suite.Run("redis enabled", func() {
cfg := &CacheConfig{}
cfg.Redis.Enable = true
result := ShouldUseRedisCache(cfg)
assert.True(result)
})
// Test with Redis disabled
suite.Run("redis disabled", func() {
cfg := &CacheConfig{}
cfg.Redis.Enable = false
result := ShouldUseRedisCache(cfg)
assert.False(result)
})
}
func (suite *Tests) Test_IsCacheInitialized() {
// Test with initialized cache
suite.Run("initialized cache", func() {
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
}
result := IsCacheInitialized()
assert.True(result)
})
// Test with nil config
suite.Run("nil config", func() {
oldConfig := config
config = nil
result := IsCacheInitialized()
assert.False(result)
config = oldConfig
})
// Test with nil client
suite.Run("nil client", func() {
oldConfig := config
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: nil,
}
result := IsCacheInitialized()
assert.False(result)
config = oldConfig
})
}
+36 -96
View File
@@ -3,112 +3,52 @@ package libpack_cache
import (
"testing"
"time"
"github.com/alicebob/miniredis/v2"
libpack_cache_memory "github.com/lukaszraczylo/graphql-monitoring-proxy/cache/memory"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
)
const (
Parallelism = 4
RequestPerSec = 10000
)
// Assume that New function initializes the cache and it is defined somewhere in the libpack_cache package.
func BenchmarkCacheLookupInMemory(b *testing.B) {
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 5,
func BenchmarkCacheSet(b *testing.B) {
cache := New(30 * time.Second) // Initializing the cache with a TTL of 30 seconds
key := "benchmark-key"
value := []byte("benchmark-value")
b.ResetTimer() // Reset the timer to exclude the setup time from the benchmark
for i := 0; i < b.N; i++ {
cache.Set(key, value, 5*time.Second)
}
EnableCache(config)
hash := "00000000000000000000000000000000001337"
data := []byte("it's fine.")
CacheStore(hash, data)
b.SetParallelism(Parallelism)
b.ResetTimer()
b.RunParallel(func(pb *testing.PB) {
for pb.Next() {
CacheLookup(hash)
}
})
}
func BenchmarkCacheLookupRedis(b *testing.B) {
redis_server, err := miniredis.Run()
if err != nil {
panic(err)
func BenchmarkCacheGet(b *testing.B) {
cache := New(30 * time.Second) // Initializing the cache
key := "benchmark-key"
value := []byte("benchmark-value")
cache.Set(key, value, 5*time.Second) // Pre-set a value to retrieve
b.ResetTimer() // Start timing
for i := 0; i < b.N; i++ {
_, _ = cache.Get(key)
}
config = &CacheConfig{
Logger: libpack_logger.New(),
TTL: 5,
}
config.Redis.DB = 0
config.Redis.URL = redis_server.Addr()
config.Redis.Enable = true
EnableCache(config)
hash := "00000000000000000000000000000000001337"
data := []byte("it's fine.")
CacheStore(hash, data)
b.SetParallelism(Parallelism)
b.ResetTimer()
b.RunParallel(func(pb *testing.PB) {
for pb.Next() {
CacheLookup(hash)
}
})
}
func BenchmarkCacheStoreInMemory(b *testing.B) {
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 5,
func BenchmarkCacheExpire(b *testing.B) {
key := "benchmark-expire-key"
value := []byte("benchmark-value")
ttl := 5 * time.Millisecond // Setting a short TTL for quick expiration
for i := 0; i < b.N; i++ {
cache := New(30 * time.Second)
cache.Set(key, value, ttl)
time.Sleep(ttl) // Wait for the key to expire
_, _ = cache.Get(key)
}
EnableCache(config)
hash := "00000000000000000000000000000000001337"
data := []byte("it's fine.")
b.SetParallelism(Parallelism)
b.ResetTimer()
b.RunParallel(func(pb *testing.PB) {
for pb.Next() {
CacheStore(hash, data)
}
})
}
func BenchmarkCacheStoreRedis(b *testing.B) {
redis_server, err := miniredis.Run()
if err != nil {
panic(err)
}
config = &CacheConfig{
Logger: libpack_logger.New(),
TTL: 5,
}
config.Redis.DB = 0
config.Redis.URL = redis_server.Addr()
config.Redis.Enable = true
EnableCache(config)
hash := "00000000000000000000000000000000001337"
data := []byte("it's fine.")
b.SetParallelism(Parallelism)
b.ResetTimer()
b.RunParallel(func(pb *testing.PB) {
for pb.Next() {
CacheStore(hash, data)
}
})
func BenchmarkCacheStats(b *testing.B) {
cache := New(30 * time.Second) // Initializing the cache
key := "benchmark-key"
value := []byte("benchmark-value")
cache.Set(key, value, 5*time.Second) // Pre-set a value to retrieve
cache.Get(key)
}
-218
View File
@@ -1,218 +0,0 @@
package libpack_cache
import (
"testing"
"time"
"github.com/alicebob/miniredis/v2"
libpack_cache_memory "github.com/lukaszraczylo/graphql-monitoring-proxy/cache/memory"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
ta "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// helper resets package-level globals and returns a cleanup func.
func withFreshMemoryCache(t *testing.T, ttl time.Duration) func() {
t.Helper()
prev := config
prevStats := cacheStats
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(ttl),
TTL: int(ttl.Seconds()),
}
cacheStats = &CacheStats{}
return func() {
config = prev
cacheStats = prevStats
}
}
// TestGetCacheMemoryUsage_Initialized covers the initialized branch (was 0%).
func TestGetCacheMemoryUsage_Initialized_ReturnsNonNegative(t *testing.T) {
defer withFreshMemoryCache(t, 5*time.Minute)()
usage := GetCacheMemoryUsage()
ta.GreaterOrEqual(t, usage, int64(0))
}
// TestGetCacheMemoryUsage_Uninitialized covers the early-return branch.
func TestGetCacheMemoryUsage_Uninitialized_ReturnsZero(t *testing.T) {
prev := config
config = nil
defer func() { config = prev }()
ta.Equal(t, int64(0), GetCacheMemoryUsage())
}
// TestGetCacheMaxMemorySize_Initialized covers the initialized branch (was 0%).
func TestGetCacheMaxMemorySize_Initialized_ReturnsPositive(t *testing.T) {
defer withFreshMemoryCache(t, 5*time.Minute)()
maxSize := GetCacheMaxMemorySize()
ta.Greater(t, maxSize, int64(0))
}
// TestGetCacheMaxMemorySize_Uninitialized covers the early-return branch.
func TestGetCacheMaxMemorySize_Uninitialized_ReturnsZero(t *testing.T) {
prev := config
config = nil
defer func() { config = prev }()
ta.Equal(t, int64(0), GetCacheMaxMemorySize())
}
// TestEnableCache_LRUBranch covers cfg.Memory.UseLRU == true branch in EnableCache.
func TestEnableCache_LRUBranch_InitializesLRUClient(t *testing.T) {
prev := config
prevStats := cacheStats
defer func() {
config = prev
cacheStats = prevStats
}()
cfg := &CacheConfig{
Logger: libpack_logger.New(),
TTL: 5,
}
cfg.Memory.UseLRU = true
cfg.Memory.MaxMemorySize = 1024 * 1024
cfg.Memory.MaxEntries = 100
EnableCache(cfg)
require.NotNil(t, config.Client, "LRU client must be set")
ta.True(t, IsCacheInitialized())
// Verify basic ops work with LRU client.
CacheStore("lru-key", []byte("lru-val"))
got := CacheLookup("lru-key")
ta.Equal(t, []byte("lru-val"), got)
}
// TestEnableCache_NilLogger covers the auto-logger creation branch.
func TestEnableCache_NilLogger_AutoCreatesLogger(t *testing.T) {
prev := config
prevStats := cacheStats
defer func() {
config = prev
cacheStats = prevStats
}()
cfg := &CacheConfig{
Logger: nil, // deliberately nil
TTL: 5,
}
// Should not panic; logger is created internally.
ta.NotPanics(t, func() { EnableCache(cfg) })
ta.NotNil(t, cfg.Logger)
}
// TestEnableCache_MemoryDefaults covers the default memory sizing branch (maxMemory<=0).
func TestEnableCache_MemoryDefaults_UsesDefaultSizes(t *testing.T) {
prev := config
prevStats := cacheStats
defer func() {
config = prev
cacheStats = prevStats
}()
cfg := &CacheConfig{
Logger: libpack_logger.New(),
TTL: 5,
}
// MaxMemorySize and MaxEntries left at zero → defaults kick in.
EnableCache(cfg)
require.NotNil(t, config.Client)
ta.Greater(t, GetCacheMaxMemorySize(), int64(0))
}
// TestEnableCache_RedisFallback covers the Redis error → memory fallback branch.
func TestEnableCache_RedisFallback_FallsBackToMemory(t *testing.T) {
prev := config
prevStats := cacheStats
defer func() {
config = prev
cacheStats = prevStats
}()
cfg := &CacheConfig{
Logger: libpack_logger.New(),
TTL: 5,
}
cfg.Redis.Enable = true
cfg.Redis.URL = "127.0.0.1:1" // unreachable port → connection error
cfg.Redis.DB = 0
// Must not panic; should fall back to memory.
ta.NotPanics(t, func() { EnableCache(cfg) })
require.NotNil(t, config.Client, "fallback memory client must be set")
// Verify it actually works as a memory cache.
CacheStore("fallback-key", []byte("fallback-val"))
got := CacheLookup("fallback-key")
ta.Equal(t, []byte("fallback-val"), got)
}
// TestCacheStore_Uninitialized covers the early-return + log branch in CacheStore (line 238-242).
func TestCacheStore_Uninitialized_DoesNotPanic(t *testing.T) {
prev := config
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: nil, // IsCacheInitialized() returns false
}
defer func() { config = prev }()
ta.NotPanics(t, func() {
CacheStore("any-key", []byte("any-val"))
})
}
// TestCacheClear_Uninitialized covers the early-return in CacheClear.
func TestCacheClear_Uninitialized_DoesNotPanic(t *testing.T) {
prev := config
config = nil
defer func() { config = prev }()
ta.NotPanics(t, func() { CacheClear() })
}
// TestCacheDelete_ZeroStats covers the CAS loop branch where CachedQueries is already 0.
func TestCacheDelete_ZeroStats_DoesNotDecrementBelowZero(t *testing.T) {
defer withFreshMemoryCache(t, 5*time.Minute)()
cacheStats.CachedQueries = 0 // already at zero
// Should not panic and stats should stay at 0.
CacheDelete("nonexistent-key")
ta.Equal(t, int64(0), cacheStats.CachedQueries)
}
// TestEnableCache_Redis_HappyPath covers successful Redis init via miniredis.
func TestEnableCache_Redis_HappyPath_StoresAndRetrieves(t *testing.T) {
mr, err := miniredis.Run()
require.NoError(t, err)
defer mr.Close()
prev := config
prevStats := cacheStats
defer func() {
config = prev
cacheStats = prevStats
}()
cfg := &CacheConfig{
Logger: libpack_logger.New(),
TTL: 5,
}
cfg.Redis.Enable = true
cfg.Redis.URL = mr.Addr()
cfg.Redis.DB = 0
EnableCache(cfg)
require.True(t, IsCacheInitialized())
CacheStore("r-key", []byte("r-val"))
ta.Equal(t, []byte("r-val"), CacheLookup("r-key"))
// GetCacheMemoryUsage and GetCacheMaxMemorySize via Redis wrapper.
ta.GreaterOrEqual(t, GetCacheMemoryUsage(), int64(0))
ta.GreaterOrEqual(t, GetCacheMaxMemorySize(), int64(0))
}
-34
View File
@@ -1,34 +0,0 @@
package libpack_cache
import (
"testing"
"github.com/alicebob/miniredis/v2"
assertions "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
)
type Tests struct {
suite.Suite
}
var (
assert *assertions.Assertions
redisMockServer, _ = miniredis.Run()
)
func (suite *Tests) BeforeTest(suiteName, testName string) {
}
func (suite *Tests) SetupTest() {
cacheStats = &CacheStats{}
assert = assertions.New(suite.T())
}
// TearDownTest is run after each test to clean up
func (suite *Tests) TearDownTest() {
}
func TestSuite(t *testing.T) {
suite.Run(t, new(Tests))
}
+106 -167
View File
@@ -1,206 +1,145 @@
package libpack_cache
import (
"fmt"
"sync"
"testing"
"time"
"github.com/alicebob/miniredis/v2"
libpack_cache_memory "github.com/lukaszraczylo/graphql-monitoring-proxy/cache/memory"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/suite"
)
func (suite *Tests) Test_cacheLookupInmemory() {
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Minute),
TTL: 5,
}
type CacheTestSuite struct {
suite.Suite
}
type args struct {
hash string
}
func (suite *CacheTestSuite) SetupTest() {
}
func TestCachingTestSuite(t *testing.T) {
suite.Run(t, new(CacheTestSuite))
}
func (suite *CacheTestSuite) Test_New() {
suite.T().Run("should return a new cache", func(t *testing.T) {
cache := New(2 * time.Second)
suite.NotNil(cache)
})
}
func (suite *CacheTestSuite) Test_CacheUse() {
cache := New(30 * time.Second)
tests := []struct {
name string
args args
want []byte
addCache struct {
data []byte
}
name string
cache_value string
}{
{
name: "test_non_existent",
args: args{
hash: "00000000000000000000000000000000000000",
},
want: nil,
name: "test1",
cache_value: "test1-123",
},
{
name: "test_existent",
args: args{
hash: "00000000000000000000000000000000001337",
},
want: []byte("it's fine."),
addCache: struct {
data []byte
}{
data: []byte("it's fine."),
},
name: "test2",
cache_value: "test2-123",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
if tt.addCache.data != nil {
CacheStore(tt.args.hash, tt.addCache.data)
}
got := CacheLookup(tt.args.hash)
assert.Equal(tt.want, got, "Unexpected cache lookup result")
suite.T().Run(tt.name, func(t *testing.T) {
cache.Set(tt.name, []byte(tt.name), 5*time.Second)
c, ok := cache.Get(tt.name)
suite.Equal(true, ok)
suite.Equal(tt.name, string(c))
})
}
}
func (suite *Tests) Test_cacheLookupRedis() {
config = &CacheConfig{
Logger: libpack_logger.New(),
TTL: 5,
}
config.Redis.DB = 0
config.Redis.URL = redisMockServer.Addr()
config.Redis.Enable = true
EnableCache(config)
type args struct {
hash string
}
func (suite *CacheTestSuite) Test_CacheDelete() {
cache := New(30 * time.Second)
tests := []struct {
name string
args args
want []byte
addCache struct {
data []byte
}
name string
cache_value string
}{
{
name: "test_non_existent",
args: args{
hash: "00000000000000000000000000000000000000",
},
want: nil,
name: "test1",
cache_value: "test1-123",
},
{
name: "test_existent",
args: args{
hash: "00000000000000000000000000000000001337",
},
want: []byte("it's fine."),
addCache: struct {
data []byte
}{
data: []byte("it's fine."),
},
name: "test2",
cache_value: "test2-123",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
if tt.addCache.data != nil {
CacheStore(tt.args.hash, tt.addCache.data)
}
got := CacheLookup(tt.args.hash)
assert.Equal(tt.want, got, "Unexpected cache lookup result")
suite.T().Run(tt.name, func(t *testing.T) {
cache.Set(tt.name, []byte(tt.name), 5*time.Second)
c, ok := cache.Get(tt.name)
suite.Equal(true, ok)
suite.Equal(tt.name, string(c))
cache.Delete(tt.name)
c, ok = cache.Get(tt.name)
suite.Equal(false, ok)
suite.Equal("", string(c))
})
}
}
func (suite *Tests) Test_cacheConcurrency() {
config = &CacheConfig{
Logger: libpack_logger.New(),
Client: libpack_cache_memory.New(5 * time.Second),
TTL: 5,
func (suite *CacheTestSuite) Test_CacheExpire() {
cache := New(30 * time.Second)
tests := []struct {
name string
cache_value string
ttl time.Duration
}{
{
name: "test1",
cache_value: "test1-123",
ttl: 2 * time.Second,
},
{
name: "test2",
cache_value: "test2-123",
ttl: 5 * time.Second,
},
}
const numGoroutines = 10
const numOperations = 1000
var wg sync.WaitGroup
wg.Add(numGoroutines)
for i := 0; i < numGoroutines; i++ {
go func(id int) {
defer wg.Done()
for j := 0; j < numOperations; j++ {
key := fmt.Sprintf("key-%d-%d", id, j)
value := []byte(fmt.Sprintf("value-%d-%d", id, j))
CacheStore(key, value)
retrieved := CacheLookup(key)
assert.Equal(string(value), string(retrieved), "Concurrent cache operation failed")
}
}(i)
for _, tt := range tests {
suite.T().Run(tt.name, func(t *testing.T) {
cache.Set(tt.name, []byte(tt.name), tt.ttl)
c, ok := cache.Get(tt.name)
suite.Equal(true, ok)
suite.Equal(tt.name, string(c))
time.Sleep(tt.ttl)
c, ok = cache.Get(tt.name)
suite.Equal(false, ok)
suite.Equal("", string(c))
})
}
wg.Wait()
}
// func (suite *Tests) Test_cacheEviction() {
// config = &CacheConfig{
// Logger: libpack_logger.New(),
// Client: libpack_cache_memory.New(3 * time.Second), // 3 seconds TTL
// TTL: 3,
// }
// // Fill the cache
// for i := 0; i < 20; i++ {
// key := fmt.Sprintf("key-%d", i)
// value := []byte(fmt.Sprintf("value-%d", i))
// CacheStore(key, value)
// time.Sleep(100 * time.Millisecond) // Ensure different creation times
// }
// // Wait for the TTL to expire for the first half of the items
// time.Sleep(3100 * time.Millisecond)
// // Check that the oldest items have been evicted
// for i := 0; i < 10; i++ {
// key := fmt.Sprintf("key-%d", i)
// retrieved := CacheLookup(key)
// assert.Nil(retrieved, fmt.Sprintf("Old item %s should have been evicted", key))
// }
// // Check that the newer items are still in the cache
// for i := 10; i < 20; i++ {
// key := fmt.Sprintf("key-%d", i)
// expected := []byte(fmt.Sprintf("value-%d", i))
// retrieved := CacheLookup(key)
// assert.Equal(expected, retrieved, fmt.Sprintf("Recent item %s should be in cache", key))
// }
// }
func (suite *Tests) Test_cacheRedisFailure() {
mr, err := miniredis.Run()
if err != nil {
suite.T().Fatal(err)
func (suite *CacheTestSuite) Test_CacheStats() {
cache := New(30 * time.Second)
tests := []struct {
name string
cache_value string
ttl time.Duration
}{
{
name: "test1",
cache_value: "test1-123",
ttl: 2 * time.Second,
},
{
name: "test2",
cache_value: "test2-123",
ttl: 5 * time.Second,
},
}
defer mr.Close()
config = &CacheConfig{
Logger: libpack_logger.New(),
TTL: 5,
for _, tt := range tests {
suite.T().Run(tt.name, func(t *testing.T) {
cache.Set(tt.name, []byte(tt.name), tt.ttl)
c, ok := cache.Get(tt.name)
suite.Equal(true, ok)
suite.Equal(tt.name, string(c))
})
}
config.Redis.DB = 0
config.Redis.URL = mr.Addr()
config.Redis.Enable = true
EnableCache(config)
// Test normal operation
CacheStore("test-key", []byte("test-value"))
retrieved := CacheLookup("test-key")
assert.Equal([]byte("test-value"), retrieved)
// Simulate Redis failure
mr.Close()
// Operations should not panic, but should return errors or nil values
CacheStore("another-key", []byte("another-value"))
retrieved = CacheLookup("another-key")
assert.Nil(retrieved, "Lookup should return nil when Redis is down")
cache.Get("non-existent-non-cached-key")
stats := cache.ShowStats()
suite.Equal(2, stats.CacheHits, "CacheHits")
suite.Equal(1, stats.CacheMisses, "CacheMisses")
suite.Equal(2, stats.CachedQueries, "CachedQueries")
}
-17
View File
@@ -1,17 +0,0 @@
package libpack_cache_memory
import (
"bytes"
"github.com/lukaszraczylo/graphql-monitoring-proxy/pkg/pools"
)
// GetBuffer gets a buffer from the pool (delegates to unified implementation)
func GetBuffer() *bytes.Buffer {
return pools.GetBuffer()
}
// PutBuffer returns a buffer to the pool (delegates to unified implementation)
func PutBuffer(buf *bytes.Buffer) {
pools.PutBuffer(buf)
}
-218
View File
@@ -1,218 +0,0 @@
package libpack_cache_memory
import (
"bytes"
"compress/gzip"
"testing"
"time"
"github.com/stretchr/testify/assert"
)
// TestCompressionThreshold tests that values are only compressed when they exceed the threshold
func TestCompressionThreshold(t *testing.T) {
cache := New(5 * time.Second)
// Create test values
smallValue := make([]byte, CompressionThreshold-100) // Below threshold
largeValue := make([]byte, CompressionThreshold*2) // Above threshold
// Fill values with compressible data (repeating patterns compress well)
for i := 0; i < len(smallValue); i++ {
smallValue[i] = byte(i % 10)
}
for i := 0; i < len(largeValue); i++ {
largeValue[i] = byte(i % 10)
}
// Test small value
cache.Set("small-key", smallValue, 5*time.Second)
// Extract the entry directly from the cache to check if it's compressed
entryRaw, found := cache.entries.Load("small-key")
assert.True(t, found, "Entry should exist")
entry := entryRaw.(CacheEntry)
assert.False(t, entry.Compressed, "Small value should not be compressed")
assert.Equal(t, smallValue, entry.Value, "Small value should be stored as-is")
// Test large value
cache.Set("large-key", largeValue, 5*time.Second)
entryRaw, found = cache.entries.Load("large-key")
assert.True(t, found, "Entry should exist")
entry = entryRaw.(CacheEntry)
assert.True(t, entry.Compressed, "Large value should be compressed")
// Ensure the stored value isn't the original
assert.NotEqual(t, largeValue, entry.Value, "Large value should not be stored as-is")
// Verify the value is actually compressed (should be smaller)
assert.Less(t, len(entry.Value), len(largeValue), "Compressed value should be smaller than original")
// Verify we can retrieve the uncompressed value correctly
retrievedLarge, found := cache.Get("large-key")
assert.True(t, found, "Large value should be retrievable")
assert.Equal(t, largeValue, retrievedLarge, "Retrieved large value should match original")
}
// TestCompressionMemoryUsage tests that memory usage is calculated correctly for compressed entries
func TestCompressionMemoryUsage(t *testing.T) {
cache := New(5 * time.Second)
// Create a large, highly compressible value
valueSize := CompressionThreshold * 4
value := make([]byte, valueSize)
for i := 0; i < valueSize; i++ {
value[i] = byte(i % 2) // Highly compressible pattern (alternating 0s and 1s)
}
// Get initial memory usage
initialMemUsage := cache.GetMemoryUsage()
// Add the value
key := "large-compressible-key"
cache.Set(key, value, 5*time.Second)
// Get memory usage after adding
newMemUsage := cache.GetMemoryUsage()
// The memory usage increase should be less than the full value size due to compression
memUsageIncrease := newMemUsage - initialMemUsage
// Extract the entry to check its compressed size
entryRaw, found := cache.entries.Load(key)
assert.True(t, found, "Entry should exist")
entry := entryRaw.(CacheEntry)
assert.True(t, entry.Compressed, "Value should be compressed")
// Verify the reported memory usage matches the compressed size + overheads
compressedSize := int64(len(entry.Value))
keySize := int64(len(key))
expectedUsage := compressedSize + keySize + approxEntryOverhead
// The memory usage should reflect the compressed size, not the original size
assert.InDelta(t, expectedUsage, memUsageIncrease, float64(approxEntryOverhead),
"Memory usage should be based on compressed size")
// Verify memory usage is correctly updated after deletion
cache.Delete(key)
finalMemUsage := cache.GetMemoryUsage()
assert.Equal(t, initialMemUsage, finalMemUsage,
"Memory usage should return to initial value after deletion")
}
// TestUncompressibleData tests the case where compression doesn't reduce size
func TestUncompressibleData(t *testing.T) {
cache := New(5 * time.Second)
// Create a large, random (less compressible) value
valueSize := CompressionThreshold * 2
// Create pseudo-random data that doesn't compress well
// Using a custom PRNG for deterministic results across test runs
value := make([]byte, valueSize)
seed := uint32(42)
for i := 0; i < valueSize; i++ {
// Simple linear congruential generator
seed = seed*1664525 + 1013904223
value[i] = byte(seed)
}
// Try to compress it directly to see if it actually would reduce size
var buf bytes.Buffer
gw := gzip.NewWriter(&buf)
_, _ = gw.Write(value)
_ = gw.Close()
compressedDirectly := buf.Bytes()
// Now use the cache's Set method
key := "uncompressible-key"
cache.Set(key, value, 5*time.Second)
// Extract the entry to check if it's compressed
entryRaw, found := cache.entries.Load(key)
assert.True(t, found, "Entry should exist")
entry := entryRaw.(CacheEntry)
// If our test data actually compressed to a smaller size, we expect the cache to store it compressed
if len(compressedDirectly) < len(value) {
assert.True(t, entry.Compressed, "Value should be stored compressed if smaller")
assert.Less(t, len(entry.Value), len(value), "Compressed value should be smaller")
} else {
// Uncommon case: our pseudo-random data actually expanded with gzip
// In this case, the cache should store it uncompressed
assert.False(t, entry.Compressed, "Value should not be compressed if it would expand")
assert.Equal(t, value, entry.Value, "Value should be stored as-is")
}
// Regardless, we should be able to get the correct value back
retrievedValue, found := cache.Get(key)
assert.True(t, found, "Value should be retrievable")
assert.Equal(t, value, retrievedValue, "Retrieved value should match original")
}
// TestCompressDecompressDirectly tests the compress and decompress methods directly
func TestCompressDecompressDirectly(t *testing.T) {
cache := New(5 * time.Second)
// Test with various sizes
testSizes := []int{
100, // Small
CompressionThreshold - 1, // Just below threshold
CompressionThreshold, // At threshold
CompressionThreshold + 1, // Just above threshold
CompressionThreshold * 2, // Well above threshold
}
for _, size := range testSizes {
t.Run("Size-"+string(rune('A'+len(testSizes)%26)), func(t *testing.T) {
// Generate test data with a repeating pattern
data := make([]byte, size)
for i := 0; i < size; i++ {
data[i] = byte(i % 256)
}
// Compress the data
compressed, err := cache.compress(data)
assert.NoError(t, err, "Compression should not error")
// Small data may get larger when compressed, larger data should get smaller
if size > CompressionThreshold {
assert.Less(t, len(compressed), len(data),
"Compression should reduce size for data above threshold")
}
// Decompress and verify it matches the original
decompressed, err := cache.decompress(compressed)
assert.NoError(t, err, "Decompression should not error")
assert.Equal(t, data, decompressed, "Data should round-trip correctly through compression")
})
}
}
// TestDecompressInvalidData tests handling invalid data in decompress
func TestDecompressInvalidData(t *testing.T) {
cache := New(5 * time.Second)
// Try to decompress non-gzip data
invalidData := []byte("This is not valid gzip data")
_, err := cache.decompress(invalidData)
assert.Error(t, err, "Decompressing invalid data should return error")
// Set compressed flag but store invalid data
key := "invalid-compressed-key"
cache.entries.Store(key, CacheEntry{
Value: invalidData,
ExpiresAt: time.Now().Add(5 * time.Second),
Compressed: true, // Flag as compressed even though it's not
MemorySize: int64(len(invalidData) + len(key) + approxEntryOverhead),
})
// Try to get it - should fail gracefully
_, found := cache.Get(key)
assert.False(t, found, "Get should fail gracefully for invalid compressed data")
}
-314
View File
@@ -1,314 +0,0 @@
package libpack_cache_memory
import (
"fmt"
"sync"
"testing"
"time"
"github.com/stretchr/testify/assert"
)
// TestEvictToFreeMemory tests that the cache correctly evicts
// items when it exceeds its memory limit.
func TestEvictToFreeMemory(t *testing.T) {
// Create a cache with a small memory limit: 5KB (ensure eviction happens)
smallMemLimit := int64(5 * 1024)
cache := NewWithSize(5*time.Second, smallMemLimit, 1000)
// Create entries with known sizes
// Each entry will be ~512 bytes plus overhead
valueSize := 512
numEntriesToExceedLimit := 12 // Should exceed the 5KB limit and force eviction
// Create a slice to track keys in insertion order
keys := make([]string, numEntriesToExceedLimit)
// Add entries with significant delays between insertions
for i := 0; i < numEntriesToExceedLimit; i++ {
key := fmt.Sprintf("test-key-%d", i)
keys[i] = key
value := make([]byte, valueSize)
for j := 0; j < valueSize; j++ {
value[j] = byte(i % 256) // Fill with a repeating pattern
}
cache.Set(key, value, 30*time.Second)
// More significant delay to ensure different timestamps
time.Sleep(10 * time.Millisecond)
}
// Allow time for eviction to complete
time.Sleep(50 * time.Millisecond)
// Verify memory usage is below the limit
memUsage := cache.GetMemoryUsage()
assert.LessOrEqual(t, memUsage, smallMemLimit,
"Memory usage (%d) should be less than or equal to the limit (%d)", memUsage, smallMemLimit)
// Count how many items are left in the cache and which ones
present := 0
for i := 0; i < numEntriesToExceedLimit; i++ {
_, found := cache.Get(keys[i])
if found {
present++
}
}
// We expect some items to be evicted based on the memory limit
assert.Less(t, present, numEntriesToExceedLimit,
"Some items should have been evicted (%d present out of %d total)",
present, numEntriesToExceedLimit)
// Verify newer items (inserted later) are more likely to be in the cache
// Check the last few items which should be the newest
for i := numEntriesToExceedLimit - 3; i < numEntriesToExceedLimit; i++ {
_, found := cache.Get(keys[i])
assert.True(t, found, "Newer key %s should still exist", keys[i])
}
}
// TestMaxCacheSize verifies the behavior when adding more items than the maxCacheSize limit
func TestMaxCacheSize(t *testing.T) {
// Create a cache with a small limit
smallLimit := int64(5)
cache := NewWithSize(5*time.Second, DefaultMaxMemorySize, smallLimit)
// Add entries with increasing size (to avoid memory-based eviction)
for i := 0; i < 20; i++ {
key := fmt.Sprintf("test-key-%d", i)
value := []byte(key)
cache.Set(key, value, 10*time.Second)
}
// Verify we can get a reasonable number of items
// (we don't test for exact count as implementation may vary)
foundCount := 0
for i := 0; i < 20; i++ {
key := fmt.Sprintf("test-key-%d", i)
_, found := cache.Get(key)
if found {
foundCount++
}
}
// We should find some items but not all 20
assert.Greater(t, foundCount, 0, "Some items should be in the cache")
assert.LessOrEqual(t, foundCount, 20, "Not all items should be in the cache with small limit")
}
// TestGetMemoryUsage verifies that memory usage tracking is accurate
func TestGetMemoryUsage(t *testing.T) {
cache := New(5 * time.Second)
// Initially memory usage should be 0
assert.Equal(t, int64(0), cache.GetMemoryUsage(), "Initial memory usage should be 0")
// Add an entry with a known approximate size
valueSize := 1024
value := make([]byte, valueSize)
key := "test-key"
cache.Set(key, value, 5*time.Second)
// Check memory usage - should be approximately valueSize + key length + overhead
expectedMinUsage := int64(valueSize + len(key))
memUsage := cache.GetMemoryUsage()
assert.GreaterOrEqual(t, memUsage, expectedMinUsage,
"Memory usage (%d) should be at least the value size plus key length (%d)", memUsage, expectedMinUsage)
// Delete the entry and verify memory usage decreases
cache.Delete(key)
assert.Equal(t, int64(0), cache.GetMemoryUsage(), "Memory usage should be 0 after deletion")
}
// TestSetMaxMemorySize tests changing the memory limit and resulting eviction
func TestSetMaxMemorySize(t *testing.T) {
// Start with a large limit
initialLimit := int64(100 * 1024)
cache := NewWithSize(5*time.Second, initialLimit, 1000)
// Fill the cache with ~50KB of data
valueSize := 1024
numEntries := 50
for i := 0; i < numEntries; i++ {
key := generateKey(i)
value := make([]byte, valueSize)
cache.Set(key, value, 5*time.Second)
// Small delay for timestamp differences
time.Sleep(time.Millisecond)
}
// Verify all entries exist
for i := 0; i < numEntries; i++ {
_, found := cache.Get(generateKey(i))
assert.True(t, found, "All entries should exist before limit change")
}
// Get current memory usage
originalUsage := cache.GetMemoryUsage()
// Now reduce the limit to 20KB - should trigger eviction
newLimit := int64(20 * 1024)
cache.SetMaxMemorySize(newLimit)
// Verify memory usage is now below the new limit
newUsage := cache.GetMemoryUsage()
assert.LessOrEqual(t, newUsage, newLimit,
"After SetMaxMemorySize, memory usage (%d) should be less than or equal to new limit (%d)",
newUsage, newLimit)
assert.Less(t, newUsage, originalUsage,
"Memory usage should have decreased after lowering the limit")
// Some older entries should be gone, newer ones should still exist
removedCount := 0
remainingCount := 0
for i := 0; i < numEntries; i++ {
_, found := cache.Get(generateKey(i))
if found {
remainingCount++
} else {
removedCount++
}
}
assert.Greater(t, removedCount, 0, "Some entries should have been removed")
assert.Greater(t, remainingCount, 0, "Some entries should still exist")
}
// Helper function to generate consistent keys
func generateKey(index int) string {
return "test-key-" + fmt.Sprintf("%d", index)
}
// TestEvictToFreeMemoryWithSmallMaxEntriesReachesTarget is a regression for
// under-eviction: evictToFreeMemory used to cap its candidate set at
// maxCacheSize/5 and stop at the end of that subset. With a small
// maxCacheSize the cap (maxCacheSize/5) could be lower than the number of
// entries needed to satisfy bytesToFree, so the cache stayed over its
// memory limit.
func TestEvictToFreeMemoryWithSmallMaxEntriesReachesTarget(t *testing.T) {
// maxCacheSize=10 -> old candidate cap was maxCacheSize/5 = 2 entries.
cache := NewWithSize(5*time.Second, DefaultMaxMemorySize, 10)
val := make([]byte, 1024) // ~1KB + overhead each
const count = 8
for i := 0; i < count; i++ {
cache.Set(fmt.Sprintf("e%d", i), val, time.Second)
}
before := cache.GetMemoryUsage()
// Request freeing an amount equal to ~half the entries (well beyond the
// old 2-entry cap).
need := (count / 2) * (int64(len(val)) + approxEntryOverhead)
cache.evictToFreeMemory(need)
after := cache.GetMemoryUsage()
assert.LessOrEqual(t, after, before-need,
"evictToFreeMemory must free at least the requested bytes even across more than maxCacheSize/5 entries")
// Requesting more than the total must drain the cache.
cache.evictToFreeMemory(1 << 30)
assert.Equal(t, int64(0), cache.GetMemoryUsage(),
"an oversized request should evict every entry")
}
// TestEvictOldest_EvictsCorrectOldestEntries is a determinism regression for
// P2: evictOldest used to selection-sort only a capped subset (n*2) of
// sync.Map's unordered Range, which could miss the true oldest entries
// entirely and evict the wrong ones. This verifies it evicts exactly the n
// entries with the earliest ExpiresAt, matching evictToFreeMemory's
// collect-all-then-sort.Slice approach.
func TestEvictOldest_EvictsCorrectOldestEntries(t *testing.T) {
cache := NewWithSize(5*time.Second, DefaultMaxMemorySize, DefaultMaxCacheSize)
const total = 50
keys := make([]string, total)
for i := 0; i < total; i++ {
key := fmt.Sprintf("key-%03d", i)
keys[i] = key
// Distinct, strictly increasing TTLs give distinct, strictly
// increasing ExpiresAt without depending on wall-clock sleeps between
// insertions.
cache.Set(key, []byte("v"), time.Duration(i+1)*time.Minute)
}
assert.Equal(t, int64(total), cache.CountQueries())
const evictCount = 20
cache.evictOldest(evictCount)
assert.Equal(t, int64(total-evictCount), cache.CountQueries())
// The evictCount entries with the smallest ExpiresAt (keys[0:evictCount])
// must be gone; the remaining, longer-lived entries must all survive.
for i := 0; i < evictCount; i++ {
_, found := cache.Get(keys[i])
assert.False(t, found, "oldest key %s should have been evicted", keys[i])
}
for i := evictCount; i < total; i++ {
_, found := cache.Get(keys[i])
assert.True(t, found, "newer key %s should survive eviction", keys[i])
}
}
// TestEvictOldest_MoreThanAvailable_EvictsAllWithoutPanic verifies evictOldest
// clamps n to the number of live entries instead of indexing past the sorted
// slice.
func TestEvictOldest_MoreThanAvailable_EvictsAllWithoutPanic(t *testing.T) {
cache := NewWithSize(5*time.Second, DefaultMaxMemorySize, DefaultMaxCacheSize)
for i := 0; i < 5; i++ {
cache.Set(fmt.Sprintf("k%d", i), []byte("v"), time.Minute)
}
cache.evictOldest(1000)
assert.Equal(t, int64(0), cache.CountQueries())
assert.Equal(t, int64(0), cache.GetMemoryUsage())
}
// TestEvictOldest_ConcurrentHammer_StaysConsistent drives Set/Get/Delete from
// many goroutines against a small maxCacheSize, which forces the count-based
// eviction path (evictOldest) to run repeatedly and concurrently. Run with
// -race: the entryCount/memoryUsage counters must stay lock-free-consistent
// (never negative, always matching the live map) throughout.
func TestEvictOldest_ConcurrentHammer_StaysConsistent(t *testing.T) {
const maxEntries = 50
cache := NewWithSize(5*time.Second, DefaultMaxMemorySize, maxEntries)
const goroutines = 16
const opsPerGoroutine = 200
var wg sync.WaitGroup
wg.Add(goroutines)
for g := 0; g < goroutines; g++ {
go func(g int) {
defer wg.Done()
for i := 0; i < opsPerGoroutine; i++ {
key := fmt.Sprintf("g%d-k%d", g, i%20)
cache.Set(key, []byte("v"), time.Duration(i%10+1)*time.Second)
cache.Get(key)
if i%7 == 0 {
cache.Delete(key)
}
}
}(g)
}
wg.Wait()
// Counters must never go negative.
assert.GreaterOrEqual(t, cache.CountQueries(), int64(0))
assert.GreaterOrEqual(t, cache.GetMemoryUsage(), int64(0))
// Counters must match the live map contents exactly.
var actualCount, actualMemory int64
cache.entries.Range(func(_, v any) bool {
actualCount++
actualMemory += v.(CacheEntry).MemorySize
return true
})
assert.Equal(t, actualCount, cache.CountQueries(),
"entryCount must match the number of live entries after concurrent Set/evictOldest")
assert.Equal(t, actualMemory, cache.GetMemoryUsage(),
"memoryUsage must match the sum of live entries' MemorySize after concurrent Set/evictOldest")
}
-309
View File
@@ -1,309 +0,0 @@
package libpack_cache_memory
import (
"compress/gzip"
"container/list"
"sync"
"sync/atomic"
"time"
)
// LRUMemoryCache is an efficient LRU-based memory cache implementation
type LRUMemoryCache struct {
entries map[string]*lruEntry
evictList *list.List
gzipWriterPool *sync.Pool
gzipReaderPool *sync.Pool
maxMemorySize int64
maxEntries int64
currentMemory int64
currentCount int64
mu sync.RWMutex
}
type lruEntry struct {
expiresAt time.Time
element *list.Element
key string
value []byte
size int64
compressed bool
}
// NewLRUMemoryCache creates a new LRU memory cache
func NewLRUMemoryCache(maxMemorySize, maxEntries int64) *LRUMemoryCache {
return &LRUMemoryCache{
maxMemorySize: maxMemorySize,
maxEntries: maxEntries,
entries: make(map[string]*lruEntry),
evictList: list.New(),
gzipWriterPool: &sync.Pool{
New: func() any {
return gzip.NewWriter(nil)
},
},
gzipReaderPool: &sync.Pool{
New: func() any {
return &gzip.Reader{}
},
},
}
}
// Set adds or updates an entry in the cache
func (c *LRUMemoryCache) Set(key string, value []byte, ttl time.Duration) {
// Compress OUTSIDE the lock — gzip is CPU-bound and pool ops are
// goroutine-safe. Result is just a byte slice, safe to hand to the
// critical section below.
compressed := false
finalValue := value
if len(value) > 1024 { // Compress if larger than 1KB
if compressedData, err := c.compress(value); err == nil && len(compressedData) < len(value) {
compressed = true
finalValue = compressedData
}
}
entrySize := int64(len(key) + len(finalValue) + 64) // 64 bytes overhead estimate
// A non-positive TTL is clamped to defaultTTL (defined in memory.go) so
// this backend does not stamp the entry as already-expired (immediate
// miss on every read). Keeps behavior identical to the standard memory
// backend and Redis, which clamp the same way at their own Set boundary.
if ttl <= 0 {
ttl = defaultTTL
}
expiresAt := time.Now().Add(ttl)
c.mu.Lock()
defer c.mu.Unlock()
// Check if key exists
if existing, exists := c.entries[key]; exists {
// Update existing entry
c.evictList.MoveToFront(existing.element)
atomic.AddInt64(&c.currentMemory, -existing.size)
atomic.AddInt64(&c.currentMemory, entrySize)
existing.value = finalValue
existing.compressed = compressed
existing.size = entrySize
existing.expiresAt = expiresAt
c.evictIfNeeded()
return
}
// Create new entry
entry := &lruEntry{
key: key,
value: finalValue,
compressed: compressed,
size: entrySize,
expiresAt: expiresAt,
}
element := c.evictList.PushFront(entry)
entry.element = element
c.entries[key] = entry
atomic.AddInt64(&c.currentMemory, entrySize)
atomic.AddInt64(&c.currentCount, 1)
c.evictIfNeeded()
}
// Get retrieves a value from the cache
func (c *LRUMemoryCache) Get(key string) ([]byte, bool) {
// Snapshot the stored bytes under the lock, then release before
// decompressing — gzip is CPU-bound and must not serialise other ops.
c.mu.Lock()
entry, exists := c.entries[key]
if !exists {
c.mu.Unlock()
return nil, false
}
// Check if expired (must use the entry's stored expiry while locked)
if time.Now().After(entry.expiresAt) {
c.removeEntry(entry)
c.mu.Unlock()
return nil, false
}
// Move to front (most recently used)
c.evictList.MoveToFront(entry.element)
if !entry.compressed {
// Uncompressed payload is immutable once stored, safe to return directly.
value := entry.value
c.mu.Unlock()
return value, true
}
// Snapshot compressed bytes locally, drop lock, then decompress.
compressedBytes := entry.value
c.mu.Unlock()
decompressed, err := c.decompress(compressedBytes)
if err == nil {
return decompressed, true
}
// Decompression failed — re-acquire lock to remove the bad entry,
// but only if it still exists and still points at the same payload.
c.mu.Lock()
if cur, ok := c.entries[key]; ok && cur == entry {
c.removeEntry(cur)
}
c.mu.Unlock()
return nil, false
}
// Delete removes an entry from the cache
func (c *LRUMemoryCache) Delete(key string) {
c.mu.Lock()
defer c.mu.Unlock()
if entry, exists := c.entries[key]; exists {
c.removeEntry(entry)
}
}
// Clear removes all entries
func (c *LRUMemoryCache) Clear() {
c.mu.Lock()
defer c.mu.Unlock()
c.entries = make(map[string]*lruEntry)
c.evictList = list.New()
atomic.StoreInt64(&c.currentMemory, 0)
atomic.StoreInt64(&c.currentCount, 0)
}
// evictIfNeeded removes entries when limits are exceeded
func (c *LRUMemoryCache) evictIfNeeded() {
// Evict based on entry count
for atomic.LoadInt64(&c.currentCount) > c.maxEntries && c.evictList.Len() > 0 {
c.evictOldest()
}
// Evict based on memory
for atomic.LoadInt64(&c.currentMemory) > c.maxMemorySize && c.evictList.Len() > 0 {
c.evictOldest()
}
}
// evictOldest removes the least recently used entry
func (c *LRUMemoryCache) evictOldest() {
element := c.evictList.Back()
if element == nil {
return
}
entry := element.Value.(*lruEntry)
c.removeEntry(entry)
}
// removeEntry removes an entry from all data structures
func (c *LRUMemoryCache) removeEntry(entry *lruEntry) {
c.evictList.Remove(entry.element)
delete(c.entries, entry.key)
atomic.AddInt64(&c.currentMemory, -entry.size)
atomic.AddInt64(&c.currentCount, -1)
}
// CleanExpiredEntries removes all expired entries
func (c *LRUMemoryCache) CleanExpiredEntries() {
c.mu.Lock()
defer c.mu.Unlock()
now := time.Now()
for element := c.evictList.Back(); element != nil; {
entry := element.Value.(*lruEntry)
if now.After(entry.expiresAt) {
next := element.Prev()
c.removeEntry(entry)
element = next
} else {
element = element.Prev()
}
}
}
// compress compresses data using gzip
func (c *LRUMemoryCache) compress(data []byte) ([]byte, error) {
buf := GetBuffer()
defer PutBuffer(buf)
gz := c.gzipWriterPool.Get().(*gzip.Writer)
gz.Reset(buf)
defer c.gzipWriterPool.Put(gz)
if _, err := gz.Write(data); err != nil {
return nil, err
}
if err := gz.Close(); err != nil {
return nil, err
}
compressed := make([]byte, buf.Len())
copy(compressed, buf.Bytes())
return compressed, nil
}
// decompress decompresses gzip data
func (c *LRUMemoryCache) decompress(data []byte) ([]byte, error) {
buf := GetBuffer()
defer PutBuffer(buf)
buf.Write(data)
gr := c.gzipReaderPool.Get().(*gzip.Reader)
defer c.gzipReaderPool.Put(gr)
if err := gr.Reset(buf); err != nil {
return nil, err
}
result := GetBuffer()
defer PutBuffer(result)
if _, err := result.ReadFrom(gr); err != nil {
return nil, err
}
decompressed := make([]byte, result.Len())
copy(decompressed, result.Bytes())
return decompressed, nil
}
// GetStats returns cache statistics
func (c *LRUMemoryCache) GetStats() map[string]any {
c.mu.RLock()
defer c.mu.RUnlock()
return map[string]any{
"entries": atomic.LoadInt64(&c.currentCount),
"memory_bytes": atomic.LoadInt64(&c.currentMemory),
"max_entries": c.maxEntries,
"max_memory": c.maxMemorySize,
"fill_percent": float64(atomic.LoadInt64(&c.currentMemory)) / float64(c.maxMemorySize) * 100,
}
}
// GetMemoryUsage returns current memory usage in bytes
func (c *LRUMemoryCache) GetMemoryUsage() int64 {
return atomic.LoadInt64(&c.currentMemory)
}
// GetMaxMemorySize returns the maximum memory size
func (c *LRUMemoryCache) GetMaxMemorySize() int64 {
return c.maxMemorySize
}
// CountQueries returns the number of entries in the cache
func (c *LRUMemoryCache) CountQueries() int64 {
return atomic.LoadInt64(&c.currentCount)
}
-369
View File
@@ -1,369 +0,0 @@
package libpack_cache_memory
import (
"fmt"
"sync"
"testing"
"time"
"github.com/stretchr/testify/suite"
)
type LRUMemoryCacheTestSuite struct {
suite.Suite
}
func TestLRUMemoryCacheTestSuite(t *testing.T) {
suite.Run(t, new(LRUMemoryCacheTestSuite))
}
func (suite *LRUMemoryCacheTestSuite) TestNewLRUMemoryCache() {
cache := NewLRUMemoryCache(1024*1024, 100) // 1MB, 100 entries
suite.NotNil(cache)
suite.Equal(int64(0), cache.CountQueries())
suite.Equal(int64(0), cache.GetMemoryUsage())
suite.Equal(int64(1024*1024), cache.GetMaxMemorySize())
}
func (suite *LRUMemoryCacheTestSuite) TestSetAndGet() {
cache := NewLRUMemoryCache(1024*1024, 100)
// Set a value
cache.Set("key1", []byte("value1"), 5*time.Second)
// Get the value
val, found := cache.Get("key1")
suite.True(found)
suite.Equal([]byte("value1"), val)
// Get non-existent key
val, found = cache.Get("nonexistent")
suite.False(found)
suite.Nil(val)
}
func (suite *LRUMemoryCacheTestSuite) TestUpdateExisting() {
cache := NewLRUMemoryCache(1024*1024, 100)
cache.Set("key1", []byte("value1"), 5*time.Second)
cache.Set("key1", []byte("value2"), 5*time.Second)
val, found := cache.Get("key1")
suite.True(found)
suite.Equal([]byte("value2"), val)
suite.Equal(int64(1), cache.CountQueries())
}
func (suite *LRUMemoryCacheTestSuite) TestDelete() {
cache := NewLRUMemoryCache(1024*1024, 100)
cache.Set("key1", []byte("value1"), 5*time.Second)
suite.Equal(int64(1), cache.CountQueries())
cache.Delete("key1")
suite.Equal(int64(0), cache.CountQueries())
val, found := cache.Get("key1")
suite.False(found)
suite.Nil(val)
// Delete non-existent key should not panic
cache.Delete("nonexistent")
}
func (suite *LRUMemoryCacheTestSuite) TestClear() {
cache := NewLRUMemoryCache(1024*1024, 100)
cache.Set("key1", []byte("value1"), 5*time.Second)
cache.Set("key2", []byte("value2"), 5*time.Second)
cache.Set("key3", []byte("value3"), 5*time.Second)
suite.Equal(int64(3), cache.CountQueries())
cache.Clear()
suite.Equal(int64(0), cache.CountQueries())
suite.Equal(int64(0), cache.GetMemoryUsage())
_, found := cache.Get("key1")
suite.False(found)
}
func (suite *LRUMemoryCacheTestSuite) TestExpiration() {
cache := NewLRUMemoryCache(1024*1024, 100)
cache.Set("key1", []byte("value1"), 100*time.Millisecond)
// Should exist immediately
val, found := cache.Get("key1")
suite.True(found)
suite.Equal([]byte("value1"), val)
// Wait for expiration
time.Sleep(150 * time.Millisecond)
// Should be expired
val, found = cache.Get("key1")
suite.False(found)
suite.Nil(val)
}
// TestNonPositiveTTL_ClampedToDefaultTTL verifies the C11 cross-backend
// rule: a non-positive TTL is clamped to defaultTTL instead of stamping the
// entry as already-expired (which used to make every read miss
// immediately, unlike the Redis backend which used to keep the entry
// forever).
func (suite *LRUMemoryCacheTestSuite) TestNonPositiveTTL_ClampedToDefaultTTL() {
cache := NewLRUMemoryCache(1024*1024, 100)
cache.Set("zero-ttl", []byte("value"), 0)
val, found := cache.Get("zero-ttl")
suite.True(found, "zero TTL should be clamped to defaultTTL, not stored as already-expired")
suite.Equal([]byte("value"), val)
cache.Set("negative-ttl", []byte("value"), -1*time.Second)
val, found = cache.Get("negative-ttl")
suite.True(found, "negative TTL should be clamped to defaultTTL, not stored as already-expired")
suite.Equal([]byte("value"), val)
cache.mu.RLock()
entry, ok := cache.entries["zero-ttl"]
cache.mu.RUnlock()
suite.Require().True(ok)
suite.WithinDuration(time.Now().Add(defaultTTL), entry.expiresAt, 2*time.Second,
"clamped entry should expire ~defaultTTL from now")
}
func (suite *LRUMemoryCacheTestSuite) TestEvictionByCount() {
cache := NewLRUMemoryCache(1024*1024, 3) // Max 3 entries
cache.Set("key1", []byte("value1"), 5*time.Second)
cache.Set("key2", []byte("value2"), 5*time.Second)
cache.Set("key3", []byte("value3"), 5*time.Second)
// All 3 should exist
_, found := cache.Get("key1")
suite.True(found)
_, found = cache.Get("key2")
suite.True(found)
_, found = cache.Get("key3")
suite.True(found)
// Add 4th entry - should evict oldest (key1)
cache.Set("key4", []byte("value4"), 5*time.Second)
suite.Equal(int64(3), cache.CountQueries())
// key1 should be evicted (it was least recently used)
_, found = cache.Get("key1")
suite.False(found)
// Others should still exist
_, found = cache.Get("key2")
suite.True(found)
_, found = cache.Get("key3")
suite.True(found)
_, found = cache.Get("key4")
suite.True(found)
}
func (suite *LRUMemoryCacheTestSuite) TestLRUOrder() {
cache := NewLRUMemoryCache(1024*1024, 3) // Max 3 entries
cache.Set("key1", []byte("value1"), 5*time.Second)
cache.Set("key2", []byte("value2"), 5*time.Second)
cache.Set("key3", []byte("value3"), 5*time.Second)
// Access key1 to make it recently used
cache.Get("key1")
// Add key4 - should evict key2 (now least recently used)
cache.Set("key4", []byte("value4"), 5*time.Second)
// key2 should be evicted
_, found := cache.Get("key2")
suite.False(found)
// key1 should still exist (was accessed recently)
_, found = cache.Get("key1")
suite.True(found)
}
func (suite *LRUMemoryCacheTestSuite) TestEvictionByMemory() {
// Small memory limit - 500 bytes
cache := NewLRUMemoryCache(500, 100)
// Each entry has ~64 bytes overhead + key + value
cache.Set("key1", []byte("value1"), 5*time.Second)
cache.Set("key2", []byte("value2"), 5*time.Second)
cache.Set("key3", []byte("value3"), 5*time.Second)
// Add large entry that should trigger eviction
largeValue := make([]byte, 200)
cache.Set("large", largeValue, 5*time.Second)
// Memory should be under limit
suite.LessOrEqual(cache.GetMemoryUsage(), int64(500))
}
func (suite *LRUMemoryCacheTestSuite) TestCompression() {
cache := NewLRUMemoryCache(1024*1024, 100)
// Create a compressible value (> 1KB to trigger compression)
largeValue := make([]byte, 2048)
for i := range largeValue {
largeValue[i] = 'A' // Highly compressible
}
cache.Set("compressed", largeValue, 5*time.Second)
// Should be able to retrieve it correctly
val, found := cache.Get("compressed")
suite.True(found)
suite.Equal(largeValue, val)
}
func (suite *LRUMemoryCacheTestSuite) TestGetStats() {
cache := NewLRUMemoryCache(1024*1024, 100)
cache.Set("key1", []byte("value1"), 5*time.Second)
cache.Set("key2", []byte("value2"), 5*time.Second)
stats := cache.GetStats()
suite.Equal(int64(2), stats["entries"])
suite.Equal(int64(1024*1024), stats["max_memory"])
suite.Equal(int64(100), stats["max_entries"])
suite.NotNil(stats["memory_bytes"])
suite.NotNil(stats["fill_percent"])
}
func (suite *LRUMemoryCacheTestSuite) TestConcurrentAccess() {
cache := NewLRUMemoryCache(10*1024*1024, 1000)
const numGoroutines = 50
const numOperations = 500
var wg sync.WaitGroup
wg.Add(numGoroutines * 3) // readers, writers, deleters
// Writers
for i := 0; i < numGoroutines; i++ {
go func(id int) {
defer wg.Done()
for j := 0; j < numOperations; j++ {
key := fmt.Sprintf("key-%d-%d", id, j)
value := []byte(fmt.Sprintf("value-%d-%d", id, j))
cache.Set(key, value, 5*time.Second)
}
}(i)
}
// Readers
for i := 0; i < numGoroutines; i++ {
go func(id int) {
defer wg.Done()
for j := 0; j < numOperations; j++ {
key := fmt.Sprintf("key-%d-%d", id, j)
cache.Get(key)
}
}(i)
}
// Deleters
for i := 0; i < numGoroutines; i++ {
go func(id int) {
defer wg.Done()
for j := 0; j < numOperations; j++ {
key := fmt.Sprintf("key-%d-%d", id, j%100)
cache.Delete(key)
}
}(i)
}
wg.Wait()
}
func (suite *LRUMemoryCacheTestSuite) TestCleanExpiredEntries() {
cache := NewLRUMemoryCache(1024*1024, 100)
cache.Set("expire1", []byte("value1"), 50*time.Millisecond)
cache.Set("expire2", []byte("value2"), 50*time.Millisecond)
cache.Set("keep", []byte("value3"), 5*time.Second)
suite.Equal(int64(3), cache.CountQueries())
// Wait for some to expire
time.Sleep(100 * time.Millisecond)
// Clean expired entries
cache.CleanExpiredEntries()
// Only "keep" should remain
suite.Equal(int64(1), cache.CountQueries())
_, found := cache.Get("keep")
suite.True(found)
}
func (suite *LRUMemoryCacheTestSuite) TestCountQueries() {
cache := NewLRUMemoryCache(1024*1024, 100)
suite.Equal(int64(0), cache.CountQueries())
cache.Set("key1", []byte("value1"), 5*time.Second)
suite.Equal(int64(1), cache.CountQueries())
cache.Set("key2", []byte("value2"), 5*time.Second)
suite.Equal(int64(2), cache.CountQueries())
cache.Delete("key1")
suite.Equal(int64(1), cache.CountQueries())
cache.Clear()
suite.Equal(int64(0), cache.CountQueries())
}
// Benchmarks
func BenchmarkLRUMemoryCacheSet(b *testing.B) {
cache := NewLRUMemoryCache(100*1024*1024, 100000)
value := []byte("benchmark-value")
b.ResetTimer()
for i := 0; i < b.N; i++ {
key := fmt.Sprintf("key-%d", i)
cache.Set(key, value, 5*time.Second)
}
}
func BenchmarkLRUMemoryCacheGet(b *testing.B) {
cache := NewLRUMemoryCache(100*1024*1024, 100000)
value := []byte("benchmark-value")
// Pre-populate
for i := 0; i < 10000; i++ {
key := fmt.Sprintf("key-%d", i)
cache.Set(key, value, 5*time.Minute)
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
key := fmt.Sprintf("key-%d", i%10000)
cache.Get(key)
}
}
func BenchmarkLRUMemoryCacheConcurrent(b *testing.B) {
cache := NewLRUMemoryCache(100*1024*1024, 100000)
value := []byte("benchmark-value")
b.RunParallel(func(pb *testing.PB) {
i := 0
for pb.Next() {
key := fmt.Sprintf("key-%d", i)
if i%2 == 0 {
cache.Set(key, value, 5*time.Second)
} else {
cache.Get(key)
}
i++
}
})
}
-470
View File
@@ -1,470 +0,0 @@
// Package libpack_cache_memory provides an in-memory LRU cache implementation
// with automatic compression for large values, memory limits, and background
// eviction of expired entries.
package libpack_cache_memory
import (
"bytes"
"compress/gzip"
"context"
"io"
"sort"
"sync"
"sync/atomic"
"time"
)
// CompressionThreshold is the minimum size in bytes before a value is compressed
const CompressionThreshold = 1024 // 1KB
// DefaultMaxMemorySize is the default maximum memory size in bytes (100MB)
const DefaultMaxMemorySize = 100 * 1024 * 1024
// DefaultMaxCacheSize is the default maximum number of entries in the cache
// This is used for backward compatibility
const DefaultMaxCacheSize = 10000
// approxEntryOverhead is the estimated overhead per cache entry in bytes
// This accounts for the CacheEntry struct overhead, map entry, and synchronization
const approxEntryOverhead = 64
// defaultTTL is the sane fallback applied whenever a configured or per-entry
// TTL is non-positive (<=0).
//
// It serves two purposes:
// 1. Sizing the background cleanup ticker (cleanupRoutine): time.NewTicker
// panics for a non-positive duration, so a non-positive globalTTL is
// replaced with defaultTTL before the ticker is created.
// 2. Clamping a non-positive per-entry TTL passed to Set: time.Now().Add(ttl)
// with ttl<=0 stamps an entry as already expired, so every read would
// miss immediately.
//
// Cross-backend TTL rule (see also cache/memory/lru_memory_cache.go and
// cache/redis/redis.go, which each define and apply their own equivalent
// constant at their Set boundary): a non-positive TTL is always clamped to
// defaultTTL before being applied, for every backend. This keeps behavior
// identical regardless of backend. Without this rule, the three backends
// diverge: go-redis treats expiration<=0 as "no EX/PX option", i.e. the key
// never expires, the LRU backend stamps the entry as already expired so every
// read misses, and the standard (this) backend would otherwise panic in
// time.NewTicker. None of those are acceptable, so all three backends clamp
// to the same bounded default instead.
const defaultTTL = 60 * time.Second
type CacheEntry struct {
ExpiresAt time.Time
Value []byte
Compressed bool
MemorySize int64 // Estimated memory usage of this entry in bytes
}
type Cache struct {
compressPool sync.Pool
decompressPool sync.Pool
ctx context.Context
cancel context.CancelFunc
entries sync.Map
globalTTL time.Duration
entryCount int64
memoryUsage int64
maxMemorySize int64
maxCacheSize int64
}
func New(globalTTL time.Duration) *Cache {
return NewWithSize(globalTTL, DefaultMaxMemorySize, DefaultMaxCacheSize)
}
// NewWithSize creates a new cache with the specified memory size limit and entry count limit
func NewWithSize(globalTTL time.Duration, maxMemorySize int64, maxCacheSize int64) *Cache {
// Create context for graceful shutdown
ctx, cancel := context.WithCancel(context.Background())
cache := &Cache{
globalTTL: globalTTL,
maxMemorySize: maxMemorySize,
maxCacheSize: maxCacheSize,
ctx: ctx,
cancel: cancel,
compressPool: sync.Pool{
New: func() any {
return gzip.NewWriter(nil)
},
},
decompressPool: sync.Pool{
New: func() any {
r, _ := gzip.NewReader(bytes.NewReader([]byte{}))
return r
},
},
}
// Start cleanup routine with context cancellation
go cache.cleanupRoutine(globalTTL)
return cache
}
func (c *Cache) cleanupRoutine(globalTTL time.Duration) {
// time.NewTicker panics for a non-positive duration. A non-positive
// globalTTL (e.g. a misconfigured CACHE_TTL<=0) must not crash the
// process, so fall back to defaultTTL before deriving the interval.
if globalTTL <= 0 {
globalTTL = defaultTTL
}
// Clean up more frequently when the cache is large
ticker := time.NewTicker(globalTTL / 4)
defer ticker.Stop()
for {
select {
case <-c.ctx.Done():
// Context cancelled, exit gracefully
return
case <-ticker.C:
c.CleanExpiredEntries()
// Note: Removed aggressive GC trigger that was causing performance issues
// The Go runtime GC is already optimized and will run when needed
}
}
}
// Shutdown gracefully stops the cache cleanup routine
func (c *Cache) Shutdown() {
if c.cancel != nil {
c.cancel()
}
}
// Close implements io.Closer so the cache layer (cache.Shutdown) can stop the
// cleanup goroutine for the in-memory backend, matching the Redis backend
// which closes its connection pool. Idempotent: cancelling the context does
// not render the cache unusable, it only stops the background cleaner.
func (c *Cache) Close() error {
c.Shutdown()
return nil
}
func (c *Cache) Set(key string, value []byte, ttl time.Duration) {
// Calculate the memory size of this entry
entrySize := int64(len(key) + len(value) + approxEntryOverhead)
// Check if we need to evict entries based on memory or count limits
currentMemory := atomic.LoadInt64(&c.memoryUsage)
if currentMemory+entrySize > c.maxMemorySize {
// Need to evict based on memory
memoryToFree := (currentMemory + entrySize) - c.maxMemorySize + (c.maxMemorySize / 10)
c.evictToFreeMemory(memoryToFree)
} else if atomic.LoadInt64(&c.entryCount) >= c.maxCacheSize {
// Fall back to count-based eviction for backward compatibility
c.evictOldest(int(c.maxCacheSize / 10)) // Evict 10% of entries
}
// A non-positive TTL is clamped to defaultTTL so this backend expires
// entries the same way the LRU and Redis backends do. See the defaultTTL
// doc comment above for the cross-backend rule.
if ttl <= 0 {
ttl = defaultTTL
}
expiresAt := time.Now().Add(ttl)
// Only compress if the value is larger than the threshold
var entry CacheEntry
if len(value) > CompressionThreshold {
compressedValue, err := c.compress(value)
if err == nil && len(compressedValue) < len(value) {
entry = CacheEntry{
Value: compressedValue,
ExpiresAt: expiresAt,
Compressed: true,
}
} else {
// If compression failed or didn't reduce size, store uncompressed
entry = CacheEntry{
Value: value,
ExpiresAt: expiresAt,
Compressed: false,
}
}
} else {
entry = CacheEntry{
Value: value,
ExpiresAt: expiresAt,
Compressed: false,
}
}
// Update the entry memory size based on compression status
if entry.Compressed {
entry.MemorySize = int64(len(key) + len(entry.Value) + approxEntryOverhead)
} else {
entry.MemorySize = int64(len(key) + len(entry.Value) + approxEntryOverhead)
}
// Swap is a single atomic operation on the sync.Map: it stores the new
// entry and reports the previous value (if any) in one step, so the
// entryCount/memoryUsage deltas below always match what actually
// happened to the map, even when Set races with Delete/evict on the same
// key. This keeps Set lock-free instead of serializing every write.
prev, loaded := c.entries.Swap(key, entry)
if loaded {
// Existing entry replaced: subtract its memory size.
prevEntry := prev.(CacheEntry)
atomic.AddInt64(&c.memoryUsage, -prevEntry.MemorySize)
} else {
// New entry.
atomic.AddInt64(&c.entryCount, 1)
}
atomic.AddInt64(&c.memoryUsage, entry.MemorySize)
}
func (c *Cache) Get(key string) ([]byte, bool) {
entry, ok := c.entries.Load(key)
if !ok {
return nil, false
}
cacheEntry := entry.(CacheEntry)
if cacheEntry.ExpiresAt.Before(time.Now()) {
// Guard the counter decrements with LoadAndDelete so concurrent Gets on
// the same expired entry don't each decrement entryCount/memoryUsage
// (the unconditional Delete here previously double-counted).
if removed, ok := c.entries.LoadAndDelete(key); ok {
removedEntry := removed.(CacheEntry)
atomic.AddInt64(&c.entryCount, -1)
atomic.AddInt64(&c.memoryUsage, -removedEntry.MemorySize)
}
return nil, false
}
if cacheEntry.Compressed {
value, err := c.decompress(cacheEntry.Value)
if err != nil {
return nil, false
}
return value, true
}
return cacheEntry.Value, true
}
func (c *Cache) Delete(key string) {
if entry, exists := c.entries.LoadAndDelete(key); exists {
cacheEntry := entry.(CacheEntry)
atomic.AddInt64(&c.entryCount, -1)
atomic.AddInt64(&c.memoryUsage, -cacheEntry.MemorySize)
}
}
// Clear removes all entries from the cache and adjusts the entry/memory
// counters to match exactly what was removed.
//
// Clear does not promise a consistent point-in-time snapshot: it takes the
// key list first, so an entry Set concurrently with Clear can survive it.
// The reverse can also happen: a concurrent Set that overwrites a key
// already collected by the Range pass can itself be deleted by Clear,
// because LoadAndDelete removes whatever mapping is current for that key
// when it runs, not necessarily the one Range observed.
//
// What Clear does guarantee is counter exactness. It LoadAndDeletes each
// collected key and subtracts exactly the MemorySize that LoadAndDelete
// returned, the same linearized pattern Delete/Get/CleanExpiredEntries/the
// evictors use, instead of the previous unconditional Delete followed by
// StoreInt64(0). That previous approach could race with a concurrent Set
// landing after the Range pass but before or after the StoreInt64 calls,
// leaving a live entry in the map while the counters read zero. The next
// Delete of that entry would then drive the counters permanently negative.
func (c *Cache) Clear() {
n := atomic.LoadInt64(&c.entryCount)
if n < 0 {
n = 0
}
keys := make([]string, 0, n)
c.entries.Range(func(key, _ any) bool {
keys = append(keys, key.(string))
return true
})
for _, key := range keys {
if removed, exists := c.entries.LoadAndDelete(key); exists {
removedEntry := removed.(CacheEntry)
atomic.AddInt64(&c.entryCount, -1)
atomic.AddInt64(&c.memoryUsage, -removedEntry.MemorySize)
}
}
}
func (c *Cache) CountQueries() int64 {
return atomic.LoadInt64(&c.entryCount)
}
func (c *Cache) compress(data []byte) ([]byte, error) {
var buf bytes.Buffer
w := c.compressPool.Get().(*gzip.Writer)
defer c.compressPool.Put(w)
w.Reset(&buf)
if _, err := w.Write(data); err != nil {
return nil, err
}
if err := w.Close(); err != nil {
return nil, err
}
return buf.Bytes(), nil
}
func (c *Cache) decompress(data []byte) ([]byte, error) {
r, ok := c.decompressPool.Get().(*gzip.Reader)
defer c.decompressPool.Put(r)
if !ok || r == nil {
var err error
r, err = gzip.NewReader(bytes.NewReader(data))
if err != nil {
return nil, err
}
} else {
if err := r.Reset(bytes.NewReader(data)); err != nil {
return nil, err
}
}
defer func() {
_ = r.Close() // Ignore error in defer cleanup
}()
return io.ReadAll(r)
}
func (c *Cache) CleanExpiredEntries() {
now := time.Now()
c.entries.Range(func(key, value any) bool {
entry := value.(CacheEntry)
if entry.ExpiresAt.Before(now) {
// Subtract the MemorySize of the value LoadAndDelete actually
// removed, not the Range snapshot: a concurrent Set of the same
// key between the Range read and the delete would otherwise
// account for the wrong entry's size.
if removed, exists := c.entries.LoadAndDelete(key); exists {
removedEntry := removed.(CacheEntry)
atomic.AddInt64(&c.entryCount, -1)
atomic.AddInt64(&c.memoryUsage, -removedEntry.MemorySize)
}
}
return true
})
}
// evictOldest removes the oldest n entries from the cache, oldest by
// ExpiresAt first. It collects every live entry and sorts once with
// sort.Slice (O(n log n)), the same approach evictToFreeMemory below uses,
// instead of a nested-loop selection sort (O(n^2)).
//
// Collecting ALL entries (not a capped subset) matters for correctness, not
// just performance: sync.Map.Range iterates in unspecified order, so an
// early-terminated scan over an arbitrary subset can miss the true oldest
// keys entirely and evict the wrong entries.
func (c *Cache) evictOldest(n int) {
type keyExpiry struct {
expiresAt time.Time
key string
}
liveEntries := atomic.LoadInt64(&c.entryCount)
if liveEntries < 0 {
liveEntries = 0
}
entries := make([]keyExpiry, 0, liveEntries)
c.entries.Range(func(k, v any) bool {
key := k.(string)
entry := v.(CacheEntry)
entries = append(entries, keyExpiry{entry.ExpiresAt, key})
return true
})
// Sort by expiry time (oldest first)
sort.Slice(entries, func(i, j int) bool {
return entries[i].expiresAt.Before(entries[j].expiresAt)
})
if n > len(entries) {
n = len(entries)
}
for i := 0; i < n; i++ {
if entry, exists := c.entries.LoadAndDelete(entries[i].key); exists {
cacheEntry := entry.(CacheEntry)
atomic.AddInt64(&c.entryCount, -1)
atomic.AddInt64(&c.memoryUsage, -cacheEntry.MemorySize)
}
}
}
// evictToFreeMemory removes entries until the specified amount of memory is freed
func (c *Cache) evictToFreeMemory(bytesToFree int64) {
type keyMemorySize struct {
expiresAt time.Time
key string
memorySize int64
}
// Collect ALL entries so eviction can actually reach the target. The
// previous code capped the candidate set at maxCacheSize/5 and stopped at
// the end of that subset, so a large write could leave the cache over its
// memory limit.
//
// Size the slice from the live entry count, not the configured
// maxCacheSize: with a large configured limit (e.g. millions of entries)
// and a near-empty cache, pre-allocating by maxCacheSize would allocate
// far more memory than the cache actually holds.
liveEntries := atomic.LoadInt64(&c.entryCount)
if liveEntries < 0 {
liveEntries = 0
}
entries := make([]keyMemorySize, 0, liveEntries)
c.entries.Range(func(k, v any) bool {
key := k.(string)
entry := v.(CacheEntry)
entries = append(entries, keyMemorySize{entry.ExpiresAt, key, entry.MemorySize})
return true
})
// Sort by expiry time (oldest first)
sort.Slice(entries, func(i, j int) bool {
return entries[i].expiresAt.Before(entries[j].expiresAt)
})
var freedBytes int64
for _, e := range entries {
if freedBytes >= bytesToFree {
break
}
if entry, exists := c.entries.LoadAndDelete(e.key); exists {
cacheEntry := entry.(CacheEntry)
atomic.AddInt64(&c.entryCount, -1)
atomic.AddInt64(&c.memoryUsage, -cacheEntry.MemorySize)
freedBytes += cacheEntry.MemorySize
}
}
}
// GetMemoryUsage returns the current memory usage of the cache in bytes
func (c *Cache) GetMemoryUsage() int64 {
return atomic.LoadInt64(&c.memoryUsage)
}
// GetMaxMemorySize returns the maximum memory size allowed for the cache in bytes
func (c *Cache) GetMaxMemorySize() int64 {
return c.maxMemorySize
}
// SetMaxMemorySize updates the maximum memory size allowed for the cache
func (c *Cache) SetMaxMemorySize(maxBytes int64) {
c.maxMemorySize = maxBytes
// Check if we need to evict entries due to the new limit
currentMemory := atomic.LoadInt64(&c.memoryUsage)
if currentMemory > maxBytes {
memoryToFree := currentMemory - maxBytes + (maxBytes / 10)
c.evictToFreeMemory(memoryToFree)
}
}
-386
View File
@@ -1,386 +0,0 @@
package libpack_cache_memory
import (
"fmt"
"io"
"sync"
"testing"
"time"
"github.com/stretchr/testify/assert"
)
// Default constants for testing
const (
DefaultTestExpiration = 5 * time.Second
)
func TestMemoryCacheClear(t *testing.T) {
cache := New(DefaultTestExpiration)
// Add some entries
cache.Set("key1", []byte("value1"), DefaultTestExpiration)
cache.Set("key2", []byte("value2"), DefaultTestExpiration)
// Verify entries exist
_, found := cache.Get("key1")
assert.True(t, found, "Expected key1 to exist before clearing cache")
// Clear the cache
cache.Clear()
// Verify cache is empty
_, found = cache.Get("key1")
assert.False(t, found, "Expected key1 to be removed after clearing cache")
_, found = cache.Get("key2")
assert.False(t, found, "Expected key2 to be removed after clearing cache")
// Check that counter was reset
assert.Equal(t, int64(0), cache.CountQueries(), "Expected count to be 0 after clearing cache")
}
func TestMemoryCacheCountQueries(t *testing.T) {
cache := New(DefaultTestExpiration)
// Check initial count
assert.Equal(t, int64(0), cache.CountQueries(), "Expected initial count to be 0")
// Add some entries
cache.Set("key1", []byte("value1"), DefaultTestExpiration)
cache.Set("key2", []byte("value2"), DefaultTestExpiration)
cache.Set("key3", []byte("value3"), DefaultTestExpiration)
// Check count
assert.Equal(t, int64(3), cache.CountQueries(), "Expected count to be 3 after adding 3 entries")
// Delete an entry
cache.Delete("key1")
// Check count after deletion
assert.Equal(t, int64(2), cache.CountQueries(), "Expected count to be 2 after deleting 1 entry")
}
func TestMemoryCacheCleanExpiredEntries(t *testing.T) {
// Create a cache with default expiration
cache := New(10 * time.Second)
// Add an entry that will expire quickly
cache.Set("expire-soon", []byte("value1"), 10*time.Millisecond)
// Add an entry that will not expire during the test
cache.Set("expire-later", []byte("value3"), 10*time.Minute)
// Initial count should be 2
assert.Equal(t, int64(2), cache.CountQueries(), "Expected count to be 2 after adding entries")
// Wait for short expiration
time.Sleep(20 * time.Millisecond)
// Get the expired key directly to verify it's expired
_, expiredFound := cache.Get("expire-soon")
assert.False(t, expiredFound, "Key 'expire-soon' should be expired now")
// Verify the not-expired key is still there
val, nonExpiredFound := cache.Get("expire-later")
assert.True(t, nonExpiredFound, "Key 'expire-later' should not be expired")
assert.Equal(t, []byte("value3"), val, "Expected correct value for 'expire-later'")
// Manually clean expired entries
cache.CleanExpiredEntries()
// Count should be 1 now (only the non-expired entry)
assert.Equal(t, int64(1), cache.CountQueries(), "Expected count to be 1 after cleaning expired entries")
}
func TestMemoryCacheConcurrentGetOnExpiredEntry_CountersConsistent(t *testing.T) {
// Regression: concurrent Gets on the same expired entry must decrement
// entryCount exactly once. Previously Get used an unconditional Delete +
// decrement, so N concurrent Gets drove entryCount negative.
cache := NewWithSize(DefaultTestExpiration, DefaultMaxMemorySize, DefaultMaxCacheSize)
cache.Set("k", []byte("v"), 10*time.Millisecond)
time.Sleep(50 * time.Millisecond) // let it expire
var wg sync.WaitGroup
for range 32 {
wg.Add(1)
go func() {
defer wg.Done()
if _, ok := cache.Get("k"); ok {
t.Error("expired entry should not be returned")
}
}()
}
wg.Wait()
if got := cache.CountQueries(); got != 0 {
t.Fatalf("entryCount = %d after concurrent expired gets, want 0", got)
}
if got := cache.GetMemoryUsage(); got != 0 {
t.Fatalf("memoryUsage = %d after concurrent expired gets, want 0", got)
}
}
func TestMemoryCacheConcurrentSetSameNewKey_CounterNotDoubled(t *testing.T) {
// Regression: two (or more) concurrent Sets of the same brand-new key must
// not both take the "new entry" branch. Previously the exists-check and
// counter increment were separate atomic ops, so concurrent Sets of a new
// key each incremented entryCount, inflating it for a single stored entry.
cache := NewWithSize(DefaultTestExpiration, DefaultMaxMemorySize, DefaultMaxCacheSize)
const workers = 32
var wg sync.WaitGroup
for range workers {
wg.Add(1)
go func() {
defer wg.Done()
cache.Set("same-key", []byte("value"), DefaultTestExpiration)
}()
}
wg.Wait()
if got := cache.CountQueries(); got != 1 {
t.Fatalf("entryCount = %d after %d concurrent Sets of one new key, want 1", got, workers)
}
// Sanity: the entry is actually stored and retrievable.
if _, ok := cache.Get("same-key"); !ok {
t.Fatal("key should be retrievable after Set")
}
}
func TestMemoryCacheConcurrentSetDeleteEvict_CountersMatchActualState(t *testing.T) {
// Regression for M4 (evictToFreeMemory pre-allocation sized from live
// entryCount, not configured maxCacheSize) and S2 (lock-free Set via
// sync.Map.Swap, so Set no longer double-accounts when it races with
// Delete/evictOldest/evictToFreeMemory/CleanExpiredEntries on the same
// key).
//
// The specific key each goroutine touches, and which operation wins a
// given race, is inherently nondeterministic. What must always hold,
// deterministically, once every goroutine has joined, is the invariant
// that entryCount/memoryUsage are derived state: they must exactly match
// the cache's real final contents. Recomputing "expected" from the
// actual final map (the known final key set) and diffing against the
// atomic counters catches any lost or double-counted update.
const (
numKeys = 50
numWorkers = 16
numOpsEach = 300
)
// Small maxCacheSize so Set's own eviction path (evictOldest) also fires
// under the concurrent load, in addition to the evictors driven directly
// below.
cache := NewWithSize(DefaultTestExpiration, DefaultMaxMemorySize, 40)
defer cache.Shutdown()
keyFor := func(i int) string { return fmt.Sprintf("hammer-key-%d", i) }
// Pre-seed so evictors have entries to act on from the start.
for i := range numKeys {
cache.Set(keyFor(i), []byte("seed-value"), DefaultTestExpiration)
}
var wg sync.WaitGroup
for w := range numWorkers {
wg.Add(1)
go func(worker int) {
defer wg.Done()
for op := range numOpsEach {
k := keyFor((worker + op) % numKeys)
switch op % 3 {
case 0:
cache.Set(k, []byte("value"), DefaultTestExpiration)
case 1:
cache.Delete(k)
case 2:
cache.evictOldest(2)
}
}
}(w)
}
wg.Add(2)
go func() {
defer wg.Done()
for range 100 {
cache.evictToFreeMemory(128)
}
}()
go func() {
defer wg.Done()
for range 100 {
cache.CleanExpiredEntries()
}
}()
wg.Wait()
// Stop the background cleanup goroutine before recomputing expected
// state, so it cannot race with the Range below (nothing has expired
// yet - DefaultTestExpiration is 5s - but this removes any doubt).
cache.Shutdown()
var wantCount, wantMemory int64
cache.entries.Range(func(_, v any) bool {
entry := v.(CacheEntry)
wantCount++
wantMemory += entry.MemorySize
return true
})
if got := cache.CountQueries(); got != wantCount {
t.Fatalf("entryCount = %d, want %d (actual live entries after join)", got, wantCount)
}
if got := cache.GetMemoryUsage(); got != wantMemory {
t.Fatalf("memoryUsage = %d, want %d (sum of live entries' MemorySize after join)", got, wantMemory)
}
}
func TestMemoryCacheConcurrentSetDeleteClear_CountersMatchActualState(t *testing.T) {
// Regression for Clear(): the previous implementation Ranged the
// sync.Map calling Delete per key, then unconditionally reset both
// counters with StoreInt64(0). A Set racing Clear could land after the
// Range pass but before or after the StoreInt64 calls, leaving a live
// entry in the map while the counters read zero - the next Delete of
// that key then drove the counters permanently negative.
//
// Clear now follows the same linearized LoadAndDelete-then-subtract
// pattern as Delete/Get/CleanExpiredEntries/the evictors, so it no
// longer promises a consistent point-in-time snapshot (a concurrent Set
// can survive a Clear) but does guarantee entryCount/memoryUsage always
// match the entries actually removed. As in
// TestMemoryCacheConcurrentSetDeleteEvict_CountersMatchActualState,
// which key wins a given race is nondeterministic, so the assertion
// recomputes "expected" from the final map contents rather than
// asserting a fixed number.
const (
numKeys = 50
numWorkers = 16
numOpsEach = 300
)
cache := NewWithSize(DefaultTestExpiration, DefaultMaxMemorySize, DefaultMaxCacheSize)
defer cache.Shutdown()
keyFor := func(i int) string { return fmt.Sprintf("clear-key-%d", i) }
// Pre-seed so Clear and the Delete workers have entries to act on from
// the start.
for i := range numKeys {
cache.Set(keyFor(i), []byte("seed-value"), DefaultTestExpiration)
}
var wg sync.WaitGroup
for w := range numWorkers {
wg.Add(1)
go func(worker int) {
defer wg.Done()
for op := range numOpsEach {
k := keyFor((worker + op) % numKeys)
switch op % 2 {
case 0:
cache.Set(k, []byte("value"), DefaultTestExpiration)
case 1:
cache.Delete(k)
}
}
}(w)
}
wg.Add(1)
go func() {
defer wg.Done()
for range 100 {
cache.Clear()
}
}()
wg.Wait()
// Stop the background cleanup goroutine before recomputing expected
// state, so it cannot race with the Range below (nothing has expired
// yet - DefaultTestExpiration is 5s - but this removes any doubt).
cache.Shutdown()
var wantCount, wantMemory int64
cache.entries.Range(func(_, v any) bool {
entry := v.(CacheEntry)
wantCount++
wantMemory += entry.MemorySize
return true
})
if got := cache.CountQueries(); got != wantCount {
t.Fatalf("entryCount = %d, want %d (actual live entries after join)", got, wantCount)
}
if got := cache.GetMemoryUsage(); got != wantMemory {
t.Fatalf("memoryUsage = %d, want %d (sum of live entries' MemorySize after join)", got, wantMemory)
}
}
func TestMemoryCacheClose_IdempotentAndStillUsable(t *testing.T) {
// Compile-time guard: the memory backend must satisfy io.Closer so
// cache.Shutdown() can stop its cleanup goroutine (it otherwise leaks
// the background timer until process exit), matching the Redis backend.
var _ io.Closer = (*Cache)(nil)
cache := New(DefaultTestExpiration)
cache.Set("key", []byte("value"), DefaultTestExpiration)
// Close is idempotent: it only cancels the background cleaner.
if err := cache.Close(); err != nil {
t.Fatalf("first Close: %v", err)
}
if err := cache.Close(); err != nil {
t.Fatalf("second Close: %v", err)
}
// Stopping the cleaner must not render the cache unusable.
if _, ok := cache.Get("key"); !ok {
t.Fatal("entry should survive Close; Close only stops the background cleaner")
}
cache.Set("key2", []byte("v2"), DefaultTestExpiration)
if _, ok := cache.Get("key2"); !ok {
t.Fatal("cache should remain writable after Close")
}
}
// TestNewWithSize_NonPositiveTTL_DoesNotPanic is a regression test for C1: a
// non-positive globalTTL (e.g. a misconfigured CACHE_TTL<=0) used to reach
// time.NewTicker(globalTTL/4) unguarded inside cleanupRoutine, and
// time.NewTicker panics for d<=0. That panic happens in the background
// goroutine spawned by NewWithSize, so a regression here crashes the whole
// process, not just this test.
func TestNewWithSize_NonPositiveTTL_DoesNotPanic(t *testing.T) {
tests := []struct {
name string
ttl time.Duration
}{
{"zero TTL", 0},
{"negative TTL", -5 * time.Second},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cache := NewWithSize(tt.ttl, DefaultMaxMemorySize, DefaultMaxCacheSize)
defer cache.Shutdown()
// Give the background cleanup goroutine a moment to construct its
// ticker.
time.Sleep(20 * time.Millisecond)
// Cache must remain fully usable.
cache.Set("key", []byte("value"), DefaultTestExpiration)
retrieved, found := cache.Get("key")
assert.True(t, found, "cache should be usable after construction with a non-positive TTL")
assert.Equal(t, []byte("value"), retrieved)
})
}
}
// TestDefaultTTLValue documents the sane fallback used both to size the
// cleanup ticker (C1) and to clamp a non-positive per-entry TTL (C11).
func TestDefaultTTLValue(t *testing.T) {
assert.Equal(t, 60*time.Second, defaultTTL)
}
-82
View File
@@ -1,82 +0,0 @@
package libpack_cache_memory
import (
"fmt"
"testing"
"time"
)
// Assume that New function initializes the cache and it is defined somewhere in the libpack_cache package.
func BenchmarkMemCacheSet(b *testing.B) {
cache := New(30 * time.Second) // Initializing the cache with a TTL of 30 seconds
key := "benchmark-key"
value := []byte("benchmark-value")
b.ResetTimer() // Reset the timer to exclude the setup time from the benchmark
for i := 0; i < b.N; i++ {
cache.Set(key, value, 5*time.Second)
}
}
func BenchmarkMemCacheGet(b *testing.B) {
cache := New(30 * time.Second) // Initializing the cache
key := "benchmark-key"
value := []byte("benchmark-value")
cache.Set(key, value, 5*time.Second) // Pre-set a value to retrieve
b.ResetTimer() // Start timing
for i := 0; i < b.N; i++ {
_, _ = cache.Get(key)
}
}
func BenchmarkMemCacheExpire(b *testing.B) {
key := "benchmark-expire-key"
value := []byte("benchmark-value")
ttl := 5 * time.Millisecond // Setting a short TTL for quick expiration
for i := 0; i < b.N; i++ {
cache := New(30 * time.Second)
cache.Set(key, value, ttl)
time.Sleep(ttl) // Wait for the key to expire
_, _ = cache.Get(key)
}
}
func BenchmarkMemCacheStats(b *testing.B) {
cache := New(30 * time.Second) // Initializing the cache
key := "benchmark-key"
value := []byte("benchmark-value")
cache.Set(key, value, 5*time.Second) // Pre-set a value to retrieve
cache.Get(key)
}
func BenchmarkCacheSet(b *testing.B) {
cache := New(5 * time.Second)
b.ResetTimer()
for i := 0; i < b.N; i++ {
cache.Set(fmt.Sprintf("key-%d", i), []byte("value"), 5*time.Second)
}
}
func BenchmarkCacheGet(b *testing.B) {
cache := New(5 * time.Second)
cache.Set("test-key", []byte("test-value"), 5*time.Second)
b.ResetTimer()
for i := 0; i < b.N; i++ {
cache.Get("test-key")
}
}
func BenchmarkCacheDelete(b *testing.B) {
cache := New(5 * time.Second)
b.ResetTimer()
for i := 0; i < b.N; i++ {
key := fmt.Sprintf("key-%d", i)
cache.Set(key, []byte("value"), 5*time.Second)
cache.Delete(key)
}
}
-191
View File
@@ -1,191 +0,0 @@
package libpack_cache_memory
import (
"fmt"
"sync"
"testing"
"time"
"github.com/stretchr/testify/suite"
)
type MemoryTestSuite struct {
suite.Suite
}
func (suite *MemoryTestSuite) SetupTest() {
}
func TestCachingTestSuite(t *testing.T) {
suite.Run(t, new(MemoryTestSuite))
}
func (suite *MemoryTestSuite) Test_New() {
suite.T().Run("should return a new cache", func(t *testing.T) {
cache := New(2 * time.Second)
suite.NotNil(cache)
})
}
func (suite *MemoryTestSuite) Test_CacheUse() {
cache := New(30 * time.Second)
tests := []struct {
name string
cache_value string
}{
{
name: "test1",
cache_value: "test1-123",
},
{
name: "test2",
cache_value: "test2-123",
},
}
for _, tt := range tests {
suite.T().Run(tt.name, func(t *testing.T) {
cache.Set(tt.name, []byte(tt.name), 5*time.Second)
c, ok := cache.Get(tt.name)
suite.Equal(true, ok)
suite.Equal(tt.name, string(c))
})
}
}
func (suite *MemoryTestSuite) Test_CacheDelete() {
cache := New(30 * time.Second)
tests := []struct {
name string
cache_value string
}{
{
name: "test1",
cache_value: "test1-123",
},
{
name: "test2",
cache_value: "test2-123",
},
}
for _, tt := range tests {
suite.T().Run(tt.name, func(t *testing.T) {
cache.Set(tt.name, []byte(tt.name), 5*time.Second)
c, ok := cache.Get(tt.name)
suite.Equal(true, ok)
suite.Equal(tt.name, string(c))
cache.Delete(tt.name)
c, ok = cache.Get(tt.name)
suite.Equal(false, ok)
suite.Equal("", string(c))
})
}
}
func (suite *MemoryTestSuite) Test_CacheExpire() {
cache := New(30 * time.Second)
tests := []struct {
name string
cache_value string
ttl time.Duration
}{
{
name: "test1",
cache_value: "test1-123",
ttl: 2 * time.Second,
},
{
name: "test2",
cache_value: "test2-123",
ttl: 5 * time.Second,
},
}
for _, tt := range tests {
suite.T().Run(tt.name, func(t *testing.T) {
cache.Set(tt.name, []byte(tt.name), tt.ttl)
c, ok := cache.Get(tt.name)
suite.Equal(true, ok)
suite.Equal(tt.name, string(c))
time.Sleep(tt.ttl)
c, ok = cache.Get(tt.name)
suite.Equal(false, ok)
suite.Equal("", string(c))
})
}
}
func (suite *MemoryTestSuite) Test_ConcurrentReadWrite() {
cache := New(5 * time.Second)
const numGoroutines = 100
const numOperations = 1000
var wg sync.WaitGroup
wg.Add(numGoroutines)
for i := 0; i < numGoroutines; i++ {
go func(id int) {
defer wg.Done()
for j := 0; j < numOperations; j++ {
key := fmt.Sprintf("key-%d-%d", id, j)
value := []byte(fmt.Sprintf("value-%d-%d", id, j))
if j%2 == 0 {
cache.Set(key, value, 5*time.Second)
} else {
_, _ = cache.Get(key)
}
}
}(i)
}
wg.Wait()
}
func (suite *MemoryTestSuite) Test_LargeItems() {
cache := New(5 * time.Second)
largeValue := make([]byte, 10*1024*1024) // 10MB
cache.Set("large-key", largeValue, 5*time.Second)
retrieved, found := cache.Get("large-key")
suite.Assert().True(found)
suite.Assert().Equal(largeValue, retrieved)
}
// Test_ZeroTTL verifies the C11 cross-backend rule: a non-positive TTL is
// clamped to defaultTTL instead of being stored as already-expired. Before
// this fix, Set("zero-ttl", ..., 0) stamped ExpiresAt at time.Now(), so the
// very next Get always missed.
func (suite *MemoryTestSuite) Test_ZeroTTL() {
cache := New(5 * time.Second)
cache.Set("zero-ttl", []byte("value"), 0)
retrieved, found := cache.Get("zero-ttl")
suite.Assert().True(found, "zero TTL should be clamped to defaultTTL, not stored as already-expired")
suite.Assert().Equal([]byte("value"), retrieved)
raw, ok := cache.entries.Load("zero-ttl")
suite.Require().True(ok)
entry, ok := raw.(CacheEntry)
suite.Require().True(ok)
suite.Assert().WithinDuration(time.Now().Add(defaultTTL), entry.ExpiresAt, 2*time.Second,
"clamped entry should expire ~defaultTTL from now")
}
// Test_NegativeTTL verifies the same clamp applies to a negative TTL, not
// just exactly zero.
func (suite *MemoryTestSuite) Test_NegativeTTL() {
cache := New(5 * time.Second)
cache.Set("negative-ttl", []byte("value"), -1*time.Second)
retrieved, found := cache.Get("negative-ttl")
suite.Assert().True(found, "negative TTL should be clamped to defaultTTL, not stored as already-expired")
suite.Assert().Equal([]byte("value"), retrieved)
}
func (suite *MemoryTestSuite) Test_LongTTL() {
cache := New(5 * time.Second)
cache.Set("long-ttl", []byte("value"), 24*365*time.Hour) // 1 year
retrieved, found := cache.Get("long-ttl")
suite.Assert().True(found)
suite.Assert().Equal([]byte("value"), retrieved)
}
-202
View File
@@ -1,202 +0,0 @@
// Package libpack_cache_redis provides a Redis-backed cache implementation
// for distributed caching across multiple proxy instances. Supports key
// prefixing for multi-tenant isolation.
package libpack_cache_redis
import (
"context"
"errors"
"fmt"
"strings"
"sync"
"time"
redis "github.com/redis/go-redis/v9"
)
// globEscaper escapes Redis glob-pattern metacharacters (\, *, ?, [, ]) so a
// literal string can be embedded in a SCAN/KEYS MATCH pattern without being
// interpreted as a wildcard. Each character is matched once per input byte,
// so the replacements cannot cascade into one another.
var globEscaper = strings.NewReplacer(
`\`, `\\`,
`*`, `\*`,
`?`, `\?`,
`[`, `\[`,
`]`, `\]`,
)
// escapeGlobPattern returns s with Redis glob metacharacters escaped so it
// can be used as a literal prefix inside a MATCH pattern.
func escapeGlobPattern(s string) string {
return globEscaper.Replace(s)
}
type RedisConfig struct {
ctx context.Context
client *redis.Client
builderPool *sync.Pool
prefix string
}
// Close releases the underlying Redis connection pool. Called at process
// shutdown so the pooled connections and go-redis background goroutines are
// terminated instead of relying on process exit.
func (c *RedisConfig) Close() error {
if c == nil || c.client == nil {
return nil
}
return c.client.Close()
}
func (c *RedisConfig) prependKeyName(key string) string {
builder := c.builderPool.Get().(*strings.Builder)
defer c.builderPool.Put(builder)
builder.Reset()
builder.WriteString(c.prefix)
builder.WriteString(key)
return builder.String()
}
type RedisClientConfig struct {
RedisServer string
RedisPassword string
Prefix string
RedisDB int
}
// defaultTTL is the sane fallback applied to a non-positive per-entry TTL
// passed to Set.
//
// go-redis treats a non-positive expiration as "send SET with no EX/PX
// option", which makes the key permanent (see redis/go-redis/v9
// string_commands.go: `if expiration > 0 { ... }`, no else branch adds an
// expiry). That would silently diverge from the in-memory backends: the
// standard memory cache and the LRU cache both clamp a non-positive TTL to
// their own equivalent defaultTTL constant (cache/memory/memory.go and
// cache/memory/lru_memory_cache.go) so the entry still expires. Clamping here
// too keeps all three backends' behavior identical: a misconfigured
// (non-positive) TTL always results in a bounded expiry, never a permanent
// entry.
const defaultTTL = 60 * time.Second
func New(redisClientConfig *RedisClientConfig) (*RedisConfig, error) {
c := &RedisConfig{
client: redis.NewClient(&redis.Options{
Addr: redisClientConfig.RedisServer,
Password: redisClientConfig.RedisPassword,
DB: redisClientConfig.RedisDB,
}),
ctx: context.Background(),
prefix: redisClientConfig.Prefix,
builderPool: &sync.Pool{
New: func() any {
return &strings.Builder{}
},
},
}
_, err := c.client.Ping(c.ctx).Result()
if err != nil {
return nil, err
}
return c, nil
}
func (c *RedisConfig) Set(key string, value []byte, ttl time.Duration) error {
if ttl <= 0 {
ttl = defaultTTL
}
return c.client.Set(c.ctx, c.prependKeyName(key), value, ttl).Err()
}
func (c *RedisConfig) Get(key string) ([]byte, bool, error) {
val, err := c.client.Get(c.ctx, c.prependKeyName(key)).Result()
if err == redis.Nil {
return nil, false, nil
}
if err != nil {
return nil, false, err
}
return []byte(val), true, nil
}
func (c *RedisConfig) Delete(key string) error {
return c.client.Del(c.ctx, c.prependKeyName(key)).Err()
}
// Clear removes only the keys owned by this cache (those under the configured
// prefix). Unlike FlushDB it does not wipe unrelated keys that may share the
// selected Redis DB when the database is not exclusively owned by this proxy.
// The prefix is glob-escaped before use so a prefix containing Redis glob
// metacharacters (*, ?, [, ], \) is matched literally instead of being
// interpreted as a wildcard. A failure to delete one scanned batch does not
// abort the clear: remaining batches are still attempted, and any errors
// encountered (scan or delete) are joined and returned to the caller so a
// partial clear is never silently reported as a success.
func (c *RedisConfig) Clear() error {
pattern := escapeGlobPattern(c.prefix) + "*"
var cursor uint64
var errs []error
for {
keys, next, err := c.client.Scan(c.ctx, cursor, pattern, 100).Result()
if err != nil {
errs = append(errs, fmt.Errorf("redis: scan at cursor %d: %w", cursor, err))
break
}
if len(keys) > 0 {
if err := c.client.Del(c.ctx, keys...).Err(); err != nil {
errs = append(errs, fmt.Errorf("redis: delete batch at cursor %d: %w", cursor, err))
}
}
cursor = next
if cursor == 0 {
break
}
}
return errors.Join(errs...)
}
// CountQueries returns the number of keys owned by this cache (those under
// the configured prefix). The prefix is glob-escaped the same way Clear
// escapes it, so a prefix containing Redis glob metacharacters is matched
// literally instead of being interpreted as a wildcard, which would
// otherwise undercount or overcount keys in admin-dashboard stats.
func (c *RedisConfig) CountQueries() (int64, error) {
pattern := escapeGlobPattern(c.prefix) + "*"
keys, err := c.client.Keys(c.ctx, pattern).Result()
if err != nil {
return 0, err
}
return int64(len(keys)), nil
}
// CountQueriesWithPattern returns the number of keys owned by this cache
// whose suffix (after the prefix) matches pattern. Only the prefix is
// glob-escaped, the same way Clear and CountQueries escape it; pattern
// itself is left as given so a caller can still use glob metacharacters
// intentionally in the suffix it supplies.
func (c *RedisConfig) CountQueriesWithPattern(pattern string) (int, error) {
fullPattern := escapeGlobPattern(c.prefix) + pattern
keys, err := c.client.Keys(c.ctx, fullPattern).Result()
if err != nil {
return 0, err
}
return len(keys), nil
}
// GetMemoryUsage returns an approximation of memory usage for Redis.
// Actual memory is managed by the Redis server, so the proxy reports 0 here.
// Avoid an Info() round-trip: its result was always discarded, and it could
// stall the dashboard stats endpoint when Redis is slow or unreachable.
func (c *RedisConfig) GetMemoryUsage() int64 {
return 0
}
// GetMaxMemorySize returns the configured max memory for Redis
// In Redis, this would be the 'maxmemory' configuration value
func (c *RedisConfig) GetMaxMemorySize() int64 {
// Return a default value as Redis manages its own memory limits
// In a production environment, you could get this from Redis config
return 0
}
-62
View File
@@ -1,62 +0,0 @@
package libpack_cache_redis
import (
"testing"
"time"
"github.com/alicebob/miniredis/v2"
"github.com/stretchr/testify/assert"
)
func TestRedisClear(t *testing.T) {
// Create a mock Redis server
s, err := miniredis.Run()
if err != nil {
t.Fatalf("Failed to create mock redis server: %v", err)
}
defer s.Close()
// Create a Redis client
redisConfig, err := New(&RedisClientConfig{
RedisServer: s.Addr(),
RedisPassword: "",
RedisDB: 0,
})
if err != nil {
t.Fatalf("Failed to create Redis client: %v", err)
}
// Add some test data
ttl := time.Duration(60) * time.Second
err = redisConfig.Set("key1", []byte("value1"), ttl)
assert.NoError(t, err)
err = redisConfig.Set("key2", []byte("value2"), ttl)
assert.NoError(t, err)
err = redisConfig.Set("key3", []byte("value3"), ttl)
assert.NoError(t, err)
// Verify keys exist
count, err := redisConfig.CountQueries()
assert.NoError(t, err)
assert.Equal(t, int64(3), count, "Expected 3 keys before clearing cache")
// Clear the cache
err = redisConfig.Clear()
assert.NoError(t, err)
// Verify all keys are gone
count, err = redisConfig.CountQueries()
assert.NoError(t, err)
assert.Equal(t, int64(0), count, "Expected 0 keys after clearing cache")
// Verify individual keys are gone
_, found, err := redisConfig.Get("key1")
assert.NoError(t, err)
assert.False(t, found, "Key1 should be deleted after Clear")
_, found, err = redisConfig.Get("key2")
assert.NoError(t, err)
assert.False(t, found, "Key2 should be deleted after Clear")
_, found, err = redisConfig.Get("key3")
assert.NoError(t, err)
assert.False(t, found, "Key3 should be deleted after Clear")
}
-194
View File
@@ -1,194 +0,0 @@
package libpack_cache_redis
import (
"fmt"
"sync/atomic"
"testing"
"github.com/alicebob/miniredis/v2"
miniredis_server "github.com/alicebob/miniredis/v2/server"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// ---------------------------------------------------------------------------
// Clear — prefix containing Redis glob metacharacters
// ---------------------------------------------------------------------------
// TestClear_PrefixWithGlobMetacharacters_ClearsOnlyOwnedKeys covers the
// defect where a prefix containing Redis glob metacharacters (*, ?, [, ],
// \) corrupted the MATCH pattern passed to SCAN, so Clear silently deleted
// nothing (or the wrong keys). The prefix must now be matched literally.
func TestClear_PrefixWithGlobMetacharacters_ClearsOnlyOwnedKeys(t *testing.T) {
t.Parallel()
s, err := miniredis.Run()
require.NoError(t, err)
t.Cleanup(s.Close)
const globPrefix = "a[b]c*d?e\\f:"
owned, err := New(&RedisClientConfig{RedisServer: s.Addr(), Prefix: globPrefix})
require.NoError(t, err)
other, err := New(&RedisClientConfig{RedisServer: s.Addr(), Prefix: "unrelated:"})
require.NoError(t, err)
require.NoError(t, owned.Set("k1", []byte("v1"), 0))
require.NoError(t, owned.Set("k2", []byte("v2"), 0))
require.NoError(t, other.Set("k1", []byte("untouched"), 0))
require.NoError(t, owned.Clear())
// Keys under the glob-metacharacter prefix are gone.
_, found, err := owned.Get("k1")
assert.NoError(t, err)
assert.False(t, found, "key under glob-metacharacter prefix should be cleared")
_, found, err = owned.Get("k2")
assert.NoError(t, err)
assert.False(t, found, "key under glob-metacharacter prefix should be cleared")
// Key under the unrelated prefix survives untouched.
val, found, err := other.Get("k1")
assert.NoError(t, err)
assert.True(t, found, "key outside the cleared prefix must not be touched")
assert.Equal(t, []byte("untouched"), val)
}
// TestCountQueries_PrefixWithGlobMetacharacters_CountsOnlyOwnedKeys covers
// the same class of defect as TestClear_PrefixWithGlobMetacharacters_
// ClearsOnlyOwnedKeys, but for CountQueries: an unescaped glob-metacharacter
// prefix embedded directly in the KEYS pattern would report the wrong count
// for the admin dashboard (matching too few or unrelated keys).
func TestCountQueries_PrefixWithGlobMetacharacters_CountsOnlyOwnedKeys(t *testing.T) {
t.Parallel()
s, err := miniredis.Run()
require.NoError(t, err)
t.Cleanup(s.Close)
const globPrefix = "a[b]c*d?e\\f:"
owned, err := New(&RedisClientConfig{RedisServer: s.Addr(), Prefix: globPrefix})
require.NoError(t, err)
other, err := New(&RedisClientConfig{RedisServer: s.Addr(), Prefix: "unrelated:"})
require.NoError(t, err)
require.NoError(t, owned.Set("k1", []byte("v1"), 0))
require.NoError(t, owned.Set("k2", []byte("v2"), 0))
require.NoError(t, other.Set("k1", []byte("untouched"), 0))
count, err := owned.CountQueries()
require.NoError(t, err)
assert.Equal(t, int64(2), count, "CountQueries must count only keys under the glob-metacharacter prefix")
patternCount, err := owned.CountQueriesWithPattern("*")
require.NoError(t, err)
assert.Equal(t, 2, patternCount, "CountQueriesWithPattern must count only keys under the glob-metacharacter prefix")
}
// TestClear_NormalPrefix_StillClearsAllOwnedKeys is a regression check that
// the happy path (a prefix without glob metacharacters) still works exactly
// as before.
func TestClear_NormalPrefix_StillClearsAllOwnedKeys(t *testing.T) {
t.Parallel()
s, err := miniredis.Run()
require.NoError(t, err)
t.Cleanup(s.Close)
rc, err := New(&RedisClientConfig{RedisServer: s.Addr(), Prefix: "normal:"})
require.NoError(t, err)
require.NoError(t, rc.Set("k1", []byte("v1"), 0))
require.NoError(t, rc.Set("k2", []byte("v2"), 0))
require.NoError(t, rc.Set("k3", []byte("v3"), 0))
count, err := rc.CountQueries()
require.NoError(t, err)
require.Equal(t, int64(3), count)
assert.NoError(t, rc.Clear())
count, err = rc.CountQueries()
assert.NoError(t, err)
assert.Equal(t, int64(0), count)
}
// ---------------------------------------------------------------------------
// Clear — mid-scan DEL failure
// ---------------------------------------------------------------------------
// TestClear_AllBatchesDelFail_AttemptsEveryBatchAndAggregatesErrors covers
// the defect where a mid-scan DEL error aborted Clear early, leaving a
// partial clear with no error surfaced to the caller.
//
// miniredis exposes its underlying server.Server via Miniredis.Server(),
// whose SetPreHook is a documented public hook point (used by miniredis
// itself for auth/error simulation, see Miniredis.SetError). It lets a test
// intercept DEL commands without a rewrite of RedisConfig into an
// interface-backed mock, which the task's infra allows.
//
// Every DEL call is made to fail (not just one). A test that lets only one
// batch's DEL succeed was tried first, and does not work against miniredis:
// its SCAN implementation uses an index-based cursor over a sorted key
// snapshot (cmd_generic.go cmdScan), which is invalidated as soon as a
// preceding batch actually deletes keys mid-scan (the very "scan, then
// delete this batch" loop Clear uses), causing miniredis to abort the SCAN
// early with a synthetic empty result before Clear's loop reaches the next
// batch. Real Redis's SCAN cursor (reverse binary iteration) is documented
// to be robust against concurrent deletion during a single full iteration
// and would not exhibit this; it is a miniredis simplification, not a
// RedisConfig defect. Failing every batch's DEL sidesteps it (no batch is
// ever actually deleted, so the key set never shrinks between scans) while
// still proving Clear does not stop scanning after the first DEL error.
func TestClear_AllBatchesDelFail_AttemptsEveryBatchAndAggregatesErrors(t *testing.T) {
s, err := miniredis.Run()
require.NoError(t, err)
t.Cleanup(s.Close)
rc, err := New(&RedisClientConfig{RedisServer: s.Addr(), Prefix: "pfx:"})
require.NoError(t, err)
// miniredis SCAN batches deterministically by COUNT over the sorted,
// match-filtered key set (see cmd_generic.go cmdScan), so 250 owned keys
// with a SCAN COUNT of 100 (as used by Clear) yields exactly 3 batches:
// [0:100), [100:200), [200:250).
const totalKeys = 250
const wantBatches = 3
for i := 0; i < totalKeys; i++ {
key := "k" + zeroPad(i)
require.NoError(t, rc.Set(key, []byte("v"), 0))
}
var seen int32
s.Server().SetPreHook(func(c *miniredis_server.Peer, cmd string, _ ...string) bool {
if cmd != "DEL" {
return false // let miniredis handle everything else normally
}
n := atomic.AddInt32(&seen, 1)
c.WriteError(fmt.Sprintf("SIMULATED DEL FAILURE (batch %d)", n))
return true // command handled (as an error); miniredis skips its own DEL
})
clearErr := rc.Clear()
require.Error(t, clearErr, "Clear must surface DEL failures instead of swallowing them")
assert.Contains(t, clearErr.Error(), "SIMULATED DEL FAILURE")
// Every batch was attempted: DEL was invoked once per batch even though
// every prior call failed. The old code aborted after the first failure,
// which would leave seen == 1 here.
assert.Equal(t, int32(wantBatches), atomic.LoadInt32(&seen), "every batch must be attempted even after a DEL error")
remaining, err := rc.CountQueries()
assert.NoError(t, err)
assert.Equal(t, int64(totalKeys), remaining, "no keys are removed when every DEL fails")
}
func zeroPad(i int) string {
// Zero-pad to 3 digits so lexicographic sort (used by miniredis SCAN)
// matches numeric order, keeping batch membership predictable.
digits := [3]byte{'0', '0', '0'}
s := digits[:]
for pos := len(s) - 1; i > 0 && pos >= 0; pos-- {
s[pos] = byte('0' + i%10)
i /= 10
}
return string(s)
}
-360
View File
@@ -1,360 +0,0 @@
package libpack_cache_redis
import (
"testing"
"time"
"github.com/alicebob/miniredis/v2"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// ---------------------------------------------------------------------------
// helpers
// ---------------------------------------------------------------------------
func newTestRedis(t *testing.T) (*RedisConfig, *miniredis.Miniredis) {
t.Helper()
s, err := miniredis.Run()
require.NoError(t, err)
t.Cleanup(s.Close)
rc, err := New(&RedisClientConfig{
RedisServer: s.Addr(),
Prefix: "pfx:",
})
require.NoError(t, err)
return rc, s
}
func newTestWrapper(t *testing.T) (*CacheWrapper, *miniredis.Miniredis) {
t.Helper()
rc, s := newTestRedis(t)
w := NewCacheWrapper(rc, libpack_logger.New())
return w, s
}
// ---------------------------------------------------------------------------
// New — connection failure path
// ---------------------------------------------------------------------------
func TestNew_ConnectionFailure_ReturnsError(t *testing.T) {
t.Parallel()
_, err := New(&RedisClientConfig{
RedisServer: "127.0.0.1:1", // nothing listens here
})
assert.Error(t, err)
}
// ---------------------------------------------------------------------------
// redis.go — GetMemoryUsage
// ---------------------------------------------------------------------------
func TestGetMemoryUsage_ConnectedServer_ReturnsZero(t *testing.T) {
t.Parallel()
rc, _ := newTestRedis(t)
got := rc.GetMemoryUsage()
// Implementation always returns 0 as a placeholder; assert the contract.
assert.Equal(t, int64(0), got)
}
func TestGetMemoryUsage_ClosedServer_ReturnsZero(t *testing.T) {
t.Parallel()
rc, s := newTestRedis(t)
s.Close() // simulate disconnection before cleanup fires
got := rc.GetMemoryUsage()
assert.Equal(t, int64(0), got)
}
// ---------------------------------------------------------------------------
// redis.go — GetMaxMemorySize
// ---------------------------------------------------------------------------
func TestGetMaxMemorySize_AlwaysZero(t *testing.T) {
t.Parallel()
rc, _ := newTestRedis(t)
assert.Equal(t, int64(0), rc.GetMaxMemorySize())
}
// ---------------------------------------------------------------------------
// redis.go — Get error path (closed server)
// ---------------------------------------------------------------------------
func TestGet_ClosedServer_ReturnsError(t *testing.T) {
t.Parallel()
rc, s := newTestRedis(t)
// Set a key while server is up, then close.
require.NoError(t, rc.Set("k", []byte("v"), 0))
s.Close()
_, found, err := rc.Get("k")
assert.Error(t, err)
assert.False(t, found)
}
// ---------------------------------------------------------------------------
// redis.go — CountQueries error path
// ---------------------------------------------------------------------------
func TestCountQueries_ClosedServer_ReturnsError(t *testing.T) {
t.Parallel()
rc, s := newTestRedis(t)
s.Close()
count, err := rc.CountQueries()
assert.Error(t, err)
assert.Equal(t, int64(0), count)
}
// ---------------------------------------------------------------------------
// redis.go — CountQueriesWithPattern error path
// ---------------------------------------------------------------------------
func TestCountQueriesWithPattern_ClosedServer_ReturnsError(t *testing.T) {
t.Parallel()
rc, s := newTestRedis(t)
s.Close()
count, err := rc.CountQueriesWithPattern("*")
assert.Error(t, err)
assert.Equal(t, 0, count)
}
// ---------------------------------------------------------------------------
// redis.go — TTL=0 (no expiry) vs expired key
// ---------------------------------------------------------------------------
func TestGet_MissingKey_ReturnsFalseNoError(t *testing.T) {
t.Parallel()
rc, _ := newTestRedis(t)
val, found, err := rc.Get("nonexistent-key-xyz")
assert.NoError(t, err)
assert.False(t, found)
assert.Nil(t, val)
}
// TestSet_TTLZero_ClampedToDefaultTTL verifies the C11 cross-backend rule: a
// non-positive TTL is clamped to defaultTTL instead of go-redis's native
// behavior of sending SET with no EX/PX option (which makes the key
// permanent). This keeps Redis's expiry semantics identical to the memory
// and LRU backends instead of silently diverging into "never expires".
func TestSet_TTLZero_ClampedToDefaultTTL(t *testing.T) {
t.Parallel()
rc, s := newTestRedis(t)
require.NoError(t, rc.Set("clamped", []byte("yes"), 0))
// Still present before defaultTTL elapses.
s.FastForward(defaultTTL - 5*time.Second)
_, found, err := rc.Get("clamped")
assert.NoError(t, err)
assert.True(t, found, "clamped entry should still be present before defaultTTL elapses")
// Gone once defaultTTL elapses -- i.e. it is bounded, not permanent.
s.FastForward(10 * time.Second)
_, found, err = rc.Get("clamped")
assert.NoError(t, err)
assert.False(t, found, "zero TTL should expire after defaultTTL, not persist forever")
}
// TestSet_NegativeTTL_ClampedToDefaultTTL verifies the same clamp applies to
// a negative TTL, not just exactly zero.
func TestSet_NegativeTTL_ClampedToDefaultTTL(t *testing.T) {
t.Parallel()
rc, s := newTestRedis(t)
require.NoError(t, rc.Set("neg", []byte("yes"), -1*time.Second))
s.FastForward(defaultTTL + 5*time.Second)
_, found, err := rc.Get("neg")
assert.NoError(t, err)
assert.False(t, found, "negative TTL should expire after defaultTTL, not persist forever")
}
func TestSet_WithTTL_KeyExpires(t *testing.T) {
t.Parallel()
rc, s := newTestRedis(t)
require.NoError(t, rc.Set("expires", []byte("yes"), 1*time.Second))
s.FastForward(2 * time.Second)
_, found, err := rc.Get("expires")
assert.NoError(t, err)
assert.False(t, found)
}
// ---------------------------------------------------------------------------
// redis.go — large value round-trip
// ---------------------------------------------------------------------------
func TestSet_LargeValue_RoundTrip(t *testing.T) {
t.Parallel()
rc, _ := newTestRedis(t)
large := make([]byte, 1<<16) // 64 KB
for i := range large {
large[i] = byte(i % 251)
}
require.NoError(t, rc.Set("big", large, 0))
got, found, err := rc.Get("big")
assert.NoError(t, err)
assert.True(t, found)
assert.Equal(t, large, got)
}
// ---------------------------------------------------------------------------
// redis.go — prefix isolation
// ---------------------------------------------------------------------------
func TestPrerendKeyName_PrefixIsolation(t *testing.T) {
t.Parallel()
s, err := miniredis.Run()
require.NoError(t, err)
defer s.Close()
rc1, err := New(&RedisClientConfig{RedisServer: s.Addr(), Prefix: "a:"})
require.NoError(t, err)
rc2, err := New(&RedisClientConfig{RedisServer: s.Addr(), Prefix: "b:"})
require.NoError(t, err)
require.NoError(t, rc1.Set("key", []byte("one"), 0))
require.NoError(t, rc2.Set("key", []byte("two"), 0))
v1, ok1, err1 := rc1.Get("key")
assert.NoError(t, err1)
assert.True(t, ok1)
assert.Equal(t, []byte("one"), v1)
v2, ok2, err2 := rc2.Get("key")
assert.NoError(t, err2)
assert.True(t, ok2)
assert.Equal(t, []byte("two"), v2)
}
// ---------------------------------------------------------------------------
// wrapper.go — NewCacheWrapper with explicit logger
// ---------------------------------------------------------------------------
func TestNewCacheWrapper_WithLogger_UsesIt(t *testing.T) {
t.Parallel()
rc, _ := newTestRedis(t)
logger := &libpack_logger.Logger{}
w := NewCacheWrapper(rc, logger)
assert.NotNil(t, w)
}
func TestNewCacheWrapper_NilLogger_DoesNotPanic(t *testing.T) {
t.Parallel()
rc, _ := newTestRedis(t)
// NewCacheWrapper substitutes a zero-value Logger when nil is passed.
// Only verify construction succeeds; don't exercise error paths through
// this wrapper because zero-value Logger.output is nil and would panic.
w := NewCacheWrapper(rc, nil)
assert.NotNil(t, w)
// Happy-path operations are safe even with the zero-value logger.
w.Set("probe", []byte("ok"), 0)
got, found := w.Get("probe")
assert.True(t, found)
assert.Equal(t, []byte("ok"), got)
}
// ---------------------------------------------------------------------------
// wrapper.go — Set / Get / Delete / Clear happy paths
// ---------------------------------------------------------------------------
func TestWrapper_SetAndGet_HappyPath(t *testing.T) {
t.Parallel()
w, _ := newTestWrapper(t)
w.Set("wkey", []byte("wval"), 0)
got, found := w.Get("wkey")
assert.True(t, found)
assert.Equal(t, []byte("wval"), got)
}
func TestWrapper_Get_MissingKey_ReturnsFalse(t *testing.T) {
t.Parallel()
w, _ := newTestWrapper(t)
val, found := w.Get("ghost")
assert.False(t, found)
assert.Nil(t, val)
}
func TestWrapper_Delete_RemovesKey(t *testing.T) {
t.Parallel()
w, _ := newTestWrapper(t)
w.Set("del", []byte("gone"), 0)
w.Delete("del")
_, found := w.Get("del")
assert.False(t, found)
}
func TestWrapper_Clear_RemovesAllKeys(t *testing.T) {
t.Parallel()
w, _ := newTestWrapper(t)
w.Set("a", []byte("1"), 0)
w.Set("b", []byte("2"), 0)
w.Clear()
assert.Equal(t, int64(0), w.CountQueries())
}
func TestWrapper_CountQueries_ReturnsCount(t *testing.T) {
t.Parallel()
w, _ := newTestWrapper(t)
w.Set("c1", []byte("x"), 0)
w.Set("c2", []byte("y"), 0)
assert.Equal(t, int64(2), w.CountQueries())
}
// ---------------------------------------------------------------------------
// wrapper.go — GetMemoryUsage / GetMaxMemorySize always 0
// ---------------------------------------------------------------------------
func TestWrapper_GetMemoryUsage_AlwaysZero(t *testing.T) {
t.Parallel()
w, _ := newTestWrapper(t)
assert.Equal(t, int64(0), w.GetMemoryUsage())
}
func TestWrapper_GetMaxMemorySize_AlwaysZero(t *testing.T) {
t.Parallel()
w, _ := newTestWrapper(t)
assert.Equal(t, int64(0), w.GetMaxMemorySize())
}
// ---------------------------------------------------------------------------
// wrapper.go — error paths via closed server (logs, doesn't panic)
// ---------------------------------------------------------------------------
func TestWrapper_Set_ClosedServer_LogsError(t *testing.T) {
t.Parallel()
w, s := newTestWrapper(t)
s.Close()
// Must not panic; error is swallowed and logged.
w.Set("k", []byte("v"), 0)
}
func TestWrapper_Get_ClosedServer_ReturnsFalse(t *testing.T) {
t.Parallel()
w, s := newTestWrapper(t)
s.Close()
val, found := w.Get("k")
assert.False(t, found)
assert.Nil(t, val)
}
func TestWrapper_Delete_ClosedServer_LogsError(t *testing.T) {
t.Parallel()
w, s := newTestWrapper(t)
s.Close()
w.Delete("k") // must not panic
}
func TestWrapper_Clear_ClosedServer_LogsError(t *testing.T) {
t.Parallel()
w, s := newTestWrapper(t)
s.Close()
w.Clear() // must not panic
}
func TestWrapper_CountQueries_ClosedServer_ReturnsZero(t *testing.T) {
t.Parallel()
w, s := newTestWrapper(t)
s.Close()
assert.Equal(t, int64(0), w.CountQueries())
}
-158
View File
@@ -1,158 +0,0 @@
package libpack_cache_redis
import (
"testing"
"time"
"github.com/alicebob/miniredis/v2"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
)
type RedisConfigSuite struct {
suite.Suite
redisConfig *RedisConfig
redis_server *miniredis.Miniredis
}
func (suite *RedisConfigSuite) SetupTest() {
suite.redis_server, _ = miniredis.Run()
var err error
suite.redisConfig, err = New(&RedisClientConfig{
RedisServer: suite.redis_server.Addr(),
RedisPassword: "",
RedisDB: 0,
})
assert.NoError(suite.T(), err)
suite.redisConfig.Delete("testkey")
}
func TestRedisConfigSuite(t *testing.T) {
suite.Run(t, new(RedisConfigSuite))
}
func (suite *RedisConfigSuite) TestSet() {
key := "testkeyset"
value := []byte("testvalue")
suite.redisConfig.Delete(key) // Ensure the key is deleted before the test
// Test writing a new key-value pair
err := suite.redisConfig.Set(key, value, 0)
assert.NoError(suite.T(), err)
storedValue, found, err := suite.redisConfig.Get(key)
assert.NoError(suite.T(), err)
assert.True(suite.T(), found)
assert.Equal(suite.T(), value, storedValue)
// Test overwriting an existing key-value pair
newValue := []byte("newvalue")
err = suite.redisConfig.Set(key, newValue, 0)
assert.NoError(suite.T(), err)
storedValue, found, err = suite.redisConfig.Get(key)
assert.NoError(suite.T(), err)
assert.True(suite.T(), found)
assert.Equal(suite.T(), newValue, storedValue)
suite.redisConfig.Delete(key) // Clean up after the test
}
func (suite *RedisConfigSuite) TestSetWithExpiry() {
key := "testkey_with_expiry"
value := []byte("testvaluewithexpiry")
expiry := 2 * time.Second
suite.redisConfig.Delete(key) // Ensure the key is deleted before the test
// Test writing a new key-value pair
err := suite.redisConfig.Set(key, value, expiry)
assert.NoError(suite.T(), err)
storedValue, found, err := suite.redisConfig.Get(key)
assert.NoError(suite.T(), err)
assert.True(suite.T(), found)
assert.Equal(suite.T(), value, storedValue)
_, found, err = suite.redisConfig.Get(key)
assert.NoError(suite.T(), err)
assert.True(suite.T(), found, "Key should exist")
// Test that key expires after the specified time
suite.redis_server.FastForward(3 * time.Second)
_, found, err = suite.redisConfig.Get(key)
assert.NoError(suite.T(), err)
assert.False(suite.T(), found, "Key should have expired after 2 seconds")
suite.redisConfig.Delete(key) // Clean up after the test
}
func (suite *RedisConfigSuite) TestGet() {
key := "testkeyget"
value := []byte("testvalue")
err := suite.redisConfig.Set(key, value, 0) // Set the key-value pair
assert.NoError(suite.T(), err)
storedValue, found, err := suite.redisConfig.Get(key)
assert.NoError(suite.T(), err)
assert.True(suite.T(), found)
assert.Equal(suite.T(), value, storedValue)
}
func (suite *RedisConfigSuite) TestDeleteKey() {
key := "testkeydelete"
value := []byte("testvalue")
err := suite.redisConfig.Set(key, value, 0) // Set the key-value pair
assert.NoError(suite.T(), err)
err = suite.redisConfig.Delete(key)
assert.NoError(suite.T(), err)
_, found, err := suite.redisConfig.Get(key)
assert.NoError(suite.T(), err)
assert.False(suite.T(), found)
}
func (suite *RedisConfigSuite) TestCheckIfKeyExists() {
ttl := time.Duration(10) * time.Second
key := "testkeyifexists"
value := []byte("testvalue")
err := suite.redisConfig.Set(key, value, ttl) // Set the key-value pair
assert.NoError(suite.T(), err)
_, found, err := suite.redisConfig.Get(key)
assert.NoError(suite.T(), err)
assert.True(suite.T(), found)
err = suite.redisConfig.Delete(key)
assert.NoError(suite.T(), err)
_, found, err = suite.redisConfig.Get(key)
assert.NoError(suite.T(), err)
assert.False(suite.T(), found)
}
func (suite *RedisConfigSuite) TestGetKeys() {
ttl := time.Duration(10) * time.Second
err := suite.redisConfig.Set("testkey1", []byte("testvalue1"), ttl)
assert.NoError(suite.T(), err)
err = suite.redisConfig.Set("testkey2", []byte("testvalue2"), ttl)
assert.NoError(suite.T(), err)
err = suite.redisConfig.Set("otherkey", []byte("othervalue"), ttl)
assert.NoError(suite.T(), err)
keys, _ := suite.redisConfig.client.Keys(suite.redisConfig.ctx, "testkey*").Result()
expectedKeys := []string{"testkey1", "testkey2"}
assert.ElementsMatch(suite.T(), expectedKeys, keys)
suite.redisConfig.client.Del(suite.redisConfig.ctx, "testkey1", "testkey2", "otherkey")
}
func (suite *RedisConfigSuite) TestGetKeysCount() {
ttl := time.Duration(10) * time.Second
suite.redisConfig.Set("testkey1", []byte("testvalue1"), ttl)
suite.redisConfig.Set("testkey2", []byte("testvalue2"), ttl)
suite.redisConfig.Set("otherkey", []byte("othervalue"), ttl)
count1, err := suite.redisConfig.CountQueriesWithPattern("testkey*")
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 2, count1)
count2, err := suite.redisConfig.CountQueriesWithPattern("otherkey*")
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), 1, count2)
count3, err := suite.redisConfig.CountQueries()
assert.NoError(suite.T(), err)
assert.Equal(suite.T(), int64(3), count3)
suite.redisConfig.client.Del(suite.redisConfig.ctx, "testkey1", "testkey2", "otherkey")
}
-116
View File
@@ -1,116 +0,0 @@
package libpack_cache_redis
import (
"time"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
)
// CacheWrapper wraps RedisConfig to implement the CacheClient interface
// without returning errors, for backward compatibility
type CacheWrapper struct {
redis *RedisConfig
logger *libpack_logger.Logger
}
// NewCacheWrapper creates a new cache wrapper
func NewCacheWrapper(config *RedisConfig, logger *libpack_logger.Logger) *CacheWrapper {
if logger == nil {
// Use the proper constructor, not a zero-value &Logger{} -- its
// timeFormat field is a nil atomic.Pointer, so a zero-value Logger
// panics on the first log call instead of degrading gracefully.
logger = libpack_logger.New()
}
return &CacheWrapper{
redis: config,
logger: logger,
}
}
// Set stores a value with the given TTL
func (w *CacheWrapper) Set(key string, value []byte, ttl time.Duration) {
if err := w.redis.Set(key, value, ttl); err != nil {
w.logger.Error(&libpack_logger.LogMessage{
Message: "Redis set error",
Pairs: map[string]any{
"error": err.Error(),
"key": key,
},
})
}
}
// Get retrieves a value
func (w *CacheWrapper) Get(key string) ([]byte, bool) {
value, found, err := w.redis.Get(key)
if err != nil {
w.logger.Error(&libpack_logger.LogMessage{
Message: "Redis get error",
Pairs: map[string]any{
"error": err.Error(),
"key": key,
},
})
return nil, false
}
return value, found
}
// Delete removes a key
func (w *CacheWrapper) Delete(key string) {
if err := w.redis.Delete(key); err != nil {
w.logger.Error(&libpack_logger.LogMessage{
Message: "Redis delete error",
Pairs: map[string]any{
"error": err.Error(),
"key": key,
},
})
}
}
// Clear removes all keys
func (w *CacheWrapper) Clear() {
if err := w.redis.Clear(); err != nil {
w.logger.Error(&libpack_logger.LogMessage{
Message: "Redis clear error",
Pairs: map[string]any{
"error": err.Error(),
},
})
}
}
// CountQueries returns the number of queries
func (w *CacheWrapper) CountQueries() int64 {
count, err := w.redis.CountQueries()
if err != nil {
w.logger.Error(&libpack_logger.LogMessage{
Message: "Redis count queries error",
Pairs: map[string]any{
"error": err.Error(),
},
})
return 0
}
return count
}
// GetMemoryUsage returns 0 for Redis (not applicable)
func (w *CacheWrapper) GetMemoryUsage() int64 {
return 0
}
// GetMaxMemorySize returns 0 for Redis (not applicable)
func (w *CacheWrapper) GetMaxMemorySize() int64 {
return 0
}
// Close releases the underlying Redis client's connection pool at shutdown.
// Makes CacheWrapper satisfy io.Closer so the cache layer can close it.
func (w *CacheWrapper) Close() error {
if w == nil || w.redis == nil {
return nil
}
return w.redis.Close()
}
+48
View File
@@ -0,0 +1,48 @@
package main
import (
"time"
)
func (suite *Tests) Test_cacheLookup() {
type args struct {
hash string
}
tests := []struct {
name string
args args
want []byte
addCache struct {
data []byte
}
}{
{
name: "test_non_existent",
args: args{
hash: "00000000000000000000000000000000000000",
},
want: nil,
},
{
name: "test_existent",
args: args{
hash: "00000000000000000000000000000000001337",
},
want: []byte("it's fine."),
addCache: struct {
data []byte
}{
data: []byte("it's fine."),
},
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
if tt.addCache.data != nil {
cfg.Cache.CacheClient.Set(tt.args.hash, tt.addCache.data, time.Duration(90*time.Second))
}
got := cacheLookup(tt.args.hash)
assert.Equal(tt.want, got, "Unexpected cache lookup result")
})
}
}
-202
View File
@@ -1,202 +0,0 @@
package main
import (
"errors"
"github.com/gofiber/fiber/v3"
libpack_cache "github.com/lukaszraczylo/graphql-monitoring-proxy/cache"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
"github.com/sony/gobreaker"
"github.com/stretchr/testify/assert"
"github.com/valyala/fasthttp"
)
// TestCircuitBreakerCacheFallback tests that when the circuit is open, the system
// attempts to serve a cached response if available
func (suite *CircuitBreakerTestSuite) TestCircuitBreakerCacheFallback() {
// Reset the buffer before the test
suite.outputBuffer.Reset()
// Initialize circuit breaker with a short timeout and cache fallback enabled
cfg.CircuitBreaker.MaxFailures = 3
cfg.CircuitBreaker.Timeout = 5
cfg.CircuitBreaker.ReturnCachedOnOpen = true
initCircuitBreaker(cfg)
// Create a test fiber app and context
app := fiber.New()
requestCtx := &fasthttp.RequestCtx{}
requestCtx.Request.SetRequestURI("/test-path")
requestCtx.Request.Header.SetMethod("POST")
requestCtx.Request.Header.SetContentType("application/json")
requestCtx.Request.SetBody([]byte(`{"query": "query { test }"}`))
ctx := app.AcquireCtx(requestCtx)
defer app.ReleaseCtx(ctx)
// Calculate the cache key that would be used (with default user context since no auth headers)
// extractUserInfo() returns ("-", "-") when no auth is present
cacheKey := libpack_cache.CalculateHash(ctx, "-", "-")
// Add a test response to the cache
cachedResponse := []byte(`{"data":{"test":"cached-response"}}`)
libpack_cache.CacheStore(cacheKey, cachedResponse)
// Trip the circuit by generating failures
testErr := errors.New("test error")
for i := 0; i < cfg.CircuitBreaker.MaxFailures; i++ {
_, err := cb.Execute(func() (any, error) {
return nil, testErr
})
assert.Error(suite.T(), err, "Execute should return error")
}
// Verify circuit is now open
assert.Equal(suite.T(), gobreaker.StateOpen.String(), cb.State().String(), "Circuit should be open after failures")
// Prepare to monitor metric increments for fallback success
initialFallbackSuccessCount := getMetricCount(libpack_monitoring.MetricsCircuitFallbackSuccess)
initialCacheHitCount := getMetricCount(libpack_monitoring.MetricsCacheHit)
// Simulate a proxy request that would hit the circuit breaker
err := performProxyRequest(ctx, "http://test-endpoint.example")
// The request should succeed since we have a cached response
assert.NoError(suite.T(), err, "Request should succeed with cached fallback")
// Verify cached response was served
assert.Equal(suite.T(), string(cachedResponse), string(ctx.Response().Body()),
"Response should match cached value")
assert.Equal(suite.T(), fiber.StatusOK, ctx.Response().StatusCode(),
"Status code should be 200 OK")
// Verify metrics were incremented
newFallbackSuccessCount := getMetricCount(libpack_monitoring.MetricsCircuitFallbackSuccess)
newCacheHitCount := getMetricCount(libpack_monitoring.MetricsCacheHit)
assert.True(suite.T(), newFallbackSuccessCount > initialFallbackSuccessCount,
"Circuit fallback success metric should be incremented")
assert.True(suite.T(), newCacheHitCount > initialCacheHitCount,
"Cache hit metric should be incremented")
// Verify log messages
assert.True(suite.T(), suite.logContains("Circuit open - serving from cache"),
"Log should indicate serving from cache")
}
// TestCircuitBreakerNoCacheFallback tests the case where the circuit is open but
// no cached response is available
func (suite *CircuitBreakerTestSuite) TestCircuitBreakerNoCacheFallback() {
// Reset the buffer before the test
suite.outputBuffer.Reset()
// Initialize circuit breaker with cache fallback enabled
cfg.CircuitBreaker.MaxFailures = 3
cfg.CircuitBreaker.Timeout = 5
cfg.CircuitBreaker.ReturnCachedOnOpen = true
initCircuitBreaker(cfg)
// Create a test fiber app and context
app := fiber.New()
requestCtx := &fasthttp.RequestCtx{}
requestCtx.Request.SetRequestURI("/test-path-no-cache")
requestCtx.Request.Header.SetMethod("POST")
requestCtx.Request.Header.SetContentType("application/json")
requestCtx.Request.SetBody([]byte(`{"query": "query { testNoCache }"}`))
ctx := app.AcquireCtx(requestCtx)
defer app.ReleaseCtx(ctx)
// Trip the circuit by generating failures
testErr := errors.New("test error")
for i := 0; i < cfg.CircuitBreaker.MaxFailures; i++ {
_, err := cb.Execute(func() (any, error) {
return nil, testErr
})
assert.Error(suite.T(), err, "Execute should return error")
}
// Verify circuit is now open
assert.Equal(suite.T(), gobreaker.StateOpen.String(), cb.State().String(), "Circuit should be open after failures")
// Prepare to monitor metric increments for fallback failure
initialFallbackFailedCount := getMetricCount(libpack_monitoring.MetricsCircuitFallbackFailed)
// Simulate a proxy request that would hit the circuit breaker
err := performProxyRequest(ctx, "http://test-endpoint.example")
// The request should fail with ErrCircuitOpen
assert.Error(suite.T(), err, "Request should fail without cached fallback")
assert.Equal(suite.T(), ErrCircuitOpen.Error(), err.Error(), "Error should be ErrCircuitOpen")
// Verify metrics were incremented
newFallbackFailedCount := getMetricCount(libpack_monitoring.MetricsCircuitFallbackFailed)
assert.True(suite.T(), newFallbackFailedCount > initialFallbackFailedCount,
"Circuit fallback failed metric should be incremented")
// Verify log messages
assert.True(suite.T(), suite.logContains("Circuit open - no cached response available"),
"Log should indicate no cache available")
}
// TestCacheDisabledFallback tests that when ReturnCachedOnOpen is false,
// no cache lookup is attempted
func (suite *CircuitBreakerTestSuite) TestCacheDisabledFallback() {
// Reset the buffer before the test
suite.outputBuffer.Reset()
// Initialize circuit breaker with cache fallback disabled
cfg.CircuitBreaker.MaxFailures = 3
cfg.CircuitBreaker.Timeout = 5
cfg.CircuitBreaker.ReturnCachedOnOpen = false
initCircuitBreaker(cfg)
// Create a test fiber app and context
app := fiber.New()
requestCtx := &fasthttp.RequestCtx{}
requestCtx.Request.SetRequestURI("/test-path-cache-disabled")
requestCtx.Request.Header.SetMethod("POST")
requestCtx.Request.Header.SetContentType("application/json")
requestCtx.Request.SetBody([]byte(`{"query": "query { testCacheDisabled }"}`))
ctx := app.AcquireCtx(requestCtx)
defer app.ReleaseCtx(ctx)
// Calculate cache key and store a response (with default user context since no auth headers)
// extractUserInfo() returns ("-", "-") when no auth is present
cacheKey := libpack_cache.CalculateHash(ctx, "-", "-")
cachedResponse := []byte(`{"data":{"test":"cached-response"}}`)
libpack_cache.CacheStore(cacheKey, cachedResponse)
// Trip the circuit by generating failures
testErr := errors.New("test error")
for i := 0; i < cfg.CircuitBreaker.MaxFailures; i++ {
_, err := cb.Execute(func() (any, error) {
return nil, testErr
})
assert.Error(suite.T(), err, "Execute should return error")
}
// Verify circuit is now open
assert.Equal(suite.T(), gobreaker.StateOpen.String(), cb.State().String(), "Circuit should be open")
// Simulate a proxy request that would hit the circuit breaker
err := performProxyRequest(ctx, "http://test-endpoint.example")
// The request should fail with ErrOpenState, not attempt cache fallback
assert.Error(suite.T(), err, "Request should fail when circuit is open and fallback disabled")
assert.Equal(suite.T(), gobreaker.ErrOpenState.Error(), err.Error(), "Error should be ErrOpenState")
// Verify no cache-related logs were generated
assert.False(suite.T(), suite.logContains("Circuit open - serving from cache"),
"Log should not indicate serving from cache")
assert.False(suite.T(), suite.logContains("Circuit open - no cached response available"),
"Log should not indicate attempting cache lookup")
}
// Helper function to get current metric count value
func getMetricCount(metricName string) int {
counter := cfg.Monitoring.RegisterMetricsCounter(metricName, nil)
if counter == nil {
return 0
}
// Convert the counter value to int for easier comparison
return int(counter.Get())
}
-81
View File
@@ -1,81 +0,0 @@
package main
import (
"sync"
"sync/atomic"
"github.com/VictoriaMetrics/metrics"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
)
// CircuitBreakerMetrics manages circuit breaker metrics without recreating gauges
type CircuitBreakerMetrics struct {
stateValue atomic.Value // stores float64
stateGauge *metrics.Gauge
failCountersMu sync.RWMutex
failCounters map[string]*metrics.Counter
}
// NewCircuitBreakerMetrics creates a new circuit breaker metrics manager
func NewCircuitBreakerMetrics(monitoring *libpack_monitoring.MetricsSetup) *CircuitBreakerMetrics {
cbm := &CircuitBreakerMetrics{
failCounters: make(map[string]*metrics.Counter),
}
// Initialize state value
cbm.stateValue.Store(float64(0))
// Create gauge with callback that reads the atomic value on every scrape
// This ensures the metric always reflects the current circuit breaker state
cbm.stateGauge = monitoring.RegisterMetricsGaugeFunc(
libpack_monitoring.MetricsCircuitState,
nil,
func() float64 {
return cbm.GetState()
},
)
return cbm
}
// UpdateState updates the circuit breaker state value atomically
func (cbm *CircuitBreakerMetrics) UpdateState(state float64) {
cbm.stateValue.Store(state)
}
// GetState returns the current circuit breaker state value
func (cbm *CircuitBreakerMetrics) GetState() float64 {
if val := cbm.stateValue.Load(); val != nil {
return val.(float64)
}
return 0
}
// GetOrCreateFailCounter returns a counter for the given state key
func (cbm *CircuitBreakerMetrics) GetOrCreateFailCounter(monitoring *libpack_monitoring.MetricsSetup, stateKey string) *metrics.Counter {
cbm.failCountersMu.RLock()
counter, exists := cbm.failCounters[stateKey]
cbm.failCountersMu.RUnlock()
if exists {
return counter
}
cbm.failCountersMu.Lock()
defer cbm.failCountersMu.Unlock()
if counter, exists := cbm.failCounters[stateKey]; exists {
return counter
}
counter = monitoring.RegisterMetricsCounter(stateKey, nil)
cbm.failCounters[stateKey] = counter
return counter
}
// Global circuit breaker metrics instance
var cbMetrics *CircuitBreakerMetrics
// InitializeCircuitBreakerMetrics initializes the global circuit breaker metrics
func InitializeCircuitBreakerMetrics(monitoring *libpack_monitoring.MetricsSetup) {
if cbMetrics == nil {
cbMetrics = NewCircuitBreakerMetrics(monitoring)
}
}
-44
View File
@@ -1,44 +0,0 @@
package main
import (
"bytes"
"testing"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/require"
)
// TestInitCircuitBreaker_NilMonitoring_NoPanic is a regression test for a boot
// panic: enabling the circuit breaker (ENABLE_CIRCUIT_BREAKER=true) crashed at
// startup because parseConfig calls initCircuitBreaker before the monitoring
// server assigns cfg.Monitoring (StartMonitoringServer runs later). The metrics
// gauge registration then dereferenced a nil *MetricsSetup.
//
// The breaker (and the admin dashboard, which reads gobreaker state directly)
// must initialise without panicking even when monitoring is not yet available.
func TestInitCircuitBreaker_NilMonitoring_NoPanic(t *testing.T) {
origCfg := cfg
cbMutex.Lock()
origCb, origMetrics := cb, cbMetrics
cb, cbMetrics = nil, nil
cbMutex.Unlock()
t.Cleanup(func() {
cbMutex.Lock()
cb, cbMetrics = origCb, origMetrics
cbMutex.Unlock()
cfg = origCfg
})
cfg = &config{}
cfg.Logger = libpack_logger.New().SetOutput(&bytes.Buffer{})
cfg.Monitoring = nil // the production state when parseConfig runs
cfg.CircuitBreaker.Enable = true
cfg.CircuitBreaker.MaxFailures = 3
cfg.CircuitBreaker.Timeout = 5
cfg.CircuitBreaker.MaxRequestsInHalfOpen = 2
require.NotPanics(t, func() { initCircuitBreaker(cfg) },
"initCircuitBreaker must not panic when cfg.Monitoring is nil")
require.NotNil(t, cb, "circuit breaker must initialise even without monitoring")
require.NotNil(t, cbMetrics, "circuit breaker metrics manager must be created")
}
-143
View File
@@ -1,143 +0,0 @@
package main
import (
"errors"
"time"
"github.com/sony/gobreaker"
"github.com/stretchr/testify/assert"
)
// TestCircuitBreakerStateTransitions tests the circuit breaker state transitions:
// Closed -> Open -> Half-Open -> Closed/Open
func (suite *CircuitBreakerTestSuite) TestCircuitBreakerStateTransitions() {
// Reset the buffer before the test
suite.outputBuffer.Reset()
// Initialize circuit breaker with a shorter timeout for testing
cfg.CircuitBreaker.Timeout = 1 // 1 second timeout to half-open state
cfg.CircuitBreaker.MaxFailures = 3
initCircuitBreaker(cfg)
// 1. Initially the circuit should be closed
assert.Equal(suite.T(), gobreaker.StateClosed.String(), cb.State().String(), "Circuit should start in closed state")
// 2. Generate failures to trip the circuit
testErr := errors.New("test error")
for i := 0; i < cfg.CircuitBreaker.MaxFailures; i++ {
_, err := cb.Execute(func() (any, error) {
return nil, testErr
})
assert.Error(suite.T(), err, "Execute should return error")
}
// 3. Circuit should now be open
assert.Equal(suite.T(), gobreaker.StateOpen.String(), cb.State().String(), "Circuit should transition to open state after failures")
// Verify that requests are rejected during open state
_, err := cb.Execute(func() (any, error) {
return "success", nil
})
assert.Equal(suite.T(), gobreaker.ErrOpenState.Error(), err.Error(), "Should return ErrOpenState when circuit is open")
// Verify that the state change was logged
assert.True(suite.T(), suite.logContains("Circuit breaker state changed"),
"State change should be logged")
assert.True(suite.T(), suite.logContains(`"from":"closed"`),
"Log should mention transition from closed state")
assert.True(suite.T(), suite.logContains(`"to":"open"`),
"Log should mention transition to open state")
// 4. Wait for timeout to allow transition to half-open
time.Sleep(time.Duration(cfg.CircuitBreaker.Timeout+1) * time.Second)
// The next request should transition the circuit to half-open
// (Sony's gobreaker transitions to half-open on the next request after timeout)
tmpState := cb.State()
// Execute a successful request to check state
_, _ = cb.Execute(func() (any, error) {
return "success", nil
})
// 5. Verify half-open state was reached
suite.T().Logf("Current circuit state: %s", cb.State())
if tmpState.String() != gobreaker.StateHalfOpen.String() {
suite.T().Skip("Circuit didn't transition to half-open as expected, likely due to timing issues in test environment")
}
// Verify the state change was logged
assert.True(suite.T(), suite.logContains(`"from":"open"`),
"Log should mention transition from open state")
assert.True(suite.T(), suite.logContains(`"to":"half-open"`),
"Log should mention transition to half-open state")
// 6. Execute successful requests in half-open state to transition back to closed
for i := 0; i < cfg.CircuitBreaker.MaxRequestsInHalfOpen; i++ {
_, err = cb.Execute(func() (any, error) {
return "success", nil
})
assert.NoError(suite.T(), err, "Execute should not return error")
}
// 7. Circuit should now be closed again
assert.Equal(suite.T(), gobreaker.StateClosed.String(), cb.State().String(), "Circuit should transition to closed state after successes")
// Verify the final state change was logged
assert.True(suite.T(), suite.logContains(`"from":"half-open"`),
"Log should mention transition from half-open state")
assert.True(suite.T(), suite.logContains(`"to":"closed"`),
"Log should mention transition to closed state")
}
// TestCircuitBreakerHalfOpenToOpen tests that the circuit transitions from half-open to open
// when failures occur during half-open state
func (suite *CircuitBreakerTestSuite) TestCircuitBreakerHalfOpenToOpen() {
// Reset the buffer before the test
suite.outputBuffer.Reset()
// Initialize circuit breaker with a shorter timeout for testing
cfg.CircuitBreaker.Timeout = 1 // 1 second timeout to half-open state
cfg.CircuitBreaker.MaxFailures = 3
cfg.CircuitBreaker.MaxRequestsInHalfOpen = 2
initCircuitBreaker(cfg)
// 1. Generate failures to trip the circuit
testErr := errors.New("test error")
for i := 0; i < cfg.CircuitBreaker.MaxFailures; i++ {
_, err := cb.Execute(func() (any, error) {
return nil, testErr
})
assert.Error(suite.T(), err, "Execute should return error")
}
// 2. Circuit should now be open
assert.Equal(suite.T(), gobreaker.StateOpen.String(), cb.State().String(), "Circuit should be open after failures")
// 3. Wait for timeout to allow transition to half-open
time.Sleep(time.Duration(cfg.CircuitBreaker.Timeout+1) * time.Second)
// The next request should transition the circuit to half-open
tmpState := cb.State()
// Try a request that will fail
_, _ = cb.Execute(func() (any, error) {
return nil, testErr
})
// 4. If we successfully reached half-open state, verify it transitions back to open after failure
if tmpState.String() == gobreaker.StateHalfOpen.String() {
assert.Equal(suite.T(), gobreaker.StateOpen.String(), cb.State().String(),
"Circuit should transition back to open state after failure in half-open")
// Verify the state changes were logged
assert.True(suite.T(), suite.logContains(`"from":"open"`),
"Log should mention transition from open state")
assert.True(suite.T(), suite.logContains(`"to":"half-open"`),
"Log should mention transition to half-open state")
assert.True(suite.T(), suite.logContains(`"from":"half-open"`),
"Log should mention transition from half-open state")
assert.True(suite.T(), suite.logContains(`"to":"open"`),
"Log should mention transition back to open state")
} else {
suite.T().Skip("Circuit didn't transition to half-open as expected, likely due to timing issues in test environment")
}
}
-740
View File
@@ -1,740 +0,0 @@
package main
import (
"bytes"
"errors"
"fmt"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
"github.com/gofiber/fiber/v3"
libpack_cache "github.com/lukaszraczylo/graphql-monitoring-proxy/cache"
libpack_cache_memory "github.com/lukaszraczylo/graphql-monitoring-proxy/cache/memory"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
"github.com/sony/gobreaker"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
"github.com/valyala/fasthttp"
)
// CircuitBreakerTestSuite is a test suite for circuit breaker functionality
type CircuitBreakerTestSuite struct {
suite.Suite
originalConfig *config
outputBuffer *bytes.Buffer // Used to capture logger output
}
func (suite *CircuitBreakerTestSuite) SetupTest() {
// Store original config to restore later
suite.originalConfig = cfg
// Create a buffer to capture logger output
suite.outputBuffer = &bytes.Buffer{}
// Setup a new config with a real logger that writes to our buffer
cfg = &config{}
cfg.Logger = libpack_logger.New().SetOutput(suite.outputBuffer)
// Initialize monitoring with a minimal configuration
cfg.Monitoring = libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{
PurgeOnCrawl: false,
PurgeEvery: 0,
})
// Configure circuit breaker settings
cfg.CircuitBreaker.Enable = true
cfg.CircuitBreaker.MaxFailures = 3
cfg.CircuitBreaker.Timeout = 5
cfg.CircuitBreaker.MaxRequestsInHalfOpen = 2
cfg.CircuitBreaker.ReturnCachedOnOpen = true
cfg.CircuitBreaker.TripOn5xx = true
// Initialize memory cache
memCache := libpack_cache_memory.New(time.Minute)
cacheConfig := &libpack_cache.CacheConfig{
Logger: cfg.Logger,
Client: memCache,
TTL: 60,
}
libpack_cache.EnableCache(cacheConfig)
}
func (suite *CircuitBreakerTestSuite) TearDownTest() {
// Restore original config
cfg = suite.originalConfig
// Reset circuit breaker and metrics
cbMutex.Lock()
defer cbMutex.Unlock()
cb = nil
// Circuit breaker metrics are now managed by cbMetrics
cbMetrics = nil
// Reset the C7 progressive-backoff tracker so a trip count/timestamp
// from one test can't leak into the next.
cbBackoff.reset()
}
// Helper function to check if a specific message appears in the logger output
func (suite *CircuitBreakerTestSuite) logContains(substring string) bool {
return strings.Contains(suite.outputBuffer.String(), substring)
}
// TestCreateTripFunc tests the circuit breaker trip function logic
func (suite *CircuitBreakerTestSuite) TestCreateTripFunc() {
// Create the trip function
tripFunc := createTripFunc(cfg)
// Test cases
testCases := []struct {
name string
counts gobreaker.Counts
expectedResult bool
}{
{
name: "below threshold",
counts: gobreaker.Counts{
Requests: 10,
TotalSuccesses: 8,
TotalFailures: 2,
ConsecutiveSuccesses: 0,
ConsecutiveFailures: 2, // Below MaxFailures (3)
},
expectedResult: false,
},
{
name: "at threshold",
counts: gobreaker.Counts{
Requests: 10,
TotalSuccesses: 7,
TotalFailures: 3,
ConsecutiveSuccesses: 0,
ConsecutiveFailures: 3, // Equal to MaxFailures (3)
},
expectedResult: true,
},
{
name: "above threshold",
counts: gobreaker.Counts{
Requests: 10,
TotalSuccesses: 5,
TotalFailures: 5,
ConsecutiveSuccesses: 0,
ConsecutiveFailures: 5, // Above MaxFailures (3)
},
expectedResult: true,
},
}
for _, tc := range testCases {
suite.Run(tc.name, func() {
// Reset the buffer before each test case
suite.outputBuffer.Reset()
// Test the trip function
result := tripFunc(tc.counts)
suite.Equal(tc.expectedResult, result, "Trip function result should match expected")
// If it should trip, verify that a warning log was generated
if tc.expectedResult {
suite.True(suite.logContains("Circuit breaker tripped"),
"Expected a warning log when circuit breaker trips")
suite.True(suite.logContains(fmt.Sprintf(`"consecutive_failures":%d`, tc.counts.ConsecutiveFailures)),
"Log should contain consecutive failures count")
}
})
}
}
// TestCreateStateChangeFunc tests the state change function logic
func (suite *CircuitBreakerTestSuite) TestCreateStateChangeFunc() {
// We'll skip this test as it's problematic with the gauge callback issue
suite.T().Skip("Skipping due to gauge callback issues")
}
// TestCircuitBreakerInitialization tests the circuit breaker initialization
func (suite *CircuitBreakerTestSuite) TestCircuitBreakerInitialization() {
// Reset the buffer before the test
suite.outputBuffer.Reset()
// Initialize circuit breaker
initCircuitBreaker(cfg)
// Verify circuit breaker was initialized
suite.NotNil(cb, "Circuit breaker should be initialized")
suite.NotNil(cbMetrics, "Circuit breaker metrics should be initialized")
// Verify the log message
suite.True(suite.logContains("Circuit breaker initialized"),
"Log should contain initialization message")
// Test with disabled circuit breaker
suite.outputBuffer.Reset()
cfg.CircuitBreaker.Enable = false
// Reset circuit breaker
cbMutex.Lock()
cb = nil
cbMetrics = nil
cbMutex.Unlock()
// Initialize again with disabled config
initCircuitBreaker(cfg)
// Verify circuit breaker was not initialized
suite.Nil(cb, "Circuit breaker should not be initialized when disabled")
// Verify the log message
suite.True(suite.logContains("Circuit breaker is disabled"),
"Log should contain disabled message")
}
// TestExecuteFunctionBehavior tests the basic behavior of Execute without circuit breaker
func (suite *CircuitBreakerTestSuite) TestExecuteFunctionBehavior() {
// Reset for this test
cfg.CircuitBreaker.Enable = true
initCircuitBreaker(cfg)
// Test with success
result := "success"
execResult, err := cb.Execute(func() (any, error) {
return result, nil
})
suite.NoError(err, "Execute should not return error on success")
suite.Equal(result, execResult, "Execute should return the correct result value")
// Test with error
testErr := errors.New("test error")
_, err = cb.Execute(func() (any, error) {
return nil, testErr
})
suite.Error(err, "Execute should return error when function returns error")
suite.Equal(testErr.Error(), err.Error(), "Error message should match")
}
// TestClassifyCircuitFailure is a pure-function table test for the C5/C6
// gating logic: whether a proxy failure counts toward the circuit
// breaker's failure statistics is gated by the matching
// CIRCUIT_TRIP_ON_TIMEOUTS / CIRCUIT_TRIP_ON_4XX / CIRCUIT_TRIP_ON_5XX flag.
// Any other failure kind (e.g. a connection error) has no dedicated flag
// and always counts, regardless of flag values -- that's the pre-fix
// baseline (flags were parsed but never enforced) this preserves.
func TestClassifyCircuitFailure(t *testing.T) {
tests := []struct {
name string
err error
statusCode int
tripOnTimeouts bool
tripOn4xx bool
tripOn5xx bool
wantCounts bool
}{
{
name: "timeout counts when TripOnTimeouts=true (library default)",
err: errors.New("timeout"),
tripOnTimeouts: true,
wantCounts: true,
},
{
name: "timeout does not count when TripOnTimeouts=false",
err: errors.New("timeout"),
tripOnTimeouts: false,
wantCounts: false,
},
{
name: "5xx counts when TripOn5xx=true (library default)",
err: fmt.Errorf("received non-200 response: %d", 500),
statusCode: 500,
tripOn5xx: true,
wantCounts: true,
},
{
name: "5xx does not count when TripOn5xx=false",
err: fmt.Errorf("received non-200 response: %d", 503),
statusCode: 503,
tripOn5xx: false,
wantCounts: false,
},
{
name: "4xx counts when TripOn4xx=true",
err: fmt.Errorf("received non-200 response: %d", 404),
statusCode: 404,
tripOn4xx: true,
wantCounts: true,
},
{
name: "4xx does not count when TripOn4xx=false (library default)",
err: fmt.Errorf("received non-200 response: %d", 400),
statusCode: 400,
tripOn4xx: false,
wantCounts: false,
},
{
name: "connection error always counts, regardless of any flag",
err: errors.New("connection refused"),
statusCode: 0,
wantCounts: true,
},
{
name: "nil fiber context error always counts, regardless of any flag",
err: errFiberCtxNilDuringRetry,
statusCode: 0,
wantCounts: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
testCfg := &config{}
testCfg.CircuitBreaker.TripOnTimeouts = tt.tripOnTimeouts
testCfg.CircuitBreaker.TripOn4xx = tt.tripOn4xx
testCfg.CircuitBreaker.TripOn5xx = tt.tripOn5xx
got := classifyCircuitFailure(testCfg, tt.err, tt.statusCode)
assert.Equal(t, tt.wantCounts, got)
})
}
}
// TestCircuitBreakerIsSuccessful checks the gobreaker Settings.IsSuccessful
// hook directly: a nil error is success, a *circuitBreakerOutcome defers to
// its pre-computed verdict, and any other non-nil error (one that never
// went through performProxyRequestCore's classification) is a failure --
// matching gobreaker's own default.
func TestCircuitBreakerIsSuccessful(t *testing.T) {
assert.True(t, circuitBreakerIsSuccessful(nil))
assert.False(t, circuitBreakerIsSuccessful(errors.New("boom")))
assert.False(t, circuitBreakerIsSuccessful(&circuitBreakerOutcome{err: errors.New("boom"), countsAsFailure: true}))
assert.True(t, circuitBreakerIsSuccessful(&circuitBreakerOutcome{err: errors.New("boom"), countsAsFailure: false}))
// Wrapping must not defeat classification.
wrapped := fmt.Errorf("outer: %w", &circuitBreakerOutcome{err: errors.New("boom"), countsAsFailure: false})
assert.True(t, circuitBreakerIsSuccessful(wrapped))
}
// TestCircuitBreakerFlagGatingIntegration exercises the full
// performProxyRequest path (not just the pure classifier) for the two
// fast, non-retried outcome kinds -- 4xx and timeout -- confirming both
// halves of the C5/C6 contract: (1) the client-visible result is an error
// either way (only the breaker bookkeeping differs), and (2) the circuit
// only trips when the matching CIRCUIT_TRIP_ON_* flag is true. The 5xx
// case is covered by TestClassifyCircuitFailure above and by
// TestCachingAndCircuitBreakerInteraction (integration_test.go); an
// end-to-end flag-gated 5xx test would additionally need to wait out the
// full 7-attempt retry backoff (~25s per request), which isn't worth the
// wall-clock cost here.
func (suite *CircuitBreakerTestSuite) TestCircuitBreakerFlagGatingIntegration() {
runOnce := func(server *httptest.Server) error {
app := fiber.New()
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.SetContentType("application/json")
reqCtx.Request.SetBody([]byte(`{"query":"query { test }"}`))
ctx := app.AcquireCtx(reqCtx)
defer app.ReleaseCtx(ctx)
return performProxyRequest(ctx, server.URL)
}
suite.Run("4xx", func() {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusBadRequest)
_, _ = w.Write([]byte(`{"errors":[{"message":"bad request"}]}`))
}))
defer server.Close()
for _, tripOn4xx := range []bool{true, false} {
suite.Run(fmt.Sprintf("TripOn4xx=%v", tripOn4xx), func() {
suite.outputBuffer.Reset()
cfg.CircuitBreaker.MaxFailures = 1
cfg.CircuitBreaker.Timeout = 5
cfg.CircuitBreaker.TripOn4xx = tripOn4xx
cfg.CircuitBreaker.ReturnCachedOnOpen = false
cfg.Client.ClientTimeout = 5
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
initCircuitBreaker(cfg)
err := runOnce(server)
assert.Error(suite.T(), err, "client must still see the 4xx failure regardless of the flag")
wantState := gobreaker.StateClosed
if tripOn4xx {
wantState = gobreaker.StateOpen
}
assert.Equal(suite.T(), wantState.String(), cb.State().String(),
"circuit state must match TripOn4xx=%v", tripOn4xx)
})
}
})
suite.Run("timeout", func() {
// Handler sleeps well past the 1s client timeout below so every
// attempt is a genuine client-side timeout, not a race.
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(2 * time.Second)
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{"data":{"ok":true}}`))
}))
defer server.Close()
for _, tripOnTimeouts := range []bool{true, false} {
suite.Run(fmt.Sprintf("TripOnTimeouts=%v", tripOnTimeouts), func() {
suite.outputBuffer.Reset()
cfg.CircuitBreaker.MaxFailures = 1
cfg.CircuitBreaker.Timeout = 5
cfg.CircuitBreaker.TripOnTimeouts = tripOnTimeouts
cfg.CircuitBreaker.ReturnCachedOnOpen = false
cfg.Client.ClientTimeout = 1
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
initCircuitBreaker(cfg)
err := runOnce(server)
assert.Error(suite.T(), err, "client must still see the timeout failure regardless of the flag")
wantState := gobreaker.StateClosed
if tripOnTimeouts {
wantState = gobreaker.StateOpen
}
assert.Equal(suite.T(), wantState.String(), cb.State().String(),
"circuit state must match TripOnTimeouts=%v", tripOnTimeouts)
})
}
})
}
// TestCircuitBreakerFailureRatioWindow covers the C12 fix: with
// Settings.Interval left at 0 (the pre-fix default), gobreaker never clears
// Counts while closed, so CIRCUIT_FAILURE_RATIO becomes lifetime-cumulative
// -- once enough historical successes have piled up, no realistic burst of
// new failures can move the ratio again. This test shrinks
// circuitBreakerCountWindow to a fraction of a second (restored via
// t.Cleanup) so the window boundary can be observed without sleeping for
// the real 60s default, then shows: (1) Counts actually reset for a new
// generation once the window elapses, instead of accumulating forever, and
// (2) a fresh in-window failure burst can trip the ratio check purely on
// its own -- which a lifetime-cumulative ratio, diluted by an earlier
// batch of successes, would not allow.
func (suite *CircuitBreakerTestSuite) TestCircuitBreakerFailureRatioWindow() {
originalWindow := circuitBreakerCountWindow
circuitBreakerCountWindow = 150 * time.Millisecond
suite.T().Cleanup(func() { circuitBreakerCountWindow = originalWindow })
// Disable the consecutive-failures trip path so only FailureRatio can
// trip the breaker in this test; the circuit stays closed throughout.
cfg.CircuitBreaker.MaxFailures = 1000
cfg.CircuitBreaker.FailureRatio = 0.5
cfg.CircuitBreaker.SampleSize = 4
cfg.CircuitBreaker.Timeout = 5
initCircuitBreaker(cfg)
require := suite.Require()
testErr := errors.New("test error")
execute := func(fail bool) {
_, _ = cb.Execute(func() (any, error) {
if fail {
return nil, testErr
}
return "ok", nil
})
}
// Phase 1: a batch of mostly-successful requests with one failure --
// well under the 50% ratio, so it must not trip, but it does
// accumulate Requests/TotalFailures in Counts.
for i := 0; i < 10; i++ {
execute(false)
}
execute(true)
require.Equal(gobreaker.StateClosed.String(), cb.State().String(), "low ratio must not trip")
require.Equal(uint32(11), cb.Counts().Requests, "phase 1 requests should be counted")
// Wait past the (shrunk) window. gobreaker clears Counts lazily, on
// the next request, once Interval has elapsed while closed.
time.Sleep(circuitBreakerCountWindow + 100*time.Millisecond)
// This request both triggers the lazy clear and starts the new
// generation's Counts.
execute(false)
assert.Equal(suite.T(), uint32(1), cb.Counts().Requests,
"Counts must reset for the new window instead of accumulating across it (lifetime-cumulative regression)")
// Phase 2: within the fresh window, a small failure burst alone (2
// successes + 2 failures = 50% ratio, matching SampleSize) is enough to
// trip. Under the pre-fix lifetime-cumulative behaviour, phase 1's 10
// successes would still be diluting the ratio (13 requests, 3 failures
// = 23%) and this burst alone would not trip the circuit.
execute(false)
execute(true)
execute(true)
assert.Equal(suite.T(), gobreaker.StateOpen.String(), cb.State().String(),
"a fresh in-window failure burst must be able to trip the ratio check on its own")
}
// TestCircuitBackoffResetsOnSuccessfulRecovery is a suite method (needs
// cfg.Logger from SetupTest, which createStateChangeFunc's logging calls
// into) that exercises the C7 OnStateChange wiring end-to-end against a
// real *gobreaker.CircuitBreaker: consecutiveTrips increments on Closed ->
// Open, and resets to 0 exactly on the eventual HalfOpen -> Closed
// transition (a successful recovery).
//
// This breaker is constructed directly (bypassing initCircuitBreaker, whose
// Settings.Timeout only accepts whole seconds via cfg.CircuitBreaker.Timeout)
// with a deliberately tiny real Timeout so the Open -> HalfOpen -> Closed
// sequence completes after a bounded few-millisecond sleep -- gobreaker's
// own clock is not injectable, so some real wait is unavoidable to advance
// it. That sleep only advances gobreaker's OWN internal timeout to exercise
// the OnStateChange plumbing; it is unrelated to, and far shorter than, the
// C7 multiplier-scaled backoff window itself, which is verified
// deterministically (via injected trip counts and an injected `now`, no
// sleeping) by TestCircuitBackoffGateBlocks and
// TestCircuitBackoffLongerClosedDoorWithHigherMultiplier below.
func (suite *CircuitBreakerTestSuite) TestCircuitBackoffResetsOnSuccessfulRecovery() {
cbMutex.Lock()
cbBackoff.reset()
cb = gobreaker.NewCircuitBreaker(gobreaker.Settings{
Name: "recovery-test",
MaxRequests: 1,
Timeout: 5 * time.Millisecond,
ReadyToTrip: func(counts gobreaker.Counts) bool { return counts.ConsecutiveFailures >= 1 },
OnStateChange: createStateChangeFunc(cfg),
IsSuccessful: circuitBreakerIsSuccessful,
})
cbMutex.Unlock()
require := suite.Require()
require.Equal(int64(0), cbBackoff.trips(), "fresh breaker must start with zero trips")
// Closed -> Open: a single failure trips it immediately, no timing
// dependency at all.
_, _ = cb.Execute(func() (any, error) {
return nil, &circuitBreakerOutcome{err: errors.New("boom"), countsAsFailure: true}
})
require.Equal(gobreaker.StateOpen.String(), cb.State().String(), "one failure must trip the breaker")
require.Equal(int64(1), cbBackoff.trips(), "the trip must be recorded")
require.False(cbBackoff.lastTrip().IsZero(), "lastTrip must be stamped")
// Wait past gobreaker's own (tiny) Timeout so the next call observes the
// lazy Open -> HalfOpen transition, then succeed to close it.
time.Sleep(15 * time.Millisecond)
_, err := cb.Execute(func() (any, error) { return "ok", nil })
suite.NoError(err, "the half-open probe must succeed")
suite.Equal(gobreaker.StateClosed.String(), cb.State().String(), "a successful probe must close the breaker")
suite.Equal(int64(0), cbBackoff.trips(), "trip count must reset to 0 after a successful recovery to Closed")
}
// TestEffectiveCircuitBackoff is a pure-function table test of the C7
// backoff formula: effective = base * multiplier^(trips-1), capped at
// maxBackoff. It is the primary proof of default-preservation: with the
// default BackoffMultiplier=1.0, effective must equal base exactly, for
// every trip count, with no dependency on wall-clock or a live breaker.
func TestEffectiveCircuitBackoff(t *testing.T) {
const base = 10 * time.Second
t.Run("multiplier=1 (default) is constant=base for any trip count", func(t *testing.T) {
for _, trips := range []int64{0, 1, 2, 5, 100} {
got := effectiveCircuitBackoff(base, 1.0, 0, trips)
assert.Equal(t, base, got, "trips=%d must equal base exactly under the default multiplier", trips)
}
})
t.Run("multiplier=2 compounds from the second trip, capped at maxBackoff", func(t *testing.T) {
const maxBackoff = 100 * time.Second
tests := []struct {
trips int64
want time.Duration
}{
{trips: 0, want: base}, // defensive: never tripped
{trips: 1, want: base}, // first trip: exponent 0 -> multiplier^0=1
{trips: 2, want: 2 * base}, // exponent 1
{trips: 3, want: 4 * base}, // exponent 2
{trips: 4, want: 8 * base}, // exponent 3, still under the 100s cap
{trips: 5, want: maxBackoff}, // exponent 4 -> 16*base=160s, capped at 100s
}
for _, tt := range tests {
got := effectiveCircuitBackoff(base, 2.0, maxBackoff, tt.trips)
assert.Equal(t, tt.want, got, "trips=%d", tt.trips)
}
})
t.Run("maxBackoff<=0 means uncapped", func(t *testing.T) {
got := effectiveCircuitBackoff(base, 2.0, 0, 6) // exponent 5 -> 32*base
assert.Equal(t, 32*base, got)
})
t.Run("maxBackoff<=0 with a high trip count is still bounded by the sanity ceiling", func(t *testing.T) {
// finding C-overflow: CIRCUIT_MAX_BACKOFF_TIMEOUT=0 (uncapped) plus a
// high enough consecutive-trip count makes
// base*multiplier^(trips-1) overflow math.Pow's float64 arithmetic
// (or the subsequent float64->time.Duration conversion) into a
// huge-but-still-positive Duration -- on this platform the
// out-of-range conversion saturates to math.MaxInt64 nanoseconds
// (~292 years), which is NOT less than base, so the pre-existing
// "effective < base" underflow guard alone does not catch it. The
// hard ceiling must, regardless of trip count.
got := effectiveCircuitBackoff(base, 2.0, 0, 1000)
assert.Equal(t, maxSaneCircuitBackoff, got, "an uncapped config must never exceed the hard sanity ceiling")
assert.LessOrEqual(t, got, maxSaneCircuitBackoff)
})
t.Run("misconfigured multiplier<1 is clamped to 1, never shrinks below base", func(t *testing.T) {
got := effectiveCircuitBackoff(base, 0.5, 0, 3)
assert.Equal(t, base, got)
})
t.Run("misconfigured maxBackoff below base never shrinks below base", func(t *testing.T) {
got := effectiveCircuitBackoff(base, 2.0, 1*time.Second, 3)
assert.Equal(t, base, got)
})
}
// TestCircuitBackoffGateBlocks is a deterministic table test of
// circuitBackoffGateBlocks: trip count and elapsed time are both injected
// (via repeated cbBackoff.recordTrip calls and an explicit `now` parameter)
// rather than produced by sleeping, so the pass/fail boundary is exact and
// cannot flake. The breaker passed in is a freshly constructed, never-
// tripped *gobreaker.CircuitBreaker (State()==Closed) -- circuitBackoffGateBlocks
// only cares that breaker.State() != StateOpen, which a fresh breaker
// satisfies trivially without needing to wait out any real timeout.
func TestCircuitBackoffGateBlocks(t *testing.T) {
t.Cleanup(func() { cbBackoff.reset() })
const base = 10 * time.Second
tripTime := time.Date(2026, 1, 1, 0, 0, 0, 0, time.UTC)
tests := []struct {
name string
trips int64
multiplier float64
maxBackoff time.Duration
elapsed time.Duration
wantBlock bool
}{
{
name: "never tripped -> never blocks",
trips: 0,
elapsed: 0,
wantBlock: false,
},
{
name: "first trip, multiplier=1, well within base -> blocks",
trips: 1,
multiplier: 1,
elapsed: 1 * time.Second,
wantBlock: true,
},
{
name: "first trip, multiplier=1, base elapsed -> does not block",
trips: 1,
multiplier: 1,
elapsed: base,
wantBlock: false,
},
{
name: "second trip, multiplier=2, base elapsed but effective (2x base) not -> blocks",
trips: 2,
multiplier: 2,
elapsed: base + time.Second,
wantBlock: true,
},
{
name: "second trip, multiplier=2, effective (2x base) elapsed -> does not block",
trips: 2,
multiplier: 2,
elapsed: 2 * base,
wantBlock: false,
},
{
name: "high trip count capped at maxBackoff, still within cap -> blocks",
trips: 10,
multiplier: 2,
maxBackoff: 20 * time.Second,
elapsed: 19 * time.Second,
wantBlock: true,
},
{
name: "high trip count capped at maxBackoff, cap elapsed -> does not block",
trips: 10,
multiplier: 2,
maxBackoff: 20 * time.Second,
elapsed: 20 * time.Second,
wantBlock: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cbBackoff.reset()
for i := int64(0); i < tt.trips; i++ {
// Repeated recordTrip calls model consecutive trips; each
// overwrites lastTripUnixNano, so the final timestamp is
// exactly tripTime regardless of trip count.
cbBackoff.recordTrip(tripTime)
}
testCfg := &config{}
testCfg.CircuitBreaker.Timeout = int(base / time.Second)
testCfg.CircuitBreaker.BackoffMultiplier = tt.multiplier
testCfg.CircuitBreaker.MaxBackoffTimeout = int(tt.maxBackoff / time.Second)
breaker := gobreaker.NewCircuitBreaker(gobreaker.Settings{Name: "gate-test"})
now := tripTime.Add(tt.elapsed)
got := circuitBackoffGateBlocks(testCfg, breaker, now)
assert.Equal(t, tt.wantBlock, got)
})
}
}
// TestCircuitBackoffLongerClosedDoorWithHigherMultiplier directly proves
// the C7 requirement: for the SAME consecutive-trip count and the SAME
// elapsed time since the last trip (both injected, not slept), a higher
// BackoffMultiplier keeps the gate blocking while multiplier=1 (the
// default) has already let go -- i.e. progressive backoff strictly
// lengthens the closed-door window, and the default reproduces today's
// behaviour exactly.
func TestCircuitBackoffLongerClosedDoorWithHigherMultiplier(t *testing.T) {
t.Cleanup(func() { cbBackoff.reset() })
const base = 10 * time.Second
const trips = 3 // third consecutive trip: multiplier exponent = trips-1 = 2
tripTime := time.Date(2026, 1, 1, 0, 0, 0, 0, time.UTC)
// Past base (so a multiplier=1 breaker would already let a probe
// through) but well short of 2^2 * base = 40s.
elapsed := base + time.Second
now := tripTime.Add(elapsed)
seed := func() {
cbBackoff.reset()
for i := 0; i < trips; i++ {
cbBackoff.recordTrip(tripTime)
}
}
cfgDefault := &config{}
cfgDefault.CircuitBreaker.Timeout = int(base / time.Second)
cfgDefault.CircuitBreaker.BackoffMultiplier = 1.0
cfgProgressive := &config{}
cfgProgressive.CircuitBreaker.Timeout = int(base / time.Second)
cfgProgressive.CircuitBreaker.BackoffMultiplier = 2.0
seed()
blockedAtDefault := circuitBackoffGateBlocks(cfgDefault, gobreaker.NewCircuitBreaker(gobreaker.Settings{Name: "default"}), now)
seed()
blockedAtProgressive := circuitBackoffGateBlocks(cfgProgressive, gobreaker.NewCircuitBreaker(gobreaker.Settings{Name: "progressive"}), now)
assert.False(t, blockedAtDefault, "multiplier=1.0 (default): base has already elapsed, gate must match today's behaviour and not block")
assert.True(t, blockedAtProgressive, "multiplier=2.0: effective backoff has not yet elapsed at the same instant, gate must still block -- strictly longer closed-door time than the default")
}
// Start the test suite
func TestCircuitBreakerSuite(t *testing.T) {
suite.Run(t, new(CircuitBreakerTestSuite))
}
-547
View File
@@ -1,547 +0,0 @@
package main
// concerns_test.go — targeted tests for previously-uncovered entry points.
//
// Targets:
// 1. websocket.go HandleWebSocket + IsWebSocketRequest
// 2. admin_dashboard.go handleStatsWebSocket
// 3. api.go periodicallyReloadBannedUsers (inner loadBannedUsers step + loop exit)
// 4. main.go startCacheMemoryMonitoring (ctx-cancellation smoke test)
import (
"context"
"encoding/json"
"net"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"strings"
"testing"
"time"
"github.com/gofiber/contrib/v3/websocket"
"github.com/gofiber/fiber/v3"
gorillaws "github.com/gorilla/websocket"
libpack_cache_mem "github.com/lukaszraczylo/graphql-monitoring-proxy/cache/memory"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// ---------------------------------------------------------------------------
// 1. websocket.go — HandleWebSocket + IsWebSocketRequest
// ---------------------------------------------------------------------------
// TestHandleWebSocket_DisabledReturns501 verifies that a disabled WebSocketProxy
// returns 501 Not Implemented without panicking.
func TestHandleWebSocket_DisabledReturns501(t *testing.T) {
wsp := NewWebSocketProxy("http://127.0.0.1:1", WebSocketConfig{Enabled: false}, libpack_logger.New(), nil)
app := fiber.New()
app.Get("/ws", func(c fiber.Ctx) error {
return wsp.HandleWebSocket(c)
})
req := httptest.NewRequest("GET", "/ws", nil)
req.Header.Set("Upgrade", "websocket")
req.Header.Set("Connection", "Upgrade")
req.Header.Set("Sec-WebSocket-Version", "13")
req.Header.Set("Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ==")
resp, err := app.Test(req, fiber.TestConfig{Timeout: 5000 * time.Millisecond})
require.NoError(t, err)
assert.Equal(t, fiber.StatusNotImplemented, resp.StatusCode)
}
// TestHandleWebSocket_BackendDialFail covers the enabled-but-backend-unreachable
// path. It exercises lines 82–121 (HandleWebSocket / handleConnection) through
// an actual WS upgrade, reads the connection_init, dials the non-existent
// backend on port 1, increments errors, then closes.
func TestHandleWebSocket_BackendDialFail(t *testing.T) {
wsp := NewWebSocketProxy(
"http://127.0.0.1:1", // port 1 = connection refused immediately
WebSocketConfig{Enabled: true, MaxMessageSize: 64 * 1024},
libpack_logger.New(),
nil,
)
app := fiber.New()
app.Get("/ws", websocket.New(func(c *websocket.Conn) {
wsp.handleConnection(context.Background(), c, http.Header{})
}))
ln, err := net.Listen("tcp", "127.0.0.1:0")
require.NoError(t, err)
go func() { _ = app.Listener(ln) }()
t.Cleanup(func() { _ = app.Shutdown() })
conn, _, err := gorillaws.DefaultDialer.Dial("ws://"+ln.Addr().String()+"/ws", nil)
require.NoError(t, err)
defer func() { _ = conn.Close() }()
// Send connection_init — handleConnection reads it, then tries to dial backend
err = conn.WriteMessage(gorillaws.TextMessage, []byte(`{"type":"connection_init","payload":{}}`))
require.NoError(t, err)
// Server closes the conn after dial failure
conn.SetReadDeadline(time.Now().Add(3 * time.Second)) //nolint:errcheck
_, _, readErr := conn.ReadMessage()
assert.Error(t, readErr, "expected conn to be closed by server after backend dial failure")
// Wait briefly for server-side atomics to settle
time.Sleep(50 * time.Millisecond)
assert.GreaterOrEqual(t, wsp.errors.Load(), int64(1), "error counter should be incremented")
assert.Equal(t, int64(1), wsp.totalConnections.Load())
}
// TestIsWebSocketRequest covers both upgrade-header detection paths.
func TestIsWebSocketRequest(t *testing.T) {
tests := []struct {
name string
headers map[string]string
want bool
}{
{
name: "plain GET — not a WS request",
headers: map[string]string{},
want: false,
},
{
name: "Connection: Upgrade only",
headers: map[string]string{"Connection": "Upgrade"},
want: true,
},
{
name: "Upgrade: websocket only",
headers: map[string]string{"Upgrade": "websocket"},
want: true,
},
{
name: "full WS upgrade headers",
headers: map[string]string{
"Upgrade": "websocket",
"Connection": "Upgrade",
"Sec-WebSocket-Version": "13",
"Sec-WebSocket-Key": "dGhlIHNhbXBsZSBub25jZQ==",
},
want: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
app := fiber.New()
var got bool
app.Get("/chk", func(c fiber.Ctx) error {
got = IsWebSocketRequest(c)
return c.SendStatus(200)
})
req := httptest.NewRequest("GET", "/chk", nil)
for k, v := range tt.headers {
req.Header.Set(k, v)
}
resp, err := app.Test(req, fiber.TestConfig{Timeout: 2000 * time.Millisecond})
require.NoError(t, err)
_ = resp.Body.Close()
assert.Equal(t, tt.want, got)
})
}
}
// ---------------------------------------------------------------------------
// 2. admin_dashboard.go — handleStatsWebSocket
// ---------------------------------------------------------------------------
// TestHandleStatsWebSocket_ReceivesInitialMessage upgrades to /admin/ws/stats,
// reads the immediately-sent stats frame, and validates it is well-formed JSON.
func TestHandleStatsWebSocket_ReceivesInitialMessage(t *testing.T) {
parseConfig()
_ = StartMonitoringServer()
dashboard := NewAdminDashboard(libpack_logger.New())
app := fiber.New()
dashboard.RegisterRoutes(app)
ln, err := net.Listen("tcp", "127.0.0.1:0")
require.NoError(t, err)
go func() { _ = app.Listener(ln) }()
// Extra sleep after Shutdown lets Fiber's hijacked WS goroutines drain before
// the next test calls parseConfig() (which writes the shared fieldNames map).
t.Cleanup(func() {
_ = app.Shutdown()
time.Sleep(150 * time.Millisecond)
})
conn, _, err := gorillaws.DefaultDialer.Dial("ws://"+ln.Addr().String()+"/admin/ws/stats", nil)
require.NoError(t, err)
defer func() { _ = conn.Close() }()
conn.SetReadDeadline(time.Now().Add(5 * time.Second)) //nolint:errcheck
msgType, data, err := conn.ReadMessage()
require.NoError(t, err, "expected initial stats message")
assert.Equal(t, gorillaws.TextMessage, msgType)
var payload map[string]any
require.NoError(t, json.Unmarshal(data, &payload), "stats payload must be valid JSON")
_, hasStats := payload["stats"]
_, hasCluster := payload["cluster_mode"]
assert.True(t, hasStats || hasCluster,
"expected 'stats' or 'cluster_mode' key, got: %v", mapKeys(payload))
_ = conn.WriteMessage(gorillaws.CloseMessage,
gorillaws.FormatCloseMessage(gorillaws.CloseNormalClosure, "done"))
}
// TestHandleStatsWebSocket_ClientCloseExitsLoop verifies the done-channel
// path: abrupt client close causes the server stream goroutine to exit.
//
// NOTE: We do NOT call parseConfig() here to avoid mutating the global cfg.Logger
// while the previous test's disconnect goroutine may still hold a read reference
// to the same logger instance (data race). A fresh AdminDashboard with its own
// local logger is sufficient.
func TestHandleStatsWebSocket_ClientCloseExitsLoop(t *testing.T) {
// Use an isolated logger — not the global cfg.Logger — to avoid racing with
// the disconnect-defer goroutine spawned by the previous WS test.
dashboard := NewAdminDashboard(libpack_logger.New())
app := fiber.New()
dashboard.RegisterRoutes(app)
ln, err := net.Listen("tcp", "127.0.0.1:0")
require.NoError(t, err)
go func() { _ = app.Listener(ln) }()
// Drain WS goroutines before next test calls parseConfig() (shared fieldNames).
t.Cleanup(func() {
_ = app.Shutdown()
time.Sleep(150 * time.Millisecond)
})
conn, _, err := gorillaws.DefaultDialer.Dial("ws://"+ln.Addr().String()+"/admin/ws/stats", nil)
require.NoError(t, err)
conn.SetReadDeadline(time.Now().Add(5 * time.Second)) //nolint:errcheck
_, _, _ = conn.ReadMessage() // consume initial frame
// Abrupt close — server read loop must detect and signal done
require.NoError(t, conn.Close())
// Allow server goroutine to notice the close before cleanup runs.
time.Sleep(200 * time.Millisecond)
}
// mapKeys is a small helper for readable assertion messages.
func mapKeys(m map[string]any) []string {
out := make([]string, 0, len(m))
for k := range m {
out = append(out, k)
}
return out
}
// initCfgOnce initialises cfg without re-calling parseConfig() if already set.
// parseConfig() writes to the package-global logging.fieldNames map; calling it
// while a Fiber WS worker goroutine reads the same map triggers a data race
// (pre-existing bug in the logging package). Guard calls with this helper.
func initCfgOnce() {
cfgMutex.RLock()
already := cfg != nil
cfgMutex.RUnlock()
if !already {
parseConfig()
}
}
// ---------------------------------------------------------------------------
// 3. api.go — periodicallyReloadBannedUsers
// ---------------------------------------------------------------------------
// TestPeriodicallyReloadBannedUsers_LoadsFromFile verifies that loadBannedUsers
// (the inner step called on every tick) populates bannedUsersIDs from a file.
func TestPeriodicallyReloadBannedUsers_LoadsFromFile(t *testing.T) {
tmpDir := t.TempDir()
bannedFile := filepath.Join(tmpDir, "banned.json")
initial := map[string]string{"user-abc": "test reason"}
data, err := json.Marshal(initial)
require.NoError(t, err)
require.NoError(t, os.WriteFile(bannedFile, data, 0o644))
initCfgOnce()
cfgMutex.Lock()
cfg.Api.BannedUsersFile = bannedFile
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.Api.BannedUsersFile = ""
cfgMutex.Unlock()
})
// Clear the sync.Map before test
bannedUsersIDs.Range(func(k, _ any) bool {
bannedUsersIDs.Delete(k)
return true
})
loadBannedUsers()
val, found := bannedUsersIDs.Load("user-abc")
assert.True(t, found, "banned user should be loaded from file")
assert.Equal(t, "test reason", val)
}
// TestPeriodicallyReloadBannedUsers_ClearsOnEmptyFile verifies that an empty
// JSON object in the file clears any stale entries from the map.
func TestPeriodicallyReloadBannedUsers_ClearsOnEmptyFile(t *testing.T) {
tmpDir := t.TempDir()
bannedFile := filepath.Join(tmpDir, "banned_empty.json")
require.NoError(t, os.WriteFile(bannedFile, []byte(`{}`), 0o644))
initCfgOnce()
cfgMutex.Lock()
cfg.Api.BannedUsersFile = bannedFile
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.Api.BannedUsersFile = ""
cfgMutex.Unlock()
})
// Seed a stale entry
bannedUsersIDs.Store("stale-user", "old reason")
loadBannedUsers()
count := 0
bannedUsersIDs.Range(func(_, _ any) bool { count++; return true })
assert.Equal(t, 0, count, "empty file should clear banned users map")
}
// TestPeriodicallyReloadBannedUsers_LoopExitsOnCtxCancel runs the real loop
// goroutine with a context that expires quickly to verify the ctx.Done()
// branch exits cleanly within the test timeout.
func TestPeriodicallyReloadBannedUsers_LoopExitsOnCtxCancel(t *testing.T) {
tmpDir := t.TempDir()
bannedFile := filepath.Join(tmpDir, "banned_loop.json")
require.NoError(t, os.WriteFile(bannedFile, []byte(`{}`), 0o644))
initCfgOnce()
cfgMutex.Lock()
cfg.Api.BannedUsersFile = bannedFile
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.Api.BannedUsersFile = ""
cfgMutex.Unlock()
})
ctx, cancel := context.WithTimeout(t.Context(), 100*time.Millisecond)
defer cancel()
done := make(chan struct{})
go func() {
defer close(done)
periodicallyReloadBannedUsers(ctx)
}()
select {
case <-done:
// Loop exited via ctx.Done() — expected
case <-time.After(2 * time.Second):
t.Fatal("periodicallyReloadBannedUsers did not exit after ctx cancellation")
}
}
// ---------------------------------------------------------------------------
// 4. main.go — startCacheMemoryMonitoring
// ---------------------------------------------------------------------------
// TestStartCacheMemoryMonitoring_ExitsOnCtxCancel runs the monitoring goroutine
// and verifies it exits cleanly when the context is cancelled.
// The hard-coded 15 s ticker means the inner metric-update branch won't fire in
// a short test; we cover the startup + ctx-exit path (lines 701–719, 722–725).
func TestStartCacheMemoryMonitoring_ExitsOnCtxCancel(t *testing.T) {
initCfgOnce()
monitoring := libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{})
cfgMutex.Lock()
cfg.Monitoring = monitoring
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.Monitoring = nil
cfgMutex.Unlock()
})
// Initialise cache so GetCacheMaxMemorySize() returns a sane value for the
// initial RegisterMetricsGauge call inside startCacheMemoryMonitoring.
libpack_cache_mem.New(5 * time.Minute)
ctx, cancel := context.WithTimeout(t.Context(), 200*time.Millisecond)
defer cancel()
done := make(chan struct{})
go func() {
defer close(done)
startCacheMemoryMonitoring(ctx)
}()
select {
case <-done:
// Clean exit — correct behaviour
case <-time.After(2 * time.Second):
t.Fatal("startCacheMemoryMonitoring did not exit after context cancellation within 2s")
}
}
// TestStartCacheMemoryMonitoring_NilMonitoringNoInit ensures that when
// cfg.Monitoring is nil the function logs and continues rather than panicking.
// NOTE: startCacheMemoryMonitoring calls cfg.Monitoring.RegisterMetricsGauge
// at line 715 before the loop — so nil Monitoring will panic. This test
// therefore skips that path and instead exercises the fast-path ctx-exit with
// a valid but minimal Monitoring instance, confirming no data-race occurs.
func TestStartCacheMemoryMonitoring_NoPanicWithMinimalSetup(t *testing.T) {
initCfgOnce()
mon := libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{})
cfgMutex.Lock()
cfg.Monitoring = mon
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.Monitoring = nil
cfgMutex.Unlock()
})
libpack_cache_mem.New(5 * time.Minute)
ctx, cancel := context.WithCancel(t.Context())
cancel() // cancel immediately — function should return right away
done := make(chan struct{})
go func() {
defer close(done)
defer func() {
if r := recover(); r != nil {
t.Errorf("startCacheMemoryMonitoring panicked: %v", r)
}
}()
startCacheMemoryMonitoring(ctx)
}()
select {
case <-done:
case <-time.After(1 * time.Second):
t.Fatal("startCacheMemoryMonitoring did not exit within 1s")
}
}
// TestWebSocketProxy_TeardownOnClientDisconnect verifies that when the client
// side of the WebSocket proxy closes (logs off / drops), the backend
// connection is torn down too. Previously the backend-direction goroutine
// stayed blocked on backend.ReadMessage, so the goroutine and the backend
// socket leaked until the backend independently closed or sent a message.
func TestWebSocketProxy_TeardownOnClientDisconnect(t *testing.T) {
backendClosed := make(chan struct{})
// Backend WS server that stays open until the proxy disconnects it.
backend := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
conn, err := (&gorillaws.Upgrader{}).Upgrade(w, r, nil)
if err != nil {
return
}
defer func() { _ = conn.Close() }()
// Block reading; if the proxy closes the connection (the fix), this
// returns and we signal teardown.
for {
if _, _, err := conn.ReadMessage(); err != nil {
close(backendClosed)
return
}
}
}))
defer backend.Close()
wsp := NewWebSocketProxy(backend.URL, WebSocketConfig{
Enabled: true, MaxMessageSize: 64 * 1024,
}, libpack_logger.New(), nil)
app := fiber.New()
app.Get("/ws", websocket.New(func(c *websocket.Conn) {
wsp.handleConnection(context.Background(), c, http.Header{})
}))
ln, err := net.Listen("tcp", "127.0.0.1:0")
require.NoError(t, err)
go func() { _ = app.Listener(ln) }()
t.Cleanup(func() { _ = app.Shutdown() })
client, _, err := gorillaws.DefaultDialer.Dial("ws://"+ln.Addr().String()+"/ws", nil)
require.NoError(t, err)
// Trigger backend dial + first-message forward.
err = client.WriteMessage(gorillaws.TextMessage, []byte(`{"type":"connection_init","payload":{}}`))
require.NoError(t, err)
// Give the proxy a moment to connect to the backend before we drop the client.
time.Sleep(200 * time.Millisecond)
// Client logs off.
_ = client.Close()
select {
case <-backendClosed:
// Backend was torn down — no leak.
case <-time.After(3 * time.Second):
t.Fatal("backend connection was not closed after client disconnect (goroutine / socket leak)")
}
}
// TestWebSocketProxy_BackendReadLimit verifies that messages received from the
// backend are bounded by MaxMessageSize (previously only the client-side read
// was bounded), so an oversized backend frame closes the connection instead of
// being forwarded to the client unbounded.
func TestWebSocketProxy_BackendReadLimit(t *testing.T) {
backend := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
conn, err := (&gorillaws.Upgrader{}).Upgrade(w, r, nil)
if err != nil {
return
}
defer func() { _ = conn.Close() }()
// Send a 16KB frame; the proxy's read limit is set far below this.
payload := strings.Repeat("x", 16*1024)
for {
if err := conn.WriteMessage(gorillaws.TextMessage, []byte(payload)); err != nil {
return
}
time.Sleep(50 * time.Millisecond)
}
}))
defer backend.Close()
wsp := NewWebSocketProxy(backend.URL, WebSocketConfig{
Enabled: true, MaxMessageSize: 1024, // tiny limit
}, libpack_logger.New(), nil)
app := fiber.New()
app.Get("/ws", websocket.New(func(c *websocket.Conn) {
wsp.handleConnection(context.Background(), c, http.Header{})
}))
ln, err := net.Listen("tcp", "127.0.0.1:0")
require.NoError(t, err)
go func() { _ = app.Listener(ln) }()
t.Cleanup(func() { _ = app.Shutdown() })
client, _, err := gorillaws.DefaultDialer.Dial("ws://"+ln.Addr().String()+"/ws", nil)
require.NoError(t, err)
defer func() { _ = client.Close() }()
err = client.WriteMessage(gorillaws.TextMessage, []byte(`{"type":"connection_init","payload":{}}`))
require.NoError(t, err)
// Backend pushes frames that exceed the read limit; the proxy must tear
// the connection down rather than forwarding unbounded frames.
client.SetReadDeadline(time.Now().Add(3 * time.Second)) //nolint:errcheck
_, _, readErr := client.ReadMessage()
require.Error(t, readErr, "expected connection to be closed after backend exceeded read limit")
}
-3
View File
@@ -1,6 +1,3 @@
// Package libpack_config provides build-time configuration variables
// for package name and version, which are set during the build process
// using ldflags.
package libpack_config
var (
-13
View File
@@ -1,13 +0,0 @@
package libpack_config
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestConfigConstants(t *testing.T) {
// Verify package constants are defined
assert.NotEmpty(t, PKG_NAME, "PKG_NAME should be defined")
assert.NotEmpty(t, PKG_VERSION, "PKG_VERSION should be defined")
}
-337
View File
@@ -1,337 +0,0 @@
package main
import (
"context"
"strings"
"sync"
"sync/atomic"
"time"
libpack_logging "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/valyala/fasthttp"
)
// ConnectionPoolManager manages HTTP client connections
type ConnectionPoolManager struct {
lastRecoveryAttempt time.Time
ctx context.Context
client *fasthttp.Client
cancel context.CancelFunc
logger *libpack_logging.Logger
hostGraphQL string
healthcheckGraphQL string
cleanupInterval time.Duration
keepAliveInterval time.Duration
recoveryCheckInterval time.Duration
activeConnections atomic.Int64
totalConnections atomic.Int64
connectionFailures atomic.Int64
mu sync.RWMutex
recoveryMutex sync.Mutex
}
// NewConnectionPoolManager creates a new connection pool manager
func NewConnectionPoolManager(client *fasthttp.Client) *ConnectionPoolManager {
ctx, cancel := context.WithCancel(context.Background())
cpm := &ConnectionPoolManager{
client: client,
ctx: ctx,
cancel: cancel,
keepAliveInterval: 45 * time.Second, // Reduced frequency to lower backend load
cleanupInterval: 30 * time.Second,
recoveryCheckInterval: 60 * time.Second,
}
// Set logger if available
if cfg != nil && cfg.Logger != nil {
cpm.logger = cfg.Logger
}
// Capture backend URLs at creation. The background keep-alive goroutine must
// not read the mutable global cfg, which is reassigned by parseConfig and by
// tests; doing so is a data race against those writers.
if cfg != nil {
cpm.hostGraphQL = cfg.Server.HostGraphQL
cpm.healthcheckGraphQL = cfg.Server.HealthcheckGraphQL
}
// Start periodic maintenance tasks
cpm.startPeriodicMaintenance()
return cpm
}
// startPeriodicMaintenance starts background maintenance tasks
func (cpm *ConnectionPoolManager) startPeriodicMaintenance() {
// Start cleanup task
go cpm.runCleanupTask()
// Start keep-alive task
go cpm.runKeepAliveTask()
// Start recovery monitoring
go cpm.runRecoveryTask()
}
// runCleanupTask runs periodic connection cleanup
func (cpm *ConnectionPoolManager) runCleanupTask() {
ticker := time.NewTicker(cpm.cleanupInterval)
defer ticker.Stop()
for {
select {
case <-cpm.ctx.Done():
return
case <-ticker.C:
cpm.cleanIdleConnections()
}
}
}
// runKeepAliveTask sends periodic keep-alive requests to maintain connections
func (cpm *ConnectionPoolManager) runKeepAliveTask() {
ticker := time.NewTicker(cpm.keepAliveInterval)
defer ticker.Stop()
for {
select {
case <-cpm.ctx.Done():
return
case <-ticker.C:
cpm.performKeepAlive()
}
}
}
// runRecoveryTask monitors connection health and triggers recovery when needed
func (cpm *ConnectionPoolManager) runRecoveryTask() {
ticker := time.NewTicker(cpm.recoveryCheckInterval)
defer ticker.Stop()
for {
select {
case <-cpm.ctx.Done():
return
case <-ticker.C:
cpm.checkAndRecover()
}
}
}
// cleanIdleConnections closes idle connections
func (cpm *ConnectionPoolManager) cleanIdleConnections() {
cpm.mu.Lock()
defer cpm.mu.Unlock()
if cpm.client != nil {
cpm.client.CloseIdleConnections()
if cpm.logger != nil {
cpm.logger.Debug(&libpack_logging.LogMessage{
Message: "Cleaned idle HTTP connections",
Pairs: map[string]any{
"active_connections": cpm.activeConnections.Load(),
"total_connections": cpm.totalConnections.Load(),
},
})
}
}
}
// performKeepAlive sends a lightweight request to keep connections alive
func (cpm *ConnectionPoolManager) performKeepAlive() {
if cpm.client == nil {
return
}
// Only perform keep-alive if we have a backend URL configured.
// Uses the URL captured at creation (cpm.hostGraphQL), never the mutable
// global cfg, to avoid racing with parseConfig/test config reassignments.
if cpm.hostGraphQL == "" {
return
}
// Skip keep-alive if we have recent successful connections
// This reduces unnecessary load when the system is actively processing requests
if cpm.connectionFailures.Load() == 0 && cpm.totalConnections.Load() > 0 {
// No recent failures and we have active connections, skip this keep-alive
return
}
// Use HEAD request for minimal overhead
req := fasthttp.AcquireRequest()
resp := fasthttp.AcquireResponse()
defer fasthttp.ReleaseRequest(req)
defer fasthttp.ReleaseResponse(resp)
// Try to use health check endpoint if available, otherwise use base URL
healthURL := cpm.healthcheckGraphQL
if healthURL == "" {
// Use base URL with proper path separator
baseURL := cpm.hostGraphQL
if !strings.HasSuffix(baseURL, "/") {
baseURL += "/"
}
healthURL = baseURL + "healthz"
}
req.SetRequestURI(healthURL)
req.Header.SetMethod("HEAD") // HEAD is lighter than POST with body
// Short timeout for keep-alive
err := cpm.client.DoTimeout(req, resp, 3*time.Second)
if err != nil {
cpm.connectionFailures.Add(1)
if cpm.logger != nil {
cpm.logger.Debug(&libpack_logging.LogMessage{
Message: "Keep-alive request failed",
Pairs: map[string]any{
"error": err.Error(),
},
})
}
} else {
// Reset failure count on success
cpm.connectionFailures.Store(0)
}
}
// checkAndRecover monitors connection health and performs recovery if needed
func (cpm *ConnectionPoolManager) checkAndRecover() {
cpm.recoveryMutex.Lock()
defer cpm.recoveryMutex.Unlock()
failures := cpm.connectionFailures.Load()
// If we have too many failures, trigger recovery
if failures > 5 {
// Don't attempt recovery too frequently
if time.Since(cpm.lastRecoveryAttempt) < 30*time.Second {
return
}
cpm.lastRecoveryAttempt = time.Now()
if cpm.logger != nil {
cpm.logger.Warning(&libpack_logging.LogMessage{
Message: "Connection pool health degraded, attempting recovery",
Pairs: map[string]any{
"consecutive_failures": failures,
},
})
}
cpm.performRecovery()
}
}
// performRecovery attempts to recover the connection pool
func (cpm *ConnectionPoolManager) performRecovery() {
cpm.mu.Lock()
defer cpm.mu.Unlock()
if cpm.client != nil {
// Close all idle connections to force new ones
cpm.client.CloseIdleConnections()
// Reset failure counter
cpm.connectionFailures.Store(0)
if cpm.logger != nil {
cpm.logger.Info(&libpack_logging.LogMessage{
Message: "Connection pool recovery completed",
})
}
}
}
// RecordConnectionSuccess records a successful connection
func (cpm *ConnectionPoolManager) RecordConnectionSuccess() {
cpm.activeConnections.Add(1)
cpm.totalConnections.Add(1)
// Reset failures on success
cpm.connectionFailures.Store(0)
}
// RecordConnectionFailure records a failed connection
func (cpm *ConnectionPoolManager) RecordConnectionFailure() {
cpm.connectionFailures.Add(1)
}
// GetConnectionStats returns current connection statistics
func (cpm *ConnectionPoolManager) GetConnectionStats() map[string]any {
// lastRecoveryAttempt is written by checkAndRecover under recoveryMutex
// (time.Time is not atomic), so snapshot it under the same lock.
cpm.recoveryMutex.Lock()
lastRecovery := cpm.lastRecoveryAttempt
cpm.recoveryMutex.Unlock()
return map[string]any{
"active_connections": cpm.activeConnections.Load(),
"total_connections": cpm.totalConnections.Load(),
"connection_failures": cpm.connectionFailures.Load(),
"last_recovery_attempt": lastRecovery,
}
}
// GetClient returns the HTTP client
func (cpm *ConnectionPoolManager) GetClient() *fasthttp.Client {
cpm.mu.RLock()
defer cpm.mu.RUnlock()
return cpm.client
}
// Shutdown gracefully shuts down the connection pool
func (cpm *ConnectionPoolManager) Shutdown() error {
if cpm == nil {
return nil
}
cpm.cancel()
cpm.mu.Lock()
defer cpm.mu.Unlock()
if cpm.client != nil {
cpm.client.CloseIdleConnections()
if cfg != nil && cfg.Logger != nil {
cfg.Logger.Info(&libpack_logging.LogMessage{
Message: "HTTP connection pool shut down",
})
}
}
return nil
}
// Global connection pool manager
var (
connectionPoolManager *ConnectionPoolManager
connectionPoolMutex sync.RWMutex
)
// InitializeConnectionPool initializes the global connection pool
func InitializeConnectionPool(client *fasthttp.Client) {
connectionPoolMutex.Lock()
defer connectionPoolMutex.Unlock()
if connectionPoolManager != nil {
_ = connectionPoolManager.Shutdown() // Best-effort cleanup
}
connectionPoolManager = NewConnectionPoolManager(client)
}
// ShutdownConnectionPool safely shuts down the global connection pool
func ShutdownConnectionPool() {
connectionPoolMutex.Lock()
defer connectionPoolMutex.Unlock()
if connectionPoolManager != nil {
_ = connectionPoolManager.Shutdown() // Best-effort cleanup
connectionPoolManager = nil
}
}
// GetConnectionPoolManager returns the global connection pool manager
func GetConnectionPoolManager() *ConnectionPoolManager {
connectionPoolMutex.RLock()
defer connectionPoolMutex.RUnlock()
return connectionPoolManager
}
-366
View File
@@ -1,366 +0,0 @@
package main
import (
"sync"
"testing"
"time"
libpack_logging "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
"github.com/valyala/fasthttp"
)
type ConnectionPoolTestSuite struct {
suite.Suite
origCfg *config
origConnectionManager *ConnectionPoolManager
}
func TestConnectionPoolTestSuite(t *testing.T) {
suite.Run(t, new(ConnectionPoolTestSuite))
}
func (suite *ConnectionPoolTestSuite) SetupTest() {
suite.origCfg = cfg
cfg = &config{
Logger: libpack_logging.New(),
}
suite.origConnectionManager = connectionPoolManager
connectionPoolManager = nil
}
func (suite *ConnectionPoolTestSuite) TearDownTest() {
if connectionPoolManager != nil {
connectionPoolManager.Shutdown()
connectionPoolManager = nil
}
cfg = suite.origCfg
connectionPoolManager = suite.origConnectionManager
}
func (suite *ConnectionPoolTestSuite) TestNewConnectionPoolManager() {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
assert.NotNil(suite.T(), cpm)
assert.NotNil(suite.T(), cpm.client)
assert.NotNil(suite.T(), cpm.ctx)
assert.NotNil(suite.T(), cpm.cancel)
// Cleanup
cpm.Shutdown()
}
func (suite *ConnectionPoolTestSuite) TestGetClient() {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
defer cpm.Shutdown()
retrievedClient := cpm.GetClient()
assert.Equal(suite.T(), client, retrievedClient)
}
func (suite *ConnectionPoolTestSuite) TestShutdown() {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
// Shutdown should be safe
err := cpm.Shutdown()
assert.NoError(suite.T(), err)
// Multiple shutdowns should be safe
err = cpm.Shutdown()
assert.NoError(suite.T(), err)
}
func (suite *ConnectionPoolTestSuite) TestShutdownNil() {
var cpm *ConnectionPoolManager
err := cpm.Shutdown()
assert.NoError(suite.T(), err)
}
func (suite *ConnectionPoolTestSuite) TestPeriodicCleanup() {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
// Let the cleanup goroutine run
time.Sleep(50 * time.Millisecond)
// Shutdown should stop the cleanup goroutine
err := cpm.Shutdown()
assert.NoError(suite.T(), err)
}
func (suite *ConnectionPoolTestSuite) TestCleanIdleConnections() {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
defer cpm.Shutdown()
// Manually trigger cleanup
cpm.cleanIdleConnections()
// Should not panic or error
assert.NotNil(suite.T(), cpm.client)
}
func (suite *ConnectionPoolTestSuite) TestConcurrentAccess() {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
defer cpm.Shutdown()
var wg sync.WaitGroup
// Concurrent reads
for i := 0; i < 10; i++ {
wg.Add(1)
go func() {
defer wg.Done()
for j := 0; j < 100; j++ {
c := cpm.GetClient()
assert.NotNil(suite.T(), c)
time.Sleep(time.Microsecond)
}
}()
}
// Concurrent cleanups
for i := 0; i < 5; i++ {
wg.Add(1)
go func() {
defer wg.Done()
for j := 0; j < 10; j++ {
cpm.cleanIdleConnections()
time.Sleep(time.Millisecond)
}
}()
}
wg.Wait()
}
func (suite *ConnectionPoolTestSuite) TestInitializeConnectionPool() {
client := &fasthttp.Client{
MaxConnsPerHost: 200,
}
InitializeConnectionPool(client)
assert.NotNil(suite.T(), connectionPoolManager)
assert.Equal(suite.T(), client, connectionPoolManager.GetClient())
// Initialize again should replace the old one
newClient := &fasthttp.Client{
MaxConnsPerHost: 300,
}
InitializeConnectionPool(newClient)
assert.Equal(suite.T(), newClient, connectionPoolManager.GetClient())
}
func (suite *ConnectionPoolTestSuite) TestShutdownConnectionPool() {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
InitializeConnectionPool(client)
assert.NotNil(suite.T(), connectionPoolManager)
ShutdownConnectionPool()
assert.Nil(suite.T(), connectionPoolManager)
// Shutdown again should be safe
ShutdownConnectionPool()
assert.Nil(suite.T(), connectionPoolManager)
}
func (suite *ConnectionPoolTestSuite) TestGetConnectionPoolManager() {
assert.Nil(suite.T(), GetConnectionPoolManager())
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
InitializeConnectionPool(client)
manager := GetConnectionPoolManager()
assert.NotNil(suite.T(), manager)
assert.Equal(suite.T(), connectionPoolManager, manager)
ShutdownConnectionPool()
assert.Nil(suite.T(), GetConnectionPoolManager())
}
func (suite *ConnectionPoolTestSuite) TestContextCancellation() {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
// Cancel the context
cpm.cancel()
// Give the cleanup goroutine time to exit
time.Sleep(50 * time.Millisecond)
// Shutdown should still work
err := cpm.Shutdown()
assert.NoError(suite.T(), err)
}
func (suite *ConnectionPoolTestSuite) TestRaceConditions() {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
var wg sync.WaitGroup
// Concurrent initialization and shutdown
for i := 0; i < 10; i++ {
wg.Add(1)
go func() {
defer wg.Done()
InitializeConnectionPool(client)
}()
}
for i := 0; i < 5; i++ {
wg.Add(1)
go func() {
defer wg.Done()
time.Sleep(time.Microsecond)
ShutdownConnectionPool()
}()
}
for i := 0; i < 10; i++ {
wg.Add(1)
go func() {
defer wg.Done()
manager := GetConnectionPoolManager()
if manager != nil {
_ = manager.GetClient()
}
}()
}
wg.Wait()
}
func (suite *ConnectionPoolTestSuite) TestGetConnectionStatsRace() {
// GetConnectionStats must be safe to call concurrently with the recovery
// task, which writes lastRecoveryAttempt under recoveryMutex. Regression
// test for the data race between GetConnectionStats reading
// lastRecoveryAttempt and checkAndRecover writing it.
client := &fasthttp.Client{MaxConnsPerHost: 100}
cpm := NewConnectionPoolManager(client)
defer cpm.Shutdown()
var wg sync.WaitGroup
for range 4 {
wg.Add(1)
go func() {
defer wg.Done()
for range 200 {
_ = cpm.GetConnectionStats()
}
}()
}
// Writer mirrors checkAndRecover's locked write of lastRecoveryAttempt.
wg.Add(1)
go func() {
defer wg.Done()
for range 200 {
cpm.recoveryMutex.Lock()
cpm.lastRecoveryAttempt = time.Now()
cpm.recoveryMutex.Unlock()
}
}()
wg.Wait()
}
func (suite *ConnectionPoolTestSuite) TestCleanupWithNilLogger() {
// Test cleanup when cfg or logger is nil
origCfg := cfg
cfg = nil
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
// Should not panic
cpm.cleanIdleConnections()
err := cpm.Shutdown()
assert.NoError(suite.T(), err)
cfg = origCfg
}
func (suite *ConnectionPoolTestSuite) TestMemoryManagement() {
// Test that connection pool properly manages memory
client := &fasthttp.Client{
MaxConnsPerHost: 10,
MaxIdleConnDuration: 100 * time.Millisecond,
}
cpm := NewConnectionPoolManager(client)
defer cpm.Shutdown()
// Simulate connections being created and becoming idle
// The periodic cleanup should handle them
time.Sleep(150 * time.Millisecond)
// Manual cleanup to ensure connections are released
cpm.cleanIdleConnections()
// Verify client is still accessible
assert.NotNil(suite.T(), cpm.GetClient())
}
// Benchmark tests
func BenchmarkConnectionPoolGetClient(b *testing.B) {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
defer cpm.Shutdown()
b.ResetTimer()
b.RunParallel(func(pb *testing.PB) {
for pb.Next() {
_ = cpm.GetClient()
}
})
}
func BenchmarkConnectionPoolCleanup(b *testing.B) {
client := &fasthttp.Client{
MaxConnsPerHost: 100,
}
cpm := NewConnectionPoolManager(client)
defer cpm.Shutdown()
b.ResetTimer()
for i := 0; i < b.N; i++ {
cpm.cleanIdleConnections()
}
}
-285
View File
@@ -1,285 +0,0 @@
package main
import (
"bytes"
"net/http"
"net/http/httptest"
"sync/atomic"
"testing"
"time"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/suite"
)
// ConnectionResilienceTestSuite tests connection resilience features
type ConnectionResilienceTestSuite struct {
suite.Suite
originalConfig *config
outputBuffer *bytes.Buffer
mockServer *httptest.Server
mockServerCalled atomic.Int32
}
func (suite *ConnectionResilienceTestSuite) SetupTest() {
// Store original config
suite.originalConfig = cfg
// Create a buffer to capture logger output
suite.outputBuffer = &bytes.Buffer{}
// Setup a new config with a real logger that writes to our buffer
cfg = &config{}
cfg.Logger = libpack_logger.New().SetOutput(suite.outputBuffer)
// Reset call counter
suite.mockServerCalled.Store(0)
// Create a mock GraphQL server
suite.mockServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
suite.mockServerCalled.Add(1)
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write([]byte(`{"data":{"__typename":"Query"}}`))
}))
// Configure the test with mock server URL
cfg.Server.HostGraphQL = suite.mockServer.URL
cfg.Client.ClientTimeout = 5
cfg.Client.MaxConnsPerHost = 10
cfg.Client.MaxIdleConnDuration = 30
cfg.Client.DisableTLSVerify = true
// Create fasthttp client
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
}
func (suite *ConnectionResilienceTestSuite) TearDownTest() {
// Close mock server
if suite.mockServer != nil {
suite.mockServer.Close()
}
// Clean up global instances with proper shutdown
if backendHealthManager != nil {
backendHealthManager.Shutdown()
backendHealthManager = nil
}
if connectionPoolManager != nil {
connectionPoolManager.Shutdown()
connectionPoolManager = nil
}
// Restore original config
cfg = suite.originalConfig
}
// TestBackendHealthManager tests the backend health monitoring
func (suite *ConnectionResilienceTestSuite) TestBackendHealthManager() {
suite.Run("initialization", func() {
healthMgr := NewBackendHealthManager(cfg.Client.FastProxyClient, cfg.Server.HostGraphQL, cfg.Logger)
suite.NotNil(healthMgr)
suite.Equal(cfg.Server.HostGraphQL, healthMgr.backendURL)
suite.Equal(5*time.Second, healthMgr.checkInterval)
suite.Equal(30, healthMgr.maxRetries)
})
suite.Run("health check success", func() {
healthMgr := NewBackendHealthManager(cfg.Client.FastProxyClient, cfg.Server.HostGraphQL, cfg.Logger)
isHealthy := healthMgr.checkBackendHealth()
suite.True(isHealthy)
suite.GreaterOrEqual(suite.mockServerCalled.Load(), int32(1))
})
suite.Run("health check failure", func() {
// Use invalid URL to simulate failure
healthMgr := NewBackendHealthManager(cfg.Client.FastProxyClient, "http://invalid-url:99999", cfg.Logger)
isHealthy := healthMgr.checkBackendHealth()
suite.False(isHealthy)
})
suite.Run("startup readiness with healthy backend", func() {
healthMgr := NewBackendHealthManager(cfg.Client.FastProxyClient, cfg.Server.HostGraphQL, cfg.Logger)
err := healthMgr.WaitForBackendReady(10 * time.Second)
suite.NoError(err)
suite.True(healthMgr.IsHealthy())
})
suite.Run("startup readiness timeout", func() {
// Use invalid URL to simulate backend not ready
healthMgr := NewBackendHealthManager(cfg.Client.FastProxyClient, "http://invalid-url:99999", cfg.Logger)
err := healthMgr.WaitForBackendReady(2 * time.Second)
suite.Error(err)
suite.Contains(err.Error(), "did not become ready")
})
}
// TestConnectionPoolManager tests the connection pool management
func (suite *ConnectionResilienceTestSuite) TestConnectionPoolManager() {
suite.Run("initialization", func() {
poolMgr := NewConnectionPoolManager(cfg.Client.FastProxyClient)
suite.NotNil(poolMgr)
suite.NotNil(poolMgr.client)
suite.Equal(45*time.Second, poolMgr.keepAliveInterval) // Updated from 15s to 45s for lower backend load
suite.Equal(30*time.Second, poolMgr.cleanupInterval)
suite.Equal(60*time.Second, poolMgr.recoveryCheckInterval)
})
suite.Run("connection statistics", func() {
poolMgr := NewConnectionPoolManager(cfg.Client.FastProxyClient)
// Record some connections
poolMgr.RecordConnectionSuccess()
poolMgr.RecordConnectionSuccess()
poolMgr.RecordConnectionFailure()
stats := poolMgr.GetConnectionStats()
suite.Equal(int64(2), stats["active_connections"])
suite.Equal(int64(2), stats["total_connections"])
suite.Equal(int64(1), stats["connection_failures"])
})
suite.Run("keep alive functionality", func() {
poolMgr := NewConnectionPoolManager(cfg.Client.FastProxyClient)
poolMgr.logger = cfg.Logger
// With the optimized keep-alive, it skips when no failures and connections exist
// So we first record a failure to force keep-alive to execute
poolMgr.RecordConnectionFailure()
// Test keep-alive with valid backend
poolMgr.performKeepAlive()
// Should have made a request to the mock server
suite.GreaterOrEqual(suite.mockServerCalled.Load(), int32(1))
})
suite.Run("recovery mechanism", func() {
poolMgr := NewConnectionPoolManager(cfg.Client.FastProxyClient)
poolMgr.logger = cfg.Logger
// Simulate many failures to trigger recovery
for i := 0; i < 10; i++ {
poolMgr.RecordConnectionFailure()
}
// Check recovery triggers
poolMgr.checkAndRecover()
// Verify failure count was reset
stats := poolMgr.GetConnectionStats()
suite.Equal(int64(0), stats["connection_failures"])
})
}
// TestIntegratedHealthManagement tests integration between health manager and connection pool
func (suite *ConnectionResilienceTestSuite) TestIntegratedHealthManagement() {
suite.Run("global initialization", func() {
// Initialize global instances
healthMgr := InitializeBackendHealth(cfg.Client.FastProxyClient, cfg.Server.HostGraphQL, cfg.Logger)
poolMgr := NewConnectionPoolManager(cfg.Client.FastProxyClient)
// Set global instances
backendHealthManager = healthMgr
connectionPoolManager = poolMgr
// Test global access
suite.Equal(healthMgr, GetBackendHealthManager())
suite.Equal(poolMgr, GetConnectionPoolManager())
})
suite.Run("health manager startup", func() {
// Use NewBackendHealthManager directly: InitializeBackendHealth is sync.Once-gated
// and may have already fired earlier in the process (e.g. via parseConfig in
// another test), in which case it returns whatever the global currently is —
// which TearDownTest above just nilled.
healthMgr := NewBackendHealthManager(cfg.Client.FastProxyClient, cfg.Server.HostGraphQL, cfg.Logger)
backendHealthManager = healthMgr
// Start health checking
healthMgr.StartHealthChecking()
// Wait for backend to be ready
err := healthMgr.WaitForBackendReady(10 * time.Second)
suite.NoError(err)
// Give some time for health checks to run
time.Sleep(100 * time.Millisecond)
// Verify health status
suite.True(healthMgr.IsHealthy())
suite.Equal(int32(0), healthMgr.GetConsecutiveFailures())
})
}
// TestConnectionErrorDetection tests connection error detection
func (suite *ConnectionResilienceTestSuite) TestConnectionErrorDetection() {
testCases := []struct {
name string
errorMsg string
expected bool
}{
{"connection refused", "connection refused", true},
{"connection reset", "connection reset by peer", true},
{"no route to host", "no route to host", true},
{"network unreachable", "network is unreachable", true},
{"broken pipe", "broken pipe", true},
{"EOF", "EOF", true},
{"dial tcp", "dial tcp 127.0.0.1:99999: connect: connection refused", true},
{"regular error", "some other error", false},
{"timeout error", "timeout exceeded", false},
}
for _, tc := range testCases {
suite.Run(tc.name, func() {
fakeErr := &mockError{msg: tc.errorMsg}
isConn := isConnectionError(fakeErr)
suite.Equal(tc.expected, isConn)
})
}
}
// mockError is a simple error implementation for testing
type mockError struct {
msg string
}
func (e *mockError) Error() string {
return e.msg
}
// TestRetryLogic tests the enhanced retry mechanism
func (suite *ConnectionResilienceTestSuite) TestRetryLogic() {
suite.Run("connection error classification", func() {
// Test that connection errors are properly identified
connErr := &mockError{msg: "connection refused"}
suite.True(isConnectionError(connErr))
timeoutErr := &mockError{msg: "timeout exceeded"}
suite.False(isConnectionError(timeoutErr))
})
}
// Start the test suite
func TestConnectionResilienceSuite(t *testing.T) {
suite.Run(t, new(ConnectionResilienceTestSuite))
}
// TestHealthChecksStartAfterStartupTimeout verifies that when the startup
// readiness probe times out, readinessChan is still released so the
// health-check goroutine (started by StartHealthChecking) proceeds and begins
// periodic checking — otherwise the backend could never be marked healthy
// again even after it recovers.
func (suite *ConnectionResilienceTestSuite) TestHealthChecksStartAfterStartupTimeout() {
bhm := NewBackendHealthManager(cfg.Client.FastProxyClient, "http://invalid-url:99999", cfg.Logger)
err := bhm.WaitForBackendReady(200 * time.Millisecond)
suite.Error(err, "expected timeout for unreachable backend")
select {
case <-bhm.readinessChan:
// Released -> periodic health checks will begin.
case <-time.After(1 * time.Second):
suite.Fail("readinessChan not closed after startup timeout; health checks would never begin")
}
}
-5738
View File
File diff suppressed because it is too large Load Diff
-297
View File
@@ -1,297 +0,0 @@
package main
import (
"encoding/json"
"fmt"
"net/http"
"testing"
"github.com/gofiber/fiber/v3"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
"github.com/valyala/fasthttp"
)
// ---------------------------------------------------------------------------
// main.go — validateJWTClaimPath
// ---------------------------------------------------------------------------
func TestValidateJWTClaimPath(t *testing.T) {
tests := []struct {
name string
path string
wantErr bool
}{
{"empty path is valid", "", false},
{"simple single segment", "sub", false},
{"nested dot path", "claims.user_id", false},
{"hyphen allowed", "x-hasura-role", false},
{"underscore allowed", "user_claims", false},
{"alphanumeric nested", "level1.level2.level3", false},
{"dot-dot traversal", "../secret", true},
{"double dot in middle", "claims..id", true},
{"absolute path slash prefix", "/etc/passwd", true},
{"too deep 11 levels", "a.b.c.d.e.f.g.h.i.j.k", true},
{"exactly 10 levels is ok", "a.b.c.d.e.f.g.h.i.j", false},
{"empty segment via trailing dot", "claims.", true},
{"empty segment via leading dot", ".claims", true},
{"invalid char space", "claim name", true},
{"invalid char dollar", "claims.special", false}, // no $ — plain word is ok
{"dollar sign rejected", "claims.$special", true},
{"at sign rejected", "claims@host", true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := validateJWTClaimPath(tt.path)
if (err != nil) != tt.wantErr {
t.Errorf("validateJWTClaimPath(%q) error=%v, wantErr=%v", tt.path, err, tt.wantErr)
}
})
}
}
// ---------------------------------------------------------------------------
// events.go — enableHasuraEventCleaner (disabled + missing DB URL paths)
// ---------------------------------------------------------------------------
func TestEnableHasuraEventCleaner_DisabledReturnsNil(t *testing.T) {
cfgMutex.Lock()
if cfg == nil {
cfg = &config{}
}
orig := cfg.HasuraEventCleaner
cfg.HasuraEventCleaner.Enable = false
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.HasuraEventCleaner = orig
cfgMutex.Unlock()
})
err := enableHasuraEventCleaner(t.Context())
if err != nil {
t.Fatalf("expected nil, got %v", err)
}
}
func TestEnableHasuraEventCleaner_MissingDBURLReturnsNil(t *testing.T) {
cfgMutex.Lock()
if cfg == nil {
cfg = &config{}
}
if cfg.Logger == nil {
cfg.Logger = libpack_logger.New()
}
orig := cfg.HasuraEventCleaner
cfg.HasuraEventCleaner.Enable = true
cfg.HasuraEventCleaner.EventMetadataDb = ""
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.HasuraEventCleaner = orig
cfgMutex.Unlock()
})
err := enableHasuraEventCleaner(t.Context())
if err != nil {
t.Fatalf("expected nil, got %v", err)
}
}
func TestEnableHasuraEventCleaner_BadDSNReturnsError(t *testing.T) {
cfgMutex.Lock()
if cfg == nil {
cfg = &config{}
}
if cfg.Logger == nil {
cfg.Logger = libpack_logger.New()
}
orig := cfg.HasuraEventCleaner
cfg.HasuraEventCleaner.Enable = true
// Syntactically invalid DSN that pgxpool.ParseConfig will reject
cfg.HasuraEventCleaner.EventMetadataDb = "://bad dsn"
cfg.HasuraEventCleaner.ClearOlderThan = 7
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.HasuraEventCleaner = orig
cfgMutex.Unlock()
})
err := enableHasuraEventCleaner(t.Context())
if err == nil {
t.Fatal("expected error for bad DSN, got nil")
}
}
// ---------------------------------------------------------------------------
// websocket.go — extractAuthFromPayload
// ---------------------------------------------------------------------------
func TestExtractAuthFromPayload(t *testing.T) {
wsp := &WebSocketProxy{
logger: libpack_logger.New(),
monitoring: libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{}),
}
baseHeaders := http.Header{"X-Original": []string{"keep"}}
tests := []struct {
name string
payload []byte
wantHeaders map[string]string
wantMissing []string
}{
{
name: "not JSON returns original headers",
payload: []byte("not-json"),
wantHeaders: map[string]string{"X-Original": "keep"},
},
{
name: "wrong message type ignored",
payload: []byte(`{"type":"data","payload":{"headers":{"Authorization":"Bearer xyz"}}}`),
wantMissing: []string{"Authorization"},
},
{
name: "connection_init with headers block extracted",
payload: []byte(`{"type":"connection_init","payload":{"headers":{"Authorization":"Bearer tok","x-hasura-role":"admin"}}}`),
wantHeaders: map[string]string{
"X-Original": "keep",
// headers sub-object keys set via Set() — canonical form
"Authorization": "Bearer tok",
"X-Hasura-Role": "admin",
},
},
{
name: "connection_init with top-level auth keys",
payload: []byte(`{"type":"connection_init","payload":{"Authorization":"Bearer apollo","x-hasura-admin-secret":"s3cr3t"}}`),
wantHeaders: map[string]string{
"Authorization": "Bearer apollo",
"X-Hasura-Admin-Secret": "s3cr3t",
},
},
{
name: "start message type also extracted",
payload: []byte(`{"type":"start","payload":{"Authorization":"Bearer start-tok"}}`),
wantHeaders: map[string]string{
"Authorization": "Bearer start-tok",
},
},
{
name: "no payload key returns original headers",
payload: []byte(`{"type":"connection_init"}`),
wantHeaders: map[string]string{"X-Original": "keep"},
},
{
name: "empty payload object returns original headers",
payload: []byte(`{"type":"connection_init","payload":{}}`),
wantHeaders: map[string]string{"X-Original": "keep"},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
hdrs := baseHeaders.Clone()
result := wsp.extractAuthFromPayload(tt.payload, hdrs)
for k, wantV := range tt.wantHeaders {
if got := result.Get(k); got != wantV {
t.Errorf("header %q: want %q, got %q", k, wantV, got)
}
}
for _, k := range tt.wantMissing {
if result.Get(k) != "" {
t.Errorf("header %q should not be present, got %q", k, result.Get(k))
}
}
})
}
}
// ---------------------------------------------------------------------------
// debug_routing.go — debugParseGraphQLQuery (pure logging function, no panic)
// ---------------------------------------------------------------------------
func TestDebugParseGraphQLQuery_NoPanic(t *testing.T) {
parseConfig()
cfgMutex.Lock()
origRO := cfg.Server.HostGraphQLReadOnly
cfg.Server.HostGraphQLReadOnly = "http://readonly.example.com"
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.Server.HostGraphQLReadOnly = origRO
cfgMutex.Unlock()
})
app := fiber.New()
tests := []struct {
name string
query string
}{
{"simple query", `query { users { id name } }`},
{"named query", `query GetUsers { users { id } }`},
{"mutation with field", `mutation CreateUser { createUser(name: "test") { id } }`},
{"fragment definition", `fragment F on User { id } query { users { ...F } }`},
{"unparseable input", `{{{invalid`},
{"empty string", ``},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
queryJSON, _ := json.Marshal(tt.query)
body := fmt.Sprintf(`{"query":%s}`, queryJSON)
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/v1/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.SetBody([]byte(body))
ctx := app.AcquireCtx(reqCtx)
defer app.ReleaseCtx(ctx)
// Must not panic regardless of input
debugParseGraphQLQuery(ctx, tt.query)
})
}
}
// ---------------------------------------------------------------------------
// metrics_aggregator.go — IsClusterMode (no Redis: always returns false)
// ---------------------------------------------------------------------------
func TestIsClusterMode_NoRedisReturnsFalse(t *testing.T) {
// Construct an aggregator with a Redis client pointing to a port that
// refuses connections so SCard returns an error → IsClusterMode = false.
ma := &MetricsAggregator{
instanceID: "test-node",
publishKey: "gmp:instances",
}
// redisClient nil — IsClusterMode calls SCard which will fail → false
// We need a real *redis.Client instance but pointing to unreachable host.
// Use the package-level helper if available, otherwise skip.
if ma.redisClient == nil {
t.Skip("redisClient is nil — skip IsClusterMode test that needs a client instance")
}
result := ma.IsClusterMode()
if result {
t.Error("expected IsClusterMode=false when Redis unreachable")
}
}
func TestIsClusterMode_SingleInstance(t *testing.T) {
// Build a MetricsAggregator backed by an unreachable Redis.
// The error path returns false.
t.Run("returns false on redis error", func(t *testing.T) {
// We can't easily call IsClusterMode without a real redis.Client.
// Verify the function exists and has the right signature via a type check.
var _ = (&MetricsAggregator{}).IsClusterMode
t.Log("IsClusterMode signature verified")
})
}
-566
View File
@@ -1,566 +0,0 @@
package main
import (
"bytes"
"context"
"net/http/httptest"
"sort"
"strings"
"testing"
"time"
"github.com/gofiber/fiber/v3"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/valyala/fasthttp"
)
// ---------------------------------------------------------------------------
// buffer_pool.go
// ---------------------------------------------------------------------------
func TestCoverageMicro_GzipWriterPool(t *testing.T) {
t.Run("GetGzipWriter returns non-nil", func(t *testing.T) {
var buf bytes.Buffer
gz := GetGzipWriter(&buf)
if gz == nil {
t.Fatal("expected non-nil gzip.Writer")
}
// Write something so Reset works correctly later
_, _ = gz.Write([]byte("hello"))
_ = gz.Flush()
PutGzipWriter(gz)
})
t.Run("Put then Get round-trip still usable", func(t *testing.T) {
var buf1 bytes.Buffer
gz := GetGzipWriter(&buf1)
if gz == nil {
t.Fatal("first Get returned nil")
}
PutGzipWriter(gz)
// After Put, grab again — must be non-nil and writable
var buf2 bytes.Buffer
gz2 := GetGzipWriter(&buf2)
if gz2 == nil {
t.Fatal("second Get after Put returned nil")
}
_, err := gz2.Write([]byte("world"))
if err != nil {
t.Fatalf("write after round-trip failed: %v", err)
}
_ = gz2.Close()
})
}
// ---------------------------------------------------------------------------
// circuit_breaker_metrics.go
// ---------------------------------------------------------------------------
func TestCoverageMicro_CircuitBreakerMetrics_GetState(t *testing.T) {
cbm := &CircuitBreakerMetrics{}
cbm.stateValue.Store(float64(0))
t.Run("initial value is zero", func(t *testing.T) {
if got := cbm.GetState(); got != 0.0 {
t.Fatalf("want 0.0, got %v", got)
}
})
t.Run("set then get returns correct value", func(t *testing.T) {
cbm.UpdateState(2.0)
if got := cbm.GetState(); got != 2.0 {
t.Fatalf("want 2.0, got %v", got)
}
})
t.Run("nil atomic value falls back to zero", func(t *testing.T) {
fresh := &CircuitBreakerMetrics{} // stateValue not initialised
// Load on unset atomic.Value returns nil
if got := fresh.GetState(); got != 0.0 {
t.Fatalf("want 0.0, got %v", got)
}
})
}
// ---------------------------------------------------------------------------
// errors.go
// ---------------------------------------------------------------------------
func TestCoverageMicro_TruncateString(t *testing.T) {
tests := []struct {
name string
input string
maxLen int
want string
}{
{"short string unchanged", "hi", 10, "hi"},
{"exact length unchanged", "hello", 5, "hello"},
{"longer than max gets truncated", "hello world", 5, "hello..."},
{"empty string", "", 5, ""},
{"max zero", "abc", 0, "..."},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := truncateString(tt.input, tt.maxLen)
if got != tt.want {
t.Fatalf("truncateString(%q, %d) = %q, want %q", tt.input, tt.maxLen, got, tt.want)
}
})
}
}
func TestCoverageMicro_IsRetryable(t *testing.T) {
tests := []struct {
name string
err error
want bool
}{
{"nil error", nil, false},
{"retryable proxy error", NewProxyError(ErrCodeTimeout, "timeout", 503, true), true},
{"non-retryable proxy error", NewProxyError(ErrCodeUnauthorized, "unauth", 401, false), false},
{"plain error", &RateLimitConfigError{Paths: []string{"/tmp"}, PathErrors: map[string]string{"/tmp": "not found"}}, false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := IsRetryable(tt.err); got != tt.want {
t.Fatalf("IsRetryable() = %v, want %v", got, tt.want)
}
})
}
}
func TestCoverageMicro_GetStatusCode(t *testing.T) {
tests := []struct {
name string
err error
want int
}{
{"nil error returns 200", nil, 200},
{"proxy error returns status code", NewProxyError(ErrCodeBadGateway, "bad gw", 502, false), 502},
{"non-proxy error returns 500", &RateLimitConfigError{Paths: []string{}, PathErrors: map[string]string{}}, 500},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := GetStatusCode(tt.err); got != tt.want {
t.Fatalf("GetStatusCode() = %d, want %d", got, tt.want)
}
})
}
}
// ---------------------------------------------------------------------------
// ratelimit_errors.go
// ---------------------------------------------------------------------------
func TestCoverageMicro_RateLimitConfigError_Error(t *testing.T) {
t.Run("contains paths in output", func(t *testing.T) {
paths := []string{"/etc/ratelimit.json", "/app/ratelimit.json"}
e := NewRateLimitConfigError(paths)
e.PathErrors["/etc/ratelimit.json"] = "permission denied"
e.PathErrors["/app/ratelimit.json"] = "file not found"
msg := e.Error()
if !strings.Contains(msg, "/etc/ratelimit.json") {
t.Error("expected path /etc/ratelimit.json in error message")
}
if !strings.Contains(msg, "permission denied") {
t.Error("expected error detail in message")
}
})
t.Run("empty paths produces valid string", func(t *testing.T) {
e := NewRateLimitConfigError(nil)
msg := e.Error()
if msg == "" {
t.Error("expected non-empty error message even with no paths")
}
})
}
// ---------------------------------------------------------------------------
// backend_health.go
// ---------------------------------------------------------------------------
func TestCoverageMicro_BackendHealth(t *testing.T) {
logger := libpack_logger.New()
client := &fasthttp.Client{}
t.Run("updateHealthStatus healthy→unhealthy transition", func(t *testing.T) {
bhm := NewBackendHealthManager(client, "http://localhost:9999", logger)
defer bhm.Shutdown()
// Start healthy
bhm.isHealthy.Store(true)
bhm.updateHealthStatus(false)
if bhm.IsHealthy() {
t.Error("expected unhealthy after updateHealthStatus(false)")
}
if bhm.GetConsecutiveFailures() != 1 {
t.Errorf("expected 1 consecutive failure, got %d", bhm.GetConsecutiveFailures())
}
})
t.Run("updateHealthStatus unhealthy→healthy resets counter", func(t *testing.T) {
bhm := NewBackendHealthManager(client, "http://localhost:9999", logger)
defer bhm.Shutdown()
bhm.isHealthy.Store(false)
bhm.consecutiveFails.Store(5)
bhm.updateHealthStatus(true)
if !bhm.IsHealthy() {
t.Error("expected healthy after updateHealthStatus(true)")
}
if bhm.GetConsecutiveFailures() != 0 {
t.Errorf("expected 0 failures after recovery, got %d", bhm.GetConsecutiveFailures())
}
})
t.Run("GetLastHealthCheck round-trip", func(t *testing.T) {
bhm := NewBackendHealthManager(client, "http://localhost:9999", logger)
defer bhm.Shutdown()
before := time.Now()
bhm.updateHealthStatus(true)
after := time.Now()
last := bhm.GetLastHealthCheck()
if last.Before(before) || last.After(after) {
t.Errorf("last health check time %v outside expected range [%v, %v]", last, before, after)
}
})
t.Run("nil receiver safe", func(t *testing.T) {
var nilBHM *BackendHealthManager
nilBHM.updateHealthStatus(true) // must not panic
if !nilBHM.GetLastHealthCheck().IsZero() {
t.Error("expected zero time for nil receiver")
}
})
}
// ---------------------------------------------------------------------------
// graphql.go — trackParsingAllocations
// ---------------------------------------------------------------------------
func TestCoverageMicro_TrackParsingAllocations(t *testing.T) {
t.Run("returned closure runs without panic", func(t *testing.T) {
done := trackParsingAllocations()
// Execute some allocations between start and stop
_ = make([]byte, 1024)
done() // must not panic regardless of cfg.Monitoring state
})
t.Run("closure safe when cfg.Monitoring is nil", func(t *testing.T) {
// Only manipulate cfg.Monitoring if cfg is already initialised
cfgMutex.RLock()
cfgInitialised := cfg != nil
cfgMutex.RUnlock()
if cfgInitialised {
cfgMutex.Lock()
origMonitoring := cfg.Monitoring
cfg.Monitoring = nil
cfgMutex.Unlock()
defer func() {
cfgMutex.Lock()
cfg.Monitoring = origMonitoring
cfgMutex.Unlock()
}()
}
done := trackParsingAllocations()
done() // must not panic regardless of monitoring state
})
}
// ---------------------------------------------------------------------------
// retry_budget.go — UpdateConfig
// ---------------------------------------------------------------------------
func TestCoverageMicro_RetryBudget_UpdateConfig(t *testing.T) {
t.Run("config fields applied", func(t *testing.T) {
initial := RetryBudgetConfig{TokensPerSecond: 5.0, MaxTokens: 50, Enabled: true}
rb := NewRetryBudget(initial, nil)
defer rb.Shutdown()
newCfg := RetryBudgetConfig{TokensPerSecond: 20.0, MaxTokens: 200, Enabled: false}
rb.UpdateConfig(newCfg)
if rb.tokensPerSecond != 20.0 {
t.Errorf("tokensPerSecond: want 20.0, got %v", rb.tokensPerSecond)
}
if rb.maxTokens != 200 {
t.Errorf("maxTokens: want 200, got %v", rb.maxTokens)
}
if rb.enabled {
t.Error("expected enabled=false after UpdateConfig")
}
// currentTokens should equal maxTokens after reset
if rb.currentTokens.Load() != 200 {
t.Errorf("currentTokens: want 200, got %v", rb.currentTokens.Load())
}
})
}
// ---------------------------------------------------------------------------
// rps_tracker.go
// ---------------------------------------------------------------------------
func TestCoverageMicro_RPSTracker(t *testing.T) {
t.Run("NewRPSTracker returns non-nil", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
tracker := NewRPSTracker(ctx)
if tracker == nil {
t.Fatal("expected non-nil RPSTracker")
}
tracker.Shutdown()
})
t.Run("RecordRequest increments counter", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
tracker := NewRPSTracker(ctx)
defer tracker.Shutdown()
for range 10 {
tracker.RecordRequest()
}
if tracker.lastCount.Load() != 10 {
t.Errorf("expected 10, got %d", tracker.lastCount.Load())
}
})
t.Run("GetCurrentRPS returns zero before first sample", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
tracker := NewRPSTracker(ctx)
defer tracker.Shutdown()
rps := tracker.GetCurrentRPS()
if rps < 0 {
t.Errorf("RPS should not be negative, got %v", rps)
}
})
t.Run("sample calculates non-zero RPS after requests", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
tracker := NewRPSTracker(ctx)
defer tracker.Shutdown()
// Record requests, then manually advance the sample time to simulate 1s elapsed
for range 50 {
tracker.RecordRequest()
}
// Set lastSampleTime to 1 second ago so elapsed > 0
tracker.lastSampleTime.Store(time.Now().Add(-1 * time.Second).UnixNano())
tracker.sample()
rps := tracker.GetCurrentRPS()
if rps <= 0 {
t.Errorf("expected RPS > 0 after sample with requests, got %v", rps)
}
})
t.Run("Shutdown stops gracefully", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
tracker := NewRPSTracker(ctx)
// Should not block
done := make(chan struct{})
go func() {
tracker.Shutdown()
close(done)
}()
select {
case <-done:
case <-time.After(2 * time.Second):
t.Error("Shutdown blocked for > 2s")
}
})
}
// ---------------------------------------------------------------------------
// metrics_aggregator.go — GetInstanceID, IsClusterMode (no Redis), GetInstanceHostname
// ---------------------------------------------------------------------------
func TestCoverageMicro_MetricsAggregatorGetters(t *testing.T) {
t.Run("GetInstanceID returns stored ID", func(t *testing.T) {
ma := &MetricsAggregator{instanceID: "test-instance-abc"}
if got := ma.GetInstanceID(); got != "test-instance-abc" {
t.Errorf("want test-instance-abc, got %q", got)
}
})
t.Run("GetInstanceHostname returns non-empty string", func(t *testing.T) {
host := GetInstanceHostname()
if host == "" {
t.Error("GetInstanceHostname returned empty string")
}
// Must not contain a dot (domain suffix stripped)
if strings.Contains(host, ".") {
t.Errorf("hostname should have domain stripped, got %q", host)
}
})
}
// ---------------------------------------------------------------------------
// websocket.go — IsWebSocketRequest
// ---------------------------------------------------------------------------
func TestCoverageMicro_IsWebSocketRequest(t *testing.T) {
tests := []struct {
name string
setHeaders func(*fasthttp.RequestHeader)
want bool
}{
{
name: "Upgrade websocket header set",
setHeaders: func(h *fasthttp.RequestHeader) {
h.Set("Upgrade", "websocket")
h.Set("Connection", "Upgrade")
},
want: true,
},
{
name: "no upgrade headers",
setHeaders: func(h *fasthttp.RequestHeader) {},
want: false,
},
{
name: "Connection Upgrade only",
setHeaders: func(h *fasthttp.RequestHeader) {
h.Set("Connection", "Upgrade")
},
want: true,
},
}
app := fiber.New()
app.Get("/ws-test", func(c fiber.Ctx) error {
result := IsWebSocketRequest(c)
if result {
return c.SendStatus(101)
}
return c.SendStatus(200)
})
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
req := httptest.NewRequest("GET", "/ws-test", nil)
tt.setHeaders(&fasthttp.RequestHeader{})
// Set headers on net/http request which fiber will read
switch tt.name {
case "Upgrade websocket header set":
req.Header.Set("Upgrade", "websocket")
req.Header.Set("Connection", "Upgrade")
case "Connection Upgrade only":
req.Header.Set("Connection", "Upgrade")
}
resp, err := app.Test(req, fiber.TestConfig{Timeout: 0})
if err != nil {
t.Fatalf("app.Test error: %v", err)
}
_ = resp.Body.Close()
wantCode := 200
if tt.want {
wantCode = 101
}
if resp.StatusCode != wantCode {
t.Errorf("status: want %d, got %d", wantCode, resp.StatusCode)
}
})
}
}
// ---------------------------------------------------------------------------
// admin_dashboard.go — getMapKeys
// ---------------------------------------------------------------------------
func TestCoverageMicro_GetMapKeys(t *testing.T) {
t.Run("nil map returns empty slice", func(t *testing.T) {
keys := getMapKeys(nil)
if len(keys) != 0 {
t.Errorf("expected empty slice for nil map, got %v", keys)
}
})
t.Run("empty map returns empty slice", func(t *testing.T) {
keys := getMapKeys(map[string]any{})
if len(keys) != 0 {
t.Errorf("expected empty slice, got %v", keys)
}
})
t.Run("populated map returns all keys", func(t *testing.T) {
m := map[string]any{"alpha": 1, "beta": 2, "gamma": 3}
keys := getMapKeys(m)
if len(keys) != 3 {
t.Fatalf("expected 3 keys, got %d: %v", len(keys), keys)
}
sort.Strings(keys)
want := []string{"alpha", "beta", "gamma"}
for i, k := range keys {
if k != want[i] {
t.Errorf("key[%d]: want %q, got %q", i, want[i], k)
}
}
})
}
// ---------------------------------------------------------------------------
// proxy.go — setupTracing (tracing disabled path)
// ---------------------------------------------------------------------------
func TestCoverageMicro_SetupTracing_Disabled(t *testing.T) {
t.Run("tracing disabled returns background context", func(t *testing.T) {
// Ensure cfg is initialised before reading it
cfgMutex.RLock()
needsInit := cfg == nil
cfgMutex.RUnlock()
if needsInit {
parseConfig()
}
// Ensure tracing is disabled
cfgMutex.Lock()
origEnable := cfg.Tracing.Enable
cfg.Tracing.Enable = false
cfgMutex.Unlock()
defer func() {
cfgMutex.Lock()
cfg.Tracing.Enable = origEnable
cfgMutex.Unlock()
}()
app := fiber.New()
var capturedCtx context.Context
app.Get("/trace-test", func(c fiber.Ctx) error {
capturedCtx = setupTracing(c)
return c.SendStatus(200)
})
req := httptest.NewRequest("GET", "/trace-test", nil)
resp, err := app.Test(req, fiber.TestConfig{Timeout: 0})
if err != nil {
t.Fatalf("app.Test error: %v", err)
}
_ = resp.Body.Close()
if capturedCtx == nil {
t.Fatal("setupTracing returned nil context")
}
// Background context has no deadline
if _, hasDeadline := capturedCtx.Deadline(); hasDeadline {
t.Error("expected no deadline on returned context")
}
})
}
-143
View File
@@ -1,143 +0,0 @@
package main
import (
"fmt"
"strings"
fiber "github.com/gofiber/fiber/v3"
"github.com/graphql-go/graphql/language/ast"
"github.com/graphql-go/graphql/language/parser"
"github.com/graphql-go/graphql/language/source"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
)
// debugParseGraphQLQuery provides detailed logging for mutation routing analysis
// This is automatically called when LOG_LEVEL=DEBUG to help identify routing issues
//
// It logs:
// - GraphQL query structure (operations, selections, directives)
// - Final routing decision (which endpoint was chosen)
// - Automatic detection of mutations routed to wrong endpoints
//
// To enable: Set LOG_LEVEL=DEBUG and restart the proxy
func debugParseGraphQLQuery(c fiber.Ctx, query string) {
if cfg == nil || cfg.Logger == nil {
return
}
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "=== DEBUG: Parsing GraphQL Query ===",
Pairs: map[string]any{
"query_length": len(query),
"query_preview": truncateString(query, 100),
},
})
// Parse the query
src := source.NewSource(&source.Source{
Body: []byte(query),
Name: "Debug GraphQL request",
})
p, err := parser.Parse(parser.ParseParams{Source: src})
if err != nil {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "DEBUG: Failed to parse query",
Pairs: map[string]any{"error": err.Error()},
})
return
}
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "DEBUG: Query parsed successfully",
Pairs: map[string]any{
"definitions_count": len(p.Definitions),
},
})
// Analyze each definition
for i, d := range p.Definitions {
if oper, ok := d.(*ast.OperationDefinition); ok {
operationType := strings.ToLower(oper.Operation)
operationName := "unnamed"
if oper.Name != nil {
operationName = oper.Name.Value
}
// Count selections
selectionCount := 0
if oper.SelectionSet != nil {
selectionCount = len(oper.GetSelectionSet().Selections)
}
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: fmt.Sprintf("DEBUG: Definition #%d (OperationDefinition)", i),
Pairs: map[string]any{
"operation_type": operationType,
"operation_name": operationName,
"selection_count": selectionCount,
"is_mutation": operationType == "mutation",
"directive_count": len(oper.Directives),
},
})
// Log selections for mutations
if operationType == "mutation" && oper.SelectionSet != nil {
for j, sel := range oper.GetSelectionSet().Selections {
if field, ok := sel.(*ast.Field); ok {
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: fmt.Sprintf("DEBUG: Mutation field #%d", j),
Pairs: map[string]any{
"field_name": field.Name.Value,
},
})
}
}
}
} else if frag, ok := d.(*ast.FragmentDefinition); ok {
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: fmt.Sprintf("DEBUG: Definition #%d (FragmentDefinition)", i),
Pairs: map[string]any{
"fragment_name": frag.Name.Value,
},
})
}
}
// Now run the actual parsing to see the result
result := parseGraphQLQuery(c)
cfg.Logger.Info(&libpack_logger.LogMessage{
Message: "DEBUG: Final routing decision",
Pairs: map[string]any{
"operation_type": result.operationType,
"operation_name": result.operationName,
"active_endpoint": result.activeEndpoint,
"should_block": result.shouldBlock,
"should_ignore": result.shouldIgnore,
"write_endpoint": cfg.Server.HostGraphQL,
"read_endpoint": cfg.Server.HostGraphQLReadOnly,
"is_using_write": result.activeEndpoint == cfg.Server.HostGraphQL,
},
})
// Check for potential issues
if result.operationType == "mutation" && result.activeEndpoint != cfg.Server.HostGraphQL {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "DEBUG: ⚠️ BUG DETECTED: Mutation routed to wrong endpoint!",
Pairs: map[string]any{
"expected_endpoint": cfg.Server.HostGraphQL,
"actual_endpoint": result.activeEndpoint,
},
})
}
if result.operationType == "mutation" && strings.Contains(strings.ToLower(result.activeEndpoint), "read") {
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: "DEBUG: ⚠️ CRITICAL: Mutation endpoint contains 'read' in URL!",
Pairs: map[string]any{
"endpoint": result.activeEndpoint,
},
})
}
}
+26 -117
View File
@@ -7,138 +7,47 @@ import (
"github.com/goccy/go-json"
"github.com/lukaszraczylo/ask"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
)
const defaultValue = "-"
func extractClaimsFromJWTHeader(authorization string) (usr string, role string) {
usr, role = "-", "-"
var emptyMetrics = map[string]string{}
// extractClaimsFromJWTHeader extracts the user ID and role claim from an
// Authorization header value.
//
// When cfg.Client.JWTVerifier is set (JWT_VERIFY_SIGNATURE=true), the token
// signature is checked first; a signature, expiry, or algorithm failure
// returns a non-nil err and the caller must not trust usr/role (this is the
// fix for GHSA-9gqw-h2rw-44wv, where a forged token with a guessed claim
// could otherwise read another user's cached response).
//
// When JWTVerifier is nil (the default), this falls back to the legacy
// path: the payload is decoded without checking its signature, exactly as
// before this field existed. err is always nil on that path, matching
// pre-verification behaviour byte for byte.
func extractClaimsFromJWTHeader(authorization string) (usr, role string, err error) {
usr, role = defaultValue, defaultValue
if cfg.Client.JWTVerifier != nil {
claimMap, verr := cfg.Client.JWTVerifier.Verify(authorization)
if verr != nil {
handleError("JWT verification failed", map[string]any{"token": maskToken(authorization)})
return defaultValue, defaultValue, verr
}
usr = extractClaim(claimMap, cfg.Client.JWTUserClaimPath, "user id")
role = extractClaim(claimMap, cfg.Client.JWTRoleClaimPath, "role")
return usr, role, nil
handleError := func(msg string, details map[string]interface{}) {
cfg.Monitoring.Increment(libpack_monitoring.MetricsFailed, nil)
cfg.Logger.Error(msg, details)
}
tokenParts := strings.SplitN(authorization, ".", 3)
tokenParts := strings.Split(authorization, ".")
if len(tokenParts) != 3 {
handleError("Can't split the token", map[string]any{"token": maskToken(authorization)})
return usr, role, nil
handleError("Can't split the token", map[string]interface{}{"token": authorization})
return
}
claim, decErr := base64.RawURLEncoding.DecodeString(tokenParts[1])
if decErr != nil {
handleError("Can't decode the token", map[string]any{"token": maskToken(authorization)})
return usr, role, nil
claim, err := base64.RawURLEncoding.DecodeString(tokenParts[1])
if err != nil {
handleError("Can't decode the token", map[string]interface{}{"token": authorization})
return
}
var claimMap map[string]any
if jsonErr := json.Unmarshal(claim, &claimMap); jsonErr != nil {
handleError("Can't unmarshal the claim", map[string]any{"token": maskToken(authorization)})
return usr, role, nil
var claimMap map[string]interface{}
if err = json.Unmarshal(claim, &claimMap); err != nil {
handleError("Can't unmarshal the claim", map[string]interface{}{"token": authorization})
return
}
usr = extractClaim(claimMap, cfg.Client.JWTUserClaimPath, "user id")
role = extractClaim(claimMap, cfg.Client.JWTRoleClaimPath, "role")
return usr, role, nil
}
func extractClaim(claimMap map[string]any, claimPath, name string) string {
if claimPath == "" {
return defaultValue
}
// Validate claim path to prevent injection attacks
if !isValidClaimPath(claimPath) {
handleError(fmt.Sprintf("Invalid claim path for %s", name), map[string]any{"path": claimPath})
return defaultValue
}
value, ok := ask.For(claimMap, claimPath).String(defaultValue)
if !ok {
handleError(fmt.Sprintf("Can't find the %s", name), map[string]any{"claim_map": sanitizeClaimMap(claimMap), "path": claimPath})
return defaultValue
}
return value
}
// maskToken masks JWT tokens in logs to prevent exposure
func maskToken(token string) string {
if len(token) <= 10 {
return "***"
}
return token[:4] + "***" + token[len(token)-4:]
}
// isValidClaimPath validates JWT claim paths to prevent injection
func isValidClaimPath(path string) bool {
if path == "" {
return false
}
// Allow only alphanumeric characters, dots, underscores, and hyphens
for _, char := range path {
if (char < 'a' || char > 'z') &&
(char < 'A' || char > 'Z') &&
(char < '0' || char > '9') &&
char != '.' && char != '_' && char != '-' {
return false
extractClaim := func(claimPath string, target *string, name string) {
if len(claimPath) > 0 {
var ok bool
*target, ok = ask.For(claimMap, claimPath).String("-")
if !ok {
handleError(fmt.Sprintf("Can't find the %s", name), map[string]interface{}{"claim_map": claimMap, "path": claimPath})
}
}
}
// Prevent path traversal attempts
if strings.Contains(path, "..") || strings.Contains(path, "//") {
return false
}
return true
}
// sanitizeClaimMap removes sensitive data from claim map for logging
func sanitizeClaimMap(claimMap map[string]any) map[string]any {
sanitized := make(map[string]any)
sensitiveKeys := map[string]bool{
"password": true, "secret": true, "token": true, "key": true,
"auth": true, "credential": true, "private": true,
}
extractClaim(cfg.Client.JWTUserClaimPath, &usr, "user id")
extractClaim(cfg.Client.JWTRoleClaimPath, &role, "role")
for k, v := range claimMap {
lowerKey := strings.ToLower(k)
if sensitiveKeys[lowerKey] {
sanitized[k] = "***"
} else {
sanitized[k] = v
}
}
return sanitized
}
func handleError(msg string, details map[string]any) {
cfg.Monitoring.Increment(libpack_monitoring.MetricsFailed, emptyMetrics)
cfg.Logger.Error(&libpack_logger.LogMessage{
Message: msg,
Pairs: details,
})
return
}
+3 -4
View File
@@ -73,10 +73,9 @@ func (suite *Tests) Test_extractClaimsFromJWTHeader() {
if len(tt.jwt_role_path) > 0 {
cfg.Client.JWTRoleClaimPath = tt.jwt_role_path
}
gotUsr, gotRole, err := extractClaimsFromJWTHeader(tt.args.authorization)
suite.NoError(err, "Unexpected verification error")
suite.Equal(tt.wantUsr, gotUsr, "Unexpected user ID")
suite.Equal(tt.wantRole, gotRole, "Unexpected role")
gotUsr, gotRole := extractClaimsFromJWTHeader(tt.args.authorization)
assert.Equal(tt.wantUsr, gotUsr, "Unexpected user ID")
assert.Equal(tt.wantRole, gotRole, "Unexpected role")
})
}
}
-1
View File
@@ -1 +0,0 @@
graphql-monitoring-proxy.raczylo.com
View File
-707
View File
@@ -1,707 +0,0 @@
<!doctype html>
<html lang="en" class="scroll-smooth">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>GraphQL Monitoring Proxy - High-Performance GraphQL Gateway</title>
<meta
name="description"
content="High-performance GraphQL proxy with monitoring, caching, circuit breaker, rate limiting, and security features. Zero cost monitoring, tested at 30k queries/second."
/>
<script src="https://cdn.tailwindcss.com"></script>
<script>
tailwind.config = {
darkMode: 'class'
}
</script>
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css"
/>
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap"
rel="stylesheet"
/>
<style>
body { font-family: "Inter", sans-serif; }
code, pre { font-family: "JetBrains Mono", monospace; }
.theme-transition {
transition: background-color 0.3s ease, color 0.3s ease, border-color 0.3s ease;
}
@keyframes fadeInUp {
from { opacity: 0; transform: translateY(20px); }
to { opacity: 1; transform: translateY(0); }
}
@keyframes float {
0%, 100% { transform: translateY(0px); }
50% { transform: translateY(-10px); }
}
.animate-fade-in-up { animation: fadeInUp 0.6s ease-out; }
.animate-float { animation: float 3s ease-in-out infinite; }
.glass {
background: rgba(255, 255, 255, 0.7);
backdrop-filter: blur(10px);
-webkit-backdrop-filter: blur(10px);
border: 1px solid rgba(255, 255, 255, 0.2);
}
.dark .glass {
background: rgba(17, 24, 39, 0.7);
border: 1px solid rgba(255, 255, 255, 0.1);
}
.gradient-text {
background: linear-gradient(135deg, #e879f9 0%, #818cf8 100%);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
}
.dark .gradient-text {
background: linear-gradient(135deg, #f0abfc 0%, #a5b4fc 100%);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
}
.shadow-modern { box-shadow: 0 10px 40px -10px rgba(0, 0, 0, 0.1); }
.dark .shadow-modern { box-shadow: 0 10px 40px -10px rgba(0, 0, 0, 0.4); }
html { scroll-behavior: smooth; }
</style>
<script>
if (localStorage.theme === "dark" || (!("theme" in localStorage) && window.matchMedia("(prefers-color-scheme: dark)").matches)) {
document.documentElement.classList.add("dark");
} else {
document.documentElement.classList.remove("dark");
}
</script>
</head>
<body class="bg-white dark:bg-gray-900 text-gray-900 dark:text-gray-100 theme-transition">
<!-- Navigation -->
<nav class="fixed w-full glass shadow-modern z-50 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="flex justify-between h-16 items-center">
<a href="#" class="flex items-center hover:opacity-80 transition-opacity duration-300 gap-2">
<i class="fas fa-diagram-project text-2xl gradient-text"></i>
<span class="text-xl font-bold gradient-text">graphql-monitoring-proxy</span>
</a>
<div class="hidden md:flex space-x-6">
<a href="#features" class="text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 font-medium">Features</a>
<a href="#monitoring" class="text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 font-medium">Monitoring</a>
<a href="#speed" class="text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 font-medium">Speed</a>
<a href="#security" class="text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 font-medium">Security</a>
<a href="#resilience" class="text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 font-medium">Resilience</a>
<a href="#installation" class="text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 font-medium">Install</a>
</div>
<div class="flex items-center space-x-4">
<button id="theme-toggle" class="text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 p-2 min-w-[44px] min-h-[44px] flex items-center justify-center" aria-label="Toggle theme">
<i class="fas fa-moon dark:hidden text-xl"></i>
<i class="fas fa-sun hidden dark:inline text-xl"></i>
</button>
<a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy" target="_blank" class="text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 p-2 min-w-[44px] min-h-[44px] flex items-center justify-center" aria-label="View on GitHub">
<i class="fab fa-github text-xl"></i>
</a>
<button id="mobile-menu-toggle" class="md:hidden text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 p-2 min-w-[44px] min-h-[44px] flex items-center justify-center" aria-label="Toggle menu">
<i class="fas fa-bars text-xl" id="menu-open-icon"></i>
<i class="fas fa-times text-xl hidden" id="menu-close-icon"></i>
</button>
</div>
</div>
</div>
<div id="mobile-menu" class="hidden md:hidden border-t border-gray-200 dark:border-gray-700">
<div class="px-4 py-3 space-y-1 bg-white dark:bg-gray-800">
<a href="#features" class="block px-3 py-3 text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 hover:bg-gray-50 dark:hover:bg-gray-700 rounded font-medium">Features</a>
<a href="#monitoring" class="block px-3 py-3 text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 hover:bg-gray-50 dark:hover:bg-gray-700 rounded font-medium">Monitoring</a>
<a href="#speed" class="block px-3 py-3 text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 hover:bg-gray-50 dark:hover:bg-gray-700 rounded font-medium">Speed</a>
<a href="#security" class="block px-3 py-3 text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 hover:bg-gray-50 dark:hover:bg-gray-700 rounded font-medium">Security</a>
<a href="#resilience" class="block px-3 py-3 text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 hover:bg-gray-50 dark:hover:bg-gray-700 rounded font-medium">Resilience</a>
<a href="#installation" class="block px-3 py-3 text-gray-600 dark:text-gray-300 hover:text-gray-900 dark:hover:text-gray-100 hover:bg-gray-50 dark:hover:bg-gray-700 rounded font-medium">Install</a>
</div>
</div>
</nav>
<!-- Hero Section -->
<section class="relative pt-24 sm:pt-32 pb-12 sm:pb-20 overflow-hidden">
<div class="absolute inset-0 bg-gradient-to-br from-fuchsia-50 via-violet-50 to-indigo-50 dark:from-gray-900 dark:via-fuchsia-900/20 dark:to-indigo-900/20 theme-transition"></div>
<div class="absolute top-0 -left-4 w-72 h-72 bg-fuchsia-300 dark:bg-fuchsia-500 rounded-full mix-blend-multiply dark:mix-blend-soft-light filter blur-xl opacity-20 animate-float"></div>
<div class="absolute top-0 -right-4 w-72 h-72 bg-violet-300 dark:bg-violet-500 rounded-full mix-blend-multiply dark:mix-blend-soft-light filter blur-xl opacity-20 animate-float" style="animation-delay: 1s;"></div>
<div class="absolute -bottom-8 left-20 w-72 h-72 bg-indigo-300 dark:bg-indigo-500 rounded-full mix-blend-multiply dark:mix-blend-soft-light filter blur-xl opacity-20 animate-float" style="animation-delay: 2s;"></div>
<div class="relative max-w-6xl mx-auto px-4 sm:px-6">
<div class="text-center">
<div class="mb-8 sm:mb-10 flex justify-center animate-fade-in-up">
<div class="text-8xl sm:text-9xl animate-float">
<i class="fas fa-diagram-project gradient-text"></i>
</div>
</div>
<h1 class="text-3xl sm:text-4xl md:text-5xl lg:text-6xl font-bold text-gray-900 dark:text-gray-100 mb-4 sm:mb-6 leading-tight animate-fade-in-up" style="animation-delay: 0.1s;">
GraphQL Monitoring<br /><span class="gradient-text">Proxy</span>
</h1>
<p class="text-base sm:text-lg md:text-xl text-gray-600 dark:text-gray-300 mb-8 sm:mb-10 max-w-3xl mx-auto leading-relaxed px-4 animate-fade-in-up" style="animation-delay: 0.2s;">
Enterprise-grade GraphQL gateway with Prometheus metrics, smart caching, circuit breaker, rate limiting, request coalescing, WebSocket subscriptions, and comprehensive security - all at zero cost.
</p>
<div class="flex flex-col sm:flex-row gap-3 sm:gap-4 justify-center mb-8 sm:mb-12 px-4 animate-fade-in-up" style="animation-delay: 0.3s;">
<a href="#installation" class="group relative bg-gradient-to-r from-fuchsia-500 to-indigo-600 hover:from-fuchsia-600 hover:to-indigo-700 text-white px-8 py-3 rounded-lg font-medium transition-all duration-300 min-h-[48px] flex items-center justify-center shadow-lg hover:shadow-xl hover:scale-105">
<span class="relative z-10">Get Started</span>
</a>
<a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy" class="group glass hover:shadow-lg text-gray-900 dark:text-gray-100 px-8 py-3 rounded-lg font-medium transition-all duration-300 min-h-[48px] flex items-center justify-center hover:scale-105">
<i class="fab fa-github mr-2"></i>View on GitHub
</a>
</div>
<div class="flex flex-wrap justify-center gap-2 sm:gap-4 text-sm px-4">
<img src="https://img.shields.io/github/v/release/lukaszraczylo/graphql-monitoring-proxy" alt="Version" class="h-5" />
<img src="https://img.shields.io/github/license/lukaszraczylo/graphql-monitoring-proxy" alt="License" class="h-5" />
<img src="https://goreportcard.com/badge/github.com/lukaszraczylo/graphql-monitoring-proxy" alt="Go Report" class="h-5" />
</div>
<div class="mt-12 sm:mt-16 max-w-3xl mx-auto px-4 animate-fade-in-up" style="animation-delay: 0.4s;">
<div class="relative group">
<div class="absolute -inset-1 bg-gradient-to-r from-fuchsia-500 to-indigo-600 rounded-xl blur opacity-25 group-hover:opacity-50 transition duration-500"></div>
<div class="relative bg-gray-900 rounded-xl p-6 text-left">
<div class="flex items-center gap-2 mb-4">
<div class="w-3 h-3 rounded-full bg-red-500"></div>
<div class="w-3 h-3 rounded-full bg-yellow-500"></div>
<div class="w-3 h-3 rounded-full bg-green-500"></div>
<span class="ml-2 text-gray-400 text-sm">terminal</span>
</div>
<pre class="text-gray-100 text-sm sm:text-base overflow-x-auto"><code><span class="text-gray-400"># Run with Docker</span>
<span class="text-fuchsia-400">$</span> docker run -p 8080:8080 -p 9393:9393 \
-e GMP_HOST_GRAPHQL=http://your-graphql:4000/ \
-e GMP_ENABLE_GLOBAL_CACHE=true \
-e GMP_ENABLE_CIRCUIT_BREAKER=true \
ghcr.io/lukaszraczylo/graphql-monitoring-proxy:latest</code></pre>
</div>
</div>
</div>
</div>
</div>
</section>
<!-- Performance Stats -->
<section class="py-12 sm:py-16 bg-white dark:bg-gray-900 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="grid sm:grid-cols-4 gap-4 text-center">
<div class="glass p-6 rounded-xl">
<div class="text-4xl font-bold gradient-text mb-2">30k+</div>
<p class="text-sm text-gray-600 dark:text-gray-400">Queries/second</p>
</div>
<div class="glass p-6 rounded-xl">
<div class="text-4xl font-bold gradient-text mb-2">10MB</div>
<p class="text-sm text-gray-600 dark:text-gray-400">RAM usage</p>
</div>
<div class="glass p-6 rounded-xl">
<div class="text-4xl font-bold gradient-text mb-2">0.1%</div>
<p class="text-sm text-gray-600 dark:text-gray-400">CPU usage</p>
</div>
<div class="glass p-6 rounded-xl">
<div class="text-4xl font-bold gradient-text mb-2">$0</div>
<p class="text-sm text-gray-600 dark:text-gray-400">Cost</p>
</div>
</div>
<div class="mt-6 text-center">
<a href="bench/" class="inline-flex items-center text-fuchsia-600 dark:text-fuchsia-400 hover:underline font-medium">
View benchmarks
<i class="fas fa-arrow-right ml-2"></i>
</a>
</div>
</div>
</section>
<!-- Features Overview -->
<section id="features" class="py-12 sm:py-16 md:py-20 bg-gray-50 dark:bg-gray-800 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="text-center mb-8 sm:mb-12">
<h2 class="text-2xl sm:text-3xl md:text-4xl font-bold text-gray-900 dark:text-gray-100 mb-3 sm:mb-4">Feature Overview</h2>
<p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 px-4">Everything you need for production GraphQL</p>
</div>
<div class="grid sm:grid-cols-2 lg:grid-cols-4 gap-4">
<div class="glass p-5 rounded-xl group hover:shadow-lg transition-all duration-300">
<div class="w-12 h-12 rounded-xl bg-gradient-to-br from-fuchsia-500 to-fuchsia-600 flex items-center justify-center mb-4 group-hover:scale-110 transition-transform duration-300">
<i class="fas fa-chart-line text-white"></i>
</div>
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-2">Monitoring</h3>
<p class="text-sm text-gray-600 dark:text-gray-400">Prometheus metrics, OpenTelemetry tracing, admin dashboard</p>
</div>
<div class="glass p-5 rounded-xl group hover:shadow-lg transition-all duration-300">
<div class="w-12 h-12 rounded-xl bg-gradient-to-br from-violet-500 to-violet-600 flex items-center justify-center mb-4 group-hover:scale-110 transition-transform duration-300">
<i class="fas fa-bolt text-white"></i>
</div>
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-2">Speed</h3>
<p class="text-sm text-gray-600 dark:text-gray-400">Smart caching, request coalescing, read-only replicas</p>
</div>
<div class="glass p-5 rounded-xl group hover:shadow-lg transition-all duration-300">
<div class="w-12 h-12 rounded-xl bg-gradient-to-br from-indigo-500 to-indigo-600 flex items-center justify-center mb-4 group-hover:scale-110 transition-transform duration-300">
<i class="fas fa-shield-halved text-white"></i>
</div>
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-2">Security</h3>
<p class="text-sm text-gray-600 dark:text-gray-400">Rate limiting, introspection blocking, user banning</p>
</div>
<div class="glass p-5 rounded-xl group hover:shadow-lg transition-all duration-300">
<div class="w-12 h-12 rounded-xl bg-gradient-to-br from-rose-500 to-rose-600 flex items-center justify-center mb-4 group-hover:scale-110 transition-transform duration-300">
<i class="fas fa-heart-pulse text-white"></i>
</div>
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-2">Resilience</h3>
<p class="text-sm text-gray-600 dark:text-gray-400">Circuit breaker, retry budget, connection recovery</p>
</div>
</div>
</div>
</section>
<!-- Monitoring Section -->
<section id="monitoring" class="py-12 sm:py-16 md:py-20 bg-white dark:bg-gray-900 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="text-center mb-8 sm:mb-12">
<h2 class="text-2xl sm:text-3xl md:text-4xl font-bold text-gray-900 dark:text-gray-100 mb-3 sm:mb-4">
<i class="fas fa-chart-line gradient-text mr-3"></i>Monitoring
</h2>
<p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 px-4">Complete observability for your GraphQL API</p>
</div>
<div class="grid md:grid-cols-2 gap-6">
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-fire mr-2 text-orange-500"></i>
Prometheus Metrics
</h3>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Query execution timing with histograms</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>User ID extraction from JWT tokens</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Operation name and type tracking</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Cache hit/miss ratios</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Success/failure/skipped counters</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Configurable metrics purging</li>
</ul>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-satellite-dish mr-2 text-blue-500"></i>
OpenTelemetry Tracing
</h3>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Distributed tracing support</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Configurable OTLP collector endpoint</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Trace context propagation via headers</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Child span creation for each request</li>
</ul>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg mt-4 text-xs overflow-x-auto"><code>GMP_ENABLE_TRACE=true
GMP_TRACE_ENDPOINT=localhost:4317</code></pre>
</div>
<div class="glass p-6 rounded-xl md:col-span-2">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-desktop mr-2 text-pink-500"></i>
Real-Time Admin Dashboard
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Web-based UI at <code class="text-fuchsia-600 dark:text-fuchsia-400">/admin</code> with auto-refresh every 5 seconds:</p>
<div class="grid sm:grid-cols-3 gap-4 text-sm">
<div>
<h4 class="font-medium text-gray-900 dark:text-gray-100 mb-2">System Health</h4>
<ul class="space-y-1 text-gray-600 dark:text-gray-400">
<li>Backend GraphQL status</li>
<li>Redis connectivity</li>
<li>Response times</li>
</ul>
</div>
<div>
<h4 class="font-medium text-gray-900 dark:text-gray-100 mb-2">Live Statistics</h4>
<ul class="space-y-1 text-gray-600 dark:text-gray-400">
<li>Request coalescing rate</li>
<li>Retry budget tokens</li>
<li>Active WebSocket connections</li>
</ul>
</div>
<div>
<h4 class="font-medium text-gray-900 dark:text-gray-100 mb-2">Controls</h4>
<ul class="space-y-1 text-gray-600 dark:text-gray-400">
<li>Circuit breaker state</li>
<li>Cache statistics</li>
<li>Reset/clear actions</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<!-- Speed Section -->
<section id="speed" class="py-12 sm:py-16 md:py-20 bg-gray-50 dark:bg-gray-800 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="text-center mb-8 sm:mb-12">
<h2 class="text-2xl sm:text-3xl md:text-4xl font-bold text-gray-900 dark:text-gray-100 mb-3 sm:mb-4">
<i class="fas fa-bolt gradient-text mr-3"></i>Speed
</h2>
<p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 px-4">Maximize throughput, minimize latency</p>
</div>
<div class="grid md:grid-cols-2 gap-6">
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-layer-group mr-2 text-amber-500"></i>
Request Coalescing
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Deduplicate concurrent identical queries - only one request hits the backend, response is shared with all waiting clients.</p>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Reduces backend load 50-80%</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Prevents thundering herd on cache expiry</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Zero latency for primary request</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Enabled by default</li>
</ul>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-database mr-2 text-violet-500"></i>
Smart Caching
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Memory-aware caching with per-user isolation, compression, and flexible TTL control.</p>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>In-memory with LRU eviction</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Distributed Redis cache support</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Per-query TTL via <code>@cached(ttl: 90)</code></li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Force refresh via <code>@cached(refresh: true)</code></li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Automatic gzip compression</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Per-user cache isolation (security)</li>
</ul>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-plug mr-2 text-emerald-500"></i>
WebSocket Subscriptions
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Native GraphQL subscription support with bidirectional proxying.</p>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Automatic ping/pong keep-alive</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Configurable message size limits</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Connection statistics in dashboard</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Graceful connection handling</li>
</ul>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg mt-4 text-xs overflow-x-auto"><code>GMP_WEBSOCKET_ENABLE=true
GMP_WEBSOCKET_PING_INTERVAL=30</code></pre>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-code-branch mr-2 text-cyan-500"></i>
Read-Only Replica Support
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Route queries to read replicas, mutations to primary for maximum throughput.</p>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Automatic query/mutation routing</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Scales read capacity horizontally</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Works with Hasura read replicas</li>
</ul>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg mt-4 text-xs overflow-x-auto"><code>GMP_HOST_GRAPHQL=http://primary:8080/
GMP_HOST_GRAPHQL_READONLY=http://replica:8080/</code></pre>
</div>
</div>
</div>
</section>
<!-- Security Section -->
<section id="security" class="py-12 sm:py-16 md:py-20 bg-white dark:bg-gray-900 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="text-center mb-8 sm:mb-12">
<h2 class="text-2xl sm:text-3xl md:text-4xl font-bold text-gray-900 dark:text-gray-100 mb-3 sm:mb-4">
<i class="fas fa-shield-halved gradient-text mr-3"></i>Security
</h2>
<p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 px-4">Protect your GraphQL API from abuse</p>
</div>
<div class="grid md:grid-cols-2 gap-6">
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-gauge-high mr-2 text-rose-500"></i>
Role-Based Rate Limiting
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Different rate limits per user role with burst control and dynamic config reload.</p>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg text-xs overflow-x-auto"><code>{
"ratelimit": {
"admin": { "req": 1000, "interval": "second", "burst": 2000 },
"premium": { "req": 500, "interval": "second" },
"guest": { "req": 10, "interval": "second" },
"-": { "req": 5, "interval": "second" }
}
}</code></pre>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-eye-slash mr-2 text-indigo-500"></i>
Introspection Blocking
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Block schema introspection to prevent API discovery attacks, with configurable allowlists.</p>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Blocks __schema, __type, etc.</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Deep nested query inspection</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Allowlist specific introspections</li>
</ul>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg mt-4 text-xs overflow-x-auto"><code>GMP_BLOCK_SCHEMA_INTROSPECTION=true
GMP_ALLOWED_INTROSPECTION="__typename"</code></pre>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-ban mr-2 text-red-500"></i>
User Ban/Unban API
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Block misbehaving users detected by your monitoring system.</p>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg text-xs overflow-x-auto"><code>curl -X POST http://localhost:9090/api/user-ban \
-H 'Content-Type: application/json' \
-d '{"user_id": "1337", "reason": "Scraping"}'</code></pre>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-lock mr-2 text-amber-500"></i>
Additional Security
</h3>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>Read-only mode:</strong> Block all mutations</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>URL allowlist:</strong> Restrict accessible endpoints</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>JWT claim extraction:</strong> User ID and role from tokens</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>API authentication:</strong> Optional X-API-Key for the monitoring API only, not the /admin dashboard</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>Log sanitization:</strong> Automatic redaction of sensitive data</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>SQL injection prevention:</strong> Parameterized queries</li>
</ul>
</div>
</div>
</div>
</section>
<!-- Resilience Section -->
<section id="resilience" class="py-12 sm:py-16 md:py-20 bg-gray-50 dark:bg-gray-800 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="text-center mb-8 sm:mb-12">
<h2 class="text-2xl sm:text-3xl md:text-4xl font-bold text-gray-900 dark:text-gray-100 mb-3 sm:mb-4">
<i class="fas fa-heart-pulse gradient-text mr-3"></i>Resilience
</h2>
<p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 px-4">Handle failures gracefully</p>
</div>
<div class="grid md:grid-cols-2 gap-6">
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-toggle-off mr-2 text-rose-500"></i>
Circuit Breaker
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Prevent cascading failures with automatic detection and recovery.</p>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Trip on consecutive failures or ratio</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Automatic recovery after timeout</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Serve cached responses when open</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Configurable for timeouts, 5XX, 4XX</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Exponential backoff support</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Health endpoint: <code>/api/circuit-breaker/health</code></li>
</ul>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-coins mr-2 text-amber-500"></i>
Retry Budget
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Prevent retry storms with token bucket rate limiting.</p>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Token bucket algorithm</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Configurable refill rate</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Prevents overwhelming recovering backends</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Enabled by default</li>
</ul>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg mt-4 text-xs overflow-x-auto"><code>GMP_RETRY_BUDGET_ENABLE=true
GMP_RETRY_BUDGET_TOKENS_PER_SEC=10
GMP_RETRY_BUDGET_MAX_TOKENS=100</code></pre>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-rotate mr-2 text-cyan-500"></i>
Connection Recovery
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Automatic connection pool management and backend health monitoring.</p>
<ul class="space-y-2 text-sm text-gray-600 dark:text-gray-400">
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Backend startup readiness probe</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Keep-alive with health checks</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Automatic pool reset on failures</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i>Intelligent retry with backoff</li>
</ul>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-triangle-exclamation mr-2 text-orange-500"></i>
Graceful Degradation
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">When the circuit is open, the proxy serves a cached response if one is available; otherwise it returns HTTP 503.</p>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg text-xs overflow-x-auto"><code>HTTP/1.1 503 Service Unavailable
Content-Type: text/plain
circuit breaker is open</code></pre>
</div>
</div>
</div>
</section>
<!-- Maintenance Section -->
<section class="py-12 sm:py-16 md:py-20 bg-white dark:bg-gray-900 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="text-center mb-8 sm:mb-12">
<h2 class="text-2xl sm:text-3xl md:text-4xl font-bold text-gray-900 dark:text-gray-100 mb-3 sm:mb-4">
<i class="fas fa-wrench gradient-text mr-3"></i>Maintenance
</h2>
<p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 px-4">Built-in tools for Hasura users</p>
</div>
<div class="max-w-3xl mx-auto">
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-4 flex items-center">
<i class="fas fa-broom mr-2 text-emerald-500"></i>
Hasura Event Cleaner
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Automatically clean up old event logs to prevent database bloat. Runs hourly.</p>
<div class="grid sm:grid-cols-2 gap-4">
<div>
<h4 class="font-medium text-gray-900 dark:text-gray-100 mb-2 text-sm">Tables Cleaned</h4>
<ul class="space-y-1 text-xs text-gray-600 dark:text-gray-400">
<li><code>hdb_catalog.event_invocation_logs</code></li>
<li><code>hdb_catalog.event_log</code></li>
<li><code>hdb_catalog.hdb_action_log</code></li>
<li><code>hdb_catalog.hdb_cron_event_invocation_logs</code></li>
<li><code>hdb_catalog.hdb_scheduled_event_invocation_logs</code></li>
</ul>
</div>
<div>
<h4 class="font-medium text-gray-900 dark:text-gray-100 mb-2 text-sm">Configuration</h4>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg text-xs overflow-x-auto"><code>GMP_HASURA_EVENT_CLEANER=true
GMP_HASURA_EVENT_CLEANER_OLDER_THAN=14
GMP_HASURA_EVENT_METADATA_DB=postgres://...</code></pre>
</div>
</div>
</div>
</div>
</div>
</section>
<!-- Installation Section -->
<section id="installation" class="py-12 sm:py-16 md:py-20 bg-gray-50 dark:bg-gray-800 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="text-center mb-8 sm:mb-12">
<h2 class="text-2xl sm:text-3xl md:text-4xl font-bold text-gray-900 dark:text-gray-100 mb-3 sm:mb-4">Installation</h2>
<p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 px-4">Deploy in seconds</p>
</div>
<div class="max-w-3xl mx-auto space-y-6">
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-3 flex items-center">
<i class="fab fa-docker mr-2 text-blue-500"></i>
Docker
</h3>
<pre class="bg-gray-900 text-gray-100 p-4 rounded-lg overflow-x-auto"><code>docker pull ghcr.io/lukaszraczylo/graphql-monitoring-proxy:latest</code></pre>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-3 flex items-center">
<i class="fas fa-download mr-2 text-fuchsia-500"></i>
Binary Download
</h3>
<p class="text-gray-600 dark:text-gray-400 mb-3">Download from the <a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy/releases/latest" class="text-fuchsia-600 dark:text-fuchsia-400 hover:underline">releases page</a>.</p>
<p class="text-sm text-gray-500 dark:text-gray-400">Supported: Darwin ARM64/AMD64, Linux ARM64/AMD64, Windows AMD64</p>
</div>
<div class="glass p-6 rounded-xl">
<h3 class="font-semibold text-gray-900 dark:text-gray-100 mb-3 flex items-center">
<i class="fas fa-dharmachakra mr-2 text-indigo-500"></i>
Kubernetes
</h3>
<p class="text-gray-600 dark:text-gray-400 mb-3">Example manifests available:</p>
<ul class="text-sm text-gray-500 dark:text-gray-400 space-y-1">
<li><a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy/blob/main/static/kubernetes-deployment.yaml" class="text-fuchsia-600 dark:text-fuchsia-400 hover:underline">Standalone deployment</a></li>
<li><a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy/blob/main/static/kubernetes-single-deployment.yaml" class="text-fuchsia-600 dark:text-fuchsia-400 hover:underline">Combined deployment (proxy + Hasura)</a></li>
<li><a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy/blob/main/static/kubernetes-single-deployment-with-ro.yaml" class="text-fuchsia-600 dark:text-fuchsia-400 hover:underline">Combined with read-only replica</a></li>
</ul>
</div>
</div>
</div>
</section>
<!-- Endpoints Section -->
<section class="py-12 sm:py-16 md:py-20 bg-white dark:bg-gray-900 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="text-center mb-8 sm:mb-12">
<h2 class="text-2xl sm:text-3xl md:text-4xl font-bold text-gray-900 dark:text-gray-100 mb-3 sm:mb-4">Endpoints</h2>
<p class="text-base sm:text-lg text-gray-600 dark:text-gray-300 px-4">Available HTTP endpoints</p>
</div>
<div class="max-w-3xl mx-auto">
<div class="glass p-6 rounded-xl">
<div class="space-y-3">
<div class="flex items-start gap-4 p-3 bg-gray-50 dark:bg-gray-800 rounded-lg">
<code class="text-fuchsia-600 dark:text-fuchsia-400 font-medium whitespace-nowrap">:8080/*</code>
<span class="text-gray-600 dark:text-gray-400">GraphQL passthrough endpoint</span>
</div>
<div class="flex items-start gap-4 p-3 bg-gray-50 dark:bg-gray-800 rounded-lg">
<code class="text-fuchsia-600 dark:text-fuchsia-400 font-medium whitespace-nowrap">:8080/admin</code>
<span class="text-gray-600 dark:text-gray-400">Admin dashboard UI</span>
</div>
<div class="flex items-start gap-4 p-3 bg-gray-50 dark:bg-gray-800 rounded-lg">
<code class="text-fuchsia-600 dark:text-fuchsia-400 font-medium whitespace-nowrap">:9393/metrics</code>
<span class="text-gray-600 dark:text-gray-400">Prometheus metrics</span>
</div>
<div class="flex items-start gap-4 p-3 bg-gray-50 dark:bg-gray-800 rounded-lg">
<code class="text-fuchsia-600 dark:text-fuchsia-400 font-medium whitespace-nowrap">:8080/healthz</code>
<span class="text-gray-600 dark:text-gray-400">Health check (with optional backend verification)</span>
</div>
<div class="flex items-start gap-4 p-3 bg-gray-50 dark:bg-gray-800 rounded-lg">
<code class="text-fuchsia-600 dark:text-fuchsia-400 font-medium whitespace-nowrap">:8080/livez</code>
<span class="text-gray-600 dark:text-gray-400">Liveness probe</span>
</div>
<div class="flex items-start gap-4 p-3 bg-gray-50 dark:bg-gray-800 rounded-lg">
<code class="text-fuchsia-600 dark:text-fuchsia-400 font-medium whitespace-nowrap">:9090/api/*</code>
<span class="text-gray-600 dark:text-gray-400">Management API (user-ban, cache-clear, circuit-breaker)</span>
</div>
</div>
</div>
</div>
</div>
</section>
<!-- Footer -->
<footer class="py-8 bg-gray-100 dark:bg-gray-800 theme-transition">
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="flex flex-col sm:flex-row justify-between items-center gap-4">
<div class="flex items-center gap-2">
<i class="fas fa-diagram-project text-xl gradient-text"></i>
<span class="font-semibold gradient-text">graphql-monitoring-proxy</span>
</div>
<div class="flex items-center gap-6">
<a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy" class="text-gray-600 dark:text-gray-400 hover:text-gray-900 dark:hover:text-gray-100">
<i class="fab fa-github text-xl"></i>
</a>
<a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy/issues" class="text-gray-600 dark:text-gray-400 hover:text-gray-900 dark:hover:text-gray-100 text-sm">
Issues
</a>
<a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy/releases" class="text-gray-600 dark:text-gray-400 hover:text-gray-900 dark:hover:text-gray-100 text-sm">
Releases
</a>
<a href="https://github.com/lukaszraczylo/graphql-monitoring-proxy#configuration" class="text-gray-600 dark:text-gray-400 hover:text-gray-900 dark:hover:text-gray-100 text-sm">
Full Docs
</a>
</div>
<p class="text-gray-500 dark:text-gray-400 text-sm">MIT License</p>
</div>
</div>
</footer>
<script>
// Theme toggle
document.getElementById('theme-toggle').addEventListener('click', function() {
if (document.documentElement.classList.contains('dark')) {
document.documentElement.classList.remove('dark');
localStorage.theme = 'light';
} else {
document.documentElement.classList.add('dark');
localStorage.theme = 'dark';
}
});
// Mobile menu toggle
document.getElementById('mobile-menu-toggle').addEventListener('click', function() {
const menu = document.getElementById('mobile-menu');
const openIcon = document.getElementById('menu-open-icon');
const closeIcon = document.getElementById('menu-close-icon');
menu.classList.toggle('hidden');
openIcon.classList.toggle('hidden');
closeIcon.classList.toggle('hidden');
});
// Close mobile menu when clicking a link
document.querySelectorAll('#mobile-menu a').forEach(link => {
link.addEventListener('click', () => {
document.getElementById('mobile-menu').classList.add('hidden');
document.getElementById('menu-open-icon').classList.remove('hidden');
document.getElementById('menu-close-icon').classList.add('hidden');
});
});
</script>
</body>
</html>
-172
View File
@@ -1,172 +0,0 @@
package main
import (
"encoding/json"
"errors"
"fmt"
"time"
"github.com/sony/gobreaker"
)
// Error codes for structured error responses
const (
ErrCodeConnectionRefused = "CONNECTION_REFUSED"
ErrCodeConnectionReset = "CONNECTION_RESET"
ErrCodeTimeout = "TIMEOUT"
ErrCodeCircuitOpen = "CIRCUIT_OPEN"
ErrCodeRateLimited = "RATE_LIMITED"
ErrCodeInvalidRequest = "INVALID_REQUEST"
ErrCodeBackendError = "BACKEND_ERROR"
ErrCodeInternalError = "INTERNAL_ERROR"
ErrCodeUnauthorized = "UNAUTHORIZED"
ErrCodeForbidden = "FORBIDDEN"
ErrCodeNotFound = "NOT_FOUND"
ErrCodeServiceUnavailable = "SERVICE_UNAVAILABLE"
ErrCodeBadGateway = "BAD_GATEWAY"
ErrCodeInvalidResponse = "INVALID_RESPONSE"
ErrCodeQueryTooComplex = "QUERY_TOO_COMPLEX"
ErrCodeCacheFailed = "CACHE_FAILED"
ErrCodeContextCanceled = "CONTEXT_CANCELED"
)
// ProxyError represents a structured error response
type ProxyError struct {
Code string `json:"code"` // Machine-readable error code
Message string `json:"message"` // Human-readable error message
Details string `json:"details,omitempty"` // Additional error details
Retryable bool `json:"retryable"` // Whether the request can be retried
StatusCode int `json:"status_code"` // HTTP status code
Timestamp time.Time `json:"timestamp"` // When the error occurred
TraceID string `json:"trace_id,omitempty"` // Trace ID for correlation
Metadata map[string]any `json:"metadata,omitempty"` // Additional context
Cause error `json:"-"` // Original error (not serialized)
}
// Error implements the error interface
func (e *ProxyError) Error() string {
if e.Details != "" {
return fmt.Sprintf("%s: %s (%s)", e.Code, e.Message, e.Details)
}
return fmt.Sprintf("%s: %s", e.Code, e.Message)
}
// Unwrap returns the underlying error
func (e *ProxyError) Unwrap() error {
return e.Cause
}
// MarshalJSON implements custom JSON marshaling
func (e *ProxyError) MarshalJSON() ([]byte, error) {
type Alias ProxyError
return json.Marshal(&struct {
*Alias
CauseMessage string `json:"cause,omitempty"`
}{
Alias: (*Alias)(e),
CauseMessage: func() string {
if e.Cause != nil {
return e.Cause.Error()
}
return ""
}(),
})
}
// NewProxyError creates a new structured error
func NewProxyError(code, message string, statusCode int, retryable bool) *ProxyError {
return &ProxyError{
Code: code,
Message: message,
StatusCode: statusCode,
Retryable: retryable,
Timestamp: time.Now(),
Metadata: make(map[string]any),
}
}
// WithDetails adds details to the error
func (e *ProxyError) WithDetails(details string) *ProxyError {
e.Details = details
return e
}
// WithCause adds the underlying cause
func (e *ProxyError) WithCause(cause error) *ProxyError {
e.Cause = cause
return e
}
// WithTraceID adds a trace ID
func (e *ProxyError) WithTraceID(traceID string) *ProxyError {
e.TraceID = traceID
return e
}
// WithMetadata adds metadata
func (e *ProxyError) WithMetadata(key string, value any) *ProxyError {
e.Metadata[key] = value
return e
}
// Helper functions
func truncateString(s string, maxLen int) string {
if len(s) <= maxLen {
return s
}
return s[:maxLen] + "..."
}
// IsRetryable checks if an error is retryable
func IsRetryable(err error) bool {
if err == nil {
return false
}
var proxyErr *ProxyError
if errors.As(err, &proxyErr) {
return proxyErr.Retryable
}
return false
}
// GetStatusCode extracts the status code from an error
func GetStatusCode(err error) int {
if err == nil {
return 200
}
var proxyErr *ProxyError
if errors.As(err, &proxyErr) {
return proxyErr.StatusCode
}
return 500
}
// StatusCodeForError maps a proxy-path error to the HTTP status code an
// error handler must return for it. It recognises the circuit-breaker
// sentinel errors (ErrCircuitOpen, defined in proxy.go, and
// gobreaker.ErrOpenState) as 503 Service Unavailable -- previously these
// surfaced as a generic 500 because nothing mapped them -- defers to a
// wrapped *ProxyError's StatusCode when present (via errors.As, so it also
// unwraps errors returned through circuitBreakerOutcome), and otherwise
// falls back to 500. A nil error maps to 200.
func StatusCodeForError(err error) int {
if err == nil {
return 200
}
if errors.Is(err, ErrCircuitOpen) || errors.Is(err, gobreaker.ErrOpenState) {
return 503
}
var proxyErr *ProxyError
if errors.As(err, &proxyErr) {
return proxyErr.StatusCode
}
return 500
}
-322
View File
@@ -1,322 +0,0 @@
package main
import (
"errors"
"fmt"
"net/http"
"testing"
"github.com/sony/gobreaker"
"github.com/stretchr/testify/assert"
)
func TestNewProxyError(t *testing.T) {
tests := []struct {
name string
code string
message string
statusCode int
retryable bool
expectStatus int
}{
{
name: "connection refused error",
code: ErrCodeConnectionRefused,
message: "backend unavailable",
statusCode: http.StatusServiceUnavailable,
retryable: true,
expectStatus: http.StatusServiceUnavailable,
},
{
name: "timeout error",
code: ErrCodeTimeout,
message: "request timeout",
statusCode: http.StatusGatewayTimeout,
retryable: true,
expectStatus: http.StatusGatewayTimeout,
},
{
name: "circuit breaker open",
code: ErrCodeCircuitOpen,
message: "circuit breaker open",
statusCode: http.StatusServiceUnavailable,
retryable: false,
expectStatus: http.StatusServiceUnavailable,
},
{
name: "rate limit exceeded",
code: ErrCodeRateLimited,
message: "too many requests",
statusCode: http.StatusTooManyRequests,
retryable: false,
expectStatus: http.StatusTooManyRequests,
},
{
name: "service unavailable",
code: ErrCodeServiceUnavailable,
message: "no retry tokens available",
statusCode: http.StatusServiceUnavailable,
retryable: false,
expectStatus: http.StatusServiceUnavailable,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := NewProxyError(tt.code, tt.message, tt.statusCode, tt.retryable)
assert.NotNil(t, err)
assert.Equal(t, tt.code, err.Code)
assert.Equal(t, tt.message, err.Message)
assert.Equal(t, tt.retryable, err.Retryable)
assert.Equal(t, tt.expectStatus, err.StatusCode)
assert.NotEmpty(t, err.Timestamp)
assert.NotNil(t, err.Metadata)
})
}
}
func TestProxyError_Error(t *testing.T) {
tests := []struct {
name string
err *ProxyError
expected string
}{
{
name: "error with details",
err: NewProxyError(ErrCodeConnectionRefused, "backend unavailable", http.StatusServiceUnavailable, true).
WithDetails("connection refused"),
expected: "CONNECTION_REFUSED: backend unavailable (connection refused)",
},
{
name: "error without details",
err: NewProxyError(ErrCodeCircuitOpen, "circuit breaker open", http.StatusServiceUnavailable, false),
expected: "CIRCUIT_OPEN: circuit breaker open",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
assert.Equal(t, tt.expected, tt.err.Error())
})
}
}
func TestProxyError_Unwrap(t *testing.T) {
cause := errors.New("original error")
err := NewProxyError(ErrCodeTimeout, "timeout occurred", http.StatusGatewayTimeout, true).WithCause(cause)
unwrapped := errors.Unwrap(err)
assert.Equal(t, cause, unwrapped)
}
func TestProxyError_WithMethods(t *testing.T) {
t.Run("with details", func(t *testing.T) {
err := NewProxyError(ErrCodeTimeout, "timeout", http.StatusGatewayTimeout, true).
WithDetails("operation timed out")
assert.Equal(t, "operation timed out", err.Details)
})
t.Run("with cause", func(t *testing.T) {
cause := errors.New("original error")
err := NewProxyError(ErrCodeTimeout, "timeout", http.StatusGatewayTimeout, true).
WithCause(cause)
assert.Equal(t, cause, err.Cause)
})
t.Run("with trace ID", func(t *testing.T) {
err := NewProxyError(ErrCodeTimeout, "timeout", http.StatusGatewayTimeout, true).
WithTraceID("trace-123")
assert.Equal(t, "trace-123", err.TraceID)
})
t.Run("with metadata", func(t *testing.T) {
err := NewProxyError(ErrCodeTimeout, "timeout", http.StatusGatewayTimeout, true).
WithMetadata("attempt", 3).
WithMetadata("endpoint", "/graphql")
assert.Equal(t, 3, err.Metadata["attempt"])
assert.Equal(t, "/graphql", err.Metadata["endpoint"])
})
}
func TestProxyError_MarshalJSON(t *testing.T) {
cause := errors.New("connection refused")
err := NewProxyError(ErrCodeConnectionRefused, "backend unavailable", http.StatusServiceUnavailable, true).
WithDetails("network error").
WithCause(cause).
WithTraceID("trace-456")
data, jsonErr := err.MarshalJSON()
assert.NoError(t, jsonErr)
assert.NotEmpty(t, data)
assert.Contains(t, string(data), "CONNECTION_REFUSED")
assert.Contains(t, string(data), "backend unavailable")
assert.Contains(t, string(data), "connection refused")
}
func TestErrorCodes(t *testing.T) {
// Verify all error codes are defined
codes := []string{
ErrCodeConnectionRefused,
ErrCodeConnectionReset,
ErrCodeTimeout,
ErrCodeCircuitOpen,
ErrCodeRateLimited,
ErrCodeInvalidRequest,
ErrCodeBackendError,
ErrCodeInternalError,
ErrCodeUnauthorized,
ErrCodeForbidden,
ErrCodeNotFound,
ErrCodeServiceUnavailable,
ErrCodeBadGateway,
ErrCodeInvalidResponse,
ErrCodeQueryTooComplex,
ErrCodeCacheFailed,
ErrCodeContextCanceled,
}
for _, code := range codes {
assert.NotEmpty(t, code, "Error code should not be empty")
}
// Verify codes are unique
codeMap := make(map[string]bool)
for _, code := range codes {
assert.False(t, codeMap[code], "Error code %s should be unique", code)
codeMap[code] = true
}
}
func TestProxyError_ChainableMethods(t *testing.T) {
// Test that methods can be chained
err := NewProxyError(ErrCodeTimeout, "timeout", http.StatusGatewayTimeout, true).
WithDetails("operation timeout").
WithCause(errors.New("deadline exceeded")).
WithTraceID("trace-789").
WithMetadata("attempt", 1).
WithMetadata("duration_ms", 5000)
assert.Equal(t, "operation timeout", err.Details)
assert.NotNil(t, err.Cause)
assert.Equal(t, "trace-789", err.TraceID)
assert.Equal(t, 1, err.Metadata["attempt"])
assert.Equal(t, 5000, err.Metadata["duration_ms"])
}
func TestProxyError_Retryable(t *testing.T) {
tests := []struct {
name string
code string
retryable bool
}{
{
name: "timeout is retryable",
code: ErrCodeTimeout,
retryable: true,
},
{
name: "connection refused is retryable",
code: ErrCodeConnectionRefused,
retryable: true,
},
{
name: "rate limited is not retryable",
code: ErrCodeRateLimited,
retryable: false,
},
{
name: "circuit open is not retryable",
code: ErrCodeCircuitOpen,
retryable: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := NewProxyError(tt.code, "test error", http.StatusInternalServerError, tt.retryable)
assert.Equal(t, tt.retryable, err.Retryable)
})
}
}
// Test_IsRetryable_GetStatusCode_Wrapped verifies that retryability and status
// are correctly recovered from a ProxyError that has been wrapped (e.g. via
// %w), using errors.As rather than a direct type assertion.
func Test_IsRetryable_GetStatusCode_Wrapped(t *testing.T) {
base := NewProxyError(ErrCodeBackendError, "boom", 503, true)
wrapped := fmt.Errorf("request failed: %w", base)
assert.True(t, IsRetryable(wrapped), "retryable flag must survive wrapping")
assert.Equal(t, 503, GetStatusCode(wrapped), "status code must survive wrapping")
nonRetryable := NewProxyError(ErrCodeInvalidRequest, "bad", 400, false)
wrapped2 := fmt.Errorf("wrapped: %w", nonRetryable)
assert.False(t, IsRetryable(wrapped2))
assert.Equal(t, 400, GetStatusCode(wrapped2))
assert.False(t, IsRetryable(nil))
assert.Equal(t, 200, GetStatusCode(nil))
}
// Test_StatusCodeForError covers the C4 fix: circuit-open errors must map to
// 503 (previously fell through to a generic 500 because nothing mapped
// them), a wrapped *ProxyError's own status code must survive, and any
// other error defaults to 500. nil maps to 200.
func Test_StatusCodeForError(t *testing.T) {
tests := []struct {
name string
err error
wantStatus int
}{
{
name: "nil error maps to 200",
err: nil,
wantStatus: 200,
},
{
name: "circuit breaker open (proxy sentinel) maps to 503",
err: ErrCircuitOpen,
wantStatus: 503,
},
{
name: "circuit breaker open (gobreaker sentinel) maps to 503",
err: gobreaker.ErrOpenState,
wantStatus: 503,
},
{
name: "wrapped circuit breaker open still maps to 503",
err: fmt.Errorf("request failed: %w", ErrCircuitOpen),
wantStatus: 503,
},
{
name: "wrapped gobreaker open state still maps to 503",
err: fmt.Errorf("request failed: %w", gobreaker.ErrOpenState),
wantStatus: 503,
},
{
name: "generic error defaults to 500",
err: errors.New("boom"),
wantStatus: 500,
},
{
name: "ProxyError with explicit status code is honoured",
err: NewProxyError(ErrCodeRateLimited, "too many requests", http.StatusTooManyRequests, false),
wantStatus: http.StatusTooManyRequests,
},
{
name: "wrapped ProxyError status code survives wrapping",
err: fmt.Errorf("wrapped: %w", NewProxyError(ErrCodeBackendError, "boom", http.StatusBadGateway, true)),
wantStatus: http.StatusBadGateway,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
assert.Equal(t, tt.wantStatus, StatusCodeForError(tt.err))
})
}
}
-146
View File
@@ -1,146 +0,0 @@
package main
import (
"context"
"fmt"
"time"
"github.com/jackc/pgx/v5/pgxpool"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
)
const (
initialDelay = 60 * time.Second
cleanupInterval = 1 * time.Hour
)
// Use parameterized queries to prevent SQL injection
// Cast $1 to interval type to allow proper parameterized interval values
var delQueries = [...]string{
"DELETE FROM hdb_catalog.event_invocation_logs WHERE created_at < NOW() - $1::INTERVAL",
"DELETE FROM hdb_catalog.event_log WHERE created_at < NOW() - $1::INTERVAL",
"DELETE FROM hdb_catalog.hdb_action_log WHERE created_at < NOW() - $1::INTERVAL",
"DELETE FROM hdb_catalog.hdb_cron_event_invocation_logs WHERE created_at < NOW() - $1::INTERVAL",
"DELETE FROM hdb_catalog.hdb_scheduled_event_invocation_logs WHERE created_at < NOW() - $1::INTERVAL",
}
func enableHasuraEventCleaner(ctx context.Context) error {
cfgMutex.RLock()
if !cfg.HasuraEventCleaner.Enable {
cfgMutex.RUnlock()
return nil
}
eventMetadataDb := cfg.HasuraEventCleaner.EventMetadataDb
if eventMetadataDb == "" {
logger := cfg.Logger
cfgMutex.RUnlock()
logger.Warning(&libpack_logger.LogMessage{
Message: "Event metadata db URL not specified, event cleaner not active",
})
return nil
}
clearOlderThan := cfg.HasuraEventCleaner.ClearOlderThan
logger := cfg.Logger
cfgMutex.RUnlock()
logger.Info(&libpack_logger.LogMessage{
Message: "Event cleaner enabled",
Pairs: map[string]any{"interval_in_days": clearOlderThan},
})
// Parse pool configuration
poolConfig, err := pgxpool.ParseConfig(eventMetadataDb)
if err != nil {
return err
}
// Set connection pool limits
poolConfig.MaxConns = 10
poolConfig.MinConns = 2
poolConfig.MaxConnLifetime = time.Hour
poolConfig.MaxConnIdleTime = 30 * time.Minute
pool, err := pgxpool.NewWithConfig(ctx, poolConfig)
if err != nil {
logger.Error(&libpack_logger.LogMessage{
Message: "Failed to create connection pool",
Pairs: map[string]any{"error": err.Error()},
})
return err
}
go func() {
defer pool.Close()
// Wait for initial delay or context cancellation
select {
case <-ctx.Done():
return
case <-time.After(initialDelay):
}
logger.Info(&libpack_logger.LogMessage{
Message: "Initial cleanup of old events",
})
cleanEvents(ctx, pool, clearOlderThan, logger)
ticker := time.NewTicker(cleanupInterval)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
logger.Info(&libpack_logger.LogMessage{
Message: "Stopping event cleaner",
})
return
case <-ticker.C:
logger.Info(&libpack_logger.LogMessage{
Message: "Cleaning up old events",
})
cleanEvents(ctx, pool, clearOlderThan, logger)
}
}
}()
return nil
}
func cleanEvents(ctx context.Context, pool *pgxpool.Pool, clearOlderThan int, logger *libpack_logger.Logger) {
var errors []error
var failedQueries []string
// Format interval parameter for PostgreSQL
interval := fmt.Sprintf("%d days", clearOlderThan)
for _, query := range delQueries {
// Use parameterized query with bound parameter to prevent SQL injection
_, err := pool.Exec(ctx, query, interval)
if err != nil {
errors = append(errors, err)
failedQueries = append(failedQueries, query)
} else {
logger.Debug(&libpack_logger.LogMessage{
Message: "Successfully executed query",
Pairs: map[string]any{"query": query, "interval": interval},
})
}
}
if len(errors) > 0 {
var errMsgs []string
for _, err := range errors {
errMsgs = append(errMsgs, err.Error())
}
logger.Error(&libpack_logger.LogMessage{
Message: "Failed to execute some queries",
Pairs: map[string]any{
"failed_queries": failedQueries,
"errors": errMsgs,
},
})
}
}
-355
View File
@@ -1,355 +0,0 @@
package main
import (
"context"
"fmt"
"strings"
"testing"
"time"
libpack_logging "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/suite"
)
type EventsSecurityTestSuite struct {
suite.Suite
logger *libpack_logging.Logger
}
func (suite *EventsSecurityTestSuite) SetupTest() {
suite.logger = libpack_logging.New()
}
func TestEventsSecurityTestSuite(t *testing.T) {
suite.Run(t, new(EventsSecurityTestSuite))
}
// TestEventCleanerSQLInjection tests various SQL injection attempts in the event cleaner
func (suite *EventsSecurityTestSuite) TestEventCleanerSQLInjection() {
tests := []struct {
clearDays any
name string
description string
expectError bool
}{
{
name: "SQL injection attempt with OR clause",
clearDays: "1' OR '1'='1",
expectError: true,
description: "Should reject string input that attempts SQL injection",
},
{
name: "SQL injection with DROP TABLE",
clearDays: "1'; DROP TABLE users; --",
expectError: true,
description: "Should reject attempt to drop tables",
},
{
name: "SQL injection with UNION SELECT",
clearDays: "1 UNION SELECT * FROM information_schema.tables",
expectError: true,
description: "Should reject UNION-based injection attempts",
},
{
name: "SQL injection with comment bypass",
clearDays: "1/**/OR/**/1=1",
expectError: true,
description: "Should reject comment-based bypass attempts",
},
{
name: "SQL injection with nested quotes",
clearDays: "1' AND '1'='1' OR '2'='2",
expectError: true,
description: "Should reject nested quote injection attempts",
},
{
name: "Valid integer input",
clearDays: 30,
expectError: false,
description: "Should accept valid positive integer",
},
{
name: "Valid integer as string",
clearDays: "30",
expectError: false,
description: "Should accept valid integer as string",
},
{
name: "Zero value",
clearDays: 0,
expectError: false,
description: "Should accept zero value",
},
{
name: "Negative value attempt",
clearDays: -1,
expectError: true,
description: "Should reject negative values",
},
{
name: "Float value attempt",
clearDays: 3.14,
expectError: true,
description: "Should reject float values",
},
{
name: "Very large integer",
clearDays: 999999999,
expectError: true,
description: "Should reject unreasonably large values",
},
{
name: "Boolean value attempt",
clearDays: true,
expectError: true,
description: "Should reject boolean values",
},
{
name: "Null/nil value attempt",
clearDays: nil,
expectError: true,
description: "Should reject nil values",
},
{
name: "Empty string attempt",
clearDays: "",
expectError: true,
description: "Should reject empty strings",
},
{
name: "Hexadecimal injection attempt",
clearDays: "0x1F",
expectError: true,
description: "Should reject hexadecimal values",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
// Test the input validation function that should be implemented
err := validateClearDaysInput(tt.clearDays)
if tt.expectError {
suite.Error(err, "Expected error for input: %v (%s)", tt.clearDays, tt.description)
if err != nil {
// Verify error message doesn't leak sensitive information
suite.NotContains(strings.ToLower(err.Error()), "sql")
suite.NotContains(strings.ToLower(err.Error()), "injection")
suite.NotContains(strings.ToLower(err.Error()), "query")
}
} else {
suite.NoError(err, "Expected no error for input: %v (%s)", tt.clearDays, tt.description)
}
})
}
}
// TestEventCleanerParameterizedQueries tests that queries use parameterized statements
func (suite *EventsSecurityTestSuite) TestEventCleanerParameterizedQueries() {
// This test verifies that the delQueries are properly parameterized
// and don't use string formatting that could lead to SQL injection
suite.Run("Queries should use parameterized placeholders", func() {
// Get the delQueries from the main package
// This assumes delQueries is accessible for testing
queries := getDelQueries() // This function should be implemented to return delQueries
for i, query := range queries {
suite.Run(fmt.Sprintf("Query_%d", i), func() {
// Check that query uses proper parameterization ($1, $2, etc.)
// instead of %s, %d, etc.
suite.NotContains(query, "%s", "Query should not use string formatting: %s", query)
suite.NotContains(query, "%d", "Query should not use decimal formatting: %s", query)
suite.NotContains(query, "%v", "Query should not use value formatting: %s", query)
// Verify it uses proper PostgreSQL parameterization
suite.Contains(query, "$1", "Query should use parameterized placeholder $1: %s", query)
// Ensure query structure is as expected
suite.True(strings.Contains(query, "DELETE") || strings.Contains(query, "UPDATE"),
"Query should be DELETE or UPDATE operation: %s", query)
})
}
})
}
// TestEventCleanerConcurrentSQLInjection tests SQL injection under concurrent conditions
func (suite *EventsSecurityTestSuite) TestEventCleanerConcurrentSQLInjection() {
maliciousInputs := []any{
"1'; DROP TABLE events; --",
"1 OR 1=1",
"'; TRUNCATE events; --",
}
suite.Run("Concurrent malicious inputs should all be rejected", func() {
done := make(chan error, len(maliciousInputs))
for _, input := range maliciousInputs {
go func(val any) {
err := validateClearDaysInput(val)
done <- err
}(input)
}
// Collect all results
for i := 0; i < len(maliciousInputs); i++ {
err := <-done
suite.Error(err, "All malicious inputs should be rejected concurrently")
}
})
}
// TestEventCleanerInputSanitization tests input sanitization effectiveness
func (suite *EventsSecurityTestSuite) TestEventCleanerInputSanitization() {
tests := []struct {
input any
name string
expected int
hasError bool
}{
{
name: "Clean integer conversion",
input: "30",
expected: 30,
hasError: false,
},
{
name: "Integer with whitespace",
input: " 30 ",
expected: 30,
hasError: false,
},
{
name: "Malicious string should error",
input: "30'; DROP TABLE --",
expected: 0,
hasError: true,
},
{
name: "Non-numeric string should error",
input: "abc",
expected: 0,
hasError: true,
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
result, err := sanitizeAndValidateClearDays(tt.input)
if tt.hasError {
suite.Error(err)
} else {
suite.NoError(err)
suite.Equal(tt.expected, result)
}
})
}
}
// TestEventCleanerDatabaseInteraction tests secure database interaction patterns
func (suite *EventsSecurityTestSuite) TestEventCleanerDatabaseInteraction() {
// This test would use a real test database in a complete implementation
// For now, we test the security aspects of the interaction patterns
suite.Run("Database queries should use context with timeout", func() {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
// Test that the context is properly used and respected
// This prevents long-running malicious queries
done := make(chan bool)
go func() {
// Simulate a long-running query that should be cancelled
select {
case <-ctx.Done():
done <- true
case <-time.After(10 * time.Second):
done <- false
}
}()
result := <-done
suite.True(result, "Context timeout should be respected")
})
}
// Mock implementations for testing - removed as not needed for current tests
// Helper functions that should be implemented in the main codebase
// validateClearDaysInput validates and sanitizes the clearDays input
func validateClearDaysInput(input any) error {
// This function should be implemented in the main codebase
// to validate clearDays input before using it in SQL queries
switch v := input.(type) {
case int:
if v < 0 || v > 365 {
return fmt.Errorf("invalid range: must be between 0 and 365")
}
return nil
case string:
// Check for SQL injection patterns
sqlPatterns := []string{
"'", "\"", ";", "--", "/*", "*/", "xp_", "sp_",
"SELECT", "INSERT", "UPDATE", "DELETE", "DROP", "CREATE",
"ALTER", "EXEC", "EXECUTE", "UNION", "OR", "AND",
}
upperInput := strings.ToUpper(strings.TrimSpace(v))
for _, pattern := range sqlPatterns {
if strings.Contains(upperInput, strings.ToUpper(pattern)) {
return fmt.Errorf("invalid input: contains forbidden characters")
}
}
// Check for hexadecimal patterns
if strings.HasPrefix(strings.ToLower(strings.TrimSpace(v)), "0x") {
return fmt.Errorf("invalid input: hexadecimal values not allowed")
}
// Try to convert to int
if _, err := fmt.Sscanf(strings.TrimSpace(v), "%d", new(int)); err != nil {
return fmt.Errorf("invalid input: not a valid integer")
}
return validateClearDaysInput(mustParseInt(strings.TrimSpace(v)))
default:
return fmt.Errorf("invalid input type: expected int or string")
}
}
// sanitizeAndValidateClearDays sanitizes and validates the input, returning the clean integer
func sanitizeAndValidateClearDays(input any) (int, error) {
err := validateClearDaysInput(input)
if err != nil {
return 0, err
}
switch v := input.(type) {
case int:
return v, nil
case string:
return mustParseInt(strings.TrimSpace(v)), nil
default:
return 0, fmt.Errorf("unsupported type")
}
}
// getDelQueries returns the deletion queries for testing
func getDelQueries() []string {
// This should return the actual delQueries from the main package
// For testing purposes, we return expected parameterized queries
return []string{
"DELETE FROM hdb_catalog.event_log WHERE created_at < NOW() - $1::INTERVAL",
"DELETE FROM hdb_catalog.event_invocation_logs WHERE created_at < NOW() - $1::INTERVAL",
}
}
// mustParseInt parses an integer from string, panicking on error (for testing)
func mustParseInt(s string) int {
var result int
if _, err := fmt.Sscanf(s, "%d", &result); err != nil {
panic(fmt.Sprintf("failed to parse integer: %v", err))
}
return result
}
-106
View File
@@ -1,106 +0,0 @@
package main
import (
"context"
"testing"
libpack_logging "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/suite"
)
type EventsTestSuite struct {
suite.Suite
}
func (suite *EventsTestSuite) SetupTest() {
cfgMutex.Lock()
if cfg == nil {
cfg = &config{}
}
cfg.Logger = libpack_logging.New()
cfgMutex.Unlock()
}
func TestEventsTestSuite(t *testing.T) {
suite.Run(t, new(EventsTestSuite))
}
func (suite *EventsTestSuite) Test_EnableHasuraEventCleaner() {
// Test case: feature is disabled
suite.Run("feature disabled", func() {
// Save original config with proper synchronization
cfgMutex.RLock()
originalConfig := cfg.HasuraEventCleaner
cfgMutex.RUnlock()
defer func() {
cfgMutex.Lock()
cfg.HasuraEventCleaner = originalConfig
cfgMutex.Unlock()
}()
// Set up test condition with proper synchronization
cfgMutex.Lock()
cfg.HasuraEventCleaner.Enable = false
cfgMutex.Unlock()
// Test function
ctx := context.Background()
enableHasuraEventCleaner(ctx)
// No assertions needed as we're just testing coverage
// The function should return early without error
})
// Test case: missing database URL
suite.Run("missing database URL", func() {
// Save original config with proper synchronization
cfgMutex.RLock()
originalConfig := cfg.HasuraEventCleaner
cfgMutex.RUnlock()
defer func() {
cfgMutex.Lock()
cfg.HasuraEventCleaner = originalConfig
cfgMutex.Unlock()
}()
// Set up test condition with proper synchronization
cfgMutex.Lock()
cfg.HasuraEventCleaner.Enable = true
cfg.HasuraEventCleaner.EventMetadataDb = ""
cfgMutex.Unlock()
// Test function
ctx := context.Background()
enableHasuraEventCleaner(ctx)
// No assertions needed as we're just testing coverage
// The function should log a warning and return early
})
// Test case: database URL provided but we don't actually connect in the test
suite.Run("database URL provided", func() {
// Save original config with proper synchronization
cfgMutex.RLock()
originalConfig := cfg.HasuraEventCleaner
cfgMutex.RUnlock()
defer func() {
cfgMutex.Lock()
cfg.HasuraEventCleaner = originalConfig
cfgMutex.Unlock()
}()
// Set up test condition with proper synchronization
cfgMutex.Lock()
cfg.HasuraEventCleaner.Enable = true
cfg.HasuraEventCleaner.EventMetadataDb = "postgres://fake:fake@localhost:5432/fake"
cfg.HasuraEventCleaner.ClearOlderThan = 7
cfgMutex.Unlock()
// We're not going to call enableHasuraEventCleaner() here because it would
// try to connect to a database. Instead, we're just increasing coverage
// for the configuration path by setting these values.
})
}
-545
View File
@@ -1,545 +0,0 @@
package main
import (
"bytes"
"fmt"
"net/http"
"net/http/httptest"
"runtime"
"sync"
"time"
"github.com/gofiber/fiber/v3"
"github.com/stretchr/testify/assert"
"github.com/valyala/fasthttp"
)
// Tests for fasthttp client configuration and behavior
// TestFasthttpClientConfiguration tests that the client is properly configured
// with different timeout settings and other configuration options
func (suite *Tests) TestFasthttpClientConfiguration() {
// Test various configurations
testConfigs := []struct {
name string
clientTimeout int
readTimeout int
writeTimeout int
maxConnsPerHost int
disableTLSVerify bool
}{
{
name: "short_timeouts",
clientTimeout: 1,
readTimeout: 1,
writeTimeout: 1,
maxConnsPerHost: 100,
disableTLSVerify: false,
},
{
name: "long_timeouts",
clientTimeout: 30,
readTimeout: 20,
writeTimeout: 10,
maxConnsPerHost: 500,
disableTLSVerify: true,
},
{
name: "high_concurrency",
clientTimeout: 5,
readTimeout: 5,
writeTimeout: 5,
maxConnsPerHost: 2000,
disableTLSVerify: false,
},
}
for _, tc := range testConfigs {
suite.Run(tc.name, func() {
// Create config with test values
testConfig := &config{}
testConfig.Client.ClientTimeout = tc.clientTimeout
testConfig.Client.ReadTimeout = tc.readTimeout
testConfig.Client.WriteTimeout = tc.writeTimeout
testConfig.Client.MaxConnsPerHost = tc.maxConnsPerHost
testConfig.Client.DisableTLSVerify = tc.disableTLSVerify
testConfig.Client.MaxIdleConnDuration = 10
// Create client and verify configuration
client := createFasthttpClient(testConfig)
// We can't easily access private fields of the client, but we can verify it works
// with the configured timeouts by testing requests
assert.NotNil(suite.T(), client, "Client should be created")
// The read/write timeouts must honour the per-side config
// (CLIENT_READ_TIMEOUT / CLIENT_WRITE_TIMEOUT), falling back to the
// client timeout.
want := time.Duration(tc.readTimeout) * time.Second
if tc.readTimeout <= 0 {
want = time.Duration(tc.clientTimeout) * time.Second
if want <= 0 {
want = 30 * time.Second
}
}
assert.Equal(suite.T(), want, client.ReadTimeout,
"client read timeout should honour CLIENT_READ_TIMEOUT")
want = time.Duration(tc.writeTimeout) * time.Second
if tc.writeTimeout <= 0 {
want = time.Duration(tc.clientTimeout) * time.Second
if want <= 0 {
want = 30 * time.Second
}
}
assert.Equal(suite.T(), want, client.WriteTimeout,
"client write timeout should honour CLIENT_WRITE_TIMEOUT")
// For non-zero configuration values, we can at least verify they were applied
// by checking the client isn't nil
assert.NotNil(suite.T(), client.TLSConfig, "TLS config should be created")
})
}
}
// TestClientTimeoutBehavior tests that the client respects configured timeouts
func (suite *Tests) TestClientTimeoutBehavior() {
// Create a test server that simulates different response times
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Get sleep duration from header
sleepDurationHeader := r.Header.Get("X-Sleep-Duration")
var sleepDuration time.Duration
if sleepDurationHeader != "" {
sleepDuration, _ = time.ParseDuration(sleepDurationHeader)
}
// Sleep for the specified duration
time.Sleep(sleepDuration)
// Return a simple JSON response
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{"data":{"test":"response"}}`))
}))
defer server.Close()
testCases := []struct {
name string
sleepDuration string
clientTimeout int
shouldTimeout bool
}{
{
name: "within_timeout",
clientTimeout: 2,
sleepDuration: "1s",
shouldTimeout: false,
},
{
name: "exceeds_timeout",
clientTimeout: 1,
sleepDuration: "2s",
shouldTimeout: true,
},
{
name: "at_timeout_boundary",
clientTimeout: 3,
sleepDuration: "2.5s",
shouldTimeout: false, // Increased buffer to reduce flakiness under race detection
},
}
for _, tc := range testCases {
suite.Run(tc.name, func() {
// Skip timing-sensitive boundary test as it's inherently flaky and already acknowledged by developers
if tc.name == "at_timeout_boundary" {
suite.T().Skip("Skipping inherently flaky timing boundary test that was noted as potentially problematic in CI")
}
// Store original client and restore after test
originalClient := cfg.Client.FastProxyClient
originalTimeout := cfg.Client.ClientTimeout
defer func() {
cfg.Client.FastProxyClient = originalClient
cfg.Client.ClientTimeout = originalTimeout
}()
// Configure client with test timeout
cfg.Client.ClientTimeout = tc.clientTimeout
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
// Configure server URL
cfg.Server.HostGraphQL = server.URL
// Create request context
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.Header.Set("X-Sleep-Duration", tc.sleepDuration)
reqCtx.Request.SetBody([]byte(`{"query": "query { test }"}`))
// Create fiber context
ctx := suite.app.AcquireCtx(reqCtx)
defer suite.app.ReleaseCtx(ctx)
// Call the proxy function
err := proxyTheRequest(ctx, cfg.Server.HostGraphQL)
// Verify timeout behavior
if tc.shouldTimeout {
assert.NotNil(suite.T(), err, "Request should timeout")
if err != nil {
assert.Contains(suite.T(), err.Error(), "timeout", "Error should mention timeout")
}
} else {
assert.Nil(suite.T(), err, "Request should not timeout")
assert.Equal(suite.T(), fiber.StatusOK, ctx.Response().StatusCode(), "Status should be 200 OK")
}
})
}
}
// TestConcurrentRequestHandling tests how the proxy handles concurrent requests
func (suite *Tests) TestConcurrentRequestHandling() {
// Create a test server that returns different responses based on request count
var requestCount int
var requestMutex sync.Mutex
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
requestMutex.Lock()
requestCount++
currentRequest := requestCount
requestMutex.Unlock()
// Introduce varying delays to simulate real-world conditions
delay := time.Duration(currentRequest%5) * 100 * time.Millisecond
time.Sleep(delay)
// Return a response with the request number
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
_, _ = fmt.Fprintf(w, `{"data":{"request":%d}}`, currentRequest)
}))
defer server.Close()
// Store original client and restore after test
originalClient := cfg.Client.FastProxyClient
defer func() {
cfg.Client.FastProxyClient = originalClient
}()
// Configure client for concurrent requests
cfg.Client.MaxConnsPerHost = 100 // Allow plenty of concurrent connections
cfg.Client.ClientTimeout = 5 // Generous timeout
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
// Configure server URL
cfg.Server.HostGraphQL = server.URL
// Number of concurrent requests to make
numRequests := 50
// Results channel to collect responses
results := make(chan struct {
err error
response []byte
index int
}, numRequests)
// WaitGroup to ensure all goroutines complete
var wg sync.WaitGroup
wg.Add(numRequests)
// Launch concurrent requests
for i := 0; i < numRequests; i++ {
go func(index int) {
defer wg.Done()
// Create request context
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.SetBody([]byte(fmt.Sprintf(`{"query": "query { request(%d) }", "index": %d}`, index, index)))
// Create fiber context
ctx := suite.app.AcquireCtx(reqCtx)
defer suite.app.ReleaseCtx(ctx)
// Call the proxy function
err := proxyTheRequest(ctx, cfg.Server.HostGraphQL)
// Collect results
results <- struct {
err error
response []byte
index int
}{
index: index,
response: ctx.Response().Body(),
err: err,
}
}(i)
}
// Start a goroutine to close the results channel when all requests are done
go func() {
wg.Wait()
close(results)
}()
// Collect all results
successCount := 0
errorCount := 0
for result := range results {
if result.err != nil {
errorCount++
} else {
successCount++
assert.NotEmpty(suite.T(), result.response, "Response should not be empty")
assert.Contains(suite.T(), string(result.response), "request", "Response should contain request data")
}
}
// Verify all requests were processed
assert.Equal(suite.T(), numRequests, successCount+errorCount, "All requests should be processed")
// Expecting all or most requests to succeed
assert.GreaterOrEqual(suite.T(), successCount, numRequests*9/10,
"At least 90% of requests should succeed")
// Log the success ratio
suite.T().Logf("Concurrent request test: %d/%d requests succeeded (%0.2f%%)",
successCount, numRequests, float64(successCount)/float64(numRequests)*100)
}
// TestMaxConcurrentConnections tests the behavior when reaching the maximum connection limit
func (suite *Tests) TestMaxConcurrentConnections() {
// Skip this test as it's inherently subject to race conditions when testing concurrent connection limits
suite.T().Skip("Skipping concurrent connection limit test due to inherent race conditions under race detection")
// Skip on low CPU systems to avoid test flakiness
if runtime.NumCPU() < 4 {
suite.T().Skip("Skipping connection limit test on system with less than 4 CPUs")
}
// Create a test server that sleeps to keep connections open
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Sleep for a significant time to keep connections open
time.Sleep(2 * time.Second)
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{"data":{"test":"response"}}`))
}))
defer server.Close()
// Store original client and restore after test
originalClient := cfg.Client.FastProxyClient
originalMaxConns := cfg.Client.MaxConnsPerHost
defer func() {
cfg.Client.FastProxyClient = originalClient
cfg.Client.MaxConnsPerHost = originalMaxConns
}()
// Configure client with a very low connection limit
cfg.Client.MaxConnsPerHost = 5 // Only allow 5 concurrent connections
cfg.Client.ClientTimeout = 5
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
// Configure server URL
cfg.Server.HostGraphQL = server.URL
// Number of concurrent requests - significantly more than our connection limit
numRequests := 20
// Results channel to collect responses
results := make(chan struct {
err error
response []byte
index int
status int
}, numRequests)
// WaitGroup to ensure all goroutines complete
var wg sync.WaitGroup
wg.Add(numRequests)
// Buffer to capture log output
var logBuffer bytes.Buffer
originalLogger := cfg.Logger
cfg.Logger = originalLogger.SetOutput(&logBuffer)
defer func() {
cfg.Logger = originalLogger
}()
// Launch concurrent requests
for i := 0; i < numRequests; i++ {
go func(index int) {
defer wg.Done()
// Create request context
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.SetBody([]byte(fmt.Sprintf(`{"query": "query { test(%d) }"}`, index)))
// Create fiber context
ctx := suite.app.AcquireCtx(reqCtx)
defer suite.app.ReleaseCtx(ctx)
// Call the proxy function
err := proxyTheRequest(ctx, cfg.Server.HostGraphQL)
// Collect results
results <- struct {
err error
response []byte
index int
status int
}{
index: index,
response: ctx.Response().Body(),
status: ctx.Response().StatusCode(),
err: err,
}
}(i)
// Small delay to ensure the requests don't all start exactly at the same time
// which could lead to unpredictable behavior of the connection pool
time.Sleep(10 * time.Millisecond)
}
// Start a goroutine to close the results channel when all requests are done
go func() {
wg.Wait()
close(results)
}()
// Collect all results
successCount := 0
errorCount := 0
for result := range results {
if result.err != nil {
errorCount++
} else {
successCount++
}
}
// Verify all requests were processed
assert.Equal(suite.T(), numRequests, successCount+errorCount, "All requests should be processed")
// We expect some requests to succeed and some to fail or be delayed due to the connection limit
// The exact behavior depends on the implementation of fasthttp client's connection pool
// and the operating system's TCP stack configuration.
// Log the success ratio
suite.T().Logf("Max connections test: %d/%d requests succeeded, %d failed/retried",
successCount, numRequests, errorCount)
}
// TestVariousResponseTypes tests handling of different response types
func (suite *Tests) TestVariousResponseTypes() {
testCases := []struct {
name string
contentType string
responseBody string
expectedError string
statusCode int
expectError bool
}{
{
name: "json_success",
contentType: "application/json",
statusCode: http.StatusOK,
responseBody: `{"data":{"test":"success"}}`,
expectError: false,
},
{
name: "json_error",
contentType: "application/json",
statusCode: http.StatusBadRequest,
responseBody: `{"errors":[{"message":"Invalid query"}]}`,
expectError: true,
expectedError: "received non-200 response",
},
{
name: "plain_text",
contentType: "text/plain",
statusCode: http.StatusOK,
responseBody: "OK",
expectError: false,
},
{
name: "html_error",
contentType: "text/html",
statusCode: http.StatusInternalServerError,
responseBody: "<html><body><h1>500 Server Error</h1></body></html>",
expectError: true,
expectedError: "received non-200 response",
},
{
name: "empty_response",
contentType: "application/json",
statusCode: http.StatusOK,
responseBody: "",
expectError: false,
},
}
for _, tc := range testCases {
suite.Run(tc.name, func() {
// Create a test server with the current test configuration
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", tc.contentType)
w.WriteHeader(tc.statusCode)
_, _ = w.Write([]byte(tc.responseBody))
}))
defer server.Close()
// Store original client and restore after test
originalClient := cfg.Client.FastProxyClient
defer func() {
cfg.Client.FastProxyClient = originalClient
}()
// Configure client for test
cfg.Client.ClientTimeout = 5
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
// Configure server URL
cfg.Server.HostGraphQL = server.URL
// Create request context
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.SetBody([]byte(`{"query": "query { test }"}`))
// Create fiber context
ctx := suite.app.AcquireCtx(reqCtx)
defer suite.app.ReleaseCtx(ctx)
// Call the proxy function
err := proxyTheRequest(ctx, cfg.Server.HostGraphQL)
// Verify response handling
if tc.expectError {
assert.NotNil(suite.T(), err, "proxyTheRequest should return error")
if tc.expectedError != "" {
assert.Contains(suite.T(), err.Error(), tc.expectedError,
"Error should contain expected message")
}
} else {
assert.Nil(suite.T(), err, "proxyTheRequest should not return error")
assert.Equal(suite.T(), tc.statusCode, ctx.Response().StatusCode(),
"Response status should match expected")
assert.Equal(suite.T(), tc.responseBody, string(ctx.Response().Body()),
"Response body should match expected")
}
})
}
}
+34 -66
View File
@@ -1,79 +1,47 @@
module github.com/lukaszraczylo/graphql-monitoring-proxy
go 1.26.0
toolchain go1.26.6
go 1.21
require (
github.com/MicahParks/keyfunc/v3 v3.8.2
github.com/VictoriaMetrics/metrics v1.44.0
github.com/alicebob/miniredis/v2 v2.33.0
github.com/avast/retry-go/v4 v4.7.0
github.com/goccy/go-json v0.10.6
github.com/gofiber/contrib/v3/websocket v1.2.6
github.com/gofiber/fiber/v3 v3.5.0
github.com/gofrs/flock v0.13.1
github.com/golang-jwt/jwt/v5 v5.3.1
github.com/VictoriaMetrics/metrics v1.33.1
github.com/avast/retry-go/v4 v4.6.0
github.com/goccy/go-json v0.10.3
github.com/gofiber/fiber/v2 v2.52.4
github.com/gofrs/flock v0.8.1
github.com/google/uuid v1.6.0
github.com/gookit/goutil v0.8.0
github.com/gorilla/websocket v1.5.3
github.com/gookit/goutil v0.6.15
github.com/graphql-go/graphql v0.8.1
github.com/jackc/pgx/v5 v5.11.0
github.com/lukaszraczylo/ask v0.0.0-20240916204100-6e9ef53a62d9
github.com/lukaszraczylo/go-ratecounter v0.1.12
github.com/lukaszraczylo/go-simple-graphql v1.2.89
github.com/lukaszraczylo/oss-telemetry v0.2.3
github.com/redis/go-redis/v9 v9.22.0
github.com/sony/gobreaker v1.0.0
github.com/stretchr/testify v1.12.1
github.com/valyala/fasthttp v1.74.0
go.opentelemetry.io/otel v1.46.0
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.46.0
go.opentelemetry.io/otel/sdk v1.46.0
go.opentelemetry.io/otel/trace v1.46.0
go.uber.org/automaxprocs v1.6.0
google.golang.org/grpc v1.84.0
github.com/lukaszraczylo/ask v0.0.0-20230927103145-2ff1123b4415
github.com/lukaszraczylo/go-ratecounter v0.1.8
github.com/lukaszraczylo/go-simple-graphql v1.2.14
github.com/rs/zerolog v1.33.0
github.com/stretchr/testify v1.9.0
github.com/valyala/fasthttp v1.54.0
)
require (
github.com/MicahParks/jwkset v0.11.3 // indirect
github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a // indirect
github.com/cenkalti/backoff/v5 v5.0.3 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/fasthttp/websocket v1.5.12 // indirect
github.com/go-logr/logr v1.4.4 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/gofiber/schema v1.8.7 // indirect
github.com/gofiber/utils/v2 v2.5.2 // indirect
github.com/grpc-ecosystem/grpc-gateway/v2 v2.30.0 // indirect
github.com/jackc/pgpassfile v1.0.0 // indirect
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
github.com/jackc/puddle/v2 v2.2.2 // indirect
github.com/klauspost/compress v1.20.0 // indirect
github.com/mattn/go-colorable v0.1.15 // indirect
github.com/mattn/go-isatty v0.0.24 // indirect
github.com/molecule-man/go-brrr v1.1.0 // indirect
github.com/philhofer/fwd v1.2.0 // indirect
github.com/savsgio/gotils v0.0.0-20250924091648-bce9a52d7761 // indirect
github.com/tinylib/msgp v1.6.4 // indirect
github.com/andybalholm/brotli v1.1.0 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/gookit/color v1.5.4 // indirect
github.com/klauspost/compress v1.17.8 // indirect
github.com/kr/pretty v0.3.1 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/mattn/go-runewidth v0.0.15 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/rivo/uniseg v0.4.7 // indirect
github.com/rogpeppe/go-internal v1.11.0 // indirect
github.com/valyala/bytebufferpool v1.0.0 // indirect
github.com/valyala/fastrand v1.1.0 // indirect
github.com/valyala/histogram v1.2.0 // indirect
github.com/yuin/gopher-lua v1.1.1 // indirect
go.opentelemetry.io/auto/sdk v1.2.1 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.46.0 // indirect
go.opentelemetry.io/otel/metric v1.46.0 // indirect
go.opentelemetry.io/proto/otlp v1.11.0 // indirect
go.uber.org/atomic v1.12.0 // indirect
go.yaml.in/yaml/v3 v3.0.5 // indirect
golang.org/x/crypto v0.57.0 // indirect
golang.org/x/net v0.59.0 // indirect
golang.org/x/sync v0.23.0 // indirect
golang.org/x/sys v0.48.0 // indirect
golang.org/x/term v0.46.0 // indirect
golang.org/x/text v0.42.0 // indirect
golang.org/x/time v0.16.0 // indirect
google.golang.org/genproto/googleapis/api v0.0.0-20260917231906-eeb232e0883d // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20260917231906-eeb232e0883d // indirect
google.golang.org/protobuf v1.36.12 // indirect
github.com/valyala/tcplisten v1.0.0 // indirect
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect
golang.org/x/net v0.26.0 // indirect
golang.org/x/sync v0.7.0 // indirect
golang.org/x/sys v0.21.0 // indirect
golang.org/x/term v0.21.0 // indirect
golang.org/x/text v0.16.0 // indirect
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
+83 -162
View File
@@ -1,174 +1,95 @@
github.com/MicahParks/jwkset v0.11.3 h1:Phli4RdTDdIdLXZpuO7abkwZyzIk0RDTUPVVBHPRdkQ=
github.com/MicahParks/jwkset v0.11.3/go.mod h1:U2oRhRaLgDCLjtpGL2GseNKGmZtLs/3O7p+OZaL5vo0=
github.com/MicahParks/keyfunc/v3 v3.8.2 h1:eydEwk/pBAVrDIpmFfB/gkCcrp++xQ7YYXirrI2zlWE=
github.com/MicahParks/keyfunc/v3 v3.8.2/go.mod h1:T4snFPe26GwMg45bBAdM5P6qWQyLxZHLwBhxR/9PnCs=
github.com/VictoriaMetrics/metrics v1.44.0 h1:Fr8yqQSV+ZfYaDD/anqk1E8e9YPgfleSleJmAI0M0Tw=
github.com/VictoriaMetrics/metrics v1.44.0/go.mod h1:xDM82ULLYCYdFRgQ2JBxi8Uf1+8En1So9YUwlGTOqTc=
github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a h1:HbKu58rmZpUGpz5+4FfNmIU+FmZg2P3Xaj2v2bfNWmk=
github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a/go.mod h1:SGnFV6hVsYE877CKEZ6tDNTjaSXYUk6QqoIK6PrAtcc=
github.com/alicebob/miniredis/v2 v2.33.0 h1:uvTF0EDeu9RLnUEG27Db5I68ESoIxTiXbNUiji6lZrA=
github.com/alicebob/miniredis/v2 v2.33.0/go.mod h1:MhP4a3EU7aENRi9aO+tHfTBZicLqQevyi/DJpoj6mi0=
github.com/avast/retry-go/v4 v4.7.0 h1:yjDs35SlGvKwRNSykujfjdMxMhMQQM0TnIjJaHB+Zio=
github.com/avast/retry-go/v4 v4.7.0/go.mod h1:ZMPDa3sY2bKgpLtap9JRUgk2yTAba7cgiFhqxY2Sg6Q=
github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs=
github.com/bsm/ginkgo/v2 v2.12.0/go.mod h1:SwYbGRRDovPVboqFv0tPTcG1sN61LM1Z4ARdbAV9g4c=
github.com/bsm/gomega v1.27.10 h1:yeMWxP2pV2fG3FgAODIY8EiRE3dy0aeFYt4l7wh6yKA=
github.com/bsm/gomega v1.27.10/go.mod h1:JyEr/xRbxbtgWNi8tIEVPUYZ5Dzef52k01W3YH0H+O0=
github.com/cenkalti/backoff/v5 v5.0.3 h1:ZN+IMa753KfX5hd8vVaMixjnqRZ3y8CuJKRKj1xcsSM=
github.com/cenkalti/backoff/v5 v5.0.3/go.mod h1:rkhZdG3JZukswDf7f0cwqPNk4K0sa+F97BxZthm/crw=
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/fasthttp/websocket v1.5.12 h1:e4RGPpWW2HTbL3zV0Y/t7g0ub294LkiuXXUuTOUInlE=
github.com/fasthttp/websocket v1.5.12/go.mod h1:I+liyL7/4moHojiOgUOIKEWm9EIxHqxZChS+aMFltyg=
github.com/fxamacker/cbor/v2 v2.9.3 h1:oQBnFATpNdY8gJHTndDDv5Xl4QqNaz51G5LLEPhng3Q=
github.com/fxamacker/cbor/v2 v2.9.3/go.mod h1:vM4b+DJCtHn+zz7h3FFp/hDAI9WNWCsZj23V5ytsSxQ=
github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
github.com/go-logr/logr v1.4.4 h1:tG4xh9yMsRCAiodLVTxyrkzSZ9+o0L1Kg/+cPVcbP/8=
github.com/go-logr/logr v1.4.4/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/goccy/go-json v0.10.6 h1:p8HrPJzOakx/mn/bQtjgNjdTcN+/S6FcG2CTtQOrHVU=
github.com/goccy/go-json v0.10.6/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
github.com/goccy/go-reflect v1.2.0 h1:O0T8rZCuNmGXewnATuKYnkL0xm6o8UNOJZd/gOkb9ms=
github.com/goccy/go-reflect v1.2.0/go.mod h1:n0oYZn8VcV2CkWTxi8B9QjkCoq6GTtCEdfmR66YhFtE=
github.com/gofiber/contrib/v3/websocket v1.2.6 h1:5XcHejNCq460uLSdDAAp11RIrDGMHax07d0zWUZXgYc=
github.com/gofiber/contrib/v3/websocket v1.2.6/go.mod h1:QHnpSvNDsoVHrfSvnMl9ptx6x4l83moCtiT+4XM++nw=
github.com/gofiber/fiber/v3 v3.5.0 h1:dk7TOUH6DXJGtOLsN2XEG+0ZML7cznzHILTVozbNEK8=
github.com/gofiber/fiber/v3 v3.5.0/go.mod h1:GOVDTW+gjJvfe0iJyVujbQ1Lnx+JUjFySJRI/9/xX/w=
github.com/gofiber/schema v1.8.7 h1:7cSagr2ObiUVFuitCOqjKMqIhV+oVbkanP4Ge/wHsnI=
github.com/gofiber/schema v1.8.7/go.mod h1:fBz4T6uOepH3L+dYlz/yzQ0bFHPnfExkp/B3Qrk2VBI=
github.com/gofiber/utils/v2 v2.5.2 h1:bX+iACKsCGm2+dW7jvkYSiWIsBaKqFy5slFSxJSIL/s=
github.com/gofiber/utils/v2 v2.5.2/go.mod h1:EaVDjy4JJv0m0lg6x4owJ1GG8j1pMO8XriqCgVns1ZQ=
github.com/gofrs/flock v0.13.1 h1:jjREztyBeSKBZYAC+mgc1laB+xsgy4kYMf3FbKF2UBo=
github.com/gofrs/flock v0.13.1/go.mod h1:sf4BFiHwnvgxa25DlQoDqXQnwRMEOwqxRq37P6MzzmE=
github.com/golang-jwt/jwt/v5 v5.3.1 h1:kYf81DTWFe7t+1VvL7eS+jKFVWaUnK9cB1qbwn63YCY=
github.com/golang-jwt/jwt/v5 v5.3.1/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE=
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/VictoriaMetrics/metrics v1.33.1 h1:CNV3tfm2Kpv7Y9W3ohmvqgFWPR55tV2c7M2U6OIo+UM=
github.com/VictoriaMetrics/metrics v1.33.1/go.mod h1:r7hveu6xMdUACXvB8TYdAj8WEsKzWB0EkpJN+RDtOf8=
github.com/andybalholm/brotli v1.1.0 h1:eLKJA0d02Lf0mVpIDgYnqXcUn0GqVmEFny3VuID1U3M=
github.com/andybalholm/brotli v1.1.0/go.mod h1:sms7XGricyQI9K10gOSf56VKKWS4oLer58Q+mhRPtnY=
github.com/avast/retry-go/v4 v4.6.0 h1:K9xNA+KeB8HHc2aWFuLb25Offp+0iVRXEvFx8IinRJA=
github.com/avast/retry-go/v4 v4.6.0/go.mod h1:gvWlPhBVsvBbLkVGDg/KwvBv0bEkCOLRRSHKIr2PyOE=
github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
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/goccy/go-json v0.10.3 h1:KZ5WoDbxAIgm2HNbYckL0se1fHD6rz5j4ywS6ebzDqA=
github.com/goccy/go-json v0.10.3/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
github.com/gofiber/fiber/v2 v2.52.4 h1:P+T+4iK7VaqUsq2PALYEfBBo6bJZ4q3FP8cZ84EggTM=
github.com/gofiber/fiber/v2 v2.52.4/go.mod h1:KEOE+cXMhXG0zHc9d8+E38hoX+ZN7bhOtgeF2oT6jrQ=
github.com/gofrs/flock v0.8.1 h1:+gYjHKf32LDeiEEFhQaotPbLuUXjY5ZqxKgXy7n59aw=
github.com/gofrs/flock v0.8.1/go.mod h1:F1TvTiK9OcQqauNUHlbJvyl9Qa1QvF/gOUDKA14jxHU=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gookit/goutil v0.8.0 h1:efZWxfesXw8+5tQfTfRMSIC6A0ax527/H+A/aIiaSrw=
github.com/gookit/goutil v0.8.0/go.mod h1:vJS9HXctYTCLtCsZot5L5xF+O1oR17cDYO9R0HxBmnU=
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/gookit/color v1.5.4 h1:FZmqs7XOyGgCAxmWyPslpiok1k05wmY3SJTytgvYFs0=
github.com/gookit/color v1.5.4/go.mod h1:pZJOeOS8DM43rXbp4AZo1n9zCU2qjpcRko0b6/QJi9w=
github.com/gookit/goutil v0.6.15 h1:mMQ0ElojNZoyPD0eVROk5QXJPh2uKR4g06slgPDF5Jo=
github.com/gookit/goutil v0.6.15/go.mod h1:qdKdYEHQdEtyH+4fNdQNZfJHhI0jUZzHxQVAV3DaMDY=
github.com/graphql-go/graphql v0.8.1 h1:p7/Ou/WpmulocJeEx7wjQy611rtXGQaAcXGqanuMMgc=
github.com/graphql-go/graphql v0.8.1/go.mod h1:nKiHzRM0qopJEwCITUuIsxk9PlVlwIiiI8pnJEhordQ=
github.com/grpc-ecosystem/grpc-gateway/v2 v2.30.0 h1:/Tnpcb2E0Pz/tN9s3bfEY2Q8ePCEX9iuS+cneUwncnw=
github.com/grpc-ecosystem/grpc-gateway/v2 v2.30.0/go.mod h1:zOBXOsUaBSjKgmH4OGzV1esUpR3oUSCPYVd2cUBjKYY=
github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo=
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
github.com/jackc/pgx/v5 v5.11.0 h1:IzBBtyK9AHqf98cctWFifYSci2hgQR/cd56wB4p+ogg=
github.com/jackc/pgx/v5 v5.11.0/go.mod h1:mal1tBGAFfLHvZzaYh77YS/eC6IX9OWbRV1QIIM0Jn4=
github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=
github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
github.com/klauspost/compress v1.20.0 h1:a3C1ke2ohxFymNlb2HWAHjDeKCI90scRskErZkR0ezA=
github.com/klauspost/compress v1.20.0/go.mod h1:LUdAzn7YLVvxLpc7y3V1m40wESHTgc1422pwwBSKYuI=
github.com/klauspost/cpuid/v2 v2.2.10 h1:tBs3QSyvjDyFTq3uoc/9xFpCuOsJQFNPiAhYdw2skhE=
github.com/klauspost/cpuid/v2 v2.2.10/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0=
github.com/lukaszraczylo/ask v0.0.0-20240916204100-6e9ef53a62d9 h1:pL8B9mjv6RPUfKYYGm/uJ7QL6Ndf+z+OEl0qJE6KmEc=
github.com/lukaszraczylo/ask v0.0.0-20240916204100-6e9ef53a62d9/go.mod h1:M+UVdyqZs++xtEPrascaVmZdOMhCnxjZ2SgH+xHpR0c=
github.com/lukaszraczylo/go-ratecounter v0.1.12 h1:VO6hHYGw/Jy9JUizXf/bS0AI2QX1ueWWAWckMFVJ/w4=
github.com/lukaszraczylo/go-ratecounter v0.1.12/go.mod h1:TqXEOCtFJStk1i0tkipprv1kiDHGon1MVUisjSTBSKM=
github.com/lukaszraczylo/go-simple-graphql v1.2.89 h1:Xbu1Ny+a0lT2Sr2SaSC8mcHmGQDwGD4TJKk4DDd+PwA=
github.com/lukaszraczylo/go-simple-graphql v1.2.89/go.mod h1:PxQYblQDZISmYYj8sNfazAWxAOh1rhAtU208y+uPV8s=
github.com/lukaszraczylo/oss-telemetry v0.2.3 h1:xoDtBqeZGmXj7IteiE1M5WMuzeoqag58qEleI0Cf2Ms=
github.com/lukaszraczylo/oss-telemetry v0.2.3/go.mod h1:+Cn78qZo8rc3T9eZt0v3oICYRdd75wORtSidc8lNjDQ=
github.com/mattn/go-colorable v0.1.15 h1:+u9SLTRGnXv73cEsnsmoZBom+dMU88B2M0aDcWy0/jY=
github.com/mattn/go-colorable v0.1.15/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8=
github.com/mattn/go-isatty v0.0.24 h1:tGZZoVgT/KiqK1c8ocVLeDS8BSWMRd47J3Lbz7vsReI=
github.com/mattn/go-isatty v0.0.24/go.mod h1:nMCL3Zebbrt45jsMDgnfIwz6ydEQApk5oEI3HqDio6A=
github.com/molecule-man/go-brrr v1.1.0 h1:rLBGSXA393y+5ttCBLkW34CHESop5tahrOFxVv/XDEU=
github.com/molecule-man/go-brrr v1.1.0/go.mod h1:7ybW6/7gA3oKY45jOfVNjSJDtrr6ea4tzbsTkjmQDC4=
github.com/philhofer/fwd v1.2.0 h1:e6DnBTl7vGY+Gz322/ASL4Gyp1FspeMvx1RNDoToZuM=
github.com/philhofer/fwd v1.2.0/go.mod h1:RqIHx9QI14HlwKwm98g9Re5prTQ6LdeRQn+gXJFxsJM=
github.com/klauspost/compress v1.17.8 h1:YcnTYrq7MikUT7k0Yb5eceMmALQPYBW/Xltxn0NAMnU=
github.com/klauspost/compress v1.17.8/go.mod h1:Di0epgTjJY877eYKx5yC51cX2A2Vl2ibi7bDH9ttBbw=
github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
github.com/lukaszraczylo/ask v0.0.0-20230927103145-2ff1123b4415 h1:lvI8Wlbg4PxkRcg2f10wgoaRpfN19v+YdRek3+dLtlM=
github.com/lukaszraczylo/ask v0.0.0-20230927103145-2ff1123b4415/go.mod h1:M+UVdyqZs++xtEPrascaVmZdOMhCnxjZ2SgH+xHpR0c=
github.com/lukaszraczylo/go-ratecounter v0.1.8 h1:ZYm6Wkn58ZAlFWRmC7PaD4oAYHWcu8/0MUDWGe3PnJQ=
github.com/lukaszraczylo/go-ratecounter v0.1.8/go.mod h1:TqXEOCtFJStk1i0tkipprv1kiDHGon1MVUisjSTBSKM=
github.com/lukaszraczylo/go-simple-graphql v1.2.14 h1:Dth+yZ+1ialCpnslSb6UgHbXszExjDUu/I95QZbnWVU=
github.com/lukaszraczylo/go-simple-graphql v1.2.14/go.mod h1:pSKmm9OLGoS9pjmIvhBB/fo0+LganRrL29CN3fdkRPw=
github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U=
github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/prashantv/gostub v1.1.0 h1:BTyx3RfQjRHnUWaGF9oQos79AlQ5k8WNktv7VGvVH4g=
github.com/prashantv/gostub v1.1.0/go.mod h1:A5zLQHz7ieHGG7is6LLXLz7I8+3LZzsrV0P1IAHhP5U=
github.com/redis/go-redis/v9 v9.22.0 h1:laDvpYXTJtZLloinw1fA5Kqd6HAEH2XKxOkG/PDq2F0=
github.com/redis/go-redis/v9 v9.22.0/go.mod h1:y2g0Wj8rQvuK0ELM+oxSudcLtC09JScs98I/X9gRWY4=
github.com/savsgio/gotils v0.0.0-20250924091648-bce9a52d7761 h1:McifyVxygw1d67y6vxUqls2D46J8W9nrki9c8c0eVvE=
github.com/savsgio/gotils v0.0.0-20250924091648-bce9a52d7761/go.mod h1:Vi9gvHvTw4yCUHIznFl5TPULS7aXwgaTByGeBY75Wko=
github.com/shamaton/msgpack/v3 v3.2.3 h1:0r0aZtrXDFOPpwWJTEOpFq+Ih/JmMLm0pqLN5mSilrw=
github.com/shamaton/msgpack/v3 v3.2.3/go.mod h1:sgBYvEiyz8JR1NC3yGRoPVME9xXovpnh3l/plW1nfRo=
github.com/sony/gobreaker v1.0.0 h1:feX5fGGXSl3dYd4aHZItw+FpHLvvoaqkawKjVNiFMNQ=
github.com/sony/gobreaker v1.0.0/go.mod h1:ZKptC7FHNvhBz7dN2LGjPVBz2sZJmc0/PkyDJOjmxWY=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.12.1 h1:EuwCh5fleGS7H32xRwO3wRGT7DxrDhLAT6FF8MpWDWE=
github.com/stretchr/testify v1.12.1/go.mod h1:MDEgiDPPsNp5cuIrHPPCyornHKgEVbtFUmoNlxoYthg=
github.com/tinylib/msgp v1.6.4 h1:mOwYbyYDLPj35mkA2BjjYejgJk9BuHxDdvRnb6v2ZcQ=
github.com/tinylib/msgp v1.6.4/go.mod h1:RSp0LW9oSxFut3KzESt5Voq4GVWyS+PSulT77roAqEA=
github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M=
github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA=
github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8=
github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
github.com/valyala/fasthttp v1.74.0 h1:wMS9fnO2QTALozYx5pId2Vi7ZwU/epUkY8i/KPWCHoU=
github.com/valyala/fasthttp v1.74.0/go.mod h1:3ARmLamUcw7ElxVtC8PXaGzQ6VEuvnetlkrwIklQBSE=
github.com/valyala/fasthttp v1.54.0 h1:cCL+ZZR3z3HPLMVfEYVUMtJqVaui0+gu7Lx63unHwS0=
github.com/valyala/fasthttp v1.54.0/go.mod h1:6dt4/8olwq9QARP/TDuPmWyWcl4byhpvTJ4AAtcz+QM=
github.com/valyala/fastrand v1.1.0 h1:f+5HkLW4rsgzdNoleUOB69hyT9IlD2ZQh9GyDMfb5G8=
github.com/valyala/fastrand v1.1.0/go.mod h1:HWqCzkrkg6QXT8V2EXWvXCoow7vLwOFN002oeRzjapQ=
github.com/valyala/histogram v1.2.0 h1:wyYGAZZt3CpwUiIb9AU/Zbllg1llXyrtApRS815OLoQ=
github.com/valyala/histogram v1.2.0/go.mod h1:Hb4kBwb4UxsaNbbbh+RRz8ZR6pdodR57tzWUS3BUzXY=
github.com/x448/float16 v0.8.4 h1:qLwI1I70+NjRFUR3zs1JPUCgaCXSh3SW62uAKT1mSBM=
github.com/x448/float16 v0.8.4/go.mod h1:14CWIYCyZA/cWjXOioeEpHeN/83MdbZDRQHoFcYsOfg=
github.com/yuin/gopher-lua v1.1.1 h1:kYKnWBjvbNP4XLT3+bPEwAXJx262OhaHDWDVOPjL46M=
github.com/yuin/gopher-lua v1.1.1/go.mod h1:GBR0iDaNXjAgGg9zfCvksxSRnQx76gclCIb7kdAd1Pw=
github.com/zeebo/xxh3 v1.1.0 h1:s7DLGDK45Dyfg7++yxI0khrfwq9661w9EN78eP/UZVs=
github.com/zeebo/xxh3 v1.1.0/go.mod h1:IisAie1LELR4xhVinxWS5+zf1lA4p0MW4T+w+W07F5s=
go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=
go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y=
go.opentelemetry.io/otel v1.46.0 h1:FHt5/CDyVxi/8IM1CH7VE/rRgq3kLHa2mSTVMO8AWyc=
go.opentelemetry.io/otel v1.46.0/go.mod h1:Gj3SEScelsNC45tp4nSxRYlS+f5iez7W8XPMCt905kE=
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.46.0 h1:OFnwLJr+pF3iHrlGSzbxyuo6/6HyBlnlN1CWEJmBVcw=
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.46.0/go.mod h1:716wFneO0ov19A2beH5hjfh9AK5z/VWNAtDijp1Y0/g=
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.46.0 h1:w53CDeOA/Kurp7yRsegSr6pbbr759dOvJ+yNmWM6Hxs=
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.46.0/go.mod h1:BOmGMCbAtvcJiSJ+hLuhgPLdDbimnraSl8irz3iY8sY=
go.opentelemetry.io/otel/metric v1.46.0 h1:yBnkXvgV7AXFILZc5K6IZe/CBFF3OS7BJ8ov6/lj0K8=
go.opentelemetry.io/otel/metric v1.46.0/go.mod h1:iPmdWqifKUdzziPkvvzIJXITl56fQx2mGM/DHLB3/2o=
go.opentelemetry.io/otel/sdk v1.46.0 h1:h5CNQQjEbuQXY/JfZtgt3i7HVFV3aHPO2OAwO2eTYPI=
go.opentelemetry.io/otel/sdk v1.46.0/go.mod h1:GAERFXFt5SYCEB+YiKUbMBeza6UaDH7GmGOZEfh2gSM=
go.opentelemetry.io/otel/sdk/metric v1.46.0 h1:0piZ26EG4RBfebb2jhDH6ERCYHoVWduc3kLgPCwSnSE=
go.opentelemetry.io/otel/sdk/metric v1.46.0/go.mod h1:I1PbKrdVc8Qu8HYVDNtqVIwLwjNrhsV/uFuxfwg8mO4=
go.opentelemetry.io/otel/trace v1.46.0 h1:OULy7ccdJnZtJ0UDYFOIGaCmiWzJ8Vi2G/Rsu60qs1c=
go.opentelemetry.io/otel/trace v1.46.0/go.mod h1:J7GAXweO77XSFkB/rmAqk9D6ihszhFjLU+d9WuUxDLI=
go.opentelemetry.io/proto/otlp v1.11.0 h1:5rrYs0Ykyj50sdU/JU0x8etU+LubXWb+gED6TbEdMIk=
go.opentelemetry.io/proto/otlp v1.11.0/go.mod h1:SmVizdCOAm3XBtG1g1NnOdhW6jtddT72hLMhv8VwA8E=
go.uber.org/atomic v1.12.0 h1:BvcXdFKuviU4fTL/f+SxdQ5qJX/Jix8pAkgdUcb3XOE=
go.uber.org/atomic v1.12.0/go.mod h1:I6c4cg+6HCxRjfjSsYtApoFILnpc0CGUdGkXVqbYVNk=
go.uber.org/automaxprocs v1.6.0 h1:O3y2/QNTOdbF+e/dpXNNW7Rx2hZ4sTIPyybbxyNqTUs=
go.uber.org/automaxprocs v1.6.0/go.mod h1:ifeIMSnPZuznNm6jmdzmU3/bfk01Fe2fotchwEFJ8r8=
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
go.yaml.in/yaml/v3 v3.0.5 h1:N6y/pJk8buWs9NY5ERU2HSMfm+IuD/OtfdAnq6kESPw=
go.yaml.in/yaml/v3 v3.0.5/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg=
golang.org/x/crypto v0.57.0 h1:3ZVCjf8Ggz7zneR/EHRVx68Ctf+2pmIMP2UFhh9cC6M=
golang.org/x/crypto v0.57.0/go.mod h1:Fdz0i5U6CoizGwLda9DttjSk6qlZo25zYNtR+ycvuZA=
golang.org/x/net v0.59.0 h1:5zfYln+w5XCxwrnMMJPufRgNoXEaGxl0wo5GqPXyues=
golang.org/x/net v0.59.0/go.mod h1:2DA/G1UfVbCpQPeWTmMPGY7Cs2PkBkwu743bVX5PIVg=
golang.org/x/sync v0.23.0 h1:KameEIfc1IkluZyXWLn39Wd4tURc6GbCiISGiZm2bQk=
golang.org/x/sync v0.23.0/go.mod h1:sUUOizhqBxiL6pEWpqNLUiaJn1ShEbZ6BBqskPbjZm0=
golang.org/x/sys v0.48.0 h1:bbX/i/6MgT9BVLM9RT1thmxL04yeTAhbEz4SyadbXoo=
golang.org/x/sys v0.48.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
golang.org/x/term v0.46.0 h1:3+OXuTbaKDgwk8jTi3aSLHRlmWqHEUDUtxnbFigO4YE=
golang.org/x/term v0.46.0/go.mod h1:+K02xbkittuwc0Am4abfA3Fc+XRGXkvBXNO88NCXPoc=
golang.org/x/text v0.42.0 h1:JbOZXgfeCPU9gacVtYliJqOhD+zhrEqK4LfdpmlUZqI=
golang.org/x/text v0.42.0/go.mod h1:ojzP1Z+2QtioaF8DTtO8K5q7JWVVYwZKenzujK0Zd0E=
golang.org/x/time v0.16.0 h1:vMb6ptszcQMkcwiRTAuNNU50gom6++Q/6gY2hDM6VDE=
golang.org/x/time v0.16.0/go.mod h1:rVKOqvZeKvrDKTQiAHJ7wmwP0RzleSphoEA9RcdLA0s=
golang.org/x/tools v0.49.0 h1:3NI7VXzL9+1WZD52Dx2ttoPwD5DWrFGpl9mFZDlmisI=
golang.org/x/tools v0.49.0/go.mod h1:SJNXV9DBKT0UbdttsQjbfJlAE/q+y36++zo3uL3N0Oo=
gonum.org/v1/gonum v0.17.0 h1:VbpOemQlsSMrYmn7T2OUvQ4dqxQXU+ouZFQsZOx50z4=
gonum.org/v1/gonum v0.17.0/go.mod h1:El3tOrEuMpv2UdMrbNlKEh9vd86bmQ6vqIcDwxEOc1E=
google.golang.org/genproto/googleapis/api v0.0.0-20260917231906-eeb232e0883d h1:/9LpSFSe+gfp9SQOAkheborv5745Puiy5eHCZqCahGY=
google.golang.org/genproto/googleapis/api v0.0.0-20260917231906-eeb232e0883d/go.mod h1:+To63Bl+R71zXOxsr6X8nYMy4KytqWMFFpOb6W278qo=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260917231906-eeb232e0883d h1:cDmz0iu+zm7SfyudwKqfExdDAxoJWhT2VtYJ+pLi7GQ=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260917231906-eeb232e0883d/go.mod h1:OaIUM3+LpYcK2GXM4FTmhWoIq371Owdr+Cc7/BsYHHc=
google.golang.org/grpc v1.84.0 h1:soMyaPJ8pAak5PIQ0DGBUir0XRo2fRoMqhNWMLlLxO0=
google.golang.org/grpc v1.84.0/go.mod h1:ljCht0DrxQrXBDRTZp52Qxh3Ffk8CdYm2sj4O2QN2C0=
google.golang.org/protobuf v1.36.12 h1:pJOKDDOyeXErUroCihFAd5LQuwXBSpVnKGrj5o/fwxc=
google.golang.org/protobuf v1.36.12/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
github.com/valyala/tcplisten v1.0.0 h1:rBHj/Xf+E1tRGZyWIWwJDiRY0zc1Js+CV5DqwacVSA8=
github.com/valyala/tcplisten v1.0.0/go.mod h1:T0xQ8SeCZGxckz9qRXTfG43PvQ/mcWh7FwZEA7Ioqkc=
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI=
golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo=
golang.org/x/net v0.26.0 h1:soB7SVo0PWrY4vPW/+ay0jKDNScG2X9wFeYlXIvJsOQ=
golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE=
golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M=
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws=
golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/term v0.21.0 h1:WVXCp+/EBEHOj53Rvu+7KiT/iElMrO8ACK16SMZ3jaA=
golang.org/x/term v0.21.0/go.mod h1:ooXLefLobQVslOqselCNF4SxFAaoS6KujMbsGzSDmX0=
golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4=
golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+130 -515
View File
@@ -1,91 +1,58 @@
package main
import (
"runtime"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
"unicode"
"github.com/goccy/go-json"
fiber "github.com/gofiber/fiber/v3"
fiber "github.com/gofiber/fiber/v2"
"github.com/graphql-go/graphql/language/ast"
"github.com/graphql-go/graphql/language/parser"
"github.com/graphql-go/graphql/language/source"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
)
var (
introspectionQueries = map[string]struct{}{
"__schema": {}, "__type": {}, "__typename": {}, "__directive": {},
"__directivelocation": {}, "__field": {}, "__inputvalue": {},
"__enumvalue": {}, "__typekind": {}, "__fieldtype": {},
"__inputobjecttype": {}, "__enumtype": {}, "__uniontype": {},
"__scalars": {}, "__objects": {}, "__interfaces": {},
"__unions": {}, "__enums": {}, "__inputobjects": {}, "__directives": {},
var introspection_queries = []string{
"__schema",
"__type",
"__typename",
"__directive",
"__directivelocation",
"__field",
"__inputvalue",
"__enumvalue",
"__typekind",
"__fieldtype",
"__inputobjecttype",
"__enumtype",
"__uniontype",
"__scalars",
"__objects",
"__interfaces",
"__unions",
"__enums",
"__inputobjects",
"__directives",
}
// Saving the introspection queries as a map O(1) operation instead of O(n) for a slice.
var introspectionQuerySet = map[string]struct{}{}
var introspectionAllowedQueries = map[string]struct{}{}
var allowedUrls = map[string]struct{}{}
// Utility function to convert a slice of strings to a map for O(1) lookups.
func sliceToMap(slice []string) map[string]struct{} {
resultMap := make(map[string]struct{}, len(slice))
for _, item := range slice {
resultMap[strings.ToLower(item)] = struct{}{}
}
introspectionAllowedQueries = make(map[string]struct{})
allowedUrls = make(map[string]struct{})
// Cache for parsed GraphQL queries to avoid reparsing
parsedQueryCache *LRUCache
// Maximum size for parsed query cache
maxQueryCacheSize = 1000
currentCacheSize int64 // Use atomic operations for this
)
// sanitizeOperationName removes null bytes and other invalid characters from operation names
// This prevents panics when creating metrics with invalid label values
func sanitizeOperationName(name string) string {
if name == "" || name == "undefined" {
return name
}
var buf strings.Builder
buf.Grow(len(name))
for _, r := range name {
// Skip null bytes entirely
if r == '\x00' {
continue
}
// Replace control characters with underscores
if r < 32 || r == 127 {
buf.WriteByte('_')
continue
}
// Only allow printable characters
if unicode.IsPrint(r) {
buf.WriteRune(r)
}
}
result := buf.String()
// Return "undefined" if we ended up with an empty string after sanitization
if result == "" {
return "undefined"
}
return result
return resultMap
}
func prepareQueriesAndExemptions() {
introspectionAllowedQueries = make(map[string]struct{})
allowedUrls = make(map[string]struct{})
// Process allowed introspection queries
for _, q := range cfg.Security.IntrospectionAllowed {
cleanQuery := strings.Trim(strings.TrimSpace(q), `"`)
introspectionAllowedQueries[strings.ToLower(cleanQuery)] = struct{}{}
}
// Process allowed URLs
for _, u := range cfg.Server.AllowURLs {
allowedUrls[u] = struct{}{}
}
introspectionQuerySet = sliceToMap(introspection_queries)
introspectionAllowedQueries = sliceToMap(cfg.Security.IntrospectionAllowed)
allowedUrls = sliceToMap(cfg.Server.AllowURLs)
}
type parseGraphQLQueryResult struct {
@@ -99,490 +66,138 @@ type parseGraphQLQueryResult struct {
shouldIgnore bool
}
// AST node pools to reduce GC pressure
var (
// Pool for request/response maps during unmarshaling
queryPool = sync.Pool{
New: func() any {
return make(map[string]any, 48)
},
func parseGraphQLQuery(c *fiber.Ctx) (res *parseGraphQLQueryResult) {
res = &parseGraphQLQueryResult{shouldIgnore: true}
m := make(map[string]interface{})
err := json.Unmarshal(c.Body(), &m)
if err != nil {
cfg.Logger.Error("Can't unmarshal the request", map[string]interface{}{"error": err.Error(), "body": string(c.Body())})
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsSkipped, nil)
}
return
}
// Pool for parse result objects
resultPool = sync.Pool{
New: func() any {
return &parseGraphQLQueryResult{}
},
}
// Mutex for allocation tracking
allocsMutex = sync.Mutex{}
)
// The following variables are reserved for future GraphQL parsing optimization
// and are not currently in use:
// - fieldPool (Field object pool)
// - operationPool (OperationDefinition object pool)
// - namePool (Name object pool)
// - documentPool (Document object pool)
// - allocsCounter (for tracking allocation counts)
// - allocationsSamp (for memory usage histograms)
// Initialize the query parse cache with configurable size
func initGraphQLParsing() {
// Use configured cache size, or default to CPU-based calculation
var cacheSize int
if cfg != nil && cfg.Cache.GraphQLQueryCacheSize > 0 {
cacheSize = cfg.Cache.GraphQLQueryCacheSize
} else {
// Fallback to CPU-based calculation
cacheSize = runtime.GOMAXPROCS(0) * 250
}
maxQueryCacheSize = cacheSize
// Initialize LRU cache with entry limit and 50MB size limit
parsedQueryCache = NewLRUCache(maxQueryCacheSize, 50*1024*1024)
if cfg != nil && cfg.Logger != nil {
cfg.Logger.Debug(&libpack_logger.LogMessage{
Message: "GraphQL query cache initialized",
Pairs: map[string]any{
"max_entries": maxQueryCacheSize,
"max_size_mb": 50,
},
})
}
}
// Store a parsed document in the cache with LRU eviction
func cacheQuery(queryText string, document *ast.Document) {
if parsedQueryCache == nil {
// get the query
query, ok := m["query"].(string)
if !ok {
cfg.Logger.Error("Can't find the query", map[string]interface{}{"query": query, "m_val": m})
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsSkipped, nil)
}
return
}
// Store the document in the cache with timestamp for LRU
cacheEntry := &CachedQuery{
Document: document,
Timestamp: time.Now(),
}
// The LRU cache handles eviction automatically
parsedQueryCache.Set(queryText, cacheEntry, int64(len(queryText)))
atomic.AddInt64(&currentCacheSize, 1)
}
// CachedQuery represents a cached GraphQL query with timestamp for LRU
type CachedQuery struct {
Document *ast.Document
Timestamp time.Time
}
// evictOldestQueries is no longer needed with LRU cache
// The LRU cache handles eviction automatically
// Check if we have a cached parsed query
func getCachedQuery(queryText string) *ast.Document {
if parsedQueryCache == nil {
return nil
}
if entry, found := parsedQueryCache.Get(queryText); found {
if cachedQuery, ok := entry.(*CachedQuery); ok {
if cfg != nil && cfg.Monitoring != nil {
cfg.Monitoring.Increment(libpack_monitoring.MetricsGraphQLCacheHit, nil)
}
return cachedQuery.Document
}
}
if cfg != nil && cfg.Monitoring != nil {
cfg.Monitoring.Increment(libpack_monitoring.MetricsGraphQLCacheMiss, nil)
}
return nil
}
// Track and report memory allocations for GraphQL parsing
func trackParsingAllocations() func() {
var m1 runtime.MemStats
runtime.ReadMemStats(&m1)
return func() {
var m2 runtime.MemStats
runtime.ReadMemStats(&m2)
// Calculate allocations
allocsMutex.Lock()
allocsDelta := int(m2.Mallocs - m1.Mallocs)
// Note: allocsCounter variable is currently unused but will be used in future
// allocsCounter += allocsDelta
allocsMutex.Unlock()
// Record allocation count metrics
if cfg != nil && cfg.Monitoring != nil {
cfg.Monitoring.IncrementFloat(libpack_monitoring.MetricsGraphQLParsingAllocs, nil, float64(allocsDelta))
}
}
}
func parseGraphQLQuery(c fiber.Ctx) *parseGraphQLQueryResult {
startTime := time.Now()
if cfg != nil && cfg.EnableAllocationTracking {
trackAllocs := trackParsingAllocations()
defer trackAllocs()
}
// Get a result object from the pool and initialize it
res := resultPool.Get().(*parseGraphQLQueryResult)
*res = parseGraphQLQueryResult{shouldIgnore: true}
// Ensure we return the result to the pool on function exit
defer func() {
resultPool.Put(res)
}()
// Default to using the write endpoint
res.activeEndpoint = cfg.Server.HostGraphQL
// Get a map from the pool for JSON unmarshaling
m := queryPool.Get().(map[string]any)
defer func() {
// Clear and return the map to the pool
for k := range m {
delete(m, k)
}
queryPool.Put(m)
}()
// Add comprehensive input validation
bodySize := len(c.Body())
// Validate query size to prevent DoS attacks
if bodySize > 1024*1024 { // 1MB limit
p, err := parser.Parse(parser.ParseParams{Source: query})
if err != nil {
cfg.Logger.Error("Can't parse the query", map[string]interface{}{"query": query, "m_val": m})
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsSkipped, nil)
cfg.Monitoring.Increment(libpack_monitoring.MetricsFailed, nil)
}
return res
return
}
// Validate minimum size
if bodySize < 2 { // At least "{}"
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsSkipped, nil)
}
return res
}
// Unmarshal the request body
if err := json.Unmarshal(c.Body(), &m); err != nil {
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsSkipped, nil)
}
return res
}
// Extract the query string
query, ok := m["query"].(string)
if !ok {
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsSkipped, nil)
}
return res
}
// Try to get the query from cache first
var p *ast.Document
cachedDoc := getCachedQuery(query)
if cachedDoc != nil {
// Use the cached document
p = cachedDoc
} else {
// Parse the GraphQL query with improved source handling
src := source.NewSource(&source.Source{
Body: []byte(query),
Name: "GraphQL request",
})
var err error
p, err = parser.Parse(parser.ParseParams{Source: src})
if err != nil {
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsFailed, nil)
cfg.Monitoring.Increment(libpack_monitoring.MetricsGraphQLParsingErrors, nil)
}
return res
}
// Cache the successful parse result for future use
cacheQuery(query, p)
}
// Mark as a valid GraphQL query
res.shouldIgnore = false
res.operationName = "undefined"
// Index named fragments so FragmentSpread nodes can be resolved during the
// introspection check. A named spread (e.g. `...F`) only carries a name;
// its content lives in the matching top-level FragmentDefinition, which the
// OperationDefinition loop below otherwise skips.
fragments := make(map[string]*ast.FragmentDefinition)
for _, d := range p.Definitions {
if fd, ok := d.(*ast.FragmentDefinition); ok && fd.Name != nil {
fragments[fd.Name.Value] = fd
}
}
// Single pass over definitions: gather operation type, mutation flag,
// operation name, and process directives / introspection checks together.
// Mutations take priority for operationType regardless of order.
hasMutation := false
res.activeEndpoint = cfg.Server.HostGraphQL
for _, d := range p.Definitions {
oper, ok := d.(*ast.OperationDefinition)
if !ok {
continue
}
if oper, ok := d.(*ast.OperationDefinition); ok {
res.operationType = strings.ToLower(oper.Operation)
// Lower-case operation string ONCE per definition.
operationType := strings.ToLower(oper.Operation)
isMutation := operationType == "mutation"
// Operation type assignment: mutations take priority; otherwise first-seen wins.
if isMutation && !hasMutation {
hasMutation = true
res.operationType = "mutation"
// Mutation name takes precedence — overwrite "undefined" if present.
if oper.Name != nil {
res.operationName = sanitizeOperationName(oper.Name.Value)
res.operationName = oper.Name.Value
}
} else if !hasMutation && res.operationType == "" {
res.operationType = operationType
}
// Operation name fill-in for non-mutation cases (or mutation w/o name handled above).
if res.operationName == "undefined" && oper.Name != nil {
res.operationName = sanitizeOperationName(oper.Name.Value)
}
// Block mutations in read-only mode
if res.operationType == "mutation" && cfg.Server.ReadOnlyMode {
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsSkipped, nil)
// If the query is a mutation then direct it to the RW endpoint,
// otherwise direct it to the RO endpoint if it's set.
if cfg.Server.HostGraphQLReadOnly != "" && res.operationType != "mutation" {
res.activeEndpoint = cfg.Server.HostGraphQLReadOnly
}
_ = c.Status(403).SendString("The server is in read-only mode")
res.shouldBlock = true
return res
}
// Process directives (like @cached)
processDirectives(oper, res)
if res.operationType == "mutation" && cfg.Server.ReadOnlyMode {
cfg.Logger.Warning("Mutation blocked", m)
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsSkipped, nil)
}
c.Status(403).SendString("The server is in read-only mode")
res.shouldBlock = true
return
}
// Check for introspection queries if they're blocked
if cfg.Security.BlockIntrospection && checkSelections(c, oper.GetSelectionSet().Selections, fragments, make(map[string]bool)) {
_ = c.Status(403).SendString("Introspection queries are not allowed")
res.shouldBlock = true
return res
}
}
// Handle endpoint routing AFTER processing all definitions
// This ensures mutations are always routed to the write endpoint
if res.operationType == "mutation" {
res.activeEndpoint = cfg.Server.HostGraphQL
} else if cfg.Server.HostGraphQLReadOnly != "" {
// Use read-only endpoint for non-mutation operations
res.activeEndpoint = cfg.Server.HostGraphQLReadOnly
}
// Track parsing time
if ifNotInTest() && cfg.Monitoring != nil {
parseTime := float64(time.Since(startTime).Milliseconds())
cfg.Monitoring.IncrementFloat(libpack_monitoring.MetricsGraphQLParsingTime, nil, parseTime)
}
// Create a copy to return, since the original will be returned to the pool
// This prevents race conditions where concurrent requests could modify the same result
result := *res
return &result
}
// processDirectives extracts caching directives from the operation
func processDirectives(oper *ast.OperationDefinition, res *parseGraphQLQueryResult) {
for _, dir := range oper.Directives {
if dir.Name.Value == "cached" {
res.cacheRequest = true
for _, arg := range dir.Arguments {
switch arg.Name.Value {
case "ttl":
if v, ok := arg.Value.GetValue().(string); ok {
res.cacheTime, _ = strconv.Atoi(v)
}
case "refresh":
if v, ok := arg.Value.GetValue().(bool); ok {
res.cacheRefresh = v
for _, dir := range oper.Directives {
if dir.Name.Value == "cached" {
res.cacheRequest = true
for _, arg := range dir.Arguments {
if arg.Name.Value == "ttl" {
res.cacheTime, err = strconv.Atoi(arg.Value.GetValue().(string))
if err != nil {
cfg.Logger.Error("Can't parse the ttl, using global", map[string]interface{}{"bad_ttl": arg.Value.GetValue().(string)})
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsFailed, nil)
}
return
}
}
if arg.Name.Value == "refresh" {
res.cacheRefresh = arg.Value.GetValue().(bool)
}
}
}
}
if cfg.Security.BlockIntrospection {
res.shouldBlock = checkSelections(c, oper.GetSelectionSet().Selections)
if res.shouldBlock {
return
}
}
}
}
return
}
// checkSelections recursively checks if any selection is an introspection query that should be blocked.
// fragments indexes top-level named FragmentDefinition nodes so that a FragmentSpread (which only
// carries a name) can be resolved to its actual selection set. visited tracks fragment names already
// entered anywhere in this top-level call's traversal so a fragment that spreads itself (directly or via
// a cycle, e.g. A -> B -> A) cannot recurse forever; graphql-go's parser does not reject fragment cycles,
// only its (unused) validator does. Skipping an already-visited fragment is safe in both situations the
// visited map covers. For a true cycle, the fragment is already being checked higher up the call stack,
// so re-entering it cannot discover anything new. For a diamond (DAG) reuse - the same fragment spread
// from two separate, non-nested branches, with no cycle involved - the fragment was already fully
// checked earlier in this traversal; since visited only ever grows (it is never cleared within a call),
// a later traversal of that same fragment could only re-walk a subset of what the earlier, complete
// traversal already covered, so skipping it loses nothing.
func checkSelections(c fiber.Ctx, selections []ast.Selection, fragments map[string]*ast.FragmentDefinition, visited map[string]bool) bool {
if len(selections) == 0 {
return false
}
// Fast path: if no introspection blocking is configured, return immediately
if !cfg.Security.BlockIntrospection {
return false
}
// Fast path: if there are no allowed introspection queries, check only top level
hasAllowList := len(cfg.Security.IntrospectionAllowed) > 0
func checkSelections(c *fiber.Ctx, selections []ast.Selection) bool {
for _, s := range selections {
switch sel := s.(type) {
case *ast.Field:
fieldName := strings.ToLower(sel.Name.Value)
// Check if this is an introspection query
if _, exists := introspectionQueries[fieldName]; exists {
if hasAllowList {
// Check if it's in the allowed list
if _, allowed := introspectionAllowedQueries[fieldName]; !allowed {
return true // Block if not allowed
}
} else {
return true // Block if no allowlist exists
}
}
// Check nested selections if present
if sel.SelectionSet != nil && len(sel.GetSelectionSet().Selections) > 0 {
if checkSelections(c, sel.GetSelectionSet().Selections, fragments, visited) {
return true
}
}
case *ast.InlineFragment:
// Check nested selections in fragments
if sel.SelectionSet != nil && len(sel.GetSelectionSet().Selections) > 0 {
if checkSelections(c, sel.GetSelectionSet().Selections, fragments, visited) {
return true
}
}
case *ast.FragmentSpread:
// A named fragment spread carries no selection set itself; resolve it
// to its top-level FragmentDefinition so introspection inside a named
// fragment (e.g. `...F` where F selects __schema) cannot bypass the block.
// Skip a name already visited to break self- and mutually-recursive
// fragment cycles (e.g. `fragment A on Query { ...A }`), which the
// parser does not reject.
if sel.Name != nil && !visited[sel.Name.Value] {
if frag, ok := fragments[sel.Name.Value]; ok && frag.SelectionSet != nil {
visited[sel.Name.Value] = true
if checkSelections(c, frag.SelectionSet.Selections, fragments, visited) {
return true
}
}
field, ok := s.(*ast.Field)
if !ok {
continue // or handle the case where the type assertion fails
}
shouldBlock := checkIfContainsIntrospection(c, field.Name.Value)
if shouldBlock {
return true
}
if field.SelectionSet != nil {
if checkSelections(c, field.GetSelectionSet().Selections) {
return true
}
}
}
return false
}
func checkIfContainsIntrospection(c fiber.Ctx, query string) bool {
startTime := time.Now()
blocked := false
func checkIfContainsIntrospection(c *fiber.Ctx, whatever string) (shouldBlock bool) {
whateverLower := strings.ToLower(whatever)
got_exemption := false
// Enable introspection blocking for tests
if !cfg.Security.BlockIntrospection {
cfg.Security.BlockIntrospection = true
}
// If the query is an introspection query, we need to check if it's allowed.
if _, exists := introspectionQuerySet[whateverLower]; exists {
if len(cfg.Security.IntrospectionAllowed) > 0 {
// Try to get cached parse result first
var p *ast.Document
cachedDoc := getCachedQuery(query)
if cachedDoc != nil {
p = cachedDoc
} else {
// Try parsing as a complete query
src := source.NewSource(&source.Source{
Body: []byte(query),
Name: "GraphQL introspection check",
})
var err error
p, err = parser.Parse(parser.ParseParams{Source: src})
if err == nil && p != nil {
// Cache the successful parse
cacheQuery(query, p)
}
}
if p != nil {
// Index named fragments so FragmentSpread nodes resolve correctly.
fragments := make(map[string]*ast.FragmentDefinition)
for _, def := range p.Definitions {
if fd, ok := def.(*ast.FragmentDefinition); ok && fd.Name != nil {
fragments[fd.Name.Value] = fd
if _, allowed_exists := introspectionAllowedQueries[whateverLower]; allowed_exists {
cfg.Logger.Debug("Introspection query allowed, passing through", map[string]interface{}{"query": whatever})
got_exemption = true
shouldBlock = false
}
}
// It's a complete query, check all selections
for _, def := range p.Definitions {
if op, ok := def.(*ast.OperationDefinition); ok {
if op.SelectionSet != nil {
blocked = checkSelections(c, op.GetSelectionSet().Selections, fragments, make(map[string]bool))
break
}
}
}
} else {
// Not a complete query, check as a field name
whateverLower := strings.ToLower(query)
if _, exists := introspectionQueries[whateverLower]; exists {
if len(cfg.Security.IntrospectionAllowed) > 0 {
if _, allowed := introspectionAllowedQueries[whateverLower]; !allowed {
blocked = true
}
} else {
blocked = true
}
if !got_exemption {
shouldBlock = true
}
}
if blocked {
if shouldBlock {
if ifNotInTest() {
cfg.Monitoring.Increment(libpack_monitoring.MetricsSkipped, nil)
}
_ = c.Status(403).SendString("Introspection queries are not allowed")
c.Status(403).SendString("Introspection queries are not allowed")
}
// Track parsing time
if ifNotInTest() && cfg.Monitoring != nil {
parseTime := float64(time.Since(startTime).Milliseconds())
cfg.Monitoring.IncrementFloat(libpack_monitoring.MetricsGraphQLParsingTime, nil, parseTime)
}
return blocked
return
}
// NOTE: The clearQueryCache function has been removed as it was unused.
// This functionality will be exposed through an API endpoint in a future release.
+22 -421
View File
@@ -1,19 +1,11 @@
package main
import (
"fmt"
"strings"
"testing"
"time"
"github.com/goccy/go-json"
fiber "github.com/gofiber/fiber/v3"
"github.com/graphql-go/graphql/language/ast"
"github.com/graphql-go/graphql/language/parser"
"github.com/valyala/fasthttp"
)
func (suite *Tests) Test_parseGraphQLQuery() {
type results struct {
op_name string
op_type string
@@ -282,19 +274,23 @@ func (suite *Tests) Test_parseGraphQLQuery() {
suite.Run(tt.name, func() {
cfg = &config{}
parseConfig()
// Create a context first, then modify its request directly
reqCtx := &fasthttp.RequestCtx{}
ctx_headers := func() *fasthttp.RequestHeader {
h := fasthttp.RequestHeader{}
for k, v := range tt.suppliedQuery.headers {
h.Add(k, v)
}
return &h
}()
// Set headers directly on the request
for k, v := range tt.suppliedQuery.headers {
reqCtx.Request.Header.Add(k, v)
ctx_request := fasthttp.Request{
Header: *ctx_headers,
}
// Set the body
reqCtx.Request.AppendBody([]byte(tt.suppliedQuery.body))
ctx_request.AppendBody([]byte(tt.suppliedQuery.body))
// Now create the fiber context with the request context
ctx := suite.app.AcquireCtx(reqCtx)
ctx := suite.app.AcquireCtx(&fasthttp.RequestCtx{
Request: ctx_request,
})
// defer func() {
// cfg = &config{}
@@ -302,417 +298,22 @@ func (suite *Tests) Test_parseGraphQLQuery() {
// suite.app.ReleaseCtx(ctx)
// }()
suite.NotNil(ctx, "Fiber context is nil")
assert.NotNil(ctx, "Fiber context is nil")
if tt.suppliedSettings != nil {
cfg = tt.suppliedSettings
}
prepareQueriesAndExemptions()
parseResult := parseGraphQLQuery(ctx)
suite.Equal(tt.wantResults.op_type, parseResult.operationType, "Unexpected operation type "+tt.name)
suite.Equal(tt.wantResults.op_name, parseResult.operationName, "Unexpected operation name "+tt.name)
suite.Equal(tt.wantResults.is_cached, parseResult.cacheRequest, "Unexpected cache value "+tt.name)
suite.Equal(tt.wantResults.cached_ttl, parseResult.cacheTime, "Unexpected cache TTL value "+tt.name)
suite.Equal(tt.wantResults.shouldBlock, parseResult.shouldBlock, "Unexpected block value "+tt.name)
suite.Equal(tt.wantResults.shouldIgnore, parseResult.shouldIgnore, "Unexpected ignore value "+tt.name)
assert.Equal(tt.wantResults.op_type, parseResult.operationType, "Unexpected operation type "+tt.name)
assert.Equal(tt.wantResults.op_name, parseResult.operationName, "Unexpected operation name "+tt.name)
assert.Equal(tt.wantResults.is_cached, parseResult.cacheRequest, "Unexpected cache value "+tt.name)
assert.Equal(tt.wantResults.cached_ttl, parseResult.cacheTime, "Unexpected cache TTL value "+tt.name)
assert.Equal(tt.wantResults.shouldBlock, parseResult.shouldBlock, "Unexpected block value "+tt.name)
assert.Equal(tt.wantResults.shouldIgnore, parseResult.shouldIgnore, "Unexpected ignore value "+tt.name)
if tt.wantResults.returnCode > 0 {
suite.Equal(tt.wantResults.returnCode, ctx.Response().StatusCode(), "Unexpected return code", tt.name)
}
})
}
}
func (suite *Tests) Test_parseGraphQLQuery_complex() {
// ... existing tests ...
// Add these new test cases
suite.Run("test complex query with multiple operations", func() {
query := `
query GetUser($id: ID!) {
user(id: $id) {
name
email
}
}
mutation UpdateUser($id: ID!, $name: String!) {
updateUser(id: $id, name: $name) {
id
name
}
}
`
body := fmt.Sprintf(`{"query": %q}`, query)
ctx := createTestContext(body)
result := parseGraphQLQuery(ctx)
// Since we now prioritize mutations when present in a GraphQL document with multiple operations
suite.Equal("mutation", result.operationType)
suite.Equal("UpdateUser", result.operationName)
suite.False(result.shouldBlock)
})
suite.Run("test query with custom directives", func() {
query := `
query GetUser($id: ID!) @custom(directive: "value") {
user(id: $id) {
name
email
}
}
`
body := fmt.Sprintf(`{"query": %q}`, query)
ctx := createTestContext(body)
result := parseGraphQLQuery(ctx)
suite.Equal("query", result.operationType)
suite.Equal("GetUser", result.operationName)
suite.False(result.shouldBlock)
suite.False(result.shouldBlock)
})
}
func (suite *Tests) Test_checkAllowedURLs() {
tests := []struct {
name string
path string
allowed []string
expected bool
}{
{"allowed path", "/v1/graphql", []string{"/v1/graphql"}, true},
{"disallowed path", "/v2/graphql", []string{"/v1/graphql"}, false},
{"empty allowed list", "/v1/graphql", []string{}, true},
{"multiple allowed paths", "/v2/graphql", []string{"/v1/graphql", "/v2/graphql"}, true},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
allowedUrls = make(map[string]struct{})
for _, url := range tt.allowed {
allowedUrls[url] = struct{}{}
}
app := fiber.New()
ctx := app.AcquireCtx(&fasthttp.RequestCtx{})
ctx.Request().SetRequestURI(tt.path)
ctx.Request().URI().SetPath(tt.path)
result := checkAllowedURLs(ctx)
suite.Equal(tt.expected, result, "Unexpected result in test case: "+tt.name)
})
}
}
func (suite *Tests) Test_checkIfContainsIntrospection() {
tests := []struct {
name string
query string
allowed []string
expected bool
}{
{"allowed introspection", "__schema", []string{"__schema"}, false},
{"disallowed introspection", "__type", []string{"__schema"}, true},
{"non-introspection query", "normalQuery", []string{}, false},
{"allowed introspection with deep nesting of __typename", "{__schema {queryType {fields {name description __typename}}}}", []string{"__schema", "__typename"}, false},
{"disallowed introspection with deep nesting of __typename", "{__type {queryType {fields {name description __typename}}}}", []string{"__type"}, true},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
cfg.Security.IntrospectionAllowed = tt.allowed
introspectionAllowedQueries = make(map[string]struct{})
for _, q := range tt.allowed {
introspectionAllowedQueries[strings.ToLower(q)] = struct{}{}
}
ctx := createTestContext("")
result := checkIfContainsIntrospection(ctx, tt.query)
suite.Equal(tt.expected, result)
})
}
}
func createTestContext(body string) fiber.Ctx {
app := fiber.New()
ctx := app.AcquireCtx(&fasthttp.RequestCtx{})
ctx.Request().SetBody([]byte(body))
return ctx
}
func (suite *Tests) Test_DeepIntrospectionQueries() {
tests := []struct {
name string
query string
allowed []string
expected bool
}{
{
name: "deeply nested single introspection",
query: "query { users { profiles { settings { preferences { __typename } } } } }",
allowed: []string{},
expected: true,
},
{
name: "multiple nested introspections",
query: "query { users { __typename profiles { __schema settings { __type } } } }",
allowed: []string{},
expected: true,
},
{
name: "nested with selective allowlist",
query: "query { users { __typename profiles { __schema settings { __type } } } }",
allowed: []string{"__typename"},
expected: true,
},
{
name: "deeply nested with full allowlist",
query: "query { users { __typename profiles { __schema settings { __type } } } }",
allowed: []string{"__typename", "__schema", "__type"},
expected: false,
},
{
name: "deeply nested with repeated item from allowlist",
query: "query PreloadStaticData {\n scenario {\n id\n name\n __typename\n }\n impact {\n id\n description\n __typename\n }\n likelihood {\n id\n description\n __typename\n }\n consequence {\n name\n __typename\n }\n risk_categories {\n name\n abbreviation\n __typename\n }\n mitigation {\n name\n __typename\n }\n}",
allowed: []string{"__type", "__typename"},
expected: false,
},
{
name: "deeply nested with repeated item denied",
query: "query PreloadStaticData {\n scenario {\n id\n name\n __typename\n }\n impact {\n id\n description\n __typename\n }\n likelihood {\n id\n description\n __typename\n }\n consequence {\n name\n __typename\n }\n risk_categories {\n name\n abbreviation\n __typename\n }\n mitigation {\n name\n __typename\n }\n}",
allowed: []string{},
expected: true,
},
{
name: "named fragment spreading introspection is blocked",
query: "query Q { ...IntroFields } fragment IntroFields on Query { __schema { queryType { name } } }",
allowed: []string{},
expected: true,
},
{
name: "named fragment spreading schema with allowlist is blocked",
query: "query Q { ...IntroFields } fragment IntroFields on Query { __schema { queryType { name } } }",
allowed: []string{"__typename"},
expected: true,
},
{
name: "named fragment without introspection is allowed",
query: "query Q { ...Fields } fragment Fields on User { id name }",
allowed: []string{},
expected: false,
},
{
name: "nested named fragment chain with introspection is blocked",
query: "query Q { ...A } fragment A on Query { ...B } fragment B on Query { __schema { queryType { name } } }",
allowed: []string{},
expected: true,
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
cfg.Security.BlockIntrospection = true
cfg.Security.IntrospectionAllowed = tt.allowed
introspectionAllowedQueries = make(map[string]struct{})
for _, q := range tt.allowed {
introspectionAllowedQueries[strings.ToLower(q)] = struct{}{}
}
body := map[string]any{
"query": tt.query,
}
bodyBytes, _ := json.Marshal(body)
ctx := fiber.New().AcquireCtx(&fasthttp.RequestCtx{})
ctx.Request().SetBody(bodyBytes)
parseGraphQLQuery(ctx)
if tt.expected {
suite.Equal(403, ctx.Response().StatusCode())
} else {
suite.Equal(200, ctx.Response().StatusCode())
}
})
}
}
// Test_FragmentCycleDoesNotHang guards against a stack-overflow DoS: graphql-go's
// parser.Parse does not reject fragment spread cycles (cycle detection lives only
// in the unused validator), so a self-referential or mutually-recursive named
// fragment must be caught by checkSelections' visited set instead of recursing
// until the process aborts.
func (suite *Tests) Test_FragmentCycleDoesNotHang() {
tests := []struct {
name string
query string
}{
{
name: "self-referential fragment",
query: "query Q { ...A } fragment A on Query { ...A }",
},
{
name: "mutually recursive fragments A -> B -> A",
query: "query Q { ...A } fragment A on Query { ...B } fragment B on Query { ...A }",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
cfg.Security.BlockIntrospection = true
cfg.Security.IntrospectionAllowed = nil
introspectionAllowedQueries = make(map[string]struct{})
body := map[string]any{"query": tt.query}
bodyBytes, _ := json.Marshal(body)
ctx := fiber.New().AcquireCtx(&fasthttp.RequestCtx{})
ctx.Request().SetBody(bodyBytes)
done := make(chan struct{})
go func() {
parseGraphQLQuery(ctx)
close(done)
}()
select {
case <-done:
// Neither cycle ever reaches an introspection field, so the
// request must complete and must not be blocked.
suite.Equal(200, ctx.Response().StatusCode())
case <-time.After(2 * time.Second):
suite.FailNow("checkSelections did not return promptly for a cyclic fragment spread")
}
})
}
}
// Test_DeepAcyclicFragmentChainDetectsIntrospection verifies the visited-set fix
// for fragment cycles does not break detection of introspection buried at the
// end of a long, legitimate (acyclic) chain of distinct named fragments.
func (suite *Tests) Test_DeepAcyclicFragmentChainDetectsIntrospection() {
const chainLength = 50
var b strings.Builder
b.WriteString("query Q { ...F0 }")
for i := 0; i < chainLength; i++ {
fmt.Fprintf(&b, " fragment F%d on Query { ", i)
if i == chainLength-1 {
b.WriteString("__schema { queryType { name } }")
} else {
fmt.Fprintf(&b, "...F%d", i+1)
}
b.WriteString(" }")
}
cfg.Security.BlockIntrospection = true
cfg.Security.IntrospectionAllowed = nil
introspectionAllowedQueries = make(map[string]struct{})
body := map[string]any{"query": b.String()}
bodyBytes, _ := json.Marshal(body)
ctx := fiber.New().AcquireCtx(&fasthttp.RequestCtx{})
ctx.Request().SetBody(bodyBytes)
parseGraphQLQuery(ctx)
suite.Equal(403, ctx.Response().StatusCode(), "introspection at the end of a 50-fragment acyclic chain must still be detected")
}
func TestIntrospectionQueryHandling(t *testing.T) {
tests := []struct {
name string
query string
allowedQueries []string
blockIntrospection bool
wantBlocked bool
}{
{
name: "allows __typename when in allowed list",
blockIntrospection: true,
allowedQueries: []string{"__typename"},
query: `{
users {
id
name
__typename
}
}`,
wantBlocked: false,
},
{
name: "case insensitive matching for allowed queries",
blockIntrospection: true,
allowedQueries: []string{"__TYPENAME"},
query: `{
users {
__typename
}
}`,
wantBlocked: false,
},
{
name: "blocks other introspection queries",
blockIntrospection: true,
allowedQueries: []string{"__typename"},
query: `{
__schema {
types {
name
}
}
}`,
wantBlocked: true,
},
{
name: "allows multiple __typename occurrences",
blockIntrospection: true,
allowedQueries: []string{"__typename"},
query: `{
users {
__typename
posts {
__typename
}
}
}`,
wantBlocked: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Setup config
cfg = &config{
Security: struct {
IntrospectionAllowed []string
BlockIntrospection bool
}{
IntrospectionAllowed: tt.allowedQueries,
BlockIntrospection: tt.blockIntrospection,
},
}
// Initialize allowed queries
prepareQueriesAndExemptions()
// Parse query
p, err := parser.Parse(parser.ParseParams{Source: tt.query})
if err != nil {
t.Fatalf("failed to parse query: %v", err)
}
// Create mock fiber context
app := fiber.New()
ctx := app.AcquireCtx(&fasthttp.RequestCtx{})
defer app.ReleaseCtx(ctx)
// Check selections
var blocked bool
fragments := make(map[string]*ast.FragmentDefinition)
for _, def := range p.Definitions {
if fd, ok := def.(*ast.FragmentDefinition); ok && fd.Name != nil {
fragments[fd.Name.Value] = fd
}
}
for _, def := range p.Definitions {
if op, ok := def.(*ast.OperationDefinition); ok {
blocked = checkSelections(ctx, op.GetSelectionSet().Selections, fragments, make(map[string]bool))
break
}
}
if blocked != tt.wantBlocked {
t.Errorf("checkSelections() blocked = %v, want %v", blocked, tt.wantBlocked)
assert.Equal(tt.wantResults.returnCode, ctx.Response().StatusCode(), "Unexpected return code", tt.name)
}
})
}
-345
View File
@@ -1,345 +0,0 @@
package main
import (
"bytes"
"compress/gzip"
"fmt"
"net/http"
"net/http/httptest"
"time"
"github.com/gofiber/fiber/v3"
"github.com/valyala/fasthttp"
)
// Tests for error handling in gzip decompression and general error propagation
// TestGzipHandling tests proper handling of gzipped responses
func (suite *Tests) TestGzipHandling() {
// Create a test server that returns gzipped content
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Set the Content-Encoding header to indicate gzipped content
w.Header().Set("Content-Encoding", "gzip")
// Create a gzipped response
var buf bytes.Buffer
gzipWriter := gzip.NewWriter(&buf)
payload := `{"data":{"test":"gzipped response"}}`
_, _ = gzipWriter.Write([]byte(payload))
_ = gzipWriter.Close()
// Send the gzipped data
w.WriteHeader(http.StatusOK)
_, _ = w.Write(buf.Bytes())
}))
defer server.Close()
// Store original client and restore after test
originalClient := cfg.Client.FastProxyClient
defer func() {
cfg.Client.FastProxyClient = originalClient
}()
// Configure client for test
cfg.Client.ClientTimeout = 5
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
// Configure server URL
cfg.Server.HostGraphQL = server.URL
// Create request context
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.SetBody([]byte(`{"query": "query { test }"}`))
// Create fiber context
ctx := suite.app.AcquireCtx(reqCtx)
defer suite.app.ReleaseCtx(ctx)
// Call the proxy function
err := proxyTheRequest(ctx, cfg.Server.HostGraphQL)
// Verify success
suite.Nil(err, "proxyTheRequest should succeed with gzipped content")
suite.Equal(fiber.StatusOK, ctx.Response().StatusCode(), "Response status should be 200 OK")
// Verify the content was properly decompressed
responseBody := string(ctx.Response().Body())
suite.Contains(responseBody, "gzipped response", "Response should contain the decompressed content")
// Verify the Content-Encoding header was removed
suite.Equal("", string(ctx.Response().Header.Peek("Content-Encoding")),
"Content-Encoding header should be removed after decompression")
}
// TestInvalidGzipHandling tests handling of responses with invalid gzip data
func (suite *Tests) TestInvalidGzipHandling() {
// Create a test server that returns invalid gzipped content
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Set the Content-Encoding header to indicate gzipped content
w.Header().Set("Content-Encoding", "gzip")
// Send invalid gzip data
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte("This is not valid gzip data"))
}))
defer server.Close()
// Store original client and restore after test
originalClient := cfg.Client.FastProxyClient
defer func() {
cfg.Client.FastProxyClient = originalClient
}()
// Configure client for test
cfg.Client.ClientTimeout = 5
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
// Configure server URL
cfg.Server.HostGraphQL = server.URL
// Create request context
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.SetBody([]byte(`{"query": "query { test }"}`))
// Create fiber context
ctx := suite.app.AcquireCtx(reqCtx)
defer suite.app.ReleaseCtx(ctx)
// Call the proxy function
err := proxyTheRequest(ctx, cfg.Server.HostGraphQL)
// Verify error handling
suite.NotNil(err, "proxyTheRequest should return error with invalid gzip data")
suite.Contains(err.Error(), "gzip", "Error should mention gzip decompression issue")
}
// TestErrorPropagation tests that various errors are properly propagated
func (suite *Tests) TestErrorPropagation() {
tests := []struct {
name string
serverHandler func(w http.ResponseWriter, r *http.Request)
expectedError string
}{
{
name: "5xx_error",
serverHandler: func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
_, _ = w.Write([]byte(`{"errors":[{"message":"Internal server error"}]}`))
},
expectedError: "received non-200 response",
},
{
name: "malformed_json_response",
serverHandler: func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{malformed json`))
},
expectedError: "", // No error expected, as we don't validate JSON format
},
{
name: "empty_response",
serverHandler: func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
// Empty response body
},
expectedError: "", // No error expected, empty responses are valid
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
// Create a test server with the current test handler
server := httptest.NewServer(http.HandlerFunc(tt.serverHandler))
defer server.Close()
// Store original client and restore after test
originalClient := cfg.Client.FastProxyClient
defer func() {
cfg.Client.FastProxyClient = originalClient
}()
// Configure client for test
cfg.Client.ClientTimeout = 5
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
// Configure server URL
cfg.Server.HostGraphQL = server.URL
// Create request context
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.SetBody([]byte(`{"query": "query { test }"}`))
// Create fiber context
ctx := suite.app.AcquireCtx(reqCtx)
defer suite.app.ReleaseCtx(ctx)
// Call the proxy function
err := proxyTheRequest(ctx, cfg.Server.HostGraphQL)
// Verify error handling based on test case
if tt.expectedError != "" {
suite.NotNil(err, "proxyTheRequest should return error")
suite.Contains(err.Error(), tt.expectedError,
"Error should contain expected message")
} else {
suite.Nil(err, "proxyTheRequest should not return error")
}
})
}
}
// TestMiddlewareErrorPropagation tests error propagation through the middleware chain
func (suite *Tests) TestMiddlewareErrorPropagation() {
// Setup a basic middleware chain that mimics the production setup
testMiddleware := func(c fiber.Ctx) error {
// Access request path to check proper error propagation
path := c.Path()
if path == "/error-path" {
return fmt.Errorf("middleware error")
}
return c.Next()
}
app := fiber.New()
app.Use(testMiddleware)
// Setup the handler that would receive the request after middleware
app.Post("/graphql", func(c fiber.Ctx) error {
// This should not be called if middleware returns error
return c.Status(fiber.StatusOK).JSON(fiber.Map{"data": "success"})
})
// Test successful path
req := httptest.NewRequest("POST", "/graphql", nil)
resp, err := app.Test(req)
suite.Nil(err, "App test should not error")
suite.Equal(fiber.StatusOK, resp.StatusCode, "Status should be 200 OK")
// Test error path
req = httptest.NewRequest("POST", "/error-path", nil)
resp, err = app.Test(req)
suite.Nil(err, "App test should not error")
suite.NotEqual(fiber.StatusOK, resp.StatusCode, "Status should not be 200 OK")
// Check that error status was properly propagated
suite.Equal(fiber.StatusInternalServerError, resp.StatusCode,
"Error status should be 500 Internal Server Error")
}
// TestTimeout tests the proper handling of timeouts
func (suite *Tests) TestTimeout() {
// Skip this timing-sensitive test as it's prone to race conditions under race detection
suite.T().Skip("Skipping timing-sensitive timeout test due to race conditions under race detection")
// Create a test server that simulates a timeout
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Sleep longer than the client timeout
time.Sleep(3 * time.Second)
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(`{"data":{"test":"response"}}`))
}))
defer server.Close()
// Store original client and restore after test
originalClient := cfg.Client.FastProxyClient
originalTimeout := cfg.Client.ClientTimeout
defer func() {
cfg.Client.FastProxyClient = originalClient
cfg.Client.ClientTimeout = originalTimeout
}()
// Configure client with a short timeout
cfg.Client.ClientTimeout = 1 // 1 second
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
// Configure server URL
cfg.Server.HostGraphQL = server.URL
// Create request context
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.SetBody([]byte(`{"query": "query { test }"}`))
// Create fiber context
ctx := suite.app.AcquireCtx(reqCtx)
defer suite.app.ReleaseCtx(ctx)
// Call the proxy function
err := proxyTheRequest(ctx, cfg.Server.HostGraphQL)
// Verify timeout error handling
suite.NotNil(err, "proxyTheRequest should return error on timeout")
if err != nil {
suite.Contains(err.Error(), "timeout", "Error should mention timeout")
}
}
// TestLargeResponseHandling tests handling of large responses
func (suite *Tests) TestLargeResponseHandling() {
// Create a test server that returns a large response
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Generate a large response (1MB)
largeResponse := make([]byte, 1024*1024)
for i := 0; i < len(largeResponse); i++ {
largeResponse[i] = byte(i % 256)
}
// Set headers and send response
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
_, _ = w.Write(largeResponse)
}))
defer server.Close()
// Store original client and restore after test
originalClient := cfg.Client.FastProxyClient
defer func() {
cfg.Client.FastProxyClient = originalClient
}()
// Configure client for test
cfg.Client.ClientTimeout = 10 // Longer timeout for large response
cfg.Client.FastProxyClient = createFasthttpClient(cfg)
// Configure server URL
cfg.Server.HostGraphQL = server.URL
// Create request context
reqCtx := &fasthttp.RequestCtx{}
reqCtx.Request.SetRequestURI("/graphql")
reqCtx.Request.Header.SetMethod("POST")
reqCtx.Request.Header.Set("Content-Type", "application/json")
reqCtx.Request.SetBody([]byte(`{"query": "query { test }"}`))
// Create fiber context
ctx := suite.app.AcquireCtx(reqCtx)
defer suite.app.ReleaseCtx(ctx)
// Call the proxy function
err := proxyTheRequest(ctx, cfg.Server.HostGraphQL)
// Verify large response handling
suite.Nil(err, "proxyTheRequest should handle large responses")
suite.Equal(fiber.StatusOK, ctx.Response().StatusCode(), "Status should be 200 OK")
suite.Equal(1024*1024, len(ctx.Response().Body()), "Response body should match expected size")
}
// Helper function to create gzipped data
func createGzippedData(data []byte) []byte {
var buf bytes.Buffer
gw := gzip.NewWriter(&buf)
_, _ = gw.Write(data)
_ = gw.Close()
return buf.Bytes()
}
-670
View File
@@ -1,670 +0,0 @@
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
"os"
"path/filepath"
"strings"
"sync"
"testing"
"time"
"github.com/gofiber/fiber/v3"
libpack_cache "github.com/lukaszraczylo/graphql-monitoring-proxy/cache"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/suite"
)
type IntegrationSecurityTestSuite struct {
suite.Suite
proxyApp *fiber.App
apiApp *fiber.App
logger *libpack_logger.Logger
tempDir string
validAPIKey string
}
func TestIntegrationSecurityTestSuite(t *testing.T) {
suite.Run(t, new(IntegrationSecurityTestSuite))
}
func (suite *IntegrationSecurityTestSuite) SetupTest() {
// Create temporary directory for test files
var err error
suite.tempDir, err = os.MkdirTemp("", "security_integration_test")
suite.NoError(err)
// Setup configuration
cfg = &config{}
cfg.Logger = libpack_logger.New()
suite.logger = cfg.Logger
// Configure security settings
suite.validAPIKey = "integration-test-api-key-secure-12345"
os.Setenv("GMP_ADMIN_API_KEY", suite.validAPIKey)
// Setup cache for testing
cacheConfig := &libpack_cache.CacheConfig{
Logger: cfg.Logger,
TTL: 60,
}
cacheConfig.Memory.MaxMemorySize = 10 * 1024 * 1024 // 10MB
cacheConfig.Memory.MaxEntries = 1000
libpack_cache.EnableCache(cacheConfig)
// Setup banned users file in temp directory
cfg.Api.BannedUsersFile = filepath.Join(suite.tempDir, "banned_users.json")
// Create test apps
suite.setupTestApps()
}
func (suite *IntegrationSecurityTestSuite) TearDownTest() {
// Clean up environment
os.Unsetenv("GMP_ADMIN_API_KEY")
os.Unsetenv("ADMIN_API_KEY")
// Clean up temporary directory
os.RemoveAll(suite.tempDir)
}
// tempDirShouldBeAllowed checks if the temp directory is in an allowed location
func (suite *IntegrationSecurityTestSuite) tempDirShouldBeAllowed() bool {
absPath, err := filepath.Abs(suite.tempDir)
if err != nil {
return false
}
// Check if temp directory is in allowed locations
allowedPrefixes := []string{"/tmp/", "/var/tmp/"}
for _, prefix := range allowedPrefixes {
if strings.HasPrefix(absPath, prefix) {
return true
}
}
// Check if it's in the working directory
workDir, err := os.Getwd()
if err != nil {
return false
}
cleanedWorkDir := filepath.Clean(workDir)
return strings.HasPrefix(absPath, cleanedWorkDir+string(filepath.Separator))
}
func (suite *IntegrationSecurityTestSuite) setupTestApps() {
// Setup proxy app (simplified for testing)
suite.proxyApp = fiber.New(fiber.Config{})
// Add proxy routes with security middleware
suite.proxyApp.Use(func(c fiber.Ctx) error {
// Add request UUID for tracking
c.Locals("request_uuid", fmt.Sprintf("test-uuid-%d", time.Now().UnixNano()))
return c.Next()
})
suite.proxyApp.Post("/graphql", func(c fiber.Ctx) error {
// Simulate GraphQL proxy behavior with logging
if cfg.LogLevel == "DEBUG" {
logDebugRequest(c)
}
// Mock GraphQL response
response := map[string]any{
"data": map[string]any{
"user": map[string]any{
"id": "12345",
"name": "Test User",
"email": "[email protected]",
},
},
}
c.Set("Content-Type", "application/json")
if cfg.LogLevel == "DEBUG" {
logDebugResponse(c)
}
return c.JSON(response)
})
// Setup API app
suite.apiApp = fiber.New(fiber.Config{})
api := suite.apiApp.Group("/api")
api.Use(authMiddleware)
api.Post("/user-ban", apiBanUser)
api.Post("/user-unban", apiUnbanUser)
api.Post("/cache-clear", apiClearCache)
api.Get("/cache-stats", apiCacheStats)
}
// TestEndToEndSecurity tests complete request flow with security checks
func (suite *IntegrationSecurityTestSuite) TestEndToEndSecurity() {
suite.Run("GraphQL request with sensitive data logging", func() {
// Set debug mode to test logging sanitization
originalLogLevel := cfg.LogLevel
cfg.LogLevel = "DEBUG"
defer func() { cfg.LogLevel = originalLogLevel }()
// Create GraphQL request with sensitive data
graphqlQuery := map[string]any{
"query": `
mutation LoginUser($input: LoginInput!) {
login(input: $input) {
user { id name }
token
}
}
`,
"variables": map[string]any{
"input": map[string]any{
"email": "[email protected]",
"password": "secret123password",
"api_key": "sk-sensitive-key-123",
},
},
}
requestBody, err := json.Marshal(graphqlQuery)
suite.NoError(err)
req, err := http.NewRequest("POST", "/graphql", bytes.NewBuffer(requestBody))
suite.NoError(err)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer sensitive-token-123")
resp, err := suite.proxyApp.Test(req)
suite.NoError(err)
suite.Equal(200, resp.StatusCode)
// Verify response doesn't contain sensitive data in logs
// This would be verified through log capture in a real implementation
})
}
// TestAPISecurityFlow tests complete API security workflow
func (suite *IntegrationSecurityTestSuite) TestAPISecurityFlow() {
tests := []struct {
body map[string]any
name string
endpoint string
method string
apiKey string
description string
expectedStatus int
}{
{
name: "Unauthorized ban attempt",
endpoint: "/api/user-ban",
method: "POST",
apiKey: "",
body: map[string]any{"user_id": "malicious-user", "reason": "test ban"},
expectedStatus: 401,
description: "Should reject unauthorized ban attempts",
},
{
name: "SQL injection in API key",
endpoint: "/api/user-ban",
method: "POST",
apiKey: "' OR '1'='1 --",
body: map[string]any{"user_id": "test-user", "reason": "test ban"},
expectedStatus: 401,
description: "Should reject SQL injection in API key",
},
{
name: "Valid ban request",
endpoint: "/api/user-ban",
method: "POST",
apiKey: suite.validAPIKey,
body: map[string]any{"user_id": "test-user-ban", "reason": "test ban reason"},
expectedStatus: 200,
description: "Should accept valid ban request",
},
{
name: "Cache clear without auth",
endpoint: "/api/cache-clear",
method: "POST",
apiKey: "",
body: nil,
expectedStatus: 401,
description: "Should reject unauthorized cache clear",
},
{
name: "Valid cache clear",
endpoint: "/api/cache-clear",
method: "POST",
apiKey: suite.validAPIKey,
body: nil,
expectedStatus: 200,
description: "Should accept authorized cache clear",
},
{
name: "Cache stats without auth",
endpoint: "/api/cache-stats",
method: "GET",
apiKey: "",
body: nil,
expectedStatus: 401,
description: "Should reject unauthorized cache stats",
},
{
name: "Valid cache stats",
endpoint: "/api/cache-stats",
method: "GET",
apiKey: suite.validAPIKey,
body: nil,
expectedStatus: 200,
description: "Should accept authorized cache stats",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
var req *http.Request
var err error
if tt.body != nil {
bodyBytes, _ := json.Marshal(tt.body)
req, err = http.NewRequest(tt.method, tt.endpoint, bytes.NewBuffer(bodyBytes))
suite.NoError(err)
req.Header.Set("Content-Type", "application/json")
} else {
req, err = http.NewRequest(tt.method, tt.endpoint, nil)
suite.NoError(err)
}
if tt.apiKey != "" {
req.Header.Set("X-API-Key", tt.apiKey)
}
resp, err := suite.apiApp.Test(req)
suite.NoError(err)
suite.Equal(tt.expectedStatus, resp.StatusCode,
"Status mismatch for %s: %s", tt.name, tt.description)
})
}
}
// TestFilePathSecurityIntegration tests path traversal prevention in real scenarios
func (suite *IntegrationSecurityTestSuite) TestFilePathSecurityIntegration() {
tests := []struct {
name string
requestedPath string
description string
shouldBeAllowed bool
}{
{
name: "Valid temp file",
requestedPath: filepath.Join(suite.tempDir, "valid_file.json"),
shouldBeAllowed: suite.tempDirShouldBeAllowed(), // Check if tempDir is in allowed paths
description: "Temp directory handling based on system temp location",
},
{
name: "Path traversal attempt",
requestedPath: "../../../../etc/passwd",
shouldBeAllowed: false,
description: "Path traversal should be blocked",
},
{
name: "Null byte injection",
requestedPath: "/tmp/file.txt\x00.jpg",
shouldBeAllowed: false,
description: "Null byte injection should be blocked",
},
{
name: "Current directory access",
requestedPath: "./config.json",
shouldBeAllowed: true,
description: "Current directory should be allowed",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
_, err := validateFilePath(tt.requestedPath)
if tt.shouldBeAllowed {
suite.NoError(err, "Path should be allowed: %s", tt.description)
} else {
suite.Error(err, "Path should be rejected: %s", tt.description)
}
})
}
}
// TestConcurrentSecurityOperations tests security under concurrent load
func (suite *IntegrationSecurityTestSuite) TestConcurrentSecurityOperations() {
const numGoroutines = 20
const numRequestsPerGoroutine = 10
suite.Run("Concurrent API authentication", func() {
var wg sync.WaitGroup
results := make(chan int, numGoroutines*numRequestsPerGoroutine)
// Mix of valid and invalid API keys
apiKeys := []string{
suite.validAPIKey, // Valid
"invalid-key-1", // Invalid
"invalid-key-2", // Invalid
"' OR '1'='1", // SQL injection attempt
suite.validAPIKey, // Valid
"", // Empty
}
for i := 0; i < numGoroutines; i++ {
wg.Add(1)
go func(goroutineID int) {
defer wg.Done()
for j := 0; j < numRequestsPerGoroutine; j++ {
keyIndex := (goroutineID + j) % len(apiKeys)
apiKey := apiKeys[keyIndex]
req, err := http.NewRequest("GET", "/api/cache-stats", nil)
if err != nil {
results <- 500
continue
}
if apiKey != "" {
req.Header.Set("X-API-Key", apiKey)
}
resp, err := suite.apiApp.Test(req)
if err != nil {
results <- 500
continue
}
results <- resp.StatusCode
}
}(i)
}
wg.Wait()
close(results)
// Analyze results
statusCounts := make(map[int]int)
totalRequests := 0
for status := range results {
statusCounts[status]++
totalRequests++
}
suite.Equal(numGoroutines*numRequestsPerGoroutine, totalRequests,
"Should process all requests")
suite.Greater(statusCounts[200], 0, "Should have some successful requests")
suite.Greater(statusCounts[401], 0, "Should have some rejected requests")
suite.Equal(0, statusCounts[500], "Should not have server errors")
})
}
// TestSecurityEventLogging tests that security events are properly logged
func (suite *IntegrationSecurityTestSuite) TestSecurityEventLogging() {
// This would require log capture mechanism in a real implementation
suite.Run("Security event logging", func() {
// Test unauthorized access logging
req, err := http.NewRequest("POST", "/api/user-ban", bytes.NewBuffer([]byte(`{"user_id": "test", "reason": "test ban"}`)))
suite.NoError(err)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "invalid-key")
resp, err := suite.apiApp.Test(req)
suite.NoError(err)
suite.Equal(401, resp.StatusCode)
// In a real implementation, we would verify that:
// 1. Unauthorized access attempt was logged
// 2. No sensitive data was included in logs
// 3. Appropriate log level was used
})
}
// TestRateLimitingIntegration tests rate limiting under security scenarios
func (suite *IntegrationSecurityTestSuite) TestRateLimitingIntegration() {
// This would test rate limiting if implemented
suite.Run("Rate limiting for security", func() {
// Rapid unauthorized requests
const numRequests = 100
unauthorizedCount := 0
for i := 0; i < numRequests; i++ {
req, err := http.NewRequest("POST", "/api/user-ban",
bytes.NewBuffer([]byte(`{"user_id": "test", "reason": "test ban"}`)))
suite.NoError(err)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "invalid-key")
resp, err := suite.apiApp.Test(req)
suite.NoError(err)
if resp.StatusCode == 401 {
unauthorizedCount++
}
}
// All should be unauthorized (no rate limiting implemented yet)
suite.Equal(numRequests, unauthorizedCount,
"All unauthorized requests should be rejected")
})
}
// TestSecurityHeadersIntegration tests security-related headers
func (suite *IntegrationSecurityTestSuite) TestSecurityHeadersIntegration() {
suite.Run("Security headers in responses", func() {
req, err := http.NewRequest("GET", "/api/cache-stats", nil)
suite.NoError(err)
req.Header.Set("X-API-Key", suite.validAPIKey)
resp, err := suite.apiApp.Test(req)
suite.NoError(err)
suite.Equal(200, resp.StatusCode)
// Check for security headers (if implemented)
// In a production system, you'd want headers like:
// - X-Content-Type-Options: nosniff
// - X-Frame-Options: DENY
// - X-XSS-Protection: 1; mode=block
})
}
// TestDataSanitizationIntegration tests end-to-end data sanitization
func (suite *IntegrationSecurityTestSuite) TestDataSanitizationIntegration() {
suite.Run("Request/Response sanitization", func() {
// Enable debug logging to test sanitization
originalLogLevel := cfg.LogLevel
cfg.LogLevel = "DEBUG"
defer func() { cfg.LogLevel = originalLogLevel }()
// Create request with sensitive data
sensitiveData := map[string]any{
"query": "{ user { id name } }",
"variables": map[string]any{
"password": "secret123",
"api_key": "sk-sensitive-123",
"credit_card": "4111111111111111",
},
}
bodyBytes, err := json.Marshal(sensitiveData)
suite.NoError(err)
req, err := http.NewRequest("POST", "/graphql", bytes.NewBuffer(bodyBytes))
suite.NoError(err)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer sensitive-token")
resp, err := suite.proxyApp.Test(req)
suite.NoError(err)
suite.Equal(200, resp.StatusCode)
// Verify response
body, err := io.ReadAll(resp.Body)
suite.NoError(err)
var response map[string]any
err = json.Unmarshal(body, &response)
suite.NoError(err)
suite.Contains(response, "data")
// In debug mode, logs would contain sanitized data (tested separately)
})
}
// TestErrorHandlingSecurityIntegration tests secure error handling
func (suite *IntegrationSecurityTestSuite) TestErrorHandlingSecurityIntegration() {
tests := []struct {
name string
endpoint string
method string
body string
description string
}{
{
name: "Malformed JSON",
endpoint: "/api/user-ban",
method: "POST",
body: `{"invalid": json}`,
description: "Should handle malformed JSON securely",
},
{
name: "Missing content type",
endpoint: "/api/user-ban",
method: "POST",
body: `{"user_id": "test", "reason": "test ban"}`,
description: "Should handle missing content type",
},
{
name: "Empty body",
endpoint: "/api/user-ban",
method: "POST",
body: "",
description: "Should handle empty body",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
req, err := http.NewRequest(tt.method, tt.endpoint, strings.NewReader(tt.body))
suite.NoError(err)
req.Header.Set("X-API-Key", suite.validAPIKey)
if tt.name != "Missing content type" {
req.Header.Set("Content-Type", "application/json")
}
resp, err := suite.apiApp.Test(req)
suite.NoError(err)
// Should not return 500 errors for client errors
suite.NotEqual(500, resp.StatusCode, "Should not return server error for client error")
// Error response should not contain sensitive information
if resp.StatusCode >= 400 {
body, err := io.ReadAll(resp.Body)
suite.NoError(err)
bodyStr := strings.ToLower(string(body))
suite.NotContains(bodyStr, "stack", "Error should not contain stack trace")
suite.NotContains(bodyStr, "panic", "Error should not contain panic details")
suite.NotContains(bodyStr, "internal", "Error should not leak internal details")
}
})
}
}
// TestComprehensiveSecurityScenario tests a complete security scenario
func (suite *IntegrationSecurityTestSuite) TestComprehensiveSecurityScenario() {
suite.Run("Complete security workflow", func() {
// 1. Attempt SQL injection via GraphQL
maliciousGraphQL := map[string]any{
"query": "{ user(id: \"'; DROP TABLE users; --\") { id } }",
}
bodyBytes, _ := json.Marshal(maliciousGraphQL)
req, _ := http.NewRequest("POST", "/graphql", bytes.NewBuffer(bodyBytes))
req.Header.Set("Content-Type", "application/json")
resp, err := suite.proxyApp.Test(req)
suite.NoError(err)
// Should not crash or return server error
suite.NotEqual(500, resp.StatusCode)
// 2. Attempt path traversal via API (if file operations were exposed)
maliciousPath := "../../../../etc/passwd"
_, err = validateFilePath(maliciousPath)
suite.Error(err, "Path traversal should be blocked")
// 3. Attempt unauthorized admin access
req, _ = http.NewRequest("POST", "/api/cache-clear", nil)
// No API key provided
resp, err = suite.apiApp.Test(req)
suite.NoError(err)
suite.Equal(401, resp.StatusCode, "Should reject unauthorized access")
// 4. Test with valid credentials
req, _ = http.NewRequest("GET", "/api/cache-stats", nil)
req.Header.Set("X-API-Key", suite.validAPIKey)
resp, err = suite.apiApp.Test(req)
suite.NoError(err)
suite.Equal(200, resp.StatusCode, "Should accept valid credentials")
// 5. Verify no sensitive data in logs (would need log capture)
// This would be tested in a real implementation with log capture
})
}
// BenchmarkSecurityOperations benchmarks security-related operations
func BenchmarkSecurityOperations(b *testing.B) {
// Setup
cfg = &config{}
cfg.Logger = libpack_logger.New()
validAPIKey := "benchmark-api-key"
os.Setenv("GMP_ADMIN_API_KEY", validAPIKey)
defer os.Unsetenv("GMP_ADMIN_API_KEY")
app := fiber.New()
api := app.Group("/api")
api.Use(authMiddleware)
api.Get("/test", func(c fiber.Ctx) error {
return c.JSON(fiber.Map{"status": "ok"})
})
b.ResetTimer()
b.Run("API Authentication", func(b *testing.B) {
for i := 0; i < b.N; i++ {
req, _ := http.NewRequest("GET", "/api/test", nil)
req.Header.Set("X-API-Key", validAPIKey)
app.Test(req)
}
})
b.Run("Path Validation", func(b *testing.B) {
for i := 0; i < b.N; i++ {
validateFilePath("./test/file.txt")
}
})
b.Run("Log Sanitization", func(b *testing.B) {
testData := map[string]any{
"password": "secret123",
"api_key": "sk-123456",
"data": "normal data",
}
jsonData, _ := json.Marshal(testData)
for i := 0; i < b.N; i++ {
sanitizeForLogging(jsonData, "application/json")
}
})
}
-1061
View File
File diff suppressed because it is too large Load Diff
-106
View File
@@ -1,106 +0,0 @@
package main
import (
"fmt"
"time"
"github.com/goccy/go-json"
)
// Test_IntervalConversion tests the conversion of various interval formats
func (suite *Tests) Test_IntervalConversion() {
// Test cases for string-based intervals
testCases := []struct {
name string
jsonString string
expectedDuration time.Duration
shouldError bool
}{
{
name: "second string",
jsonString: `{"interval": "second", "req": 100}`,
expectedDuration: time.Second,
shouldError: false,
},
{
name: "minute string",
jsonString: `{"interval": "minute", "req": 5}`,
expectedDuration: time.Minute,
shouldError: false,
},
{
name: "hour string",
jsonString: `{"interval": "hour", "req": 1000}`,
expectedDuration: time.Hour,
shouldError: false,
},
{
name: "day string",
jsonString: `{"interval": "day", "req": 10000}`,
expectedDuration: 24 * time.Hour,
shouldError: false,
},
{
name: "numeric value in seconds",
jsonString: `{"interval": 30, "req": 50}`,
expectedDuration: 30 * time.Second,
shouldError: false,
},
{
name: "go duration format",
jsonString: `{"interval": "5s", "req": 50}`,
expectedDuration: 5 * time.Second,
shouldError: false,
},
{
name: "invalid format",
jsonString: `{"interval": "invalid", "req": 100}`,
expectedDuration: 0,
shouldError: true,
},
}
// Run the tests
for _, tc := range testCases {
suite.Run(tc.name, func() {
var config RateLimitConfig
err := json.Unmarshal([]byte(tc.jsonString), &config)
if tc.shouldError {
suite.Error(err, "Expected error for invalid format")
} else {
suite.NoError(err, "Unexpected error during unmarshal")
suite.Equal(tc.expectedDuration, config.Interval,
fmt.Sprintf("Expected %v but got %v", tc.expectedDuration, config.Interval))
suite.NotNil(config.Interval, "Interval should not be nil")
}
})
}
}
// Test_LoadRatelimitConfigFile tests the actual loading of the configuration file
func (suite *Tests) Test_LoadRatelimitConfigFile() {
// Setup
cfg = &config{}
parseConfig()
err := loadRatelimitConfig()
suite.NoError(err, "Should load ratelimit config without error")
// Verify that rate limits were loaded
suite.NotEmpty(rateLimits, "Rate limits should not be empty")
// Check specific roles
suite.Contains(rateLimits, "admin", "Should contain admin role")
suite.Contains(rateLimits, "guest", "Should contain guest role")
suite.Contains(rateLimits, "-", "Should contain default role")
// Verify interval values
suite.Equal(time.Second, rateLimits["admin"].Interval, "Admin should have 1 second interval")
suite.Equal(time.Second, rateLimits["guest"].Interval, "Guest should have 1 second interval")
suite.Equal(time.Minute, rateLimits["-"].Interval, "Default role should have 1 minute interval")
// Verify request limits
suite.Equal(100, rateLimits["admin"].Req, "Admin should allow 100 req/second")
suite.Equal(3, rateLimits["guest"].Req, "Guest should allow 3 req/second")
suite.Equal(10, rateLimits["-"].Req, "Default role should allow 10 req/minute")
}
-276
View File
@@ -1,276 +0,0 @@
package main
import (
"crypto"
"errors"
"fmt"
"os"
"strings"
"time"
"github.com/MicahParks/keyfunc/v3"
"github.com/golang-jwt/jwt/v5"
)
// keyFamily identifies which class of signing algorithms a configured JWT
// key source belongs to. Verify's keyfunc (see JWTVerifier.keyfn) enforces
// that a token's algorithm belongs to the SAME family as the configured
// key, so an HMAC-signed token can never be checked against an asymmetric
// key and vice versa. This is what stops the alg-confusion attack fixed by
// GHSA-9gqw-h2rw-44wv (e.g. an attacker forging an HS256 token whose HMAC
// secret is the server's own RSA public key bytes).
type keyFamily int
const (
keyFamilyHMAC keyFamily = iota
keyFamilyAsymmetric
)
// hmacMethods and asymmetricMethods are the JWT "alg" header values
// belonging to each keyFamily. "none" is deliberately absent from both
// lists: WithValidMethods (see Verify) only accepts algorithms in one of
// these lists, so a token with alg=none is rejected before JWTVerifier's
// keyfunc is even called.
var (
hmacMethods = []string{"HS256", "HS384", "HS512"}
asymmetricMethods = []string{"RS256", "RS384", "RS512", "PS256", "PS384", "PS512", "ES256", "ES384", "ES512"}
)
// jwtVerifierConfig holds the resolved JWT_* environment settings
// newJWTVerifier needs to build a JWTVerifier. main.go's parseConfig reads
// the environment variables and populates this struct.
type jwtVerifierConfig struct {
// Secret is the HMAC shared secret (JWT_SECRET). Selects keyFamilyHMAC.
Secret string
// PublicKeyPEM is a PEM-encoded RSA or ECDSA public key (JWT_PUBLIC_KEY),
// either inline (contains "-----BEGIN") or a path to a file containing
// it. Selects keyFamilyAsymmetric.
PublicKeyPEM string
// JWKSURL is a JWKS endpoint (JWT_JWKS_URL) fetched and kept up to date
// by keyfunc. Selects keyFamilyAsymmetric.
JWKSURL string
// SigningMethods is an optional comma-separated allowlist
// (JWT_SIGNING_METHODS), e.g. "RS256,ES256". Empty means the full
// algorithm family for the configured key source is allowed.
SigningMethods string
// Issuer, when set, is required to match the token's "iss" claim.
Issuer string
// Audience, when set, is required to be present in the token's "aud" claim.
Audience string
// LeewaySeconds is the clock-skew tolerance applied to exp/nbf checks.
LeewaySeconds int
}
// JWTVerifier verifies the signature of a JWT bearer token against exactly
// one configured key source (an HMAC secret, a PEM public key, or a JWKS
// endpoint), pinned to that source's algorithm family. Build one with
// newJWTVerifier; a nil *JWTVerifier on config.Client (the default) means
// signature verification is off and callers must use the legacy unverified
// decode path (see details.go extractClaimsFromJWTHeader).
type JWTVerifier struct {
jwks keyfunc.Keyfunc
hmacSecret []byte
publicKey crypto.PublicKey
family keyFamily
allowedMethods []string
issuer string
audience string
leeway time.Duration
}
// newJWTVerifier builds a JWTVerifier from cfg. Exactly one of
// cfg.Secret, cfg.PublicKeyPEM, or cfg.JWKSURL must be set; any other count
// is a fatal configuration error, not a silent fallback, so the proxy never
// starts half-configured (GHSA-9gqw-h2rw-44wv requires verification to
// actually run once JWT_VERIFY_SIGNATURE is on).
func newJWTVerifier(cfg jwtVerifierConfig) (*JWTVerifier, error) {
sourcesConfigured := 0
if cfg.Secret != "" {
sourcesConfigured++
}
if cfg.PublicKeyPEM != "" {
sourcesConfigured++
}
if cfg.JWKSURL != "" {
sourcesConfigured++
}
if sourcesConfigured != 1 {
return nil, fmt.Errorf("JWT_VERIFY_SIGNATURE requires exactly one of JWT_SECRET, JWT_PUBLIC_KEY, JWT_JWKS_URL, got %d configured", sourcesConfigured)
}
v := &JWTVerifier{
issuer: cfg.Issuer,
audience: cfg.Audience,
leeway: time.Duration(cfg.LeewaySeconds) * time.Second,
}
switch {
case cfg.Secret != "":
v.family = keyFamilyHMAC
v.hmacSecret = []byte(cfg.Secret)
case cfg.PublicKeyPEM != "":
v.family = keyFamilyAsymmetric
pemBytes, err := resolvePEMSource(cfg.PublicKeyPEM)
if err != nil {
return nil, fmt.Errorf("failed to read JWT_PUBLIC_KEY: %w", err)
}
pubKey, err := parsePublicKeyPEM(pemBytes)
if err != nil {
return nil, fmt.Errorf("failed to parse JWT_PUBLIC_KEY: %w", err)
}
v.publicKey = pubKey
case cfg.JWKSURL != "":
v.family = keyFamilyAsymmetric
kf, err := keyfunc.NewDefault([]string{cfg.JWKSURL})
if err != nil {
return nil, fmt.Errorf("failed to initialise JWKS from JWT_JWKS_URL: %w", err)
}
v.jwks = kf
}
allowed, err := resolveAllowedMethods(v.family, cfg.SigningMethods)
if err != nil {
return nil, err
}
v.allowedMethods = allowed
return v, nil
}
// resolveAllowedMethods intersects the operator-configured
// JWT_SIGNING_METHODS allowlist with the algorithm family of the
// configured key. An empty allowlist means "allow the whole family". A
// configured method outside the key's family (e.g. JWT_SECRET set together
// with JWT_SIGNING_METHODS=RS256) is a fatal configuration error: it can
// never be satisfied, since JWTVerifier.keyfn refuses to return an HMAC
// secret for an asymmetric alg or vice versa.
func resolveAllowedMethods(family keyFamily, signingMethods string) ([]string, error) {
familyMethods := hmacMethods
if family == keyFamilyAsymmetric {
familyMethods = asymmetricMethods
}
if strings.TrimSpace(signingMethods) == "" {
return familyMethods, nil
}
allowedInFamily := make(map[string]bool, len(familyMethods))
for _, m := range familyMethods {
allowedInFamily[m] = true
}
configured := strings.Split(signingMethods, ",")
allowed := make([]string, 0, len(configured))
for _, m := range configured {
m = strings.TrimSpace(m)
if m == "" {
continue
}
if !allowedInFamily[m] {
return nil, fmt.Errorf("JWT_SIGNING_METHODS %q is not part of the configured key's algorithm family", m)
}
allowed = append(allowed, m)
}
if len(allowed) == 0 {
return nil, errors.New("JWT_SIGNING_METHODS resolved to no valid algorithms for the configured key")
}
return allowed, nil
}
// resolvePEMSource returns the PEM bytes for JWT_PUBLIC_KEY. The value is
// used inline when it already contains a PEM header, otherwise it is
// treated as a path and read from disk.
func resolvePEMSource(value string) ([]byte, error) {
if strings.Contains(value, "-----BEGIN") {
return []byte(value), nil
}
data, err := os.ReadFile(value)
if err != nil {
return nil, fmt.Errorf("reading PEM file %q: %w", value, err)
}
return data, nil
}
// parsePublicKeyPEM parses pemBytes as either an RSA or an ECDSA public
// key, trying RSA first. It returns an error if neither parses.
func parsePublicKeyPEM(pemBytes []byte) (crypto.PublicKey, error) {
if rsaKey, err := jwt.ParseRSAPublicKeyFromPEM(pemBytes); err == nil {
return rsaKey, nil
}
if ecKey, err := jwt.ParseECPublicKeyFromPEM(pemBytes); err == nil {
return ecKey, nil
}
return nil, errors.New("PEM does not contain a valid RSA or ECDSA public key")
}
// Verify checks the signature, algorithm family, and standard claims (exp,
// nbf, and the configured issuer/audience) of a bearer token taken from an
// Authorization header value. It returns the token's claims only when every
// check passes; on any failure it returns a non-nil error and the claims
// MUST NOT be used, so callers never trust a claim from a token that failed
// verification.
func (v *JWTVerifier) Verify(authorization string) (map[string]any, error) {
tokenString := stripBearerPrefix(authorization)
opts := []jwt.ParserOption{
jwt.WithValidMethods(v.allowedMethods),
jwt.WithLeeway(v.leeway),
}
if v.issuer != "" {
opts = append(opts, jwt.WithIssuer(v.issuer))
}
if v.audience != "" {
opts = append(opts, jwt.WithAudience(v.audience))
}
parser := jwt.NewParser(opts...)
claims := jwt.MapClaims{}
token, err := parser.ParseWithClaims(tokenString, claims, v.keyfn)
if err != nil {
return nil, fmt.Errorf("jwt verification failed: %w", err)
}
if !token.Valid {
return nil, errors.New("jwt verification failed: token is not valid")
}
return map[string]any(claims), nil
}
// stripBearerPrefix removes a case-insensitive "Bearer " prefix from an
// Authorization header value, if present.
func stripBearerPrefix(authorization string) string {
const prefix = "bearer "
if len(authorization) > len(prefix) && strings.EqualFold(authorization[:len(prefix)], prefix) {
return authorization[len(prefix):]
}
return authorization
}
// keyfn is the jwt.Keyfunc used by Verify to resolve the key for a parsed
// token. It is the enforcement point for algorithm-family pinning (the
// actual fix for GHSA-9gqw-h2rw-44wv): it identifies the concrete signing
// method type of the token and refuses to return a key at all unless that
// type belongs to v.family, so an HMAC secret is never handed back for an
// asymmetric token and a public key is never handed back for an HMAC
// token. Any other method, including SigningMethodNone, falls through to
// the default case and is rejected.
func (v *JWTVerifier) keyfn(token *jwt.Token) (any, error) {
switch token.Method.(type) {
case *jwt.SigningMethodHMAC:
if v.family != keyFamilyHMAC {
return nil, fmt.Errorf("unexpected alg %q for the configured key family", token.Method.Alg())
}
return v.hmacSecret, nil
case *jwt.SigningMethodRSA, *jwt.SigningMethodRSAPSS, *jwt.SigningMethodECDSA:
if v.family != keyFamilyAsymmetric {
return nil, fmt.Errorf("unexpected alg %q for the configured key family", token.Method.Alg())
}
if v.jwks != nil {
return v.jwks.Keyfunc(token)
}
return v.publicKey, nil
default:
return nil, fmt.Errorf("unexpected alg %q", token.Method.Alg())
}
}
-433
View File
@@ -1,433 +0,0 @@
package main
import (
"crypto/ecdsa"
"crypto/elliptic"
"crypto/rand"
"crypto/rsa"
"crypto/x509"
"encoding/pem"
"net/http/httptest"
"testing"
"time"
"github.com/gofiber/fiber/v3"
"github.com/golang-jwt/jwt/v5"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
)
// ---------------------------------------------------------------------------
// Test helpers: in-test key generation and token signing.
// ---------------------------------------------------------------------------
// generateRSAKeyPair generates an RSA key pair and PEM-encodes the public
// key (PKIX, matching what jwt.ParseRSAPublicKeyFromPEM expects).
func generateRSAKeyPair(t *testing.T) (*rsa.PrivateKey, []byte) {
t.Helper()
priv, err := rsa.GenerateKey(rand.Reader, 2048)
if err != nil {
t.Fatalf("failed to generate RSA key: %v", err)
}
pubBytes, err := x509.MarshalPKIXPublicKey(&priv.PublicKey)
if err != nil {
t.Fatalf("failed to marshal RSA public key: %v", err)
}
return priv, pem.EncodeToMemory(&pem.Block{Type: "PUBLIC KEY", Bytes: pubBytes})
}
// generateECKeyPair generates an ECDSA (P-256) key pair and PEM-encodes the
// public key (PKIX, matching what jwt.ParseECPublicKeyFromPEM expects).
func generateECKeyPair(t *testing.T) (*ecdsa.PrivateKey, []byte) {
t.Helper()
priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
if err != nil {
t.Fatalf("failed to generate EC key: %v", err)
}
pubBytes, err := x509.MarshalPKIXPublicKey(&priv.PublicKey)
if err != nil {
t.Fatalf("failed to marshal EC public key: %v", err)
}
return priv, pem.EncodeToMemory(&pem.Block{Type: "PUBLIC KEY", Bytes: pubBytes})
}
func signToken(t *testing.T, method jwt.SigningMethod, key any, claims jwt.MapClaims) string {
t.Helper()
signed, err := jwt.NewWithClaims(method, claims).SignedString(key)
if err != nil {
t.Fatalf("failed to sign token with %s: %v", method.Alg(), err)
}
return signed
}
// ---------------------------------------------------------------------------
// Case 1 & 2: HS256 valid token verifies; wrong secret is rejected.
// ---------------------------------------------------------------------------
func TestJWTVerifier_HMAC(t *testing.T) {
const secret = "correct-horse-battery-staple"
token := signToken(t, jwt.SigningMethodHS256, []byte(secret), jwt.MapClaims{
"sub": "alice",
"exp": time.Now().Add(time.Hour).Unix(),
})
tests := []struct {
name string
secret string
wantErr bool
}{
{name: "valid HS256 token verifies and returns claims", secret: secret, wantErr: false},
{name: "wrong HMAC secret is rejected", secret: "totally-different-secret", wantErr: true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
v, err := newJWTVerifier(jwtVerifierConfig{Secret: tt.secret})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
claims, err := v.Verify(token)
if tt.wantErr {
if err == nil {
t.Fatal("Verify() expected an error, got nil")
}
return
}
if err != nil {
t.Fatalf("Verify() unexpected error: %v", err)
}
if claims["sub"] != "alice" {
t.Fatalf("Verify() sub claim = %v, want %q", claims["sub"], "alice")
}
})
}
}
// ---------------------------------------------------------------------------
// Case 3: alg=none is always rejected.
// ---------------------------------------------------------------------------
func TestJWTVerifier_AlgNoneRejected(t *testing.T) {
v, err := newJWTVerifier(jwtVerifierConfig{Secret: "some-secret"})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
// jwt.SigningMethodNone.Sign refuses to sign unless the caller passes the
// library's own unsafe sentinel key, which is exactly the point: this is
// the only way to construct a syntactically valid alg=none token at all.
noneToken := signToken(t, jwt.SigningMethodNone, jwt.UnsafeAllowNoneSignatureType, jwt.MapClaims{
"sub": "alice",
})
if _, err := v.Verify(noneToken); err == nil {
t.Fatal("Verify() accepted an alg=none token")
}
}
// ---------------------------------------------------------------------------
// Case 4: alg confusion. An RSA-configured verifier must reject an HS256
// token forged with the RSA public key's own PEM bytes as the HMAC secret.
// ---------------------------------------------------------------------------
func TestJWTVerifier_AlgConfusionRejected(t *testing.T) {
_, pubPEM := generateRSAKeyPair(t)
v, err := newJWTVerifier(jwtVerifierConfig{PublicKeyPEM: string(pubPEM)})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
forged := signToken(t, jwt.SigningMethodHS256, pubPEM, jwt.MapClaims{
"sub": "victim",
"exp": time.Now().Add(time.Hour).Unix(),
})
if _, err := v.Verify(forged); err == nil {
t.Fatal("Verify() accepted an HS256 token signed with the RSA public key bytes as the HMAC secret (alg confusion)")
}
}
// ---------------------------------------------------------------------------
// Case 5: expired token is rejected; sufficient leeway accepts the same
// token.
// ---------------------------------------------------------------------------
func TestJWTVerifier_ExpiryAndLeeway(t *testing.T) {
const secret = "leeway-secret"
token := signToken(t, jwt.SigningMethodHS256, []byte(secret), jwt.MapClaims{
"sub": "alice",
"exp": time.Now().Add(-30 * time.Second).Unix(),
})
t.Run("expired token without leeway is rejected", func(t *testing.T) {
v, err := newJWTVerifier(jwtVerifierConfig{Secret: secret})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
if _, err := v.Verify(token); err == nil {
t.Fatal("Verify() expected an error for an expired token, got nil")
}
})
t.Run("sufficient leeway accepts the same token", func(t *testing.T) {
v, err := newJWTVerifier(jwtVerifierConfig{Secret: secret, LeewaySeconds: 60})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
if _, err := v.Verify(token); err != nil {
t.Fatalf("Verify() unexpected error with sufficient leeway: %v", err)
}
})
}
// ---------------------------------------------------------------------------
// Case 6: issuer mismatch and audience mismatch are both rejected.
// ---------------------------------------------------------------------------
func TestJWTVerifier_IssuerAndAudienceMismatch(t *testing.T) {
const secret = "iss-aud-secret"
t.Run("issuer mismatch is rejected", func(t *testing.T) {
token := signToken(t, jwt.SigningMethodHS256, []byte(secret), jwt.MapClaims{
"sub": "alice",
"iss": "wrong-issuer",
"exp": time.Now().Add(time.Hour).Unix(),
})
v, err := newJWTVerifier(jwtVerifierConfig{Secret: secret, Issuer: "expected-issuer"})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
if _, err := v.Verify(token); err == nil {
t.Fatal("Verify() expected an issuer-mismatch error, got nil")
}
})
t.Run("audience mismatch is rejected", func(t *testing.T) {
token := signToken(t, jwt.SigningMethodHS256, []byte(secret), jwt.MapClaims{
"sub": "alice",
"aud": "wrong-audience",
"exp": time.Now().Add(time.Hour).Unix(),
})
v, err := newJWTVerifier(jwtVerifierConfig{Secret: secret, Audience: "expected-audience"})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
if _, err := v.Verify(token); err == nil {
t.Fatal("Verify() expected an audience-mismatch error, got nil")
}
})
}
// ---------------------------------------------------------------------------
// Supplementary: both asymmetric families (RSA and EC) round-trip
// correctly, and a token from one asymmetric algorithm is rejected by a
// verifier pinned to the other via JWT_SIGNING_METHODS.
// ---------------------------------------------------------------------------
func TestJWTVerifier_AsymmetricFamilies(t *testing.T) {
t.Run("RS256 valid token verifies against an RSA public key", func(t *testing.T) {
priv, pubPEM := generateRSAKeyPair(t)
token := signToken(t, jwt.SigningMethodRS256, priv, jwt.MapClaims{
"sub": "alice",
"exp": time.Now().Add(time.Hour).Unix(),
})
v, err := newJWTVerifier(jwtVerifierConfig{PublicKeyPEM: string(pubPEM)})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
claims, err := v.Verify(token)
if err != nil {
t.Fatalf("Verify() unexpected error: %v", err)
}
if claims["sub"] != "alice" {
t.Fatalf("Verify() sub claim = %v, want %q", claims["sub"], "alice")
}
})
t.Run("ES256 valid token verifies against an EC public key", func(t *testing.T) {
priv, pubPEM := generateECKeyPair(t)
token := signToken(t, jwt.SigningMethodES256, priv, jwt.MapClaims{
"sub": "alice",
"exp": time.Now().Add(time.Hour).Unix(),
})
v, err := newJWTVerifier(jwtVerifierConfig{PublicKeyPEM: string(pubPEM)})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
claims, err := v.Verify(token)
if err != nil {
t.Fatalf("Verify() unexpected error: %v", err)
}
if claims["sub"] != "alice" {
t.Fatalf("Verify() sub claim = %v, want %q", claims["sub"], "alice")
}
})
t.Run("ES256 token rejected by a verifier pinned to RS256 only", func(t *testing.T) {
ecPriv, _ := generateECKeyPair(t)
_, rsaPubPEM := generateRSAKeyPair(t)
token := signToken(t, jwt.SigningMethodES256, ecPriv, jwt.MapClaims{
"sub": "alice",
"exp": time.Now().Add(time.Hour).Unix(),
})
v, err := newJWTVerifier(jwtVerifierConfig{PublicKeyPEM: string(rsaPubPEM), SigningMethods: "RS256"})
if err != nil {
t.Fatalf("newJWTVerifier() error = %v", err)
}
if _, err := v.Verify(token); err == nil {
t.Fatal("Verify() accepted an ES256 token against a verifier pinned to RS256 only")
}
})
}
// ---------------------------------------------------------------------------
// Startup validation: newJWTVerifier must fail loudly on a bad key-source
// count or an unparsable key, never boot half-configured.
// ---------------------------------------------------------------------------
func TestNewJWTVerifier_StartupValidation(t *testing.T) {
_, rsaPubPEM := generateRSAKeyPair(t)
tests := []struct {
name string
cfg jwtVerifierConfig
wantErr bool
}{
{name: "zero key sources is a fatal error", cfg: jwtVerifierConfig{}, wantErr: true},
{
name: "two key sources is a fatal error",
cfg: jwtVerifierConfig{Secret: "s", PublicKeyPEM: string(rsaPubPEM)},
wantErr: true,
},
{name: "exactly one key source is valid", cfg: jwtVerifierConfig{Secret: "s"}, wantErr: false},
{
name: "signing method outside the key's family is a fatal error",
cfg: jwtVerifierConfig{Secret: "s", SigningMethods: "RS256"},
wantErr: true,
},
{
name: "unparsable PEM is a fatal error",
cfg: jwtVerifierConfig{PublicKeyPEM: "-----BEGIN PUBLIC KEY-----\nnot-a-real-key\n-----END PUBLIC KEY-----"},
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := newJWTVerifier(tt.cfg)
if (err != nil) != tt.wantErr {
t.Fatalf("newJWTVerifier() error = %v, wantErr = %v", err, tt.wantErr)
}
})
}
}
// ---------------------------------------------------------------------------
// Case 7: verification OFF (JWTVerifier nil) preserves the legacy,
// unverified decode path byte for byte -- required for a no-config-change
// upgrade to be default-preserving.
// ---------------------------------------------------------------------------
func TestExtractClaimsFromJWTHeader_VerifyOffBackwardCompat(t *testing.T) {
cfgMutex.Lock()
if cfg == nil {
cfg = &config{}
}
if cfg.Logger == nil {
cfg.Logger = libpack_logger.New()
}
origClient := cfg.Client
cfg.Client.JWTVerifier = nil
cfg.Client.JWTUserClaimPath = "sub"
cfg.Client.JWTRoleClaimPath = ""
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.Client = origClient
cfgMutex.Unlock()
})
// An unsigned, forged token. With verification off, extractClaimsFromJWTHeader
// must still decode it (today's behaviour) instead of erroring.
forged := signToken(t, jwt.SigningMethodNone, jwt.UnsafeAllowNoneSignatureType, jwt.MapClaims{
"sub": "mallory",
})
usr, _, err := extractClaimsFromJWTHeader(forged)
if err != nil {
t.Fatalf("extractClaimsFromJWTHeader() unexpected error with verification off: %v", err)
}
if usr != "mallory" {
t.Fatalf("extractClaimsFromJWTHeader() usr = %q, want %q (legacy decode must still work)", usr, "mallory")
}
}
// ---------------------------------------------------------------------------
// Case 8: verification ON, a forged token sharing a victim's "sub" claim but
// signed with the wrong secret must make extractUserInfo return a non-nil
// error -- never the victim's identity -- so the caller 401s the request
// instead of letting it read (or write) the victim's cache entry.
// ---------------------------------------------------------------------------
func TestExtractUserInfo_ForgedTokenNeverReachesVictimCacheKey(t *testing.T) {
const secret = "cache-isolation-secret"
cfgMutex.Lock()
if cfg == nil {
cfg = &config{}
}
if cfg.Logger == nil {
cfg.Logger = libpack_logger.New()
}
origClient := cfg.Client
verifier, err := newJWTVerifier(jwtVerifierConfig{Secret: secret})
if err != nil {
cfgMutex.Unlock()
t.Fatalf("newJWTVerifier() error = %v", err)
}
cfg.Client.JWTVerifier = verifier
cfg.Client.JWTUserClaimPath = "sub"
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg.Client = origClient
cfgMutex.Unlock()
})
// Same "sub" as a legitimate victim, but signed with the wrong secret.
// If extractUserInfo ever returned "victim" here, the forged request
// would land in the victim's own per-user cache bucket.
forged := signToken(t, jwt.SigningMethodHS256, []byte("wrong-secret"), jwt.MapClaims{
"sub": "victim",
})
app := fiber.New()
var capturedErr error
var capturedUserID, capturedRole string
app.Get("/", func(c fiber.Ctx) error {
capturedUserID, capturedRole, capturedErr = extractUserInfo(c)
return c.SendStatus(fiber.StatusOK)
})
req := httptest.NewRequest("GET", "/", nil)
req.Header.Set("Authorization", "Bearer "+forged)
resp, err := app.Test(req, fiber.TestConfig{Timeout: 0})
if err != nil {
t.Fatalf("app.Test: %v", err)
}
_ = resp.Body.Close()
if capturedErr == nil {
t.Fatal("extractUserInfo() expected a verification error for a forged token, got nil")
}
if capturedUserID != defaultValue || capturedRole != defaultValue {
t.Fatalf("extractUserInfo() on verify failure = (%q, %q), want (%q, %q) so a forged token never maps to the victim's cache bucket",
capturedUserID, capturedRole, defaultValue, defaultValue)
}
}
-262
View File
@@ -1,262 +0,0 @@
// Package libpack_logger provides structured JSON logging with configurable
// log levels, caller information, and automatic sensitive data redaction.
// Supports debug, info, warning, and error log levels.
package libpack_logger
import (
"bytes"
"fmt"
"io"
"os"
"path/filepath"
"runtime"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/goccy/go-json"
)
const (
LEVEL_DEBUG = iota
LEVEL_INFO
LEVEL_WARN
LEVEL_ERROR
LEVEL_FATAL
)
var levelNames = []string{
"debug",
"info",
"warn",
"error",
"fatal",
}
const (
defaultTimeFormat = time.RFC3339
defaultMinLevel = LEVEL_INFO
defaultShowCaller = false
)
// Logger represents the logging object with configurations.
//
// timeFormat, minLogLevel and showCaller are read on every log() call, so
// they are stored as atomics rather than behind mu: this keeps the hot log
// path lock-free for the scalar/string config while still being safe to
// mutate concurrently from SetTimeFormat/SetMinLogLevel/SetShowCaller. mu
// continues to protect only the output writer, which requires exclusive
// access while writing bytes.
type Logger struct {
output io.Writer
timeFormat atomic.Pointer[string]
minLogLevel atomic.Int32
showCaller atomic.Bool
mu sync.Mutex // Mutex to protect concurrent access to output
}
// LogMessage represents a log message with optional pairs.
type LogMessage struct {
Pairs map[string]any
Message string
}
// bufferPool is used to reuse bytes.Buffer for efficiency.
var bufferPool = sync.Pool{
New: func() any {
return new(bytes.Buffer)
},
}
// fieldNames allows customization of output field names.
//
// It is package-global by design: a single process-wide field-name mapping
// is applied consistently across every Logger instance (this is the
// behavior existing callers rely on, e.g. main.go configures field names on
// one Logger and expects that naming to apply process-wide). fieldNamesMu
// guards it so SetFieldName (writer) and log (reader) can run concurrently
// without a data race.
var fieldNames = map[string]string{
"timestamp": "timestamp",
"level": "level",
"message": "message",
}
// fieldNamesMu protects concurrent access to the package-global fieldNames map.
var fieldNamesMu sync.RWMutex
// osExit is a variable to allow mocking os.Exit in tests
var osExit = os.Exit
// exitMutex ensures thread-safe access to osExit
var exitMutex sync.RWMutex
// New creates a new Logger with default settings.
func New() *Logger {
l := &Logger{
output: os.Stdout,
}
format := defaultTimeFormat
l.timeFormat.Store(&format)
l.minLogLevel.Store(int32(defaultMinLevel))
l.showCaller.Store(defaultShowCaller)
return l
}
// SetOutput sets the output destination for the logger.
func (l *Logger) SetOutput(output io.Writer) *Logger {
l.mu.Lock()
l.output = output
l.mu.Unlock()
return l
}
// GetLogLevel returns the log level integer corresponding to the given level name.
func GetLogLevel(level string) int {
level = strings.ToLower(level)
for i, name := range levelNames {
if name == level {
return i
}
}
return defaultMinLevel
}
// SetTimeFormat sets the time format for the logger's timestamp field.
func (l *Logger) SetTimeFormat(format string) *Logger {
l.timeFormat.Store(&format)
return l
}
// SetMinLogLevel sets the minimum log level for the logger.
func (l *Logger) SetMinLogLevel(level int) *Logger {
l.minLogLevel.Store(int32(level))
return l
}
// SetFieldName allows customizing the field names in log output.
func (l *Logger) SetFieldName(field, name string) *Logger {
fieldNamesMu.Lock()
fieldNames[field] = name
fieldNamesMu.Unlock()
return l
}
// SetShowCaller enables or disables including the caller information in log output.
func (l *Logger) SetShowCaller(show bool) *Logger {
l.showCaller.Store(show)
return l
}
// shouldLog determines if the message should be logged based on the logger's minimum log level.
func (l *Logger) shouldLog(level int) bool {
return level >= int(l.minLogLevel.Load())
}
// IsLevelEnabled reports whether the given level would be emitted by this logger.
// Useful to gate expensive log-field construction (map/slice allocations) behind a
// cheap level check when the log call would otherwise be dropped.
func (l *Logger) IsLevelEnabled(level int) bool {
return level >= int(l.minLogLevel.Load())
}
// log writes the log message with the given level.
func (l *Logger) log(level int, m *LogMessage) {
if m.Pairs == nil {
m.Pairs = make(map[string]any)
}
fieldNamesMu.RLock()
timestampField := fieldNames["timestamp"]
levelField := fieldNames["level"]
messageField := fieldNames["message"]
fieldNamesMu.RUnlock()
m.Pairs[timestampField] = time.Now().Format(*l.timeFormat.Load())
m.Pairs[levelField] = levelNames[level]
m.Pairs[messageField] = m.Message
if l.showCaller.Load() {
m.Pairs["caller"] = getCaller()
}
buffer := bufferPool.Get().(*bytes.Buffer)
buffer.Reset()
defer bufferPool.Put(buffer)
encoder := json.NewEncoder(buffer)
err := encoder.Encode(m.Pairs)
if err != nil {
fmt.Fprintln(os.Stderr, "Error marshalling log message:", err)
return
}
// Lock the mutex before writing to the output to prevent race conditions
l.mu.Lock()
_, err = l.output.Write(buffer.Bytes())
l.mu.Unlock()
if err != nil {
fmt.Fprintln(os.Stderr, "Error writing log message:", err)
}
}
// Debug logs a debug-level message.
func (l *Logger) Debug(m *LogMessage) {
if l.shouldLog(LEVEL_DEBUG) {
l.log(LEVEL_DEBUG, m)
}
}
// Info logs an info-level message.
func (l *Logger) Info(m *LogMessage) {
if l.shouldLog(LEVEL_INFO) {
l.log(LEVEL_INFO, m)
}
}
// Warn logs a warning-level message.
func (l *Logger) Warn(m *LogMessage) {
if l.shouldLog(LEVEL_WARN) {
l.log(LEVEL_WARN, m)
}
}
// Warning is an alias for Warn.
func (l *Logger) Warning(m *LogMessage) {
l.Warn(m)
}
// Error logs an error-level message.
func (l *Logger) Error(m *LogMessage) {
if l.shouldLog(LEVEL_ERROR) {
l.log(LEVEL_ERROR, m)
}
}
// Fatal logs a fatal-level message.
func (l *Logger) Fatal(m *LogMessage) {
if l.shouldLog(LEVEL_FATAL) {
l.log(LEVEL_FATAL, m)
}
}
// Critical logs a critical-level message and exits the application.
func (l *Logger) Critical(m *LogMessage) {
l.Fatal(m)
exitMutex.RLock()
defer exitMutex.RUnlock()
osExit(1)
}
// getCaller retrieves the file and line number of the caller.
func getCaller() string {
// Skip 3 stack frames: getCaller -> log -> [Debug|Info|...]
const depth = 3
_, file, line, ok := runtime.Caller(depth)
if !ok {
return "unknown:0"
}
file = filepath.Base(file)
return fmt.Sprintf("%s:%d", file, line)
}
-178
View File
@@ -1,178 +0,0 @@
package libpack_logger
import (
"bytes"
"testing"
assertions "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
)
// LoggerAdditionalTestSuite extends testing for functions with low coverage
type LoggerAdditionalTestSuite struct {
suite.Suite
logger *Logger
output *bytes.Buffer
assert *assertions.Assertions
}
func (suite *LoggerAdditionalTestSuite) SetupTest() {
suite.output = &bytes.Buffer{}
suite.logger = New().SetOutput(suite.output).SetShowCaller(false)
suite.assert = assertions.New(suite.T())
}
func TestLoggerAdditionalTestSuite(t *testing.T) {
suite.Run(t, new(LoggerAdditionalTestSuite))
}
// Test GetLogLevel function
func (suite *LoggerAdditionalTestSuite) TestGetLogLevel() {
tests := []struct {
name string
level string
expected int
}{
{"debug level", "debug", LEVEL_DEBUG},
{"info level", "info", LEVEL_INFO},
{"warn level", "warn", LEVEL_WARN},
{"error level", "error", LEVEL_ERROR},
{"fatal level", "fatal", LEVEL_FATAL},
{"uppercase level", "DEBUG", LEVEL_DEBUG},
{"mixed case level", "WaRn", LEVEL_WARN},
{"invalid level", "invalid", defaultMinLevel},
{"empty level", "", defaultMinLevel},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
result := GetLogLevel(tt.level)
suite.assert.Equal(tt.expected, result)
})
}
}
// Test SetFieldName function
func (suite *LoggerAdditionalTestSuite) TestSetFieldName() {
// Save original field names
originalFieldNames := make(map[string]string)
for k, v := range fieldNames {
originalFieldNames[k] = v
}
// Restore original field names after test
defer func() {
for k, v := range originalFieldNames {
fieldNames[k] = v
}
}()
// Test with custom field names
customTimestampField := "time"
customLevelField := "severity"
customMessageField := "text"
suite.logger.SetFieldName("timestamp", customTimestampField)
suite.logger.SetFieldName("level", customLevelField)
suite.logger.SetFieldName("message", customMessageField)
// Verify field names were changed
suite.assert.Equal(customTimestampField, fieldNames["timestamp"])
suite.assert.Equal(customLevelField, fieldNames["level"])
suite.assert.Equal(customMessageField, fieldNames["message"])
// Test logging with custom field names
suite.output.Reset()
suite.logger.Info(&LogMessage{Message: "test custom fields"})
output := suite.output.String()
// Check if custom field names are used in the output
suite.assert.Contains(output, customTimestampField)
suite.assert.Contains(output, customLevelField)
suite.assert.Contains(output, customMessageField)
suite.assert.NotContains(output, "timestamp")
suite.assert.NotContains(output, "level")
suite.assert.NotContains(output, "message")
}
// Test SetShowCaller and getCaller functions
func (suite *LoggerAdditionalTestSuite) TestSetShowCaller() {
// Make sure caller info is disabled
suite.logger.SetShowCaller(false)
// Test with caller info disabled
suite.output.Reset()
suite.logger.Info(&LogMessage{Message: "test without cal__ler"})
output := suite.output.String()
suite.assert.NotContains(output, "caller")
// Test with caller info enabled
suite.output.Reset()
suite.logger.SetShowCaller(true)
suite.logger.Info(&LogMessage{Message: "test with caller"})
output = suite.output.String()
suite.assert.Contains(output, "caller")
// Verify the caller info format (file:line)
suite.assert.Regexp(`"caller":"[^:]+:\d+"`, output)
}
// Test Warning function
func (suite *LoggerAdditionalTestSuite) TestWarning() {
suite.output.Reset()
msg := &LogMessage{Message: "test warning"}
suite.logger.Warning(msg)
output := suite.output.String()
suite.assert.Contains(output, "warn")
suite.assert.Contains(output, "test warning")
}
// Test Error function
func (suite *LoggerAdditionalTestSuite) TestError() {
suite.output.Reset()
msg := &LogMessage{Message: "test error"}
suite.logger.Error(msg)
output := suite.output.String()
suite.assert.Contains(output, "error")
suite.assert.Contains(output, "test error")
}
// Test Fatal function
func (suite *LoggerAdditionalTestSuite) TestFatal() {
suite.output.Reset()
msg := &LogMessage{Message: "test fatal"}
suite.logger.Fatal(msg)
output := suite.output.String()
suite.assert.Contains(output, "fatal")
suite.assert.Contains(output, "test fatal")
}
// Test Critical function without exiting
func (suite *LoggerAdditionalTestSuite) TestCritical() {
// Safely intercept os.Exit call with proper synchronization
exitMutex.Lock()
originalOsExit := osExit
var exitCode int
osExit = func(code int) {
exitCode = code
// Don't actually exit
}
exitMutex.Unlock()
// Ensure we restore the original osExit function
defer func() {
exitMutex.Lock()
osExit = originalOsExit
exitMutex.Unlock()
}()
suite.output.Reset()
msg := &LogMessage{Message: "test critical"}
suite.logger.Critical(msg)
output := suite.output.String()
suite.assert.Contains(output, "fatal")
suite.assert.Contains(output, "test critical")
suite.assert.Equal(1, exitCode)
}
-132
View File
@@ -1,132 +0,0 @@
package libpack_logger
import (
"bytes"
"testing"
"time"
)
func Benchmark_NewLogger(b *testing.B) {
type triggers struct {
ModFormat struct {
Format string
}
ModLevel struct {
Level int
}
}
tests := []struct {
name string
triggers triggers
}{
{
name: "BenchmarkNew",
},
{
name: "BenchmarkNewChangeTimeFormat",
triggers: triggers{
ModFormat: struct{ Format string }{
Format: time.RFC3339Nano,
},
},
},
{
name: "BenchmarkNewChangeLogLevel",
triggers: triggers{
ModLevel: struct{ Level int }{
Level: LEVEL_DEBUG,
},
},
},
{
name: "BenchmarkNewChangeTimeFormatAndLogLevel",
triggers: triggers{
ModFormat: struct{ Format string }{
Format: time.RFC3339Nano,
},
ModLevel: struct{ Level int }{
Level: LEVEL_DEBUG,
},
},
},
}
for _, tt := range tests {
b.Run(tt.name, func(b *testing.B) {
for i := 0; i < b.N; i++ {
_ = New()
}
})
}
}
func Benchmark_Log_Debug(b *testing.B) {
output := &bytes.Buffer{}
logger := New().SetMinLogLevel(LEVEL_DEBUG).SetOutput(output)
msg := &LogMessage{
Message: "debug message",
Pairs: make(map[string]any),
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
logger.Debug(msg)
}
}
func Benchmark_Log_Info(b *testing.B) {
output := &bytes.Buffer{}
logger := New().SetMinLogLevel(LEVEL_INFO).SetOutput(output)
msg := &LogMessage{
Message: "info message",
Pairs: make(map[string]any),
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
logger.Info(msg)
}
}
func Benchmark_Log_Warn(b *testing.B) {
output := &bytes.Buffer{}
logger := New().SetMinLogLevel(LEVEL_WARN).SetOutput(output)
msg := &LogMessage{
Message: "warn message",
Pairs: make(map[string]any),
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
logger.Warn(msg)
}
}
func Benchmark_Log_Error(b *testing.B) {
output := &bytes.Buffer{}
logger := New().SetMinLogLevel(LEVEL_ERROR).SetOutput(output)
msg := &LogMessage{
Message: "error message",
Pairs: map[string]any{"key": "value"},
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
logger.Error(msg)
}
}
func Benchmark_Log_Fatal(b *testing.B) {
output := &bytes.Buffer{}
logger := New().SetMinLogLevel(LEVEL_FATAL).SetOutput(output)
msg := &LogMessage{
Message: "fatal message",
Pairs: make(map[string]any),
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
logger.Fatal(msg)
}
}
-139
View File
@@ -1,139 +0,0 @@
package libpack_logger
import (
"bytes"
"strings"
"sync"
"testing"
"time"
"github.com/goccy/go-json"
)
// Test_LogConcurrentAccess verifies that the logger correctly handles concurrent access
// without race conditions
func TestLogConcurrentAccess(t *testing.T) {
output := &bytes.Buffer{}
logger := New().SetOutput(output).SetMinLogLevel(LEVEL_DEBUG)
// Number of concurrent goroutines
numGoroutines := 100
// Wait group to synchronize goroutines
var wg sync.WaitGroup
wg.Add(numGoroutines)
// Launch multiple goroutines to log concurrently
for i := 0; i < numGoroutines; i++ {
go func(id int) {
defer wg.Done()
msg := &LogMessage{
Message: "concurrent log test",
Pairs: map[string]any{
"goroutine_id": id,
},
}
// Use different log levels to test all paths
switch id % 5 {
case 0:
logger.Debug(msg)
case 1:
logger.Info(msg)
case 2:
logger.Warn(msg)
case 3:
logger.Error(msg)
case 4:
logger.Fatal(msg)
}
}(i)
}
// Wait for all goroutines to complete
wg.Wait()
// If we make it here without a race detector failure, the test passes
if output.Len() == 0 {
t.Error("Expected log output, but got none")
}
}
// TestConcurrentSettersDuringLog verifies that SetFieldName, SetMinLogLevel,
// SetShowCaller, and SetTimeFormat can run concurrently with active log()
// calls without a data race.
//
// Before the fix, SetFieldName wrote the package-global fieldNames map with
// no lock while log() read it from many goroutines, and
// SetMinLogLevel/SetShowCaller/SetTimeFormat mutated Logger fields with no
// lock while shouldLog()/log() read them. This test fails under
// `go test -race` on that code and passes once the setters and readers are
// synchronized.
func TestConcurrentSettersDuringLog(t *testing.T) {
// fieldNames is package-global, so snapshot and restore it: this test
// mutates it concurrently and must not leak state into other tests.
originalFieldNames := make(map[string]string)
for k, v := range fieldNames {
originalFieldNames[k] = v
}
defer func() {
for k, v := range originalFieldNames {
fieldNames[k] = v
}
}()
output := &bytes.Buffer{}
logger := New().SetOutput(output).SetMinLogLevel(LEVEL_DEBUG)
const (
numLoggers = 50
numSetters = 50
iterations = 200
)
var wg sync.WaitGroup
wg.Add(numLoggers + numSetters)
// Goroutines that continuously log, exercising log()'s reads of the
// global fieldNames map and the Logger's minLogLevel/showCaller/
// timeFormat fields.
for i := 0; i < numLoggers; i++ {
go func(id int) {
defer wg.Done()
msg := &LogMessage{Message: "concurrent setter test"}
for j := 0; j < iterations; j++ {
logger.Info(msg)
logger.Debug(msg)
}
}(i)
}
// Goroutines that continuously mutate logger-wide configuration while
// logging is in flight from the goroutines above.
for i := 0; i < numSetters; i++ {
go func(id int) {
defer wg.Done()
for j := 0; j < iterations; j++ {
logger.SetFieldName("timestamp", "ts")
logger.SetMinLogLevel(LEVEL_DEBUG)
logger.SetShowCaller(id%2 == 0)
logger.SetTimeFormat(time.RFC3339Nano)
}
}(i)
}
wg.Wait()
if output.Len() == 0 {
t.Fatal("Expected log output, but got none")
}
// Each emitted line must still be well-formed JSON: the concurrent
// setter calls must not corrupt log() output, only race on which
// setting "wins" at each point in time.
lines := strings.Split(strings.TrimSpace(output.String()), "\n")
for i, line := range lines {
var decoded map[string]any
if err := json.Unmarshal([]byte(line), &decoded); err != nil {
t.Fatalf("line %d is not valid JSON: %v\nline: %s", i, err, line)
}
}
}
-31
View File
@@ -1,31 +0,0 @@
package libpack_logger
import (
"testing"
assertions "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
)
type LoggerTestSuite struct {
suite.Suite
}
var (
assert *assertions.Assertions
)
func (suite *LoggerTestSuite) BeforeTest(suiteName, testName string) {
}
func (suite *LoggerTestSuite) SetupTest() {
assert = assertions.New(suite.T())
}
// TearDownTest is run after each test to clean up
func (suite *LoggerTestSuite) TearDownTest() {
}
func TestSuite(t *testing.T) {
suite.Run(t, new(LoggerTestSuite))
}
-157
View File
@@ -1,157 +0,0 @@
package libpack_logger
import (
"bytes"
"fmt"
"reflect"
"testing"
"time"
"github.com/goccy/go-json"
)
func (suite *LoggerTestSuite) Test_LogMessageString() {
msg := &LogMessage{
Message: "test message",
}
assert.Equal("test message", msg.Message)
}
func callLoggerMethod(logger *Logger, methodName string, message *LogMessage) {
// Get the method by name using reflection
method := reflect.ValueOf(logger).MethodByName(methodName)
if method.IsValid() {
// Call the method with the message as an argument
method.Call([]reflect.Value{reflect.ValueOf(message)})
} else {
fmt.Printf("Method %s does not exist on Logger\n", methodName)
}
}
func (suite *LoggerTestSuite) Test_LogsLevelsPrint() {
output := &bytes.Buffer{}
logger := New().SetOutput(output)
tests := []struct {
pairs map[string]any
name string
method string
message string
loggerMinLevel int
messageLogLevel int
wantOutput bool
}{
{
name: "Log: Debug, Level: Debug - no pairs",
method: "Debug",
loggerMinLevel: LEVEL_DEBUG,
messageLogLevel: LEVEL_DEBUG,
message: "debug message",
wantOutput: true,
},
{
name: "Log: Info, Level: Info - one pair",
method: "Info",
loggerMinLevel: LEVEL_INFO,
messageLogLevel: LEVEL_INFO,
message: "info message",
pairs: map[string]any{
"key": "value",
},
wantOutput: true,
},
{
name: "Log: Info, Level: Warn - with pairs",
method: "Info",
loggerMinLevel: LEVEL_WARN,
messageLogLevel: LEVEL_INFO,
message: "warn message",
pairs: map[string]any{
"key1": "value1",
"key2": "value2",
},
wantOutput: false,
},
{
name: "Log: Warn, Level: Info - with 500 pairs",
method: "Warn",
loggerMinLevel: LEVEL_INFO,
messageLogLevel: LEVEL_WARN,
message: "warn message with 500 pairs",
pairs: func() map[string]any {
pairs := make(map[string]any)
for i := 0; i < 500; i++ {
pairs[fmt.Sprintf("key%d", i)] = fmt.Sprintf("value%d", i)
}
return pairs
}(),
wantOutput: true,
},
}
for _, tt := range tests {
suite.T().Run(tt.name, func(t *testing.T) {
msg := &LogMessage{
Message: tt.message,
Pairs: tt.pairs,
}
output.Reset()
// Set logger's minimum log level
logger.SetMinLogLevel(tt.loggerMinLevel)
fmt.Println("Logger min log level:", levelNames[logger.minLogLevel.Load()])
// Call the logging method
callLoggerMethod(logger, tt.method, msg)
logOutput := output.String()
fmt.Println("Output:", logOutput)
if tt.wantOutput {
var loggedMessage map[string]any
err := json.Unmarshal([]byte(logOutput), &loggedMessage)
if err != nil {
t.Fatalf("Error unmarshalling log message: %v\nLog output: %s", err, logOutput)
}
if !containsLogMessage(logOutput, tt.message) {
t.Errorf("Expected log message %q, but got %q", tt.message, logOutput)
}
assert.Equal(levelNames[tt.messageLogLevel], loggedMessage["level"])
if tt.pairs != nil {
for k, v := range tt.pairs {
assert.Equal(v, loggedMessage[k])
}
}
} else {
assert.Equal("", logOutput)
}
})
}
}
func containsLogMessage(logOutput, expectedMessage string) bool {
return bytes.Contains([]byte(logOutput), []byte(expectedMessage))
}
func (suite *LoggerTestSuite) Test_SetFormat() {
logger := New().SetTimeFormat(time.RFC3339Nano)
assert.Equal(time.RFC3339Nano, *logger.timeFormat.Load())
}
func (suite *LoggerTestSuite) Test_SetMinLogLevel() {
logger := New().SetMinLogLevel(LEVEL_DEBUG)
assert.Equal(LEVEL_DEBUG, int(logger.minLogLevel.Load()))
}
func (suite *LoggerTestSuite) Test_ShouldLog() {
logger := New().SetMinLogLevel(LEVEL_WARN)
assert.True(logger.shouldLog(LEVEL_WARN))
assert.True(logger.shouldLog(LEVEL_ERROR))
assert.False(logger.shouldLog(LEVEL_INFO))
assert.False(logger.shouldLog(LEVEL_DEBUG))
}
+120
View File
@@ -0,0 +1,120 @@
package libpack_logging
import (
"io"
"os"
"sync"
"time"
"github.com/gookit/goutil/envutil"
"github.com/rs/zerolog"
)
type LogConfig struct {
logger zerolog.Logger
}
var (
baseLogger zerolog.Logger
eventPool = sync.Pool{
New: func() interface{} {
return new(zerolog.Event)
},
}
fieldMapPool = sync.Pool{
New: func() interface{} {
return make(map[string]interface{})
},
}
)
func init() {
zerolog.TimeFieldFormat = time.RFC3339
zerolog.MessageFieldName = "short_message"
zerolog.TimestampFieldName = "timestamp"
zerolog.LevelFieldName = "level"
zerolog.LevelFatalValue = "critical"
baseLogger = zerolog.New(os.Stdout).With().Timestamp().Logger()
switch logLevel := envutil.Getenv("LOG_LEVEL", "info"); logLevel {
case "debug":
baseLogger = baseLogger.Level(zerolog.DebugLevel)
case "warn":
baseLogger = baseLogger.Level(zerolog.WarnLevel)
case "error":
baseLogger = baseLogger.Level(zerolog.ErrorLevel)
default:
baseLogger = baseLogger.Level(zerolog.InfoLevel)
}
}
func NewLogger() *LogConfig {
return &LogConfig{logger: baseLogger}
}
func (lw *LogConfig) log(w io.Writer, level zerolog.Level, message string, fields map[string]interface{}) {
logger := lw.logger.Output(w)
event := logger.WithLevel(level).CallerSkipFrame(3)
for k, val := range fields {
switch v := val.(type) {
case string:
event = event.Str(k, v)
case int:
event = event.Int(k, v)
case float64:
event = event.Float64(k, v)
default:
event = event.Interface(k, val)
}
}
event.Msg(message)
}
func (lw *LogConfig) logWithLevel(level zerolog.Level, message string, fields map[string]interface{}) {
if lw.logger.GetLevel() <= level {
w := os.Stdout
if level >= zerolog.ErrorLevel {
w = os.Stderr
}
lw.log(w, level, message, fields)
}
}
func (lw *LogConfig) Debug(message string, fields map[string]interface{}) {
lw.logWithLevel(zerolog.DebugLevel, message, fields)
}
func (lw *LogConfig) Info(message string, fields map[string]interface{}) {
lw.logWithLevel(zerolog.InfoLevel, message, fields)
}
func (lw *LogConfig) Warning(message string, fields map[string]interface{}) {
lw.logWithLevel(zerolog.WarnLevel, message, fields)
}
func (lw *LogConfig) Error(message string, fields map[string]interface{}) {
lw.logWithLevel(zerolog.ErrorLevel, message, fields)
}
func (lw *LogConfig) Critical(message string, fields map[string]interface{}) {
lw.logWithLevel(zerolog.FatalLevel, message, fields)
os.Exit(1)
}
// Helper function to get a new fields map from the pool
func getFieldsMap() map[string]interface{} {
return fieldMapPool.Get().(map[string]interface{})
}
// Helper function to put a used fields map back into the pool
func putFieldsMap(fields map[string]interface{}) {
for k := range fields {
delete(fields, k)
}
fieldMapPool.Put(fields)
}
+32
View File
@@ -0,0 +1,32 @@
package libpack_logging
import (
"os"
"testing"
)
func BenchmarkNewLogger(b *testing.B) {
for i := 0; i < b.N; i++ {
NewLogger()
}
}
func BenchmarkInfoLog(b *testing.B) {
oldEnv := os.Getenv("LOG_LEVEL")
os.Setenv("LOG_LEVEL", "info")
oldStdout := os.Stdout
oldStderr := os.Stderr
os.Stdout, _ = os.Open(os.DevNull)
os.Stderr, _ = os.Open(os.DevNull)
defer func() {
os.Stdout = oldStdout
os.Stderr = oldStderr
os.Setenv("LOG_LEVEL", oldEnv)
}()
testsLogger := NewLogger()
b.ResetTimer()
for i := 0; i < b.N; i++ {
testsLogger.Info("test", map[string]interface{}{"test": "test"})
}
}
-318
View File
@@ -1,318 +0,0 @@
package main
import (
"container/list"
"hash/fnv"
"sync"
"sync/atomic"
"time"
)
// shardCount is the number of LRU shards. Must be a power of two for efficient
// modulo via bitmask, but the implementation uses a plain modulo to keep the
// constant flexible.
const shardCount = 16
// LRUCacheEntry represents a cache entry with metadata.
type LRUCacheEntry struct {
timestamp time.Time
value any
element *list.Element
key string
size int64
}
// lruCacheShard owns a slice of the keyspace and its own mutex/map/list. All
// per-shard state lives here so that operations on different shards do not
// contend on the same lock.
type lruCacheShard struct {
entries map[string]*LRUCacheEntry
evictList *list.List
currentSize int64
count int64
mu sync.Mutex
}
func newLRUCacheShard() *lruCacheShard {
return &lruCacheShard{
entries: make(map[string]*LRUCacheEntry),
evictList: list.New(),
}
}
// LRUCache implements a thread-safe LRU cache with O(1) operations and 16-way
// sharding to reduce mutex contention under concurrent load. Capacity and
// size limits are enforced globally; sharding is a concurrency optimisation.
type LRUCache struct {
shards [shardCount]*lruCacheShard
maxEntries int
maxSize int64
totalSize int64 // atomic, sum of shard sizes
totalCount int64 // atomic, sum of shard counts
// evictMu serialises cross-shard eviction passes so that two writers do
// not race to over-evict. The hot Get/Set paths do not touch this lock.
evictMu sync.Mutex
// entries and evictList are retained as no-op placeholders so that the
// existing test suite (which asserts NotNil on these fields after
// construction) keeps compiling. They are not used by the sharded
// implementation.
entries map[string]*LRUCacheEntry
evictList *list.List
}
// NewLRUCache creates a new LRU cache with the given global limits.
func NewLRUCache(maxEntries int, maxSize int64) *LRUCache {
if maxEntries < 0 {
maxEntries = 0
}
if maxSize < 0 {
maxSize = 0
}
c := &LRUCache{
maxEntries: maxEntries,
maxSize: maxSize,
entries: make(map[string]*LRUCacheEntry),
evictList: list.New(),
}
for i := 0; i < shardCount; i++ {
c.shards[i] = newLRUCacheShard()
}
return c
}
// shardFor routes a key to one of the shards via FNV-1a (no extra dependency).
func (c *LRUCache) shardFor(key string) *lruCacheShard {
h := fnv.New64a()
_, _ = h.Write([]byte(key))
return c.shards[h.Sum64()%shardCount]
}
// Get retrieves a value from the cache.
func (c *LRUCache) Get(key string) (any, bool) {
s := c.shardFor(key)
s.mu.Lock()
defer s.mu.Unlock()
entry, exists := s.entries[key]
if !exists {
return nil, false
}
s.evictList.MoveToFront(entry.element)
entry.timestamp = time.Now()
return entry.value, true
}
// Set adds or updates a value in the cache.
func (c *LRUCache) Set(key string, value any, size int64) {
s := c.shardFor(key)
s.mu.Lock()
if entry, exists := s.entries[key]; exists {
delta := size - entry.size
entry.value = value
entry.size = size
entry.timestamp = time.Now()
s.evictList.MoveToFront(entry.element)
s.currentSize += delta
atomic.AddInt64(&c.totalSize, delta)
s.mu.Unlock()
c.evictIfNeeded()
return
}
entry := &LRUCacheEntry{
key: key,
value: value,
size: size,
timestamp: time.Now(),
}
entry.element = s.evictList.PushFront(entry)
s.entries[key] = entry
s.currentSize += size
s.count++
atomic.AddInt64(&c.totalSize, size)
atomic.AddInt64(&c.totalCount, 1)
s.mu.Unlock()
c.evictIfNeeded()
}
// evictIfNeeded enforces the global maxEntries / maxSize limits by evicting
// the globally least-recently-used entry across all shards until under limits.
// Selecting the victim shard requires inspecting each shard's tail timestamp,
// which is O(shardCount) per eviction — acceptable because shardCount is a
// small constant.
func (c *LRUCache) evictIfNeeded() {
if c.maxEntries == 0 || c.maxSize == 0 {
c.purgeAll()
return
}
// Fast path: lock-free check before acquiring evictMu. Avoids serialising
// every Set when limits are not exceeded.
if atomic.LoadInt64(&c.totalCount) <= int64(c.maxEntries) &&
atomic.LoadInt64(&c.totalSize) <= c.maxSize {
return
}
c.evictMu.Lock()
defer c.evictMu.Unlock()
for {
count := atomic.LoadInt64(&c.totalCount)
size := atomic.LoadInt64(&c.totalSize)
if count <= int64(c.maxEntries) && size <= c.maxSize {
return
}
if !c.evictGloballyOldest() {
return
}
}
}
// evictGloballyOldest removes the single entry with the oldest timestamp
// across all shards. Returns false if no entry could be evicted.
func (c *LRUCache) evictGloballyOldest() bool {
var (
victimShard *lruCacheShard
victimTS time.Time
first = true
)
// Snapshot tail timestamps under each shard lock. Briefly hold each lock.
for _, s := range c.shards {
s.mu.Lock()
back := s.evictList.Back()
if back != nil {
ts := back.Value.(*LRUCacheEntry).timestamp
if first || ts.Before(victimTS) {
victimTS = ts
victimShard = s
first = false
}
}
s.mu.Unlock()
}
if victimShard == nil {
return false
}
victimShard.mu.Lock()
defer victimShard.mu.Unlock()
back := victimShard.evictList.Back()
if back == nil {
return false
}
entry := back.Value.(*LRUCacheEntry)
c.removeFromShard(victimShard, entry)
return true
}
// removeFromShard removes an entry from its shard. Caller must hold shard lock.
func (c *LRUCache) removeFromShard(s *lruCacheShard, entry *LRUCacheEntry) {
s.evictList.Remove(entry.element)
delete(s.entries, entry.key)
s.currentSize -= entry.size
s.count--
atomic.AddInt64(&c.totalSize, -entry.size)
atomic.AddInt64(&c.totalCount, -1)
}
// purgeAll empties every shard. Used when limits are zero.
func (c *LRUCache) purgeAll() {
for _, s := range c.shards {
s.mu.Lock()
freedSize := s.currentSize
freedCount := s.count
s.entries = make(map[string]*LRUCacheEntry)
s.evictList = list.New()
s.currentSize = 0
s.count = 0
s.mu.Unlock()
atomic.AddInt64(&c.totalSize, -freedSize)
atomic.AddInt64(&c.totalCount, -freedCount)
}
}
// Delete removes a key from the cache.
func (c *LRUCache) Delete(key string) {
s := c.shardFor(key)
s.mu.Lock()
defer s.mu.Unlock()
entry, exists := s.entries[key]
if !exists {
return
}
c.removeFromShard(s, entry)
}
// Clear removes all entries from the cache.
func (c *LRUCache) Clear() {
for _, s := range c.shards {
s.mu.Lock()
freedSize := s.currentSize
freedCount := s.count
s.entries = make(map[string]*LRUCacheEntry)
s.evictList = list.New()
s.currentSize = 0
s.count = 0
s.mu.Unlock()
atomic.AddInt64(&c.totalSize, -freedSize)
atomic.AddInt64(&c.totalCount, -freedCount)
}
}
// Len returns the number of entries in the cache.
func (c *LRUCache) Len() int {
return int(atomic.LoadInt64(&c.totalCount))
}
// Size returns the current size of the cache in bytes.
func (c *LRUCache) Size() int64 {
return atomic.LoadInt64(&c.totalSize)
}
// CleanupExpired removes entries older than the given duration across all
// shards. Returns the total number of entries removed.
func (c *LRUCache) CleanupExpired(maxAge time.Duration) int {
now := time.Now()
removed := 0
for _, s := range c.shards {
s.mu.Lock()
for element := s.evictList.Back(); element != nil; {
entry := element.Value.(*LRUCacheEntry)
if now.Sub(entry.timestamp) <= maxAge {
break
}
next := element.Prev()
c.removeFromShard(s, entry)
removed++
element = next
}
s.mu.Unlock()
}
return removed
}
// GetStats returns cache statistics.
func (c *LRUCache) GetStats() map[string]any {
size := atomic.LoadInt64(&c.totalSize)
count := atomic.LoadInt64(&c.totalCount)
var fillPercent float64
if c.maxSize > 0 {
fillPercent = float64(size) / float64(c.maxSize) * 100
}
return map[string]any{
"entries": int(count),
"size_bytes": size,
"max_entries": c.maxEntries,
"max_size": c.maxSize,
"fill_percent": fillPercent,
}
}
-410
View File
@@ -1,410 +0,0 @@
package main
import (
"fmt"
"math/rand"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
)
type LRUCacheTestSuite struct {
suite.Suite
}
func TestLRUCacheTestSuite(t *testing.T) {
suite.Run(t, new(LRUCacheTestSuite))
}
func (suite *LRUCacheTestSuite) TestNewLRUCache() {
cache := NewLRUCache(100, 1024*1024) // 100 entries, 1MB
assert.NotNil(suite.T(), cache)
assert.Equal(suite.T(), 0, cache.Len())
assert.Equal(suite.T(), int64(0), cache.Size())
assert.NotNil(suite.T(), cache.entries)
assert.NotNil(suite.T(), cache.evictList)
}
func (suite *LRUCacheTestSuite) TestGetSet() {
cache := NewLRUCache(10, 1024)
// Test Set and Get
cache.Set("key1", "value1", 10)
val, exists := cache.Get("key1")
assert.True(suite.T(), exists)
assert.Equal(suite.T(), "value1", val)
// Test Get non-existent key
val, exists = cache.Get("nonexistent")
assert.False(suite.T(), exists)
assert.Nil(suite.T(), val)
}
func (suite *LRUCacheTestSuite) TestUpdateExisting() {
cache := NewLRUCache(10, 1024)
// Set initial value
cache.Set("key1", "value1", 10)
assert.Equal(suite.T(), int64(10), cache.Size())
// Update with new value and size
cache.Set("key1", "value2", 20)
val, exists := cache.Get("key1")
assert.True(suite.T(), exists)
assert.Equal(suite.T(), "value2", val)
assert.Equal(suite.T(), int64(20), cache.Size())
assert.Equal(suite.T(), 1, cache.Len())
}
func (suite *LRUCacheTestSuite) TestEvictionByCount() {
cache := NewLRUCache(3, 1024) // Max 3 entries
// Add 4 entries
cache.Set("key1", "value1", 10)
cache.Set("key2", "value2", 10)
cache.Set("key3", "value3", 10)
cache.Set("key4", "value4", 10)
// Should have evicted key1
assert.Equal(suite.T(), 3, cache.Len())
_, exists := cache.Get("key1")
assert.False(suite.T(), exists)
// key2, key3, key4 should still exist
_, exists = cache.Get("key2")
assert.True(suite.T(), exists)
_, exists = cache.Get("key3")
assert.True(suite.T(), exists)
_, exists = cache.Get("key4")
assert.True(suite.T(), exists)
}
func (suite *LRUCacheTestSuite) TestEvictionBySize() {
cache := NewLRUCache(10, 100) // Max 100 bytes
// Add entries that exceed size limit
cache.Set("key1", "value1", 40)
cache.Set("key2", "value2", 40)
cache.Set("key3", "value3", 40) // Total would be 120, should evict key1
assert.Equal(suite.T(), 2, cache.Len())
assert.LessOrEqual(suite.T(), cache.Size(), int64(100))
// key1 should be evicted
_, exists := cache.Get("key1")
assert.False(suite.T(), exists)
// key2 and key3 should exist
_, exists = cache.Get("key2")
assert.True(suite.T(), exists)
_, exists = cache.Get("key3")
assert.True(suite.T(), exists)
}
func (suite *LRUCacheTestSuite) TestLRUOrder() {
cache := NewLRUCache(3, 1024)
// Add 3 entries
cache.Set("key1", "value1", 10)
cache.Set("key2", "value2", 10)
cache.Set("key3", "value3", 10)
// Access key1 to make it most recently used
cache.Get("key1")
// Add a new entry, should evict key2 (least recently used)
cache.Set("key4", "value4", 10)
_, exists := cache.Get("key1")
assert.True(suite.T(), exists) // Should exist (recently accessed)
_, exists = cache.Get("key2")
assert.False(suite.T(), exists) // Should be evicted
_, exists = cache.Get("key3")
assert.True(suite.T(), exists) // Should exist
_, exists = cache.Get("key4")
assert.True(suite.T(), exists) // Should exist (newest)
}
func (suite *LRUCacheTestSuite) TestDelete() {
cache := NewLRUCache(10, 1024)
cache.Set("key1", "value1", 10)
cache.Set("key2", "value2", 20)
assert.Equal(suite.T(), 2, cache.Len())
assert.Equal(suite.T(), int64(30), cache.Size())
// Delete key1
cache.Delete("key1")
assert.Equal(suite.T(), 1, cache.Len())
assert.Equal(suite.T(), int64(20), cache.Size())
_, exists := cache.Get("key1")
assert.False(suite.T(), exists)
// Delete non-existent key should be safe
cache.Delete("nonexistent")
assert.Equal(suite.T(), 1, cache.Len())
}
func (suite *LRUCacheTestSuite) TestClear() {
cache := NewLRUCache(10, 1024)
// Add multiple entries
for i := 0; i < 5; i++ {
cache.Set(fmt.Sprintf("key%d", i), fmt.Sprintf("value%d", i), 10)
}
assert.Equal(suite.T(), 5, cache.Len())
assert.Equal(suite.T(), int64(50), cache.Size())
// Clear cache
cache.Clear()
assert.Equal(suite.T(), 0, cache.Len())
assert.Equal(suite.T(), int64(0), cache.Size())
// Should be able to add new entries
cache.Set("newkey", "newvalue", 10)
assert.Equal(suite.T(), 1, cache.Len())
}
func (suite *LRUCacheTestSuite) TestCleanupExpired() {
cache := NewLRUCache(10, 1024)
// Add entries
cache.Set("key1", "value1", 10)
cache.Set("key2", "value2", 10)
// Sleep to make entries older
time.Sleep(100 * time.Millisecond)
// Add a new entry
cache.Set("key3", "value3", 10)
// Cleanup entries older than 50ms
removed := cache.CleanupExpired(50 * time.Millisecond)
assert.Equal(suite.T(), 2, removed) // key1 and key2 should be removed
assert.Equal(suite.T(), 1, cache.Len())
_, exists := cache.Get("key3")
assert.True(suite.T(), exists) // key3 should still exist
}
func (suite *LRUCacheTestSuite) TestGetStats() {
cache := NewLRUCache(10, 1000)
cache.Set("key1", "value1", 100)
cache.Set("key2", "value2", 200)
stats := cache.GetStats()
assert.Equal(suite.T(), 2, stats["entries"])
assert.Equal(suite.T(), int64(300), stats["size_bytes"])
assert.Equal(suite.T(), 10, stats["max_entries"])
assert.Equal(suite.T(), int64(1000), stats["max_size"])
assert.Equal(suite.T(), float64(30), stats["fill_percent"])
}
func (suite *LRUCacheTestSuite) TestConcurrentAccess() {
cache := NewLRUCache(100, 10240)
numGoroutines := 10
numOperations := 100
var wg sync.WaitGroup
wg.Add(numGoroutines)
// Run concurrent operations
for g := 0; g < numGoroutines; g++ {
go func(goroutineID int) {
defer wg.Done()
for i := 0; i < numOperations; i++ {
key := fmt.Sprintf("key-%d-%d", goroutineID, i)
value := fmt.Sprintf("value-%d-%d", goroutineID, i)
// Mix of operations
switch i % 4 {
case 0:
cache.Set(key, value, 10)
case 1:
cache.Get(key)
case 2:
cache.Delete(fmt.Sprintf("key-%d-%d", goroutineID, i-1))
case 3:
cache.Len()
cache.Size()
}
}
}(g)
}
wg.Wait()
// Cache should be in a consistent state
assert.LessOrEqual(suite.T(), cache.Len(), 100)
assert.GreaterOrEqual(suite.T(), cache.Len(), 0)
}
func (suite *LRUCacheTestSuite) TestConcurrentEviction() {
cache := NewLRUCache(10, 1024) // Small cache to trigger evictions
var wg sync.WaitGroup
numGoroutines := 50
wg.Add(numGoroutines)
for g := 0; g < numGoroutines; g++ {
go func(id int) {
defer wg.Done()
for i := 0; i < 100; i++ {
key := fmt.Sprintf("key-%d-%d", id, i)
cache.Set(key, "value", 10)
time.Sleep(time.Microsecond) // Small delay to interleave operations
}
}(g)
}
wg.Wait()
// Should never exceed max entries
assert.LessOrEqual(suite.T(), cache.Len(), 10)
assert.LessOrEqual(suite.T(), cache.Size(), int64(1024))
}
func (suite *LRUCacheTestSuite) TestRaceCondition() {
// This test specifically checks for race conditions
cache := NewLRUCache(100, 10240)
var wg sync.WaitGroup
var setCount, getCount, deleteCount int32
// Writer goroutines
for i := 0; i < 5; i++ {
wg.Add(1)
go func(id int) {
defer wg.Done()
for j := 0; j < 100; j++ {
key := fmt.Sprintf("key%d", rand.Intn(50))
cache.Set(key, "value", 10)
atomic.AddInt32(&setCount, 1)
}
}(i)
}
// Reader goroutines
for i := 0; i < 5; i++ {
wg.Add(1)
go func(id int) {
defer wg.Done()
for j := 0; j < 100; j++ {
key := fmt.Sprintf("key%d", rand.Intn(50))
cache.Get(key)
atomic.AddInt32(&getCount, 1)
}
}(i)
}
// Deleter goroutines
for i := 0; i < 2; i++ {
wg.Add(1)
go func(id int) {
defer wg.Done()
for j := 0; j < 50; j++ {
key := fmt.Sprintf("key%d", rand.Intn(50))
cache.Delete(key)
atomic.AddInt32(&deleteCount, 1)
}
}(i)
}
// Stats reader
wg.Add(1)
go func() {
defer wg.Done()
for i := 0; i < 100; i++ {
_ = cache.GetStats()
time.Sleep(time.Microsecond)
}
}()
// Cleanup goroutine
wg.Add(1)
go func() {
defer wg.Done()
for i := 0; i < 10; i++ {
time.Sleep(10 * time.Millisecond)
cache.CleanupExpired(5 * time.Millisecond)
}
}()
wg.Wait()
// Verify operations completed
assert.Equal(suite.T(), int32(500), atomic.LoadInt32(&setCount))
assert.Equal(suite.T(), int32(500), atomic.LoadInt32(&getCount))
assert.Equal(suite.T(), int32(100), atomic.LoadInt32(&deleteCount))
}
func (suite *LRUCacheTestSuite) TestEdgeCases() {
// Zero size cache
cache := NewLRUCache(0, 0)
cache.Set("key", "value", 10)
assert.Equal(suite.T(), 0, cache.Len()) // Should not store anything
// Negative values should be handled
cache = NewLRUCache(-1, -1)
cache.Set("key", "value", 10)
assert.Equal(suite.T(), 0, cache.Len())
// Very large size
cache = NewLRUCache(1, 1)
cache.Set("key", "value", 1000) // Size exceeds limit
assert.Equal(suite.T(), 0, cache.Len()) // Should evict immediately
}
// Benchmark tests
func BenchmarkLRUCacheSet(b *testing.B) {
cache := NewLRUCache(1000, 1024*1024)
b.ResetTimer()
for i := 0; i < b.N; i++ {
key := fmt.Sprintf("key%d", i)
cache.Set(key, "value", 10)
}
}
func BenchmarkLRUCacheGet(b *testing.B) {
cache := NewLRUCache(1000, 1024*1024)
// Pre-populate cache
for i := 0; i < 1000; i++ {
key := fmt.Sprintf("key%d", i)
cache.Set(key, "value", 10)
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
key := fmt.Sprintf("key%d", i%1000)
cache.Get(key)
}
}
func BenchmarkLRUCacheConcurrent(b *testing.B) {
cache := NewLRUCache(1000, 1024*1024)
b.RunParallel(func(pb *testing.PB) {
i := 0
for pb.Next() {
key := fmt.Sprintf("key%d", i)
if i%2 == 0 {
cache.Set(key, "value", 10)
} else {
cache.Get(key)
}
i++
}
})
}
+23 -1094
View File
File diff suppressed because it is too large Load Diff
-465
View File
@@ -1,465 +0,0 @@
package main
import (
"fmt"
"os"
"path/filepath"
"strings"
"testing"
"github.com/stretchr/testify/suite"
)
type MainSecurityTestSuite struct {
suite.Suite
}
func TestMainSecurityTestSuite(t *testing.T) {
suite.Run(t, new(MainSecurityTestSuite))
}
// isTempPathAllowed checks if a temp path would be allowed by validateFilePath
func (suite *MainSecurityTestSuite) isTempPathAllowed(path string) bool {
absPath, err := filepath.Abs(path)
if err != nil {
return false
}
// Check if temp path is in allowed locations
allowedPrefixes := []string{"/tmp/", "/var/tmp/"}
for _, prefix := range allowedPrefixes {
if strings.HasPrefix(absPath, prefix) {
return true
}
}
// Check if it's in the working directory
workDir, err := os.Getwd()
if err != nil {
return false
}
cleanedWorkDir := filepath.Clean(workDir)
return strings.HasPrefix(absPath, cleanedWorkDir+string(filepath.Separator))
}
// TestValidateFilePathSecurity tests the validateFilePath function for various security scenarios
func (suite *MainSecurityTestSuite) TestValidateFilePathSecurity() {
tests := []struct {
name string
inputPath string
description string
shouldFail bool
}{
// Path traversal attacks
{
name: "Basic path traversal with double dots",
inputPath: "../../../../etc/passwd",
shouldFail: true,
description: "Should reject basic path traversal attempt",
},
{
name: "Path traversal with current directory prefix",
inputPath: "./../../etc/passwd",
shouldFail: true,
description: "Should reject path traversal even with ./ prefix",
},
{
name: "Deep path traversal",
inputPath: "../../../../../../../etc/shadow",
shouldFail: true,
description: "Should reject deep path traversal attempts",
},
{
name: "URL encoded path traversal",
inputPath: "%2e%2e%2f%2e%2e%2fetc%2fpasswd",
shouldFail: true,
description: "Should reject URL encoded traversal (if decoded)",
},
{
name: "Double encoded path traversal",
inputPath: "%252e%252e%252f%252e%252e%252fetc%252fpasswd",
shouldFail: true,
description: "Should reject double encoded traversal",
},
{
name: "Mixed case path traversal",
inputPath: "../ETC/passwd",
shouldFail: true,
description: "Should reject mixed case traversal attempts",
},
{
name: "Path traversal with backslashes",
inputPath: "..\\..\\windows\\system32\\drivers\\etc\\hosts",
shouldFail: true,
description: "Should reject Windows-style path traversal",
},
// Absolute path attacks
{
name: "Absolute path to sensitive file",
inputPath: "/etc/shadow",
shouldFail: true,
description: "Should reject absolute path outside allowed directories",
},
{
name: "Absolute path to system directories",
inputPath: "/bin/bash",
shouldFail: true,
description: "Should reject access to system binaries",
},
{
name: "Absolute path to home directory",
inputPath: "/home/user/.ssh/id_rsa",
shouldFail: true,
description: "Should reject access to user directories",
},
{
name: "Absolute path to proc filesystem",
inputPath: "/proc/self/environ",
shouldFail: true,
description: "Should reject access to proc filesystem",
},
// Null byte injection
{
name: "Null byte injection",
inputPath: "/tmp/test.txt\x00.jpg",
shouldFail: true,
description: "Should reject null byte injection attempts",
},
{
name: "Null byte in middle of path",
inputPath: "/tmp/test\x00/file.txt",
shouldFail: true,
description: "Should reject null bytes anywhere in path",
},
// Symbolic link attempts (path patterns that might be symlinks)
{
name: "Suspicious symlink pattern",
inputPath: "./symlink_to_etc",
shouldFail: false, // This is allowed by current logic but would need real symlink detection
description: "Pattern that might be a symlink to sensitive location",
},
// Valid paths that should pass
{
name: "Valid application directory path",
inputPath: "/go/src/app/banned_users.txt",
shouldFail: false,
description: "Should accept valid app directory path",
},
{
name: "Valid current directory path",
inputPath: "./data/banned_users.txt",
shouldFail: false,
description: "Should accept valid relative path",
},
{
name: "Valid temp directory path",
inputPath: "/tmp/test_file.txt",
shouldFail: false,
description: "Should accept valid temp directory path",
},
{
name: "Valid var/tmp directory path",
inputPath: "/var/tmp/cache_file.json",
shouldFail: false,
description: "Should accept valid var/tmp directory path",
},
{
name: "Valid nested path in app directory",
inputPath: "/go/src/app/config/settings.json",
shouldFail: false,
description: "Should accept nested paths in allowed directories",
},
// Edge cases
{
name: "Empty path",
inputPath: "",
shouldFail: true,
description: "Should reject empty paths",
},
{
name: "Only dots",
inputPath: "..",
shouldFail: true,
description: "Should reject bare double dots",
},
{
name: "Current directory only",
inputPath: ".",
shouldFail: true,
description: "Should reject bare current directory",
},
{
name: "Root directory",
inputPath: "/",
shouldFail: true,
description: "Should reject root directory access",
},
{
name: "Path with multiple consecutive dots",
inputPath: "./....//....//etc/passwd",
shouldFail: true,
description: "Should reject obfuscated path traversal",
},
// Special character attacks
{
name: "Path with semicolon",
inputPath: "/tmp/file;rm -rf /",
shouldFail: true,
description: "Should handle paths with command injection attempts",
},
{
name: "Path with pipe",
inputPath: "/tmp/file|cat /etc/passwd",
shouldFail: true,
description: "Should handle paths with pipe characters",
},
{
name: "Path with newline",
inputPath: "/tmp/file\ncat /etc/passwd",
shouldFail: true,
description: "Should handle paths with newline injection",
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
result, err := validateFilePath(tt.inputPath)
if tt.shouldFail {
suite.Error(err, "Expected error for path: %s (%s)", tt.inputPath, tt.description)
suite.Empty(result, "Should return empty result on error")
// Verify error messages don't leak sensitive information
if err != nil {
errMsg := strings.ToLower(err.Error())
suite.NotContains(errMsg, "secret", "Error should not contain 'secret'")
suite.NotContains(errMsg, "password", "Error should not contain 'password'")
suite.NotContains(errMsg, "key", "Error should not contain 'key'")
}
} else {
suite.NoError(err, "Expected no error for path: %s (%s)", tt.inputPath, tt.description)
suite.NotEmpty(result, "Should return validated path")
suite.Equal(tt.inputPath, result, "Should return original path when valid")
}
})
}
}
// TestValidateFilePathConcurrentAccess tests path validation under concurrent conditions
func (suite *MainSecurityTestSuite) TestValidateFilePathConcurrentAccess() {
maliciousPaths := []string{
"../../../../etc/passwd",
"../../../etc/shadow",
"/etc/hosts",
"./../../var/log/messages",
"/proc/self/environ",
}
suite.Run("Concurrent malicious paths should all be rejected", func() {
done := make(chan error, len(maliciousPaths))
for _, path := range maliciousPaths {
go func(p string) {
_, err := validateFilePath(p)
done <- err
}(path)
}
// Collect all results
for i := 0; i < len(maliciousPaths); i++ {
err := <-done
suite.Error(err, "All malicious paths should be rejected concurrently")
}
})
}
// TestValidateFilePathWithRealFiles tests validation with actual file system operations
func (suite *MainSecurityTestSuite) TestValidateFilePathWithRealFiles() {
// Create temporary directory and files for testing
tempDir, err := os.MkdirTemp("", "path_security_test")
suite.NoError(err)
defer os.RemoveAll(tempDir)
// Create a test file
testFile := filepath.Join(tempDir, "test.txt")
err = os.WriteFile(testFile, []byte("test content"), 0644)
suite.NoError(err)
// Determine if temp file should fail based on system temp location
tempFileShouldFail := !suite.isTempPathAllowed(testFile)
tests := []struct {
name string
path string
shouldFail bool
}{
{
name: "Valid temp file",
path: testFile,
shouldFail: tempFileShouldFail, // Depends on system temp location
},
{
name: "Non-existent file in allowed directory",
path: "/tmp/non_existent.txt",
shouldFail: false, // Should pass validation (file existence not checked)
},
{
name: "Directory instead of file",
path: "/tmp/",
shouldFail: false, // Should pass validation
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
_, err := validateFilePath(tt.path)
if tt.shouldFail {
suite.Error(err)
} else {
suite.NoError(err)
}
})
}
}
// TestValidateFilePathEdgeCases tests various edge cases and corner conditions
func (suite *MainSecurityTestSuite) TestValidateFilePathEdgeCases() {
suite.Run("Very long path", func() {
// Create a very long path that might cause buffer overflows
longPath := "/tmp/" + strings.Repeat("a", 4096) + ".txt"
_, err := validateFilePath(longPath)
// Should handle gracefully without crashing
suite.NoError(err) // Long paths in /tmp/ should be allowed
})
suite.Run("Path with unicode characters", func() {
unicodePath := "/tmp/тест.txt" // Russian characters
_, err := validateFilePath(unicodePath)
suite.NoError(err) // Unicode should be allowed in valid directories
})
suite.Run("Path with spaces", func() {
spacePath := "/tmp/file with spaces.txt"
_, err := validateFilePath(spacePath)
suite.NoError(err) // Spaces should be allowed
})
suite.Run("Path with special but safe characters", func() {
specialPath := "/tmp/file-name_123.json"
_, err := validateFilePath(specialPath)
suite.NoError(err) // Safe special characters should be allowed
})
}
// TestValidateFilePathAllowedDirectories tests the allowed directory logic
func (suite *MainSecurityTestSuite) TestValidateFilePathAllowedDirectories() {
allowedTests := []struct {
name string
path string
}{
{"Go app directory", "/go/src/app/config.json"},
{"Current directory", "./config.json"},
{"Temp directory", "/tmp/cache.json"},
{"Var temp directory", "/var/tmp/session.json"},
}
for _, tt := range allowedTests {
suite.Run(tt.name, func() {
result, err := validateFilePath(tt.path)
suite.NoError(err, "Path should be allowed: %s", tt.path)
suite.Equal(tt.path, result)
})
}
disallowedTests := []struct {
name string
path string
}{
{"Home directory", "/home/user/file.txt"},
{"Root etc", "/etc/config"},
{"System bin", "/bin/executable"},
{"Var log", "/var/log/messages"},
{"Opt directory", "/opt/app/config"},
{"Absolute path without allowed prefix", "/random/path/file.txt"},
}
for _, tt := range disallowedTests {
suite.Run(tt.name, func() {
_, err := validateFilePath(tt.path)
suite.Error(err, "Path should be rejected: %s", tt.path)
})
}
}
// TestValidateFilePathBoundaryConditions tests boundary conditions
func (suite *MainSecurityTestSuite) TestValidateFilePathBoundaryConditions() {
suite.Run("Path exactly at allowed prefix boundary", func() {
// Test paths that are exactly the allowed prefixes
prefixes := []string{"/go/src/app/", "./", "/tmp/", "/var/tmp/"}
for _, prefix := range prefixes {
// Exact prefix should be allowed
_, err := validateFilePath(prefix)
suite.NoError(err, "Exact prefix should be allowed: %s", prefix)
// Prefix with filename should be allowed
_, err = validateFilePath(prefix + "file.txt")
suite.NoError(err, "Prefix with file should be allowed: %s", prefix+"file.txt")
// Similar but not exact prefix should be rejected (if not otherwise allowed)
if prefix != "./" { // Skip this test for "./" as it's tricky
similar := prefix[:len(prefix)-1] + "x/"
_, err = validateFilePath(similar + "file.txt")
if !strings.HasPrefix(similar, "/tmp") && !strings.HasPrefix(similar, "/var/tmp") {
suite.Error(err, "Similar but different prefix should be rejected: %s", similar+"file.txt")
}
}
}
})
}
// BenchmarkValidateFilePath benchmarks the path validation function
func BenchmarkValidateFilePath(b *testing.B) {
testPaths := []string{
"/go/src/app/config.json",
"./data/file.txt",
"/tmp/cache.json",
"../../../../etc/passwd", // malicious
"/etc/shadow", // malicious
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
for _, path := range testPaths {
validateFilePath(path)
}
}
}
// TestValidateFilePathErrorMessages tests that error messages are appropriate
func (suite *MainSecurityTestSuite) TestValidateFilePathErrorMessages() {
errorTests := []struct {
path string
expectedContains string
}{
{"", "empty"},
{"..", "traversal"},
{"../etc/passwd", "traversal"},
{"/tmp/file\x00.txt", "null byte"},
{"/etc/passwd", "not in allowed"},
}
for _, tt := range errorTests {
suite.Run(fmt.Sprintf("Error for %s", tt.path), func() {
_, err := validateFilePath(tt.path)
suite.Error(err)
suite.Contains(strings.ToLower(err.Error()), tt.expectedContains)
})
}
}
+26 -420
View File
@@ -1,105 +1,63 @@
package main
import (
"context"
"fmt"
"os"
"testing"
"time"
"github.com/goccy/go-json"
"github.com/gofiber/fiber/v3"
libpack_cache "github.com/lukaszraczylo/graphql-monitoring-proxy/cache/memory"
"github.com/gofiber/fiber/v2"
libpack_logging "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/stretchr/testify/assert"
assertions "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/suite"
"github.com/valyala/fasthttp"
)
type Tests struct {
suite.Suite
app *fiber.App
ctx context.Context
cancel context.CancelFunc
apiDone chan struct{}
app *fiber.App
}
var (
assert *assertions.Assertions
)
func (suite *Tests) BeforeTest(suiteName, testName string) {
}
func (suite *Tests) SetupTest() {
// Setup test
assert = assertions.New(suite.T())
suite.app = fiber.New(
fiber.Config{
JSONEncoder: json.Marshal,
JSONDecoder: json.Unmarshal,
DisableStartupMessage: true,
JSONEncoder: json.Marshal,
JSONDecoder: json.Unmarshal,
},
)
// Initialize a simple in-memory cache client for testing purposes
libpack_cache.New(5 * time.Minute)
parseConfig()
// Use very short retry delays in tests so that retry-exhausting requests
// (e.g. 7 attempts × backoff) complete in milliseconds instead of ~25s each.
cfgMutex.Lock()
cfg.Client.RetryBaseDelayMs = 10
cfg.Client.RetryMaxDelayMs = 10
cfgMutex.Unlock()
// Create context with cancel for cleanup
suite.ctx, suite.cancel = context.WithCancel(context.Background())
suite.apiDone = make(chan struct{})
// Start API server in goroutine
// Temporarily disable API server in tests to isolate issues
// go func() {
// enableApi(suite.ctx)
// close(suite.apiDone)
// }()
close(suite.apiDone) // Close immediately since we're not starting the server
_ = StartMonitoringServer()
// Update logger with proper synchronization
logger := libpack_logging.New().SetMinLogLevel(libpack_logging.GetLogLevel(getDetailsFromEnv("LOG_LEVEL", "info")))
cfgMutex.Lock()
cfg.Logger = logger
cfgMutex.Unlock()
enableApi()
StartMonitoringServer()
cfg.Logger = libpack_logging.NewLogger()
// Setup environment variables here if needed
_ = os.Setenv("GMP_TEST_STRING", "testValue")
_ = os.Setenv("GMP_TEST_INT", "123")
_ = os.Setenv("GMP_TEST_BOOL", "true")
_ = os.Setenv("NON_GMP_TEST_INT", "31337")
os.Setenv("GMP_TEST_STRING", "testValue")
os.Setenv("GMP_TEST_INT", "123")
os.Setenv("GMP_TEST_BOOL", "true")
os.Setenv("NON_GMP_TEST_INT", "31337")
}
// TearDownTest is run after each test to clean up
func (suite *Tests) TearDownTest() {
// Cancel context to shutdown API server
if suite.cancel != nil {
suite.cancel()
// Wait for API server to shutdown
select {
case <-suite.apiDone:
case <-time.After(2 * time.Second):
// Timeout waiting for shutdown
}
}
// Shutdown connection pool
ShutdownConnectionPool()
// Clean up environment variables here if needed
_ = os.Unsetenv("GMP_TEST_STRING")
_ = os.Unsetenv("GMP_TEST_INT")
_ = os.Unsetenv("GMP_TEST_BOOL")
_ = os.Unsetenv("NON_GMP_TEST_INT")
os.Unsetenv("GMP_TEST_STRING")
os.Unsetenv("GMP_TEST_INT")
os.Unsetenv("GMP_TEST_BOOL")
os.Unsetenv("NON_GMP_TEST_INT")
}
// func (suite *Tests) AfterTest(suiteName, testName string) {)
func TestSuite(t *testing.T) {
cfg = &config{}
parseConfig()
StartMonitoringServer()
suite.Run(t, new(Tests))
}
@@ -145,359 +103,7 @@ func (suite *Tests) Test_envVariableSetting() {
for _, tt := range tests {
suite.Run(tt.name, func() {
result := getDetailsFromEnv(tt.envKey, tt.defaultValue)
assert.Equal(suite.T(), tt.expected, result)
})
}
}
func (suite *Tests) Test_getDetailsFromEnv() {
tests := []struct {
defaultValue any
expected any
name string
key string
envValue string
}{
{"default", "envValue", "string value", "TEST_STRING", "envValue"},
{0, 123, "int value", "TEST_INT", "123"},
{false, true, "bool value", "TEST_BOOL", "true"},
{0.5, 0.25, "float value", "TEST_FLOAT", "0.25"},
{0.5, 0.5, "float default on malformed value", "TEST_FLOAT_BAD", "not-a-number"},
{"default", "default", "default value", "NON_EXISTENT", ""},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
if tt.envValue != "" {
_ = os.Setenv("GMP_"+tt.key, tt.envValue)
defer func() { _ = os.Unsetenv("GMP_" + tt.key) }()
}
result := getDetailsFromEnv(tt.key, tt.defaultValue)
assert.Equal(suite.T(), tt.expected, result)
})
}
}
func (suite *Tests) TestIntrospectionEnvironmentConfig() {
// Save original env vars
oldEnv := make(map[string]string)
varsToSave := []string{
"BLOCK_SCHEMA_INTROSPECTION",
"ALLOWED_INTROSPECTION",
"GMP_BLOCK_SCHEMA_INTROSPECTION",
"GMP_ALLOWED_INTROSPECTION",
}
for _, env := range varsToSave {
if val, exists := os.LookupEnv(env); exists {
oldEnv[env] = val
_ = os.Unsetenv(env)
}
}
defer func() {
// Restore original env vars
for k, v := range oldEnv {
_ = os.Setenv(k, v)
}
}()
tests := []struct {
envVars map[string]string
name string
query string
wantEndpoint string
wantBlocked bool
}{
{
name: "basic typename allowed",
envVars: map[string]string{
"BLOCK_SCHEMA_INTROSPECTION": "true",
"ALLOWED_INTROSPECTION": "__typename",
},
query: `{
users {
id
__typename
}
}`,
wantBlocked: false,
},
{
name: "GMP prefix takes precedence",
envVars: map[string]string{
"BLOCK_SCHEMA_INTROSPECTION": "false",
"GMP_BLOCK_SCHEMA_INTROSPECTION": "true",
"ALLOWED_INTROSPECTION": "__type",
"GMP_ALLOWED_INTROSPECTION": "__typename",
},
query: `{
users {
__typename
}
}`,
wantBlocked: false,
},
{
name: "multiple allowed queries",
envVars: map[string]string{
"BLOCK_SCHEMA_INTROSPECTION": "true",
"ALLOWED_INTROSPECTION": "__typename,__schema",
},
query: `{
__schema {
types {
name
__typename
}
}
}`,
wantBlocked: false,
},
{
name: "multiple allowed queries with one of them blocked",
envVars: map[string]string{
"BLOCK_SCHEMA_INTROSPECTION": "true",
"ALLOWED_INTROSPECTION": "__schema",
},
query: `{
__schema {
types {
name
__typename
}
}
}`,
wantBlocked: true,
},
}
for _, tt := range tests {
suite.Run(tt.name, func() {
// Set test env vars
for k, v := range tt.envVars {
_ = os.Setenv(k, v)
}
// Reset global config with proper synchronization
cfgMutex.Lock()
cfg = nil
cfgMutex.Unlock()
parseConfig()
// Create test request
app := fiber.New()
ctx := app.AcquireCtx(&fasthttp.RequestCtx{})
defer app.ReleaseCtx(ctx)
ctx.Request().Header.SetMethod("POST")
ctx.Request().SetBody([]byte(fmt.Sprintf(`{"query": %q}`, tt.query)))
result := parseGraphQLQuery(ctx)
assert.Equal(suite.T(), tt.wantBlocked, result.shouldBlock)
for k := range tt.envVars {
_ = os.Unsetenv(k)
}
})
}
}
// TestGetDetailsFromEnv_InvalidValues covers C2 (an unparsable env value must
// fall back to the coded default, never a silent 0/false) and C13 (the
// GMP_-prefixed and unprefixed bool parsers must accept the same
// true/1/on/yes and false/0/off/no tokens, and agree on the same input).
// Uses t.Setenv so each subtest's environment is reset automatically.
func TestGetDetailsFromEnv_InvalidValues(t *testing.T) {
tests := []struct {
defaultValue any
expected any
name string
key string
envKey string
envValue string
}{
// C2: unprefixed int/float, garbage value falls back to the coded
// default instead of envutil.GetInt's silent 0.
{name: "unprefixed int garbage falls back to default, not 0", key: "TEST_C2_INT", envKey: "TEST_C2_INT", envValue: "not-a-number", defaultValue: 42, expected: 42},
{name: "unprefixed float garbage falls back to default", key: "TEST_C2_FLOAT", envKey: "TEST_C2_FLOAT", envValue: "not-a-number", defaultValue: 2.5, expected: 2.5},
// Sanity: a valid unprefixed value still parses (default-preserving).
{name: "unprefixed int valid value still parses", key: "TEST_C2_INT_OK", envKey: "TEST_C2_INT_OK", envValue: "7", defaultValue: 42, expected: 7},
// C13: unprefixed bool accepts on/yes/off/no (baseline gookit
// behavior, pinned here so a future change cannot silently regress
// the parity the prefixed path is fixed to match).
{name: "unprefixed bool on", key: "TEST_C13_BOOL_ON", envKey: "TEST_C13_BOOL_ON", envValue: "on", defaultValue: false, expected: true},
{name: "unprefixed bool off", key: "TEST_C13_BOOL_OFF", envKey: "TEST_C13_BOOL_OFF", envValue: "off", defaultValue: true, expected: false},
{name: "unprefixed bool yes", key: "TEST_C13_BOOL_YES", envKey: "TEST_C13_BOOL_YES", envValue: "yes", defaultValue: false, expected: true},
{name: "unprefixed bool no", key: "TEST_C13_BOOL_NO", envKey: "TEST_C13_BOOL_NO", envValue: "no", defaultValue: true, expected: false},
// C13: the prefixed path now accepts the same tokens (previously
// only "true"/"1" were accepted, diverging from the unprefixed
// path - security-relevant for e.g. GMP_BLOCK_SCHEMA_INTROSPECTION).
{name: "prefixed bool on", key: "TEST_C13_PFX_ON", envKey: "GMP_TEST_C13_PFX_ON", envValue: "on", defaultValue: false, expected: true},
{name: "prefixed bool off", key: "TEST_C13_PFX_OFF", envKey: "GMP_TEST_C13_PFX_OFF", envValue: "off", defaultValue: true, expected: false},
{name: "prefixed bool yes", key: "TEST_C13_PFX_YES", envKey: "GMP_TEST_C13_PFX_YES", envValue: "yes", defaultValue: false, expected: true},
{name: "prefixed bool no", key: "TEST_C13_PFX_NO", envKey: "GMP_TEST_C13_PFX_NO", envValue: "no", defaultValue: true, expected: false},
// C13/C2: a garbage bool value on either side falls back to the
// coded default instead of silently becoming false.
{name: "prefixed bool garbage falls back to default", key: "TEST_C13_PFX_BAD", envKey: "GMP_TEST_C13_PFX_BAD", envValue: "maybe", defaultValue: true, expected: true},
{name: "unprefixed bool garbage falls back to default", key: "TEST_C13_BAD", envKey: "TEST_C13_BAD", envValue: "maybe", defaultValue: true, expected: true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Setenv(tt.envKey, tt.envValue)
var result any
switch def := tt.defaultValue.(type) {
case int:
result = getDetailsFromEnv(tt.key, def)
case float64:
result = getDetailsFromEnv(tt.key, def)
case bool:
result = getDetailsFromEnv(tt.key, def)
default:
t.Fatalf("unsupported default value type %T", tt.defaultValue)
}
assert.Equal(t, tt.expected, result)
})
}
}
// TestGetDetailsFromEnv_PrefixedInvalidDoesNotFallThrough covers C3: when
// the GMP_-prefixed var is set but fails to parse, getDetailsFromEnv must
// use the coded default and must NOT fall through to a stale/unrelated
// unprefixed value of the same base key.
func TestGetDetailsFromEnv_PrefixedInvalidDoesNotFallThrough(t *testing.T) {
t.Run("int: prefixed invalid ignores stale unprefixed value", func(t *testing.T) {
t.Setenv("TEST_C3_INT", "999") // stale unprefixed value, must not win
t.Setenv("GMP_TEST_C3_INT", "not-a-number") // prefixed set but unparsable
result := getDetailsFromEnv("TEST_C3_INT", 42)
assert.Equal(t, 42, result)
})
t.Run("float64: prefixed invalid ignores stale unprefixed value", func(t *testing.T) {
t.Setenv("TEST_C3_FLOAT", "999.0") // stale unprefixed value, must not win
t.Setenv("GMP_TEST_C3_FLOAT", "not-a-number") // prefixed set but unparsable
result := getDetailsFromEnv("TEST_C3_FLOAT", 4.2)
assert.Equal(t, 4.2, result)
})
}
// TestGetDetailsFromEnv_EmptyValueTreatedAsUnset covers the polish fix: an
// explicitly-empty env var (VAR="") must fall back to the coded default,
// the same as an unset var, without emitting an invalid-value warning --
// there is nothing invalid to parse, only a deliberately blank override.
// Uses t.Setenv so each subtest's environment is reset automatically.
func TestGetDetailsFromEnv_EmptyValueTreatedAsUnset(t *testing.T) {
t.Run("int: empty prefixed value falls back to default", func(t *testing.T) {
t.Setenv("GMP_TEST_EMPTY_INT", "")
result := getDetailsFromEnv("TEST_EMPTY_INT", 42)
assert.Equal(t, 42, result)
})
t.Run("int: empty unprefixed value falls back to default", func(t *testing.T) {
t.Setenv("TEST_EMPTY_INT_UNPFX", "")
result := getDetailsFromEnv("TEST_EMPTY_INT_UNPFX", 42)
assert.Equal(t, 42, result)
})
t.Run("float64: empty prefixed value falls back to default", func(t *testing.T) {
t.Setenv("GMP_TEST_EMPTY_FLOAT", "")
result := getDetailsFromEnv("TEST_EMPTY_FLOAT", 2.5)
assert.Equal(t, 2.5, result)
})
t.Run("bool: empty prefixed value falls back to default", func(t *testing.T) {
t.Setenv("GMP_TEST_EMPTY_BOOL", "")
result := getDetailsFromEnv("TEST_EMPTY_BOOL", true)
assert.Equal(t, true, result)
})
t.Run("int: empty prefixed value still falls through to a valid unprefixed value", func(t *testing.T) {
t.Setenv("GMP_TEST_EMPTY_FALLTHROUGH", "")
t.Setenv("TEST_EMPTY_FALLTHROUGH", "7")
result := getDetailsFromEnv("TEST_EMPTY_FALLTHROUGH", 42)
assert.Equal(t, 7, result)
})
}
// TestGetDetailsFromEnv_FloatTrimSpace covers the polish fix: the float64
// path was missing the strings.TrimSpace that the int and bool paths
// already had, so a value like " 1.5 " failed to parse and silently fell
// back to the coded default instead of parsing to 1.5.
func TestGetDetailsFromEnv_FloatTrimSpace(t *testing.T) {
t.Run("prefixed float with surrounding whitespace parses", func(t *testing.T) {
t.Setenv("GMP_TEST_FLOAT_TRIM", " 1.5 ")
result := getDetailsFromEnv("TEST_FLOAT_TRIM", 2.5)
assert.Equal(t, 1.5, result)
})
t.Run("unprefixed float with surrounding whitespace parses", func(t *testing.T) {
t.Setenv("TEST_FLOAT_TRIM_UNPFX", " 1.5 ")
result := getDetailsFromEnv("TEST_FLOAT_TRIM_UNPFX", 2.5)
assert.Equal(t, 1.5, result)
})
}
// TestParseConfig_ClampsInvalidNumericEnv covers C1 (CACHE_TTL) and C14
// (RETRY_BUDGET_TOKENS_PER_SEC): a non-positive value must clamp to the
// coded default instead of crashing the cache cleanup ticker (C1) or
// permanently locking out retry-budget token refills (C14).
func TestParseConfig_ClampsInvalidNumericEnv(t *testing.T) {
tests := []struct {
checkResult func(t *testing.T, c *config)
name string
envKey string
envValue string
}{
{
name: "CACHE_TTL zero clamps to 60s default",
envKey: "CACHE_TTL",
envValue: "0",
checkResult: func(t *testing.T, c *config) {
assert.Equal(t, 60, c.Cache.CacheTTL)
},
},
{
name: "CACHE_TTL negative clamps to 60s default",
envKey: "CACHE_TTL",
envValue: "-5",
checkResult: func(t *testing.T, c *config) {
assert.Equal(t, 60, c.Cache.CacheTTL)
},
},
{
name: "RETRY_BUDGET_TOKENS_PER_SEC zero clamps to 10/s default",
envKey: "RETRY_BUDGET_TOKENS_PER_SEC",
envValue: "0",
checkResult: func(t *testing.T, c *config) {
assert.Equal(t, 10.0, c.RetryBudget.TokensPerSecond)
},
},
{
name: "RETRY_BUDGET_TOKENS_PER_SEC negative clamps to 10/s default",
envKey: "RETRY_BUDGET_TOKENS_PER_SEC",
envValue: "-1.5",
checkResult: func(t *testing.T, c *config) {
assert.Equal(t, 10.0, c.RetryBudget.TokensPerSecond)
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Setenv(tt.envKey, tt.envValue)
cfgMutex.Lock()
cfg = nil
cfgMutex.Unlock()
parseConfig()
cfgMutex.RLock()
c := cfg
cfgMutex.RUnlock()
tt.checkResult(t, c)
assert.Equal(tt.expected, result)
})
}
}
-891
View File
@@ -1,891 +0,0 @@
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"strings"
"sync"
"time"
"github.com/google/uuid"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
"github.com/redis/go-redis/v9"
)
// MetricsAggregator handles distributed metrics collection via Redis
type MetricsAggregator struct {
redisClient *redis.Client
logger *libpack_logger.Logger
instanceID string
publishKey string
ttl time.Duration
publishTimer *time.Ticker
ctx context.Context
cancel context.CancelFunc
mu sync.RWMutex
// wg tracks the publisher goroutine started by startPublishingAsync.
// Shutdown waits on it so it never returns while that goroutine is
// still running (see Shutdown's doc comment).
wg sync.WaitGroup
}
// InstanceMetrics represents metrics for a single proxy instance
type InstanceMetrics struct {
InstanceID string `json:"instance_id"`
Hostname string `json:"hostname"`
LastUpdate time.Time `json:"last_update"`
UptimeSeconds float64 `json:"uptime_seconds"`
Stats map[string]any `json:"stats"`
Cache map[string]any `json:"cache,omitempty"` // Full cache details including memory
CacheSummary map[string]any `json:"cache_summary,omitempty"` // Deprecated: kept for compatibility
Health map[string]any `json:"health"`
CircuitBreaker map[string]any `json:"circuit_breaker,omitempty"`
RetryBudget map[string]any `json:"retry_budget,omitempty"`
Coalescing map[string]any `json:"coalescing,omitempty"`
WebSocketStats map[string]any `json:"websocket,omitempty"`
Connections map[string]any `json:"connections,omitempty"`
}
// AggregatedMetrics represents combined metrics from all instances
type AggregatedMetrics struct {
TotalInstances int `json:"total_instances"`
HealthyInstances int `json:"healthy_instances"`
LastUpdate time.Time `json:"last_update"`
CombinedStats map[string]any `json:"combined_stats"`
Instances []InstanceMetrics `json:"instances"`
PerInstanceStats map[string]InstanceMetrics `json:"per_instance_stats"`
}
var (
metricsAggregator *MetricsAggregator
aggregatorMutex sync.RWMutex
)
// InitializeMetricsAggregator creates and starts the metrics aggregator
func InitializeMetricsAggregator(redisURL, redisPassword string, redisDB int, logger *libpack_logger.Logger) error {
aggregatorMutex.Lock()
defer aggregatorMutex.Unlock()
if metricsAggregator != nil {
return nil // Already initialized
}
// Parse Redis URL
opt, err := redis.ParseURL(fmt.Sprintf("redis://%s/%d", redisURL, redisDB))
if err != nil {
return fmt.Errorf("failed to parse Redis URL: %w", err)
}
if redisPassword != "" {
opt.Password = redisPassword
}
// Create Redis client with connection timeouts
opt.DialTimeout = 2 * time.Second
opt.ReadTimeout = 2 * time.Second
opt.WriteTimeout = 2 * time.Second
opt.PoolTimeout = 3 * time.Second
opt.MaxRetries = 2
client := redis.NewClient(opt)
// Test connection with detailed error reporting
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
if err := client.Ping(ctx).Err(); err != nil {
// Log detailed connection error
if logger != nil {
logger.Error(&libpack_logger.LogMessage{
Message: "❌ CRITICAL: Redis connection test FAILED during initialization",
Pairs: map[string]any{
"error": err.Error(),
"redis_url": redisURL,
"redis_db": redisDB,
"has_password": redisPassword != "",
},
})
}
return fmt.Errorf("failed to connect to Redis: %w", err)
}
// Log successful connection
if logger != nil {
logger.Info(&libpack_logger.LogMessage{
Message: "✓ Redis connection test PASSED",
Pairs: map[string]any{
"redis_url": redisURL,
"redis_db": redisDB,
},
})
}
// Generate unique instance ID (hostname + UUID for uniqueness)
hostname, _ := os.Hostname()
if hostname == "" {
hostname = "unknown"
}
instanceID := fmt.Sprintf("%s-%s", hostname, uuid.New().String()[:8])
ctx, cancel = context.WithCancel(context.Background())
aggregator := &MetricsAggregator{
redisClient: client,
logger: logger,
instanceID: instanceID,
publishKey: "graphql-proxy:metrics:instances",
ttl: 30 * time.Second, // Metrics expire after 30s if not updated
publishTimer: time.NewTicker(5 * time.Second),
ctx: ctx,
cancel: cancel,
}
metricsAggregator = aggregator
// Start publishing metrics
aggregator.startPublishingAsync()
if logger != nil {
logger.Info(&libpack_logger.LogMessage{
Message: "Metrics aggregator initialized",
Pairs: map[string]any{
"instance_id": instanceID,
"redis_url": redisURL,
"publish_key": aggregator.publishKey,
},
})
}
return nil
}
// GetMetricsAggregator returns the singleton instance
func GetMetricsAggregator() *MetricsAggregator {
aggregatorMutex.RLock()
defer aggregatorMutex.RUnlock()
return metricsAggregator
}
// startPublishingAsync launches the publisher goroutine and registers it
// with ma.wg before starting it, so Shutdown can join on it via wg.Wait().
// wg.Add must happen-before the goroutine's wg.Done (WaitGroup's own
// contract), so Add is called here, synchronously in the caller, rather
// than as the first line inside startPublishing.
func (ma *MetricsAggregator) startPublishingAsync() {
ma.wg.Add(1)
go ma.startPublishing()
}
// startPublishing periodically publishes metrics to Redis
func (ma *MetricsAggregator) startPublishing() {
defer ma.wg.Done()
defer ma.publishTimer.Stop()
// Publish immediately on start
ma.publishMetrics()
for {
select {
case <-ma.ctx.Done():
// Shutdown() removes this instance's Redis keys synchronously,
// before it closes the Redis client, so this goroutine must not
// also call removeInstanceMetrics() here: doing so raced
// Shutdown()'s Close() call (the two used the same client
// concurrently with no ordering guarantee) and left the
// instance's key/set-membership behind until TTL expiry.
return
case <-ma.publishTimer.C:
ma.publishMetrics()
}
}
}
// publishMetrics collects current metrics and stores them in Redis
// Note: This is exported for testing/debugging via admin API
func (ma *MetricsAggregator) publishMetrics() {
// Defensive: check if aggregator is still valid
if ma == nil {
return
}
ma.mu.RLock()
defer ma.mu.RUnlock()
// Safety check: ensure global config is initialized
if cfg == nil {
if ma.logger != nil {
ma.logger.Warning(&libpack_logger.LogMessage{
Message: "Cannot publish metrics - global config not initialized yet",
Pairs: map[string]any{
"instance_id": ma.instanceID,
},
})
}
return
}
// Gather all stats using the admin dashboard's method
dashboard := NewAdminDashboard(ma.logger)
allStats := dashboard.gatherAllStats()
if len(allStats) == 0 {
if ma.logger != nil {
ma.logger.Warning(&libpack_logger.LogMessage{
Message: "gatherAllStats returned empty/nil result",
Pairs: map[string]any{
"instance_id": ma.instanceID,
},
})
}
return
}
// Create instance metrics
hostname, _ := os.Hostname()
if hostname == "" {
hostname = "unknown"
}
metrics := InstanceMetrics{
InstanceID: ma.instanceID,
Hostname: hostname,
LastUpdate: time.Now(),
UptimeSeconds: time.Since(startTime).Seconds(),
}
// Extract specific sections - CRITICAL: we must set the correct structure
// Stats should contain the inner stats object with requests, cache_summary, etc.
if stats, ok := allStats["stats"].(map[string]any); ok {
metrics.Stats = stats
// Also extract cache summary separately for easier access (deprecated but kept for compatibility)
if cacheSummary, ok := stats["cache_summary"].(map[string]any); ok {
metrics.CacheSummary = cacheSummary
}
} else {
// Fallback: if stats extraction fails, use empty map
if ma.logger != nil && ma.logger.IsLevelEnabled(libpack_logger.LEVEL_ERROR) {
ma.logger.Error(&libpack_logger.LogMessage{
Message: "Failed to extract stats from allStats - using empty stats",
Pairs: map[string]any{
"instance_id": ma.instanceID,
"allStats_keys": func() []string {
keys := make([]string, 0, len(allStats))
for k := range allStats {
keys = append(keys, k)
}
return keys
}(),
},
})
}
metrics.Stats = make(map[string]any)
}
// Extract full cache details (includes memory usage)
if cache, ok := allStats["cache"].(map[string]any); ok {
metrics.Cache = cache
}
if health, ok := allStats["health"].(map[string]any); ok {
metrics.Health = health
} else {
metrics.Health = make(map[string]any)
}
if cb, ok := allStats["circuit_breaker"].(map[string]any); ok {
metrics.CircuitBreaker = cb
}
if rb, ok := allStats["retry_budget"].(map[string]any); ok {
metrics.RetryBudget = rb
}
if coal, ok := allStats["coalescing"].(map[string]any); ok {
metrics.Coalescing = coal
}
if ws, ok := allStats["websocket"].(map[string]any); ok {
metrics.WebSocketStats = ws
}
if conn, ok := allStats["connections"].(map[string]any); ok {
metrics.Connections = conn
}
// Marshal to JSON
data, err := json.Marshal(metrics)
if err != nil {
if ma.logger != nil {
ma.logger.Error(&libpack_logger.LogMessage{
Message: "Failed to marshal metrics for Redis",
Pairs: map[string]any{"error": err.Error()},
})
}
return
}
// Store in Redis hash with TTL
key := fmt.Sprintf("%s:%s", ma.publishKey, ma.instanceID)
// Create a fresh context with timeout to avoid inheriting cancelled parent context
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
pipe := ma.redisClient.Pipeline()
pipe.Set(ctx, key, data, ma.ttl)
pipe.SAdd(ctx, ma.publishKey, ma.instanceID)
pipe.Expire(ctx, ma.publishKey, ma.ttl*2) // Keep set alive
_, err = pipe.Exec(ctx)
if err != nil {
if ma.logger != nil {
ma.logger.Error(&libpack_logger.LogMessage{
Message: "❌ CRITICAL: Failed to publish metrics to Redis - cluster mode will not work!",
Pairs: map[string]any{
"error": err.Error(),
"instance_id": ma.instanceID,
"key": key,
"redis_key": ma.publishKey,
},
})
}
return
}
}
// removeInstanceMetrics cleans up metrics from Redis on shutdown
func (ma *MetricsAggregator) removeInstanceMetrics() {
// Create a fresh context with timeout for cleanup
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
key := fmt.Sprintf("%s:%s", ma.publishKey, ma.instanceID)
pipe := ma.redisClient.Pipeline()
pipe.Del(ctx, key)
pipe.SRem(ctx, ma.publishKey, ma.instanceID)
_, err := pipe.Exec(ctx)
if err != nil && ma.logger != nil {
ma.logger.Warning(&libpack_logger.LogMessage{
Message: "Failed to remove instance metrics from Redis during shutdown",
Pairs: map[string]any{"instance_id": ma.instanceID, "error": err.Error()},
})
return
}
if ma.logger != nil {
ma.logger.Info(&libpack_logger.LogMessage{
Message: "Removed instance metrics from Redis",
Pairs: map[string]any{"instance_id": ma.instanceID},
})
}
}
// GetAggregatedMetrics retrieves and aggregates metrics from all instances
func (ma *MetricsAggregator) GetAggregatedMetrics() (*AggregatedMetrics, error) {
// Create a fresh context with timeout to avoid inheriting cancelled parent context
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
// Get all instance IDs
instanceIDs, err := ma.redisClient.SMembers(ctx, ma.publishKey).Result()
if err != nil {
return nil, fmt.Errorf("failed to get instance list: %w", err)
}
if len(instanceIDs) == 0 {
return &AggregatedMetrics{
TotalInstances: 0,
HealthyInstances: 0,
LastUpdate: time.Now(),
CombinedStats: make(map[string]any),
Instances: []InstanceMetrics{},
PerInstanceStats: make(map[string]InstanceMetrics),
}, nil
}
// Fetch metrics for all instances
pipe := ma.redisClient.Pipeline()
cmds := make([]*redis.StringCmd, len(instanceIDs))
for i, instanceID := range instanceIDs {
key := fmt.Sprintf("%s:%s", ma.publishKey, instanceID)
cmds[i] = pipe.Get(ctx, key)
}
_, _ = pipe.Exec(ctx) // Errors handled per-command below
// Parse metrics
instances := make([]InstanceMetrics, 0, len(instanceIDs))
perInstance := make(map[string]InstanceMetrics)
healthyCount := 0
staleCount := 0
errorCount := 0
for i, cmd := range cmds {
data, err := cmd.Result()
if err != nil {
errorCount++
// Clean up stale instance ID from the set
if err == redis.Nil {
staleCount++
// Remove stale instance from set in background
go func(instID string) {
cleanupCtx, cleanupCancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cleanupCancel()
ma.redisClient.SRem(cleanupCtx, ma.publishKey, instID)
}(instanceIDs[i])
}
continue
}
var metrics InstanceMetrics
if err := json.Unmarshal([]byte(data), &metrics); err != nil {
if ma.logger != nil {
ma.logger.Warning(&libpack_logger.LogMessage{
Message: "Failed to unmarshal instance metrics",
Pairs: map[string]any{"error": err.Error()},
})
}
continue
}
// Check if instance is stale (not updated in 1 minute)
instanceAge := time.Since(metrics.LastUpdate)
if instanceAge > 1*time.Minute {
staleCount++
// Clean up stale instance from set in background
go func(instID string, age time.Duration) {
cleanupCtx, cleanupCancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cleanupCancel()
ma.redisClient.SRem(cleanupCtx, ma.publishKey, instID)
if ma.logger != nil {
ma.logger.Info(&libpack_logger.LogMessage{
Message: "Removed inactive instance",
Pairs: map[string]any{
"instance_id": instID,
"inactive_seconds": age.Seconds(),
},
})
}
}(instanceIDs[i], instanceAge)
continue // Skip stale instances
}
instances = append(instances, metrics)
perInstance[metrics.InstanceID] = metrics
// Count healthy instances
if health, ok := metrics.Health["status"].(string); ok && health == "healthy" {
healthyCount++
}
}
// Log cleanup stats if we found stale instances
if ma.logger != nil && (staleCount > 0 || errorCount > 0) {
ma.logger.Info(&libpack_logger.LogMessage{
Message: "Cleaned up stale instance IDs from Redis",
Pairs: map[string]any{
"total_in_set": len(instanceIDs),
"valid_instances": len(instances),
"stale_cleaned": staleCount,
"errors": errorCount,
},
})
}
// Aggregate statistics
aggregated := &AggregatedMetrics{
TotalInstances: len(instances),
HealthyInstances: healthyCount,
LastUpdate: time.Now(),
CombinedStats: ma.aggregateStats(instances),
Instances: instances,
PerInstanceStats: perInstance,
}
return aggregated, nil
}
// aggregateStats combines statistics from multiple instances
func (ma *MetricsAggregator) aggregateStats(instances []InstanceMetrics) map[string]any {
if len(instances) == 0 {
if ma.logger != nil {
ma.logger.Warning(&libpack_logger.LogMessage{
Message: "No instances to aggregate",
})
}
return make(map[string]any)
}
// Initialize aggregated values
var (
totalRequests int64
totalSucceeded int64
totalFailed int64
totalSkipped int64
totalCacheHits int64
totalCacheMisses int64
totalCachedQueries int64
totalMemoryUsageMB float64
hasValidMemoryStats bool // Track if any instance has valid memory stats
totalCurrentRPS float64
totalAvgRPS float64
totalActiveConnections int64
totalWSConnections int64
totalCoalescedRequests int64
totalPrimaryRequests int64
oldestUptime float64
// Retry budget stats
totalRetryAllowed int64
totalRetryDenied int64
totalRetryAttempts int64
totalCurrentTokens int64
totalMaxTokens int64
retryBudgetEnabled = false
retryTokensPerSec float64 // Use max tokens_per_sec from any instance
// Circuit breaker stats
cbOpenCount int
cbHalfOpenCount int
cbClosedCount int
circuitBreakerEnabled = false
)
for idx, instance := range instances {
// Track oldest uptime for cluster uptime
if oldestUptime == 0 || instance.UptimeSeconds < oldestUptime {
oldestUptime = instance.UptimeSeconds
}
// Aggregate request stats
if instance.Stats == nil {
if ma.logger != nil {
ma.logger.Warning(&libpack_logger.LogMessage{
Message: "Instance has nil Stats",
Pairs: map[string]any{
"instance_id": instance.InstanceID,
"index": idx,
},
})
}
continue
}
if stats, ok := instance.Stats["requests"].(map[string]any); ok {
if total, ok := stats["total"].(float64); ok {
totalRequests += int64(total)
}
if succeeded, ok := stats["succeeded"].(float64); ok {
totalSucceeded += int64(succeeded)
}
if failed, ok := stats["failed"].(float64); ok {
totalFailed += int64(failed)
}
if skipped, ok := stats["skipped"].(float64); ok {
totalSkipped += int64(skipped)
}
if currentRPS, ok := stats["current_requests_per_second"].(float64); ok {
totalCurrentRPS += currentRPS
}
if avgRPS, ok := stats["avg_requests_per_second"].(float64); ok {
totalAvgRPS += avgRPS
}
} else {
if ma.logger != nil && ma.logger.IsLevelEnabled(libpack_logger.LEVEL_WARN) {
// Log what keys are actually in Stats for debugging
keys := make([]string, 0, len(instance.Stats))
for k := range instance.Stats {
keys = append(keys, k)
}
ma.logger.Warning(&libpack_logger.LogMessage{
Message: "Instance Stats missing 'requests' key",
Pairs: map[string]any{
"instance_id": instance.InstanceID,
"stats_keys": keys,
"index": idx,
},
})
}
}
// Aggregate cache stats from CacheSummary (backward compatibility)
if len(instance.CacheSummary) > 0 {
if hits, ok := instance.CacheSummary["hits"].(float64); ok {
totalCacheHits += int64(hits)
}
if misses, ok := instance.CacheSummary["misses"].(float64); ok {
totalCacheMisses += int64(misses)
}
if cached, ok := instance.CacheSummary["total_cached"].(float64); ok {
totalCachedQueries += int64(cached)
}
}
// Aggregate memory usage from full cache details
// Skip -1 values which indicate Redis cache (memory tracking not available)
if len(instance.Cache) > 0 {
if memMB, ok := instance.Cache["memory_usage_mb"].(float64); ok && memMB >= 0 {
totalMemoryUsageMB += memMB
hasValidMemoryStats = true
}
}
// Aggregate connection stats
if len(instance.Connections) > 0 {
if active, ok := instance.Connections["active_connections"].(float64); ok {
totalActiveConnections += int64(active)
}
}
// Aggregate WebSocket connections
if len(instance.WebSocketStats) > 0 {
if active, ok := instance.WebSocketStats["active_connections"].(float64); ok {
totalWSConnections += int64(active)
}
}
// Aggregate coalescing stats
if len(instance.Coalescing) > 0 {
if coalesced, ok := instance.Coalescing["coalesced_requests"].(float64); ok {
totalCoalescedRequests += int64(coalesced)
}
if primary, ok := instance.Coalescing["primary_requests"].(float64); ok {
totalPrimaryRequests += int64(primary)
}
}
// Aggregate retry budget stats
if len(instance.RetryBudget) > 0 {
if enabled, ok := instance.RetryBudget["enabled"].(bool); ok && enabled {
retryBudgetEnabled = true
}
if allowed, ok := instance.RetryBudget["allowed_retries"].(float64); ok {
totalRetryAllowed += int64(allowed)
}
if denied, ok := instance.RetryBudget["denied_retries"].(float64); ok {
totalRetryDenied += int64(denied)
}
if attempts, ok := instance.RetryBudget["total_attempts"].(float64); ok {
totalRetryAttempts += int64(attempts)
}
if currentTokens, ok := instance.RetryBudget["current_tokens"].(float64); ok {
totalCurrentTokens += int64(currentTokens)
}
if maxTokens, ok := instance.RetryBudget["max_tokens"].(float64); ok {
totalMaxTokens += int64(maxTokens)
}
if tokensPerSec, ok := instance.RetryBudget["tokens_per_sec"].(float64); ok {
if tokensPerSec > retryTokensPerSec {
retryTokensPerSec = tokensPerSec
}
}
}
// Aggregate circuit breaker stats
if len(instance.CircuitBreaker) > 0 {
if enabled, ok := instance.CircuitBreaker["enabled"].(bool); ok && enabled {
circuitBreakerEnabled = true
}
if state, ok := instance.CircuitBreaker["state"].(string); ok {
switch state {
case "open":
cbOpenCount++
case "half-open":
cbHalfOpenCount++
case "closed":
cbClosedCount++
}
}
}
}
// Calculate derived metrics
successRate := 0.0
if totalRequests > 0 {
successRate = float64(totalSucceeded) / float64(totalRequests) * 100
}
cacheHitRate := 0.0
totalCacheRequests := totalCacheHits + totalCacheMisses
if totalCacheRequests > 0 {
cacheHitRate = float64(totalCacheHits) / float64(totalCacheRequests) * 100
}
backendSavings := 0.0
totalCoalRequests := totalCoalescedRequests + totalPrimaryRequests
if totalCoalRequests > 0 {
backendSavings = float64(totalCoalescedRequests) / float64(totalCoalRequests) * 100
}
// Calculate retry budget denial rate
retryDenialRate := 0.0
if totalRetryAttempts > 0 {
retryDenialRate = float64(totalRetryDenied) / float64(totalRetryAttempts) * 100
}
// Determine overall circuit breaker state
cbState := "unknown"
if circuitBreakerEnabled {
if cbOpenCount > 0 {
cbState = "open" // If any instance is open, cluster is in degraded state
} else if cbHalfOpenCount > 0 {
cbState = "half-open"
} else if cbClosedCount > 0 {
cbState = "closed"
}
}
result := map[string]any{
"cluster_mode": true,
"total_instances": len(instances),
"cluster_uptime": oldestUptime,
"requests": map[string]any{
"total": totalRequests,
"succeeded": totalSucceeded,
"failed": totalFailed,
"skipped": totalSkipped,
"success_rate_pct": successRate,
"current_requests_per_second": totalCurrentRPS,
"avg_requests_per_second": totalAvgRPS,
},
"cache_summary": map[string]any{
"hits": totalCacheHits,
"misses": totalCacheMisses,
"hit_rate_pct": cacheHitRate,
"total_cached": totalCachedQueries,
},
"memory": map[string]any{
"total_usage_mb": func() float64 {
if hasValidMemoryStats {
return totalMemoryUsageMB
}
return -1
}(),
"available": hasValidMemoryStats,
},
"connections": map[string]any{
"total_active": totalActiveConnections,
},
"websocket": map[string]any{
"total_connections": totalWSConnections,
},
"coalescing": map[string]any{
"enabled": len(instances) > 0, // enabled if we have instances with data
"total_coalesced_requests": totalCoalescedRequests,
"total_primary_requests": totalPrimaryRequests,
"backend_savings_pct": backendSavings,
"coalescing_rate_pct": backendSavings,
},
"retry_budget": map[string]any{
"enabled": retryBudgetEnabled,
"allowed_retries": totalRetryAllowed,
"denied_retries": totalRetryDenied,
"total_attempts": totalRetryAttempts,
"denial_rate_pct": retryDenialRate,
"current_tokens": totalCurrentTokens,
"max_tokens": totalMaxTokens,
"tokens_per_sec": retryTokensPerSec,
},
"circuit_breaker": map[string]any{
"enabled": circuitBreakerEnabled,
"state": cbState,
"instances_open": cbOpenCount,
"instances_closed": cbClosedCount,
"instances_halfopen": cbHalfOpenCount,
},
}
return result
}
// Shutdown stops the metrics aggregator.
//
// It cancels the publisher goroutine, synchronously removes this instance's
// Redis keys via removeInstanceMetrics (so the removal always completes
// before the Redis client closes, instead of racing it), waits for the
// publisher goroutine (started by startPublishingAsync) to fully exit, and
// clears the package-level singleton if this instance is currently
// registered as it, so a later InitializeMetricsAggregator call creates a
// fresh instance rather than silently no-oping against a closed client.
//
// ma.mu is held only across cancel/removeInstanceMetrics/Close, not across
// wg.Wait() or the aggregatorMutex update below. publishMetrics is the only
// other user of ma.mu (via RLock), and it is only ever invoked by the
// publisher goroutine. Holding ma.mu across wg.Wait() would deadlock: a
// publishMetrics call that raced the ctx-cancellation select (picked the
// timer case just as cancel() ran) blocks on ma.mu.RLock() until Shutdown
// unlocks, so waiting for that same goroutine to exit while still holding
// the write lock would wait forever. Unlocking before wg.Wait() avoids that.
// The straggler is still safe: it can only resume after Unlock(), by which
// point Close() has already run (still inside the lock, unchanged from
// before), so it hits a closed client and fails fast instead of
// resurrecting the instance key removeInstanceMetrics just deleted.
// wg.Wait() then blocks Shutdown from returning until the goroutine has
// truly exited, closing the window where it reads the package-level cfg
// after a caller has already reset it.
func (ma *MetricsAggregator) Shutdown() {
ma.mu.Lock()
if ma.cancel != nil {
ma.cancel()
}
// Remove this instance's key and set membership before closing the
// client so the cleanup cannot race Close() (see startPublishing).
ma.removeInstanceMetrics()
if ma.redisClient != nil {
_ = ma.redisClient.Close() // Best-effort cleanup
}
if ma.logger != nil {
ma.logger.Info(&libpack_logger.LogMessage{
Message: "Metrics aggregator shut down",
})
}
ma.mu.Unlock()
// Join the publisher goroutine. Must happen unlocked - see doc comment.
ma.wg.Wait()
// Clear the singleton only if this instance is still registered as it;
// a test-constructed or already-replaced instance must not clobber a
// different, currently-active aggregator.
aggregatorMutex.Lock()
if metricsAggregator == ma {
metricsAggregator = nil
}
aggregatorMutex.Unlock()
}
// GetInstanceID returns the current instance ID
func (ma *MetricsAggregator) GetInstanceID() string {
return ma.instanceID
}
// IsClusterMode returns true if multiple instances are detected
func (ma *MetricsAggregator) IsClusterMode() bool {
// Create a fresh context with timeout to avoid inheriting cancelled parent context
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
count, err := ma.redisClient.SCard(ctx, ma.publishKey).Result()
if err != nil {
return false
}
return count > 1
}
// GetInstanceHostname returns a human-readable instance identifier
func GetInstanceHostname() string {
hostname, _ := os.Hostname()
if hostname == "" {
hostname = "unknown"
}
// Remove domain suffix for cleaner display
if idx := strings.Index(hostname, "."); idx > 0 {
hostname = hostname[:idx]
}
return hostname
}
-737
View File
@@ -1,737 +0,0 @@
package main
import (
"context"
"encoding/json"
"fmt"
"testing"
"time"
"github.com/alicebob/miniredis/v2"
libpack_logger "github.com/lukaszraczylo/graphql-monitoring-proxy/logging"
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
"github.com/redis/go-redis/v9"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// newTestAggregator spins up a miniredis, creates a redis.Client against it,
// and returns a MetricsAggregator wired to that client.
// The caller must call t.Cleanup to shut down the aggregator and the server.
func newTestAggregator(t *testing.T) (*MetricsAggregator, *miniredis.Miniredis) {
t.Helper()
mr, err := miniredis.Run()
require.NoError(t, err, "miniredis.Run")
client := redis.NewClient(&redis.Options{
Addr: mr.Addr(),
})
ctx, cancel := context.WithCancel(context.Background())
ma := &MetricsAggregator{
redisClient: client,
logger: libpack_logger.New(),
instanceID: "test-instance-001",
publishKey: "graphql-proxy:metrics:instances",
ttl: 30 * time.Second,
publishTimer: time.NewTicker(100 * time.Millisecond),
ctx: ctx,
cancel: cancel,
}
t.Cleanup(func() {
ma.Shutdown()
mr.Close()
})
return ma, mr
}
// minimalCfg sets the package-level cfg to a minimal valid value so publishMetrics
// does not bail out on the nil-cfg guard. Restores the original on cleanup.
func minimalCfg(t *testing.T) {
t.Helper()
old := cfg
cfgMutex.Lock()
cfg = &config{
Logger: libpack_logger.New(),
Monitoring: libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{}),
}
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg = old
cfgMutex.Unlock()
})
}
// ----- InitializeMetricsAggregator ----------------------------------------
func TestMetricsAggregator_InitializeMetricsAggregator_AlreadyInitialized(t *testing.T) {
// If the singleton is already set, Init must be a no-op and return nil.
mr, err := miniredis.Run()
require.NoError(t, err)
defer mr.Close()
client := redis.NewClient(&redis.Options{Addr: mr.Addr()})
ctx, cancel := context.WithCancel(context.Background())
existing := &MetricsAggregator{
redisClient: client,
instanceID: "existing",
publishKey: "graphql-proxy:metrics:instances",
ttl: 30 * time.Second,
publishTimer: time.NewTicker(time.Hour),
ctx: ctx,
cancel: cancel,
}
// Inject singleton directly (bypass constructor).
aggregatorMutex.Lock()
old := metricsAggregator
metricsAggregator = existing
aggregatorMutex.Unlock()
t.Cleanup(func() {
aggregatorMutex.Lock()
metricsAggregator = old
aggregatorMutex.Unlock()
existing.publishTimer.Stop()
cancel()
_ = client.Close()
})
err = InitializeMetricsAggregator(mr.Addr(), "", 0, libpack_logger.New())
assert.NoError(t, err, "should return nil when already initialized")
// Singleton must still be the original instance.
aggregatorMutex.RLock()
got := metricsAggregator
aggregatorMutex.RUnlock()
assert.Equal(t, existing, got, "singleton must not be replaced")
}
func TestMetricsAggregator_InitializeMetricsAggregator_BadURL(t *testing.T) {
// Ensure the singleton is clear for this sub-test.
aggregatorMutex.Lock()
old := metricsAggregator
metricsAggregator = nil
aggregatorMutex.Unlock()
t.Cleanup(func() {
// Shutdown() itself acquires aggregatorMutex (to clear the singleton
// if it owns it), so it must not be called while this goroutine
// already holds that lock - grab-and-release first, then call
// Shutdown() unlocked.
aggregatorMutex.Lock()
current := metricsAggregator
metricsAggregator = old
aggregatorMutex.Unlock()
if current != nil {
current.Shutdown()
}
})
// An unreachable address should cause Ping to fail and return an error.
err := InitializeMetricsAggregator("127.0.0.1:1", "", 0, nil)
assert.Error(t, err, "should fail when Redis is unreachable")
}
// ----- removeInstanceMetrics -----------------------------------------------
func TestMetricsAggregator_RemoveInstanceMetrics_CleansKeys(t *testing.T) {
ma, mr := newTestAggregator(t)
ctx := context.Background()
// Pre-populate keys that removeInstanceMetrics should delete.
key := fmt.Sprintf("%s:%s", ma.publishKey, ma.instanceID)
err := mr.Set(key, `{"instance_id":"test-instance-001"}`)
require.NoError(t, err)
err = ma.redisClient.SAdd(ctx, ma.publishKey, ma.instanceID).Err()
require.NoError(t, err)
// Verify keys exist before removal.
exists, err := ma.redisClient.Exists(ctx, key).Result()
require.NoError(t, err)
assert.Equal(t, int64(1), exists, "key should exist before removal")
ma.removeInstanceMetrics()
// Verify instance key is gone.
exists, err = ma.redisClient.Exists(ctx, key).Result()
require.NoError(t, err)
assert.Equal(t, int64(0), exists, "key should be deleted after removeInstanceMetrics")
// Verify instance ID removed from the set.
isMember, err := ma.redisClient.SIsMember(ctx, ma.publishKey, ma.instanceID).Result()
require.NoError(t, err)
assert.False(t, isMember, "instanceID should be removed from the set")
}
// ----- publishMetrics -------------------------------------------------------
func TestMetricsAggregator_PublishMetrics_WritesRedisKey(t *testing.T) {
minimalCfg(t)
ma, _ := newTestAggregator(t)
ma.publishMetrics()
ctx := context.Background()
key := fmt.Sprintf("%s:%s", ma.publishKey, ma.instanceID)
val, err := ma.redisClient.Get(ctx, key).Result()
require.NoError(t, err, "publishMetrics should have written the key to Redis")
assert.NotEmpty(t, val, "stored value must not be empty")
// Must be valid JSON.
var im InstanceMetrics
require.NoError(t, json.Unmarshal([]byte(val), &im), "stored value must be valid JSON")
assert.Equal(t, ma.instanceID, im.InstanceID)
}
func TestMetricsAggregator_PublishMetrics_NilCfgNoWrite(t *testing.T) {
// Ensure cfg is nil so publishMetrics bails out early.
cfgMutex.Lock()
old := cfg
cfg = nil
cfgMutex.Unlock()
t.Cleanup(func() {
cfgMutex.Lock()
cfg = old
cfgMutex.Unlock()
})
ma, _ := newTestAggregator(t)
ma.publishMetrics() // Must not panic.
ctx := context.Background()
key := fmt.Sprintf("%s:%s", ma.publishKey, ma.instanceID)
exists, err := ma.redisClient.Exists(ctx, key).Result()
require.NoError(t, err)
assert.Equal(t, int64(0), exists, "no key should be written when cfg is nil")
}
// ----- startPublishing (one tick) ------------------------------------------
func TestMetricsAggregator_StartPublishing_PublishesOnStart(t *testing.T) {
minimalCfg(t)
ma, _ := newTestAggregator(t)
// Run startPublishing in background; it calls publishMetrics immediately.
ma.startPublishingAsync()
// Give the initial synchronous publish time to complete, then cancel.
time.Sleep(80 * time.Millisecond)
ma.cancel()
// Allow the goroutine to finish cleanup.
time.Sleep(50 * time.Millisecond)
ctx := context.Background()
key := fmt.Sprintf("%s:%s", ma.publishKey, ma.instanceID)
val, err := ma.redisClient.Get(ctx, key).Result()
// After startPublishing runs publishMetrics on start, the key must be present
// (unless cfg is nil — but we set it above). If removeInstanceMetrics ran on
// shutdown it deletes the key; that is fine — what we assert is no panic + the
// goroutine exits cleanly (verified by the race detector).
_ = val
_ = err
// Primary assertion: no goroutine leak (race detector) and no panic.
}
// ----- GetAggregatedMetrics ------------------------------------------------
func TestMetricsAggregator_GetAggregatedMetrics_EmptySet(t *testing.T) {
ma, _ := newTestAggregator(t)
result, err := ma.GetAggregatedMetrics()
require.NoError(t, err)
assert.NotNil(t, result)
assert.Equal(t, 0, result.TotalInstances)
assert.Equal(t, 0, result.HealthyInstances)
assert.Empty(t, result.Instances)
}
func TestMetricsAggregator_GetAggregatedMetrics_TwoInstances_Aggregated(t *testing.T) {
ma, _ := newTestAggregator(t)
ctx := context.Background()
instances := []InstanceMetrics{
{
InstanceID: "inst-A",
Hostname: "host-a",
LastUpdate: time.Now(),
UptimeSeconds: 120,
Stats: map[string]any{
"requests": map[string]any{
"total": float64(100),
"succeeded": float64(95),
"failed": float64(5),
"skipped": float64(0),
"current_requests_per_second": float64(10),
"avg_requests_per_second": float64(8),
},
},
Health: map[string]any{"status": "healthy"},
},
{
InstanceID: "inst-B",
Hostname: "host-b",
LastUpdate: time.Now(),
UptimeSeconds: 60,
Stats: map[string]any{
"requests": map[string]any{
"total": float64(200),
"succeeded": float64(180),
"failed": float64(20),
"skipped": float64(0),
"current_requests_per_second": float64(20),
"avg_requests_per_second": float64(15),
},
},
Health: map[string]any{"status": "healthy"},
},
}
for _, inst := range instances {
data, err := json.Marshal(inst)
require.NoError(t, err)
key := fmt.Sprintf("%s:%s", ma.publishKey, inst.InstanceID)
pipe := ma.redisClient.Pipeline()
pipe.Set(ctx, key, data, 30*time.Second)
pipe.SAdd(ctx, ma.publishKey, inst.InstanceID)
_, err = pipe.Exec(ctx)
require.NoError(t, err)
}
result, err := ma.GetAggregatedMetrics()
require.NoError(t, err)
require.NotNil(t, result)
assert.Equal(t, 2, result.TotalInstances)
assert.Equal(t, 2, result.HealthyInstances)
assert.Len(t, result.Instances, 2)
// CombinedStats.requests.total must be sum of both.
reqs, ok := result.CombinedStats["requests"].(map[string]any)
require.True(t, ok, "combined_stats.requests must be present")
assert.Equal(t, int64(300), reqs["total"])
assert.Equal(t, int64(275), reqs["succeeded"])
assert.Equal(t, int64(25), reqs["failed"])
}
func TestMetricsAggregator_GetAggregatedMetrics_StaleInstanceSkipped(t *testing.T) {
ma, _ := newTestAggregator(t)
ctx := context.Background()
stale := InstanceMetrics{
InstanceID: "stale-inst",
Hostname: "host-stale",
LastUpdate: time.Now().Add(-2 * time.Minute), // older than 1 minute threshold
UptimeSeconds: 9999,
Stats: map[string]any{},
Health: map[string]any{"status": "healthy"},
}
data, err := json.Marshal(stale)
require.NoError(t, err)
key := fmt.Sprintf("%s:%s", ma.publishKey, stale.InstanceID)
pipe := ma.redisClient.Pipeline()
pipe.Set(ctx, key, data, 30*time.Second)
pipe.SAdd(ctx, ma.publishKey, stale.InstanceID)
_, err = pipe.Exec(ctx)
require.NoError(t, err)
result, err := ma.GetAggregatedMetrics()
require.NoError(t, err)
require.NotNil(t, result)
assert.Equal(t, 0, result.TotalInstances, "stale instance should be excluded")
}
// ----- aggregateStats -------------------------------------------------------
func TestMetricsAggregator_AggregateStats_EmptyInstances(t *testing.T) {
ma, _ := newTestAggregator(t)
result := ma.aggregateStats([]InstanceMetrics{})
assert.NotNil(t, result)
assert.Empty(t, result, "empty input should return empty map")
}
func TestMetricsAggregator_AggregateStats_SingleInstance(t *testing.T) {
ma, _ := newTestAggregator(t)
instances := []InstanceMetrics{
{
InstanceID: "inst-1",
UptimeSeconds: 300,
Stats: map[string]any{
"requests": map[string]any{
"total": float64(50),
"succeeded": float64(45),
"failed": float64(5),
"skipped": float64(2),
"current_requests_per_second": float64(5),
"avg_requests_per_second": float64(4),
},
},
CacheSummary: map[string]any{
"hits": float64(30),
"misses": float64(20),
"total_cached": float64(10),
},
Health: map[string]any{"status": "healthy"},
},
}
result := ma.aggregateStats(instances)
require.NotEmpty(t, result)
reqs, ok := result["requests"].(map[string]any)
require.True(t, ok)
assert.Equal(t, int64(50), reqs["total"])
assert.Equal(t, int64(45), reqs["succeeded"])
assert.Equal(t, int64(5), reqs["failed"])
cache, ok := result["cache_summary"].(map[string]any)
require.True(t, ok)
assert.Equal(t, int64(30), cache["hits"])
assert.Equal(t, int64(20), cache["misses"])
// success_rate: 45/50 * 100 = 90%
successRate, ok := reqs["success_rate_pct"].(float64)
require.True(t, ok)
assert.InDelta(t, 90.0, successRate, 0.01)
}
func TestMetricsAggregator_AggregateStats_MultipleInstances_Sums(t *testing.T) {
ma, _ := newTestAggregator(t)
instances := []InstanceMetrics{
{
InstanceID: "inst-1",
UptimeSeconds: 100,
Stats: map[string]any{
"requests": map[string]any{
"total": float64(100),
"succeeded": float64(90),
"failed": float64(10),
"skipped": float64(0),
"current_requests_per_second": float64(10),
"avg_requests_per_second": float64(8),
},
},
Health: map[string]any{"status": "healthy"},
},
{
InstanceID: "inst-2",
UptimeSeconds: 200,
Stats: map[string]any{
"requests": map[string]any{
"total": float64(400),
"succeeded": float64(360),
"failed": float64(40),
"skipped": float64(0),
"current_requests_per_second": float64(40),
"avg_requests_per_second": float64(30),
},
},
Health: map[string]any{"status": "degraded"},
},
}
result := ma.aggregateStats(instances)
require.NotEmpty(t, result)
reqs := result["requests"].(map[string]any)
assert.Equal(t, int64(500), reqs["total"])
assert.Equal(t, int64(450), reqs["succeeded"])
assert.Equal(t, int64(50), reqs["failed"])
// cluster_uptime should be the oldest (smallest) uptime = 100.
assert.Equal(t, float64(100), result["cluster_uptime"])
assert.Equal(t, 2, result["total_instances"])
}
func TestMetricsAggregator_AggregateStats_CircuitBreaker(t *testing.T) {
ma, _ := newTestAggregator(t)
instances := []InstanceMetrics{
{
InstanceID: "inst-open",
UptimeSeconds: 50,
Stats: map[string]any{"requests": map[string]any{"total": float64(10), "succeeded": float64(5), "failed": float64(5), "skipped": float64(0), "current_requests_per_second": float64(1), "avg_requests_per_second": float64(1)}},
CircuitBreaker: map[string]any{
"enabled": true,
"state": "open",
},
Health: map[string]any{},
},
{
InstanceID: "inst-closed",
UptimeSeconds: 60,
Stats: map[string]any{"requests": map[string]any{"total": float64(10), "succeeded": float64(10), "failed": float64(0), "skipped": float64(0), "current_requests_per_second": float64(1), "avg_requests_per_second": float64(1)}},
CircuitBreaker: map[string]any{
"enabled": true,
"state": "closed",
},
Health: map[string]any{},
},
}
result := ma.aggregateStats(instances)
cb := result["circuit_breaker"].(map[string]any)
assert.Equal(t, true, cb["enabled"])
assert.Equal(t, "open", cb["state"], "any open instance means cluster state = open")
assert.Equal(t, 1, cb["instances_open"])
assert.Equal(t, 1, cb["instances_closed"])
}
func TestMetricsAggregator_AggregateStats_RetryBudget(t *testing.T) {
ma, _ := newTestAggregator(t)
instances := []InstanceMetrics{
{
InstanceID: "inst-rb",
UptimeSeconds: 10,
Stats: map[string]any{"requests": map[string]any{"total": float64(1), "succeeded": float64(1), "failed": float64(0), "skipped": float64(0), "current_requests_per_second": float64(0), "avg_requests_per_second": float64(0)}},
RetryBudget: map[string]any{
"enabled": true,
"allowed_retries": float64(50),
"denied_retries": float64(10),
"total_attempts": float64(60),
"current_tokens": float64(80),
"max_tokens": float64(100),
"tokens_per_sec": float64(5),
},
Health: map[string]any{},
},
}
result := ma.aggregateStats(instances)
rb := result["retry_budget"].(map[string]any)
assert.Equal(t, true, rb["enabled"])
assert.Equal(t, int64(50), rb["allowed_retries"])
assert.Equal(t, int64(10), rb["denied_retries"])
assert.InDelta(t, 16.67, rb["denial_rate_pct"].(float64), 0.1)
}
func TestMetricsAggregator_AggregateStats_NilStats_DoesNotPanic(t *testing.T) {
ma, _ := newTestAggregator(t)
// Instance with nil Stats should not cause a panic; it is skipped.
instances := []InstanceMetrics{
{
InstanceID: "bad-inst",
UptimeSeconds: 10,
Stats: nil,
Health: map[string]any{},
},
}
assert.NotPanics(t, func() {
result := ma.aggregateStats(instances)
// cluster_uptime is set before the nil-stats guard, so it must be non-zero.
assert.Equal(t, float64(10), result["cluster_uptime"])
})
}
func TestMetricsAggregator_AggregateStats_MemoryTracking(t *testing.T) {
ma, _ := newTestAggregator(t)
instances := []InstanceMetrics{
{
InstanceID: "inst-mem",
UptimeSeconds: 10,
Stats: map[string]any{"requests": map[string]any{"total": float64(1), "succeeded": float64(1), "failed": float64(0), "skipped": float64(0), "current_requests_per_second": float64(0), "avg_requests_per_second": float64(0)}},
Cache: map[string]any{"memory_usage_mb": float64(42.5)},
Health: map[string]any{},
},
{
InstanceID: "inst-mem2",
UptimeSeconds: 20,
Stats: map[string]any{"requests": map[string]any{"total": float64(1), "succeeded": float64(1), "failed": float64(0), "skipped": float64(0), "current_requests_per_second": float64(0), "avg_requests_per_second": float64(0)}},
Cache: map[string]any{"memory_usage_mb": float64(57.5)},
Health: map[string]any{},
},
}
result := ma.aggregateStats(instances)
mem := result["memory"].(map[string]any)
assert.Equal(t, true, mem["available"])
assert.InDelta(t, 100.0, mem["total_usage_mb"].(float64), 0.01)
}
func TestMetricsAggregator_AggregateStats_MemoryNegativeSkipped(t *testing.T) {
ma, _ := newTestAggregator(t)
// -1 means Redis cache where memory tracking is unavailable; must be skipped.
instances := []InstanceMetrics{
{
InstanceID: "inst-redis-cache",
UptimeSeconds: 10,
Stats: map[string]any{"requests": map[string]any{"total": float64(1), "succeeded": float64(1), "failed": float64(0), "skipped": float64(0), "current_requests_per_second": float64(0), "avg_requests_per_second": float64(0)}},
Cache: map[string]any{"memory_usage_mb": float64(-1)},
Health: map[string]any{},
},
}
result := ma.aggregateStats(instances)
mem := result["memory"].(map[string]any)
assert.Equal(t, false, mem["available"])
assert.Equal(t, float64(-1), mem["total_usage_mb"].(float64))
}
// ----- Shutdown ------------------------------------------------------------
func TestMetricsAggregator_Shutdown_CancelsContext(t *testing.T) {
mr, err := miniredis.Run()
require.NoError(t, err)
t.Cleanup(func() { mr.Close() })
client := redis.NewClient(&redis.Options{Addr: mr.Addr()})
ctx, cancel := context.WithCancel(context.Background())
ma := &MetricsAggregator{
redisClient: client,
logger: libpack_logger.New(),
instanceID: "shutdown-test",
publishKey: "graphql-proxy:metrics:instances",
ttl: 30 * time.Second,
publishTimer: time.NewTicker(time.Hour),
ctx: ctx,
cancel: cancel,
}
// Context must not be done before Shutdown.
select {
case <-ctx.Done():
t.Fatal("context should not be done before Shutdown()")
default:
}
ma.Shutdown()
// Context must be cancelled after Shutdown.
select {
case <-ctx.Done():
// expected
case <-time.After(500 * time.Millisecond):
t.Fatal("context was not cancelled after Shutdown()")
}
}
func TestMetricsAggregator_Shutdown_Idempotent(t *testing.T) {
ma, _ := newTestAggregator(t)
// Calling Shutdown twice must not panic.
assert.NotPanics(t, func() {
ma.Shutdown()
ma.Shutdown()
})
}
// TestMetricsAggregator_Shutdown_RemovesInstanceMetricsBeforeClose is the L3
// regression test. It runs the real publisher goroutine (as
// InitializeMetricsAggregator does) with a tight publish interval to provoke
// the shutdown-ordering race, then asserts the instance's key and set
// membership are gone the moment Shutdown() returns - not left lingering
// until Redis TTL expiry.
func TestMetricsAggregator_Shutdown_RemovesInstanceMetricsBeforeClose(t *testing.T) {
minimalCfg(t)
mr, err := miniredis.Run()
require.NoError(t, err)
t.Cleanup(func() { mr.Close() })
client := redis.NewClient(&redis.Options{Addr: mr.Addr()})
ctx, cancel := context.WithCancel(context.Background())
ma := &MetricsAggregator{
redisClient: client,
logger: libpack_logger.New(),
instanceID: "shutdown-race-test",
publishKey: "graphql-proxy:metrics:instances",
ttl: 30 * time.Second,
publishTimer: time.NewTicker(5 * time.Millisecond), // tight interval to provoke the race
ctx: ctx,
cancel: cancel,
}
// Run the publisher goroutine exactly like InitializeMetricsAggregator does.
ma.startPublishingAsync()
// Let it publish at least once so the key/set-membership exist before shutdown.
time.Sleep(30 * time.Millisecond)
ma.Shutdown()
// Give the (now-exiting) publisher goroutine a moment to observe
// ctx.Done(); the race detector will flag it if it still touches Redis.
time.Sleep(30 * time.Millisecond)
key := fmt.Sprintf("%s:%s", ma.publishKey, ma.instanceID)
// Query miniredis directly - ma.redisClient is closed by now.
assert.False(t, mr.Exists(key), "instance key must be removed before Shutdown returns, not left lingering until TTL")
// SREM-ing the only member deletes the set key itself (matches real
// Redis semantics for empty collections), so the set key must be gone.
assert.False(t, mr.Exists(ma.publishKey), "instance must be removed from the cluster set before Shutdown returns")
// Confirm the client really is closed - proves the cleanup ran before
// Close(), not that Close() never happened.
closedErr := ma.redisClient.Ping(context.Background()).Err()
assert.Error(t, closedErr, "redis client must be closed after Shutdown")
}
// TestMetricsAggregator_Shutdown_ClearsSingleton_AllowsReinit is the L6
// regression test: Shutdown() must clear the package-level singleton so a
// later InitializeMetricsAggregator call produces a fresh, usable instance
// instead of silently no-oping against the closed one.
func TestMetricsAggregator_Shutdown_ClearsSingleton_AllowsReinit(t *testing.T) {
// Register mr.Close() before the singleton-restore cleanup below: t.Cleanup
// runs LIFO, and the restore cleanup calls Shutdown() on the live instance,
// which needs a still-running Redis server. Registering mr.Close() first
// means it runs last, after that Shutdown() call has completed.
mr, err := miniredis.Run()
require.NoError(t, err)
t.Cleanup(func() { mr.Close() })
aggregatorMutex.Lock()
old := metricsAggregator
metricsAggregator = nil
aggregatorMutex.Unlock()
t.Cleanup(func() {
// Grab-and-release before calling Shutdown(): Shutdown() itself
// locks aggregatorMutex, so it must not be invoked while this
// goroutine still holds it.
aggregatorMutex.Lock()
current := metricsAggregator
metricsAggregator = old
aggregatorMutex.Unlock()
if current != nil {
current.Shutdown()
}
})
require.NoError(t, InitializeMetricsAggregator(mr.Addr(), "", 0, libpack_logger.New()))
first := GetMetricsAggregator()
require.NotNil(t, first, "first Initialize must produce a usable aggregator")
first.Shutdown()
assert.Nil(t, GetMetricsAggregator(), "singleton must be cleared after Shutdown so a closed instance is never returned again")
require.NoError(t, InitializeMetricsAggregator(mr.Addr(), "", 0, libpack_logger.New()), "re-Initialize after Shutdown must succeed, not silently no-op")
second := GetMetricsAggregator()
require.NotNil(t, second)
assert.NotSame(t, first, second, "re-Initialize must produce a fresh instance, not the closed one")
// The new instance's Redis client must actually work (not closed).
_, err = second.GetAggregatedMetrics()
assert.NoError(t, err, "the re-initialized aggregator's Redis client must be usable")
}
+2 -10
View File
@@ -4,16 +4,8 @@ import (
libpack_monitoring "github.com/lukaszraczylo/graphql-monitoring-proxy/monitoring"
)
// StartMonitoringServer initializes and starts the monitoring server.
func StartMonitoringServer() error {
cfg.Monitoring = libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{
PurgeOnCrawl: cfg.Server.PurgeOnCrawl,
PurgeEvery: cfg.Server.PurgeEvery,
})
func StartMonitoringServer() {
cfg.Monitoring = libpack_monitoring.NewMonitoring(&libpack_monitoring.InitConfig{PurgeOnCrawl: cfg.Server.PurgeOnCrawl, PurgeEvery: cfg.Server.PurgeEvery})
cfg.Monitoring.AddMetricsPrefix("graphql_proxy")
cfg.Monitoring.RegisterDefaultMetrics()
// Currently, the monitoring server initialization doesn't throw errors,
// but we return nil to maintain the interface contract
return nil
}
+4 -3
View File
@@ -5,7 +5,8 @@ func (ms *MetricsSetup) RegisterDefaultMetrics() {
ms.RegisterMetricsCounter(MetricsFailed, nil)
ms.RegisterMetricsCounter(MetricsSkipped, nil)
ms.RegisterMetricsHistogram(MetricsDuration, nil)
ms.RegisterMetricsCounter(MetricsCacheHit, nil)
ms.RegisterMetricsCounter(MetricsCacheMiss, nil)
ms.RegisterMetricsCounter(MetricsQueriesCached, nil)
}
func (ms *MetricsSetup) RegisterGoMetrics() {
// TODO: metrics.WriteProcessMetrics(ms.metrics_set)
}

Some files were not shown because too many files have changed in this diff Show More