A platform for community discussion. Free, open, simple.
FEATURE: Add admin report group filter URLs (#41383)
Alan Guo Xiang Tan77ec3d235d73
diff --git a/config/locales/client.en.yml b/config/locales/client.en.ymlindex 0601ee1d093..dc9f643faa5 100644--- a/config/locales/client.en.yml+++ b/config/locales/client.en.yml@@ -6481,6 +6481,7 @@ en:sidebar_title: "Reports"back: "Back to all reports"back_to_dashboard: "Back to dashboard"+ all_groups: "All groups"group_engagement: "Engagement"group_traffic: "Traffic"group_members: "Members"diff --git a/frontend/discourse/admin/components/admin-filter-controls.gjs b/frontend/discourse/admin/components/admin-filter-controls.gjsindex b7bc1d29c6a..ac9a7205195 100644--- a/frontend/discourse/admin/components/admin-filter-controls.gjs+++ b/frontend/discourse/admin/components/admin-filter-controls.gjs@@ -4,6 +4,7 @@ import { fn, get, hash } from "@ember/helper";import { action } from "@ember/object";import { trackedObject } from "@ember/reactive/collections";import didInsert from "@ember/render-modifiers/modifiers/did-insert";+import didUpdate from "@ember/render-modifiers/modifiers/did-update";import { schedule } from "@ember/runloop";import { isTesting } from "discourse/lib/environment";import { resettableTracked } from "discourse/lib/tracked-tools";@@ -28,12 +29,14 @@ import dConcatClass from "discourse/ui-kit/helpers/d-concat-class";* @param {String} [inputPlaceholder] - Placeholder text for search input* @param {String|Object} [defaultDropdownValue="all"] - Default dropdown value(s). For single dropdown: "all",* for multiple: { dropdown1: "all", dropdown2: "all" }+ * @param {String|Object} [dropdownValue] - Current dropdown value(s), defaults to defaultDropdownValue* @param {String} [noResultsMessage] - Message shown when no results found* @param {Boolean} [loading] - Whether data is loading (hides reset button during loading)* @param {Number} [minItemsForFilter] - Minimum items before showing filters (default: always show)* @param {Function} [onTextFilterChange] - Callback for text changes (enables server-side mode)* @param {Function} [onDropdownFilterChange] - Callback for dropdown changes (enables server-side mode).* For multiple dropdowns: receives (key, value)+ * @param {Function} [onDropdownChange] - Callback for dropdown selection changes* @param {Function} [onResetFilters] - Callback for reset action (server-side mode)* @param {String} [initialTextFilter] - Initial value to seed the text filter input on mount*/@@ -52,7 +55,7 @@ export default class AdminFilterControls extends Component {if (this.hasMultipleDropdowns) {Object.keys(this.dropdownOptions).forEach((key) => {- this.dropdownFilters[key] = this.defaultValue(key);+ this.dropdownFilters[key] = this.dropdownValueFor(key);});}}@@ -95,6 +98,10 @@ export default class AdminFilterControls extends Component {return this.args.defaultDropdownValue || "all";}+ get dropdownValue() {+ return this.args.dropdownValue || this.defaultDropdownValue;+ }+get showFilters() {return this.args.minItemsForFilter? this.array.length >= this.args.minItemsForFilter@@ -183,14 +190,20 @@ export default class AdminFilterControls extends Component {return defaults[key] || "all";}+ dropdownValueFor(key) {+ const values =+ typeof this.dropdownValue === "object" ? this.dropdownValue : {};+ return values[key] || this.defaultValue(key);+ }+@actionsetupComponent() {if (this.hasMultipleDropdowns) {Object.keys(this.dropdownOptions).forEach((key) => {- this.dropdownFilters[key] = this.defaultValue(key);+ this.dropdownFilters[key] = this.dropdownValueFor(key);});} else {- this.dropdownFilter = this.defaultDropdownValue;+ this.dropdownFilter = this.dropdownValue;}}@@ -206,9 +219,11 @@ export default class AdminFilterControls extends Component {if (this.hasMultipleDropdowns) {this.dropdownFilters[keyOrValue] = value;this.args.onDropdownFilterChange?.(keyOrValue, value);+ this.args.onDropdownChange?.(keyOrValue, value);} else {this.dropdownFilter = keyOrValue;this.args.onDropdownFilterChange?.(keyOrValue);+ this.args.onDropdownChange?.(keyOrValue);}}@@ -218,10 +233,13 @@ export default class AdminFilterControls extends Component {if (this.hasMultipleDropdowns) {Object.keys(this.dropdownFilters).forEach((key) => {- this.dropdownFilters[key] = this.defaultValue(key);+ const defaultValue = this.defaultValue(key);+ this.dropdownFilters[key] = defaultValue;+ this.args.onDropdownChange?.(key, defaultValue);});} else {this.dropdownFilter = this.defaultDropdownValue;+ this.args.onDropdownChange?.(this.defaultDropdownValue);}if (this.args.onResetFilters) {@@ -248,6 +266,8 @@ export default class AdminFilterControls extends Component {(if this.hasMultipleDropdowns "--multiple-dropdowns")}}{{didInsert this.setupComponent}}+ {{didUpdate this.setupComponent @defaultDropdownValue}}+ {{didUpdate this.setupComponent @dropdownValue}}><div class="admin-filter-controls__inputs"><DFilterInput@@ -258,15 +278,6 @@ export default class AdminFilterControls extends Component {@icons={{hash left="magnifying-glass"}}/>- {{#if (and this.hasActiveFilters (not @loading))}}- <DButton- @icon="arrow-rotate-left"- @label="reset_filter"- @action={{this.resetFilters}}- class="btn-default admin-filter-controls__reset"- />- {{/if}}-{{#if this.hasMultipleDropdowns}}<DButtonclass="btn-transparent admin-filter-controls__toggle-filters"@@ -314,6 +325,15 @@ export default class AdminFilterControls extends Component {</div>{{/if}}+ {{#if (and this.hasActiveFilters (not @loading))}}+ <DButton+ @icon="arrow-rotate-left"+ @label="reset_filter"+ @action={{this.resetFilters}}+ class="btn-default admin-filter-controls__reset"+ />+ {{/if}}+{{yield to="actions"}}</div>{{/if}}diff --git a/frontend/discourse/admin/components/admin-reports.gjs b/frontend/discourse/admin/components/admin-reports.gjsindex b4183cd29d4..a2a19a99c4b 100644--- a/frontend/discourse/admin/components/admin-reports.gjs+++ b/frontend/discourse/admin/components/admin-reports.gjs@@ -87,6 +87,10 @@ export default class AdminReports extends Component {return reports.filter((report) => !hiddenReports.includes(report.type));}+ get requestedGroupKey() {+ return this.args.group || "all";+ }+@bindgroupReports(reports) {if (!reports) {@@ -152,14 +156,49 @@ export default class AdminReports extends Component {return groupedReports;}+ @bind+ groupDropdownOptions(reports) {+ const groups = this.groupReports(this.filterReports(reports));++ return [+ {+ value: "all",+ label: i18n("admin.reports.all_groups"),+ filterFn: () => true,+ },+ ...groups.map((group) => ({+ value: group.key,+ label: group.name,+ filterFn: (report) => group.reports.includes(report),+ })),+ ];+ }++ @bind+ selectedGroupKey(reports) {+ const options = this.groupDropdownOptions(reports);++ return options.some((option) => option.value === this.requestedGroupKey)+ ? this.requestedGroupKey+ : "all";+ }++ @bind+ updateGroupFilter(groupKey) {+ this.args.onGroupChange?.(groupKey);+ }+<template><DAsyncContent @asyncData={{this.loadReports}}><:content as |reports|><AdminFilterControls@array={{this.filterReports reports}}@searchableProps={{array "title" "description"}}+ @dropdownOptions={{this.groupDropdownOptions reports}}+ @dropdownValue={{this.selectedGroupKey reports}}@inputPlaceholder={{i18n "admin.filter_reports"}}@noResultsMessage={{i18n "admin.filter_reports_no_results"}}+ @onDropdownChange={{this.updateGroupFilter}}><:content as |filteredReports|>{{#each (this.groupReports filteredReports) as |group|}}diff --git a/frontend/discourse/admin/controllers/admin-reports/index.js b/frontend/discourse/admin/controllers/admin-reports/index.jsnew file mode 100644index 00000000000..fbfcb0b80c3--- /dev/null+++ b/frontend/discourse/admin/controllers/admin-reports/index.js@@ -0,0 +1,12 @@+import Controller from "@ember/controller";+import { action } from "@ember/object";++export default class AdminReportsIndexController extends Controller {+ queryParams = ["group"];+ group = null;++ @action+ updateGroupFilter(groupKey) {+ this.set("group", groupKey === "all" ? null : groupKey);+ }+}diff --git a/frontend/discourse/admin/templates/admin-reports/index.gjs b/frontend/discourse/admin/templates/admin-reports/index.gjsindex c508aad2f55..821c79cac72 100644--- a/frontend/discourse/admin/templates/admin-reports/index.gjs+++ b/frontend/discourse/admin/templates/admin-reports/index.gjs@@ -2,6 +2,9 @@ import AdminReports from "discourse/admin/components/admin-reports";export default <template><div class="admin-config-area__full-width">- <AdminReports />+ <AdminReports+ @group={{@controller.group}}+ @onGroupChange={{@controller.updateGroupFilter}}+ /></div></template>diff --git a/frontend/discourse/tests/integration/components/admin-filter-controls-test.gjs b/frontend/discourse/tests/integration/components/admin-filter-controls-test.gjsindex 77e1c26f98a..06e7d04b4bd 100644--- a/frontend/discourse/tests/integration/components/admin-filter-controls-test.gjs+++ b/frontend/discourse/tests/integration/components/admin-filter-controls-test.gjs@@ -295,8 +295,8 @@ module("Integration | Component | AdminFilterControls", function (hooks) {await fillIn(".filter-input", "first");assert- .dom(".admin-filter-controls__inputs .admin-filter-controls__reset")- .exists("shows reset button");+ .dom(".admin-filter-controls > .admin-filter-controls__reset")+ .exists("shows reset button after filter controls");});test("respects minItemsForFilter parameter", async function (assert) {diff --git a/spec/system/admin_reports_spec.rb b/spec/system/admin_reports_spec.rbindex c9c4e1c6c1b..1bd92a439b4 100644--- a/spec/system/admin_reports_spec.rb+++ b/spec/system/admin_reports_spec.rb@@ -2,6 +2,9 @@describe "Admin Reports" dofab!(:current_user, :admin)++ let(:reports_page) { PageObjects::Pages::AdminReport.new }+before { sign_in(current_user) }context "when use_legacy_pageviews is true" do@@ -45,4 +48,27 @@ describe "Admin Reports" dotext: I18n.t("admin_js.admin.reports.legacy_warning"),)end++ it "lets admins filter report groups from URLs and controls" do+ reports_page.visit_index(group: "engagement")++ expect(reports_page).to have_current_reports_path(group: "engagement")+ expect(reports_page.filter_controls).to have_dropdown_value("Engagement")+ expect(reports_page).to have_group("Engagement")+ expect(reports_page).to have_no_group("Traffic")++ reports_page.filter_controls.select_dropdown_option("Traffic")++ expect(reports_page).to have_current_reports_path(group: "traffic")+ expect(reports_page.filter_controls).to have_dropdown_value("Traffic")+ expect(reports_page).to have_group("Traffic")+ expect(reports_page).to have_no_group("Engagement")++ reports_page.filter_controls.select_all_dropdown_option++ expect(reports_page).to have_current_all_reports_path+ expect(reports_page.filter_controls).to have_dropdown_value("All groups")+ expect(reports_page).to have_group("Engagement")+ expect(reports_page).to have_group("Traffic")+ endenddiff --git a/spec/system/page_objects/components/admin_filter_controls.rb b/spec/system/page_objects/components/admin_filter_controls.rbindex 73f15737e9b..0bf4e9bdb6e 100644--- a/spec/system/page_objects/components/admin_filter_controls.rb+++ b/spec/system/page_objects/components/admin_filter_controls.rb@@ -41,11 +41,11 @@ module PageObjectsenddef has_reset_button?- page.has_css?(".admin-filter-controls__inputs .admin-filter-controls__reset")+ component.has_css?("> .admin-filter-controls__reset")enddef click_reset_button- page.find(".admin-filter-controls__inputs .admin-filter-controls__reset").click+ component.find("> .admin-filter-controls__reset").clickenddef click_no_results_reset_button@@ -57,7 +57,7 @@ module PageObjectsenddef has_no_reset_button?- component.has_no_css?(".admin-filter-controls__inputs .admin-filter-controls__reset")+ component.has_no_css?("> .admin-filter-controls__reset")enddef has_no_results_message?@@ -68,6 +68,12 @@ module PageObjectscomponent.find(".admin-filter-controls__input").valueend+ def has_dropdown_value?(text, dropdown_id: nil)+ selector = ".admin-filter-controls__dropdown"+ selector += "#{selector}--#{dropdown_id}" if dropdown_id+ component.has_css?("#{selector} option:checked", text: text)+ end+def dropdown_valuecomponent.find(".admin-filter-controls__dropdown option:checked").textenddiff --git a/spec/system/page_objects/pages/admin_report.rb b/spec/system/page_objects/pages/admin_report.rbindex d8b9b3a2525..fbd3ebb86a7 100644--- a/spec/system/page_objects/pages/admin_report.rb+++ b/spec/system/page_objects/pages/admin_report.rb@@ -3,6 +3,11 @@module PageObjectsmodule Pagesclass AdminReport < PageObjects::Pages::Base+ def visit_index(group: nil)+ page.visit("/admin/reports#{group ? "?group=#{group}" : ""}")+ self+ end+def visit_default_dashboard_reportpage.visit("/admin/reports/#{SeedData::AdminDashboardReports::DEFAULT_BUILTIN_REPORTS.first}",@@ -31,9 +36,33 @@ module PageObjectsselfend+ def filter_controls+ PageObjects::Components::AdminFilterControls.new(".admin-filter-controls")+ end++ def has_group?(name)+ page.has_css?(".admin-reports-group__title", text: name)+ end++ def has_no_group?(name)+ page.has_no_css?(".admin-reports-group__title", text: name)+ end++ def has_report?(title)+ page.has_css?(".admin-section-landing-item__title", text: title)+ end++ def has_no_report?(title)+ page.has_no_css?(".admin-section-landing-item__title", text: title)+ end+def has_current_all_reports_path?page.has_current_path?("/admin/reports")end++ def has_current_reports_path?(group: nil)+ page.has_current_path?("/admin/reports#{group ? "?group=#{group}" : ""}")+ endendendend