Skip to content

Fix value accumulation for case-sensitive keys in NettyHeadersAdapter #33730

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
package org.springframework.http.support;

import java.util.AbstractSet;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
Expand Down Expand Up @@ -51,6 +53,12 @@ public Netty4HeadersAdapter(HttpHeaders headers) {
this.headers = headers;
}

private void addAllIgnoreCase(String key, List<? extends String> values) {
List<String> listToUpdate = this.get(key);
listToUpdate = listToUpdate == null ? new ArrayList<>() : new ArrayList<>(listToUpdate);
listToUpdate.addAll(values);
this.headers.set(key, listToUpdate);
}

@Override
@Nullable
Expand All @@ -61,18 +69,18 @@ public String getFirst(String key) {
@Override
public void add(String key, @Nullable String value) {
if (value != null) {
this.headers.add(key, value);
addAllIgnoreCase(key, Collections.singletonList(value));
}
}

@Override
public void addAll(String key, List<? extends String> values) {
this.headers.add(key, values);
addAllIgnoreCase(key, values);
}

@Override
public void addAll(MultiValueMap<String, String> values) {
values.forEach(this.headers::add);
values.forEach(this::addAllIgnoreCase);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ public Netty5HeadersAdapter(HttpHeaders headers) {
this.headers = headers;
}

private void addAllIgnoreCase(String key, List<? extends String> values) {
List<String> listToUpdate = this.get(key);
listToUpdate = listToUpdate == null ? new ArrayList<>() : new ArrayList<>(listToUpdate);
listToUpdate.addAll(values);
this.headers.set(key, listToUpdate);
}

@Override
@Nullable
Expand All @@ -64,18 +70,18 @@ public String getFirst(String key) {
@Override
public void add(String key, @Nullable String value) {
if (value != null) {
this.headers.add(key, value);
addAllIgnoreCase(key, Collections.singletonList(value));
}
}

@Override
public void addAll(String key, List<? extends String> values) {
this.headers.add(key, values);
addAllIgnoreCase(key, values);
}

@Override
public void addAll(MultiValueMap<String, String> values) {
values.forEach(this.headers::add);
values.forEach(this::addAllIgnoreCase);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
Expand Down Expand Up @@ -126,6 +127,42 @@ void shouldFailIfHeaderRemovedFromKeyset(MultiValueMap<String, String> headers)
assertThatThrownBy(names::remove).isInstanceOf(IllegalStateException.class);
}

@ParameterizedHeadersTest
void testAddHeadersOutput(MultiValueMap<String, String> headers) {
headers.add("TestHeader", "first");
headers.add("testHeader", "second");
MultiValueMap<String, String> multiValueMap =
CollectionUtils.toMultiValueMap(new LinkedCaseInsensitiveMap<>(8, Locale.ENGLISH));
headers.forEach(multiValueMap::addAll);
assertThat(multiValueMap.toString()).isEqualToIgnoringCase("{testheader=[first, second]}");
}

@ParameterizedHeadersTest
void testAddAllSingletonHeadersOutput(MultiValueMap<String, String> headers) {
headers.addAll("TestHeader", Collections.singletonList("first"));
headers.addAll("testHeader", Collections.singletonList("second"));
MultiValueMap<String, String> multiValueMap =
CollectionUtils.toMultiValueMap(new LinkedCaseInsensitiveMap<>(8, Locale.ENGLISH));
headers.forEach(multiValueMap::addAll);
assertThat(multiValueMap.toString()).isEqualToIgnoringCase("{testheader=[first, second]}");
}

@ParameterizedHeadersTest
void testAddAllMultipleHeadersOutput(MultiValueMap<String, String> headers) {
MultiValueMap<String, String> map1 =
CollectionUtils.toMultiValueMap(new LinkedCaseInsensitiveMap<>(8, Locale.ENGLISH));
map1.add("TestHeader", "first");
headers.addAll(map1);
MultiValueMap<String, String> map2 =
CollectionUtils.toMultiValueMap(new LinkedCaseInsensitiveMap<>(8, Locale.ENGLISH));
map2.add("testHeader", "second");
headers.addAll(map2);
MultiValueMap<String, String> multiValueMap =
CollectionUtils.toMultiValueMap(new LinkedCaseInsensitiveMap<>(8, Locale.ENGLISH));
headers.forEach(multiValueMap::addAll);
assertThat(multiValueMap.toString()).isEqualToIgnoringCase("{testheader=[first, second]}");
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@ParameterizedTest
Expand Down