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

Jump to bottom

Use appendAction for translated HeaderValueOptions #8678

Merged
merged 14 commits into from
Sep 18, 2023
Merged

Use appendAction for translated HeaderValueOptions #8678

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
a4dfa17
update header value options to convert append to envoy v3's append ac…
inFocus7 Sep 11, 2023
55770a8
update tests to expect appendAction
inFocus7 Sep 12, 2023
7e60640
Merge refs/heads/main into fix/use-append-action-for-header-value-opt…
soloio-bulldozer[bot] Sep 13, 2023
118a02a
Merge refs/heads/main into fix/use-append-action-for-header-value-opt…
soloio-bulldozer[bot] Sep 14, 2023
d0e6837
remove focused test
inFocus7 Sep 14, 2023
e205010
Merge refs/heads/main into fix/use-append-action-for-header-value-opt…
soloio-bulldozer[bot] Sep 14, 2023
7d0b688
Update append description
inFocus7 Sep 14, 2023
038c729
add changelog
inFocus7 Sep 14, 2023
c4d90a1
Merge branch 'fix/use-append-action-for-header-value-options-v3' of g…
inFocus7 Sep 14, 2023
67a9d17
add extra informatnion on header append/removal docs
inFocus7 Sep 15, 2023
cc32434
Apply suggestions from code review
inFocus7 Sep 15, 2023
3cea278
Update docs/content/guides/traffic_management/request_processing/appe…
inFocus7 Sep 15, 2023
d097a2a
Update docs/content/guides/traffic_management/request_processing/appe…
inFocus7 Sep 15, 2023
c8eef51
Merge refs/heads/main into fix/use-append-action-for-header-value-opt…
soloio-bulldozer[bot] Sep 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
12 changes: 10 additions & 2 deletions pkg/utils/api_conversion/type.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,14 @@ func CheckForbiddenCustomHeaders(header envoycore_sk.HeaderValue) error {
}

func ToEnvoyHeaderValueOptions(option *envoycore_sk.HeaderValueOption, secrets *v1.SecretList, secretOptions HeaderSecretOptions) ([]*envoy_config_core_v3.HeaderValueOption, error) {
// By default, or if `append` is set to true, we'll append the header if it exists.
inFocus7 marked this conversation as resolved.
Show resolved Hide resolved
appendAction := envoy_config_core_v3.HeaderValueOption_APPEND_IF_EXISTS_OR_ADD
if appendOption := option.GetAppend(); appendOption != nil {
if appendOption.GetValue() == false {
appendAction = envoy_config_core_v3.HeaderValueOption_OVERWRITE_IF_EXISTS_OR_ADD
}
}

switch typedOption := option.GetHeaderOption().(type) {
case *envoycore_sk.HeaderValueOption_Header:
if err := CheckForbiddenCustomHeaders(*typedOption.Header); err != nil {
Expand All @@ -92,7 +100,7 @@ func ToEnvoyHeaderValueOptions(option *envoycore_sk.HeaderValueOption, secrets *
Key: typedOption.Header.GetKey(),
Value: typedOption.Header.GetValue(),
},
Append: option.GetAppend(),
AppendAction: appendAction,
},
}, nil
case *envoycore_sk.HeaderValueOption_HeaderSecretRef:
Expand All @@ -117,7 +125,7 @@ func ToEnvoyHeaderValueOptions(option *envoycore_sk.HeaderValueOption, secrets *
Key: key,
Value: value,
},
Append: option.GetAppend(),
AppendAction: appendAction,
})
}
return result, nil
Expand Down
4 changes: 1 addition & 3 deletions pkg/utils/api_conversion/type_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@ var _ = Describe("Type conversion", func() {
Key: "allowed",
Value: "header",
},
Append: &wrappers.BoolValue{
Value: true,
},
AppendAction: envoy_config_core_v3.HeaderValueOption_APPEND_IF_EXISTS_OR_ADD,
},
}
headers, err := ToEnvoyHeaderValueOptionList(allowedHeaders, nil, HeaderSecretOptions{})
Expand Down
10 changes: 9 additions & 1 deletion projects/gloo/pkg/plugins/headers/plugin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,12 +247,20 @@ func convertResponseHeaderValueOption(
return nil, CantSetHostHeaderError
}

// By default, or if `append` is set to true, we'll append the header if it exists.
inFocus7 marked this conversation as resolved.
Show resolved Hide resolved
appendAction := envoy_config_core_v3.HeaderValueOption_APPEND_IF_EXISTS_OR_ADD
sam-heilbron marked this conversation as resolved.
Show resolved Hide resolved
if appendOption := h.GetAppend(); appendOption != nil {
if appendOption.GetValue() == false {
appendAction = envoy_config_core_v3.HeaderValueOption_OVERWRITE_IF_EXISTS_OR_ADD
}
}

out = append(out, &envoy_config_core_v3.HeaderValueOption{
Header: &envoy_config_core_v3.HeaderValue{
Key: header.GetKey(),
Value: header.GetValue(),
},
Append: h.GetAppend(),
AppendAction: appendAction,
})
}
return out, nil
Expand Down
8 changes: 4 additions & 4 deletions projects/gloo/pkg/plugins/headers/plugin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,9 +299,9 @@ var testHeaderManip = &headers.HeaderManipulation{
}

var expectedHeaders = envoyHeaderManipulation{
RequestHeadersToAdd: []*envoy_config_core_v3.HeaderValueOption{{Header: &envoy_config_core_v3.HeaderValue{Key: "foo", Value: "bar"}, Append: &wrappers.BoolValue{Value: true}}},
RequestHeadersToAdd: []*envoy_config_core_v3.HeaderValueOption{{Header: &envoy_config_core_v3.HeaderValue{Key: "foo", Value: "bar"}, AppendAction: envoy_config_core_v3.HeaderValueOption_APPEND_IF_EXISTS_OR_ADD}},
RequestHeadersToRemove: []string{"a"},
ResponseHeadersToAdd: []*envoy_config_core_v3.HeaderValueOption{{Header: &envoy_config_core_v3.HeaderValue{Key: "foo", Value: "bar"}, Append: &wrappers.BoolValue{Value: true}}},
ResponseHeadersToAdd: []*envoy_config_core_v3.HeaderValueOption{{Header: &envoy_config_core_v3.HeaderValue{Key: "foo", Value: "bar"}, AppendAction: envoy_config_core_v3.HeaderValueOption_APPEND_IF_EXISTS_OR_ADD}},
ResponseHeadersToRemove: []string{"b"},
}

Expand All @@ -314,8 +314,8 @@ var testHeaderManipWithSecrets = &headers.HeaderManipulation{
}

var expectedHeadersWithSecrets = envoyHeaderManipulation{
RequestHeadersToAdd: []*envoy_config_core_v3.HeaderValueOption{{Header: &envoy_config_core_v3.HeaderValue{Key: "Authorization", Value: "basic dXNlcjpwYXNzd29yZA=="}, Append: &wrappers.BoolValue{Value: true}}},
RequestHeadersToAdd: []*envoy_config_core_v3.HeaderValueOption{{Header: &envoy_config_core_v3.HeaderValue{Key: "Authorization", Value: "basic dXNlcjpwYXNzd29yZA=="}, AppendAction: envoy_config_core_v3.HeaderValueOption_APPEND_IF_EXISTS_OR_ADD}},
RequestHeadersToRemove: []string{"a"},
ResponseHeadersToAdd: []*envoy_config_core_v3.HeaderValueOption{{Header: &envoy_config_core_v3.HeaderValue{Key: "foo", Value: "bar"}, Append: &wrappers.BoolValue{Value: true}}},
ResponseHeadersToAdd: []*envoy_config_core_v3.HeaderValueOption{{Header: &envoy_config_core_v3.HeaderValue{Key: "foo", Value: "bar"}, AppendAction: envoy_config_core_v3.HeaderValueOption_APPEND_IF_EXISTS_OR_ADD}},
ResponseHeadersToRemove: []string{"b"},
}
8 changes: 2 additions & 6 deletions projects/gloo/pkg/translator/translator_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1277,9 +1277,7 @@ var _ = Describe("Translator", func() {
Key: "Authorization",
Value: "basic dXNlcjpwYXNzd29yZA==",
},
Append: &wrappers.BoolValue{
Value: true,
},
AppendAction: envoy_config_core_v3.HeaderValueOption_APPEND_IF_EXISTS_OR_ADD,
},
}

Expand Down Expand Up @@ -2754,9 +2752,7 @@ var _ = Describe("Translator", func() {
Key: "client-id",
Value: "%REQ(client-id)%",
},
Append: &wrappers.BoolValue{
Value: false,
},
AppendAction: envoy_config_core_v3.HeaderValueOption_OVERWRITE_IF_EXISTS_OR_ADD,
},
))
})
Expand Down