mirror of
https://github.com/discourse/discourse.git
synced 2024-11-29 17:45:03 +08:00
ea5c3a3bdc
In AdminDashboardData we have a bunch of problem checks implemented as methods on that class. This PR absolves it of the responsibility by promoting each of those checks to a first class ProblemCheck. This way each of them can have their own priority and arbitrary functionality can be isolated in its own class. Think "extract class" refactoring over and over. Since they were all moved we can also get rid of the @@problem_syms class variable which was basically the old version of the registry now replaced by ProblemCheck.realtime. In addition AdminDashboardData::Problem value object has been entirely replaced with the new ProblemCheck::Problem (with compatible API). Lastly, I added some RSpec matchers to simplify testing of problem checks and provide helpful error messages when assertions fail.
105 lines
2.1 KiB
Ruby
105 lines
2.1 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
class ProblemCheck
|
|
include ActiveSupport::Configurable
|
|
|
|
config_accessor :priority, default: "low", instance_writer: false
|
|
|
|
# Determines if the check should be performed at a regular interval, and if
|
|
# so how often. If left blank, the check will be performed every time the
|
|
# admin dashboard is loaded, or the data is otherwise requested.
|
|
#
|
|
config_accessor :perform_every, default: nil, instance_writer: false
|
|
|
|
# How many times the check should retry before registering a problem. Only
|
|
# works for scheduled checks.
|
|
#
|
|
config_accessor :max_retries, default: 2, instance_writer: false
|
|
|
|
# The retry delay after a failed check. Only works for scheduled checks with
|
|
# more than one retry configured.
|
|
#
|
|
config_accessor :retry_after, default: 30.seconds, instance_writer: false
|
|
|
|
def self.[](key)
|
|
key = key.to_sym
|
|
|
|
checks.find { |c| c.identifier == key }
|
|
end
|
|
|
|
def self.checks
|
|
descendants
|
|
end
|
|
|
|
def self.scheduled
|
|
checks.select(&:scheduled?)
|
|
end
|
|
|
|
def self.realtime
|
|
checks.reject(&:scheduled?)
|
|
end
|
|
|
|
def self.identifier
|
|
name.demodulize.underscore.to_sym
|
|
end
|
|
delegate :identifier, to: :class
|
|
|
|
def self.scheduled?
|
|
perform_every.present?
|
|
end
|
|
delegate :scheduled?, to: :class
|
|
|
|
def self.realtime?
|
|
!scheduled?
|
|
end
|
|
delegate :realtime?, to: :class
|
|
|
|
def self.call(data = {})
|
|
new(data).call
|
|
end
|
|
|
|
def initialize(data = {})
|
|
@data = OpenStruct.new(data)
|
|
end
|
|
|
|
attr_reader :data
|
|
|
|
def call
|
|
raise NotImplementedError
|
|
end
|
|
|
|
private
|
|
|
|
def problem(override_key = nil)
|
|
[
|
|
Problem.new(
|
|
message ||
|
|
I18n.t(
|
|
override_key || translation_key,
|
|
base_path: Discourse.base_path,
|
|
**translation_data.symbolize_keys,
|
|
),
|
|
priority: self.config.priority,
|
|
identifier:,
|
|
),
|
|
]
|
|
end
|
|
|
|
def no_problem
|
|
[]
|
|
end
|
|
|
|
def message
|
|
nil
|
|
end
|
|
|
|
def translation_key
|
|
# TODO: Infer a default based on class name, then move translations in locale file.
|
|
raise NotImplementedError
|
|
end
|
|
|
|
def translation_data
|
|
{}
|
|
end
|
|
end
|