Skip to content

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

UX: Auto-adjust date range when changing report grouping (#38483)

Osama Sayeghf7dfa26ac54c
diff --git a/frontend/discourse/admin/components/admin-report.gjs b/frontend/discourse/admin/components/admin-report.gjs
index a78a1cfdadd..7e197d0cfe6 100644
--- a/frontend/discourse/admin/components/admin-report.gjs
+++ b/frontend/discourse/admin/components/admin-report.gjs
@@ -52,6 +52,7 @@ export default class AdminReport extends Component {
@tracked options = null;
@tracked dateRangeFrom = null;
@tracked dateRangeTo = null;
+ @tracked userHasCustomDates = false;
showHeader = this.args.showHeader ?? true;
showFilteringUI = this.args.showFilteringUI ?? false;
@@ -184,7 +185,33 @@ export default class AdminReport extends Component {
@action
changeGrouping(grouping) {
- this.refreshReport({ chartGrouping: grouping });
+ const options = { chartGrouping: grouping };
+
+ if (this.siteSettings.reporting_improvements && !this.userHasCustomDates) {
+ const endDate = moment().endOf("day");
+ let startDate;
+
+ switch (grouping) {
+ case "daily":
+ startDate = moment().subtract(1, "month").startOf("day");
+ break;
+ case "weekly":
+ startDate = moment().subtract(3, "months").startOf("day");
+ break;
+ case "monthly":
+ startDate = moment().subtract(12, "months").startOf("day");
+ break;
+ }
+
+ if (startDate) {
+ this.dateRangeFrom = startDate;
+ this.dateRangeTo = endDate;
+ options.startDate = startDate;
+ options.endDate = endDate;
+ }
+ }
+
+ this.refreshReport(options);
}
get displayedModes() {
@@ -286,15 +313,19 @@ export default class AdminReport extends Component {
return options.map((id) => {
return {
id,
- disabled: id === "daily" && dataLength >= DAILY_LIMIT_DAYS,
+ disabled:
+ id === "daily" &&
+ dataLength >= DAILY_LIMIT_DAYS &&
+ this.userHasCustomDates,
label: `admin.dashboard.reports.${id}`,
- class: `chart-grouping ${chartGrouping === id ? "active" : "inactive"}`,
+ class: `chart-grouping ${id} ${chartGrouping === id ? "active" : "inactive"}`,
};
});
}
@action
onChangeDateRange(range) {
+ this.userHasCustomDates = true;
this.dateRangeFrom = range.from;
this.dateRangeTo = range.to;
}
diff --git a/frontend/discourse/tests/integration/components/admin-report-test.gjs b/frontend/discourse/tests/integration/components/admin-report-test.gjs
index b8a8ca641b5..ce9b57bbddd 100644
--- a/frontend/discourse/tests/integration/components/admin-report-test.gjs
+++ b/frontend/discourse/tests/integration/components/admin-report-test.gjs
@@ -1,4 +1,4 @@
-import { click, render } from "@ember/test-helpers";
+import { click, fillIn, render } from "@ember/test-helpers";
import { module, test } from "qunit";
import AdminReport from "discourse/admin/components/admin-report";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
@@ -153,4 +153,133 @@ module("Integration | Component | admin-report", function (hooks) {
assert.dom(".alert-error.not-found").exists("displays a not found error");
});
+
+ module("grouping date range updates", function (nestedHooks) {
+ nestedHooks.beforeEach(function () {
+ this.siteSettings.reporting_improvements = true;
+ });
+
+ test("changing grouping to weekly updates date range to 3 months", async function (assert) {
+ const refreshArgs = [];
+ const refreshCallback = (options) => {
+ refreshArgs.push(options);
+ };
+ await render(
+ <template>
+ <AdminReport
+ @dataSourceName="signups"
+ @showFilteringUI={{true}}
+ @onRefresh={{refreshCallback}}
+ />
+ </template>
+ );
+
+ await click(".mode-btn.chart");
+
+ refreshArgs.length = 0;
+ await click(".chart-grouping.weekly");
+
+ assert.strictEqual(refreshArgs.length, 1, "refresh is called once");
+ assert.strictEqual(refreshArgs[0].chartGrouping, "weekly");
+
+ const expectedStart = moment().subtract(3, "months").startOf("day");
+ assert.strictEqual(
+ refreshArgs[0].startDate.format("YYYY-MM-DD"),
+ expectedStart.format("YYYY-MM-DD")
+ );
+ });
+
+ test("changing grouping to monthly updates date range to 12 months", async function (assert) {
+ const refreshArgs = [];
+ const refreshCallback = (options) => {
+ refreshArgs.push(options);
+ };
+ await render(
+ <template>
+ <AdminReport
+ @dataSourceName="signups"
+ @showFilteringUI={{true}}
+ @onRefresh={{refreshCallback}}
+ />
+ </template>
+ );
+
+ await click(".mode-btn.chart");
+
+ refreshArgs.length = 0;
+ await click(".chart-grouping.monthly");
+
+ assert.strictEqual(refreshArgs.length, 1, "refresh is called once");
+ assert.strictEqual(refreshArgs[0].chartGrouping, "monthly");
+
+ const expectedStart = moment().subtract(12, "months").startOf("day");
+ assert.strictEqual(
+ refreshArgs[0].startDate.format("YYYY-MM-DD"),
+ expectedStart.format("YYYY-MM-DD")
+ );
+ });
+
+ test("changing grouping to daily updates date range to 1 month", async function (assert) {
+ const refreshArgs = [];
+ const refreshCallback = (options) => {
+ refreshArgs.push(options);
+ };
+ await render(
+ <template>
+ <AdminReport
+ @dataSourceName="signups"
+ @showFilteringUI={{true}}
+ @onRefresh={{refreshCallback}}
+ />
+ </template>
+ );
+
+ await click(".mode-btn.chart");
+ await click(".chart-grouping.monthly");
+
+ refreshArgs.length = 0;
+ await click(".chart-grouping.daily");
+
+ assert.strictEqual(refreshArgs.length, 1, "refresh is called once");
+ assert.strictEqual(refreshArgs[0].chartGrouping, "daily");
+
+ const expectedStart = moment().subtract(1, "month").startOf("day");
+ assert.strictEqual(
+ refreshArgs[0].startDate.format("YYYY-MM-DD"),
+ expectedStart.format("YYYY-MM-DD")
+ );
+ });
+
+ test("after manually changing dates, changing grouping does not override the date range", async function (assert) {
+ const refreshArgs = [];
+ const refreshCallback = (options) => {
+ refreshArgs.push(options);
+ };
+ await render(
+ <template>
+ <AdminReport
+ @dataSourceName="signups"
+ @showFilteringUI={{true}}
+ @onRefresh={{refreshCallback}}
+ />
+ </template>
+ );
+
+ await click(".mode-btn.chart");
+
+ await fillIn(".from.d-date-time-input .date-picker", "2025-01-01");
+
+ refreshArgs.length = 0;
+ await click(".chart-grouping.monthly");
+
+ assert.strictEqual(refreshArgs.length, 1, "refresh is called once");
+ assert.strictEqual(refreshArgs[0].chartGrouping, "monthly");
+
+ assert.strictEqual(
+ refreshArgs[0].startDate.format("YYYY-MM-DD"),
+ "2025-01-01",
+ "does not override the custom start date"
+ );
+ });
+ });
});