From 0c982a86709ce8bb3bd63a3e6b251488a09315db Mon Sep 17 00:00:00 2001 From: Vignesh Joglekar Date: Thu, 14 Oct 2021 03:55:43 -0500 Subject: [PATCH] Adds list-based country report option (#1381) * Adds list option for countries report * Changelog * Renames Geo to Locations * Lint Co-authored-by: Uku Taht --- CHANGELOG.md | 1 + assets/js/dashboard/historical.js | 4 +- assets/js/dashboard/realtime.js | 4 +- .../js/dashboard/stats/locations/countries.js | 118 ++++++++++++++++++ assets/js/dashboard/stats/locations/index.js | 88 +++++++++++++ .../stats/{countries.js => locations/map.js} | 39 +++--- assets/js/dashboard/stats/modals/countries.js | 2 +- .../controllers/api/stats_controller.ex | 3 +- 8 files changed, 231 insertions(+), 28 deletions(-) create mode 100644 assets/js/dashboard/stats/locations/countries.js create mode 100644 assets/js/dashboard/stats/locations/index.js rename assets/js/dashboard/stats/{countries.js => locations/map.js} (83%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 91dd94b92..3e3f166ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ All notable changes to this project will be documented in this file. - Ability to invite users to sites with different roles plausible/analytics#1122 - Option to configure a custom name for the script file - Add Conversion Rate to Top Sources, Top Pages Devices, Countries when filtered by a goal plausible/analytics#1299 +- Add list view for countries report in dashboard plausible/analytics#1381 - Add ability to view more than 100 custom goal properties plausible/analytics#1353 ### Fixed diff --git a/assets/js/dashboard/historical.js b/assets/js/dashboard/historical.js index 1d90bb1d6..a4b3b4b21 100644 --- a/assets/js/dashboard/historical.js +++ b/assets/js/dashboard/historical.js @@ -7,7 +7,7 @@ import CurrentVisitors from './stats/current-visitors' import VisitorGraph from './stats/visitor-graph' import Sources from './stats/sources' import Pages from './stats/pages' -import Countries from './stats/countries' +import Locations from './stats/locations'; import Devices from './stats/devices' import Conversions from './stats/conversions' import { withPinnedHeader } from './pinned-header-hoc'; @@ -47,7 +47,7 @@ class Historical extends React.Component {
- +
{ this.renderConversions() } diff --git a/assets/js/dashboard/realtime.js b/assets/js/dashboard/realtime.js index d343390e1..ed124a746 100644 --- a/assets/js/dashboard/realtime.js +++ b/assets/js/dashboard/realtime.js @@ -6,7 +6,7 @@ import Filters from './filters' import VisitorGraph from './stats/visitor-graph' import Sources from './stats/sources' import Pages from './stats/pages' -import Countries from './stats/countries' +import Locations from './stats/locations' import Devices from './stats/devices' import Conversions from './stats/conversions' import { withPinnedHeader } from './pinned-header-hoc'; @@ -45,7 +45,7 @@ class Realtime extends React.Component {
- +
diff --git a/assets/js/dashboard/stats/locations/countries.js b/assets/js/dashboard/stats/locations/countries.js new file mode 100644 index 000000000..8e8e77137 --- /dev/null +++ b/assets/js/dashboard/stats/locations/countries.js @@ -0,0 +1,118 @@ +import React from 'react'; +import { Link } from 'react-router-dom' +import FlipMove from 'react-flip-move'; +import Datamap from 'datamaps' + +import FadeIn from '../../fade-in' +import Bar from '../bar' +import MoreLink from '../more-link' +import numberFormatter from '../../number-formatter' +import * as api from '../../api' +import * as url from '../../url' +import LazyLoader from '../../lazy-loader' + +export default class Countries extends React.Component { + constructor(props) { + super(props) + this.state = {loading: true} + this.onVisible = this.onVisible.bind(this) + } + + componentDidUpdate(prevProps) { + if (this.props.query !== prevProps.query) { + this.setState({loading: true, countries: null}) + this.fetchCountries() + } + } + + onVisible() { + this.fetchCountries() + if (this.props.timer) this.props.timer.onTick(this.fetchCountries.bind(this)) + } + + showConversionRate() { + return !!this.props.query.filters.goal + } + + fetchCountries() { + api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/countries`, this.props.query) + .then((res) => this.setState({loading: false, countries: res})) + } + + label() { + if (this.showConversionRate()) { + return 'Conversions' + } + + return 'Visitors' + } + + renderCountry(country) { + const maxWidthDeduction = this.showConversionRate() ? "10rem" : "5rem" + const allCountries = Datamap.prototype.worldTopo.objects.world.geometries; + const thisCountry = allCountries.find((c) => c.id === country.name) || {properties: {name: country.name}}; + const countryFullName = thisCountry.properties.name + + return ( +
+ + + + {countryFullName} + + + + {numberFormatter(country.count)} + {this.showConversionRate() && {numberFormatter(country.conversion_rate)}%} +
+ ) + } + + renderList() { + if (this.state.countries && this.state.countries.length > 0) { + return ( + <> +
+ Country +
+ { this.label() } + {this.showConversionRate() && CR} +
+
+ + + { this.state.countries.map(this.renderCountry.bind(this)) } + + + ) + } + + return
No data yet
+ } + + render() { + const { loading } = this.state; + return ( + + { loading &&
} + + { this.renderList() } + + {!loading && } +
+ ) + } +} diff --git a/assets/js/dashboard/stats/locations/index.js b/assets/js/dashboard/stats/locations/index.js new file mode 100644 index 000000000..701fae92d --- /dev/null +++ b/assets/js/dashboard/stats/locations/index.js @@ -0,0 +1,88 @@ +import React from 'react'; + +import * as storage from '../../storage' +import Countries from './countries'; +import CountriesMap from './map' + +const labelFor = { + 'map': 'Countries Map', + 'countries': 'Countries', + 'regions': 'Regions', + 'cities': 'Cities', +} + +export default class Locations extends React.Component { + constructor(props) { + super(props) + this.tabKey = `geoTab__${ props.site.domain}` + const storedTab = storage.getItem(this.tabKey) + this.state = { + mode: storedTab || 'map' + } + } + + setMode(mode) { + return () => { + storage.setItem(this.tabKey, mode) + this.setState({mode}) + } + } + + renderContent() { + switch(this.state.mode) { + case "countries": + return + case "map": + default: + return + } + } + + renderPill(name, mode) { + const isActive = this.state.mode === mode + + if (isActive) { + return ( +
  • + {name} +
  • + ) + } + + return ( +
  • + {name} +
  • + ) + } + + render() { + return ( +
    +
    +
    +

    + {labelFor[this.state.mode] || 'Locations'} +

    +
      + { this.renderPill('Map', 'map') } + { this.renderPill('Countries', 'countries') } + {/* { this.renderPill('Regions', 'regions') } */} + {/* { this.renderPill('Cities', 'cities') } */} +
    +
    + { this.renderContent() } +
    +
    + ) + } +} diff --git a/assets/js/dashboard/stats/countries.js b/assets/js/dashboard/stats/locations/map.js similarity index 83% rename from assets/js/dashboard/stats/countries.js rename to assets/js/dashboard/stats/locations/map.js index 2c06ae684..8dc82d49c 100644 --- a/assets/js/dashboard/stats/countries.js +++ b/assets/js/dashboard/stats/locations/map.js @@ -3,15 +3,15 @@ import Datamap from 'datamaps' import { withRouter } from 'react-router-dom' import * as d3 from "d3" -import numberFormatter from '../number-formatter' -import FadeIn from '../fade-in' -import LazyLoader from '../lazy-loader' -import MoreLink from './more-link' -import * as api from '../api' -import { navigateToQuery } from '../query' -import { withThemeConsumer } from '../theme-consumer-hoc'; - -class Countries extends React.Component { +import numberFormatter from '../../number-formatter' +import FadeIn from '../../fade-in' +import LazyLoader from '../../lazy-loader' +import MoreLink from '../more-link' +import * as api from '../../api' +import { navigateToQuery } from '../../query' +import { withThemeConsumer } from '../../theme-consumer-hoc'; + +class CountriesMap extends React.Component { constructor(props) { super(props) this.resizeMap = this.resizeMap.bind(this) @@ -137,8 +137,7 @@ class Countries extends React.Component { if (this.state.countries) { return ( -

    Countries

    -
    +
    { this.geolocationDbNotice() }
    @@ -148,18 +147,14 @@ class Countries extends React.Component { render() { return ( -
    - - { this.state.loading &&
    } - - { this.renderBody() } - -
    -
    + + { this.state.loading &&
    } + + { this.renderBody() } + +
    ) } } -export default withRouter(withThemeConsumer(Countries)) +export default withRouter(withThemeConsumer(CountriesMap)) diff --git a/assets/js/dashboard/stats/modals/countries.js b/assets/js/dashboard/stats/modals/countries.js index e04b68e08..1819e5c2d 100644 --- a/assets/js/dashboard/stats/modals/countries.js +++ b/assets/js/dashboard/stats/modals/countries.js @@ -17,7 +17,7 @@ class CountriesModal extends React.Component { } componentDidMount() { - api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/countries`, this.state.query, {limit: 100}) + api.get(`/api/stats/${encodeURIComponent(this.props.site.domain)}/countries`, this.state.query, {limit: 300}) .then((res) => this.setState({loading: false, countries: res})) } diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index ff5b9ae75..409bb2c98 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -404,9 +404,10 @@ defmodule PlausibleWeb.Api.StatsController do def countries(conn, params) do site = conn.assigns[:site] query = Query.from(site.timezone, params) |> Filters.add_prefix() + pagination = parse_pagination(params) countries = - Stats.breakdown(site, query, "visit:country", ["visitors"], {300, 1}) + Stats.breakdown(site, query, "visit:country", ["visitors"], pagination) |> maybe_add_cr(site, query, {300, 1}, "country", "visit:country") |> transform_keys(%{"country" => "name", "visitors" => "count"}) |> Enum.map(fn country ->