Skip to content

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

UX: Show Site Traffic skeleton only on initial load (#42718)

Alan Guo Xiang Tan9f6ce2cac70e
diff --git a/frontend/discourse/admin/components/site-traffic-explorer-breakdown-card.gjs b/frontend/discourse/admin/components/site-traffic-explorer-breakdown-card.gjs
index 41ccf765311..d4da2ea4902 100644
--- a/frontend/discourse/admin/components/site-traffic-explorer-breakdown-card.gjs
+++ b/frontend/discourse/admin/components/site-traffic-explorer-breakdown-card.gjs
@@ -8,6 +8,7 @@ import { service } from "@ember/service";
import SiteTrafficExplorerBreakdownModal from "discourse/admin/components/site-traffic-explorer-breakdown-modal";
import SiteTrafficExplorerDimensionLabel from "discourse/admin/components/site-traffic-explorer-dimension-label";
import SiteTrafficExplorerPageviewCount from "discourse/admin/components/site-traffic-explorer-pageview-count";
+import { countryName } from "discourse/admin/lib/format-country";
import getURL from "discourse/lib/get-url";
import { eq } from "discourse/truth-helpers";
import DButton from "discourse/ui-kit/d-button";
@@ -38,8 +39,13 @@ export default class SiteTrafficExplorerBreakdownCard extends Component {
@action
filterLabel(row) {
+ const label =
+ this.activeTab.dimension === "countries"
+ ? countryName(row.value)
+ : row.label;
+
return i18n("admin.site_traffic_explorer.filter_by", {
- label: row.label,
+ label,
count: row.pageviews,
});
}
diff --git a/frontend/discourse/admin/components/site-traffic-explorer-breakdown-modal.gjs b/frontend/discourse/admin/components/site-traffic-explorer-breakdown-modal.gjs
index 6934fd1a3b2..b30c1439d70 100644
--- a/frontend/discourse/admin/components/site-traffic-explorer-breakdown-modal.gjs
+++ b/frontend/discourse/admin/components/site-traffic-explorer-breakdown-modal.gjs
@@ -2,6 +2,7 @@ import Component from "@glimmer/component";
import { action } from "@ember/object";
import SiteTrafficExplorerDimensionLabel from "discourse/admin/components/site-traffic-explorer-dimension-label";
import SiteTrafficExplorerPageviewCount from "discourse/admin/components/site-traffic-explorer-pageview-count";
+import { countryName } from "discourse/admin/lib/format-country";
import DButton from "discourse/ui-kit/d-button";
import DModal from "discourse/ui-kit/d-modal";
import { i18n } from "discourse-i18n";
@@ -13,8 +14,13 @@ export default class SiteTrafficExplorerBreakdownModal extends Component {
@action
filterLabel(row) {
+ const label =
+ this.args.model.dimension === "countries"
+ ? countryName(row.value)
+ : row.label;
+
return i18n("admin.site_traffic_explorer.filter_by", {
- label: row.label,
+ label,
count: row.pageviews,
});
}
diff --git a/frontend/discourse/admin/components/site-traffic-explorer-dimension-label.gjs b/frontend/discourse/admin/components/site-traffic-explorer-dimension-label.gjs
index 430aaf80f28..eed7887f377 100644
--- a/frontend/discourse/admin/components/site-traffic-explorer-dimension-label.gjs
+++ b/frontend/discourse/admin/components/site-traffic-explorer-dimension-label.gjs
@@ -1,6 +1,6 @@
import Component from "@glimmer/component";
import { action } from "@ember/object";
-import { countryFlag } from "discourse/admin/lib/format-country";
+import { countryFlag, countryName } from "discourse/admin/lib/format-country";
import { eq } from "discourse/truth-helpers";
import dIcon from "discourse/ui-kit/helpers/d-icon";
@@ -17,6 +17,12 @@ const BROWSER_ICONS = {
};
export default class SiteTrafficExplorerDimensionLabel extends Component {
+ get label() {
+ return this.args.dimension === "countries"
+ ? countryName(this.args.row.value)
+ : this.args.row.label;
+ }
+
@action
countryFlag(value) {
return countryFlag(value);
@@ -40,8 +46,8 @@ export default class SiteTrafficExplorerDimensionLabel extends Component {
class="site-traffic-explorer__dimension-prefix"
}}
{{/if}}
- <span class="site-traffic-explorer__dimension-text" title={{@row.label}}>
- {{@row.label}}
+ <span class="site-traffic-explorer__dimension-text" title={{this.label}}>
+ {{this.label}}
</span>
</span>
</template>
diff --git a/frontend/discourse/admin/components/site-traffic-explorer-filter-pills.gjs b/frontend/discourse/admin/components/site-traffic-explorer-filter-pills.gjs
index f2f045f3c8d..982b91a93f8 100644
--- a/frontend/discourse/admin/components/site-traffic-explorer-filter-pills.gjs
+++ b/frontend/discourse/admin/components/site-traffic-explorer-filter-pills.gjs
@@ -2,6 +2,7 @@ import Component from "@glimmer/component";
import { fn } from "@ember/helper";
import { action } from "@ember/object";
import { trustHTML } from "@ember/template";
+import { countryName } from "discourse/admin/lib/format-country";
import { escapeExpression } from "discourse/lib/utilities";
import DButton from "discourse/ui-kit/d-button";
import { i18n } from "discourse-i18n";
@@ -27,9 +28,12 @@ export default class SiteTrafficExplorerFilterPills extends Component {
@action
filterDescription(filter) {
+ const value =
+ filter.key === "country" ? countryName(filter.value) : filter.label;
+
return i18n("admin.site_traffic_explorer.filter_description", {
filter: escapeExpression(this.filterLabel(filter.key)),
- value: escapeExpression(filter.label),
+ value: escapeExpression(value),
});
}
diff --git a/frontend/discourse/admin/components/site-traffic-explorer.gjs b/frontend/discourse/admin/components/site-traffic-explorer.gjs
index 828d91130c1..bad537c7e3b 100644
--- a/frontend/discourse/admin/components/site-traffic-explorer.gjs
+++ b/frontend/discourse/admin/components/site-traffic-explorer.gjs
@@ -1,4 +1,5 @@
import Component from "@glimmer/component";
+import { cached } from "@glimmer/tracking";
import { action } from "@ember/object";
import didUpdate from "@ember/render-modifiers/modifiers/did-update";
import { service } from "@ember/service";
@@ -12,9 +13,6 @@ import DBreadcrumbsItem from "discourse/ui-kit/d-breadcrumbs-item";
import DPageHeader from "discourse/ui-kit/d-page-header";
import I18n, { i18n } from "discourse-i18n";
-const SKELETON_METRICS = Array.from({ length: 4 });
-const SKELETON_BREAKDOWNS = Array.from({ length: 3 });
-const SKELETON_ROWS = Array.from({ length: 8 });
const TRAFFIC_TYPE_BY_SERIES = {
page_view_logged_in_browser: "logged_in",
page_view_anon_browser: "anonymous",
@@ -83,21 +81,28 @@ export default class SiteTrafficExplorer extends Component {
return this.metrics.slice(1);
}
+ @cached
get chartModel() {
return {
- start_date: moment(this.args.startDate).format("YYYY-MM-DD"),
- end_date: moment(this.args.endDate).format("YYYY-MM-DD"),
+ start_date:
+ this.args.traffic?.chart_start_date ??
+ moment(this.args.startDate).format("YYYY-MM-DD"),
+ end_date:
+ this.args.traffic?.chart_end_date ??
+ moment(this.args.endDate).format("YYYY-MM-DD"),
data: this.series,
};
}
+ @cached
get chartOptions() {
+ const trafficTypes =
+ this.args.traffic?.chart_traffic_types ?? this.args.trafficTypes;
+
return {
hideYAxisGridLines: true,
hiddenLabels: Object.entries(TRAFFIC_TYPE_BY_SERIES)
- .filter(
- ([, trafficType]) => !this.args.trafficTypes.includes(trafficType)
- )
+ .filter(([, trafficType]) => !trafficTypes.includes(trafficType))
.map(([series]) => series),
onLegendClick: this.toggleTrafficType,
};
@@ -203,7 +208,7 @@ export default class SiteTrafficExplorer extends Component {
@action
announceResults() {
- if (this.args.loading || !this.args.traffic) {
+ if (!this.args.traffic) {
return;
}
@@ -235,7 +240,7 @@ export default class SiteTrafficExplorer extends Component {
<template>
<div
class="site-traffic-explorer admin-config-page"
- {{didUpdate this.announceResults @traffic @loading @hasPageviews}}
+ {{didUpdate this.announceResults @traffic @hasPageviews}}
>
<DPageHeader
@titleLabel={{i18n "admin.site_traffic_explorer.title"}}
@@ -281,46 +286,7 @@ export default class SiteTrafficExplorer extends Component {
</div>
</div>
{{else}}
- {{#if @loading}}
- <div
- class="db-skeleton --animation site-traffic-explorer__skeleton"
- role="status"
- aria-label={{i18n "admin.site_traffic_explorer.loading"}}
- data-test-site-traffic-skeleton
- >
- <div class="db-skeleton__section-wrapper">
- <div class="db-skeleton__subheader">
- <div class="db-skeleton__subintro">
- <div class="db-skeleton__heading-line"></div>
- </div>
- <div class="db-skeleton__metric-row">
- {{#each SKELETON_METRICS}}
- <div class="db-skeleton__metric">
- <div class="db-skeleton__metric-number"></div>
- <div class="db-skeleton__metric-label"></div>
- </div>
- {{/each}}
- </div>
- </div>
- <div class="db-skeleton__chart"></div>
- <div class="db-skeleton__row">
- {{#each SKELETON_BREAKDOWNS}}
- <div class="db-skeleton__row-block">
- <div class="db-skeleton__row-block-title"></div>
- <ul class="db-skeleton__list">
- {{#each SKELETON_ROWS}}
- <li class="db-skeleton__list-row">
- <span class="db-skeleton__list-name"></span>
- <span class="db-skeleton__list-value"></span>
- </li>
- {{/each}}
- </ul>
- </div>
- {{/each}}
- </div>
- </div>
- </div>
- {{else if this.partialWarning}}
+ {{#if this.partialWarning}}
<p
class="alert alert-warning site-traffic-explorer__partial-warning"
data-test-site-traffic-partial-warning
@@ -331,7 +297,7 @@ export default class SiteTrafficExplorer extends Component {
{{/if}}
{{#if @traffic}}
- <div class="site-traffic-explorer__results" hidden={{@loading}}>
+ <div class="site-traffic-explorer__results">
{{#if @hasPageviews}}
<div
class="db-section__wrapper --column site-traffic-explorer__report"
diff --git a/frontend/discourse/admin/controllers/admin-site-traffic.js b/frontend/discourse/admin/controllers/admin-site-traffic.js
index 03be251084e..7d4aeb9af9a 100644
--- a/frontend/discourse/admin/controllers/admin-site-traffic.js
+++ b/frontend/discourse/admin/controllers/admin-site-traffic.js
@@ -7,8 +7,6 @@ import {
PERIOD_CUSTOM,
VALID_PERIODS,
} from "discourse/admin/lib/dashboard-date-range";
-import { countryName } from "discourse/admin/lib/format-country";
-import { ajax } from "discourse/lib/ajax";
import { i18n } from "discourse-i18n";
const FILTER_KEYS = [
@@ -51,14 +49,9 @@ export default class AdminSiteTrafficController extends Controller {
@tracked network = null;
@tracked browser = null;
@tracked ip = null;
- @tracked traffic = null;
- @tracked loading = false;
- @tracked fetchError = null;
queryParams = ["range", "start_date", "end_date", ...FILTER_KEYS];
- #fetchId = 0;
-
get safePeriod() {
if (!VALID_PERIODS.includes(this.range)) {
return DEFAULT_PERIOD;
@@ -137,6 +130,14 @@ export default class AdminSiteTrafficController extends Controller {
);
}
+ get traffic() {
+ return this.model?.traffic ?? null;
+ }
+
+ get fetchError() {
+ return this.model?.fetchError ?? null;
+ }
+
#customDate(value, edge) {
if (this.safePeriod !== PERIOD_CUSTOM || !value) {
return null;
@@ -146,73 +147,6 @@ export default class AdminSiteTrafficController extends Controller {
return parsed.isValid() ? parsed[edge]("day").toDate() : null;
}
- #requestParams() {
- const params = {
- start_date: moment(this.startDate).format("YYYY-MM-DD"),
- end_date: moment(this.endDate).format("YYYY-MM-DD"),
- };
-
- for (const key of FILTER_KEYS) {
- if (this[key] !== null) {
- params[key] = this[key];
- }
- }
-
- return params;
- }
-
- #localizeCountryLabels(traffic) {
- const countries = traffic.dimensions?.countries ?? [];
- const activeFilters = traffic.active_filters ?? [];
-
- return {
- ...traffic,
- dimensions: {
- ...traffic.dimensions,
- countries: countries.map((row) => ({
- ...row,
- label: countryName(row.value),
- })),
- },
- active_filters: activeFilters.map((filter) =>
- filter.key === "country"
- ? { ...filter, label: countryName(filter.value) }
- : filter
- ),
- };
- }
-
- @action
- async fetchTraffic() {
- const fetchId = ++this.#fetchId;
- this.loading = true;
- this.fetchError = null;
-
- try {
- const traffic = await ajax(
- "/admin/dashboard/site-traffic-explorer.json",
- {
- data: this.#requestParams(),
- }
- );
-
- if (fetchId === this.#fetchId) {
- this.traffic = this.#localizeCountryLabels(traffic);
- }
- } catch (error) {
- if (fetchId === this.#fetchId) {
- this.fetchError =
- error.jqXHR?.responseJSON?.error_type === "traffic_query_timeout"
- ? "timeout"
- : "unexpected";
- }
- } finally {
- if (fetchId === this.#fetchId) {
- this.loading = false;
- }
- }
- }
-
@action
setPeriod(period) {
this.range = period;
@@ -257,16 +191,13 @@ export default class AdminSiteTrafficController extends Controller {
@action
resetState() {
- this.#fetchId++;
+ this.model = null;
this.range = DEFAULT_PERIOD;
this.start_date = null;
this.end_date = null;
for (const key of FILTER_KEYS) {
this[key] = null;
}
- this.traffic = null;
- this.loading = false;
- this.fetchError = null;
}
#setTrafficTypes(trafficTypes) {
diff --git a/frontend/discourse/admin/routes/admin-site-traffic.js b/frontend/discourse/admin/routes/admin-site-traffic.js
index 6bf43993a90..dd3d8cde450 100644
--- a/frontend/discourse/admin/routes/admin-site-traffic.js
+++ b/frontend/discourse/admin/routes/admin-site-traffic.js
@@ -1,7 +1,31 @@
+import { action } from "@ember/object";
+import { service } from "@ember/service";
+import {
+ calculatePresetStartDate,
+ DEFAULT_PERIOD,
+ PERIOD_CUSTOM,
+ VALID_PERIODS,
+} from "discourse/admin/lib/dashboard-date-range";
+import { ajax } from "discourse/lib/ajax";
import DiscourseRoute from "discourse/routes/discourse";
import { i18n } from "discourse-i18n";
+const FILTER_KEYS = [
+ "traffic_type",
+ "top_url",
+ "entry_url",
+ "referrer",
+ "country",
+ "network",
+ "browser",
+ "ip",
+];
+
+const TRAFFIC_TYPES = ["logged_in", "anonymous", "likely_crawler"];
+
export default class AdminSiteTrafficRoute extends DiscourseRoute {
+ @service loadingSlider;
+
queryParams = {
range: { refreshModel: true },
start_date: { refreshModel: true },
@@ -15,18 +39,54 @@ export default class AdminSiteTrafficRoute extends DiscourseRoute {
browser: { refreshModel: true },
ip: { refreshModel: true },
};
+ #refreshTransition = null;
titleToken() {
return i18n("admin.site_traffic_explorer.title");
}
model(params) {
- return params;
+ const requestParams = this.#requestParams(params);
+
+ return ajax("/admin/dashboard/site-traffic-explorer.json", {
+ data: requestParams,
+ })
+ .then((traffic) => ({
+ traffic: {
+ ...traffic,
+ chart_start_date: requestParams.start_date,
+ chart_end_date: requestParams.end_date,
+ chart_traffic_types: this.#selectedTrafficTypes(params.traffic_type),
+ },
+ fetchError: null,
+ }))
+ .catch((error) => ({
+ traffic: null,
+ fetchError:
+ error.jqXHR?.responseJSON?.error_type === "traffic_query_timeout"
+ ? "timeout"
+ : "unexpected",
+ }));
}
- setupController(controller) {
- super.setupController(...arguments);
- controller.fetchTraffic();
+ @action
+ loading(transition) {
+ if (!this.controllerFor("admin-site-traffic").model) {
+ this.intermediateTransitionTo("adminSiteTraffic_loading");
+ return false;
+ }
+
+ this.#refreshTransition = transition;
+ this.loadingSlider.transitionStarted({ showFallbackSpinner: false });
+ transition.finally(() => {
+ if (this.#refreshTransition !== transition) {
+ return;
+ }
+
+ this.#refreshTransition = null;
+ this.loadingSlider.transitionEnded();
+ });
+ return false;
}
resetController(controller, isExiting) {
@@ -34,4 +94,60 @@ export default class AdminSiteTrafficRoute extends DiscourseRoute {
controller.resetState();
}
}
+
+ #safePeriod(params) {
+ if (!VALID_PERIODS.includes(params.range)) {
+ return DEFAULT_PERIOD;
+ }
+ if (
+ params.range === PERIOD_CUSTOM &&
+ (!params.start_date || !params.end_date)
+ ) {
+ return DEFAULT_PERIOD;
+ }
+ return params.range;
+ }
+
+ #customDate(value, edge, period) {
+ if (period !== PERIOD_CUSTOM || !value) {
+ return null;
+ }
+
+ const parsed = moment(value, "YYYY-MM-DD", true);
+ return parsed.isValid() ? parsed[edge]("day").toDate() : null;
+ }
+
+ #requestParams(params) {
+ const period = this.#safePeriod(params);
+ const startDate =
+ this.#customDate(params.start_date, "startOf", period) ??
+ calculatePresetStartDate(period);
+ const endDate =
+ this.#customDate(params.end_date, "endOf", period) ??
+ moment().endOf("day").toDate();
+
+ const requestParams = {
+ start_date: moment(startDate).format("YYYY-MM-DD"),
+ end_date: moment(endDate).format("YYYY-MM-DD"),
+ };
+
+ for (const key of FILTER_KEYS) {
+ if (params[key] !== null && params[key] !== undefined) {
+ requestParams[key] = params[key];
+ }
+ }
+
+ return requestParams;
+ }
+
+ #selectedTrafficTypes(value) {
+ if (!value) {
+ return TRAFFIC_TYPES;
+ }
+
+ const selected = value.split(",");
+ return TRAFFIC_TYPES.filter((trafficType) =>
+ selected.includes(trafficType)
+ );
+ }
}
diff --git a/frontend/discourse/admin/templates/admin-site-traffic-loading.gjs b/frontend/discourse/admin/templates/admin-site-traffic-loading.gjs
new file mode 100644
index 00000000000..962d8de978f
--- /dev/null
+++ b/frontend/discourse/admin/templates/admin-site-traffic-loading.gjs
@@ -0,0 +1,78 @@
+import didInsert from "@ember/render-modifiers/modifiers/did-insert";
+import DBreadcrumbsItem from "discourse/ui-kit/d-breadcrumbs-item";
+import DPageHeader from "discourse/ui-kit/d-page-header";
+import { i18n } from "discourse-i18n";
+
+const SKELETON_METRICS = Array.from({ length: 4 });
+const SKELETON_BREAKDOWNS = Array.from({ length: 3 });
+const SKELETON_ROWS = Array.from({ length: 8 });
+
+function replaceSplash() {
+ document.querySelector("#d-splash")?.remove();
+}
+
+export default <template>
+ <div
+ class="site-traffic-explorer admin-config-page"
+ {{didInsert replaceSplash}}
+ >
+ <DPageHeader
+ @titleLabel={{i18n "admin.site_traffic_explorer.title"}}
+ @hideTabs={{true}}
+ @collapseActionsOnMobile={{false}}
+ >
+ <:breadcrumbs>
+ <DBreadcrumbsItem @path="/admin" @label={{i18n "admin_title"}} />
+ <DBreadcrumbsItem
+ @path="/admin"
+ @label={{i18n "admin.dashboard.title"}}
+ />
+ <DBreadcrumbsItem
+ @path="/admin/dashboard/site-traffic-explorer"
+ @label={{i18n "admin.site_traffic_explorer.title"}}
+ />
+ </:breadcrumbs>
+ </DPageHeader>
+
+ <div class="admin-container site-traffic-explorer__content">
+ <div
+ class="db-skeleton --animation site-traffic-explorer__skeleton"
+ role="status"
+ aria-label={{i18n "admin.site_traffic_explorer.loading"}}
+ data-test-site-traffic-skeleton
+ >
+ <div class="db-skeleton__section-wrapper">
+ <div class="db-skeleton__subheader">
+ <div class="db-skeleton__subintro">
+ <div class="db-skeleton__heading-line"></div>
+ </div>
+ <div class="db-skeleton__metric-row">
+ {{#each SKELETON_METRICS}}
+ <div class="db-skeleton__metric">
+ <div class="db-skeleton__metric-number"></div>
+ <div class="db-skeleton__metric-label"></div>
+ </div>
+ {{/each}}
+ </div>
+ </div>
+ <div class="db-skeleton__chart"></div>
+ <div class="db-skeleton__row">
+ {{#each SKELETON_BREAKDOWNS}}
+ <div class="db-skeleton__row-block">
+ <div class="db-skeleton__row-block-title"></div>
+ <ul class="db-skeleton__list">
+ {{#each SKELETON_ROWS}}
+ <li class="db-skeleton__list-row">
+ <span class="db-skeleton__list-name"></span>
+ <span class="db-skeleton__list-value"></span>
+ </li>
+ {{/each}}
+ </ul>
+ </div>
+ {{/each}}
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+</template>
diff --git a/frontend/discourse/admin/templates/admin-site-traffic.gjs b/frontend/discourse/admin/templates/admin-site-traffic.gjs
index 1c589311cad..ca8fe126e56 100644
--- a/frontend/discourse/admin/templates/admin-site-traffic.gjs
+++ b/frontend/discourse/admin/templates/admin-site-traffic.gjs
@@ -3,7 +3,6 @@ import SiteTrafficExplorer from "discourse/admin/components/site-traffic-explore
export default <template>
<SiteTrafficExplorer
@traffic={{@controller.traffic}}
- @loading={{@controller.loading}}
@fetchError={{@controller.fetchError}}
@hasPageviews={{@controller.hasPageviews}}
@period={{@controller.safePeriod}}
diff --git a/frontend/discourse/app/services/loading-slider.js b/frontend/discourse/app/services/loading-slider.js
index c5d79a1d170..cffbb3bc319 100644
--- a/frontend/discourse/app/services/loading-slider.js
+++ b/frontend/discourse/app/services/loading-slider.js
@@ -83,7 +83,7 @@ export default class LoadingSlider extends Service.extend(Evented) {
return this.rollingAverage.average;
}
- transitionStarted() {
+ transitionStarted({ showFallbackSpinner = true } = {}) {
if (this.loading) {
// Nested transition
return;
@@ -94,11 +94,12 @@ export default class LoadingSlider extends Service.extend(Evented) {
this.trigger("stateChanged", true);
this.scheduleManager.cancelAll();
-
- this.scheduleManager.later(
- this.setStillLoading,
- STILL_LOADING_DURATION * 1000
- );
+ if (showFallbackSpinner) {
+ this.scheduleManager.later(
+ this.setStillLoading,
+ STILL_LOADING_DURATION * 1000
+ );
+ }
}
@bind