Polishing contribution

Closes gh-29958

Author: rstoyanchev

spring-web/src/main/java/org/springframework/http/client/reactive/ClientHttpRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -48,16 +48,17 @@ public interface ClientHttpRequest extends ReactiveHttpOutputMessage {
 	 */
 	MultiValueMap<String, HttpCookie> getCookies();
 
+	/**
+	 * Return a mutable map of the request attributes.
+	 * @since 6.2
+	 */
+	Map<String, Object> getAttributes();
+
 	/**
 	 * Return the request from the underlying HTTP library.
 	 * @param <T> the expected type of the request to cast to
 	 * @since 5.3
 	 */
 	<T> T getNativeRequest();
 
-	/**
-	 * Return a mutable map of the request attributes.
-	 */
-	Map<String, Object> getAttributes();
-
 }

spring-web/src/main/java/org/springframework/http/client/reactive/ClientHttpRequestDecorator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -76,6 +76,11 @@ public MultiValueMap<String, HttpCookie> getCookies() {
 		return this.delegate.getCookies();
 	}
 
+	@Override
+	public Map<String, Object> getAttributes() {
+		return this.delegate.getAttributes();
+	}
+
 	@Override
 	public DataBufferFactory bufferFactory() {
 		return this.delegate.bufferFactory();
@@ -86,11 +91,6 @@ public <T> T getNativeRequest() {
 		return this.delegate.getNativeRequest();
 	}
 
-	@Override
-	public Map<String, Object> getAttributes() {
-		return this.delegate.getAttributes();
-	}
-
 	@Override
 	public void beforeCommit(Supplier<? extends Mono<Void>> action) {
 		this.delegate.beforeCommit(action);

spring-web/src/main/java/org/springframework/http/client/reactive/HttpComponentsClientHttpRequest.java

@@ -163,7 +163,7 @@ protected void applyCookies() {
 	@Override
 	protected void applyAttributes() {
 		getAttributes().forEach((key, value) -> {
-			if(this.context.getAttribute(key) == null) {
+			if (this.context.getAttribute(key) == null) {
 				this.context.setAttribute(key, value);
 			}
 		});

spring-web/src/main/java/org/springframework/http/client/reactive/JettyClientHttpRequest.java

@@ -138,14 +138,6 @@ protected void applyCookies() {
 				.forEach(this.jettyRequest::cookie);
 	}
 
-	/**
-	 * Applies the attributes to {@link Request#getAttributes()}.
-	 */
-	@Override
-	protected void applyAttributes() {
-		getAttributes().forEach(this.jettyRequest::attribute);
-	}
-
 	@Override
 	protected void applyHeaders() {
 		HttpHeaders headers = getHeaders();
@@ -162,6 +154,15 @@ protected HttpHeaders initReadOnlyHeaders() {
 		return HttpHeaders.readOnlyHttpHeaders(new JettyHeadersAdapter(this.jettyRequest.getHeaders()));
 	}
 
+	@Override
+	protected void applyAttributes() {
+		getAttributes().forEach((key, value) -> {
+			if (this.jettyRequest.getAttributes().get(key) == null) {
+				this.jettyRequest.attribute(key, value);
+			}
+		});
+	}
+
 	public ReactiveRequest toReactiveRequest() {
 		return this.builder.build();
 	}

spring-web/src/main/java/org/springframework/http/client/reactive/ReactorClientHttpConnector.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,9 +17,11 @@
 package org.springframework.http.client.reactive;
 
 import java.net.URI;
+import java.util.Map;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.Function;
 
+import io.netty.util.AttributeKey;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import reactor.core.publisher.Mono;
@@ -49,6 +51,13 @@
  */
 public class ReactorClientHttpConnector implements ClientHttpConnector, SmartLifecycle {
 
+	/**
+	 * Channel attribute key under which {@code WebClient} request attributes are stored as a Map.
+	 * @since 6.2
+	 */
+	public static final AttributeKey<Map<String, Object>> ATTRIBUTES_KEY =
+			AttributeKey.valueOf(ReactorClientHttpRequest.class.getName() + ".ATTRIBUTES");
+
 	private static final Log logger = LogFactory.getLog(ReactorClientHttpConnector.class);
 
 	private static final Function<HttpClient, HttpClient> defaultInitializer = client -> client.compress(true);

spring-web/src/main/java/org/springframework/http/client/reactive/ReactorClientHttpRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2023 the original author or authors.
+ * Copyright 2002-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,11 +18,9 @@
 
 import java.net.URI;
 import java.nio.file.Path;
-import java.util.Map;
 
 import io.netty.buffer.ByteBuf;
 import io.netty.handler.codec.http.cookie.DefaultCookie;
-import io.netty.util.AttributeKey;
 import org.reactivestreams.Publisher;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
@@ -48,8 +46,6 @@
  */
 class ReactorClientHttpRequest extends AbstractClientHttpRequest implements ZeroCopyHttpOutputMessage {
 
-	public static final String ATTRIBUTES_CHANNEL_KEY = "attributes";
-
 	private final HttpMethod httpMethod;
 
 	private final URI uri;
@@ -141,14 +137,16 @@ protected void applyCookies() {
 	}
 
 	/**
-	 * Applies the request attributes to the {@link reactor.netty.http.client.HttpClientRequest} by setting
-	 * a single {@link Map} into the {@link reactor.netty.channel.ChannelOperations#channel()},
-	 * with {@link io.netty5.util.AttributeKey#name()} equal to {@link #ATTRIBUTES_CHANNEL_KEY}.
+	 * Saves the {@link #getAttributes() request attributes} to the
+	 * {@link reactor.netty.channel.ChannelOperations#channel() channel} as a single map
+	 * attribute under the key {@link ReactorClientHttpConnector#ATTRIBUTES_KEY}.
 	 */
 	@Override
 	protected void applyAttributes() {
-		((ChannelOperations<?, ?>) this.request)
-				.channel().attr(AttributeKey.valueOf(ATTRIBUTES_CHANNEL_KEY)).set(getAttributes());
+		if (!getAttributes().isEmpty()) {
+			((ChannelOperations<?, ?>) this.request).channel()
+					.attr(ReactorClientHttpConnector.ATTRIBUTES_KEY).set(getAttributes());
+		}
 	}
 
 	@Override

spring-web/src/main/java/org/springframework/http/client/reactive/ReactorNetty2ClientHttpConnector.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2024 the original author or authors.
+ * Copyright 2002-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,9 +17,11 @@
 package org.springframework.http.client.reactive;
 
 import java.net.URI;
+import java.util.Map;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.Function;
 
+import io.netty5.util.AttributeKey;
 import reactor.core.publisher.Mono;
 import reactor.netty5.NettyOutbound;
 import reactor.netty5.http.client.HttpClient;
@@ -41,6 +43,13 @@
  */
 public class ReactorNetty2ClientHttpConnector implements ClientHttpConnector {
 
+	/**
+	 * Channel attribute key under which {@code WebClient} request attributes are stored as a Map.
+	 * @since 6.2
+	 */
+	public static final AttributeKey<Map<String, Object>> ATTRIBUTES_KEY =
+			AttributeKey.valueOf(ReactorNetty2ClientHttpRequest.class.getName() + ".ATTRIBUTES");
+
 	private static final Function<HttpClient, HttpClient> defaultInitializer = client -> client.compress(true);
 
 

spring-web/src/main/java/org/springframework/http/client/reactive/ReactorNetty2ClientHttpRequest.java

@@ -18,11 +18,9 @@
 
 import java.net.URI;
 import java.nio.file.Path;
-import java.util.Map;
 
 import io.netty5.buffer.Buffer;
 import io.netty5.handler.codec.http.headers.DefaultHttpCookiePair;
-import io.netty5.util.AttributeKey;
 import org.reactivestreams.Publisher;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
@@ -49,8 +47,6 @@
  */
 class ReactorNetty2ClientHttpRequest extends AbstractClientHttpRequest implements ZeroCopyHttpOutputMessage {
 
-	public static final String ATTRIBUTES_CHANNEL_KEY = "attributes";
-
 	private final HttpMethod httpMethod;
 
 	private final URI uri;
@@ -144,14 +140,16 @@ protected void applyCookies() {
 	}
 
 	/**
-	 * Applies the request attributes to the {@link reactor.netty.http.client.HttpClientRequest} by setting
-	 * a single {@link Map} into the {@link reactor.netty.channel.ChannelOperations#channel()},
-	 * with {@link AttributeKey#name()} equal to {@link #ATTRIBUTES_CHANNEL_KEY}.
+	 * Saves the {@link #getAttributes() request attributes} to the
+	 * {@link reactor.netty.channel.ChannelOperations#channel() channel} as a single map
+	 * attribute under the key {@link ReactorNetty2ClientHttpConnector#ATTRIBUTES_KEY}.
 	 */
 	@Override
 	protected void applyAttributes() {
-		((ChannelOperations<?, ?>) this.request)
-				.channel().attr(AttributeKey.valueOf(ATTRIBUTES_CHANNEL_KEY)).set(getAttributes());
+		if (!getAttributes().isEmpty()) {
+			((ChannelOperations<?, ?>) this.request).channel()
+					.attr(ReactorNetty2ClientHttpConnector.ATTRIBUTES_KEY).set(getAttributes());
+		}
 	}
 
 	@Override

spring-webflux/src/main/java/org/springframework/web/reactive/function/client/DefaultClientRequestBuilder.java

@@ -266,10 +266,7 @@ public Mono<Void> writeTo(ClientHttpRequest request, ExchangeStrategies strategi
 				}));
 			}
 
-			Map<String, Object> requestAttributes = request.getAttributes();
-			if (!this.attributes.isEmpty()) {
-				this.attributes.forEach((key, value) -> requestAttributes.put(key, value));
-			}
+			request.getAttributes().putAll(this.attributes);
 
 			if (this.httpRequestConsumer != null) {
 				this.httpRequestConsumer.accept(request);

spring-webflux/src/test/java/org/springframework/web/reactive/function/client/WebClientIntegrationTests.java

@@ -41,7 +41,6 @@
 import java.util.stream.Stream;
 
 import io.netty.util.Attribute;
-import io.netty.util.AttributeKey;
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.MockWebServer;
 import okhttp3.mockwebserver.RecordedRequest;
@@ -207,21 +206,21 @@ void applyAttributesToNativeRequest(ClientHttpConnector connector) {
 		StepVerifier.create(result).expectComplete().verify();
 
 		if (nativeRequest.get() instanceof ChannelOperations<?,?> nativeReq) {
-			Attribute<Map<String, Object>> attributes = nativeReq.channel().attr(AttributeKey.valueOf("attributes"));
+			Attribute<Map<String, Object>> attributes = nativeReq.channel().attr(ReactorClientHttpConnector.ATTRIBUTES_KEY);
 			assertThat(attributes.get()).isNotNull();
 			assertThat(attributes.get()).containsEntry("foo", "bar");
 		}
 		else if (nativeRequest.get() instanceof reactor.netty5.channel.ChannelOperations<?,?> nativeReq) {
 			io.netty5.util.Attribute<Map<String, Object>> attributes =
-					nativeReq.channel().attr(io.netty5.util.AttributeKey.valueOf("attributes"));
+					nativeReq.channel().attr(ReactorNetty2ClientHttpConnector.ATTRIBUTES_KEY);
 			assertThat(attributes.get()).isNotNull();
 			assertThat(attributes.get()).containsEntry("foo", "bar");
 		}
 		else if (nativeRequest.get() instanceof Request nativeReq) {
 			assertThat(nativeReq.getAttributes()).containsEntry("foo", "bar");
 		}
 		else if (nativeRequest.get() instanceof org.apache.hc.core5.http.HttpRequest nativeReq) {
-			// TODO get attributes from HttpClientContext
+			// Attributes are not in the request, but in separate HttpClientContext
 		}
 	}