Deprecated public constructor of DataReader, replaced with static create method. (helidon-io#10867)

tomas-langer · web-flow · commit 13d0e60cbe90 · 2025-12-03T22:18:22.000+01:00
Replaced usages.
diff --git a/common/buffers/src/main/java/io/helidon/common/buffers/DataReader.java b/common/buffers/src/main/java/io/helidon/common/buffers/DataReader.java
@@ -38,7 +38,9 @@ public class DataReader {
      * Data reader from a supplier of bytes.
      *
      * @param bytesSupplier supplier that can be pulled for more data
+     * @deprecated use {@link #create(java.util.function.Supplier)} instead
      */
+    @Deprecated(forRemoval = true, since = "4.4.0")
     public DataReader(Supplier<byte[]> bytesSupplier) {
         this.ignoreLoneEol = false;
         this.bytesSupplier = bytesSupplier;
@@ -52,7 +54,9 @@ public DataReader(Supplier<byte[]> bytesSupplier) {
      *
      * @param bytesSupplier supplier that can be pulled for more data
      * @param ignoreLoneEol ignore LF without CR and CR without LF
+     * @deprecated use {@link #create(java.util.function.Supplier, boolean)} instead
      */
+    @Deprecated(forRemoval = true, since = "4.4.0")
     public DataReader(Supplier<byte[]> bytesSupplier, boolean ignoreLoneEol) {
         this.ignoreLoneEol = ignoreLoneEol;
         this.bytesSupplier = bytesSupplier;
@@ -61,6 +65,27 @@ public DataReader(Supplier<byte[]> bytesSupplier, boolean ignoreLoneEol) {
         this.tail = this.head;
     }
 
+    /**
+     * Data reader from a supplier of bytes.
+     *
+     * @param bytesSupplier supplier that can be pulled for more data
+     * @return data reader using the provided supplier and treating only {@code CRLF} as a new line
+     */
+    public static DataReader create(Supplier<byte[]> bytesSupplier) {
+        return new DataReader(bytesSupplier);
+    }
+
+    /**
+     * Data reader from a supplier of bytes.
+     *
+     * @param bytesSupplier supplier that can be pulled for more data
+     * @param ignoreLoneEol ignore LF without CR and CR without LF
+     * @return data reader using the provided supplier with specified new line handling
+     */
+    public static DataReader create(Supplier<byte[]> bytesSupplier, boolean ignoreLoneEol) {
+        return new DataReader(bytesSupplier, ignoreLoneEol);
+    }
+
     /**
      * Number of bytes available in the currently pulled data.
      *
diff --git a/common/buffers/src/test/java/io/helidon/common/buffers/DataReaderTest.java b/common/buffers/src/test/java/io/helidon/common/buffers/DataReaderTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 Oracle and/or its affiliates.
+ * Copyright (c) 2024, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@ void testFindNewLineWithLoneCR() {
 
         byte[] data = "00\r0\r\n".getBytes(StandardCharsets.US_ASCII);
         AtomicReference<byte[]> ref = new AtomicReference<>(data);
-        DataReader dataReader = new DataReader(() -> ref.getAndSet(null), true);
+        DataReader dataReader = DataReader.create(() -> ref.getAndSet(null), true);
 
         int n = 2;
         assertThat(dataReader.findNewLine(n), is(n));
@@ -50,7 +50,7 @@ void testFindNewLineWithMultipleLoneCR() {
 
         byte[] data = "00\r\r\r\n".getBytes(StandardCharsets.US_ASCII);
         AtomicReference<byte[]> ref = new AtomicReference<>(data);
-        DataReader dataReader = new DataReader(() -> ref.getAndSet(null), true);
+        DataReader dataReader = DataReader.create(() -> ref.getAndSet(null), true);
 
         int n = 5;
         assertThat(dataReader.findNewLine(n), is(4));
@@ -63,7 +63,7 @@ void testFindNewLineWithMultipleLoneWithinMax() {
 
         byte[] data = "00\r00\r\n00".getBytes(StandardCharsets.US_ASCII);
         AtomicReference<byte[]> ref = new AtomicReference<>(data);
-        DataReader dataReader = new DataReader(() -> ref.getAndSet(null), true);
+        DataReader dataReader = DataReader.create(() -> ref.getAndSet(null), true);
 
         int n = 4;
         assertThat(dataReader.findNewLine(n), is(n));
diff --git a/http/http/src/test/java/io/helidon/http/Http1HeadersParserTest.java b/http/http/src/test/java/io/helidon/http/Http1HeadersParserTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ class Http1HeadersParserTest {
 
     @Test
     void testHeadersAreCaseInsensitive() {
-        DataReader reader = new DataReader(() -> (
+        DataReader reader = DataReader.create(() -> (
                 "Set-Cookie: c1=v1\r\nSet-Cookie: c2=v2\r\n"
                         + "Header: hv1\r\nheader: hv2\r\nheaDer: hv3\r\n"
                         + "\r\n").getBytes(StandardCharsets.US_ASCII));
@@ -83,7 +83,7 @@ void testHeadersWithValidationDisabled(String headerValue) {
 
     private static WritableHeaders<?> getHeaders(String headerName, String headerValue, boolean validate) {
         DataReader reader =
-                new DataReader(() -> (headerName + ":" + headerValue + "\r\n" + "\r\n").getBytes(StandardCharsets.US_ASCII));
+                DataReader.create(() -> (headerName + ":" + headerValue + "\r\n" + "\r\n").getBytes(StandardCharsets.US_ASCII));
         return Http1HeadersParser.readHeaders(reader, 1024, validate);
     }
 
diff --git a/http/media/multipart/src/main/java/io/helidon/http/media/multipart/MultiPartImpl.java b/http/media/multipart/src/main/java/io/helidon/http/media/multipart/MultiPartImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -45,7 +45,7 @@ class MultiPartImpl extends MultiPart {
         this.endBoundary = "--" + boundary + "--";
         this.maxNewLine = this.boundary.length() + 6;
         byte[] readBuffer = new byte[1024];
-        this.dataReader = new DataReader(() -> {
+        this.dataReader = DataReader.create(() -> {
             try {
                 int r = stream.read(readBuffer);
                 if (r == -1) {
diff --git a/metadata/hson/src/main/java/io/helidon/metadata/hson/HsonParser.java b/metadata/hson/src/main/java/io/helidon/metadata/hson/HsonParser.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 Oracle and/or its affiliates.
+ * Copyright (c) 2024, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -47,7 +47,7 @@ private HsonParser(DataReader reader) {
     }
 
     static Hson.Value<?> parse(InputStream stream) {
-        DataReader dr = new DataReader(() -> {
+        DataReader dr = DataReader.create(() -> {
             byte[] buffer = new byte[1024];
             try {
                 int num = stream.read(buffer);
diff --git a/tests/benchmark/jmh/src/main/java/io/helidon/webserver/benchmark/jmh/Http1ParsingJmhTest.java b/tests/benchmark/jmh/src/main/java/io/helidon/webserver/benchmark/jmh/Http1ParsingJmhTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -68,14 +68,14 @@ public void setup() {
 
     @Benchmark
     public void singleBuffer(Blackhole bh) {
-        DataReader reader = new DataReader(() -> SINGLE_BUFFER);
+        DataReader reader = DataReader.create(() -> SINGLE_BUFFER);
         readRequest(bh, reader);
     }
 
     @Benchmark
     public void multiBuffer(Blackhole bh) {
         Iterator<byte[]> iterator = MULTI_BUFFER.iterator();
-        DataReader reader = new DataReader(() -> {
+        DataReader reader = DataReader.create(() -> {
             if (iterator.hasNext()) {
                 return iterator.next();
             }
@@ -86,7 +86,7 @@ public void multiBuffer(Blackhole bh) {
 
     @Benchmark
     public void longHeader(Blackhole bh) {
-        DataReader reader = new DataReader(() -> longMessage);
+        DataReader reader = DataReader.create(() -> longMessage);
         readRequest(bh, reader);
     }
 
diff --git a/tests/benchmark/jmh/src/main/java/io/helidon/webserver/benchmark/jmh/HttpPrologueParsingJmhTest.java b/tests/benchmark/jmh/src/main/java/io/helidon/webserver/benchmark/jmh/HttpPrologueParsingJmhTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,14 +36,14 @@ public class HttpPrologueParsingJmhTest {
 
     @Benchmark
     public void techEmpower(Blackhole bh) {
-        HttpPrologue prologue = new Http1Prologue(new DataReader(() -> TECHEMPOWER_PROLOGUE), 1024, false)
+        HttpPrologue prologue = new Http1Prologue(DataReader.create(() -> TECHEMPOWER_PROLOGUE), 1024, false)
                 .readPrologue();
         bh.consume(prologue);
     }
 
     @Benchmark
     public void encoded(Blackhole bh) {
-        HttpPrologue prologue = new Http1Prologue(new DataReader(() -> ENCODED_PROLOGUE), 1024, false)
+        HttpPrologue prologue = new Http1Prologue(DataReader.create(() -> ENCODED_PROLOGUE), 1024, false)
                 .readPrologue();
         bh.consume(prologue);
     }
diff --git a/tests/benchmark/jmh/src/main/java/io/helidon/webserver/benchmark/jmh/ParsingJmhTest.java b/tests/benchmark/jmh/src/main/java/io/helidon/webserver/benchmark/jmh/ParsingJmhTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2024 Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -55,7 +55,7 @@ public class ParsingJmhTest {
 
     @Benchmark
     public void prologue(Blackhole bh) {
-        DataReader reader = new DataReader(() -> PROLOGUE_WITH_EOL);
+        DataReader reader = DataReader.create(() -> PROLOGUE_WITH_EOL);
         Http1Prologue p = new Http1Prologue(reader, 1024, false);
         HttpPrologue httpPrologue = p.readPrologue();
         bh.consume(httpPrologue.method());
@@ -66,7 +66,7 @@ public void prologue(Blackhole bh) {
 
     @Benchmark
     public void headers(Blackhole bh) {
-        DataReader reader = new DataReader(() -> HEADERS);
+        DataReader reader = DataReader.create(() -> HEADERS);
         Http1Headers p = new Http1Headers(reader, 1024, false);
         WritableHeaders<?> headers = p.readHeaders(PROLOGUE);
 
diff --git a/webclient/api/src/main/java/io/helidon/webclient/api/TcpClientConnection.java b/webclient/api/src/main/java/io/helidon/webclient/api/TcpClientConnection.java
@@ -147,7 +147,7 @@ Obtain target socket through proxy (if enabled), or connect to target socket
             this.helidonSocket = PlainSocket.client(socket, channelId);
         }
 
-        this.reader = new DataReader(helidonSocket);
+        this.reader = DataReader.create(helidonSocket);
         int writeBufferSize = webClient.prototype().writeBufferSize();
         this.writer = new BufferedDataWriter(helidonSocket, writeBufferSize);
 
diff --git a/webclient/http1/src/test/java/io/helidon/webclient/http1/Http1ClientTest.java b/webclient/http1/src/test/java/io/helidon/webclient/http1/Http1ClientTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2023, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -723,7 +723,7 @@ public void writeNow(BufferData buffer) {
         }
 
         private DataReader reader(ArrayBlockingQueue<byte[]> queue) {
-            return new DataReader(() -> {
+            return DataReader.create(() -> {
                 if (serverException != null) {
                     throw new IllegalStateException("Server exception", serverException);
                 }
diff --git a/webclient/http1/src/test/java/io/helidon/webclient/http1/Http1StatusParserTest.java b/webclient/http1/src/test/java/io/helidon/webclient/http1/Http1StatusParserTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
+ * Copyright (c) 2023, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,30 +21,30 @@
 
 import org.junit.jupiter.api.Test;
 
-import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 class Http1StatusParserTest {
 
     @Test
     public void http10() {
         String response = "HTTP/1.0 200 Connection established\r\n";
-        Status status = Http1StatusParser.readStatus(new DataReader(() -> response.getBytes()), 256);
+        Status status = Http1StatusParser.readStatus(DataReader.create(() -> response.getBytes()), 256);
         assertThat(status.code(), is(200));
     }
 
     @Test
     public void http11() {
         String response = "HTTP/1.1 200 Connection established\r\n";
-        Status status = Http1StatusParser.readStatus(new DataReader(() -> response.getBytes()), 256);
+        Status status = Http1StatusParser.readStatus(DataReader.create(() -> response.getBytes()), 256);
         assertThat(status.code(), is(200));
     }
 
     @Test
     public void wrong() {
         String response = "HTTP/1.2 200 Connection established\r\n";
         assertThrows(IllegalStateException.class,
-                () -> Http1StatusParser.readStatus(new DataReader(() -> response.getBytes()), 256));
+                () -> Http1StatusParser.readStatus(DataReader.create(() -> response.getBytes()), 256));
     }
 }
diff --git a/webserver/testing/junit5/junit5/src/main/java/io/helidon/webserver/testing/junit5/DirectClientConnection.java b/webserver/testing/junit5/junit5/src/main/java/io/helidon/webserver/testing/junit5/DirectClientConnection.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -130,7 +130,7 @@ public void writeNow(BufferData buffer) {
     }
 
     private DataReader reader(ArrayBlockingQueue<byte[]> queue) {
-        return new DataReader(() -> {
+        return DataReader.create(() -> {
             byte[] data;
             try {
                 data = queue.take();
diff --git a/webserver/testing/junit5/websocket/src/main/java/io/helidon/webserver/testing/junit5/websocket/DirectWsConnection.java b/webserver/testing/junit5/websocket/src/main/java/io/helidon/webserver/testing/junit5/websocket/DirectWsConnection.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2023, 2025 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -90,7 +90,7 @@ static DirectWsConnection create(HttpPrologue prologue, WsListener clientListene
     }
 
     private static DataReader reader(ArrayBlockingQueue<byte[]> queue) {
-        return new DataReader(() -> {
+        return DataReader.create(() -> {
             byte[] data;
             try {
                 data = queue.take();
diff --git a/webserver/webserver/src/main/java/io/helidon/webserver/ConnectionHandler.java b/webserver/webserver/src/main/java/io/helidon/webserver/ConnectionHandler.java
@@ -140,7 +140,7 @@ public final void run() {
                 helidonSocket = PlainSocket.server(socket, channelId, serverChannelId);
             }
 
-            reader = new DataReader(new MapExceptionDataSupplier(helidonSocket));
+            reader = DataReader.create(new MapExceptionDataSupplier(helidonSocket));
             writer = SocketWriter.create(listenerContext.executor(),
                                          helidonSocket,
                                          listenerConfig.writeQueueLength(),
diff --git a/webserver/webserver/src/test/java/io/helidon/webserver/ConnectionHandlerTest.java b/webserver/webserver/src/test/java/io/helidon/webserver/ConnectionHandlerTest.java
@@ -28,7 +28,7 @@ class ConnectionHandlerTest {
 
     @Test
     void testHttp10Prologue() {
-        DataReader reader = new DataReader(() -> "GET / HTTP/1.0\r\n".getBytes(StandardCharsets.US_ASCII));
+        DataReader reader = DataReader.create(() -> "GET / HTTP/1.0\r\n".getBytes(StandardCharsets.US_ASCII));
         assertThat(ConnectionHandler.isHttp10Connection(reader), is(true));
     }
 }
diff --git a/webserver/webserver/src/test/java/io/helidon/webserver/http1/Http1PrologueTest.java b/webserver/webserver/src/test/java/io/helidon/webserver/http1/Http1PrologueTest.java
@@ -36,7 +36,7 @@
 class Http1PrologueTest {
     @Test
     void testOk() {
-        DataReader reader = new DataReader(() -> "GET / HTTP/1.1\r\n".getBytes(StandardCharsets.US_ASCII));
+        DataReader reader = DataReader.create(() -> "GET / HTTP/1.1\r\n".getBytes(StandardCharsets.US_ASCII));
         Http1Prologue p = new Http1Prologue(reader, 100, false);
 
         HttpPrologue prologue = p.readPrologue();
@@ -49,7 +49,7 @@ void testOk() {
     @Test
     void testUriTooLong() {
         // make sure this regression does not happen again
-        DataReader reader = new DataReader(() -> "GET /01234567890123456789012 HTTP/1.1\r\n".getBytes(StandardCharsets.US_ASCII));
+        DataReader reader = DataReader.create(() -> "GET /01234567890123456789012 HTTP/1.1\r\n".getBytes(StandardCharsets.US_ASCII));
         Http1Prologue p = new Http1Prologue(reader, 20, false);
 
         RequestException e = assertThrows(RequestException.class, p::readPrologue);
@@ -60,7 +60,7 @@ void testUriTooLong() {
 
     @Test
     void testHttp10Error() {
-        DataReader reader = new DataReader(() -> "GET / HTTP/1.0\r\n".getBytes(StandardCharsets.US_ASCII));
+        DataReader reader = DataReader.create(() -> "GET / HTTP/1.0\r\n".getBytes(StandardCharsets.US_ASCII));
         Http1Prologue p = new Http1Prologue(reader, 100, false);
 
         try {

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright (c) 2024 Oracle and/or its affiliates.`
	`2`	`+ * Copyright (c) 2024, 2025 Oracle and/or its affiliates.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -47,7 +47,7 @@ private HsonParser(DataReader reader) {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`static Hson.Value<?> parse(InputStream stream) {`
`50`		`- DataReader dr = new DataReader(() -> {`
	`50`	`+ DataReader dr = DataReader.create(() -> {`
`51`	`51`	`byte[] buffer = new byte[1024];`
`52`	`52`	`try {`
`53`	`53`	`int num = stream.read(buffer);`
Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ Obtain target socket through proxy (if enabled), or connect to target socket`
`147`	`147`	`this.helidonSocket = PlainSocket.client(socket, channelId);`
`148`	`148`	`}`
`149`	`149`
`150`		`- this.reader = new DataReader(helidonSocket);`
	`150`	`+ this.reader = DataReader.create(helidonSocket);`
`151`	`151`	`int writeBufferSize = webClient.prototype().writeBufferSize();`
`152`	`152`	`this.writer = new BufferedDataWriter(helidonSocket, writeBufferSize);`
`153`	`153`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright (c) 2023 Oracle and/or its affiliates.`
	`2`	`+ * Copyright (c) 2023, 2025 Oracle and/or its affiliates.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -723,7 +723,7 @@ public void writeNow(BufferData buffer) {`
`723`	`723`	`}`
`724`	`724`
`725`	`725`	`private DataReader reader(ArrayBlockingQueue<byte[]> queue) {`
`726`		`- return new DataReader(() -> {`
	`726`	`+ return DataReader.create(() -> {`
`727`	`727`	`if (serverException != null) {`
`728`	`728`	`throw new IllegalStateException("Server exception", serverException);`
`729`	`729`	`}`