Extract function for adding includes to locations

Author: Kate Osborn

internal/mode/static/nginx/config/servers.go

@@ -240,19 +240,19 @@ func createLocations(server *dataplane.VirtualServer, serverID int) ([]http.Loca
 		for matchRuleIdx, r := range rule.MatchRules {
 			buildLocations := extLocations
 
-			includes := createIncludes(r.Additions)
-
 			if len(rule.MatchRules) != 1 || !isPathOnlyMatch(r.Match) {
 				intLocation, match := initializeInternalLocation(pathRuleIdx, matchRuleIdx, r.Match)
-				intLocation.Includes = includes
 				buildLocations = []http.Location{intLocation}
 				matches = append(matches, match)
-			} else {
-				for i := range extLocations {
-					extLocations[i].Includes = includes
-				}
 			}
 
+			includes := createIncludes(r.Additions)
+
+			// buildLocations will either contain the extLocations OR the intLocation.
+			// If it contains the intLocation, the extLocations will be added to the final locations after we loop
+			// through all the MatchRules.
+			// It is safe to modify the buildLocations here by adding includes and filters.
+			buildLocations = updateLocationsForIncludes(buildLocations, includes)
 			buildLocations = updateLocationsForFilters(r.Filters, buildLocations, r, server.Port, rule.Path, rule.GRPC)
 			locs = append(locs, buildLocations...)
 		}
@@ -281,6 +281,14 @@ func createLocations(server *dataplane.VirtualServer, serverID int) ([]http.Loca
 	return locs, matchPairs, grpc
 }
 
+func updateLocationsForIncludes(locations []http.Location, includes []http.Include) []http.Location {
+	for i := range locations {
+		locations[i].Includes = includes
+	}
+
+	return locations
+}
+
 // pathAndTypeMap contains a map of paths and any path types defined for that path
 // for example, {/foo: {exact: {}, prefix: {}}}
 type pathAndTypeMap map[string]map[dataplane.PathType]struct{}

internal/mode/static/nginx/config/servers_test.go

@@ -584,12 +584,30 @@ func TestCreateServers(t *testing.T) {
 			GRPC: true,
 		},
 		{
-			Path:     "/addition",
+			Path:     "/addition-path-only-match",
 			PathType: dataplane.PathTypeExact,
 			MatchRules: []dataplane.MatchRule{
 				{
 					Match:        dataplane.Match{},
 					BackendGroup: fooGroup,
+					Additions: []*dataplane.Addition{
+						{
+							Bytes:      []byte("path-only-match-addition"),
+							Identifier: "path-only-match-addition",
+						},
+					},
+				},
+			},
+		},
+		{
+			Path:     "/addition-header-match",
+			PathType: dataplane.PathTypeExact,
+			MatchRules: []dataplane.MatchRule{
+				{
+					Match: dataplane.Match{
+						Method: helpers.GetPointer("GET"),
+					},
+					BackendGroup: fooGroup,
 					Additions: []*dataplane.Addition{
 						{
 							Bytes:      []byte("match-addition"),
@@ -684,6 +702,12 @@ func TestCreateServers(t *testing.T) {
 				Any:          false,
 			},
 		},
+		"1_17": {
+			{
+				Method:       "GET",
+				RedirectPath: "@rule17-route0",
+			},
+		},
 	}
 
 	allExpMatchPair := make(httpMatchPairs)
@@ -973,7 +997,17 @@ func TestCreateServers(t *testing.T) {
 				ProxySetHeaders: grpcBaseHeaders,
 			},
 			{
-				Path:            "= /addition",
+				Path:            "= /addition-path-only-match",
+				ProxyPass:       "http://test_foo_80$request_uri",
+				ProxySetHeaders: baseHeaders,
+				Includes: []http.Include{
+					{
+						Filename: includesFolder + "/path-only-match-addition.conf",
+					},
+				},
+			},
+			{
+				Path:            "@rule17-route0",
 				ProxyPass:       "http://test_foo_80$request_uri",
 				ProxySetHeaders: httpBaseHeaders,
 				Includes: []http.Include{
@@ -982,6 +1016,10 @@ func TestCreateServers(t *testing.T) {
 					},
 				},
 			},
+			{
+				Path:         "= /addition-header-match",
+				HTTPMatchKey: ssl + "1_17",
+			},
 		}
 	}