Retro compatibilty suite

.gitattributes

@@ -0,0 +1,6 @@
+*.gen.go linguist-generated
+*.gen.ts linguist-generated
+*.gen.yaml linguist-generated
+go.sum linguist-generated
+go.work.sum linguist-generated
+vendor/** linguist-vendored

.github/workflows/go.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.21'
+        go-version: '1.23'
 
     - name: Build
       run: go build -v ./...

.github/workflows/retro.yml

@@ -0,0 +1,35 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Retro compatibility tests
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.23'
+
+    - name: Start Redis
+      uses: supercharge/[email protected]
+
+    - name: Run server
+      run: cd tests && make server-start
+
+    - name: Run latest client tests
+      run: cd tests && make client-run
+
+    - name: Stop server
+      run: cd tests && make server-stop
+      if: always()

.gitignore

@@ -1,2 +1,6 @@
 .vscode
 coverage.out
+
+tests/bin
+tests/server.pid
+tests/logs

server_test.go

@@ -37,7 +37,7 @@ var (
 
 func TestMiddlewareUseAccessKey(t *testing.T) {
 	cfg := newConfig()
-	server, cleanup := mock.NewServer(&cfg)
+	server, cleanup := mock.NewServer(&cfg, nil)
 	t.Cleanup(cleanup)
 
 	now := time.Now()
@@ -275,7 +275,7 @@ func TestMiddlewareUseAccessKey(t *testing.T) {
 
 func TestDefaultKey(t *testing.T) {
 	cfg := newConfig()
-	server, cleanup := mock.NewServer(&cfg)
+	server, cleanup := mock.NewServer(&cfg, nil)
 	t.Cleanup(cleanup)
 
 	now := time.Now()
@@ -350,7 +350,7 @@ func TestJWT(t *testing.T) {
 	counter := spendingCounter(0)
 
 	cfg := newConfig()
-	server, cleanup := mock.NewServer(&cfg)
+	server, cleanup := mock.NewServer(&cfg, nil)
 	t.Cleanup(cleanup)
 
 	logger := slog.Default()
@@ -432,7 +432,7 @@ func TestJWTAccess(t *testing.T) {
 	counter := hitCounter(0)
 
 	cfg := newConfig()
-	server, cleanup := mock.NewServer(&cfg)
+	server, cleanup := mock.NewServer(&cfg, nil)
 	t.Cleanup(cleanup)
 
 	logger := slog.Default()
@@ -539,7 +539,7 @@ func TestSession(t *testing.T) {
 	counter := hitCounter(0)
 
 	cfg := newConfig()
-	server, cleanup := mock.NewServer(&cfg)
+	server, cleanup := mock.NewServer(&cfg, nil)
 	t.Cleanup(cleanup)
 
 	logger := slog.Default()
@@ -680,7 +680,7 @@ func TestSessionDisabled(t *testing.T) {
 
 	cfg := newConfig()
 	cfg.Enabled = false
-	server, cleanup := mock.NewServer(&cfg)
+	server, cleanup := mock.NewServer(&cfg, nil)
 	t.Cleanup(cleanup)
 
 	logger := slog.Default()
@@ -805,7 +805,7 @@ func TestChainID(t *testing.T) {
 	counter := hitCounter(0)
 
 	cfg := newConfig()
-	server, cleanup := mock.NewServer(&cfg)
+	server, cleanup := mock.NewServer(&cfg, nil)
 	t.Cleanup(cleanup)
 
 	logger := slog.Default()
@@ -876,7 +876,7 @@ func TestPerServiceRateLimit(t *testing.T) {
 	counter := hitCounter(0)
 
 	cfg := newConfig()
-	server, cleanup := mock.NewServer(&cfg)
+	server, cleanup := mock.NewServer(&cfg, nil)
 	t.Cleanup(cleanup)
 
 	authOptions := authcontrol.Options{

tests/Makefile

@@ -0,0 +1,21 @@
+CONFIG_FILE:="etc/config.json"
+VERSION:=latest
+PWD:=$(shell pwd)
+
+build:
+	@go build -o $(PWD)/bin/server ./server/server.go
+
+server-start: build
+	@CONFIG_FILE=$(CONFIG_FILE) ./scripts/helper.sh server start
+
+server-status:
+	@CONFIG_FILE=$(CONFIG_FILE) ./scripts/helper.sh server status || true
+
+server-stop:
+	@CONFIG_FILE=$(CONFIG_FILE) ./scripts/helper.sh server stop
+
+server-kill:
+	@CONFIG_FILE=$(CONFIG_FILE) ./scripts/helper.sh server kill
+
+client-run:
+	@CONFIG_FILE=$(CONFIG_FILE) VERSION=$(VERSION) go run ./client/$(VERSION)/client.go

tests/client/latest/client.go

@@ -0,0 +1,125 @@
+package main
+
+import (
+	"context"
+	"log/slog"
+	"net/http"
+	"os"
+	"os/signal"
+	"time"
+
+	"github.com/0xsequence/authcontrol"
+	"github.com/0xsequence/quotacontrol"
+	qcmw "github.com/0xsequence/quotacontrol/middleware"
+	"github.com/0xsequence/quotacontrol/proto"
+	"github.com/0xsequence/quotacontrol/tests/common"
+	"github.com/go-chi/chi/v5"
+)
+
+var logger = slog.Default().With(
+	slog.String("app", "quotacontrol-client"),
+	slog.String("version", "latest"),
+)
+
+var (
+	ProjectID  uint64 = 1
+	Service           = proto.Service_Indexer
+	ServerAddr        = "localhost:8080"
+)
+
+func main() {
+	ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, os.Kill)
+	defer cancel()
+
+	cfg := common.LoadConfig[quotacontrol.Config](logger)
+
+	limit := proto.Limit{
+		ServiceLimit: map[string]proto.ServiceLimit{
+			Service.String(): {
+				RateLimit: 100,
+				FreeMax:   1000,
+				OverMax:   1000,
+			},
+		},
+	}
+	if err := common.SetProjectLimit(ctx, cfg.URL, ProjectID, limit); err != nil {
+		logger.Error("failed to set project limit", slog.Any("err", err))
+		os.Exit(1)
+	}
+	logger.Info("successfully set project limit", slog.Uint64("projectID", ProjectID))
+
+	baseClient := proto.NewQuotaControlClient(cfg.URL, http.DefaultClient)
+
+	logger.Info("server URL", slog.String("url", cfg.URL))
+
+	accessKey, err := baseClient.CreateAccessKey(ctx, ProjectID, "Test Key", false, nil, nil)
+	if err != nil {
+		logger.Error("failed to create access key", slog.Any("err", err))
+		os.Exit(1)
+	}
+	logger.Info("successfully created access key", slog.String("accessKeyID", accessKey.AccessKey))
+
+	client := quotacontrol.NewClient(logger, Service, cfg, nil)
+	go func() {
+		if err := client.Run(ctx); err != nil {
+			logger.Error("client run error", slog.Any("err", err))
+			os.Exit(1)
+		}
+	}()
+
+	counter := quotacontrol.NewLimitCounter(Service, cfg.Redis, logger)
+
+	quotaOptions := qcmw.Options{}
+	authOptions := authcontrol.Options{}
+
+	r := chi.NewRouter()
+	r.Use(authcontrol.VerifyToken(authOptions))
+	r.Use(authcontrol.Session(authOptions))
+	r.Use(qcmw.VerifyQuota(client, quotaOptions))
+	r.Use(qcmw.RateLimit(client, cfg.RateLimiter, counter, quotaOptions))
+	r.Use(qcmw.SpendUsage(client, quotaOptions))
+
+	r.Post("/*", func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+		w.Write([]byte("Hello, QuotaControl!"))
+	})
+
+	usageBefore, err := baseClient.GetUsage(ctx, ProjectID, nil, nil, nil, nil)
+	if err != nil {
+		logger.Error("failed to get usage", slog.Any("err", err))
+		os.Exit(1)
+	}
+
+	count := int64(10)
+	logger.Info("sending requests", slog.Int64("count", count))
+	for i := int64(0); i < count; i++ {
+		logger := logger.With(slog.Int64("requestNumber", i+1))
+		status, _, err := common.ExecuteRequest(ctx, r, "/", accessKey.AccessKey, "")
+		if err != nil {
+			logger.Error("request error", slog.Any("err", err))
+		}
+		if status != http.StatusOK {
+			logger.Error("unexpected status code", slog.Int("status", status))
+		}
+	}
+
+	logger.Info("shutting down client")
+
+	ctxShutDown, cancelShutDown := context.WithTimeout(context.Background(), time.Second*5)
+	defer cancelShutDown()
+	client.Stop(ctxShutDown)
+
+	logger.Info("client shut down successfully")
+
+	usageAfter, err := baseClient.GetUsage(ctx, ProjectID, nil, nil, nil, nil)
+	if err != nil {
+		logger.Error("failed to get usage", slog.Any("err", err))
+		os.Exit(1)
+	}
+	logger.Info("usage before and after requests", slog.Any("before", usageBefore), slog.Any("after", usageAfter))
+	if usageAfter-usageBefore != int64(count) {
+		logger.Error("usage did not increase as expected", slog.Int64("expectedIncrease", count), slog.Int64("actualIncrease", usageAfter-usageBefore))
+		os.Exit(1)
+	}
+	logger.Info("usage increased as expected", slog.Int64("increase", usageAfter-usageBefore))
+}

tests/client/latest/go.mod

@@ -0,0 +1,49 @@
+module client/latest
+
+go 1.24
+
+replace github.com/0xsequence/quotacontrol => ../../..
+
+require (
+	github.com/0xsequence/authcontrol v0.4.12
+	github.com/0xsequence/quotacontrol v0.22.17
+	github.com/go-chi/chi/v5 v5.2.2
+)
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0 // indirect
+	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
+	github.com/getsentry/sentry-go v0.36.2 // indirect
+	github.com/go-chi/httplog/v3 v3.2.2 // indirect
+	github.com/go-chi/httprate v0.14.1 // indirect
+	github.com/go-chi/httprate-redis v0.5.4 // indirect
+	github.com/go-chi/jwtauth/v5 v5.3.3 // indirect
+	github.com/go-chi/metrics v0.1.0 // indirect
+	github.com/go-chi/traceid v0.3.0 // indirect
+	github.com/go-chi/transport v0.5.0 // indirect
+	github.com/goccy/go-json v0.10.3 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/goware/base64 v0.1.0 // indirect
+	github.com/goware/validation v0.1.3 // indirect
+	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
+	github.com/jxskiss/base62 v1.1.0 // indirect
+	github.com/lestrrat-go/blackmagic v1.0.2 // indirect
+	github.com/lestrrat-go/httpcc v1.0.1 // indirect
+	github.com/lestrrat-go/httprc v1.0.6 // indirect
+	github.com/lestrrat-go/iter v1.0.2 // indirect
+	github.com/lestrrat-go/jwx/v2 v2.1.3 // indirect
+	github.com/lestrrat-go/option v1.0.1 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/prometheus/client_golang v1.22.0 // indirect
+	github.com/prometheus/client_model v0.6.2 // indirect
+	github.com/prometheus/common v0.64.0 // indirect
+	github.com/prometheus/procfs v0.16.1 // indirect
+	github.com/redis/go-redis/v9 v9.7.3 // indirect
+	github.com/segmentio/asm v1.2.0 // indirect
+	golang.org/x/crypto v0.41.0 // indirect
+	golang.org/x/sys v0.35.0 // indirect
+	golang.org/x/text v0.28.0 // indirect
+	google.golang.org/protobuf v1.36.6 // indirect
+)