Skip to content

A platform for community discussion. Free, open, simple.

FEATURE: Add Site Advice section to the redesigned admin dashboard (#40969)

Alan Guo Xiang Tana6413265f409
diff --git a/app/assets/stylesheets/admin/admin_dashboard.scss b/app/assets/stylesheets/admin/admin_dashboard.scss
index 053e165e6a0..91af2848177 100644
--- a/app/assets/stylesheets/admin/admin_dashboard.scss
+++ b/app/assets/stylesheets/admin/admin_dashboard.scss
@@ -1,5 +1,77 @@
@use "lib/viewport";
+.db-site-advice {
+ border: 1px solid var(--primary-low);
+ border-radius: var(--d-border-radius-large);
+
+ &__header {
+ display: flex;
+ align-items: center;
+ justify-content: space-between;
+ background: var(--primary-very-low);
+ padding: var(--space-2) var(--space-4);
+ border-top-left-radius: var(--d-border-radius-large);
+ border-top-right-radius: var(--d-border-radius-large);
+ border-bottom: 1px solid var(--primary-low);
+
+ h3 {
+ margin: 0;
+ font-size: var(--font-0);
+ }
+ }
+
+ ul {
+ list-style: none;
+ padding: 0;
+ margin: 0;
+ }
+
+ &__list {
+ display: flex;
+ flex-direction: column;
+ }
+
+ &__item {
+ display: flex;
+ align-items: center;
+
+ &:has(ul) {
+ align-items: flex-start;
+ }
+
+ @include viewport.until(sm) {
+ align-items: flex-start;
+ }
+ gap: var(--space-3);
+ padding: var(--space-4);
+
+ &:not(:last-child) {
+ border-bottom: 1px solid var(--primary-low);
+ }
+
+ .btn {
+ margin-left: auto;
+ }
+ }
+
+ &__icon {
+ flex-shrink: 0;
+ margin-top: 0.125rem;
+
+ &.--high {
+ color: var(--danger);
+ }
+
+ &.--low {
+ color: var(--tertiary);
+ }
+ }
+
+ &__message {
+ overflow-wrap: anywhere;
+ }
+}
+
.db-main {
display: flex;
flex-direction: column;
@@ -201,6 +273,10 @@
}
&__subintro {
+ h3 {
+ margin: 0;
+ }
+
p {
font-size: var(--font-down-1-rem);
color: var(--primary-high);
diff --git a/app/controllers/admin/dashboard_controller.rb b/app/controllers/admin/dashboard_controller.rb
index 8abfac4da89..bbf7768e1f6 100644
--- a/app/controllers/admin/dashboard_controller.rb
+++ b/app/controllers/admin/dashboard_controller.rb
@@ -42,7 +42,7 @@ class Admin::DashboardController < Admin::StaffController
def problems
ProblemCheck.realtime.run_all
- render json: { problems: serialize_data(AdminNotice.problem.all, AdminNoticeSerializer) }
+ render json: { problems: serialized_problems }
end
def new_features
@@ -131,6 +131,10 @@ class Admin::DashboardController < Admin::StaffController
private
+ def serialized_problems
+ serialize_data(AdminNotice.problem.order(:id), AdminNoticeSerializer)
+ end
+
def dashboard_sections_payload
visible_ids = AdminDashboardSectionConfiguration.visible_section_ids
data = {
@@ -141,6 +145,7 @@ class Admin::DashboardController < Admin::StaffController
start_date: params[:start_date],
end_date: params[:end_date],
),
+ problems: serialized_problems,
}
if current_user.admin?
data[:configuration] = { sections: AdminDashboardSectionConfiguration.sections }
diff --git a/app/jobs/scheduled/run_problem_checks.rb b/app/jobs/scheduled/run_problem_checks.rb
index 125172724ef..ea3df8c72c5 100644
--- a/app/jobs/scheduled/run_problem_checks.rb
+++ b/app/jobs/scheduled/run_problem_checks.rb
@@ -25,6 +25,8 @@ module Jobs
end
end
end
+
+ ProblemCheck.realtime.run_all
end
end
end
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index cfe99958f21..8e2fb666026 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -7013,6 +7013,10 @@ en:
latest_version: "Latest"
problems_found: "Some advice based on your current site settings"
dismiss_notice: "Ignore"
+ site_advice:
+ title:
+ one: "%{count} issue requires your attention based on your site configuration"
+ other: "%{count} issues require your attention based on your site configuration"
new_features:
title: "What's new?"
subtitle: "We are releasing new features and improvements all the time. This page covers the highlights, but you can click 'Learn more' to see extensive release notes."
diff --git a/frontend/discourse/admin/components/dashboard/site-advice.gjs b/frontend/discourse/admin/components/dashboard/site-advice.gjs
new file mode 100644
index 00000000000..200a7713288
--- /dev/null
+++ b/frontend/discourse/admin/components/dashboard/site-advice.gjs
@@ -0,0 +1,101 @@
+import Component from "@glimmer/component";
+import { tracked } from "@glimmer/tracking";
+import { concat, fn } from "@ember/helper";
+import { action } from "@ember/object";
+import { service } from "@ember/service";
+import { trustHTML } from "@ember/template";
+import { compare } from "@ember/utils";
+import { eq } from "discourse/truth-helpers";
+import DButton from "discourse/ui-kit/d-button";
+import dIcon from "discourse/ui-kit/helpers/d-icon";
+import { i18n } from "discourse-i18n";
+
+export default class DashboardSiteAdvice extends Component {
+ @service currentUser;
+
+ @tracked refreshing = false;
+ @tracked ignoringId = null;
+
+ @action
+ async refresh() {
+ this.refreshing = true;
+ try {
+ await this.args.onRefresh();
+ } finally {
+ this.refreshing = false;
+ }
+ }
+
+ @action
+ async ignore(problem) {
+ this.ignoringId = problem.id;
+ try {
+ await this.args.onIgnore(problem);
+ } finally {
+ this.ignoringId = null;
+ }
+ }
+
+ get sortedProblems() {
+ return [...this.args.problems].sort(
+ (a, b) => compare(a?.priority, b?.priority) || compare(a?.id, b?.id)
+ );
+ }
+
+ get title() {
+ return i18n("admin.dashboard.site_advice.title", {
+ count: this.args.problems.length,
+ });
+ }
+
+ <template>
+ {{#if @problems.length}}
+ <section class="db-site-advice">
+ <div class="db-site-advice__header">
+ <h3>{{this.title}}</h3>
+ <DButton
+ class="btn-transparent btn-small"
+ data-test-site-advice-refresh="true"
+ @action={{this.refresh}}
+ @isLoading={{this.refreshing}}
+ @icon="arrows-rotate"
+ @label="admin.dashboard.refresh_problems"
+ />
+ </div>
+
+ <ul class="db-site-advice__list">
+ {{#each this.sortedProblems key="id" as |problem|}}
+ <li
+ class="db-site-advice__item"
+ data-test-site-advice-problem={{problem.id}}
+ >
+
+ {{dIcon
+ (if
+ (eq problem.priority "high")
+ "triangle-exclamation"
+ "circle-info"
+ )
+ class=(concat "db-site-advice__icon --" problem.priority)
+ }}
+
+ <div class="db-site-advice__message">
+ {{trustHTML problem.message}}
+ </div>
+
+ {{#if this.currentUser.admin}}
+ <DButton
+ class="btn-default btn-small"
+ data-test-site-advice-ignore="true"
+ @action={{fn this.ignore problem}}
+ @isLoading={{eq this.ignoringId problem.id}}
+ @label="admin.dashboard.dismiss_notice"
+ />
+ {{/if}}
+ </li>
+ {{/each}}
+ </ul>
+ </section>
+ {{/if}}
+ </template>
+}
diff --git a/frontend/discourse/admin/components/redesigned-admin-dashboard.gjs b/frontend/discourse/admin/components/redesigned-admin-dashboard.gjs
index 91f989708e7..78405b3815b 100644
--- a/frontend/discourse/admin/components/redesigned-admin-dashboard.gjs
+++ b/frontend/discourse/admin/components/redesigned-admin-dashboard.gjs
@@ -7,6 +7,7 @@ import DashboardEngagement from "discourse/admin/components/dashboard/engagement
import DashboardHighlights from "discourse/admin/components/dashboard/highlights";
import DashboardReports from "discourse/admin/components/dashboard/reports";
import DashboardSearch from "discourse/admin/components/dashboard/search";
+import DashboardSiteAdvice from "discourse/admin/components/dashboard/site-advice";
import DashboardSkeleton from "discourse/admin/components/dashboard/skeleton";
import DashboardTraffic from "discourse/admin/components/dashboard/traffic";
import PluginOutlet from "discourse/components/plugin-outlet";
@@ -61,6 +62,12 @@ export default class RedesignedAdminDashboard extends Component {
<div class="db-main">
{{#if @loadedSections}}
+ <DashboardSiteAdvice
+ @problems={{@problems}}
+ @onRefresh={{@onRefreshProblems}}
+ @onIgnore={{@onIgnoreProblem}}
+ />
+
{{#each @loadedSections.sections key="id" as |section|}}
{{#if (eq section.id "highlights")}}
<DashboardHighlights
diff --git a/frontend/discourse/admin/controllers/admin/dashboard.js b/frontend/discourse/admin/controllers/admin/dashboard.js
index 8cb9c0b7e39..229039ba159 100644
--- a/frontend/discourse/admin/controllers/admin/dashboard.js
+++ b/frontend/discourse/admin/controllers/admin/dashboard.js
@@ -182,6 +182,7 @@ export default class AdminDashboardController extends Controller {
sections: model.sections,
configuration: model.configuration,
};
+ this.problems = model.problems;
} catch {
if (id !== this._sectionsLoadId) {
return;
@@ -305,4 +306,26 @@ export default class AdminDashboardController extends Controller {
refreshProblems() {
this._loadProblems();
}
+
+ @action
+ async refreshSiteAdvice() {
+ try {
+ const model = await AdminDashboard.fetchProblems();
+ this.problems = model.problems;
+ } catch (error) {
+ popupAjaxError(error);
+ }
+ }
+
+ @action
+ async ignoreProblem(problem) {
+ try {
+ await ajax(`/admin/admin_notices/${problem.id}`, { type: "DELETE" });
+ this.problems = this.problems.filter(
+ (candidate) => candidate.id !== problem.id
+ );
+ } catch (error) {
+ popupAjaxError(error);
+ }
+ }
}
diff --git a/frontend/discourse/admin/models/admin-dashboard.js b/frontend/discourse/admin/models/admin-dashboard.js
index 4dd5155b0b0..97d4d92ef22 100644
--- a/frontend/discourse/admin/models/admin-dashboard.js
+++ b/frontend/discourse/admin/models/admin-dashboard.js
@@ -27,6 +27,7 @@ export default class AdminDashboard extends EmberObject {
version_check: json.version_check,
sections: json.sections,
configuration: json.configuration,
+ problems: json.problems,
});
return model;
diff --git a/frontend/discourse/admin/templates/admin/dashboard.gjs b/frontend/discourse/admin/templates/admin/dashboard.gjs
index 229b35e27c5..6bd89906aab 100644
--- a/frontend/discourse/admin/templates/admin/dashboard.gjs
+++ b/frontend/discourse/admin/templates/admin/dashboard.gjs
@@ -21,6 +21,9 @@ export default <template>
@refreshSections={{@controller.fetchSections}}
@loadingSections={{@controller.loadingSections}}
@sectionsFetchError={{@controller.sectionsFetchError}}
+ @problems={{@controller.problems}}
+ @onRefreshProblems={{@controller.refreshSiteAdvice}}
+ @onIgnoreProblem={{@controller.ignoreProblem}}
/>
{{else}}
<PluginOutlet @name="admin-dashboard-top" @connectorTagName="div" />
diff --git a/spec/jobs/run_problem_checks_spec.rb b/spec/jobs/run_problem_checks_spec.rb
index 9d5d11d17db..a3cd0634236 100644
--- a/spec/jobs/run_problem_checks_spec.rb
+++ b/spec/jobs/run_problem_checks_spec.rb
@@ -43,6 +43,12 @@ RSpec.describe Jobs::RunProblemChecks do
ProblemCheck.send(:remove_const, "MultiTargetCheck")
end
+ it "runs the realtime checks in the background" do
+ expect { described_class.new.execute([]) }.to change {
+ ProblemCheckTracker.where(identifier: "non_scheduled_check").count
+ }.by(1)
+ end
+
context "when a tracker hasn't been created yet" do
it "still schedules checks" do
expect_enqueued_with(
diff --git a/spec/requests/admin/dashboard_controller_spec.rb b/spec/requests/admin/dashboard_controller_spec.rb
index 22696c24148..b315fd259c4 100644
--- a/spec/requests/admin/dashboard_controller_spec.rb
+++ b/spec/requests/admin/dashboard_controller_spec.rb
@@ -479,6 +479,69 @@ RSpec.describe Admin::DashboardController do
end
end
+ describe "problems payload" do
+ before do
+ SiteSetting.dashboard_improvements = true
+ Discourse.cache.clear
+ end
+
+ fab!(:starttls_problem) do
+ Fabricate(:admin_notice, identifier: "starttls_disabled", priority: "high")
+ end
+
+ fab!(:host_names_problem) do
+ Fabricate(:admin_notice, identifier: "host_names", priority: "low")
+ end
+
+ it "returns every active problem check in a top-level problems key for an admin" do
+ sign_in(admin)
+
+ get "/admin/dashboard.json"
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body["problems"]).to match_array(
+ [
+ {
+ "id" => starttls_problem.id,
+ "priority" => "high",
+ "message" => starttls_problem.message,
+ "identifier" => "starttls_disabled",
+ },
+ {
+ "id" => host_names_problem.id,
+ "priority" => "low",
+ "message" => host_names_problem.message,
+ "identifier" => "host_names",
+ },
+ ],
+ )
+ end
+
+ it "returns every active problem check in a top-level problems key for a moderator" do
+ sign_in(moderator)
+
+ get "/admin/dashboard.json"
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body["problems"]).to match_array(
+ [
+ {
+ "id" => starttls_problem.id,
+ "priority" => "high",
+ "message" => starttls_problem.message,
+ "identifier" => "starttls_disabled",
+ },
+ {
+ "id" => host_names_problem.id,
+ "priority" => "low",
+ "message" => host_names_problem.message,
+ "identifier" => "host_names",
+ },
+ ],
+ )
+ end
+ end
+
describe "configuration payload" do
before do
SiteSetting.dashboard_improvements = true
diff --git a/spec/system/admin_dashboard_redesign/site_advice_section_spec.rb b/spec/system/admin_dashboard_redesign/site_advice_section_spec.rb
new file mode 100644
index 00000000000..b5a2954d9b1
--- /dev/null
+++ b/spec/system/admin_dashboard_redesign/site_advice_section_spec.rb
@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+describe "Admin Dashboard Redesign | Site Advice section" do
+ let(:dashboard) { PageObjects::Pages::AdminDashboard.new }
+
+ before { SiteSetting.dashboard_improvements = true }
+
+ context "when signed in as an admin" do
+ fab!(:current_user, :admin)
+
+ before { sign_in(current_user) }
+
+ it "shows every active problem with its count, severity order, and actions" do
+ dashboard.visit
+
+ expect(dashboard).to have_no_site_advice
+
+ Fabricate(:admin_notice, identifier: "host_names", priority: "low")
+ Fabricate(:admin_notice, identifier: "starttls_disabled", priority: "high")
+
+ dashboard.visit
+
+ expect(dashboard).to have_site_advice_at_top
+ expect(dashboard).to have_site_advice_title(
+ "2 issues require your attention based on your site configuration",
+ )
+ expect(dashboard).to have_first_site_advice_problem("STARTTLS disabled")
+ expect(dashboard).to have_site_advice_problem("default localhost hostname")
+ expect(dashboard).to have_ignore_button_for("STARTTLS disabled")
+ expect(dashboard).to have_ignore_button_for("default localhost hostname")
+ expect(dashboard).to have_site_advice_refresh_button
+ end
+
+ it "lets an admin ignore a problem and refresh the list in place" do
+ ProblemCheck.stubs(:realtime).returns(stub(run_all: nil))
+
+ Fabricate(:admin_notice, identifier: "host_names", priority: "low")
+ resolved = Fabricate(:admin_notice, identifier: "starttls_disabled", priority: "high")
+
+ dashboard.visit
+ dashboard.ignore_site_advice_problem("default localhost hostname")
+
+ expect(dashboard).to have_no_site_advice_problem("default localhost hostname")
+
+ resolved.destroy!
+ Fabricate(:admin_notice, identifier: "subfolder_ends_in_slash", priority: "low")
+
+ dashboard.refresh_site_advice
+
+ expect(dashboard).to have_no_site_advice_problem("default localhost hostname")
+ expect(dashboard).to have_no_site_advice_problem("STARTTLS disabled")
+ expect(dashboard).to have_site_advice_problem("subfolder setup is incorrect")
+ end
+ end
+
+ context "when signed in as a moderator" do
+ fab!(:moderator)
+
+ before { sign_in(moderator) }
+
+ it "shows the advice read-only, without any Ignore buttons" do
+ Fabricate(:admin_notice, identifier: "host_names", priority: "low")
+
+ dashboard.visit
+
+ expect(dashboard).to have_site_advice
+ expect(dashboard).to have_site_advice_problem("default localhost hostname")
+ expect(dashboard).to have_no_ignore_buttons
+ expect(dashboard).to have_site_advice_refresh_button
+ end
+ end
+end
diff --git a/spec/system/page_objects/pages/admin_dashboard.rb b/spec/system/page_objects/pages/admin_dashboard.rb
index 52f89d54cf5..339bf4abfd4 100644
--- a/spec/system/page_objects/pages/admin_dashboard.rb
+++ b/spec/system/page_objects/pages/admin_dashboard.rb
@@ -27,6 +27,60 @@ module PageObjects
find(".dashboard-problem", text: message).find(".btn").click
end
+ def has_site_advice?
+ has_css?(".db-site-advice")
+ end
+
+ def has_site_advice_at_top?
+ has_css?(".db-main > .db-site-advice:first-child")
+ end
+
+ def has_no_site_advice?
+ has_no_css?(".db-site-advice")
+ end
+
+ def has_site_advice_title?(text)
+ has_css?(".db-site-advice__header h3", exact_text: text)
+ end
+
+ def has_site_advice_problem?(message)
+ has_css?(".db-site-advice [data-test-site-advice-problem]", text: message)
+ end
+
+ def has_no_site_advice_problem?(message)
+ has_no_css?(".db-site-advice [data-test-site-advice-problem]", text: message)
+ end
+
+ def has_first_site_advice_problem?(message)
+ has_css?(".db-site-advice [data-test-site-advice-problem]:first-child", text: message)
+ end
+
+ def has_ignore_button_for?(message)
+ within(".db-site-advice [data-test-site-advice-problem]", text: message) do
+ has_css?("[data-test-site-advice-ignore]")
+ end
+ end
+
+ def has_no_ignore_buttons?
+ has_no_css?(".db-site-advice [data-test-site-advice-ignore]")
+ end
+
+ def has_site_advice_refresh_button?
+ has_css?(".db-site-advice [data-test-site-advice-refresh]")
+ end
+
+ def ignore_site_advice_problem(message)
+ within(".db-site-advice [data-test-site-advice-problem]", text: message) do
+ find("[data-test-site-advice-ignore]").click
+ end
+ self
+ end
+
+ def refresh_site_advice
+ find(".db-site-advice [data-test-site-advice-refresh]").click
+ self
+ end
+
def has_redesigned_toolbar?
has_css?(".db-toolbar")
end