Skip to content

[UNDERTOW-2763] As per RFC 9112 reason phrase is optional in HTTP responses #1952

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.

Sign up for GitHub

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

Open
ropalka wants to merge 1 commit into
base: 2.4.x
Choose a base branch
from
+52 −19
Open

[UNDERTOW-2763] As per RFC 9112 reason phrase is optional in HTTP responses #1952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions core/src/main/java/io/undertow/client/http/ResponseParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,10 @@ private void parseReasonPhrase(final ByteBuffer buffer, final ResponseState stat
if (state.previousByte == 0 && (isVisibleAsciiChar(nextByte) || isSpaceOrTabChar(nextByte) || isObsoleteChar(nextByte))) {
// reason phrase data goes on
sb.append(nextChar);
} else if (state.previousByte == 0 && nextByte == CARRIAGE_RETURN && sb.length() > 0) {
} else if (state.previousByte == 0 && nextByte == CARRIAGE_RETURN) {
// reason phrase read complete - first separator
state.previousByte = nextByte;
} else if (state.previousByte == CARRIAGE_RETURN && nextByte == LINE_FEED && sb.length() > 0) {
} else if (state.previousByte == CARRIAGE_RETURN && nextByte == LINE_FEED) {
// reason phrase read complete - second separator
final String reason = sb.toString().trim();
if (!reason.isEmpty()) builder.setReasonPhrase(reason);
Expand Down
67 changes: 50 additions & 17 deletions core/src/test/java/io/undertow/client/http/ResponseParserResumeTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
package io.undertow.client.http;

import io.undertow.testutils.category.UnitTest;
import io.undertow.util.BadRequestException;
import io.undertow.util.HttpString;
import io.undertow.util.Protocols;
import io.undertow.util.StatusCodes;
Expand All @@ -37,23 +36,25 @@
@Category(UnitTest.class)
public class ResponseParserResumeTestCase {

public static final String DATA = "HTTP/1.1 200 OK\r\nHost: www.somehost.net\r\nOtherHeader: some\r\n \r\n value\r\nHostee:another\r\nAccept-garbage: a\r\n\r\ntttt";
public static final String RESPONSE1 = "HTTP/1.1 200 OK\r\nHost: www.somehost.net\r\nOtherHeader: some\r\n \r\n value\r\nHostee:another\r\nAccept-garbage: a\r\n\r\ntttt";
public static final String RESPONSE2 = "HTTP/1.1 200 \r\nHost: www.somehost.net\r\nOtherHeader: some\r\n \r\n value\r\nHostee:another\r\nAccept-garbage: a\r\n\r\ntttt";
public static final String RESPONSE3 = "HTTP/1.1 200 \r\n\r\ntttt";

@Test
public void testMethodSplit() {
byte[] in = DATA.getBytes();
public void testMethodSplit_response1() {
byte[] in = RESPONSE1.getBytes();
for (int i = 0; i < in.length - 4; ++i) {
try {
testResume(i, in);
testResume(i, in, true, true);
} catch (Throwable e) {
throw new RuntimeException("Test failed at split " + i, e);
}
}
}

@Test
public void testOneCharacterAtATime() throws BadRequestException {
byte[] in = DATA.getBytes();
public void testOneCharacterAtATime_response1() {
byte[] in = RESPONSE1.getBytes();
final ResponseState context = new ResponseState();
HttpResponseBuilder result = new HttpResponseBuilder();
ByteBuffer buffer = ByteBuffer.wrap(in);
Expand All @@ -62,10 +63,38 @@ public void testOneCharacterAtATime() throws BadRequestException {
ResponseParser.INSTANCE.handle(buffer, context, result);
buffer.limit(buffer.limit() + 1);
}
runAssertions(result, context);
runAssertions(result, context, true, true);
}

private void testResume(final int split, byte[] in) throws BadRequestException {
@Test
public void testOneCharacterAtATime_response2() {
byte[] in = RESPONSE2.getBytes();
final ResponseState context = new ResponseState();
HttpResponseBuilder result = new HttpResponseBuilder();
ByteBuffer buffer = ByteBuffer.wrap(in);
buffer.limit(1);
while (!context.isComplete()) {
ResponseParser.INSTANCE.handle(buffer, context, result);
buffer.limit(buffer.limit() + 1);
}
runAssertions(result, context, false, true);
}

@Test
public void testOneCharacterAtATime_response3() {
byte[] in = RESPONSE3.getBytes();
final ResponseState context = new ResponseState();
HttpResponseBuilder result = new HttpResponseBuilder();
ByteBuffer buffer = ByteBuffer.wrap(in);
buffer.limit(1);
while (!context.isComplete()) {
ResponseParser.INSTANCE.handle(buffer, context, result);
buffer.limit(buffer.limit() + 1);
}
runAssertions(result, context, false, false);
}

private void testResume(final int split, byte[] in, final boolean hasReasonPhrase, final boolean hasHeaders) {
final ResponseState context = new ResponseState();
HttpResponseBuilder result = new HttpResponseBuilder();
ByteBuffer buffer = ByteBuffer.wrap(in);
Expand All @@ -74,20 +103,24 @@ private void testResume(final int split, byte[] in) throws BadRequestException {
Assert.assertEquals(0, buffer.remaining());
buffer.limit(buffer.capacity());
ResponseParser.INSTANCE.handle(buffer,context, result);
runAssertions(result, context);
runAssertions(result, context, hasReasonPhrase, hasHeaders);
Assert.assertEquals(4, buffer.remaining());
}

private void runAssertions(final HttpResponseBuilder result, final ResponseState context) {
private void runAssertions(final HttpResponseBuilder result, final ResponseState context, final boolean hasReasonPhrase, final boolean hasHeaders) {
Assert.assertEquals(StatusCodes.OK, result.getStatusCode());
Assert.assertEquals("OK", result.getReasonPhrase());
Assert.assertEquals(hasReasonPhrase ? "OK" : null, result.getReasonPhrase());
Assert.assertSame(Protocols.HTTP_1_1, result.getProtocol());

Assert.assertEquals("www.somehost.net", result.getResponseHeaders().getFirst(new HttpString("Host")));
Assert.assertEquals("some value", result.getResponseHeaders().getFirst(new HttpString("OtherHeader")));
Assert.assertEquals("another", result.getResponseHeaders().getFirst(new HttpString("Hostee")));
Assert.assertEquals("a", result.getResponseHeaders().getFirst(new HttpString("Accept-garbage")));
Assert.assertEquals(4, result.getResponseHeaders().getHeaderNames().size());
if (hasHeaders) {
Assert.assertEquals("www.somehost.net", result.getResponseHeaders().getFirst(new HttpString("Host")));
Assert.assertEquals("some value", result.getResponseHeaders().getFirst(new HttpString("OtherHeader")));
Assert.assertEquals("another", result.getResponseHeaders().getFirst(new HttpString("Hostee")));
Assert.assertEquals("a", result.getResponseHeaders().getFirst(new HttpString("Accept-garbage")));
Assert.assertEquals(4, result.getResponseHeaders().getHeaderNames().size());
} else {
Assert.assertEquals(0, result.getResponseHeaders().getHeaderNames().size());
}

Assert.assertTrue(context.isComplete());
}
Expand Down
Loading