Skip to content
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.

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

Replace commons-io:commons-io #2632

Merged
merged 16 commits into from
Apr 3, 2024
1 change: 0 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,6 @@ dependencies {
api 'commons-fileupload:commons-fileupload:1.5', {
exclude group: 'commons-io', module: 'commons-io'
}
api "commons-io:commons-io:2.16.0"

api 'com.networknt:json-schema-validator:1.4.0'

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2018-2022 Thomas Akehurst
* Copyright (C) 2018-2024 Thomas Akehurst
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
import com.github.tomakehurst.wiremock.common.Exceptions;
import com.github.tomakehurst.wiremock.common.RequestCache;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import org.apache.commons.io.output.StringBuilderWriter;

public class HandlebarsOptimizedTemplate {

Expand All @@ -45,9 +45,7 @@ public HandlebarsOptimizedTemplate(final Handlebars handlebars, final String con
templateContent =
content.substring(
firstDelimStartPosition, lastDelimEndPosition + Handlebars.DELIM_END.length());
endContent =
content.substring(
lastDelimEndPosition + Handlebars.DELIM_END.length(), content.length());
endContent = content.substring(lastDelimEndPosition + Handlebars.DELIM_END.length());
}
}

Expand All @@ -72,7 +70,7 @@ public String apply(Object contextData) {
private String applyTemplate(Context context) {
return Exceptions.uncheck(
() -> {
Writer stringWriter = new StringBuilderWriter(template.text().length() * 2);
Writer stringWriter = new StringWriter(template.text().length() * 2);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you tested the performance impact of this change?

From the docs of org.apache.commons.io.output.StringBuilderWriter:

This implementation, as an alternative to java.io.StringWriter, provides an un-synchronized (i.e. for use in a single thread) implementation for better performance.

Copy link
Contributor Author

@pks-1981 pks-1981 Mar 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a simple test

`package org.example;

import org.apache.commons.io.output.StringBuilderWriter;
import org.openjdk.jmh.annotations.*;
import org.openjdk.jmh.infra.Blackhole;
import org.openjdk.jmh.runner.Runner;
import org.openjdk.jmh.runner.options.Options;
import org.openjdk.jmh.runner.options.OptionsBuilder;

import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.concurrent.TimeUnit;

@OutputTimeUnit(TimeUnit.MILLISECONDS)
@fork(value = 1, warmups = 1)
@State(Scope.Benchmark)
public class Benchmark {

/*
Generated by https://www.blindtextgenerator.com/lorem-ipsum
2000 words
10 paragraphs
 */
@Param({"Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh.\n" +
        "\n" +
        "Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc, quis gravida magna mi a libero. Fusce vulputate eleifend sapien. Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus. Nullam accumsan lorem in dui. Cras ultricies mi eu turpis hendrerit fringilla. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; In ac dui quis mi consectetuer lacinia. Nam pretium turpis et arcu. Duis arcu tortor, suscipit eget, imperdiet nec, imperdiet iaculis, ipsum. Sed aliquam ultrices mauris. Integer ante arcu, accumsan a, consectetuer eget, posuere ut, mauris. Praesent adipiscing. Phasellus ullamcorper ipsum rutrum nunc. Nunc nonummy metus. Vestibulum volutpat pretium libero. Cras id dui. Aenean ut eros et nisl sagittis vestibulum. Nullam nulla eros, ultricies sit amet, nonummy id, imperdiet feugiat, pede. Sed lectus. Donec mollis hendrerit risus. Phasellus nec sem in justo pellentesque facilisis. Etiam imperdiet imperdiet orci. Nunc nec neque. Phasellus leo dolor, tempus non, auctor et, hendrerit quis, nisi. Curabitur ligula sapien, tincidunt non, euismod vitae, posuere imperdiet, leo. Maecenas malesuada. Praesent congue erat at massa. Sed cursus turpis vitae tortor.\n" +
        "\n" +
        "Donec posuere vulputate arcu. Phasellus accumsan cursus velit. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed aliquam, nisi quis porttitor congue, elit erat euismod orci, ac placerat dolor lectus quis orci. Phasellus consectetuer vestibulum elit. Aenean tellus metus, bibendum sed, posuere ac, mattis non, nunc. Vestibulum fringilla pede sit amet augue. In turpis. Pellentesque posuere. Praesent turpis. Aenean posuere, tortor sed cursus feugiat, nunc augue blandit nunc, eu sollicitudin urna dolor sagittis lacus. Donec elit libero, sodales nec, volutpat a, suscipit non, turpis. Nullam sagittis. Suspendisse pulvinar, augue ac venenatis condimentum, sem libero volutpat nibh, nec pellentesque velit pede quis nunc. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Fusce id purus. Ut varius tincidunt libero. Phasellus dolor. Maecenas vestibulum mollis diam. Pellentesque ut neque. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. In dui magna, posuere eget, vestibulum et, tempor auctor, justo. In ac felis quis tortor malesuada pretium. Pellentesque auctor neque nec urna. Proin sapien ipsum, porta a, auctor quis, euismod ut, mi.\n" +
        "\n" +
        "Aenean viverra rhoncus pede. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut non enim eleifend felis pretium feugiat. Vivamus quis mi. Phasellus a est. Phasellus magna. In hac habitasse platea dictumst. Curabitur at lacus ac velit ornare lobortis. Curabitur a felis in nunc fringilla tristique. Morbi mattis ullamcorper velit. Phasellus gravida semper nisi. Nullam vel sem. Pellentesque libero tortor, tincidunt et, tincidunt eget, semper nec, quam. Sed hendrerit. Morbi ac felis. Nunc egestas, augue at pellentesque laoreet, felis eros vehicula leo, at malesuada velit leo quis pede. Donec interdum, metus et hendrerit aliquet, dolor diam sagittis ligula, eget egestas libero turpis vel mi. Nunc nulla. Fusce risus nisl, viverra et, tempor et, pretium in, sapien. Donec venenatis vulputate lorem. Morbi nec metus. Phasellus blandit leo ut odio. Maecenas ullamcorper, dui et placerat feugiat, eros pede varius nisi, condimentum viverra felis nunc et lorem. Sed magna purus, fermentum eu, tincidunt eu, varius ut, felis. In auctor lobortis lacus. Quisque libero metus, condimentum nec, tempor a, commodo mollis, magna. Vestibulum ullamcorper mauris at ligula. Fusce fermentum. Nullam cursus lacinia erat. Praesent blandit laoreet nibh.\n" +
        "\n" +
        "Fusce convallis metus id felis luctus adipiscing. Pellentesque egestas, neque sit amet convallis pulvinar, justo nulla eleifend augue, ac auctor orci leo non est. Quisque id mi. Ut tincidunt tincidunt erat. Etiam feugiat lorem non metus. Vestibulum dapibus nunc ac augue. Curabitur vestibulum aliquam leo. Praesent egestas neque eu enim. In hac habitasse platea dictumst. Fusce a quam. Etiam ut purus mattis mauris sodales aliquam. Curabitur nisi. Quisque malesuada placerat nisl. Nam ipsum risus, rutrum vitae, vestibulum eu, molestie vel, lacus. Sed augue ipsum, egestas nec, vestibulum et, malesuada adipiscing, dui. Vestibulum facilisis, purus nec pulvinar iaculis, ligula mi congue nunc, vitae euismod ligula urna in dolor. Mauris sollicitudin fermentum libero. Praesent nonummy mi in odio. Nunc interdum lacus sit amet orci. Vestibulum rutrum, mi nec elementum vehicula, eros quam gravida nisl, id fringilla neque ante vel mi. Morbi mollis tellus ac sapien. Phasellus volutpat, metus eget egestas mollis, lacus lacus blandit dui, id egestas quam mauris ut lacus. Fusce vel dui. Sed in libero ut nibh placerat accumsan. Proin faucibus arcu quis ante. In consectetuer turpis ut velit. Nulla sit amet est. Praesent metus tellus, elementum eu, semper a, adipiscing nec, purus.\n" +
        "\n" +
        "Cras risus ipsum, faucibus ut, ullamcorper id, varius ac, leo. Suspendisse feugiat. Suspendisse enim turpis, dictum sed, iaculis a, condimentum nec, nisi. Praesent nec nisl a purus blandit viverra. Praesent ac massa at ligula laoreet iaculis. Nulla neque dolor, sagittis eget, iaculis quis, molestie non, velit. Mauris turpis nunc, blandit et, volutpat molestie, porta ut, ligula. Fusce pharetra convallis urna. Quisque ut nisi. Donec mi odio, faucibus at, scelerisque quis, convallis in, nisi. Suspendisse non nisl sit amet velit hendrerit rutrum. Ut leo. Ut a nisl id ante tempus hendrerit. Proin pretium, leo ac pellentesque mollis, felis nunc ultrices eros, sed gravida augue augue mollis justo. Suspendisse eu ligula. Nulla facilisi. Donec id justo. Praesent porttitor, nulla vitae posuere iaculis, arcu nisl dignissim dolor, a pretium mi sem ut ipsum. Curabitur suscipit suscipit tellus. Praesent vestibulum dapibus nibh. Etiam iaculis nunc ac metus. Ut id nisl quis enim dignissim sagittis. Etiam sollicitudin, ipsum eu pulvinar rutrum, tellus ipsum laoreet sapien, quis venenatis ante odio sit amet eros. Proin magna. Duis vel nibh at velit scelerisque suscipit. Curabitur turpis. Vestibulum suscipit nulla quis orci. Fusce ac felis sit amet ligula pharetra condimentum.\n" +
        "\n" +
        "Maecenas egestas arcu quis ligula mattis placerat. Duis lobortis massa imperdiet quam. Suspendisse potenti. Pellentesque commodo eros a enim. Vestibulum turpis sem, aliquet eget, lobortis pellentesque, rutrum eu, nisl. Sed libero. Aliquam erat volutpat. Etiam vitae tortor. Morbi vestibulum volutpat enim. Aliquam eu nunc. Nunc sed turpis. Sed mollis, eros et ultrices tempus, mauris ipsum aliquam libero, non adipiscing dolor urna a orci. Nulla porta dolor. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. Pellentesque dapibus hendrerit tortor. Praesent egestas tristique nibh. Sed a libero. Cras varius. Donec vitae orci sed dolor rutrum auctor. Fusce egestas elit eget lorem. Suspendisse nisl elit, rhoncus eget, elementum ac, condimentum eget, diam. Nam at tortor in tellus interdum sagittis. Aliquam lobortis. Donec orci lectus, aliquam ut, faucibus non, euismod id, nulla. Curabitur blandit mollis lacus. Nam adipiscing. Vestibulum eu odio. Vivamus laoreet. Nullam tincidunt adipiscing enim. Phasellus tempus. Proin viverra, ligula sit amet ultrices semper, ligula arcu tristique sapien, a accumsan nisi mauris ac eros. Fusce neque. Suspendisse faucibus, nunc et pellentesque egestas, lacus ante convallis tellus, vitae iaculis lacus elit id tortor.\n" +
        "\n" +
        "Vivamus aliquet elit ac nisl. Fusce fermentum odio nec arcu. Vivamus euismod mauris. In ut quam vitae odio lacinia tincidunt. Praesent ut ligula non mi varius sagittis. Cras sagittis. Praesent ac sem eget est egestas volutpat. Vivamus consectetuer hendrerit lacus. Cras non dolor. Vivamus in erat ut urna cursus vestibulum. Fusce commodo aliquam arcu. Nam commodo suscipit quam. Quisque id odio. Praesent venenatis metus at tortor pulvinar varius. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue.\n" +
        "\n" +
        "Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc, quis gravida magna mi a libero. Fusce vulputate eleifend sapien. Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus. Nullam accumsan lorem in dui. Cras ultricies mi eu turpis hendrerit fringilla. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; In ac dui quis mi consectetuer lacinia. Nam pretium turpis et arcu. Duis arcu tortor, suscipit eget, imperdiet nec, imperdiet iaculis, ipsum. Sed aliquam ultrices mauris. Integer ante arcu, accumsan a, consectetuer eget, posuere ut, mauris. Praesent adipiscing. Phasellus ullamcorper ipsum rutrum nunc. Nunc nonummy metus. Vestibulum volutpat pretium libero. Cras id dui. Aenean ut eros et nisl sagittis vestibulum.\n" +
        "\n" +
        "Nullam nulla eros, ultricies sit amet, nonummy id, imperdiet feugiat, pede. Sed lectus. Donec mollis hendrerit risus. Phasellus nec sem in justo pellentesque facilisis. Etiam imperdiet imperdiet orci. Nunc nec neque. Phasellus leo dolor, tempus non, auctor et, hendrerit quis, nisi. Curabitur ligula sapien, tincidunt non, euismod vitae, posuere imperdiet, leo. Maecenas malesuada. Praesent congue erat at massa. Sed cursus turpis vitae tortor. Donec posuere vulputate arcu. Phasellus accumsan cursus velit. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed aliquam, nisi quis porttitor congue, elit erat euismod orci, ac placerat dolor lectus quis orci. Phasellus consectetuer vestibulum elit. Aenean tellus metus, bibendum sed, posuere ac, mattis non, nunc. Vestibulum fringilla pede sit amet augue. In turpis. Pellentesque posuere. Praesent turpis. Aenean posuere, tortor sed cursus feugiat, nunc augue blandit nunc, eu sollicitudin urna dolor sagittis lacus. Donec elit libero, sodales nec, volutpat a, suscipit non, turpis. Nullam sagittis. Suspendisse pulvinar, augue ac venenatis condimentum, sem libero volutpat nibh, nec pellentesque velit pede quis nunc. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Fusce id purus. Ut varius tincidunt libero. Phasellus dolor. Maecenas vestibulum mollis diam. Pellentesque ut neque. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. In dui magna, posuere eget, vestibulum et, tempor auctor, justo. In ac felis quis tortor malesuada pretium. Pellentesque auctor neque nec urna. Proin sapien ipsum, porta a, auctor quis, euismod ut, mi. Aenean viverra rhoncus pede. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut non enim eleifend felis pretium feugiat. Vivamus quis mi. Phasellus a est. Phasellus magna. In hac habitasse platea dictumst. Curabitur at lacus ac velit ornare lobortis. Curabitur a felis in nunc fringilla tristique. Morbi mattis ullamcorper velit. Phasellus gravida semper nisi. Nullam vel sem. Pellentesque libero tortor, tincidunt et, tincidunt eget, semper nec, quam. Sed hendrerit. Morbi ac felis.\n" +
        "\n"})
private String INPUT;

public static void main(String[] args) throws Exception {
    Options opt = new OptionsBuilder()
            .include(Benchmark.class.getSimpleName())
            .forks(1)
            .build();

    new Runner(opt).run();
}

@org.openjdk.jmh.annotations.Benchmark
public void jdkStringWriter(Blackhole blackhole) {
    try (Writer stringWriter = new StringWriter(INPUT.length() * 2)) {
        blackhole.consume(stringWriter.append(INPUT));
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}

@org.openjdk.jmh.annotations.Benchmark
public void commonsIOStringBuilderWriter(Blackhole blackhole) {
    try (Writer stringWriter = new StringBuilderWriter(INPUT.length() * 2)) {
        blackhole.consume(stringWriter.append(INPUT));
    } catch (IOException e) {
        throw new RuntimeException(e);
    }
}

}`

I got very close results

(INPUT) Mode Cnt Score Error Units
jdkStringWriter
thrpt 5 316,929 ± 2,652 ops/ms
commonsIOStringBuilderWriter
thrpt 5 319,308 ± 0,779 ops/ms

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, I've just tested it in context and there's no noticeable difference:

Pre change:

Result "benchmarks.HandlebarsOptimizedTemplateBenchmark.transform":
  128.817 ±(99.9%) 2.789 ops/s [Average]
  (min, avg, max) = (121.318, 128.817, 132.848), stdev = 3.212
  CI (99.9%): [126.028, 131.606] (assumes normal distribution)

Benchmark                                        Mode  Cnt    Score   Error  Units
HandlebarsOptimizedTemplateBenchmark.transform  thrpt   20  128.817 ± 2.789  ops/s

Post change:

Result "benchmarks.HandlebarsOptimizedTemplateBenchmark.transform":
  128.634 ±(99.9%) 1.560 ops/s [Average]
  (min, avg, max) = (124.034, 128.634, 130.370), stdev = 1.796
  CI (99.9%): [127.074, 130.194] (assumes normal distribution)

Benchmark                                        Mode  Cnt    Score   Error  Units
HandlebarsOptimizedTemplateBenchmark.transform  thrpt   20  128.634 ± 1.560  ops/s

template.apply(context, stringWriter);
return stringWriter.toString();
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2022-2023 Thomas Akehurst
* Copyright (C) 2022-2024 Thomas Akehurst
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -47,7 +47,6 @@
import org.apache.commons.fileupload.util.FileItemHeadersImpl;
import org.apache.commons.fileupload.util.LimitedInputStream;
import org.apache.commons.fileupload.util.Streams;
import org.apache.commons.io.IOUtils;

/**
* The implementation is largely ported from {@link org.apache.commons.fileupload.FileUpload} and
Expand Down Expand Up @@ -103,7 +102,7 @@ protected FileItemFactory getFileItemFactory() {
* @throws FileUploadException if there are problems reading/parsing the request or storing files.
*/
public List<FileItem> parseRequest(RequestContext ctx) throws FileUploadException {
List<FileItem> items = new ArrayList<FileItem>();
List<FileItem> items = new ArrayList<>();
boolean successful = false;
try {
FileItemIterator iter = getItemIterator(ctx);
Expand Down Expand Up @@ -580,7 +579,7 @@ public void setHeaders(FileItemHeaders pHeaders) {
: contentLengthInt;
// CHECKSTYLE:ON

InputStream input; // N.B. this is eventually closed in MultipartStream processing
; // N.B. this is eventually closed in MultipartStream processing
if (sizeMax >= 0) {
if (requestSize != -1 && requestSize > sizeMax) {
throw new SizeLimitExceededException(
Expand All @@ -590,50 +589,49 @@ public void setHeaders(FileItemHeaders pHeaders) {
requestSize,
sizeMax);
}
// N.B. this is eventually closed in MultipartStream processing
input =
new LimitedInputStream(ctx.getInputStream(), sizeMax) {
@Override
protected void raiseError(long pSizeMax, long pCount) throws IOException {
FileUploadException ex =
new SizeLimitExceededException(
format(
"the request was rejected because its size (%s) exceeds the configured maximum (%s)",
pCount, pSizeMax),
pCount,
pSizeMax);
throw new FileUploadIOException(ex);
}
};
} else {
input = ctx.getInputStream();
}

String charEncoding = headerEncoding;
if (charEncoding == null) {
charEncoding = ctx.getCharacterEncoding();
}
try (InputStream input =
sizeMax >= 0
? new LimitedInputStream(ctx.getInputStream(), sizeMax) {
@Override
protected void raiseError(long pSizeMax, long pCount) throws IOException {
FileUploadException ex =
new SizeLimitExceededException(
format(
"the request was rejected because its size (%s) exceeds the configured maximum (%s)",
pCount, pSizeMax),
pCount,
pSizeMax);
throw new FileUploadIOException(ex);
}
}
: ctx.getInputStream()) {
Comment on lines +594 to +609
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, try with resources is better than closing the stream and then throwing.

String charEncoding = headerEncoding;
if (charEncoding == null) {
charEncoding = ctx.getCharacterEncoding();
}

boundary = getBoundary(contentType);
if (boundary == null) {
IOUtils.closeQuietly(input); // avoid possible resource leak
throw new FileUploadException(
"the request was rejected because no multipart boundary was found");
}
boundary = getBoundary(contentType);
if (boundary == null) {
throw new FileUploadException(
"the request was rejected because no multipart boundary was found");
}

try {
multi = new MultipartStream(input, boundary, 4096, null);
} catch (IllegalArgumentException iae) {
IOUtils.closeQuietly(input); // avoid possible resource leak
throw new InvalidContentTypeException(
format(
"The boundary specified in the %s header is too long", FileUploadBase.CONTENT_TYPE),
iae);
}
multi.setHeaderEncoding(charEncoding);
try {
multi = new MultipartStream(input, boundary, 4096, null);
} catch (IllegalArgumentException iae) {
throw new InvalidContentTypeException(
format(
"The boundary specified in the %s header is too long",
FileUploadBase.CONTENT_TYPE),
iae);
}
multi.setHeaderEncoding(charEncoding);

skipPreamble = true;
findNextItem();
skipPreamble = true;
findNextItem();
}
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2019-2021 Thomas Akehurst
* Copyright (C) 2019-2024 Thomas Akehurst
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -29,9 +29,7 @@
import java.net.HttpURLConnection;
import java.net.SocketTimeoutException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.TimeUnit;
import org.apache.commons.io.IOUtils;
import org.junit.jupiter.api.*;
import org.junit.jupiter.api.MethodOrderer.OrderAnnotation;

Expand Down Expand Up @@ -126,7 +124,11 @@ private void downloadContentAndMeasure(String urlDir, String expectedBody) throw

private String httpGetContent(HttpURLConnection connection) throws IOException {
try (InputStream is = connection.getInputStream()) {
return IOUtils.toString(is, StandardCharsets.UTF_8);
StringBuilder sb = new StringBuilder();
for (int ch; (ch = is.read()) != -1; ) {
sb.append((char) ch);
}
return sb.toString();
}
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2017-2021 Thomas Akehurst
* Copyright (C) 2017-2024 Thomas Akehurst
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -30,7 +30,6 @@
import com.github.tomakehurst.wiremock.http.HttpClientFactory;
import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
import java.io.IOException;
import org.apache.commons.io.IOUtils;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.core5.http.ClassicHttpResponse;
Expand Down Expand Up @@ -80,7 +79,7 @@ public void requestIsSuccessfulButTakesLongerThanSocketTimeoutWhenDribbleIsEnabl
long start = System.currentTimeMillis();
ClassicHttpResponse response =
httpClient.execute(new HttpGet(wireMockRule.url("/delayedDribble")));
byte[] responseBody = IOUtils.toByteArray(response.getEntity().getContent());
byte[] responseBody = response.getEntity().getContent().readAllBytes();
int duration = (int) (System.currentTimeMillis() - start);

assertThat(response.getCode(), is(200));
Expand Down Expand Up @@ -121,7 +120,7 @@ public void requestIsSuccessfulAndBelowSocketTimeoutWhenDribbleIsDisabled() thro
long start = System.currentTimeMillis();
ClassicHttpResponse response =
httpClient.execute(new HttpGet(wireMockRule.url("/nonDelayedDribble")));
byte[] responseBody = IOUtils.toByteArray(response.getEntity().getContent());
byte[] responseBody = response.getEntity().getContent().readAllBytes();
int duration = (int) (System.currentTimeMillis() - start);

assertThat(response.getCode(), is(200));
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2013-2023 Thomas Akehurst
* Copyright (C) 2013-2024 Thomas Akehurst
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -24,9 +24,12 @@
import com.github.tomakehurst.wiremock.stubbing.StubMapping;
import com.github.tomakehurst.wiremock.testsupport.WireMockResponse;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Comparator;
import java.util.Objects;
import org.apache.commons.io.FileUtils;
import java.util.stream.Stream;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeDiagnosingMatcher;
Expand All @@ -42,7 +45,9 @@ public class SavingMappingsAcceptanceTest extends AcceptanceTestBase {
private static void resetFileSourceRoot() {
try {
if (FILE_SOURCE_ROOT.exists()) {
FileUtils.deleteDirectory(FILE_SOURCE_ROOT);
try (Stream<Path> pathStream = Files.walk(FILE_SOURCE_ROOT.toPath().toAbsolutePath())) {
pathStream.sorted(Comparator.reverseOrder()).map(Path::toFile).forEach(File::delete);
}
}
if (!FILES_DIRECTORY.mkdirs()) {
throw new Exception("Could no create " + FILES_DIRECTORY.getAbsolutePath());
Expand All @@ -62,13 +67,13 @@ public static void setupServer() {
}

@BeforeEach
public void setUp() throws Exception {
public void setUp() {
resetFileSourceRoot();
reset();
}

@Test
public void savesMappingsToMappingsDirectory() {
void savesMappingsToMappingsDirectory() {
// Check the mapping we're about to add isn't already there
WireMockResponse response = testClient.get("/some/url");
assertThat(response.statusCode(), is(404));
Expand All @@ -89,7 +94,7 @@ public void savesMappingsToMappingsDirectory() {
}

@Test
public void savedMappingIsDeletedFromTheDiskOnRemove() {
void savedMappingIsDeletedFromTheDiskOnRemove() {
StubMapping stubMapping = stubFor(get("/delete/me").willReturn(ok()));
saveAllMappings();

Expand Down Expand Up @@ -124,7 +129,7 @@ public void describeTo(Description description) {
}

@Test
public void doesNotDuplicateMappingsAlreadyPersistedToFileSystem() {
void doesNotDuplicateMappingsAlreadyPersistedToFileSystem() {
// Check the mapping we're about to add isn't already there
WireMockResponse response = testClient.get("/some/url");
assertThat(response.statusCode(), is(404));
Expand All @@ -137,11 +142,11 @@ public void doesNotDuplicateMappingsAlreadyPersistedToFileSystem() {
saveAllMappings();

// Check only one file has been written
assertThat(MAPPINGS_DIRECTORY.listFiles().length, is(1));
assertThat(Objects.requireNonNull(MAPPINGS_DIRECTORY.listFiles()).length, is(1));
}

@Test
public void doesNotDuplicateMappingsAlreadyPersistedAfterReset() {
void doesNotDuplicateMappingsAlreadyPersistedAfterReset() {
// Check the mapping we're about to add isn't already there
WireMockResponse response = testClient.get("/some/url");
assertThat(response.statusCode(), is(404));
Expand All @@ -155,7 +160,7 @@ public void doesNotDuplicateMappingsAlreadyPersistedAfterReset() {
saveAllMappings();

// Check only one file has been written
assertThat(MAPPINGS_DIRECTORY.listFiles().length, is(1));
assertThat(Objects.requireNonNull(MAPPINGS_DIRECTORY.listFiles()).length, is(1));
}

static final TypeSafeDiagnosingMatcher<StubMapping> IS_PERSISTENT =
Expand Down
Loading
Loading