MessageHeaderAccessor handle self-copy correctly

1. Revert changes in setHeader from 5.2.9 that caused regression on self-copy.
2. Update copyHeaders to ensure it still gets a copy of native headers.
3. Exit if source and target are the same instance, as an optimization.

Closes gh-26155

Author: rstoyanchev

spring-messaging/src/main/java/org/springframework/messaging/support/MessageHeaderAccessor.java

@@ -378,27 +378,29 @@ private List<String> getMatchingHeaderNames(String pattern, @Nullable Map<String
 	 * {@link #copyHeadersIfAbsent(Map)} to avoid overwriting values.
 	 */
 	public void copyHeaders(@Nullable Map<String, ?> headersToCopy) {
-		if (headersToCopy != null) {
-			headersToCopy.forEach((key, value) -> {
-				if (!isReadOnly(key)) {
-					setHeader(key, value);
-				}
-			});
+		if (headersToCopy == null || this.headers == headersToCopy) {
+			return;
 		}
+		headersToCopy.forEach((key, value) -> {
+			if (!isReadOnly(key)) {
+				setHeader(key, value);
+			}
+		});
 	}
 
 	/**
 	 * Copy the name-value pairs from the provided Map.
 	 * <p>This operation will <em>not</em> overwrite any existing values.
 	 */
 	public void copyHeadersIfAbsent(@Nullable Map<String, ?> headersToCopy) {
-		if (headersToCopy != null) {
-			headersToCopy.forEach((key, value) -> {
-				if (!isReadOnly(key)) {
-					setHeaderIfAbsent(key, value);
-				}
-			});
+		if (headersToCopy == null || this.headers == headersToCopy) {
+			return;
 		}
+		headersToCopy.forEach((key, value) -> {
+			if (!isReadOnly(key)) {
+				setHeaderIfAbsent(key, value);
+			}
+		});
 	}
 
 	protected boolean isReadOnly(String headerName) {

spring-messaging/src/main/java/org/springframework/messaging/support/NativeMessageHeaderAccessor.java

@@ -75,6 +75,8 @@ protected NativeMessageHeaderAccessor(@Nullable Message<?> message) {
 			@SuppressWarnings("unchecked")
 			Map<String, List<String>> map = (Map<String, List<String>>) getHeader(NATIVE_HEADERS);
 			if (map != null) {
+				// setHeader checks for equality but we need copy of native headers
+				setHeader(NATIVE_HEADERS, null);
 				setHeader(NATIVE_HEADERS, new LinkedMultiValueMap<>(map));
 			}
 		}
@@ -103,38 +105,28 @@ public void setImmutable() {
 		if (isMutable()) {
 			Map<String, List<String>> map = getNativeHeaders();
 			if (map != null) {
+				// setHeader checks for equality but we need immutable wrapper
+				setHeader(NATIVE_HEADERS, null);
 				setHeader(NATIVE_HEADERS, Collections.unmodifiableMap(map));
 			}
 			super.setImmutable();
 		}
 	}
 
 	@Override
-	public void setHeader(String name, @Nullable Object value) {
-		if (name.equalsIgnoreCase(NATIVE_HEADERS)) {
-			// Force removal since setHeader checks for equality
-			super.setHeader(NATIVE_HEADERS, null);
+	public void copyHeaders(@Nullable Map<String, ?> headersToCopy) {
+		if (headersToCopy == null) {
+			return;
 		}
-		super.setHeader(name, value);
-	}
 
-	@Override
-	@SuppressWarnings("unchecked")
-	public void copyHeaders(@Nullable Map<String, ?> headersToCopy) {
-		if (headersToCopy != null) {
-			Map<String, List<String>> nativeHeaders = getNativeHeaders();
-			Map<String, List<String>> map = (Map<String, List<String>>) headersToCopy.get(NATIVE_HEADERS);
-			if (map != null) {
-				if (nativeHeaders != null) {
-					nativeHeaders.putAll(map);
-				}
-				else {
-					nativeHeaders = new LinkedMultiValueMap<>(map);
-				}
-			}
-			super.copyHeaders(headersToCopy);
-			setHeader(NATIVE_HEADERS, nativeHeaders);
+		@SuppressWarnings("unchecked")
+		Map<String, List<String>> map = (Map<String, List<String>>) headersToCopy.get(NATIVE_HEADERS);
+		if (map != null && map != getNativeHeaders()) {
+			map.forEach(this::setNativeHeaderValues);
 		}
+
+		// setHeader checks for equality, native headers should be equal by now
+		super.copyHeaders(headersToCopy);
 	}
 
 	/**
@@ -201,6 +193,30 @@ public void setNativeHeader(String name, @Nullable String value) {
 		}
 	}
 
+	/**
+	 * Variant of {@link #addNativeHeader(String, String)} for all values.
+	 * @since 5.2.12
+	 */
+	public void setNativeHeaderValues(String name, @Nullable List<String> values) {
+		Assert.state(isMutable(), "Already immutable");
+		Map<String, List<String>> map = getNativeHeaders();
+		if (values == null) {
+			if (map != null && map.get(name) != null) {
+				setModified(true);
+				map.remove(name);
+			}
+			return;
+		}
+		if (map == null) {
+			map = new LinkedMultiValueMap<>(3);
+			setHeader(NATIVE_HEADERS, map);
+		}
+		if (!ObjectUtils.nullSafeEquals(values, getHeader(name))) {
+			setModified(true);
+			map.put(name, new ArrayList<>(values));
+		}
+	}
+
 	/**
 	 * Add the specified native header value to existing values.
 	 * <p>In order for this to work, the accessor must be {@link #isMutable()

spring-messaging/src/test/java/org/springframework/messaging/support/NativeMessageHeaderAccessorTests.java

@@ -241,4 +241,14 @@ void copyImmutableToMutable() {
 		assertThat(((NativeMessageHeaderAccessor) accessor).getNativeHeader("foo")).containsExactly("bar", "baz");
 	}
 
+	@Test // gh-26155
+	void copySelf() {
+		NativeMessageHeaderAccessor accessor = new NativeMessageHeaderAccessor();
+		accessor.addNativeHeader("foo", "bar");
+		accessor.setHeader("otherHeader", "otherHeaderValue");
+		accessor.setLeaveMutable(true);
+
+		// Does not fail with ConcurrentModificationException
+		accessor.copyHeaders(accessor.getMessageHeaders());
+	}
 }