Including the name in the ratelimit descriptor so that it is returned… (

#596) Signed-off-by: jespersoderlund <[email protected]>
envoyproxy · Jun 7, 2024 · f17d88f · f17d88f
1 parent 0f73f89
commit f17d88f
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 1 deletion.
diff --git a/src/config/config_impl.go b/src/config/config_impl.go
@@ -85,6 +85,7 @@ func NewRateLimit(requestsPerUnit uint32, unit pb.RateLimitResponse_RateLimit_Un
 		Limit: &pb.RateLimitResponse_RateLimit{
 			RequestsPerUnit: requestsPerUnit,
 			Unit:            unit,
+			Name:            name,
 		},
 		Unlimited:      unlimited,
 		ShadowMode:     shadowMode,

diff --git a/test/config/basic_config.yaml b/test/config/basic_config.yaml
@@ -42,6 +42,7 @@ descriptors:
 
   - key: key4
     rate_limit:
+      name: key4_rate_limit
       unit: day
       requests_per_unit: 1
 

diff --git a/test/config/config_test.go b/test/config/config_test.go
@@ -149,6 +149,7 @@ func TestBasicConfig(t *testing.T) {
 	rl.Stats.NearLimit.Inc()
 	rl.Stats.WithinLimit.Inc()
 	assert.EqualValues(1, rl.Limit.RequestsPerUnit)
+	assert.Empty(rl.Limit.Name, "No name provided in config")
 	assert.Equal(pb.RateLimitResponse_RateLimit_HOUR, rl.Limit.Unit)
 	assert.EqualValues(1, stats.NewCounter("test-domain.key3.total_hits").Value())
 	assert.EqualValues(1, stats.NewCounter("test-domain.key3.over_limit").Value())
@@ -165,6 +166,7 @@ func TestBasicConfig(t *testing.T) {
 	rl.Stats.NearLimit.Inc()
 	rl.Stats.WithinLimit.Inc()
 	assert.EqualValues(1, rl.Limit.RequestsPerUnit)
+	assert.EqualValues("key4_rate_limit", rl.Limit.Name, "Name provided in config")
 	assert.Equal(pb.RateLimitResponse_RateLimit_DAY, rl.Limit.Unit)
 	assert.EqualValues(1, stats.NewCounter("test-domain.key4.total_hits").Value())
 	assert.EqualValues(1, stats.NewCounter("test-domain.key4.over_limit").Value())

diff --git a/test/service/ratelimit_test.go b/test/service/ratelimit_test.go
@@ -153,7 +153,7 @@ func TestService(test *testing.T) {
 	request = common.NewRateLimitRequest(
 		"different-domain", [][][2]string{{{"foo", "bar"}}, {{"hello", "world"}}}, 1)
 	limits := []*config.RateLimit{
-		config.NewRateLimit(10, pb.RateLimitResponse_RateLimit_MINUTE, t.statsManager.NewStats("key"), false, false, "", nil, false),
+		config.NewRateLimit(10, pb.RateLimitResponse_RateLimit_MINUTE, t.statsManager.NewStats("key"), false, false, "key_name", nil, false),
 		nil,
 	}
 	t.config.EXPECT().GetLimit(context.Background(), "different-domain", request.Descriptors[0]).Return(limits[0])