Skip to content

Fix input order dependency in GW rules precedence #4792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cezarsa wants to merge 3 commits into
base: main
Choose a base branch
from
+150 −0
Open

Fix input order dependency in GW rules precedence #4792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49132e8
Add test cases demonstrating input order dependency in rule precedence
cezarsa Jun 15, 2026
61ef2a8
Tentative fix for rule precedence determinism
cezarsa Jun 15, 2026
47648bb
Better fix for rule precedence with different hostname match sizes
cezarsa Jun 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pkg/gateway/routeutils/route_rule_precedence.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,9 @@ func compareHttpRulePrecedence(ruleOne RulePrecedence, ruleTwo RulePrecedence) b
if ruleOne.HttpSpecificRulePrecedenceFactor.QueryParamCount != ruleTwo.HttpSpecificRulePrecedenceFactor.QueryParamCount {
return ruleOne.HttpSpecificRulePrecedenceFactor.QueryParamCount > ruleTwo.HttpSpecificRulePrecedenceFactor.QueryParamCount
}
if len(ruleOne.CommonRulePrecedence.Hostnames) != len(ruleTwo.CommonRulePrecedence.Hostnames) {
return len(ruleOne.CommonRulePrecedence.Hostnames) > len(ruleTwo.CommonRulePrecedence.Hostnames)
}
return compareCommonTieBreakers(ruleOne, ruleTwo)
}

Expand Down
147 changes: 147 additions & 0 deletions pkg/gateway/routeutils/route_rule_precedence_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,95 @@ func Test_SortAllRulesByPrecedence(t *testing.T) {
},
},
}

httpRouteOneDotHost := &httpRouteDescription{
route: &gwv1.HTTPRoute{
ObjectMeta: v1.ObjectMeta{Name: "a-host", Namespace: "ns"},
Spec: gwv1.HTTPRouteSpec{Hostnames: []gwv1.Hostname{"zzz.com"}},
},
rules: []RouteRule{
&convertedHTTPRouteRule{rule: &gwv1.HTTPRouteRule{
Matches: []gwv1.HTTPRouteMatch{{
Path: &gwv1.HTTPPathMatch{Value: new("/"), Type: new(gwv1.PathMatchPathPrefix)},
}},
}},
},
}

httpRouteNoHost := &httpRouteDescription{
route: &gwv1.HTTPRoute{
ObjectMeta: v1.ObjectMeta{Name: "b-nohost", Namespace: "ns"},
},
rules: []RouteRule{
&convertedHTTPRouteRule{rule: &gwv1.HTTPRouteRule{
Matches: []gwv1.HTTPRouteMatch{{
Path: &gwv1.HTTPPathMatch{Value: new("/"), Type: new(gwv1.PathMatchPathPrefix)},
}},
}},
},
}

httpRouteThreeDotsHost := &httpRouteDescription{
route: &gwv1.HTTPRoute{
ObjectMeta: v1.ObjectMeta{Name: "c-host", Namespace: "ns"},
Spec: gwv1.HTTPRouteSpec{Hostnames: []gwv1.Hostname{"a.b.c.com"}},
},
rules: []RouteRule{
&convertedHTTPRouteRule{rule: &gwv1.HTTPRouteRule{
Matches: []gwv1.HTTPRouteMatch{{
Path: &gwv1.HTTPPathMatch{Value: new("/"), Type: new(gwv1.PathMatchPathPrefix)},
}},
}},
},
}

httpRouteNoHostWithPost := &httpRouteDescription{
route: &gwv1.HTTPRoute{
ObjectMeta: v1.ObjectMeta{Name: "b-nohost", Namespace: "ns"},
},
rules: []RouteRule{
&convertedHTTPRouteRule{rule: &gwv1.HTTPRouteRule{
Matches: []gwv1.HTTPRouteMatch{
{
Method: new(gwv1.HTTPMethodPost),
Path: &gwv1.HTTPPathMatch{Value: new("/"), Type: new(gwv1.PathMatchPathPrefix)},
},
},
}},
},
}

makeRulePrecedenceForRouteDescription := func(desc *httpRouteDescription, fn func(*RulePrecedence)) RulePrecedence {
rule := RulePrecedence{
CommonRulePrecedence: CommonRulePrecedence{
RouteNamespacedName: desc.route.Namespace + "/" + desc.route.Name,
Hostnames: func() []string {
hostnames := make([]string, len(desc.route.Spec.Hostnames))
for i := range desc.route.Spec.Hostnames {
hostnames[i] = string(desc.route.Spec.Hostnames[i])
}
return hostnames
}(),
RouteDescriptor: desc,
Rule: desc.rules[0],
RuleIndexInRoute: 0,
MatchIndexInRule: 0,
RouteCreateTimestamp: desc.GetRouteCreateTimestamp(),
},
HttpSpecificRulePrecedenceFactor: &HttpSpecificRulePrecedenceFactor{
PathType: 2,
PathLength: 1,
},
HTTPMatch: &gwv1.HTTPRouteMatch{
Path: &gwv1.HTTPPathMatch{Value: new("/"), Type: new(gwv1.PathMatchPathPrefix)},
},
}
if fn != nil {
fn(&rule)
}
return rule
}

testCases := []struct {
name string
input []RouteDescriptor
Expand Down Expand Up @@ -393,6 +482,64 @@ func Test_SortAllRulesByPrecedence(t *testing.T) {
},
},
},
{
name: "input order independent result for mixed hostname and no-hostname rules - input order A",
input: []RouteDescriptor{
httpRouteOneDotHost, // zzz.com (1 dot)
httpRouteNoHost, // no hostname
httpRouteThreeDotsHost, // a.b.c.com (3 dots)
},
output: []RulePrecedence{
makeRulePrecedenceForRouteDescription(httpRouteThreeDotsHost, nil), // a.b.c.com (3 dots)
makeRulePrecedenceForRouteDescription(httpRouteOneDotHost, nil), // zzz.com (1 dot)
makeRulePrecedenceForRouteDescription(httpRouteNoHost, nil), // no hostname
},
},
{
name: "input order independent result for mixed hostname and no-hostname rules - input order B",
input: []RouteDescriptor{
httpRouteThreeDotsHost, // a.b.c.com (3 dots)
httpRouteNoHost, // no hostname
httpRouteOneDotHost, // zzz.com (1 dot)
},
output: []RulePrecedence{
makeRulePrecedenceForRouteDescription(httpRouteThreeDotsHost, nil), // a.b.c.com (3 dots)
makeRulePrecedenceForRouteDescription(httpRouteOneDotHost, nil), // zzz.com (1 dot)
makeRulePrecedenceForRouteDescription(httpRouteNoHost, nil), // no hostname
},
},
{
name: "input order independent result for mixed hostname and no-hostname rules, with method - input order A",
input: []RouteDescriptor{
httpRouteOneDotHost, // zzz.com (1 dot)
httpRouteNoHostWithPost, // no hostname with POST
httpRouteThreeDotsHost, // a.b.c.com (3 dots)
},
output: []RulePrecedence{
makeRulePrecedenceForRouteDescription(httpRouteNoHostWithPost, func(r *RulePrecedence) { // no hostname with POST
r.HTTPMatch.Method = new(gwv1.HTTPMethodPost)
r.HttpSpecificRulePrecedenceFactor.HasMethod = true
}),
makeRulePrecedenceForRouteDescription(httpRouteThreeDotsHost, nil), // a.b.c.com (3 dots)
makeRulePrecedenceForRouteDescription(httpRouteOneDotHost, nil), // zzz.com (1 dot)
},
},
{
name: "input order independent result for mixed hostname and no-hostname rules, with method - input order B",
input: []RouteDescriptor{
httpRouteThreeDotsHost, // a.b.c.com (3 dots)
httpRouteNoHostWithPost, // no hostname with POST
httpRouteOneDotHost, // zzz.com (1 dot)
},
output: []RulePrecedence{
makeRulePrecedenceForRouteDescription(httpRouteNoHostWithPost, func(r *RulePrecedence) { // no hostname with POST
r.HTTPMatch.Method = new(gwv1.HTTPMethodPost)
r.HttpSpecificRulePrecedenceFactor.HasMethod = true
}),
makeRulePrecedenceForRouteDescription(httpRouteThreeDotsHost, nil), // a.b.c.com (3 dots)
makeRulePrecedenceForRouteDescription(httpRouteOneDotHost, nil), // zzz.com (1 dot)
},
},
}

for _, tc := range testCases {
Expand Down