Skip to content

Commit

Permalink
fix: Incorrect log values in newconfig (#1807)
Browse files Browse the repository at this point in the history
Additional fixes for #1627
  • Loading branch information
PeterChen13579 authored and godexsoft committed Jan 7, 2025
1 parent 766bfac commit 2ad36cf
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 2 deletions.
1 change: 1 addition & 0 deletions src/app/ClioApplication.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
//==============================================================================

#pragma once

#include "util/SignalsHandler.hpp"
#include "util/newconfig/ConfigDefinition.hpp"

Expand Down
37 changes: 37 additions & 0 deletions src/util/BytesConverter.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
//------------------------------------------------------------------------------
/*
This file is part of clio: https://github.com/XRPLF/clio
Copyright (c) 2025, the clio developers.
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================

#pragma once

#include <cstdint>

namespace util {

/**
* @brief Convert megabytes to bytes
* @param mb Number of megabytes to convert
* @return The equivalent number of bytes
*/
constexpr std::uint64_t
mbToBytes(std::uint32_t mb)
{
return mb * 1024ul * 1024ul;
}

}; // namespace util
7 changes: 5 additions & 2 deletions src/util/log/Logger.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include "util/log/Logger.hpp"

#include "util/Assert.hpp"
#include "util/BytesConverter.hpp"
#include "util/SourceLocation.hpp"
#include "util/newconfig/ArrayView.hpp"
#include "util/newconfig/ConfigDefinition.hpp"
Expand Down Expand Up @@ -134,9 +135,11 @@ LogService::init(config::ClioConfigDefinition const& config)
boost::filesystem::path dirPath{logDir.value()};
if (!boost::filesystem::exists(dirPath))
boost::filesystem::create_directories(dirPath);
auto const rotationSize = config.get<uint64_t>("log_rotation_size");
auto const rotationPeriod = config.get<uint32_t>("log_rotation_hour_interval");
auto const dirSize = config.get<uint64_t>("log_directory_max_size");

// the below are taken from user in MB, but boost::log::add_file_log needs it to be in bytes
auto const rotationSize = mbToBytes(config.get<uint32_t>("log_rotation_size"));
auto const dirSize = mbToBytes(config.get<uint32_t>("log_directory_max_size"));
auto fileSink = boost::log::add_file_log(
keywords::file_name = dirPath / "clio.log",
keywords::target_file_name = dirPath / "clio_%Y-%m-%d_%H-%M-%S.log",
Expand Down
1 change: 1 addition & 0 deletions tests/unit/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ target_sources(
etlng/GrpcSourceTests.cpp
etlng/RegistryTests.cpp
# Feed
util/BytesConverterTests.cpp
feed/BookChangesFeedTests.cpp
feed/ForwardFeedTests.cpp
feed/LedgerFeedTests.cpp
Expand Down
40 changes: 40 additions & 0 deletions tests/unit/util/BytesConverterTests.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
//------------------------------------------------------------------------------
/*
This file is part of clio: https://github.com/XRPLF/clio
Copyright (c) 2025, the clio developers.
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================

#include "util/BytesConverter.hpp"

#include <gtest/gtest.h>
#include <cstdint>
#include <limits>

using namespace util;

TEST(MBToBytesTest, SimpleValues)
{
EXPECT_EQ(mbToBytes(0), 0);
EXPECT_EQ(mbToBytes(1), 1024 * 1024);
EXPECT_EQ(mbToBytes(2), 2 * 1024 * 1024);
}

TEST(MBToBytesTest, LimitValues)
{
auto const maxNum = std::numeric_limits<std::uint32_t>::max();
EXPECT_NE(mbToBytes(maxNum), maxNum * 1024 * 1024);
EXPECT_EQ(mbToBytes(maxNum), maxNum * 1024ul * 1024ul);
}

0 comments on commit 2ad36cf

Please sign in to comment.