A platform for community discussion. Free, open, simple.
FEATURE: Drill-down and pagination for top referrers/countries (#40364)
Alan Guo Xiang Tan548e2ae46a19
diff --git a/app/assets/stylesheets/admin/admin_dashboard.scss b/app/assets/stylesheets/admin/admin_dashboard.scssindex 5a68dcab67c..7f54e9a06f0 100644--- a/app/assets/stylesheets/admin/admin_dashboard.scss+++ b/app/assets/stylesheets/admin/admin_dashboard.scss@@ -357,7 +357,6 @@ h1 {}&__row-block-title {- position: relative;color: var(--primary);margin-bottom: var(--space-2);font-weight: bold;@@ -369,10 +368,22 @@ h1 {margin-inline-start: var(--space-4);}- &:is(a):hover {+ // The drill-down link is either this element (a bare anchor) or a nested+ // anchor when the title is wrapped in a heading for screen-reader semantics.+ &:is(a),+ a {+ position: relative;+ display: inline-block;color: var(--primary);- .db-link-arrow {+ &:hover,+ &:focus,+ &:visited,+ &:active {+ color: var(--primary);+ }++ &:hover .db-link-arrow {opacity: 1;transform: translateX(0);}diff --git a/app/models/concerns/reports/top_countries_by_browser_pageviews.rb b/app/models/concerns/reports/top_countries_by_browser_pageviews.rbindex 75dfc88892e..c6efe492a99 100644--- a/app/models/concerns/reports/top_countries_by_browser_pageviews.rb+++ b/app/models/concerns/reports/top_countries_by_browser_pageviews.rb@@ -4,6 +4,7 @@ module Reports::TopCountriesByBrowserPageviewsextend ActiveSupport::ConcernEXCLUDED_COUNTRY_CODES = %w[ZZ T1 A1 A2 O1 XX EU AP].freeze+ MAX_ROWS = 200class_methods dodef report_top_countries_by_browser_pageviews(report)@@ -54,7 +55,7 @@ module Reports::TopCountriesByBrowserPageviewsstart_date: report.start_date,end_date_exclusive: end_date_exclusive,excluded_codes: EXCLUDED_COUNTRY_CODES,- limit: report.limit || 50,+ limit: MAX_ROWS,).map { |row| { country_code: row.country_code, count: row.count, percent: row.percent } }enddiff --git a/app/models/concerns/reports/top_referrers_by_browser_pageviews.rb b/app/models/concerns/reports/top_referrers_by_browser_pageviews.rbindex 0ffda9b5db5..25ae84b599d 100644--- a/app/models/concerns/reports/top_referrers_by_browser_pageviews.rb+++ b/app/models/concerns/reports/top_referrers_by_browser_pageviews.rb@@ -3,6 +3,8 @@module Reports::TopReferrersByBrowserPageviewsextend ActiveSupport::Concern+ MAX_ROWS = 200+class_methods dodef report_top_referrers_by_browser_pageviews(report)report.modes = [Report::MODES[:table]]@@ -59,7 +61,7 @@ module Reports::TopReferrersByBrowserPageviewshost_exact: host,host_path_prefix: "#{escaped_host}/%",host_query_prefix: "#{escaped_host}?%",- limit: report.limit || 50,+ limit: MAX_ROWS,).map do |row|{ normalized_referrer: row.normalized_referrer, count: row.count, percent: row.percent }diff --git a/app/models/report.rb b/app/models/report.rbindex 10d76ce7c63..5b83fc9617e 100644--- a/app/models/report.rb+++ b/app/models/report.rb@@ -36,7 +36,13 @@ class Reportpage_view_logged_in_reqs]- ADMIN_ONLY_REPORTS = %w[admin_logins top_uploads topic_view_stats]+ ADMIN_ONLY_REPORTS = %w[+ admin_logins+ top_uploads+ topic_view_stats+ top_referrers_by_browser_pageviews+ top_countries_by_browser_pageviews+ ]IP_ADDRESS_REPORTS = %w[suspicious_logins]BROWSER_PAGEVIEW_REPORTS = %w[top_countries_by_browser_pageviews@@ -45,7 +51,9 @@ class Reportdef self.hidden?(type, guardian:)return true if !guardian.is_admin? && ADMIN_ONLY_REPORTS.include?(type)- return true if BROWSER_PAGEVIEW_REPORTS.include?(type)+ if BROWSER_PAGEVIEW_REPORTS.include?(type) && !SiteSetting.persist_browser_pageview_events+ return true+ endhidden_reports =SiteSetting.use_legacy_pageviews ? HIDDEN_PAGEVIEW_REPORTS : HIDDEN_LEGACY_PAGEVIEW_REPORTSdiff --git a/app/services/admin_dashboard_site_traffic.rb b/app/services/admin_dashboard_site_traffic.rbindex 5b2ef59f765..3160878a4b7 100644--- a/app/services/admin_dashboard_site_traffic.rb+++ b/app/services/admin_dashboard_site_traffic.rb@@ -2,6 +2,7 @@class AdminDashboardSiteTrafficDEFAULT_RANGE_DAYS = 30+ TOP_CARD_LIMIT = 5SERIES_LABEL_REQS = {logged_in: "page_view_logged_in_browser",anonymous: "page_view_anon_browser",@@ -9,6 +10,7 @@ class AdminDashboardSiteTrafficcrawlers: "page_view_crawler",}.freezeprivate_constant :DEFAULT_RANGE_DAYS+ private_constant :TOP_CARD_LIMITprivate_constant :SERIES_LABEL_REQSdef self.build(start_date:, end_date:)@@ -56,7 +58,6 @@ class AdminDashboardSiteTrafficlogin_required: SiteSetting.login_required,host: Discourse.current_hostname,},- limit: 5,wrap_exceptions_in_test: true,}@@ -72,14 +73,14 @@ class AdminDashboardSiteTrafficreturn { rows: [], error: report.error.to_s } if report.error.present?- { rows: report.data, error: nil }+ { rows: report.data.first(TOP_CARD_LIMIT), error: nil }enddef cached_to_payload(cached)error = cached[:error]return { rows: [], error: error.to_s } if error.present?- { rows: (cached[:data] || []).map(&:symbolize_keys), error: nil }+ { rows: (cached[:data] || []).map(&:symbolize_keys).first(TOP_CARD_LIMIT), error: nil }enddef series_ids(include_embedded:)diff --git a/frontend/discourse/admin/components/dashboard/traffic.gjs b/frontend/discourse/admin/components/dashboard/traffic.gjsindex 6e79a668044..27f9cd8fa1c 100644--- a/frontend/discourse/admin/components/dashboard/traffic.gjs+++ b/frontend/discourse/admin/components/dashboard/traffic.gjs@@ -294,7 +294,21 @@ export default class DashboardTraffic extends Component {<div class="db-section__row"><div class="db-section__row-block"><h3 class="db-section__row-block-title">- {{i18n "admin.dashboard.site_traffic.top_referrers.title"}}+ <LinkTo+ @route="adminReports.show"+ @model="top_referrers_by_browser_pageviews"+ @query={{hash+ start_date=this.reportQuery.start_date+ end_date=this.reportQuery.end_date+ }}+ >+ {{i18n+ "admin.dashboard.site_traffic.top_referrers.title"+ }}+ <span class="db-link-arrow" aria-hidden="true">+ {{dIcon "arrow-right"}}+ </span>+ </LinkTo></h3>{{#if @traffic.top_referrers.error}}<p class="db-traffic__list-error" role="status">@@ -336,7 +350,21 @@ export default class DashboardTraffic extends Component {<div class="db-section__row-block"><h3 class="db-section__row-block-title">- {{i18n "admin.dashboard.site_traffic.top_countries.title"}}+ <LinkTo+ @route="adminReports.show"+ @model="top_countries_by_browser_pageviews"+ @query={{hash+ start_date=this.reportQuery.start_date+ end_date=this.reportQuery.end_date+ }}+ >+ {{i18n+ "admin.dashboard.site_traffic.top_countries.title"+ }}+ <span class="db-link-arrow" aria-hidden="true">+ {{dIcon "arrow-right"}}+ </span>+ </LinkTo></h3>{{#if @traffic.top_countries.error}}<p class="db-traffic__list-error" role="status">diff --git a/spec/models/report_spec.rb b/spec/models/report_spec.rbindex 85d5b15a525..150099a3f4f 100644--- a/spec/models/report_spec.rb+++ b/spec/models/report_spec.rb@@ -2220,9 +2220,29 @@ RSpec.describe Report doendend- it "always hides browser pageview reports" do- Report::BROWSER_PAGEVIEW_REPORTS.each do |report_type|- expect(Report.hidden?(report_type, guardian: admin_guardian)).to eq(true)+ context "with browser pageview reports" do+ it "hides them from admins when persist_browser_pageview_events is disabled" do+ SiteSetting.persist_browser_pageview_events = false++ Report::BROWSER_PAGEVIEW_REPORTS.each do |report_type|+ expect(Report.hidden?(report_type, guardian: admin_guardian)).to eq(true)+ end+ end++ it "exposes them to admins when persist_browser_pageview_events is enabled" do+ SiteSetting.persist_browser_pageview_events = true++ Report::BROWSER_PAGEVIEW_REPORTS.each do |report_type|+ expect(Report.hidden?(report_type, guardian: admin_guardian)).to eq(false)+ end+ end++ it "always hides them from moderators, even when persist_browser_pageview_events is enabled" do+ SiteSetting.persist_browser_pageview_events = true++ Report::BROWSER_PAGEVIEW_REPORTS.each do |report_type|+ expect(Report.hidden?(report_type, guardian: moderator_guardian)).to eq(true)+ endendendenddiff --git a/spec/models/reports/top_countries_by_browser_pageviews_spec.rb b/spec/models/reports/top_countries_by_browser_pageviews_spec.rbindex c13daceb7cd..61131dc1f31 100644--- a/spec/models/reports/top_countries_by_browser_pageviews_spec.rb+++ b/spec/models/reports/top_countries_by_browser_pageviews_spec.rb@@ -65,21 +65,12 @@ describe Reports::TopCountriesByBrowserPageviews doexpect(report.data.first[:count]).to eq(1)end- it "respects the limit opt" do- %w[US GB DE FR JP CN].each_with_index do |code, idx|- (idx + 1).times { Fabricate(:browser_pageview_event, country_code: code) }- end+ it "caps results at MAX_ROWS when no explicit limit is given" do+ stub_const(Reports::TopCountriesByBrowserPageviews, "MAX_ROWS", 2) do+ %w[US GB DE].each { |code| Fabricate(:browser_pageview_event, country_code: code) }- BrowserPageviewCountryDailyRollup.aggregate(start_date: start_date, end_date: end_date)- BrowserPageviewEvent.delete_all- limited =- Report.find(- "top_countries_by_browser_pageviews",- start_date: start_date,- end_date: end_date,- limit: 3,- )- expect(limited.data.size).to eq(3)+ expect(report.data.size).to eq(2)+ endendendenddiff --git a/spec/models/reports/top_referrers_by_browser_pageviews_spec.rb b/spec/models/reports/top_referrers_by_browser_pageviews_spec.rbindex 2a40317d9da..1e19d459e13 100644--- a/spec/models/reports/top_referrers_by_browser_pageviews_spec.rb+++ b/spec/models/reports/top_referrers_by_browser_pageviews_spec.rb@@ -96,25 +96,17 @@ describe Reports::TopReferrersByBrowserPageviews doexpect(report.data).to eq([])end- it "limits displayed rows but keeps every external referrer in the percent denominator" do- 5.times { Fabricate(:browser_pageview_event, normalized_referrer: "a.example.com") }- 3.times { Fabricate(:browser_pageview_event, normalized_referrer: "b.example.com") }- 2.times { Fabricate(:browser_pageview_event, normalized_referrer: "c.example.com") }-- BrowserPageviewReferrerDailyRollup.aggregate(start_date: start_date, end_date: end_date)- BrowserPageviewEvent.delete_all- limited =- Report.find(- "top_referrers_by_browser_pageviews",- start_date: start_date,- end_date: end_date,- limit: 2,+ it "caps displayed rows at MAX_ROWS but keeps every external referrer in the percent denominator" do+ stub_const(Reports::TopReferrersByBrowserPageviews, "MAX_ROWS", 2) do+ 5.times { Fabricate(:browser_pageview_event, normalized_referrer: "a.example.com") }+ 3.times { Fabricate(:browser_pageview_event, normalized_referrer: "b.example.com") }+ 2.times { Fabricate(:browser_pageview_event, normalized_referrer: "c.example.com") }++ expect(report.data.map { |row| row[:normalized_referrer] }).to eq(+ %w[a.example.com b.example.com],)-- expect(limited.data.map { |row| row[:normalized_referrer] }).to eq(- %w[a.example.com b.example.com],- )- expect(limited.data.map { |row| row[:percent] }).to eq([50, 30])+ expect(report.data.map { |row| row[:percent] }).to eq([50, 30])+ endendendenddiff --git a/spec/requests/admin/reports_controller_spec.rb b/spec/requests/admin/reports_controller_spec.rbindex 62a88d79159..45e926a92c6 100644--- a/spec/requests/admin/reports_controller_spec.rb+++ b/spec/requests/admin/reports_controller_spec.rb@@ -547,5 +547,33 @@ RSpec.describe Admin::ReportsController doexpect(response.status).to eq(200)endend++ context "with browser pageview reports" do+ it "lets an admin run them only when persist_browser_pageview_events is enabled" do+ sign_in(admin)++ SiteSetting.persist_browser_pageview_events = false+ Report::BROWSER_PAGEVIEW_REPORTS.each do |report_type|+ get "/admin/reports/#{report_type}.json"+ expect(response.status).to eq(404)+ end++ SiteSetting.persist_browser_pageview_events = true+ Report::BROWSER_PAGEVIEW_REPORTS.each do |report_type|+ get "/admin/reports/#{report_type}.json"+ expect(response.status).to eq(200)+ end+ end++ it "denies a moderator even when persist_browser_pageview_events is enabled" do+ SiteSetting.persist_browser_pageview_events = true+ sign_in(moderator)++ Report::BROWSER_PAGEVIEW_REPORTS.each do |report_type|+ get "/admin/reports/#{report_type}.json"+ expect(response.status).to eq(404)+ end+ end+ endendenddiff --git a/spec/services/admin_dashboard_site_traffic_spec.rb b/spec/services/admin_dashboard_site_traffic_spec.rbindex 78c2852fed6..f4642cb8f16 100644--- a/spec/services/admin_dashboard_site_traffic_spec.rb+++ b/spec/services/admin_dashboard_site_traffic_spec.rb@@ -558,6 +558,25 @@ RSpec.describe AdminDashboardSiteTraffic doexpect(result[:top_referrers][:error]).to be_nilend+ it "caps each card at the top 5 rows on both the fresh and cached paths" do+ %w[US GB DE FR JP CA].each do |code|+ Fabricate(+ :browser_pageview_event,+ country_code: code,+ normalized_referrer: "#{code.downcase}.example.com",+ )+ end+ aggregate_rollups++ fresh = described_class.build(start_date: nil, end_date: nil)+ expect(fresh[:top_countries][:rows].size).to eq(5)+ expect(fresh[:top_referrers][:rows].size).to eq(5)++ cached = described_class.build(start_date: nil, end_date: nil)+ expect(cached[:top_countries][:rows].size).to eq(5)+ expect(cached[:top_referrers][:rows].size).to eq(5)+ end+it "returns empty rows when no events match the date range" doresult = described_class.build(start_date: nil, end_date: nil)expect(result[:top_countries]).to eq(rows: [], error: nil)diff --git a/spec/system/admin_dashboard_redesign/site_traffic_section_spec.rb b/spec/system/admin_dashboard_redesign/site_traffic_section_spec.rbindex c0f4682e15a..4bbc0c505cd 100644--- a/spec/system/admin_dashboard_redesign/site_traffic_section_spec.rb+++ b/spec/system/admin_dashboard_redesign/site_traffic_section_spec.rb@@ -222,13 +222,51 @@ describe "Admin Dashboard Redesign | Site Traffic section" do)end- it "shows an empty state in both cards when no events qualify",+ it "shows an empty state in both cards but keeps the headers as drill-down links when no events qualify",time: Time.zone.local(2026, 5, 14, 12, 0, 0) dodashboard.visittraffic = dashboard.site_trafficexpect(traffic).to have_top_countries_empty_stateexpect(traffic).to have_top_referrers_empty_state+ expect(traffic).to have_top_referrers_drilldown+ expect(traffic).to have_top_countries_drilldown+ end++ it "drills into the full top referrers report scoped to the dashboard period",+ time: Time.zone.local(2026, 5, 14, 12, 0, 0) do+ Fabricate(+ :browser_pageview_event,+ normalized_referrer: "news.ycombinator.com/item?id=42",+ created_at: "2026-05-12",+ )+ BrowserPageviewReferrerDailyRollup.aggregate(+ start_date: "2026-05-01".to_date,+ end_date: "2026-05-14".to_date,+ )++ dashboard.visit_with_query(range: "custom", start_date: "2026-05-01", end_date: "2026-05-12")+ dashboard.site_traffic.click_top_referrers_drilldown++ expect(page).to have_current_path(+ "/admin/reports/top_referrers_by_browser_pageviews?end_date=2026-05-12&start_date=2026-05-01",+ )+ end++ it "drills into the full top countries report scoped to the dashboard period",+ time: Time.zone.local(2026, 5, 14, 12, 0, 0) do+ Fabricate(:browser_pageview_event, country_code: "US", created_at: "2026-05-12")+ BrowserPageviewCountryDailyRollup.aggregate(+ start_date: "2026-05-01".to_date,+ end_date: "2026-05-14".to_date,+ )++ dashboard.visit_with_query(range: "custom", start_date: "2026-05-01", end_date: "2026-05-12")+ dashboard.site_traffic.click_top_countries_drilldown++ expect(page).to have_current_path(+ "/admin/reports/top_countries_by_browser_pageviews?end_date=2026-05-12&start_date=2026-05-01",+ )endendenddiff --git a/spec/system/page_objects/components/admin_dashboard_site_traffic.rb b/spec/system/page_objects/components/admin_dashboard_site_traffic.rbindex e3d1be0bf06..d5eadf46ff7 100644--- a/spec/system/page_objects/components/admin_dashboard_site_traffic.rb+++ b/spec/system/page_objects/components/admin_dashboard_site_traffic.rb@@ -108,6 +108,22 @@ module PageObjectshas_empty_state_in?("Top referrers", "No referrer data for this period.")end+ def click_top_referrers_drilldown+ within_top_card("Top referrers") { find("h3.db-section__row-block-title a").click }+ end++ def click_top_countries_drilldown+ within_top_card("Top countries") { find("h3.db-section__row-block-title a").click }+ end++ def has_top_referrers_drilldown?+ within_top_card("Top referrers") { has_css?("h3.db-section__row-block-title a") }+ end++ def has_top_countries_drilldown?+ within_top_card("Top countries") { has_css?("h3.db-section__row-block-title a") }+ end+privatedef has_no_top_card?(title)