mirror of
https://github.com/discourse/discourse.git
synced 2025-02-06 03:18:23 +00:00
a72dc2f420
Previously, problem checks were all added as either class methods or blocks in AdminDashboardData. Another set of class methods were used to add and run problem checks. As of this PR, problem checks are promoted to first-class citizens. Each problem check receives their own class. This class of course contains the implementation for running the check, but also configuration items like retry strategies (for scheduled checks.) In addition, the parent class ProblemCheck also serves as a registry for checks. For example we can get a list of all existing check classes through ProblemCheck.checks, or just the ones running on a schedule through ProblemCheck.scheduled. After this refactor, the task of adding a new check is significantly simplified. You add a class that inherits ProblemCheck, you implement it, add a test, and you're good to go.
36 lines
993 B
Ruby
36 lines
993 B
Ruby
# frozen_string_literal: true
|
|
|
|
module Jobs
|
|
class RetrySignal < Exception
|
|
end
|
|
|
|
# This job runs a singular scheduled admin check. It is scheduled by
|
|
# the ProblemChecks (plural) scheduled job.
|
|
class ProblemCheck < ::Jobs::Base
|
|
sidekiq_options retry: false
|
|
|
|
def execute(args)
|
|
retry_count = args[:retry_count].to_i
|
|
identifier = args[:check_identifier].to_sym
|
|
|
|
check = ::ProblemCheck[identifier]
|
|
|
|
problems = check.call
|
|
raise RetrySignal if problems.present? && retry_count < check.max_retries
|
|
|
|
problems.each { |problem| AdminDashboardData.add_found_scheduled_check_problem(problem) }
|
|
rescue RetrySignal
|
|
Jobs.enqueue_in(
|
|
check.retry_after,
|
|
:problem_check,
|
|
args.merge(retry_count: retry_count + 1).stringify_keys,
|
|
)
|
|
rescue StandardError => err
|
|
Discourse.warn_exception(
|
|
err,
|
|
message: "A scheduled admin dashboard problem check (#{identifier}) errored.",
|
|
)
|
|
end
|
|
end
|
|
end
|