Skip to content
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

Support for HTTP_ROUTE array insert in EnvoyFilter #27084

Merged
merged 3 commits into from
Sep 28, 2020
Merged

Support for HTTP_ROUTE array insert in EnvoyFilter #27084

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
ac75cf5
add support for INSERT_FIRST, INSERT_BEFORE, INSERT_AFTER array opera…
GregHanson Sep 4, 2020
5191c2b
add tests for array insert behavior for HTTP_ROUTE EnvoyFilters
GregHanson Sep 4, 2020
c4a3e3c
release note for added EnvoyFilter features for HTTP_ROUTE
GregHanson Sep 4, 2020
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
5 changes: 3 additions & 2 deletions pilot/pkg/model/envoyfilter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,10 @@ func convertToEnvoyFilterWrapper(local *config.Config) *EnvoyFilterWrapper {
cpw.Operation == networking.EnvoyFilter_Patch_INSERT_BEFORE ||
cpw.Operation == networking.EnvoyFilter_Patch_INSERT_FIRST {
// insert_before, after or first is applicable only for network filter and http filter
// TODO: insert before/after is also applicable to http_routes
// convert the rest to add
if cpw.ApplyTo != networking.EnvoyFilter_HTTP_FILTER && cpw.ApplyTo != networking.EnvoyFilter_NETWORK_FILTER {
if cpw.ApplyTo != networking.EnvoyFilter_HTTP_FILTER &&
cpw.ApplyTo != networking.EnvoyFilter_NETWORK_FILTER &&
cpw.ApplyTo != networking.EnvoyFilter_HTTP_ROUTE {
cpw.Operation = networking.EnvoyFilter_Patch_ADD
}
}
Expand Down
79 changes: 74 additions & 5 deletions pilot/pkg/networking/core/v1alpha3/envoyfilter/rc_patch.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func ApplyRouteConfigurationPatches(
push *model.PushContext,
routeConfiguration *route.RouteConfiguration) (out *route.RouteConfiguration) {
defer runtime.HandleCrash(runtime.LogPanic, func(interface{}) {
log.Errorf("listeners patch caused panic, so the patches did not take effect")
log.Errorf("route patch caused panic, so the patches did not take effect")
})
// In case the patches cause panic, use the route generated before to reduce the influence.
out = routeConfiguration
Expand Down Expand Up @@ -115,6 +115,20 @@ func doVirtualHostOperation(patchContext networking.EnvoyFilter_PatchContext,
doHTTPRouteListOperation(patchContext, patches, routeConfiguration, virtualHost)
}

func hasRouteMatch(cp *model.EnvoyFilterConfigPatchWrapper) bool {
cMatch := cp.Match.GetRouteConfiguration()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: this whole thing could be cp.Match.GetRouteConfiguration().GetVhost().GetRoute() != nil I think

if cMatch == nil {
return false
}

vhMatch := cMatch.Vhost
if vhMatch == nil {
return false
}

return vhMatch.Route != nil
}

func doHTTPRouteListOperation(patchContext networking.EnvoyFilter_PatchContext,
patches map[networking.EnvoyFilter_ApplyTo][]*model.EnvoyFilterConfigPatchWrapper,
routeConfiguration *route.RouteConfiguration, virtualHost *route.VirtualHost) {
Expand All @@ -127,13 +141,68 @@ func doHTTPRouteListOperation(patchContext networking.EnvoyFilter_PatchContext,

// now for the adds
for _, cp := range patches[networking.EnvoyFilter_HTTP_ROUTE] {
if cp.Operation != networking.EnvoyFilter_Patch_ADD {
if !commonConditionMatch(patchContext, cp) ||
!routeConfigurationMatch(patchContext, routeConfiguration, cp) ||
!virtualHostMatch(virtualHost, cp) {
continue
}
if commonConditionMatch(patchContext, cp) &&
routeConfigurationMatch(patchContext, routeConfiguration, cp) &&
virtualHostMatch(virtualHost, cp) {

if cp.Operation == networking.EnvoyFilter_Patch_ADD {
virtualHost.Routes = append(virtualHost.Routes, proto.Clone(cp.Value).(*route.Route))
} else if cp.Operation == networking.EnvoyFilter_Patch_INSERT_AFTER {
// Insert after without a route match is same as ADD in the end
if !hasRouteMatch(cp) {
virtualHost.Routes = append(virtualHost.Routes, proto.Clone(cp.Value).(*route.Route))
continue
}
// find the matching route first
insertPosition := -1
for i := 0; i < len(virtualHost.Routes); i++ {
if routeMatch(virtualHost.Routes[i], cp) {
insertPosition = i + 1
break
}
}

if insertPosition == -1 {
continue
}

clonedVal := proto.Clone(cp.Value).(*route.Route)
virtualHost.Routes = append(virtualHost.Routes, clonedVal)
if insertPosition < len(virtualHost.Routes)-1 {
copy(virtualHost.Routes[insertPosition+1:], virtualHost.Routes[insertPosition:])
virtualHost.Routes[insertPosition] = clonedVal
}
} else if cp.Operation == networking.EnvoyFilter_Patch_INSERT_BEFORE || cp.Operation == networking.EnvoyFilter_Patch_INSERT_FIRST {
// insert before/first without a route match is same as insert in the beginning
if !hasRouteMatch(cp) {
virtualHost.Routes = append([]*route.Route{proto.Clone(cp.Value).(*route.Route)}, virtualHost.Routes...)
continue
}
// find the matching route first
insertPosition := -1
for i := 0; i < len(virtualHost.Routes); i++ {
if routeMatch(virtualHost.Routes[i], cp) {
insertPosition = i
break
}
}

// If matching route is not found, then don't insert and continue.
if insertPosition == -1 {
continue
}

// In case of INSERT_FIRST, if a match is found, still insert it at the top of the routes.
if cp.Operation == networking.EnvoyFilter_Patch_INSERT_FIRST {
insertPosition = 0
}

clonedVal := proto.Clone(cp.Value).(*route.Route)
virtualHost.Routes = append(virtualHost.Routes, clonedVal)
copy(virtualHost.Routes[insertPosition+1:], virtualHost.Routes[insertPosition:])
virtualHost.Routes[insertPosition] = clonedVal
}
}

Expand Down
175 changes: 174 additions & 1 deletion pilot/pkg/networking/core/v1alpha3/envoyfilter/rc_patch_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,84 @@ func TestApplyRouteConfigurationPatches(t *testing.T) {
Value: buildPatchStruct(`{"domains":["domain:80"]}`),
},
},
{
ApplyTo: networking.EnvoyFilter_HTTP_ROUTE,
Match: &networking.EnvoyFilter_EnvoyConfigObjectMatch{
Context: networking.EnvoyFilter_ANY,
ObjectTypes: &networking.EnvoyFilter_EnvoyConfigObjectMatch_RouteConfiguration{
RouteConfiguration: &networking.EnvoyFilter_RouteConfigurationMatch{
PortNumber: 9090,
Vhost: &networking.EnvoyFilter_RouteConfigurationMatch_VirtualHostMatch{
Name: "test.com",
},
},
},
},
Patch: &networking.EnvoyFilter_Patch{
Operation: networking.EnvoyFilter_Patch_ADD,
Value: buildPatchStruct(`{"name": "route4.0"}`),
},
},
{
ApplyTo: networking.EnvoyFilter_HTTP_ROUTE,
Match: &networking.EnvoyFilter_EnvoyConfigObjectMatch{
Context: networking.EnvoyFilter_ANY,
ObjectTypes: &networking.EnvoyFilter_EnvoyConfigObjectMatch_RouteConfiguration{
RouteConfiguration: &networking.EnvoyFilter_RouteConfigurationMatch{
PortNumber: 9090,
Vhost: &networking.EnvoyFilter_RouteConfigurationMatch_VirtualHostMatch{
Name: "test.com",
},
},
},
},
Patch: &networking.EnvoyFilter_Patch{
Operation: networking.EnvoyFilter_Patch_INSERT_FIRST,
Value: buildPatchStruct(`{"name": "route0.0"}`),
},
},
{
ApplyTo: networking.EnvoyFilter_HTTP_ROUTE,
Match: &networking.EnvoyFilter_EnvoyConfigObjectMatch{
Context: networking.EnvoyFilter_ANY,
ObjectTypes: &networking.EnvoyFilter_EnvoyConfigObjectMatch_RouteConfiguration{
RouteConfiguration: &networking.EnvoyFilter_RouteConfigurationMatch{
PortNumber: 9090,
Vhost: &networking.EnvoyFilter_RouteConfigurationMatch_VirtualHostMatch{
Name: "test.com",
Route: &networking.EnvoyFilter_RouteConfigurationMatch_RouteMatch{
Name: "route2.0",
},
},
},
},
},
Patch: &networking.EnvoyFilter_Patch{
Operation: networking.EnvoyFilter_Patch_INSERT_AFTER,
Value: buildPatchStruct(`{"name": "route2.5"}`),
},
},
{
ApplyTo: networking.EnvoyFilter_HTTP_ROUTE,
Match: &networking.EnvoyFilter_EnvoyConfigObjectMatch{
Context: networking.EnvoyFilter_ANY,
ObjectTypes: &networking.EnvoyFilter_EnvoyConfigObjectMatch_RouteConfiguration{
RouteConfiguration: &networking.EnvoyFilter_RouteConfigurationMatch{
PortNumber: 9090,
Vhost: &networking.EnvoyFilter_RouteConfigurationMatch_VirtualHostMatch{
Name: "test.com",
Route: &networking.EnvoyFilter_RouteConfigurationMatch_RouteMatch{
Name: "route2.0",
},
},
},
},
},
Patch: &networking.EnvoyFilter_Patch{
Operation: networking.EnvoyFilter_Patch_INSERT_BEFORE,
Value: buildPatchStruct(`{"name": "route1.5"}`),
},
},
}

sidecarOutboundRC := &route.RouteConfiguration{
Expand Down Expand Up @@ -411,6 +489,91 @@ func TestApplyRouteConfigurationPatches(t *testing.T) {
},
},
}
arrayInsert := &route.RouteConfiguration{
Name: "9090",
VirtualHosts: []*route.VirtualHost{
{
Name: "test.com",
Domains: []string{"domain"},
Routes: []*route.Route{
{
Name: "route1.0",
Action: &route.Route_Route{
Route: &route.RouteAction{
PrefixRewrite: "/",
},
},
},
{
Name: "route2.0",
Action: &route.Route_Redirect{
Redirect: &route.RedirectAction{
ResponseCode: 301,
},
},
},
{
Name: "route3.0",
Action: &route.Route_Redirect{
Redirect: &route.RedirectAction{
ResponseCode: 404,
},
},
},
},
},
},
}
patchedArrayInsert := &route.RouteConfiguration{
Name: "9090",
VirtualHosts: []*route.VirtualHost{
{
Name: "test.com",
Domains: []string{"domain", "domain:80"},
Routes: []*route.Route{
{
Name: "route0.0",
},
{
Name: "route1.0",
Action: &route.Route_Route{
Route: &route.RouteAction{
PrefixRewrite: "/",
},
},
},
{
Name: "route1.5",
},
{
Name: "route2.0",
Action: &route.Route_Redirect{
Redirect: &route.RedirectAction{
ResponseCode: 301,
},
},
},
{
Name: "route2.5",
},
{
Name: "route3.0",
Action: &route.Route_Redirect{
Redirect: &route.RedirectAction{
ResponseCode: 404,
},
},
},
{
Name: "route4.0",
},
},
},
{
Name: "new-vhost",
},
},
}

serviceDiscovery := memory.NewServiceDiscovery(nil)
env := newTestEnvironment(serviceDiscovery, testMesh, buildEnvoyFilterConfigStore(configPatches))
Expand Down Expand Up @@ -461,13 +624,23 @@ func TestApplyRouteConfigurationPatches(t *testing.T) {
},
want: patchedGatewayRC,
},
{
name: "array insert patch",
args: args{
patchContext: networking.EnvoyFilter_SIDECAR_OUTBOUND,
proxy: sidecarNode,
push: push,
routeConfiguration: arrayInsert,
},
want: patchedArrayInsert,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := ApplyRouteConfigurationPatches(tt.args.patchContext, tt.args.proxy,
tt.args.push, tt.args.routeConfiguration)
if diff := cmp.Diff(tt.want, got, protocmp.Transform()); diff != "" {
t.Errorf("ApplyListenerPatches(): %s mismatch (-want +got):\n%s", tt.name, diff)
t.Errorf("ApplyRouteConfigurationPatches(): %s mismatch (-want +got):\n%s", tt.name, diff)
}
})
}
Expand Down
9 changes: 9 additions & 0 deletions releasenotes/notes/27084.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
apiVersion: release-notes/v2
kind: feature
area: traffic-management
issue:
- 26692

releaseNotes:
- |
**Added** support for `INSERT_FIRST`, `INSERT_BEFORE`, `INSERT_AFTER` insert operations for `HTTP_ROUTE` in EnvoyFilter