There are cases where I want to use keys other than the fixed ones.

base_limiter.go

@@ -1,6 +1,7 @@
 package rlutils
 
 import (
+	"fmt"
 	"net/http"
 	"path/filepath"
 	"strings"
@@ -10,6 +11,11 @@ import (
 	"github.com/2manymws/rl/counter"
 )
 
+const (
+	remoteAddrKey = "remote_addr"
+	hostKey       = "host"
+)
+
 type BaseLimiter struct {
 	reqLimit         int `mapstructure:"req_limit"`
 	windowLen        time.Duration
@@ -58,3 +64,19 @@ func (l *BaseLimiter) isTargetExtensions(r *http.Request) bool {
 	}
 	return false
 }
+func validateKey(key string) error {
+	for _, k := range []string{remoteAddrKey, hostKey} {
+		if k == key {
+			return nil
+		}
+	}
+	return fmt.Errorf("invalid key: %s", key)
+}
+
+func fillKey(r *http.Request, key string) string {
+	if key == "remote_addr" {
+		remoteAddr := strings.Split(r.RemoteAddr, ":")[0]
+		return remoteAddr
+	}
+	return r.Host
+}

coverage.out

@@ -1,14 +1,21 @@
 mode: count
-github.com/2manymws/rlutils/base_limiter.go:26.15,35.2 2 20
-github.com/2manymws/rlutils/base_limiter.go:37.70,39.2 1 0
-github.com/2manymws/rlutils/base_limiter.go:41.37,43.2 1 0
-github.com/2manymws/rlutils/base_limiter.go:45.61,47.2 1 21
-github.com/2manymws/rlutils/base_limiter.go:49.64,50.34 1 27
-github.com/2manymws/rlutils/base_limiter.go:50.34,52.3 1 22
-github.com/2manymws/rlutils/base_limiter.go:53.2,54.41 2 5
-github.com/2manymws/rlutils/base_limiter.go:54.41,55.40 1 8
-github.com/2manymws/rlutils/base_limiter.go:55.40,57.4 1 3
-github.com/2manymws/rlutils/base_limiter.go:59.2,59.14 1 2
+github.com/2manymws/rlutils/base_limiter.go:32.15,41.2 2 22
+github.com/2manymws/rlutils/base_limiter.go:43.70,45.2 1 0
+github.com/2manymws/rlutils/base_limiter.go:47.37,49.2 1 0
+github.com/2manymws/rlutils/base_limiter.go:51.61,53.2 1 23
+github.com/2manymws/rlutils/base_limiter.go:55.64,56.34 1 29
+github.com/2manymws/rlutils/base_limiter.go:56.34,58.3 1 24
+github.com/2manymws/rlutils/base_limiter.go:59.2,60.41 2 5
+github.com/2manymws/rlutils/base_limiter.go:60.41,61.40 1 8
+github.com/2manymws/rlutils/base_limiter.go:61.40,63.4 1 3
+github.com/2manymws/rlutils/base_limiter.go:65.2,65.14 1 2
+github.com/2manymws/rlutils/base_limiter.go:67.36,68.53 1 12
+github.com/2manymws/rlutils/base_limiter.go:68.53,69.15 1 22
+github.com/2manymws/rlutils/base_limiter.go:69.15,71.4 1 12
+github.com/2manymws/rlutils/base_limiter.go:73.2,73.43 1 0
+github.com/2manymws/rlutils/base_limiter.go:76.50,77.26 1 7
+github.com/2manymws/rlutils/base_limiter.go:77.26,80.3 2 2
+github.com/2manymws/rlutils/base_limiter.go:81.2,81.15 1 5
 github.com/2manymws/rlutils/country_limiter.go:36.28,38.16 2 6
 github.com/2manymws/rlutils/country_limiter.go:38.16,40.3 1 0
 github.com/2manymws/rlutils/country_limiter.go:41.2,44.30 3 6
@@ -39,15 +46,17 @@ github.com/2manymws/rlutils/country_limiter.go:118.69,126.16 3 10
 github.com/2manymws/rlutils/country_limiter.go:126.16,128.3 1 2
 github.com/2manymws/rlutils/country_limiter.go:130.2,130.36 1 8
 github.com/2manymws/rlutils/country_limiter.go:133.73,135.2 1 0
-github.com/2manymws/rlutils/get_parameter_limiter.go:23.24,33.2 1 3
-github.com/2manymws/rlutils/get_parameter_limiter.go:35.45,37.2 1 0
-github.com/2manymws/rlutils/get_parameter_limiter.go:39.71,40.27 1 3
-github.com/2manymws/rlutils/get_parameter_limiter.go:40.27,42.3 1 0
-github.com/2manymws/rlutils/get_parameter_limiter.go:43.2,43.36 1 3
-github.com/2manymws/rlutils/get_parameter_limiter.go:43.36,44.32 1 3
-github.com/2manymws/rlutils/get_parameter_limiter.go:44.32,50.4 1 2
-github.com/2manymws/rlutils/get_parameter_limiter.go:53.2,53.36 1 1
-github.com/2manymws/rlutils/get_parameter_limiter.go:56.78,58.2 1 0
+github.com/2manymws/rlutils/get_parameter_limiter.go:25.33,27.16 2 4
+github.com/2manymws/rlutils/get_parameter_limiter.go:27.16,29.3 1 0
+github.com/2manymws/rlutils/get_parameter_limiter.go:30.2,39.8 1 4
+github.com/2manymws/rlutils/get_parameter_limiter.go:42.45,44.2 1 0
+github.com/2manymws/rlutils/get_parameter_limiter.go:46.71,47.27 1 4
+github.com/2manymws/rlutils/get_parameter_limiter.go:47.27,49.3 1 0
+github.com/2manymws/rlutils/get_parameter_limiter.go:50.2,50.36 1 4
+github.com/2manymws/rlutils/get_parameter_limiter.go:50.36,51.32 1 5
+github.com/2manymws/rlutils/get_parameter_limiter.go:51.32,57.4 1 3
+github.com/2manymws/rlutils/get_parameter_limiter.go:60.2,60.36 1 1
+github.com/2manymws/rlutils/get_parameter_limiter.go:63.78,65.2 1 0
 github.com/2manymws/rlutils/host_limiter.go:21.16,30.2 1 1
 github.com/2manymws/rlutils/host_limiter.go:32.37,34.2 1 0
 github.com/2manymws/rlutils/host_limiter.go:36.63,37.27 1 1
@@ -60,25 +69,27 @@ github.com/2manymws/rlutils/ip_limiter.go:37.61,38.27 1 2
 github.com/2manymws/rlutils/ip_limiter.go:38.27,40.3 1 0
 github.com/2manymws/rlutils/ip_limiter.go:41.2,46.8 2 2
 github.com/2manymws/rlutils/ip_limiter.go:49.68,51.2 1 0
-github.com/2manymws/rlutils/request_path_limiter.go:34.23,49.2 1 7
-github.com/2manymws/rlutils/request_path_limiter.go:51.44,53.2 1 0
-github.com/2manymws/rlutils/request_path_limiter.go:55.70,56.27 1 7
-github.com/2manymws/rlutils/request_path_limiter.go:56.27,58.3 1 0
-github.com/2manymws/rlutils/request_path_limiter.go:59.2,66.4 1 7
-github.com/2manymws/rlutils/request_path_limiter.go:66.4,67.23 1 18
-github.com/2manymws/rlutils/request_path_limiter.go:67.23,68.33 1 18
-github.com/2manymws/rlutils/request_path_limiter.go:68.33,69.31 1 18
-github.com/2manymws/rlutils/request_path_limiter.go:69.31,80.8 2 9
-github.com/2manymws/rlutils/request_path_limiter.go:80.8,81.31 1 21
-github.com/2manymws/rlutils/request_path_limiter.go:81.31,82.42 1 6
-github.com/2manymws/rlutils/request_path_limiter.go:82.42,83.40 1 6
-github.com/2manymws/rlutils/request_path_limiter.go:83.40,85.15 2 6
-github.com/2manymws/rlutils/request_path_limiter.go:88.8,88.19 1 6
-github.com/2manymws/rlutils/request_path_limiter.go:88.19,89.14 1 6
-github.com/2manymws/rlutils/request_path_limiter.go:93.6,93.18 1 9
-github.com/2manymws/rlutils/request_path_limiter.go:93.18,99.7 1 3
-github.com/2manymws/rlutils/request_path_limiter.go:105.2,105.36 1 4
-github.com/2manymws/rlutils/request_path_limiter.go:108.77,110.2 1 0
+github.com/2manymws/rlutils/request_path_limiter.go:36.32,38.16 2 8
+github.com/2manymws/rlutils/request_path_limiter.go:38.16,40.3 1 0
+github.com/2manymws/rlutils/request_path_limiter.go:42.2,56.8 1 8
+github.com/2manymws/rlutils/request_path_limiter.go:59.44,61.2 1 0
+github.com/2manymws/rlutils/request_path_limiter.go:63.70,64.27 1 8
+github.com/2manymws/rlutils/request_path_limiter.go:64.27,66.3 1 0
+github.com/2manymws/rlutils/request_path_limiter.go:67.2,74.4 1 8
+github.com/2manymws/rlutils/request_path_limiter.go:74.4,75.23 1 21
+github.com/2manymws/rlutils/request_path_limiter.go:75.23,76.33 1 21
+github.com/2manymws/rlutils/request_path_limiter.go:76.33,77.31 1 21
+github.com/2manymws/rlutils/request_path_limiter.go:77.31,88.8 2 10
+github.com/2manymws/rlutils/request_path_limiter.go:88.8,89.31 1 24
+github.com/2manymws/rlutils/request_path_limiter.go:89.31,90.42 1 6
+github.com/2manymws/rlutils/request_path_limiter.go:90.42,91.40 1 6
+github.com/2manymws/rlutils/request_path_limiter.go:91.40,93.15 2 6
+github.com/2manymws/rlutils/request_path_limiter.go:96.8,96.19 1 6
+github.com/2manymws/rlutils/request_path_limiter.go:96.19,97.14 1 6
+github.com/2manymws/rlutils/request_path_limiter.go:101.6,101.18 1 10
+github.com/2manymws/rlutils/request_path_limiter.go:101.18,107.7 1 4
+github.com/2manymws/rlutils/request_path_limiter.go:113.2,113.36 1 4
+github.com/2manymws/rlutils/request_path_limiter.go:116.77,118.2 1 0
 github.com/2manymws/rlutils/user_agent_limiter.go:24.21,34.2 1 1
 github.com/2manymws/rlutils/user_agent_limiter.go:36.42,38.2 1 0
 github.com/2manymws/rlutils/user_agent_limiter.go:40.68,41.27 1 2

get_parameter_limiter.go

@@ -9,6 +9,7 @@ import (
 
 type GetParameterLimiter struct {
 	getParameters map[string]string
+	key           string
 	BaseLimiter
 }
 
@@ -18,18 +19,24 @@ func NewGetParameterLimiter(
 	getParameters map[string]string,
 	reqLimit int,
 	windowLen time.Duration,
+	key string,
 	targetExtensions []string,
 	onRequestLimit func(*rl.Context, string) http.HandlerFunc,
-) *GetParameterLimiter {
+) (*GetParameterLimiter, error) {
+	err := validateKey(key)
+	if err != nil {
+		return nil, err
+	}
 	return &GetParameterLimiter{
 		getParameters: getParameters,
+		key:           key,
 		BaseLimiter: NewBaseLimiter(
 			reqLimit,
 			windowLen,
 			targetExtensions,
 			onRequestLimit,
 		),
-	}
+	}, nil
 }
 
 func (l *GetParameterLimiter) Name() string {
@@ -43,7 +50,7 @@ func (l *GetParameterLimiter) Rule(r *http.Request) (*rl.Rule, error) {
 	for k, v := range l.getParameters {
 		if r.URL.Query().Get(k) == v {
 			return &rl.Rule{
-				Key:       r.Host + "/" + k + "=" + v,
+				Key:       fillKey(r, l.key) + "/" + k + "=" + v,
 				ReqLimit:  l.reqLimit,
 				WindowLen: l.windowLen,
 			}, nil

get_parameter_limiter_test.go

@@ -17,6 +17,7 @@ func TestGetParameterLimiter(t *testing.T) {
 		name                string
 		getParameters       map[string]string
 		queryString         string
+		key                 string
 		expectedToBeLimited bool
 		expectedKey         string
 	}{
@@ -26,6 +27,7 @@ func TestGetParameterLimiter(t *testing.T) {
 				"token": "123456",
 			},
 			queryString:         "?token=123456",
+			key:                 "host",
 			expectedToBeLimited: true,
 			expectedKey:         "example.com/token=123456",
 		},
@@ -35,6 +37,7 @@ func TestGetParameterLimiter(t *testing.T) {
 				"token": "123456",
 			},
 			queryString:         "?token=abcdef",
+			key:                 "host",
 			expectedToBeLimited: false,
 		},
 		{
@@ -44,9 +47,20 @@ func TestGetParameterLimiter(t *testing.T) {
 				"sessionId": "ABCDEF",
 			},
 			queryString:         "?token=123456&sessionId=XYZ",
+			key:                 "host",
 			expectedToBeLimited: true,
 			expectedKey:         "example.com/token=123456",
 		},
+		{
+			name: "Request with matching get parameter should be limited with remote ip",
+			getParameters: map[string]string{
+				"token": "123456",
+			},
+			queryString:         "?token=123456",
+			key:                 "remote_addr",
+			expectedToBeLimited: true,
+			expectedKey:         "127.0.0.1/token=123456",
+		},
 	}
 
 	for _, tc := range cases {
@@ -58,10 +72,11 @@ func TestGetParameterLimiter(t *testing.T) {
 			reqLimit := 5
 			windowLen := time.Minute
 
-			limiter := NewGetParameterLimiter(
+			limiter, _ := NewGetParameterLimiter(
 				tc.getParameters,
 				reqLimit,
 				windowLen,
+				tc.key,
 				nil,
 				nil,
 			)
@@ -70,6 +85,7 @@ func TestGetParameterLimiter(t *testing.T) {
 			limiter.Counter = mockCounter
 
 			req := httptest.NewRequest(http.MethodGet, "http://example.com"+tc.queryString, nil)
+			req.RemoteAddr = "127.0.0.1:12345"
 			rule, err := limiter.Rule(req)
 			assert.NoError(t, err)
 

request_path_limiter.go

@@ -15,6 +15,7 @@ type RequestPathLimiter struct {
 	ignorePathContains  []string
 	ignorePathPrefixes  []string
 	ignorePathSuffixes  []string
+	key                 string
 	BaseLimiter
 }
 
@@ -29,23 +30,30 @@ func NewRequestPathLimiter(
 	ignorePathSuffixes []string,
 	reqLimit int,
 	windowLen time.Duration,
+	key string,
 	targetExtensions []string,
 	onRequestLimit func(*rl.Context, string) http.HandlerFunc,
-) *RequestPathLimiter {
+) (*RequestPathLimiter, error) {
+	err := validateKey(key)
+	if err != nil {
+		return nil, err
+	}
+
 	return &RequestPathLimiter{
 		requestPathContains: requestPathContains,
 		requestPathPrefixes: requestPathPrefixes,
 		requestPathSuffixes: requestPathSuffixes,
 		ignorePathContains:  ignorePathContains,
 		ignorePathPrefixes:  ignorePathPrefixes,
 		ignorePathSuffixes:  ignorePathSuffixes,
+		key:                 key,
 		BaseLimiter: NewBaseLimiter(
 			reqLimit,
 			windowLen,
 			targetExtensions,
 			onRequestLimit,
 		),
-	}
+	}, nil
 }
 
 func (l *RequestPathLimiter) Name() string {
@@ -92,7 +100,7 @@ func (l *RequestPathLimiter) Rule(r *http.Request) (*rl.Rule, error) {
 					}
 					if !ignored {
 						return &rl.Rule{
-							Key:       r.Host + path,
+							Key:       fillKey(r, l.key) + path,
 							ReqLimit:  l.reqLimit,
 							WindowLen: l.windowLen,
 						}, nil