This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch camel-4.10.x in repository https://gitbox.apache.org/repos/asf/camel.git
commit fa804537375dae2f9c5b7b1766eefbcf3a4604c5 Author: Prasanth Rao <[email protected]> AuthorDate: Wed Jul 2 10:51:25 2025 +0530 CAMEL-22208 Optimize CachedOutputStream.pageToFileStream for large streams (#18493) * Optimize CachedOutputStream.pageToFileStream for large streams * Optimize CachedOutputStream.pageToFileStream for large streams * Refactor CachedOuputStream and tests Optimize CachedOutputStream.pageToFileStream for large streams Both org.apache.camel.util.IOHelper.copy(InputStream, OutputStream) and java.io.ByteArrayOutputStream.writeTo(OutputStream) internally invoke java.nio.ByteBuffer.allocateDirect which results in OOM on direct buffer memory - New maven module for the test - Remove the deprecation on the IOHelper copy method as we use it for this now --- .../camel/converter/stream/CachedOutputStream.java | 6 +- .../main/java/org/apache/camel/util/IOHelper.java | 3 - tests/camel-streamcaching-test/pom.xml | 149 +++++++++++++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 ++ .../stream/CachedOutputStreamDirectMemoryTest.java | 74 ++++++++ tests/pom.xml | 1 + 7 files changed, 441 insertions(+), 6 deletions(-) diff --git a/core/camel-support/src/main/java/org/apache/camel/converter/stream/CachedOutputStream.java b/core/camel-support/src/main/java/org/apache/camel/converter/stream/CachedOutputStream.java index d53f0ea3a9b..52fc62eeb82 100644 --- a/core/camel-support/src/main/java/org/apache/camel/converter/stream/CachedOutputStream.java +++ b/core/camel-support/src/main/java/org/apache/camel/converter/stream/CachedOutputStream.java @@ -156,17 +156,17 @@ public class CachedOutputStream extends OutputStream { private void pageToFileStream() throws IOException { flush(); - ByteArrayOutputStream bout = (ByteArrayOutputStream) currentStream; + CachedByteArrayOutputStream bout = (CachedByteArrayOutputStream) currentStream; try { // creates a tmp file and a file output stream currentStream = tempFileManager.createOutputStream(strategy); - bout.writeTo(currentStream); + IOHelper.copy(bout.newInputStreamCache(), currentStream, strategy.getBufferSize()); } finally { // ensure flag is flipped to file based inMemory = false; } } - + public int getStrategyBufferSize() { return strategy.getBufferSize(); } diff --git a/core/camel-util/src/main/java/org/apache/camel/util/IOHelper.java b/core/camel-util/src/main/java/org/apache/camel/util/IOHelper.java index de347a45612..f5937145833 100644 --- a/core/camel-util/src/main/java/org/apache/camel/util/IOHelper.java +++ b/core/camel-util/src/main/java/org/apache/camel/util/IOHelper.java @@ -175,10 +175,8 @@ public final class IOHelper { * @param output the output stream buffer * @param bufferSize the size of the buffer used for the copies * @return the number of bytes copied - * @deprecated Prefer using {@link IOHelper#copy(InputStream, OutputStream)} * @throws IOException for I/O errors */ - @Deprecated(since = "4.8.0") public static int copy(final InputStream input, final OutputStream output, int bufferSize) throws IOException { return copy(input, output, bufferSize, false); } @@ -208,7 +206,6 @@ public final class IOHelper { * @param bufferSize the size of the buffer used for the copies * @param flushOnEachWrite whether to flush the data everytime that data is written to the buffer * @return the number of bytes copied - * @deprecated Prefer using {@link IOHelper#copy(InputStream, OutputStream)} * @throws IOException for I/O errors */ public static int copy( diff --git a/tests/camel-streamcaching-test/pom.xml b/tests/camel-streamcaching-test/pom.xml new file mode 100644 index 00000000000..261261ccf0d --- /dev/null +++ b/tests/camel-streamcaching-test/pom.xml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + 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. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.camel</groupId> + <artifactId>tests</artifactId> + <version>4.13.0-SNAPSHOT</version> + </parent> + + <artifactId>camel-streamcaching-test</artifactId> + <name>Camel :: Stream Caching Tests</name> + <description>Performs cross component integration tests</description> + + + <dependencies> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-core</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-support</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.junit.jupiter</groupId> + <artifactId>junit-jupiter-api</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-test-junit5</artifactId> + <scope>test</scope> + </dependency> + <!-- testing --> + <!-- woodstox is needed by the StaxConverter test--> + <dependency> + <groupId>org.codehaus.woodstox</groupId> + <artifactId>woodstox-core-asl</artifactId> + <version>${woodstox-version}</version> + <scope>test</scope> + <exclusions> + <exclusion> + <groupId>javax.xml.stream</groupId> + <artifactId>stax-api</artifactId> + </exclusion> + </exclusions> + </dependency> + <dependency> + <groupId>org.junit.jupiter</groupId> + <artifactId>junit-jupiter</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.hamcrest</groupId> + <artifactId>hamcrest</artifactId> + <version>${hamcrest-version}</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.awaitility</groupId> + <artifactId>awaitility</artifactId> + <version>${awaitility-version}</version> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.assertj</groupId> + <artifactId>assertj-core</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.mockito</groupId> + <artifactId>mockito-core</artifactId> + <version>${mockito-version}</version> + <scope>test</scope> + </dependency> + <!-- logging --> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-slf4j2-impl</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.apache.logging.log4j</groupId> + <artifactId>log4j-core</artifactId> + <scope>test</scope> + </dependency> + + <!-- for validator tests, the artifact itself is included inside the project repository 'camel-validator-test-repo' above --> + <dependency> + <groupId>org.apache.camel.tests</groupId> + <artifactId>camel-validator-test-resources</artifactId> + <version>${project.version}</version> + </dependency> + + </dependencies> + + <build> + <plugins> + + <!-- to validate Camel endpoints: mvn camel-report:validate --> + <plugin> + <groupId>org.apache.camel</groupId> + <artifactId>camel-report-maven-plugin</artifactId> + <version>${project.version}</version> + <configuration> + <failOnError>false</failOnError> + <includeTest>true</includeTest> + <includeXml>true</includeXml> + <ignoreLenientProperties>false</ignoreLenientProperties> + </configuration> + </plugin> + <plugin> + <artifactId>maven-surefire-plugin</artifactId> + <configuration> + <systemPropertyVariables> + <derby.stream.error.file>target/derby.log</derby.stream.error.file> + </systemPropertyVariables> + <argLine>-XX:MaxDirectMemorySize=512k</argLine> + <excludes> + <!-- exclude doc tests as they dont work on CI server --> + <exclude>**/*DocumentationTest.*</exclude> + </excludes> + </configuration> + </plugin> + </plugins> + </build> +</project> diff --git a/tests/camel-streamcaching-test/src/main/resources/META-INF/LICENSE.txt b/tests/camel-streamcaching-test/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 00000000000..6b0b1270ff0 --- /dev/null +++ b/tests/camel-streamcaching-test/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. + diff --git a/tests/camel-streamcaching-test/src/main/resources/META-INF/NOTICE.txt b/tests/camel-streamcaching-test/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 00000000000..2e215bf2e6b --- /dev/null +++ b/tests/camel-streamcaching-test/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. diff --git a/tests/camel-streamcaching-test/src/test/java/org/apache/camel/converter/stream/CachedOutputStreamDirectMemoryTest.java b/tests/camel-streamcaching-test/src/test/java/org/apache/camel/converter/stream/CachedOutputStreamDirectMemoryTest.java new file mode 100644 index 00000000000..5636f391811 --- /dev/null +++ b/tests/camel-streamcaching-test/src/test/java/org/apache/camel/converter/stream/CachedOutputStreamDirectMemoryTest.java @@ -0,0 +1,74 @@ +/* + * 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. + */ +package org.apache.camel.converter.stream; + +import java.security.SecureRandom; + +import org.apache.camel.Exchange; +import org.apache.camel.Processor; +import org.apache.camel.builder.RouteBuilder; +import org.apache.camel.test.junit5.CamelTestSupport; +import org.apache.camel.util.IOHelper; +import org.junit.jupiter.api.Test; + +public class CachedOutputStreamDirectMemoryTest extends CamelTestSupport { + + private static final int SPOOL_THRESHOLD = 2 * 1024 * 1024; //Must be greater than -XX:MaxDirectMemorySize in surefire + private static final long BYTES_TO_WRITE = 2 * SPOOL_THRESHOLD; //Must be greater than SPOOL_THRESHOLD + + @Override + protected RouteBuilder createRouteBuilder() { + return new RouteBuilder() { + @Override + public void configure() throws Exception { + context.setStreamCaching(true); + context.getStreamCachingStrategy().setSpoolEnabled(true); + context.getStreamCachingStrategy().setSpoolThreshold(SPOOL_THRESHOLD); // 24 KB + from("direct:start").process(new CustomProcessor()).to("mock:result"); + } + }; + } + + private static class CustomProcessor implements Processor { + + @Override + public void process(Exchange exchange) throws Exception { + byte[] buffer = new byte[IOHelper.DEFAULT_BUFFER_SIZE]; + SecureRandom random = new SecureRandom(); + + CachedOutputStream cos = new CachedOutputStream(exchange); + long written = 0; + while (written < BYTES_TO_WRITE) { + int toWrite = (int) Math.min(IOHelper.DEFAULT_BUFFER_SIZE, BYTES_TO_WRITE - written); + random.nextBytes(buffer); + cos.write(buffer, 0, toWrite); + written += toWrite; + } + cos.flush(); + cos.close(); + + exchange.getMessage().setBody(cos.getInputStream()); + } + } + + @Test + public void oomTest() { + // This test will trigger an OutOfMemoryError if the stream caching strategy + // does not handle large streams correctly. + template.sendBodyAndHeader("direct:start", null, "stream", true); + } +} diff --git a/tests/pom.xml b/tests/pom.xml index c89b60b9197..f83283e2112 100644 --- a/tests/pom.xml +++ b/tests/pom.xml @@ -39,5 +39,6 @@ <modules> <module>test-bundles</module> <module>camel-itest</module> + <module>camel-streamcaching-test</module> </modules> </project>
