feat: add query parameter match support in ratelimit by slayer321 · Pull Request #7330 · envoyproxy/gateway

slayer321 · 2025-10-24T12:42:07Z

What type of PR is this?

feat: add query parameter match support in ratelimit

What this PR does / why we need it:
It adds the query parameter support for ratelimit
Which issue(s) this PR fixes:

Fixes #6790

Release Notes: Yes/No

codecov · 2025-10-24T12:52:43Z

Codecov Report

❌ Patch coverage is 74.04580% with 34 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.67%. Comparing base (c9e3d5f) to head (1639b7c).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
internal/xds/translator/ratelimit.go	68.75%	10 Missing and 5 partials ⚠️
internal/xds/translator/local_ratelimit.go	70.73%	10 Missing and 2 partials ⚠️
internal/gatewayapi/backendtrafficpolicy.go	82.92%	5 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7330      +/-   ##
==========================================
+ Coverage   73.65%   73.67%   +0.01%     
==========================================
  Files         239      239              
  Lines       36311    36439     +128     
==========================================
+ Hits        26745    26845     +100     
- Misses       7671     7692      +21     
- Partials     1895     1902       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

arkodg · 2025-10-29T01:49:37Z

api/v1alpha1/ratelimit_types.go

+
+	// Rate limit on query parameters.
+	// +optional
+	QueryParameters *QueryParameters `json:"queryParameters,omitempty"`


this should look more like []QueryParamMatch like []HeaderMatch fields
also lets use queryParams since that is what upstream uses https://gateway-api.sigs.k8s.io/reference/spec/#httproutematch

arkodg · 2025-10-31T02:00:40Z

api/v1alpha1/ratelimit_types.go

-	DescriptorKey string `json:"descriptorKey,omitempty"`
+	//
+	// +kubebuilder:validation:Required
+	DescriptorKey string `json:"descriptorKey"`


this is not exposed, but generated internally

slayer321 · 2025-10-31T11:15:38Z

Hey @arkodg, I noticed there are quite a few merge conflicts in my PR. I tried resolving them, but it’s getting a bit messy. Would it be okay if I open a new PR with my changes rebased on top of main?

api/v1alpha1/ratelimit_types.go

arkodg · 2025-11-15T02:20:33Z

internal/ir/xds.go

+	// Name of the query parameter.
+	Name string `json:"name" yaml:"name"`
+	// DescriptorKey is the key to use when creating the rate limit descriptor entry.
+	DescriptorKey string `json:"descriptorKey" yaml:"descriptorKey"`


this is not needed

arkodg · 2025-11-15T02:22:29Z

internal/xds/translator/local_ratelimit.go

@@ -304,6 +304,22 @@ func buildRouteLocalRateLimits(local *ir.LocalRateLimit) (
 				rlActions = append(rlActions, action)
 			}
 		}
+		for _, queryParam := range rule.QueryParamMatches {


shouldnt this look more like // HeaderMatches logic ?

arkodg · 2025-11-15T02:23:27Z

internal/xds/translator/ratelimit.go

@@ -336,6 +336,18 @@ func buildRouteRateLimits(route *ir.HTTPRoute) (rateLimits []*routev3.RateLimit,
 			}
 		}

+		for _, queryParam := range rule.QueryParamMatches {


shoudnt this look like header matches logic ?

arkodg · 2025-11-15T02:26:00Z

internal/xds/translator/ratelimit.go

@@ -682,9 +695,26 @@ func buildRateLimitServiceDescriptors(route *ir.HTTPRoute) []*rlsconfv3.RateLimi
 				cur = pbDesc
 			}
 		}
-		// Case when both header and cidr match are not set and the ratelimit
+
+		// 3) Query Parameters


shouldnt this look like header matches logic ?

slayer321 · 2025-11-24T14:18:45Z

Hey @arkodg , I see there are some new review comment . I had this query #7330 (comment)

can i do this ? .. Create a new PR and close this one. Will incorporate all the changes that you have mentioned in the new PR.

arkodg · 2025-11-24T14:30:53Z

Hey can you please use this PR to keep all the conversations in one place and to reduce reviewer burden ( to review incremental diff vs entire diff )

arkodg · 2026-01-24T15:38:21Z

api/v1alpha1/ratelimit_types.go

+	// For Distinct match type, leave this empty and use the MatchType field instead.
+	//
+	// +optional
+	StringMatch `json:",inline"`


why is StringMatch used here instead of just Value

there is already MatchType being defined in the same struct

Hi @slayer321 please go ahead and use a simple Value string here.
My previous comment https://github.com/envoyproxy/gateway/pull/7330/changes#r2644961055 can be ignored.

arkodg · 2026-01-24T15:45:40Z

internal/xds/translator/ratelimit.go

 			}
 		}
+
+		// 5) Query Parameters


@zirain this logic looks a little different than headerMatches logic, is it okay ?

zirain · 2026-01-25T04:24:51Z

internal/xds/translator/testdata/out/xds-ir/local-ratelimit-query-parameters.routes.yaml

+                descriptorKey: user
+                descriptorValue: user


why this's different with headerValueMatch?

internal/xds/translator/testdata/in/xds-ir/local-ratelimit-query-parameters.yaml

arkodg · 2026-01-28T04:50:41Z

@slayer321 we are trying to release rc in the next 2 days, can you address the newer comments soon so we can try and get this in

slayer321 · 2026-01-28T13:33:45Z

@arkodg I have addressed the review comments.. can you please take a look

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

… embedded struct Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

…yParameterValueMatch Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

zirain

LGTM, it would be better to have a gatwayapi layer test case.

zhaohuabing

LGTM thanks!

cnvergence · 2026-01-29T10:28:29Z

/retest

Signed-off-by: Sadmi Bouhafs <sadmibouhafs@gmail.com>

slayer321 requested a review from a team as a code owner October 24, 2025 12:42

slayer321 force-pushed the add-query-parameter-local-ratelimit branch from 1acdccd to e635afa Compare October 24, 2025 12:43

slayer321 force-pushed the add-query-parameter-local-ratelimit branch 3 times, most recently from 522705d to fc46b82 Compare October 24, 2025 14:10

slayer321 marked this pull request as draft October 24, 2025 15:07

slayer321 force-pushed the add-query-parameter-local-ratelimit branch 6 times, most recently from 97b2144 to 0d91c6c Compare October 28, 2025 04:39

slayer321 marked this pull request as ready for review October 28, 2025 05:49

slayer321 force-pushed the add-query-parameter-local-ratelimit branch 2 times, most recently from ae95d00 to 47ab711 Compare October 28, 2025 08:15

arkodg added this to the v1.6.0-rc.1 Release milestone Oct 28, 2025

arkodg reviewed Oct 29, 2025

View reviewed changes

arkodg modified the milestones: v1.6.0-rc.1 Release, Backlog Oct 29, 2025

arkodg reviewed Oct 31, 2025

View reviewed changes

zirain reviewed Oct 31, 2025

View reviewed changes

api/v1alpha1/ratelimit_types.go Outdated Show resolved Hide resolved

arkodg reviewed Nov 15, 2025

View reviewed changes

slayer321 force-pushed the add-query-parameter-local-ratelimit branch from b71cc08 to 64a302a Compare November 28, 2025 06:59

zirain previously approved these changes Jan 21, 2026

View reviewed changes

arkodg reviewed Jan 24, 2026

View reviewed changes

zirain reviewed Jan 25, 2026

View reviewed changes

internal/xds/translator/testdata/in/xds-ir/local-ratelimit-query-parameters.yaml Show resolved Hide resolved

slayer321 dismissed zirain’s stale review via 115804a January 28, 2026 11:53

slayer321 force-pushed the add-query-parameter-local-ratelimit branch from f50986a to 115804a Compare January 28, 2026 11:53

slayer321 added 13 commits January 29, 2026 15:34

feat: add query parameter match support in ratelimit

7109f7c

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

update queryParams to use QueryParamMatch as type

75b95fc

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

remove descriptorKey from QueryParamMatch struct

ff5d064

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

update the cel validation for RateLimitSelectCondition struct

fed2b2c

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

remove descriptorKey field and fix failing ci

f4d840a

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

fix gen-check lint failure

ac23f69

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

add omitempty to the require fields and remove pointer to StringMatch…

b050ce7

… embedded struct Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

remove unintened changes

13ae562

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

remove name fields from QueryParamMatch and use RateLimit_Action_Quer…

e2e9730

…yParameterValueMatch Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

fix lint error

f67dd13

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

fix e2e test

8386c6d

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

remove redundant comment

7c255ef

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

address review comment

5e59ae4

Signed-off-by: sachin maurya <sachin.maurya7666@gmail.com>

zirain force-pushed the add-query-parameter-local-ratelimit branch from 752ec28 to 5e59ae4 Compare January 29, 2026 07:34

zirain approved these changes Jan 29, 2026

View reviewed changes

zhaohuabing approved these changes Jan 29, 2026

View reviewed changes

Merge branch 'main' into add-query-parameter-local-ratelimit

1639b7c

cnvergence approved these changes Jan 29, 2026

View reviewed changes

cnvergence merged commit b328011 into envoyproxy:main Jan 29, 2026
60 of 62 checks passed

SadmiB pushed a commit to SadmiB/gateway that referenced this pull request Jan 30, 2026

feat: add query parameter match support in ratelimit (envoyproxy#7330)

eca93fe

Signed-off-by: Sadmi Bouhafs <sadmibouhafs@gmail.com>

Conversation

slayer321 commented Oct 24, 2025

Uh oh!

codecov bot commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slayer321 commented Oct 31, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slayer321 commented Nov 24, 2025

Uh oh!

arkodg commented Nov 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zhaohuabing Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

arkodg commented Jan 28, 2026

Uh oh!

slayer321 commented Jan 28, 2026

Uh oh!

zirain left a comment

Choose a reason for hiding this comment

Uh oh!

zhaohuabing left a comment

Choose a reason for hiding this comment

Uh oh!

cnvergence commented Jan 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov bot commented Oct 24, 2025 •

edited

Loading

zhaohuabing Jan 26, 2026 •

edited

Loading