Skip to content

feat periodic_task: add enable flag to Settings #914

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.

Sign up for GitHub

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

Closed
samsonovak8 wants to merge 1 commit into from
Closed

feat periodic_task: add enable flag to Settings #914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions core/include/userver/utils/periodic_task.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,27 +67,30 @@ class PeriodicTask final {
constexpr /*implicit*/ Settings(
std::chrono::milliseconds period,
utils::Flags<Flags> flags = {},
logging::Level span_level = logging::Level::kInfo
logging::Level span_level = logging::Level::kInfo,
bool enabled = true
)
: Settings(period, kDistributionPercent, flags, span_level) {}
: Settings(period, kDistributionPercent, flags, span_level, enabled) {}

constexpr Settings(
std::chrono::milliseconds period,
std::chrono::milliseconds distribution,
utils::Flags<Flags> flags = {},
logging::Level span_level = logging::Level::kInfo
logging::Level span_level = logging::Level::kInfo,
bool enabled = true
)
: period(period), distribution(distribution), flags(flags), span_level(span_level) {
: period(period), distribution(distribution), flags(flags), span_level(span_level), enabled(enabled) {
UASSERT(distribution <= period);
}

constexpr Settings(
std::chrono::milliseconds period,
uint8_t distribution_percent,
utils::Flags<Flags> flags = {},
logging::Level span_level = logging::Level::kInfo
logging::Level span_level = logging::Level::kInfo,
bool enabled = true
)
: Settings(period, period * distribution_percent / 100, flags, span_level) {
: Settings(period, period * distribution_percent / 100, flags, span_level, enabled) {
UASSERT(distribution_percent <= 100);
}

Expand Down Expand Up @@ -124,6 +127,9 @@ class PeriodicTask final {
/// PeriodicTask::Start() calls engine::current_task::GetTaskProcessor()
/// to get the TaskProcessor.
engine::TaskProcessor* task_processor{nullptr};

/// @brief If false, the task will skip executions until re-enabled.
bool enabled{true};
};

/// Signature of the task to be executed each period.
Expand Down
11 changes: 6 additions & 5 deletions core/src/utils/periodic_task.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ namespace {

auto TieSettings(const PeriodicTask::Settings& settings) {
// Can't use Boost.Pfr, because Settings has custom constructors.
const auto& [f1, f2, f3, f4, f5, f6] = settings;
return std::tie(f1, f2, f3, f4, f5, f6);
const auto& [f1, f2, f3, f4, f5, f6, f7] = settings;
return std::tie(f1, f2, f3, f4, f5, f6, f7);
}

} // namespace
Expand Down Expand Up @@ -106,7 +106,7 @@ void PeriodicTask::SetSettings(Settings settings) {
return;
}
settings.flags = writer->flags;
should_notify_task = settings.period != writer->period || settings.exception_period != writer->exception_period;
should_notify_task = settings.period != writer->period || settings.exception_period != writer->exception_period || settings.enabled != writer->enabled;
*writer = std::move(settings);
writer.Commit();
}
Expand Down Expand Up @@ -144,12 +144,13 @@ void PeriodicTask::Run() {
while (!engine::current_task::ShouldCancel()) {
const auto before = std::chrono::steady_clock::now();
bool no_exception = true;
bool force_step = should_force_step_.exchange(false);
const auto settings = settings_.Read();

if (!std::exchange(skip_step, false)) {
if (force_step || (settings->enabled && !std::exchange(skip_step, false))) {
no_exception = Step();
}

const auto settings = settings_.Read();
auto period = settings->period;
const auto exception_period = settings->exception_period.value_or(period);

Expand Down