Improve performance of writing JSON values

The old code was exceedingly simple, as it went char-by-char and
decided whether to write it to the output stream as-is, or escaped.
This caused a _lot_ of stream writes of individual characters.

The new code instead looks for characters that need escaping, and
bulk-writes the non-escaped characters in between them. This leads
to about the same performance for strings that comprise of only
escaped characters, and 3-10x improvement for strings without any
escaping needed.

In practice, we should expect the former rather than the latter,
but this is still nice improvement.
This commit is contained in:
Martin Hořeňovský
2025-08-21 23:36:22 +02:00
parent 78a9518a28
commit fb2e4fbe41
2 changed files with 66 additions and 23 deletions

View File

@@ -7,6 +7,8 @@
// SPDX-License-Identifier: BSL-1.0
#include <catch2/catch_test_macros.hpp>
#include <catch2/benchmark/catch_benchmark.hpp>
#include <catch2/generators/catch_generators.hpp>
#include <catch2/internal/catch_jsonwriter.hpp>
#include <catch2/matchers/catch_matchers_string.hpp>
@@ -17,7 +19,6 @@ namespace {
static std::ostream& operator<<( std::ostream& os, Custom const& ) {
return os << "custom";
}
} // namespace
TEST_CASE( "JsonWriter", "[JSON][JsonWriter]" ) {
@@ -150,3 +151,28 @@ TEST_CASE( "JsonWriter escapes characters in strings properly", "[JsonWriter]" )
REQUIRE( sstream.str() == "\"\\\\/\\t\\r\\n\"" );
}
}
TEST_CASE( "JsonWriter benchmarks", "[JsonWriter][!benchmark]" ) {
const auto input_length = GENERATE( as<size_t>{}, 10, 100, 10'000 );
std::string test_input( input_length, 'a' );
BENCHMARK_ADVANCED( "write string, no-escaping, len=" +
std::to_string( input_length ) )(
Catch::Benchmark::Chronometer meter ) {
std::stringstream sstream;
meter.measure( [&]( int ) {
Catch::JsonValueWriter( sstream ).write( test_input );
} );
};
std::string escape_input( input_length, '\b' );
BENCHMARK_ADVANCED( "write string, all-escaped, len=" +
std::to_string( input_length ) )(
Catch::Benchmark::Chronometer meter ) {
std::stringstream sstream;
meter.measure( [&]( int ) {
Catch::JsonValueWriter( sstream ).write( escape_input );
} );
};
}
} // namespace