Skip to content

Remove Gateway API types from Configuration-related types in dataplane package #976

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

Merged
merged 4 commits into from
Aug 18, 2023
Merged

Remove Gateway API types from Configuration-related types in dataplane package #976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
79bc829
Remove Gateway API types from Configuration-related types in dataplan…
pleshakov Aug 15, 2023
90b3c56
Add doc comments
pleshakov Aug 18, 2023
d725090
More comments
pleshakov Aug 18, 2023
63817ed
Merge branch 'main' into tech-debt/refactor-dataplane-package
pleshakov Aug 18, 2023
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
10 changes: 5 additions & 5 deletions internal/mode/static/nginx/config/maps_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ func TestExecuteMaps(t *testing.T) {
{
MatchRules: []dataplane.MatchRule{
{
Filters: dataplane.Filters{
Filters: dataplane.HTTPFilters{
RequestHeaderModifiers: &dataplane.HTTPHeaderFilter{
Add: []dataplane.HTTPHeader{
{
Expand All @@ -28,7 +28,7 @@ func TestExecuteMaps(t *testing.T) {
},
},
{
Filters: dataplane.Filters{
Filters: dataplane.HTTPFilters{
RequestHeaderModifiers: &dataplane.HTTPHeaderFilter{
Add: []dataplane.HTTPHeader{
{
Expand All @@ -40,7 +40,7 @@ func TestExecuteMaps(t *testing.T) {
},
},
{
Filters: dataplane.Filters{
Filters: dataplane.HTTPFilters{
RequestHeaderModifiers: &dataplane.HTTPHeaderFilter{
Set: []dataplane.HTTPHeader{
{
Expand Down Expand Up @@ -100,7 +100,7 @@ func TestBuildAddHeaderMaps(t *testing.T) {
{
MatchRules: []dataplane.MatchRule{
{
Filters: dataplane.Filters{
Filters: dataplane.HTTPFilters{
RequestHeaderModifiers: &dataplane.HTTPHeaderFilter{
Add: []dataplane.HTTPHeader{
{
Expand All @@ -126,7 +126,7 @@ func TestBuildAddHeaderMaps(t *testing.T) {
},
},
{
Filters: dataplane.Filters{
Filters: dataplane.HTTPFilters{
RequestHeaderModifiers: &dataplane.HTTPHeaderFilter{
Set: []dataplane.HTTPHeader{
{
Expand Down
46 changes: 19 additions & 27 deletions internal/mode/static/nginx/config/servers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import (
"strings"
gotemplate "text/template"

"sigs.k8s.io/gateway-api/apis/v1beta1"

"github.com/nginxinc/nginx-kubernetes-gateway/internal/mode/static/nginx/config/http"
"github.com/nginxinc/nginx-kubernetes-gateway/internal/mode/static/state/dataplane"
)
Expand Down Expand Up @@ -89,11 +87,9 @@ func createLocations(pathRules []dataplane.PathRule, listenerPort int32) []http.
extLocations := initializeExternalLocations(rule, pathsAndTypes)

for matchRuleIdx, r := range rule.MatchRules {
m := r.GetMatch()

buildLocations := extLocations
if len(rule.MatchRules) != 1 || !isPathOnlyMatch(m) {
intLocation, match := initializeInternalLocation(rule, matchRuleIdx, m)
if len(rule.MatchRules) != 1 || !isPathOnlyMatch(r.Match) {
intLocation, match := initializeInternalLocation(rule, matchRuleIdx, r.Match)
buildLocations = []http.Location{intLocation}
matches = append(matches, match)
}
Expand Down Expand Up @@ -228,20 +224,20 @@ func initializeExternalLocations(
func initializeInternalLocation(
rule dataplane.PathRule,
matchRuleIdx int,
match v1beta1.HTTPRouteMatch,
match dataplane.Match,
) (http.Location, httpMatch) {
path := createPathForMatch(rule.Path, rule.PathType, matchRuleIdx)
return createMatchLocation(path), createHTTPMatch(match, path)
}

func createReturnValForRedirectFilter(filter *v1beta1.HTTPRequestRedirectFilter, listenerPort int32) *http.Return {
func createReturnValForRedirectFilter(filter *dataplane.HTTPRequestRedirectFilter, listenerPort int32) *http.Return {
if filter == nil {
return nil
}

hostname := "$host"
if filter.Hostname != nil {
hostname = string(*filter.Hostname)
hostname = *filter.Hostname
}

code := http.StatusFound
Expand All @@ -251,7 +247,7 @@ func createReturnValForRedirectFilter(filter *v1beta1.HTTPRequestRedirectFilter,

port := listenerPort
if filter.Port != nil {
port = int32(*filter.Port)
port = *filter.Port
}

hostnamePort := fmt.Sprintf("%s:%d", hostname, port)
Expand Down Expand Up @@ -286,7 +282,7 @@ func createReturnValForRedirectFilter(filter *v1beta1.HTTPRequestRedirectFilter,
// If the request satisfies the httpMatch, NGINX will redirect the request to the location RedirectPath.
type httpMatch struct {
// Method is the HTTPMethod of the HTTPRouteMatch.
Method v1beta1.HTTPMethod `json:"method,omitempty"`
Method string `json:"method,omitempty"`
// RedirectPath is the path to redirect the request to if the request satisfies the match conditions.
RedirectPath string `json:"redirectPath,omitempty"`
// Headers is a list of HTTPHeaders name value pairs with the format "{name}:{value}".
Expand All @@ -297,7 +293,7 @@ type httpMatch struct {
Any bool `json:"any,omitempty"`
}

func createHTTPMatch(match v1beta1.HTTPRouteMatch, redirectPath string) httpMatch {
func createHTTPMatch(match dataplane.Match, redirectPath string) httpMatch {
hm := httpMatch{
RedirectPath: redirectPath,
}
Expand All @@ -316,14 +312,12 @@ func createHTTPMatch(match v1beta1.HTTPRouteMatch, redirectPath string) httpMatc
headerNames := make(map[string]struct{})

for _, h := range match.Headers {
if *h.Type == v1beta1.HeaderMatchExact {
// duplicate header names are not permitted by the spec
// only configure the first entry for every header name (case-insensitive)
lowerName := strings.ToLower(string(h.Name))
if _, ok := headerNames[lowerName]; !ok {
headers = append(headers, createHeaderKeyValString(h))
headerNames[lowerName] = struct{}{}
}
// duplicate header names are not permitted by the spec
// only configure the first entry for every header name (case-insensitive)
lowerName := strings.ToLower(h.Name)
if _, ok := headerNames[lowerName]; !ok {
headers = append(headers, createHeaderKeyValString(h))
headerNames[lowerName] = struct{}{}
}
}
hm.Headers = headers
Expand All @@ -333,9 +327,7 @@ func createHTTPMatch(match v1beta1.HTTPRouteMatch, redirectPath string) httpMatc
params := make([]string, 0, len(match.QueryParams))

for _, p := range match.QueryParams {
if *p.Type == v1beta1.QueryParamMatchExact {
params = append(params, createQueryParamKeyValString(p))
}
params = append(params, createQueryParamKeyValString(p))
}
hm.QueryParams = params
}
Expand All @@ -345,7 +337,7 @@ func createHTTPMatch(match v1beta1.HTTPRouteMatch, redirectPath string) httpMatc

// The name and values are delimited by "=". A name and value can always be recovered using strings.SplitN(arg,"=", 2).
// Query Parameters are case-sensitive so case is preserved.
func createQueryParamKeyValString(p v1beta1.HTTPQueryParamMatch) string {
func createQueryParamKeyValString(p dataplane.HTTPQueryParamMatch) string {
return string(p.Name) + "=" + p.Value
}

Expand All @@ -354,12 +346,12 @@ func createQueryParamKeyValString(p v1beta1.HTTPQueryParamMatch) string {
// Ex. foo:bar == FOO:bar, but foo:bar != foo:BAR,
// We preserve the case of the name here because NGINX allows us to look up the header names in a case-insensitive
// manner.
func createHeaderKeyValString(h v1beta1.HTTPHeaderMatch) string {
func createHeaderKeyValString(h dataplane.HTTPHeaderMatch) string {
return string(h.Name) + HeaderMatchSeparator + h.Value
}

func isPathOnlyMatch(match v1beta1.HTTPRouteMatch) bool {
return match.Method == nil && match.Headers == nil && match.QueryParams == nil
func isPathOnlyMatch(match dataplane.Match) bool {
return match.Method == nil && len(match.Headers) == 0 && len(match.QueryParams) == 0
}

func createProxyPass(backendGroup dataplane.BackendGroup) string {
Expand Down
Loading