discourse/spec/jobs/problem_checks_spec.rb
Martin Brennan 2d68e5d942
FEATURE: Scheduled problem checks for admin dashboard (#15327)
This commit introduces scheduled problem checks for the admin dashboard, which are long running or otherwise cumbersome problem checks that will be run every 10 minutes rather than every time the dashboard is loaded. If these scheduled checks add a problem, the problem will remain until it is cleared or until the scheduled job runs again.

An example of a check that should be scheduled is validating credentials against an external provider.

This commit also introduces the concept of a `priority` to the problems generated by `AdminDashboardData` and the scheduled checks. This is `low` by default, and can be set to `high`, but this commit does not change any part of the UI with this information, only adds a CSS class.

I will be making a follow up PR to check group SMTP credentials.
2021-12-20 09:59:11 +10:00

77 lines
2.9 KiB
Ruby

# frozen_string_literal: true
require 'rails_helper'
describe Jobs::ProblemChecks do
after do
Discourse.redis.flushdb
AdminDashboardData.reset_problem_checks
end
it "runs the scheduled problem check that has been added and adds the messages to the load_found_scheduled_check_problems array" do
AdminDashboardData.add_scheduled_problem_check(:test_identifier) do
AdminDashboardData::Problem.new("big problem")
end
described_class.new.execute(nil)
problems = AdminDashboardData.load_found_scheduled_check_problems
expect(problems.count).to eq(1)
expect(problems.first).to be_a(AdminDashboardData::Problem)
expect(problems.first.to_s).to eq("big problem")
end
it "can handle the problem check returning multiple problems" do
AdminDashboardData.add_scheduled_problem_check(:test_identifier) do
[
AdminDashboardData::Problem.new("big problem"),
AdminDashboardData::Problem.new("yuge problem", priority: "high", identifier: "config_is_a_mess")
]
end
described_class.new.execute(nil)
problems = AdminDashboardData.load_found_scheduled_check_problems
expect(problems.map(&:to_s)).to match_array(["big problem", "yuge problem"])
end
it "does not add the same problem twice if the identifier already exists" do
AdminDashboardData.add_scheduled_problem_check(:test_identifier) do
[
AdminDashboardData::Problem.new("yuge problem", priority: "high", identifier: "config_is_a_mess"),
AdminDashboardData::Problem.new("nasty problem", priority: "high", identifier: "config_is_a_mess")
]
end
described_class.new.execute(nil)
problems = AdminDashboardData.load_found_scheduled_check_problems
expect(problems.map(&:to_s)).to match_array(["yuge problem"])
end
it "starts with a blank slate every time the checks are run to avoid duplicate problems and to clear no longer firing problems" do
problem_should_fire = true
AdminDashboardData.add_scheduled_problem_check(:test_identifier) do
if problem_should_fire
problem_should_fire = false
AdminDashboardData::Problem.new("yuge problem", priority: "high")
end
end
described_class.new.execute(nil)
expect(AdminDashboardData.load_found_scheduled_check_problems.count).to eq(1)
described_class.new.execute(nil)
expect(AdminDashboardData.load_found_scheduled_check_problems.count).to eq(0)
end
it "handles errors from a troublesome check and proceeds with the rest" do
AdminDashboardData.add_scheduled_problem_check(:test_identifier) do
raise StandardError.new("something went wrong")
AdminDashboardData::Problem.new("polling issue")
end
AdminDashboardData.add_scheduled_problem_check(:test_identifier_2) do
AdminDashboardData::Problem.new("yuge problem", priority: "high")
end
described_class.new.execute(nil)
expect(AdminDashboardData.load_found_scheduled_check_problems.count).to eq(1)
end
end