ok2c commented on code in PR #741: URL: https://github.com/apache/httpcomponents-client/pull/741#discussion_r2442460768
########## httpclient5/src/main/java/org/apache/hc/client5/http/protocol/H2RequestPriority.java: ########## @@ -0,0 +1,109 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * <http://www.apache.org/>. + * + */ + +package org.apache.hc.client5.http.protocol; + +import java.io.IOException; + +import org.apache.hc.client5.http.config.RequestConfig; +import org.apache.hc.core5.annotation.Contract; +import org.apache.hc.core5.annotation.Experimental; +import org.apache.hc.core5.annotation.ThreadingBehavior; +import org.apache.hc.core5.http.EntityDetails; +import org.apache.hc.core5.http.Header; +import org.apache.hc.core5.http.HttpException; +import org.apache.hc.core5.http.HttpHeaders; +import org.apache.hc.core5.http.HttpRequest; +import org.apache.hc.core5.http.HttpRequestInterceptor; +import org.apache.hc.core5.http.HttpVersion; +import org.apache.hc.core5.http.ProtocolVersion; +import org.apache.hc.core5.http.protocol.HttpContext; +import org.apache.hc.core5.http.protocol.HttpCoreContext; +import org.apache.hc.core5.http2.priority.PriorityFormatter; +import org.apache.hc.core5.http2.priority.PriorityValue; +import org.apache.hc.core5.util.Args; + +/** + * Adds the {@code Priority} request header to HTTP/2+ requests when a per-request + * priority is configured. + * <p> + * The priority is taken from {@link RequestConfig#getH2Priority()}. If a {@code Priority} + * header is already present on the request, it is left unchanged. If formatting the + * configured value yields an empty string (e.g., because it encodes protocol defaults), + * the header is not added. + * + * @since 5.6 + */ +@Experimental +@Contract(threading = ThreadingBehavior.IMMUTABLE) +public final class H2RequestPriority implements HttpRequestInterceptor { + + /** + * Singleton instance. + */ + public static final H2RequestPriority INSTANCE = new H2RequestPriority(); + + @Override + public void process( + final HttpRequest request, + final EntityDetails entity, + final HttpContext context) throws HttpException, IOException { + + Args.notNull(request, "HTTP request"); + Args.notNull(context, "HTTP context"); + + final ProtocolVersion pv = HttpCoreContext.cast(context).getProtocolVersion(); + if (pv == null || pv.compareToVersion(HttpVersion.HTTP_2) < 0) { + return; // only for HTTP/2+ + } + + // Do not override a header explicitly provided by the caller. + final Header existing = request.getFirstHeader(HttpHeaders.PRIORITY); + if (existing != null) { + return; + } + + final RequestConfig requestConfig = org.apache.hc.client5.http.protocol.HttpClientContext Review Comment: @arturobernalg Another `#cast` Why? You cant you cast it just once? Full class name. Is it needed? ########## httpclient5/src/main/java/org/apache/hc/client5/http/protocol/H2RequestPriority.java: ########## @@ -0,0 +1,109 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * <http://www.apache.org/>. + * + */ + +package org.apache.hc.client5.http.protocol; + +import java.io.IOException; + +import org.apache.hc.client5.http.config.RequestConfig; +import org.apache.hc.core5.annotation.Contract; +import org.apache.hc.core5.annotation.Experimental; +import org.apache.hc.core5.annotation.ThreadingBehavior; +import org.apache.hc.core5.http.EntityDetails; +import org.apache.hc.core5.http.Header; +import org.apache.hc.core5.http.HttpException; +import org.apache.hc.core5.http.HttpHeaders; +import org.apache.hc.core5.http.HttpRequest; +import org.apache.hc.core5.http.HttpRequestInterceptor; +import org.apache.hc.core5.http.HttpVersion; +import org.apache.hc.core5.http.ProtocolVersion; +import org.apache.hc.core5.http.protocol.HttpContext; +import org.apache.hc.core5.http.protocol.HttpCoreContext; +import org.apache.hc.core5.http2.priority.PriorityFormatter; +import org.apache.hc.core5.http2.priority.PriorityValue; +import org.apache.hc.core5.util.Args; + +/** + * Adds the {@code Priority} request header to HTTP/2+ requests when a per-request + * priority is configured. + * <p> + * The priority is taken from {@link RequestConfig#getH2Priority()}. If a {@code Priority} + * header is already present on the request, it is left unchanged. If formatting the + * configured value yields an empty string (e.g., because it encodes protocol defaults), + * the header is not added. + * + * @since 5.6 + */ +@Experimental +@Contract(threading = ThreadingBehavior.IMMUTABLE) +public final class H2RequestPriority implements HttpRequestInterceptor { + + /** + * Singleton instance. + */ + public static final H2RequestPriority INSTANCE = new H2RequestPriority(); + + @Override + public void process( + final HttpRequest request, + final EntityDetails entity, + final HttpContext context) throws HttpException, IOException { + + Args.notNull(request, "HTTP request"); + Args.notNull(context, "HTTP context"); + + final ProtocolVersion pv = HttpCoreContext.cast(context).getProtocolVersion(); + if (pv == null || pv.compareToVersion(HttpVersion.HTTP_2) < 0) { + return; // only for HTTP/2+ + } + + // Do not override a header explicitly provided by the caller. + final Header existing = request.getFirstHeader(HttpHeaders.PRIORITY); + if (existing != null) { + return; + } + + final RequestConfig requestConfig = org.apache.hc.client5.http.protocol.HttpClientContext + .cast(context) + .getRequestConfigOrDefault(); + if (requestConfig == null) { + return; + } + + final PriorityValue pri = requestConfig.getH2Priority(); + if (pri == null) { Review Comment: @arturobernalg You should also exit there if the priority is equal to `PriorityValue#defaults` ########## httpclient5/src/main/java/org/apache/hc/client5/http/config/RequestConfig.java: ########## @@ -691,6 +709,15 @@ public Builder setExpectContinueTrigger(final ExpectContinueTrigger trigger) { return this; } + /** + * Sets HTTP/2+ request priority (RFC 9218). If {@code null}, the header is not emitted. + * @since 5.6 + */ + public Builder setH2Priority(final PriorityValue priority) { Review Comment: @arturobernalg We should make it experimental ########## httpclient5/src/main/java/org/apache/hc/client5/http/config/RequestConfig.java: ########## @@ -244,6 +252,14 @@ public ExpectContinueTrigger getExpectContinueTrigger() { return expectContinueTrigger; } + /** + * Returns the HTTP/2+ priority preference for this request or {@code null} if unset. + * @since 5.6 + */ + public PriorityValue getH2Priority() { Review Comment: @arturobernalg We should make it experimental ########## httpclient5/src/main/java/org/apache/hc/client5/http/protocol/H2RequestPriority.java: ########## @@ -0,0 +1,109 @@ +/* + * ==================================================================== + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * <http://www.apache.org/>. + * + */ + +package org.apache.hc.client5.http.protocol; + +import java.io.IOException; + +import org.apache.hc.client5.http.config.RequestConfig; +import org.apache.hc.core5.annotation.Contract; +import org.apache.hc.core5.annotation.Experimental; +import org.apache.hc.core5.annotation.ThreadingBehavior; +import org.apache.hc.core5.http.EntityDetails; +import org.apache.hc.core5.http.Header; +import org.apache.hc.core5.http.HttpException; +import org.apache.hc.core5.http.HttpHeaders; +import org.apache.hc.core5.http.HttpRequest; +import org.apache.hc.core5.http.HttpRequestInterceptor; +import org.apache.hc.core5.http.HttpVersion; +import org.apache.hc.core5.http.ProtocolVersion; +import org.apache.hc.core5.http.protocol.HttpContext; +import org.apache.hc.core5.http.protocol.HttpCoreContext; +import org.apache.hc.core5.http2.priority.PriorityFormatter; +import org.apache.hc.core5.http2.priority.PriorityValue; +import org.apache.hc.core5.util.Args; + +/** + * Adds the {@code Priority} request header to HTTP/2+ requests when a per-request + * priority is configured. + * <p> + * The priority is taken from {@link RequestConfig#getH2Priority()}. If a {@code Priority} + * header is already present on the request, it is left unchanged. If formatting the + * configured value yields an empty string (e.g., because it encodes protocol defaults), + * the header is not added. + * + * @since 5.6 + */ +@Experimental +@Contract(threading = ThreadingBehavior.IMMUTABLE) +public final class H2RequestPriority implements HttpRequestInterceptor { + + /** + * Singleton instance. + */ + public static final H2RequestPriority INSTANCE = new H2RequestPriority(); + + @Override + public void process( + final HttpRequest request, + final EntityDetails entity, + final HttpContext context) throws HttpException, IOException { + + Args.notNull(request, "HTTP request"); + Args.notNull(context, "HTTP context"); + + final ProtocolVersion pv = HttpCoreContext.cast(context).getProtocolVersion(); + if (pv == null || pv.compareToVersion(HttpVersion.HTTP_2) < 0) { + return; // only for HTTP/2+ + } + + // Do not override a header explicitly provided by the caller. + final Header existing = request.getFirstHeader(HttpHeaders.PRIORITY); + if (existing != null) { + return; + } + + final RequestConfig requestConfig = org.apache.hc.client5.http.protocol.HttpClientContext + .cast(context) + .getRequestConfigOrDefault(); + if (requestConfig == null) { + return; + } + + final PriorityValue pri = requestConfig.getH2Priority(); + if (pri == null) { + return; + } + + final String value = PriorityFormatter.format(pri); Review Comment: @arturobernalg Why not `#formatHeader`? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
