mirror of
https://github.com/discourse/discourse.git
synced 2026-08-08 17:53:55 +08:00
437ab337d2This commit adds two new cards to the redesigned admin dashboard's Site
Traffic section: top countries and top referrers, both sourced from
`browser_pageview_events`.
Key technical decisions:
1. Gate the cards on the `persist_browser_pageview_events` site setting.
The cards have no data source unless browser pageview events are being
persisted, so they are omitted from the dashboard.
2. Normalize referrers at write time. A new `normalized_referrer` column
on `browser_pageview_events` is populated by
`BrowserPageviewReferrerInspector`, which strips scheme, `www.`, port,
fragment, trailing slashes, and common tracking query params. Doing this
at insert time avoids per-row string operations at query time.
3. Count browser pageviews by country and by referrer in two new report
concerns. `Reports::TopCountriesByBrowserPageviews` groups by
`country_code` and `Reports::TopReferrersByBrowserPageviews` groups by
`normalized_referrer`. Both compute share of total browser pageviews and
rank the top 5 in SQL. The country report drops MaxMind reserved codes
(unknown, anonymous proxy, satellite). The referrer report drops
same-host referrals. Both also exclude anonymous browser pageviews
(`user_id IS NULL`) when the `login_required` site setting is enabled,
since only logged-in browser pageviews are meaningful on a closed forum.
4. Fetch each report through the existing dashboard service.
`AdminDashboardSiteTraffic#build` returns one entry per card with a `{
rows:, error: }` shape, e.g.:
```ruby
{
top_countries: {
rows: [
{ country_code: "US", count: 142, percent: 35 },
{ country_code: "GB", count: 89, percent: 22 }
],
error: nil
},
top_referrers: {
rows: [
{ normalized_referrer: "news.ycombinator.com/item?id=1", count: 47,
percent: 12 },
{ normalized_referrer: "reddit.com/r/discourse", count: 31, percent: 8 }
],
error: nil
}
}
```
On report failure, `rows: []` and `error: :timeout` (or another symbol).
This lets the UI render rows, error, or empty state independently.
Healthy responses are cached via `Report.find_cached`.
`SiteSetting.login_required` and `Discourse.current_hostname` flow into
`opts[:filters]` so toggling either invalidates the cache. Timeouts skip
the cache so the next request retries.
5. Use `Intl.DisplayNames` for country names instead of locale files.
`Intl.DisplayNames` is a built-in browser API that returns a localized
country name for an ISO 3166-1 alpha-2 code, avoiding ~250 translation
strings per locale.
|
||
|---|---|---|
| .. | ||
| add_topic_to_quotes.rake | ||
| admin.rake | ||
| annotate.rake | ||
| annotate_rb.rake | ||
| api.rake | ||
| api_docs.rake | ||
| assets.rake | ||
| autospec.rake | ||
| avatars.rake | ||
| backfill.thor | ||
| categories.rake | ||
| cdn.rake | ||
| compatibility.rake | ||
| db.rake | ||
| db_structure.rake | ||
| destroy.rake | ||
| dev.rake | ||
| docker.rake | ||
| documentation.rake | ||
| emails.rake | ||
| export.rake | ||
| groups.rake | ||
| hashtags.rake | ||
| i18n.rake | ||
| images.rake | ||
| import.rake | ||
| incoming_emails.rake | ||
| javascript.rake | ||
| list_email_templates_strings.rake | ||
| log.rake | ||
| maxminddb.rake | ||
| migrate_advanced_search_banner_to_welcome_banner.rake | ||
| plugin.rake | ||
| populate.rake | ||
| populate.thor | ||
| posts.rake | ||
| profile.rake | ||
| qunit.rake | ||
| redis.rake | ||
| release.rake | ||
| release_note.rake | ||
| reviewables.rake | ||
| revisions.rake | ||
| rspec.rake | ||
| s3.rake | ||
| scheduler.rake | ||
| search.rake | ||
| site.rake | ||
| site_settings.rake | ||
| smoke_test.rake | ||
| svg_icons.rake | ||
| svg_sprites.rake | ||
| tags.rake | ||
| themes.rake | ||
| topic_localizations.rake | ||
| topics.rake | ||
| turbo.rake | ||
| typepad.thor | ||
| uploads.rake | ||
| users.rake | ||
