Retain entry set order in read-only HttpHeaders

Prior to this commit, the entry set of read-only HttpHeaders lost the
original headers' ordering.

The changes in commit ce7278a introduced a regression in the read-only
HttpHeaders support. Specifically, the implementation of entrySet() in
the internal ReadOnlyHttpHeaders class converted the original entry set
to an immutable, non-ordered set of immutable entries.

This commit fixes this issue by converting the original entry set to an
immutable, ordered set of immutable entries.

Closes gh-23551

Author: sbrannen

spring-web/src/main/java/org/springframework/http/ReadOnlyHttpHeaders.java

@@ -16,9 +16,10 @@
 
 package org.springframework.http;
 
-import java.util.AbstractMap;
+import java.util.AbstractMap.SimpleImmutableEntry;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -31,6 +32,7 @@
  * {@code HttpHeaders} object that can only be read, not written to.
  *
  * @author Brian Clozel
+ * @author Sam Brannen
  * @since 5.1.1
  */
 class ReadOnlyHttpHeaders extends HttpHeaders {
@@ -141,9 +143,10 @@ public Collection<List<String>> values() {
 
 	@Override
 	public Set<Entry<String, List<String>>> entrySet() {
-		return Collections.unmodifiableSet(this.headers.entrySet().stream()
-				.map(AbstractMap.SimpleImmutableEntry::new)
-				.collect(Collectors.toSet()));
+		return this.headers.entrySet().stream().map(SimpleImmutableEntry::new)
+				.collect(Collectors.collectingAndThen(
+						Collectors.toCollection(LinkedHashSet::new), // Retain original ordering of entries
+						Collections::unmodifiableSet));
 	}
 
 }

spring-web/src/test/java/org/springframework/http/HttpHeadersTests.java

@@ -32,6 +32,7 @@
 import java.util.GregorianCalendar;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map.Entry;
 import java.util.TimeZone;
 
 import org.hamcrest.Matchers;
@@ -47,6 +48,7 @@
  * @author Sebastien Deleuze
  * @author Brian Clozel
  * @author Juergen Hoeller
+ * @author Sam Brannen
  */
 public class HttpHeadersTests {
 
@@ -557,4 +559,20 @@ public void bearerAuth() {
 		assertEquals("Bearer foo", authorization);
 	}
 
+	@Test
+	public void readOnlyHttpHeadersRetainEntrySetOrder() {
+		headers.add("aardvark", "enigma");
+		headers.add("beaver", "enigma");
+		headers.add("cat", "enigma");
+		headers.add("dog", "enigma");
+		headers.add("elephant", "enigma");
+
+		String[] expectedKeys = new String[] { "aardvark", "beaver", "cat", "dog", "elephant" };
+
+		assertArrayEquals(expectedKeys, headers.entrySet().stream().map(Entry::getKey).toArray());
+
+		HttpHeaders readOnlyHttpHeaders = HttpHeaders.readOnlyHttpHeaders(headers);
+		assertArrayEquals(expectedKeys, readOnlyHttpHeaders.entrySet().stream().map(Entry::getKey).toArray());
+	}
+
 }