Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Refactor Devices to /query endpoint (#6398)

Artur Pataba462d7d9a3f
diff --git a/assets/js/dashboard/index.tsx b/assets/js/dashboard/index.tsx
index 38a31ecd55..9b3dc4e9ef 100644
--- a/assets/js/dashboard/index.tsx
+++ b/assets/js/dashboard/index.tsx
@@ -3,7 +3,7 @@ import VisitorGraph from './stats/graph/visitor-graph'
import Sources from './stats/sources'
import Pages from './stats/pages'
import Locations from './stats/locations'
-import Devices from './stats/devices'
+import { Devices } from './stats/devices'
import { TopBar } from './nav-menu/top-bar'
import Behaviours from './stats/behaviours'
import { useDashboardStateContext } from './dashboard-state-context'
diff --git a/assets/js/dashboard/router.tsx b/assets/js/dashboard/router.tsx
index b9676b8284..90df8f75c8 100644
--- a/assets/js/dashboard/router.tsx
+++ b/assets/js/dashboard/router.tsx
@@ -12,16 +12,12 @@ import SourcesModal from './stats/modals/sources'
import ReferrersDrilldownModal from './stats/modals/referrer-drilldown'
import GoogleKeywordsModal from './stats/modals/google-keywords'
import { PagesDetails } from './stats/pages/details'
+import { DevicesDetails } from './stats/devices/details'
import {
BREAKDOWN_REPORTS,
BreakdownReportKey
} from './stats/reports/reports-config'
import LocationsModal from './stats/modals/locations-modal'
-import BrowsersModal from './stats/modals/devices/browsers-modal'
-import BrowserVersionsModal from './stats/modals/devices/browser-versions-modal'
-import OperatingSystemsModal from './stats/modals/devices/operating-systems-modal'
-import OperatingSystemVersionsModal from './stats/modals/devices/operating-system-versions-modal'
-import ScreenSizesModal from './stats/modals/devices/screen-sizes'
import PropsModal from './stats/modals/props'
import ConversionsModal from './stats/modals/conversions'
import FilterModal from './stats/modals/filter-modal'
@@ -132,28 +128,35 @@ export const citiesRoute = {
}
export const browsersRoute = {
- path: 'browsers',
- element: <BrowsersModal />
+ path: BREAKDOWN_REPORTS.browsers.detailsPath,
+ element: <DevicesDetails reportKey={BreakdownReportKey.browsers} />
}
export const browserVersionsRoute = {
- path: 'browser-versions',
- element: <BrowserVersionsModal />
+ path: BREAKDOWN_REPORTS.browserVersions.detailsPath,
+ element: <DevicesDetails reportKey={BreakdownReportKey.browserVersions} />
}
export const operatingSystemsRoute = {
- path: 'operating-systems',
- element: <OperatingSystemsModal />
+ path: BREAKDOWN_REPORTS.operatingSystems.detailsPath,
+ element: <DevicesDetails reportKey={BreakdownReportKey.operatingSystems} />
}
export const operatingSystemVersionsRoute = {
- path: 'operating-system-versions',
- element: <OperatingSystemVersionsModal />
+ path: BREAKDOWN_REPORTS.operatingSystemVersions.detailsPath,
+ element: (
+ <DevicesDetails reportKey={BreakdownReportKey.operatingSystemVersions} />
+ )
}
export const screenSizesRoute = {
- path: 'screen-sizes',
- element: <ScreenSizesModal />
+ path: BREAKDOWN_REPORTS.screenSizes.detailsPath,
+ element: (
+ <DevicesDetails
+ reportKey={BreakdownReportKey.screenSizes}
+ searchEnabled={false}
+ />
+ )
}
export const conversionsRoute = {
diff --git a/assets/js/dashboard/stats/devices/details.tsx b/assets/js/dashboard/stats/devices/details.tsx
new file mode 100644
index 0000000000..36bd6379a4
--- /dev/null
+++ b/assets/js/dashboard/stats/devices/details.tsx
@@ -0,0 +1,115 @@
+import React from 'react'
+import { useDashboardStateContext } from '../../dashboard-state-context'
+import {
+ hasConversionGoalFilter,
+ isRealTimeDashboard
+} from '../../util/filters'
+import { chooseBreakdownMetricsByContext } from '../breakdowns'
+import {
+ BREAKDOWN_REPORTS,
+ BreakdownReportKey
+} from '../reports/reports-config'
+import {
+ DetailsBreakdown,
+ DimensionCell,
+ DimensionCellProps
+} from '../modals/details-breakdown'
+import Modal from '../modals/modal'
+import { BrowserIcon, OsIcon, ScreenSizeIcon } from './icons'
+import { getScreenFilterInfo } from '.'
+
+type DevicesReportKey =
+ | BreakdownReportKey.browsers
+ | BreakdownReportKey.browserVersions
+ | BreakdownReportKey.operatingSystems
+ | BreakdownReportKey.operatingSystemVersions
+ | BreakdownReportKey.screenSizes
+
+export function DevicesDetails({
+ reportKey,
+ searchEnabled
+}: {
+ reportKey: DevicesReportKey
+ searchEnabled?: boolean
+}) {
+ const { dashboardState } = useDashboardStateContext()
+ const reportConfig = BREAKDOWN_REPORTS[reportKey]
+
+ const metrics = chooseBreakdownMetricsByContext(
+ reportConfig.metricsByContext,
+ {
+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),
+ isRealtime: isRealTimeDashboard(dashboardState),
+ isDetailed: true,
+ isRevenueAvailable: false
+ }
+ )
+
+ const DimensionElement = {
+ [BreakdownReportKey.browsers]: BrowsersDimensionCell,
+ [BreakdownReportKey.browserVersions]: BrowserVersionsDimensionCell,
+ [BreakdownReportKey.operatingSystems]: OperatingSystemsDimensionCell,
+ [BreakdownReportKey.operatingSystemVersions]:
+ OperatingSystemVersionsDimensionCell,
+ [BreakdownReportKey.screenSizes]: ScreenSizesDimensionCell
+ }[reportKey]
+
+ return (
+ <Modal>
+ <DetailsBreakdown
+ title={reportConfig.detailsTitle}
+ dimensionLabel={reportConfig.dimensionLabel}
+ dimensions={reportConfig.dimensions}
+ metrics={metrics}
+ defaultOrderBy={[['visitors', 'desc']]}
+ searchEnabled={searchEnabled}
+ DimensionElement={DimensionElement}
+ getFilterInfo={
+ reportKey === BreakdownReportKey.screenSizes
+ ? getScreenFilterInfo
+ : undefined
+ }
+ />
+ </Modal>
+ )
+}
+
+const BrowsersDimensionCell = (props: DimensionCellProps) => (
+ <DimensionCell
+ {...props}
+ text={props.row.dimensions[0]}
+ icon={<BrowserIcon dimensionValue={props.row.dimensions[0]} />}
+ />
+)
+
+const BrowserVersionsDimensionCell = (props: DimensionCellProps) => (
+ <DimensionCell
+ {...props}
+ text={props.row.dimensions[0]}
+ icon={<BrowserIcon dimensionValue={props.row.dimensions[1]} />}
+ />
+)
+
+const OperatingSystemsDimensionCell = (props: DimensionCellProps) => (
+ <DimensionCell
+ {...props}
+ text={props.row.dimensions[0]}
+ icon={<OsIcon dimensionValue={props.row.dimensions[0]} />}
+ />
+)
+
+const OperatingSystemVersionsDimensionCell = (props: DimensionCellProps) => (
+ <DimensionCell
+ {...props}
+ text={props.row.dimensions[0]}
+ icon={<OsIcon dimensionValue={props.row.dimensions[1]} />}
+ />
+)
+
+const ScreenSizesDimensionCell = (props: DimensionCellProps) => (
+ <DimensionCell
+ {...props}
+ text={props.row.dimensions[0]}
+ icon={<ScreenSizeIcon dimensionValue={props.row.dimensions[0]} />}
+ />
+)
diff --git a/assets/js/dashboard/stats/devices/icons.tsx b/assets/js/dashboard/stats/devices/icons.tsx
new file mode 100644
index 0000000000..cb2e0bd312
--- /dev/null
+++ b/assets/js/dashboard/stats/devices/icons.tsx
@@ -0,0 +1,146 @@
+import React, { ReactNode } from 'react'
+
+// Icons copied from https://github.com/alrra/browser-logos
+const BROWSER_ICONS: Record<string, string> = {
+ Chrome: 'chrome.svg',
+ curl: 'curl.svg',
+ Safari: 'safari.png',
+ Firefox: 'firefox.svg',
+ 'Microsoft Edge': 'edge.svg',
+ Vivaldi: 'vivaldi.svg',
+ Opera: 'opera.svg',
+ 'Samsung Browser': 'samsung-internet.svg',
+ Chromium: 'chromium.svg',
+ 'UC Browser': 'uc.svg',
+ 'Yandex Browser': 'yandex.png', // Only PNG available in browser-logos
+ // Logos underneath this line are not available in browser-logos. Grabbed from random places on the internets.
+ 'DuckDuckGo Privacy Browser': 'duckduckgo.svg',
+ 'MIUI Browser': 'miui.webp',
+ 'Huawei Browser Mobile': 'huawei.png',
+ 'QQ Browser': 'qq.png',
+ Ecosia: 'ecosia.png',
+ 'vivo Browser': 'vivo.png'
+}
+
+export const BrowserIcon = ({ dimensionValue }: { dimensionValue: string }) => {
+ const filename = BROWSER_ICONS[dimensionValue] ?? 'fallback.svg'
+ return (
+ <img
+ alt=""
+ src={`/images/icon/browser/${filename}`}
+ className="inline-block w-4 h-4 mr-2"
+ />
+ )
+}
+
+// Icons copied from https://github.com/ngeenx/operating-system-logos
+const OS_ICONS: Record<string, string> = {
+ iOS: 'ios.png',
+ Mac: 'mac.png',
+ Windows: 'windows.png',
+ 'Windows Phone': 'windows.png',
+ Android: 'android.png',
+ 'GNU/Linux': 'gnu_linux.png',
+ Ubuntu: 'ubuntu.png',
+ 'Chrome OS': 'chrome_os.png',
+ iPadOS: 'ipad_os.png',
+ 'Fire OS': 'fire_os.png',
+ HarmonyOS: 'harmony_os.png',
+ Tizen: 'tizen.png',
+ PlayStation: 'playstation.png',
+ KaiOS: 'kai_os.png',
+ Fedora: 'fedora.png',
+ FreeBSD: 'freebsd.png'
+}
+
+export const OsIcon = ({ dimensionValue }: { dimensionValue: string }) => {
+ const filename = OS_ICONS[dimensionValue] ?? 'fallback.svg'
+ return (
+ <img
+ alt=""
+ src={`/images/icon/os/${filename}`}
+ className="inline-block w-4 h-4 mr-2"
+ />
+ )
+}
+
+const SHARED_SCREEN_SIZE_SVG_PROPS = {
+ xmlns: 'http://www.w3.org/2000/svg',
+ width: 24,
+ height: 24,
+ viewBox: '0 0 24 24',
+ fill: 'none',
+ stroke: 'currentColor',
+ strokeWidth: 2,
+ strokeLinecap: 'round',
+ strokeLinejoin: 'round',
+ className: '-mt-px feather inline-block'
+} as const
+
+export const MobileScreenIconSvg = () => (
+ <svg {...SHARED_SCREEN_SIZE_SVG_PROPS}>
+ <rect x="5" y="2" width="14" height="20" rx="2" ry="2" />
+ <line x1="12" y1="18" x2="12" y2="18" />
+ </svg>
+)
+
+export const TabletScreenIconSvg = () => (
+ <svg {...SHARED_SCREEN_SIZE_SVG_PROPS}>
+ <rect
+ x="4"
+ y="2"
+ width="16"
+ height="20"
+ rx="2"
+ ry="2"
+ transform="rotate(180 12 12)"
+ />
+ <line x1="12" y1="18" x2="12" y2="18" />
+ </svg>
+)
+
+export const LaptopScreenIconSvg = () => (
+ <svg {...SHARED_SCREEN_SIZE_SVG_PROPS}>
+ <rect x="2" y="3" width="20" height="14" rx="2" ry="2" />
+ <line x1="2" y1="20" x2="22" y2="20" />
+ </svg>
+)
+
+export const DesktopScreenIconSvg = () => (
+ <svg {...SHARED_SCREEN_SIZE_SVG_PROPS}>
+ <rect x="2" y="3" width="20" height="14" rx="2" ry="2" />
+ <line x1="8" y1="21" x2="16" y2="21" />
+ <line x1="12" y1="17" x2="12" y2="21" />
+ </svg>
+)
+
+export const UltraWideScreenIconSvg = () => (
+ <svg {...SHARED_SCREEN_SIZE_SVG_PROPS}>
+ <rect x="1" y="4" width="22" height="12" rx="2" ry="2" />
+ <line x1="6" y1="20" x2="18" y2="20" />
+ <line x1="12" y1="16" x2="12" y2="20" />
+ </svg>
+)
+
+export const NotSetScreenIconSvg = () => (
+ <svg {...SHARED_SCREEN_SIZE_SVG_PROPS}>
+ <circle cx="12" cy="12" r="10" />
+ <circle cx="12" cy="17.25" r="1.25" />
+ <path d="M9.244 8.369c.422-1.608 1.733-2.44 3.201-2.364 1.45.075 2.799.872 2.737 2.722-.089 2.63-2.884 2.273-3.197 4.773h.011" />
+ </svg>
+)
+
+const SCREEN_SIZE_SVGS: Record<string, ReactNode> = {
+ Mobile: <MobileScreenIconSvg />,
+ Tablet: <TabletScreenIconSvg />,
+ Laptop: <LaptopScreenIconSvg />,
+ Desktop: <DesktopScreenIconSvg />,
+ 'Ultra-wide': <UltraWideScreenIconSvg />,
+ '(not set)': <NotSetScreenIconSvg />
+}
+
+export const ScreenSizeIcon = ({
+ dimensionValue
+}: {
+ dimensionValue: string
+}) => <span className="mr-1.5">{SCREEN_SIZE_SVGS[dimensionValue] ?? null}</span>
diff --git a/assets/js/dashboard/stats/devices/index.js b/assets/js/dashboard/stats/devices/index.js
deleted file mode 100644
index 88757a15c3..0000000000
--- a/assets/js/dashboard/stats/devices/index.js
+++ /dev/null
@@ -1,544 +0,0 @@
-import React, { useEffect, useState } from 'react'
-import * as storage from '../../util/storage'
-import {
- getFiltersByKeyPrefix,
- hasConversionGoalFilter,
- isFilteringOnFixedValue
-} from '../../util/filters'
-import ListReport from '../reports/list-legacy'
-import * as metrics from '../reports/metrics'
-import * as api from '../../api'
-import * as url from '../../util/url'
-import ImportedQueryUnsupportedWarning from '../imported-query-unsupported-warning'
-import { useDashboardStateContext } from '../../dashboard-state-context'
-import { useSiteContext } from '../../site-context'
-import { ReportLayout } from '../reports/report-layout'
-import { ReportHeader } from '../reports/report-header'
-import { TabButton, TabWrapper } from '../../components/tabs'
-import {
- browsersRoute,
- browserVersionsRoute,
- operatingSystemsRoute,
- operatingSystemVersionsRoute,
- screenSizesRoute
-} from '../../router'
-import MoreLink from '../more-link'
-import { MoreLinkState } from '../more-link-state'
-
-// Icons copied from https://github.com/alrra/browser-logos
-const BROWSER_ICONS = {
- Chrome: 'chrome.svg',
- curl: 'curl.svg',
- Safari: 'safari.png',
- Firefox: 'firefox.svg',
- 'Microsoft Edge': 'edge.svg',
- Vivaldi: 'vivaldi.svg',
- Opera: 'opera.svg',
- 'Samsung Browser': 'samsung-internet.svg',
- Chromium: 'chromium.svg',
- 'UC Browser': 'uc.svg',
- 'Yandex Browser': 'yandex.png', // Only PNG available in browser-logos
- // Logos underneath this line are not available in browser-logos. Grabbed from random places on the internets.
- 'DuckDuckGo Privacy Browser': 'duckduckgo.svg',
- 'MIUI Browser': 'miui.webp',
- 'Huawei Browser Mobile': 'huawei.png',
- 'QQ Browser': 'qq.png',
- Ecosia: 'ecosia.png',
- 'vivo Browser': 'vivo.png'
-}
-
-export function browserIconFor(browser) {
- const filename = BROWSER_ICONS[browser] || 'fallback.svg'
-
- return (
- <img
- alt=""
- src={`/images/icon/browser/${filename}`}
- className="w-4 h-4 mr-2"
- />
- )
-}
-
-function Browsers({ afterFetchData }) {
- const site = useSiteContext()
- const { dashboardState } = useDashboardStateContext()
- function fetchData() {
- return api.get(url.apiPath(site, '/browsers'), dashboardState)
- }
-
- function getFilterInfo(listItem) {
- return {
- prefix: 'browser',
- filter: ['is', 'browser', [listItem['name']]]
- }
- }
-
- function renderIcon(listItem) {
- return browserIconFor(listItem.name)
- }
-
- function chooseMetrics() {
- return [
- metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(dashboardState) &&
- metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
- ].filter((metric) => !!metric)
- }
-
- return (
- <ListReport
- fetchData={fetchData}
- afterFetchData={afterFetchData}
- getFilterInfo={getFilterInfo}
- keyLabel="Browser"
- metrics={chooseMetrics()}
- renderIcon={renderIcon}
- />
- )
-}
-
-function BrowserVersions({ afterFetchData }) {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
- function fetchData() {
- return api.get(url.apiPath(site, '/browser-versions'), dashboardState)
- }
-
- function renderIcon(listItem) {
- return browserIconFor(listItem.browser)
- }
-
- function getFilterInfo(listItem) {
- if (getSingleFilter(dashboardState, 'browser') == '(not set)') {
- return null
- }
- return {
- prefix: 'browser_version',
- filter: ['is', 'browser_version', [listItem.version]]
- }
- }
-
- function chooseMetrics() {
- return [
- metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(dashboardState) &&
- metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
- ].filter((metric) => !!metric)
- }
-
- return (
- <ListReport
- fetchData={fetchData}
- afterFetchData={afterFetchData}
- getFilterInfo={getFilterInfo}
- keyLabel="Browser version"
- metrics={chooseMetrics()}
- renderIcon={renderIcon}
- />
- )
-}
-
-// Icons copied from https://github.com/ngeenx/operating-system-logos
-const OS_ICONS = {
- iOS: 'ios.png',
- Mac: 'mac.png',
- Windows: 'windows.png',
- 'Windows Phone': 'windows.png',
- Android: 'android.png',
- 'GNU/Linux': 'gnu_linux.png',
- Ubuntu: 'ubuntu.png',
- 'Chrome OS': 'chrome_os.png',
- iPadOS: 'ipad_os.png',
- 'Fire OS': 'fire_os.png',
- HarmonyOS: 'harmony_os.png',
- Tizen: 'tizen.png',
- PlayStation: 'playstation.png',
- KaiOS: 'kai_os.png',
- Fedora: 'fedora.png',
- FreeBSD: 'freebsd.png'
-}
-
-export function osIconFor(os) {
- const filename = OS_ICONS[os] || 'fallback.svg'
-
- return (
- <img alt="" src={`/images/icon/os/${filename}`} className="w-4 h-4 mr-2" />
- )
-}
-
-function OperatingSystems({ afterFetchData }) {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
- function fetchData() {
- return api.get(url.apiPath(site, '/operating-systems'), dashboardState)
- }
-
- function getFilterInfo(listItem) {
- return {
- prefix: 'os',
- filter: ['is', 'os', [listItem['name']]]
- }
- }
-
- function chooseMetrics() {
- return [
- metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(dashboardState) &&
- metrics.createPercentage({
- meta: { showOnHover: true }
- }),
- hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
- ].filter((metric) => !!metric)
- }
-
- function renderIcon(listItem) {
- return osIconFor(listItem.name)
- }
-
- return (
- <ListReport
- fetchData={fetchData}
- afterFetchData={afterFetchData}
- getFilterInfo={getFilterInfo}
- renderIcon={renderIcon}
- keyLabel="Operating system"
- metrics={chooseMetrics()}
- />
- )
-}
-
-function OperatingSystemVersions({ afterFetchData }) {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
-
- function fetchData() {
- return api.get(
- url.apiPath(site, '/operating-system-versions'),
- dashboardState
- )
- }
-
- function renderIcon(listItem) {
- return osIconFor(listItem.os)
- }
-
- function getFilterInfo(listItem) {
- if (getSingleFilter(dashboardState, 'os') == '(not set)') {
- return null
- }
- return {
- prefix: 'os_version',
- filter: ['is', 'os_version', [listItem.version]]
- }
- }
-
- function chooseMetrics() {
- return [
- metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(dashboardState) &&
- metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
- ].filter((metric) => !!metric)
- }
-
- return (
- <ListReport
- fetchData={fetchData}
- renderIcon={renderIcon}
- afterFetchData={afterFetchData}
- getFilterInfo={getFilterInfo}
- keyLabel="Operating system version"
- metrics={chooseMetrics()}
- />
- )
-}
-
-function ScreenSizes({ afterFetchData }) {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
-
- function fetchData() {
- return api.get(url.apiPath(site, '/screen-sizes'), dashboardState)
- }
-
- function renderIcon(listItem) {
- return screenSizeIconFor(listItem.name)
- }
-
- function getFilterInfo(listItem) {
- return {
- prefix: 'screen',
- filter: ['is', 'screen', [listItem['name']]]
- }
- }
-
- function chooseMetrics() {
- return [
- metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(dashboardState) &&
- metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
- ].filter((metric) => !!metric)
- }
-
- return (
- <ListReport
- fetchData={fetchData}
- afterFetchData={afterFetchData}
- getFilterInfo={getFilterInfo}
- keyLabel="Device"
- metrics={chooseMetrics()}
- renderIcon={renderIcon}
- />
- )
-}
-
-export function screenSizeIconFor(screenSize) {
- let svg = null
-
- if (screenSize === 'Mobile') {
- svg = (
- <svg
- xmlns="http://www.w3.org/2000/svg"
- width="24"
- height="24"
- viewBox="0 0 24 24"
- fill="none"
- stroke="currentColor"
- strokeWidth="2"
- strokeLinecap="round"
- strokeLinejoin="round"
- className="-mt-px feather"
- >
- <rect x="5" y="2" width="14" height="20" rx="2" ry="2" />
- <line x1="12" y1="18" x2="12" y2="18" />
- </svg>
- )
- } else if (screenSize === 'Tablet') {
- svg = (
- <svg
- xmlns="http://www.w3.org/2000/svg"
- width="24"
- height="24"
- viewBox="0 0 24 24"
- fill="none"
- stroke="currentColor"
- strokeWidth="2"
- strokeLinecap="round"
- strokeLinejoin="round"
- className="-mt-px feather"
- >
- <rect
- x="4"
- y="2"
- width="16"
- height="20"
- rx="2"
- ry="2"
- transform="rotate(180 12 12)"
- />
- <line x1="12" y1="18" x2="12" y2="18" />
- </svg>
- )
- } else if (screenSize === 'Laptop') {
- svg = (
- <svg
- xmlns="http://www.w3.org/2000/svg"
- width="24"
- height="24"
- viewBox="0 0 24 24"
- fill="none"
- stroke="currentColor"
- strokeWidth="2"
- strokeLinecap="round"
- strokeLinejoin="round"
- className="-mt-px feather"
- >
- <rect x="2" y="3" width="20" height="14" rx="2" ry="2" />
- <line x1="2" y1="20" x2="22" y2="20" />
- </svg>
- )
- } else if (screenSize === 'Desktop') {
- svg = (
- <svg
- xmlns="http://www.w3.org/2000/svg"
- width="24"
- height="24"
- viewBox="0 0 24 24"
- fill="none"
- stroke="currentColor"
- strokeWidth="2"
- strokeLinecap="round"
- strokeLinejoin="round"
- className="-mt-px feather"
- >
- <rect x="2" y="3" width="20" height="14" rx="2" ry="2" />
- <line x1="8" y1="21" x2="16" y2="21" />
- <line x1="12" y1="17" x2="12" y2="21" />
- </svg>
- )
- } else if (screenSize === 'Ultra-wide') {
- svg = (
- <svg
- xmlns="http://www.w3.org/2000/svg"
- width="24"
- height="24"
- viewBox="0 0 24 24"
- fill="none"
- stroke="currentColor"
- strokeWidth="2"
- strokeLinecap="round"
- strokeLinejoin="round"
- className="-mt-px feather"
- >
- <rect x="1" y="4" width="22" height="12" rx="2" ry="2" />
- <line x1="6" y1="20" x2="18" y2="20" />
- <line x1="12" y1="16" x2="12" y2="20" />
- </svg>
- )
- } else if (screenSize === '(not set)') {
- svg = (
- <svg
- xmlns="http://www.w3.org/2000/svg"
- viewBox="0 0 24 24"
- fill="none"
- stroke="currentColor"
- strokeWidth="2"
- strokeLinecap="round"
- strokeLinejoin="round"
- className="-mt-px feather"
- >
- <circle cx="12" cy="12" r="10" />
- <circle cx="12" cy="17.25" r="1.25" />
- <path d="M9.244 8.369c.422-1.608 1.733-2.44 3.201-2.364 1.45.075 2.799.872 2.737 2.722-.089 2.63-2.884 2.273-3.197 4.773h.011" />
- </svg>
- )
- }
-
- return <span className="mr-1.5">{svg}</span>
-}
-
-export default function Devices() {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
-
- const tabKey = `deviceTab__${site.domain}`
- const storedTab = storage.getItem(tabKey)
- const [mode, setMode] = useState(storedTab || 'browser')
- const [loading, setLoading] = useState(true)
- const [skipImportedReason, setSkipImportedReason] = useState(null)
- const [moreLinkState, setMoreLinkState] = useState(MoreLinkState.LOADING)
-
- function switchTab(mode) {
- storage.setItem(tabKey, mode)
- setMode(mode)
- }
-
- function afterFetchData(apiResponse) {
- setLoading(false)
- setSkipImportedReason(apiResponse.skip_imported_reason)
- if (apiResponse.results && apiResponse.results.length > 0) {
- setMoreLinkState(MoreLinkState.READY)
- } else {
- setMoreLinkState(MoreLinkState.HIDDEN)
- }
- }
-
- useEffect(() => {
- setLoading(true)
- setMoreLinkState(MoreLinkState.LOADING)
- }, [dashboardState, mode])
-
- function moreLinkProps() {
- switch (mode) {
- case 'browser':
- if (isFilteringOnFixedValue(dashboardState, 'browser')) {
- return {
- path: browserVersionsRoute.path,
- search: (search) => search
- }
- }
- return {
- path: browsersRoute.path,
- search: (search) => search
- }
- case 'os':
- if (isFilteringOnFixedValue(dashboardState, 'os')) {
- return {
- path: operatingSystemVersionsRoute.path,
- search: (search) => search
- }
- }
- return {
- path: operatingSystemsRoute.path,
- search: (search) => search
- }
- case 'size':
- default:
- return {
- path: screenSizesRoute.path,
- search: (search) => search
- }
- }
- }
-
- function renderContent() {
- switch (mode) {
- case 'browser':
- if (isFilteringOnFixedValue(dashboardState, 'browser')) {
- return <BrowserVersions afterFetchData={afterFetchData} />
- }
- return <Browsers afterFetchData={afterFetchData} />
- case 'os':
- if (isFilteringOnFixedValue(dashboardState, 'os')) {
- return <OperatingSystemVersions afterFetchData={afterFetchData} />
- }
- return <OperatingSystems afterFetchData={afterFetchData} />
- case 'size':
- default:
- return <ScreenSizes afterFetchData={afterFetchData} />
- }
- }
-
- return (
- <ReportLayout testId="report-devices" className="overflow-x-hidden">
- <ReportHeader>
- <div className="flex gap-x-3">
- <TabWrapper>
- {[
- { label: 'Browsers', value: 'browser' },
- { label: 'Operating systems', value: 'os' },
- { label: 'Devices', value: 'size' }
- ].map(({ label, value }) => (
- <TabButton
- key={value}
- active={mode === value}
- onClick={() => switchTab(value)}
- >
- {label}
- </TabButton>
- ))}
- </TabWrapper>
- <ImportedQueryUnsupportedWarning
- loading={loading}
- skipImportedReason={skipImportedReason}
- />
- </div>
- <MoreLink state={moreLinkState} linkProps={moreLinkProps()} />
- </ReportHeader>
- {renderContent()}
- </ReportLayout>
- )
-}
-
-function getSingleFilter(dashboardState, filterKey) {
- const matches = getFiltersByKeyPrefix(dashboardState, filterKey)
- if (matches.length != 1) {
- return null
- }
- const clauses = matches[0][2]
-
- return clauses.length == 1 ? clauses[0] : null
-}
diff --git a/assets/js/dashboard/stats/devices/index.tsx b/assets/js/dashboard/stats/devices/index.tsx
new file mode 100644
index 0000000000..38e91e6772
--- /dev/null
+++ b/assets/js/dashboard/stats/devices/index.tsx
@@ -0,0 +1,228 @@
+import React, { useState } from 'react'
+
+import * as storage from '../../util/storage'
+import {
+ hasConversionGoalFilter,
+ isFilteringOnFixedValue,
+ isRealTimeDashboard
+} from '../../util/filters'
+import { useDashboardStateContext } from '../../dashboard-state-context'
+import { useSiteContext } from '../../site-context'
+import { ReportLayout } from '../reports/report-layout'
+import { ReportHeader } from '../reports/report-header'
+import { TabButton, TabWrapper } from '../../components/tabs'
+import MoreLink from '../more-link'
+import { MoreLinkState } from '../more-link-state'
+import { QueryApiResponse, QueryResultRow } from '../../api'
+import ImportedWarningBubble from '../imported-warning-bubble'
+import {
+ BREAKDOWN_REPORTS,
+ BreakdownReportKey
+} from '../reports/reports-config'
+import {
+ DimensionCellWithBar,
+ DimensionCellWithBarProps,
+ IndexBreakdown
+} from '../reports/index-breakdown'
+import { chooseBreakdownMetricsByContext } from '../breakdowns'
+import { DashboardState } from '../../dashboard-state'
+import { BrowserIcon, OsIcon, ScreenSizeIcon } from './icons'
+import { FilterInfo } from '../../components/drilldown-link'
+
+const BAR_COLOR = 'bg-green-50 group-hover/row:bg-green-100'
+
+export function Devices() {
+ const { dashboardState } = useDashboardStateContext()
+ const site = useSiteContext()
+
+ const storageKey = `deviceTab__${site.domain}`
+ const [tab, setTab] = useState<TabKey>(initTab(storage.getItem(storageKey)))
+ const [currentData, setCurrentData] = useState<QueryApiResponse | null>(null)
+
+ const reportKey = getReportKey(tab, dashboardState)
+ const reportConfig = BREAKDOWN_REPORTS[reportKey]
+ const DimensionElement = {
+ [BreakdownReportKey.browsers]: BrowsersDimensionCell,
+ [BreakdownReportKey.browserVersions]: BrowserVersionsDimensionCell,
+ [BreakdownReportKey.operatingSystems]: OperatingSystemsDimensionCell,
+ [BreakdownReportKey.operatingSystemVersions]:
+ OperatingSystemVersionsDimensionCell,
+ [BreakdownReportKey.screenSizes]: ScreenSizesDimensionCell
+ }[reportKey]
+
+ const metrics = chooseBreakdownMetricsByContext(
+ reportConfig.metricsByContext,
+ {
+ isRealtime: isRealTimeDashboard(dashboardState),
+ isDetailed: false,
+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),
+ isRevenueAvailable: false
+ }
+ )
+
+ function switchTab(tab: TabKey) {
+ storage.setItem(storageKey, tab)
+ setTab(tab)
+ }
+
+ const moreLinkState = currentData
+ ? currentData.results.length > 0
+ ? MoreLinkState.READY
+ : MoreLinkState.HIDDEN
+ : MoreLinkState.LOADING
+
+ return (
+ <ReportLayout testId="report-devices" className="overflow-x-hidden">
+ <ReportHeader>
+ <div className="flex gap-x-3">
+ <TabWrapper>
+ {(
+ [
+ { label: 'Browsers', value: BreakdownReportKey.browsers },
+ {
+ label: 'Operating systems',
+ value: BreakdownReportKey.operatingSystems
+ },
+ { label: 'Devices', value: BreakdownReportKey.screenSizes }
+ ] as const
+ ).map(({ label, value }) => (
+ <TabButton
+ key={value}
+ active={tab === value}
+ onClick={() => switchTab(value)}
+ >
+ {label}
+ </TabButton>
+ ))}
+ </TabWrapper>
+ <ImportedWarningBubble queryApiResponse={currentData} />
+ </div>
+ <MoreLink
+ state={moreLinkState}
+ linkProps={{
+ path: reportConfig.detailsPath,
+ search: (search: string) => search
+ }}
+ />
+ </ReportHeader>
+ <IndexBreakdown
+ metrics={metrics}
+ dimensions={reportConfig.dimensions}
+ dimensionLabel={reportConfig.dimensionLabel}
+ DimensionElement={DimensionElement}
+ onDataReady={setCurrentData}
+ getFilterInfo={
+ reportKey === BreakdownReportKey.screenSizes
+ ? getScreenFilterInfo
+ : undefined
+ }
+ />
+ </ReportLayout>
+ )
+}
+
+const BrowsersDimensionCell = (props: DimensionCellWithBarProps) => (
+ <DimensionCellWithBar
+ {...props}
+ barClassName={BAR_COLOR}
+ text={props.row.dimensions[0]}
+ icon={<BrowserIcon dimensionValue={props.row.dimensions[0]} />}
+ />
+)
+
+const BrowserVersionsDimensionCell = (props: DimensionCellWithBarProps) => (
+ <DimensionCellWithBar
+ {...props}
+ barClassName={BAR_COLOR}
+ text={formatTwoDimensionsText(props.row)}
+ icon={<BrowserIcon dimensionValue={props.row.dimensions[1]} />}
+ />
+)
+
+const OperatingSystemsDimensionCell = (props: DimensionCellWithBarProps) => (
+ <DimensionCellWithBar
+ {...props}
+ barClassName={BAR_COLOR}
+ text={props.row.dimensions[0]}
+ icon={<OsIcon dimensionValue={props.row.dimensions[0]} />}
+ />
+)
+
+const OperatingSystemVersionsDimensionCell = (
+ props: DimensionCellWithBarProps
+) => (
+ <DimensionCellWithBar
+ {...props}
+ barClassName={BAR_COLOR}
+ text={formatTwoDimensionsText(props.row)}
+ icon={<OsIcon dimensionValue={props.row.dimensions[1]} />}
+ />
+)
+
+const ScreenSizesDimensionCell = (props: DimensionCellWithBarProps) => (
+ <DimensionCellWithBar
+ {...props}
+ barClassName={BAR_COLOR}
+ text={props.row.dimensions[0]}
+ icon={<ScreenSizeIcon dimensionValue={props.row.dimensions[0]} />}
+ />
+)
+
+const formatTwoDimensionsText = (row: QueryResultRow) =>
+ row.dimensions[0] === '(not set)' && row.dimensions[1] === '(not set)'
+ ? '(not set)'
+ : `${row.dimensions[1]} ${row.dimensions[0]}`
+
+export const getScreenFilterInfo = (
+ _dimension: string,
+ row: QueryResultRow
+): FilterInfo => ({
+ filter: ['is', 'screen', [row.dimensions[0]]],
+ prefix: 'screen'
+})
+
+function getReportKey(tab: TabKey, dashboardState: DashboardState): ReportKey {
+ switch (tab) {
+ case BreakdownReportKey.browsers:
+ return isFilteringOnFixedValue(dashboardState, 'browser')
+ ? BreakdownReportKey.browserVersions
+ : BreakdownReportKey.browsers
+ case BreakdownReportKey.operatingSystems:
+ return isFilteringOnFixedValue(dashboardState, 'os')
+ ? BreakdownReportKey.operatingSystemVersions
+ : BreakdownReportKey.operatingSystems
+ case BreakdownReportKey.screenSizes:
+ return BreakdownReportKey.screenSizes
+ }
+}
+
+type TabKey =
+ | BreakdownReportKey.browsers
+ | BreakdownReportKey.operatingSystems
+ | BreakdownReportKey.screenSizes
+
+type ReportKey =
+ | TabKey
+ | BreakdownReportKey.browserVersions
+ | BreakdownReportKey.operatingSystemVersions
+
+const initTab = (storedTab: string): TabKey => {
+ switch (storedTab) {
+ case LegacyTabKey.operatingSystems:
+ case BreakdownReportKey.operatingSystems:
+ return BreakdownReportKey.operatingSystems
+ case LegacyTabKey.screenSizes:
+ case BreakdownReportKey.screenSizes:
+ return BreakdownReportKey.screenSizes
+ case LegacyTabKey.browsers:
+ case BreakdownReportKey.browsers:
+ default:
+ return BreakdownReportKey.browsers
+ }
+}
+
+enum LegacyTabKey {
+ browsers = 'browser',
+ operatingSystems = 'os',
+ screenSizes = 'size'
+}
diff --git a/assets/js/dashboard/stats/modals/breakdown-modal.test.tsx b/assets/js/dashboard/stats/modals/breakdown-modal-legacy.test.tsx
similarity index 58%
rename from assets/js/dashboard/stats/modals/breakdown-modal.test.tsx
rename to assets/js/dashboard/stats/modals/breakdown-modal-legacy.test.tsx
index 46d50a57f4..c91d055dad 100644
--- a/assets/js/dashboard/stats/modals/breakdown-modal.test.tsx
+++ b/assets/js/dashboard/stats/modals/breakdown-modal-legacy.test.tsx
@@ -1,10 +1,22 @@
import React, { useState, Dispatch, SetStateAction } from 'react'
import { act, render, screen } from '@testing-library/react'
import { TestContextProviders } from '../../../../test-utils/app-context-providers'
-import BrowsersModal from './devices/browsers-modal'
+import BreakdownModal from './breakdown-modal-legacy'
+import Modal from './modal'
+import { createVisitors } from '../reports/metrics'
import { MockAPI } from '../../../../test-utils/mock-api'
const domain = 'dummy.site'
+const endpoint = `/api/stats/${domain}/test-dimension/`
+
+const reportInfo = {
+ title: 'Test breakdown',
+ endpoint,
+ dimensionLabel: 'Test',
+ defaultOrder: ['visitors', 'desc'] as ['visitors', 'desc']
+}
+
+const metrics = [createVisitors({ renderLabel: () => 'Visitors' })]
let mockAPI: MockAPI
@@ -37,17 +49,22 @@ describe('BreakdownModal', () => {
meta: { date_range_label: 'Last 30 days', metric_warnings: undefined }
}
- const browsersHandler = mockAPI.get(
- `/api/stats/${domain}/browsers/`,
- response
- )
+ const handler = mockAPI.get(endpoint, response)
let setOpen: Dispatch<SetStateAction<boolean>>
function ToggleableModal() {
const [open, s] = useState(false)
setOpen = s
- return open ? <BrowsersModal /> : null
+ return open ? (
+ <Modal>
+ <BreakdownModal
+ reportInfo={reportInfo}
+ metrics={metrics}
+ getFilterInfo={() => null}
+ />
+ </Modal>
+ ) : null
}
render(
@@ -56,11 +73,11 @@ describe('BreakdownModal', () => {
</TestContextProviders>
)
- expect(browsersHandler).toHaveBeenCalledTimes(0)
+ expect(handler).toHaveBeenCalledTimes(0)
act(() => setOpen(true))
- expect(screen.getByText('Browsers')).toBeVisible()
- expect(browsersHandler).toHaveBeenCalledTimes(1)
- expect(browsersHandler).toHaveBeenNthCalledWith(
+ expect(screen.getByText('Test breakdown')).toBeVisible()
+ expect(handler).toHaveBeenCalledTimes(1)
+ expect(handler).toHaveBeenNthCalledWith(
1,
expect.stringContaining(
'order_by=%5B%5B%22visitors%22%2C%22desc%22%5D%5D&limit=100&page=1'
@@ -69,10 +86,10 @@ describe('BreakdownModal', () => {
)
act(() => setOpen(false))
- expect(screen.queryByText('Browsers')).not.toBeInTheDocument()
+ expect(screen.queryByText('Test breakdown')).not.toBeInTheDocument()
act(() => setOpen(true))
- expect(screen.getByText('Browsers')).toBeVisible()
+ expect(screen.getByText('Test breakdown')).toBeVisible()
- expect(browsersHandler).toHaveBeenCalledTimes(1)
+ expect(handler).toHaveBeenCalledTimes(1)
})
})
diff --git a/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js b/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js
deleted file mode 100644
index a24a06754a..0000000000
--- a/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js
+++ /dev/null
@@ -1,63 +0,0 @@
-import React, { useCallback } from 'react'
-import Modal from './../modal'
-import { addFilter } from '../../../dashboard-state'
-import BreakdownModal from '../breakdown-modal-legacy'
-import * as url from '../../../util/url'
-import { useDashboardStateContext } from '../../../dashboard-state-context'
-import { useSiteContext } from '../../../site-context'
-import { browserIconFor } from '../../devices'
-import chooseMetrics from './choose-metrics'
-
-function BrowserVersionsModal() {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
-
- const reportInfo = {
- title: 'Browser versions',
- dimension: 'browser_version',
- endpoint: url.apiPath(site, '/browser-versions'),
- dimensionLabel: 'Browser version',
- defaultOrder: ['visitors', 'desc']
- }
-
- const getFilterInfo = useCallback(
- (listItem) => {
- return {
- prefix: reportInfo.dimension,
- filter: ['is', reportInfo.dimension, [listItem.name]]
- }
- },
- [reportInfo.dimension]
- )
-
- const addSearchFilter = useCallback(
- (dashboardState, searchString) => {
- return addFilter(dashboardState, [
- 'contains',
- reportInfo.dimension,
- [searchString],
- { case_sensitive: false }
- ])
- },
- [reportInfo.dimension]
- )
-
- const renderIcon = useCallback(
- (listItem) => browserIconFor(listItem.browser),
- []
- )
-
- return (
- <Modal>
- <BreakdownModal
- reportInfo={reportInfo}
- metrics={chooseMetrics(dashboardState, site)}
- getFilterInfo={getFilterInfo}
- addSearchFilter={addSearchFilter}
- renderIcon={renderIcon}
- />
- </Modal>
- )
-}
-
-export default BrowserVersionsModal
diff --git a/assets/js/dashboard/stats/modals/devices/browsers-modal.js b/assets/js/dashboard/stats/modals/devices/browsers-modal.js
deleted file mode 100644
index 09ce75ae16..0000000000
--- a/assets/js/dashboard/stats/modals/devices/browsers-modal.js
+++ /dev/null
@@ -1,63 +0,0 @@
-import React, { useCallback } from 'react'
-import Modal from './../modal'
-import { addFilter } from '../../../dashboard-state'
-import BreakdownModal from '../breakdown-modal-legacy'
-import * as url from '../../../util/url'
-import { useDashboardStateContext } from '../../../dashboard-state-context'
-import { useSiteContext } from '../../../site-context'
-import { browserIconFor } from '../../devices'
-import chooseMetrics from './choose-metrics'
-
-function BrowsersModal() {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
-
- const reportInfo = {
- title: 'Browsers',
- dimension: 'browser',
- endpoint: url.apiPath(site, '/browsers'),
- dimensionLabel: 'Browser',
- defaultOrder: ['visitors', 'desc']
- }
-
- const getFilterInfo = useCallback(
- (listItem) => {
- return {
- prefix: reportInfo.dimension,
- filter: ['is', reportInfo.dimension, [listItem.name]]
- }
- },
- [reportInfo.dimension]
- )
-
- const addSearchFilter = useCallback(
- (dashboardState, searchString) => {
- return addFilter(dashboardState, [
- 'contains',
- reportInfo.dimension,
- [searchString],
- { case_sensitive: false }
- ])
- },
- [reportInfo.dimension]
- )
-
- const renderIcon = useCallback(
- (listItem) => browserIconFor(listItem.name),
- []
- )
-
- return (
- <Modal>
- <BreakdownModal
- reportInfo={reportInfo}
- metrics={chooseMetrics(dashboardState, site)}
- getFilterInfo={getFilterInfo}
- addSearchFilter={addSearchFilter}
- renderIcon={renderIcon}
- />
- </Modal>
- )
-}
-
-export default BrowsersModal
diff --git a/assets/js/dashboard/stats/modals/devices/choose-metrics.js b/assets/js/dashboard/stats/modals/devices/choose-metrics.js
deleted file mode 100644
index d50696298b..0000000000
--- a/assets/js/dashboard/stats/modals/devices/choose-metrics.js
+++ /dev/null
@@ -1,45 +0,0 @@
-import {
- hasConversionGoalFilter,
- isRealTimeDashboard
-} from '../../../util/filters'
-import { revenueAvailable } from '../../../dashboard-state'
-import * as metrics from '../../reports/metrics'
-
-export default function chooseMetrics(dashboardState, site) {
- /*global BUILD_EXTRA*/
- const showRevenueMetrics =
- BUILD_EXTRA && revenueAvailable(dashboardState, site)
-
- if (hasConversionGoalFilter(dashboardState)) {
- return [
- metrics.createTotalVisitors(),
- metrics.createVisitors({
- renderLabel: (_dashboardState) => 'Conversions',
- width: 'w-32 md:w-28'
- }),
- metrics.createConversionRate(),
- showRevenueMetrics && metrics.createTotalRevenue(),
- showRevenueMetrics && metrics.createAverageRevenue()
- ].filter((metric) => !!metric)
- }
-
- if (
- isRealTimeDashboard(dashboardState) &&
- !hasConversionGoalFilter(dashboardState)
- ) {
- return [
- metrics.createVisitors({
- renderLabel: (_dashboardState) => 'Current visitors',
- width: 'w-32'
- }),
- metrics.createPercentage()
- ]
- }
-
- return [
- metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),
- metrics.createPercentage(),
- metrics.createBounceRate(),
- metrics.createVisitDuration()
- ]
-}
diff --git a/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js b/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js
deleted file mode 100644
index fd53af221a..0000000000
--- a/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js
+++ /dev/null
@@ -1,60 +0,0 @@
-import React, { useCallback } from 'react'
-import Modal from './../modal'
-import { addFilter } from '../../../dashboard-state'
-import BreakdownModal from '../breakdown-modal-legacy'
-import * as url from '../../../util/url'
-import { useDashboardStateContext } from '../../../dashboard-state-context'
-import { useSiteContext } from '../../../site-context'
-import { osIconFor } from '../../devices'
-import chooseMetrics from './choose-metrics'
-
-function OperatingSystemVersionsModal() {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
-
- const reportInfo = {
- title: 'Operating system versions',
- dimension: 'os_version',
- endpoint: url.apiPath(site, '/operating-system-versions'),
- dimensionLabel: 'Operating system version',
- defaultOrder: ['visitors', 'desc']
- }
-
- const getFilterInfo = useCallback(
- (listItem) => {
- return {
- prefix: reportInfo.dimension,
- filter: ['is', reportInfo.dimension, [listItem.name]]
- }
- },
- [reportInfo.dimension]
- )
-
- const addSearchFilter = useCallback(
- (dashboardState, searchString) => {
- return addFilter(dashboardState, [
- 'contains',
- reportInfo.dimension,
- [searchString],
- { case_sensitive: false }
- ])
- },
- [reportInfo.dimension]
- )
-
- const renderIcon = useCallback((listItem) => osIconFor(listItem.os), [])
-
- return (
- <Modal>
- <BreakdownModal
- reportInfo={reportInfo}
- metrics={chooseMetrics(dashboardState, site)}
- getFilterInfo={getFilterInfo}
- addSearchFilter={addSearchFilter}
- renderIcon={renderIcon}
- />
- </Modal>
- )
-}
-
-export default OperatingSystemVersionsModal
diff --git a/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js b/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js
deleted file mode 100644
index 1e5000b5a3..0000000000
--- a/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js
+++ /dev/null
@@ -1,60 +0,0 @@
-import React, { useCallback } from 'react'
-import Modal from './../modal'
-import { addFilter } from '../../../dashboard-state'
-import BreakdownModal from '../breakdown-modal-legacy'
-import * as url from '../../../util/url'
-import { useDashboardStateContext } from '../../../dashboard-state-context'
-import { useSiteContext } from '../../../site-context'
-import { osIconFor } from '../../devices'
-import chooseMetrics from './choose-metrics'
-
-function OperatingSystemsModal() {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
-
- const reportInfo = {
- title: 'Operating systems',
- dimension: 'os',
- endpoint: url.apiPath(site, '/operating-systems'),
- dimensionLabel: 'Operating system',
- defaultOrder: ['visitors', 'desc']
- }
-
- const getFilterInfo = useCallback(
- (listItem) => {
- return {
- prefix: reportInfo.dimension,
- filter: ['is', reportInfo.dimension, [listItem.name]]
- }
- },
- [reportInfo.dimension]
- )
-
- const addSearchFilter = useCallback(
- (dashboardState, searchString) => {
- return addFilter(dashboardState, [
- 'contains',
- reportInfo.dimension,
- [searchString],
- { case_sensitive: false }
- ])
- },
- [reportInfo.dimension]
- )
-
- const renderIcon = useCallback((listItem) => osIconFor(listItem.name), [])
-
- return (
- <Modal>
- <BreakdownModal
- reportInfo={reportInfo}
- metrics={chooseMetrics(dashboardState, site)}
- getFilterInfo={getFilterInfo}
- addSearchFilter={addSearchFilter}
- renderIcon={renderIcon}
- />
- </Modal>
- )
-}
-
-export default OperatingSystemsModal
diff --git a/assets/js/dashboard/stats/modals/devices/screen-sizes.js b/assets/js/dashboard/stats/modals/devices/screen-sizes.js
deleted file mode 100644
index 499c880d48..0000000000
--- a/assets/js/dashboard/stats/modals/devices/screen-sizes.js
+++ /dev/null
@@ -1,50 +0,0 @@
-import React, { useCallback } from 'react'
-import Modal from './../modal'
-import BreakdownModal from '../breakdown-modal-legacy'
-import * as url from '../../../util/url'
-import { useDashboardStateContext } from '../../../dashboard-state-context'
-import { useSiteContext } from '../../../site-context'
-import { screenSizeIconFor } from '../../devices'
-import chooseMetrics from './choose-metrics'
-
-function ScreenSizesModal() {
- const { dashboardState } = useDashboardStateContext()
- const site = useSiteContext()
-
- const reportInfo = {
- title: 'Devices',
- dimension: 'screen',
- endpoint: url.apiPath(site, '/screen-sizes'),
- dimensionLabel: 'Device',
- defaultOrder: ['visitors', 'desc']
- }
-
- const getFilterInfo = useCallback(
- (listItem) => {
- return {
- prefix: reportInfo.dimension,
- filter: ['is', reportInfo.dimension, [listItem.name]]
- }
- },
- [reportInfo.dimension]
- )
-
- const renderIcon = useCallback(
- (listItem) => screenSizeIconFor(listItem.name),
- []
- )
-
- return (
- <Modal>
- <BreakdownModal
- reportInfo={reportInfo}
- metrics={chooseMetrics(dashboardState, site)}
- getFilterInfo={getFilterInfo}
- searchEnabled={false}
- renderIcon={renderIcon}
- />
- </Modal>
- )
-}
-
-export default ScreenSizesModal
diff --git a/assets/js/dashboard/stats/pages/index.tsx b/assets/js/dashboard/stats/pages/index.tsx
index 5c88ddfdb6..3bbb3acac2 100644
--- a/assets/js/dashboard/stats/pages/index.tsx
+++ b/assets/js/dashboard/stats/pages/index.tsx
@@ -27,18 +27,6 @@ import { chooseBreakdownMetricsByContext } from '../breakdowns'
import { externalLinkForPage, trimURL } from '../../util/url'
import { IndexExternalLink } from './external-link'
-type Mode = Extract<BreakdownReportKey, 'pages' | 'entryPages' | 'exitPages'>
-
-const initMode = (storedMode: string): Mode => {
- if (['entry-pages', BreakdownReportKey.entryPages].includes(storedMode)) {
- return BreakdownReportKey.entryPages
- }
- if (['exit-pages', BreakdownReportKey.exitPages].includes(storedMode)) {
- return BreakdownReportKey.exitPages
- }
- return BreakdownReportKey.pages
-}
-
const BAR_COLOR = 'bg-orange-50 group-hover/row:bg-orange-100'
const MAX_DIMENSION_LENGTH = 70
@@ -46,14 +34,15 @@ export default function Pages() {
const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
- const tabKey = `pageTab__${site.domain}`
- const [mode, setMode] = useState<Mode>(initMode(storage.getItem(tabKey)))
+ const storageKey = `pageTab__${site.domain}`
+ const [tab, setTab] = useState<TabKey>(initTab(storage.getItem(storageKey)))
const [currentData, setCurrentData] = useState<QueryApiResponse | null>(null)
- const currentModeReportConfig = BREAKDOWN_REPORTS[mode]
+ const reportKey = getReportKey(tab)
+ const reportConfig = BREAKDOWN_REPORTS[reportKey]
- const currentModeMetrics = chooseBreakdownMetricsByContext(
- currentModeReportConfig.metricsByContext,
+ const metrics = chooseBreakdownMetricsByContext(
+ reportConfig.metricsByContext,
{
isRealtime: isRealTimeDashboard(dashboardState),
isDetailed: false,
@@ -62,14 +51,14 @@ export default function Pages() {
}
)
- function switchTab(mode: Mode) {
- storage.setItem(tabKey, mode)
- setMode(mode)
+ function switchTab(tab: TabKey) {
+ storage.setItem(storageKey, tab)
+ setTab(tab)
}
function moreLinkProps() {
return {
- path: currentModeReportConfig.detailsPath,
+ path: reportConfig.detailsPath,
search: (search: string) => search
}
}
@@ -77,9 +66,9 @@ export default function Pages() {
function renderContent() {
return (
<IndexBreakdown
- metrics={currentModeMetrics}
- dimensions={currentModeReportConfig.dimensions}
- dimensionLabel={currentModeReportConfig.dimensionLabel}
+ metrics={metrics}
+ dimensions={reportConfig.dimensions}
+ dimensionLabel={reportConfig.dimensionLabel}
DimensionElement={PagesDimensionCell}
onDataReady={setCurrentData}
/>
@@ -111,7 +100,7 @@ export default function Pages() {
).map(({ value, label }) => (
<TabButton
key={value}
- active={mode === value}
+ active={tab === value}
onClick={() => switchTab(value)}
>
{label}
@@ -144,3 +133,31 @@ function PagesDimensionCell(props: DimensionCellWithBarProps) {
/>
)
}
+
+const initTab = (storedTab: string): TabKey => {
+ switch (storedTab) {
+ case LegacyTabKey.entryPages:
+ case BreakdownReportKey.entryPages:
+ return BreakdownReportKey.entryPages
+ case LegacyTabKey.exitPages:
+ case BreakdownReportKey.exitPages:
+ return BreakdownReportKey.exitPages
+ case BreakdownReportKey.pages:
+ default:
+ return BreakdownReportKey.pages
+ }
+}
+
+const getReportKey = (tab: TabKey): ReportKey => tab
+
+type TabKey =
+ | BreakdownReportKey.pages
+ | BreakdownReportKey.entryPages
+ | BreakdownReportKey.exitPages
+
+type ReportKey = TabKey
+
+enum LegacyTabKey {
+ entryPages = 'entry-pages',
+ exitPages = 'exit-pages'
+}
diff --git a/assets/js/dashboard/stats/reports/reports-config.ts b/assets/js/dashboard/stats/reports/reports-config.ts
index ef1c7a8c6a..de048724a8 100644
--- a/assets/js/dashboard/stats/reports/reports-config.ts
+++ b/assets/js/dashboard/stats/reports/reports-config.ts
@@ -37,7 +37,12 @@ const COMMON_METRICS_BY_CONTEXT: MetricsByContext = {
export enum BreakdownReportKey {
'pages' = 'pages',
'entryPages' = 'entryPages',
- 'exitPages' = 'exitPages'
+ 'exitPages' = 'exitPages',
+ 'browsers' = 'browsers',
+ 'browserVersions' = 'browserVersions',
+ 'operatingSystems' = 'operatingSystems',
+ 'operatingSystemVersions' = 'operatingSystemVersions',
+ 'screenSizes' = 'screenSizes'
}
export const BREAKDOWN_REPORTS: Record<
@@ -86,5 +91,40 @@ export const BREAKDOWN_REPORTS: Record<
detailsTitle: 'Exit pages',
detailsPath: 'exit-pages',
dimensionLabel: 'Exit page'
+ },
+ [BreakdownReportKey.browsers]: {
+ dimensions: ['visit:browser'],
+ metricsByContext: COMMON_METRICS_BY_CONTEXT,
+ detailsTitle: 'Browsers',
+ detailsPath: 'browsers',
+ dimensionLabel: 'Browser'
+ },
+ [BreakdownReportKey.browserVersions]: {
+ dimensions: ['visit:browser_version', 'visit:browser'],
+ metricsByContext: COMMON_METRICS_BY_CONTEXT,
+ detailsTitle: 'Browser versions',
+ detailsPath: 'browser-versions',
+ dimensionLabel: 'Browser version'
+ },
+ [BreakdownReportKey.operatingSystems]: {
+ dimensions: ['visit:os'],
+ metricsByContext: COMMON_METRICS_BY_CONTEXT,
+ detailsTitle: 'Operating systems',
+ detailsPath: 'operating-systems',
+ dimensionLabel: 'Operating system'
+ },
+ [BreakdownReportKey.operatingSystemVersions]: {
+ dimensions: ['visit:os_version', 'visit:os'],
+ metricsByContext: COMMON_METRICS_BY_CONTEXT,
+ detailsTitle: 'Operating system versions',
+ detailsPath: 'operating-system-versions',
+ dimensionLabel: 'Operating system version'
+ },
+ [BreakdownReportKey.screenSizes]: {
+ dimensions: ['visit:device'],
+ metricsByContext: COMMON_METRICS_BY_CONTEXT,
+ detailsTitle: 'Devices',
+ detailsPath: 'screen-sizes',
+ dimensionLabel: 'Device'
}
}
diff --git a/test/plausible_web/controllers/api/stats_controller/screen_sizes_legacy_test.exs b/test/plausible_web/controllers/api/stats_controller/screen_sizes_legacy_test.exs
new file mode 100644
index 0000000000..64100328b4
--- /dev/null
+++ b/test/plausible_web/controllers/api/stats_controller/screen_sizes_legacy_test.exs
@@ -0,0 +1,439 @@
+defmodule PlausibleWeb.Api.StatsController.ScreenSizesLegacyTest do
+ @moduledoc """
+ [DEPRECATED] Still used for CSV export but to be removed.
+ """
+ use PlausibleWeb.ConnCase
+
+ describe "GET /api/stats/:domain/screen-sizes" do
+ setup [:create_user, :log_in, :create_site, :create_legacy_site_import]
+
+ test "returns screen sizes by new visitors", %{conn: conn, site: site} do
+ populate_stats(site, [
+ build(:pageview, screen_size: "Desktop"),
+ build(:pageview, screen_size: "Desktop"),
+ build(:pageview, screen_size: "Laptop")
+ ])
+
+ conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day")
+
+ assert json_response(conn, 200)["results"] == [
+ %{"name" => "Desktop", "visitors" => 2, "percentage" => 66.67},
+ %{"name" => "Laptop", "visitors" => 1, "percentage" => 33.33}
+ ]
+ end
+
+ test "returns bounce_rate and visit_duration when detailed=true", %{conn: conn, site: site} do
+ populate_stats(site, [
+ build(:pageview,
+ user_id: 123,
+ timestamp: ~N[2021-01-01 12:00:00],
+ screen_size: "Desktop"
+ ),
+ build(:pageview,
+ user_id: 123,
+ timestamp: ~N[2021-01-01 12:10:00],
+ screen_size: "Desktop"
+ ),
+ build(:pageview, timestamp: ~N[2021-01-01 12:00:00], screen_size: "Desktop"),
+ build(:pageview, timestamp: ~N[2021-01-01 12:00:00], screen_size: "Laptop")
+ ])
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/screen-sizes?period=day&date=2021-01-01&detailed=true"
+ )
+
+ assert json_response(conn, 200)["results"] == [
+ %{
+ "name" => "Desktop",
+ "visitors" => 2,
+ "bounce_rate" => 50,
+ "visit_duration" => 300,
+ "percentage" => 66.67
+ },
+ %{
+ "name" => "Laptop",
+ "visitors" => 1,
+ "bounce_rate" => 100,
+ "visit_duration" => 0,
+ "percentage" => 33.33
+ }
+ ]
+ end
+
+ test "returns screen sizes for user making multiple sessions", %{conn: conn, site: site} do
+ populate_stats(site, [
+ build(:pageview,
+ user_id: 1,
+ screen_size: "Desktop",
+ timestamp: ~N[2021-01-01 00:00:00]
+ ),
+ build(:pageview,
+ user_id: 1,
+ screen_size: "Laptop",
+ timestamp: ~N[2021-01-01 05:00:00]
+ )
+ ])
+
+ conn =
+ get(conn, "/api/stats/#{site.domain}/screen-sizes", %{
+ "period" => "day",
+ "date" => "2021-01-01"
+ })
+
+ assert json_response(conn, 200)["results"] == [
+ %{"name" => "Desktop", "visitors" => 1, "percentage" => 100},
+ %{"name" => "Laptop", "visitors" => 1, "percentage" => 100}
+ ]
+ end
+
+ test "returns (not set) when appropriate", %{conn: conn, site: site} do
+ populate_stats(site, [
+ build(:pageview,
+ screen_size: ""
+ ),
+ build(:pageview,
+ screen_size: "Desktop"
+ )
+ ])
+
+ conn1 = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day")
+
+ assert json_response(conn1, 200)["results"] == [
+ %{"name" => "(not set)", "visitors" => 1, "percentage" => 50},
+ %{"name" => "Desktop", "visitors" => 1, "percentage" => 50}
+ ]
+
+ filters = Jason.encode!([[:is, "visit:screen", ["(not set)"]]])
+ conn2 = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+
+ assert json_response(conn2, 200)["results"] == [
+ %{"name" => "(not set)", "visitors" => 1, "percentage" => 100}
+ ]
+ end
+
+ test "select empty imported_devices as (not set), merging with the native (not set)", %{
+ conn: conn,
+ site: site
+ } do
+ populate_stats(site, [
+ build(:pageview, user_id: 123),
+ build(:imported_devices, visitors: 1),
+ build(:imported_visitors, visitors: 1)
+ ])
+
+ conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&with_imported=true")
+
+ assert json_response(conn, 200)["results"] == [
+ %{"name" => "(not set)", "visitors" => 2, "percentage" => 100.0}
+ ]
+ end
+
+ test "returns screen sizes with :is filter on custom pageview props", %{
+ conn: conn,
+ site: site
+ } do
+ populate_stats(site, [
+ build(:pageview,
+ user_id: 123,
+ screen_size: "Desktop"
+ ),
+ build(:pageview,
+ user_id: 123,
+ screen_size: "Desktop",
+ "meta.key": ["author"],
+ "meta.value": ["John Doe"]
+ ),
+ build(:pageview,
+ screen_size: "Mobile",
+ "meta.key": ["author"],
+ "meta.value": ["other"]
+ ),
+ build(:pageview,
+ screen_size: "Tablet"
+ )
+ ])
+
+ filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])
+ conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+
+ assert json_response(conn, 200)["results"] == [
+ %{"name" => "Desktop", "visitors" => 1, "percentage" => 100}
+ ]
+ end
+
+ test "returns screen sizes with :is_not filter on custom pageview props", %{
+ conn: conn,
+ site: site
+ } do
+ populate_stats(site, [
+ build(:pageview,
+ user_id: 123,
+ screen_size: "Desktop",
+ "meta.key": ["author"],
+ "meta.value": ["John Doe"]
+ ),
+ build(:pageview,
+ user_id: 123,
+ screen_size: "Desktop",
+ "meta.key": ["author"],
+ "meta.value": ["John Doe"]
+ ),
+ build(:pageview,
+ screen_size: "Mobile",
+ "meta.key": ["author"],
+ "meta.value": ["other"]
+ ),
+ build(:pageview,
+ screen_size: "Tablet"
+ )
+ ])
+
+ filters = Jason.encode!([["is_not", "event:props:author", ["John Doe"]]])
+ conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+
+ assert json_response(conn, 200)["results"] == [
+ %{"name" => "Mobile", "visitors" => 1, "percentage" => 50},
+ %{"name" => "Tablet", "visitors" => 1, "percentage" => 50}
+ ]
+ end
+
+ test "returns screen sizes by new visitors with imported data", %{conn: conn, site: site} do
+ populate_stats(site, [
+ build(:pageview, screen_size: "Desktop"),
+ build(:pageview, screen_size: "Desktop"),
+ build(:pageview, screen_size: "Laptop")
+ ])
+
+ populate_stats(site, [
+ build(:imported_devices, device: "Mobile"),
+ build(:imported_devices, device: "Laptop"),
+ build(:imported_visitors, visitors: 2)
+ ])
+
+ conn1 = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day")
+
+ assert json_response(conn1, 200)["results"] == [
+ %{"name" => "Desktop", "visitors" => 2, "percentage" => 66.67},
+ %{"name" => "Laptop", "visitors" => 1, "percentage" => 33.33}
+ ]
+
+ conn2 = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&with_imported=true")
+
+ assert json_response(conn2, 200)["results"] == [
+ %{"name" => "Desktop", "visitors" => 2, "percentage" => 40},
+ %{"name" => "Laptop", "visitors" => 2, "percentage" => 40},
+ %{"name" => "Mobile", "visitors" => 1, "percentage" => 20}
+ ]
+ end
+
+ test "returns screen sizes when filtering by imported screen size", %{conn: conn, site: site} do
+ populate_stats(site, [
+ build(:pageview, screen_size: "Desktop"),
+ build(:imported_devices, device: "Desktop"),
+ build(:imported_devices, device: "Laptop"),
+ build(:imported_visitors, visitors: 2)
+ ])
+
+ filters = Jason.encode!([[:is, "visit:screen", ["Desktop"]]])
+
+ conn =
+ get(
+ conn,
+ "/api/stats/#{site.domain}/screen-sizes?filters=#{filters}&period=day&with_imported=true"
+ )
+
+ assert json_response(conn, 200)["results"] == [
+ %{"name" => "Desktop", "visitors" => 2, "percentage" => 100.0}
+ ]
+ end
+
+ test "returns screen sizes for user making multiple sessions by no of visitors with imported data",
+ %{conn: conn, site: site} do
+ populate_stats(site, [
+ build(:pageview,
+ user_id: 1,
+ screen_size: "Desktop",
+ timestamp: ~N[2021-01-01 00:00:00]
+ ),
+ build(:pageview,
+ user_id: 1,
+ screen_size: "Laptop",
+ timestamp: ~N[2021-01-01 05:00:00]
+ )
+ ])
+
+ populate_stats(site, [
+ build(:imported_devices, device: "Desktop", date: ~D[2021-01-01]),
+ build(:imported_devices, device: "Laptop", date: ~D[2021-01-01]),
+ build(:imported_visitors, visitors: 1, date: ~D[2021-01-01])
+ ])
+
+ conn =
+ get(conn, "/api/stats/#{site.domain}/screen-sizes", %{
+ "period" => "day",
+ "date" => "2021-01-01",
+ "with_imported" => "true"
+ })
+
+ assert json_response(conn, 200)["results"] == [
+ %{"name" => "Desktop", "visitors" => 2, "percentage" => 100},
+ %{"name" => "Laptop", "visitors" => 2, "percentage" => 100}
+ ]
+ end
+
+ test "calculates conversion_rate when filtering for goal", %{conn: conn, site: site} do
+ insert(:goal, site: site, event_name: "Signup")
+
+ populate_stats(site, [
+ build(:pageview, user_id: 1, screen_size: "Desktop"),
+ build(:pageview, user_id: 2, screen_size: "Desktop"),
+ build(:event, user_id: 1, name: "Signup")
+ ])
+
+ filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])
+
+ conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+
+ assert json_response(conn, 200)["results"] == [
+ %{
+ "name" => "Desktop",
+ "total_visitors" => 2,
+ "visitors" => 1,
+ "conversion_rate" => 50.0
+ }
+ ]
+ end
+
+ test "returns screen sizes with not_member filter type", %{conn: conn, site: site} do
+ populate_stats(site, [
+ build(:pageview, referrer_source: "Google", screen_size: "Desktop"),
+ build(:pageview, referrer_source: "Bad source", screen_size: "Desktop"),
+ build(:pageview, referrer_source: "Google", screen_size: "Desktop"),
+ build(:pageview, referrer_source: "Twitter", screen_size: "Mobile"),
+ build(:pageview,
+ referrer_source: "Second bad source",
+ screen_size: "Mobile"
+ )
+ ])
+
+ filters = Jason.encode!([["is_not", "visit:source", ["Bad source", "Second bad source"]]])
+
+ conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+
+ assert json_response(conn, 200)["results"] == [
+ %{"name" => "Desktop", "visitors" => 2, "percentage" => 66.67},
+ %{"name" => "Mobile", "visitors" => 1, "percentage" => 33.33}
+ ]
+ end
+
+ @tag :ee_only
+ test "return revenue metrics for screen sizes breakdown", %{conn: conn, site: site} do
+ populate_stats(site, [
+ build(:pageview, user_id: 1, screen_size: "Mobile"),
+ build(:event,
+ name: "Payment",
+ user_id: 1,
+ revenue_reporting_amount: Decimal.new("1000"),
+ revenue_reporting_currency: "USD"
+ ),
+ build(:pageview, user_id: 2, screen_size: "Mobile"),
+ build(:event,
+ name: "Payment",
+ user_id: 2,
+ revenue_reporting_amount: Decimal.new("2000"),
+ revenue_reporting_currency: "USD"
+ ),
+ build(:pageview, user_id: 3, screen_size: "Mobile"),
+ build(:pageview, user_id: 4, screen_size: "Desktop"),
+ build(:event,
+ name: "Payment",
+ user_id: 4,
+ revenue_reporting_amount: Decimal.new("500"),
+ revenue_reporting_currency: "USD"
+ ),
+ build(:pageview, user_id: 5, screen_size: "Desktop"),
+ build(:pageview, user_id: 6),
+ build(:event,
+ name: "Payment",
+ user_id: 6,
+ revenue_reporting_amount: Decimal.new("600"),
+ revenue_reporting_currency: "USD"
+ ),
+ build(:pageview, user_id: 7),
+ build(:event,
+ name: "Payment",
+ user_id: 7,
+ revenue_reporting_amount: nil
+ )
+ ])
+
+ insert(:goal, %{site: site, event_name: "Payment", currency: :USD})
+
+ filters = Jason.encode!([[:is, "event:goal", ["Payment"]]])
+ order_by = Jason.encode!([["visitors", "desc"]])
+
+ q = "?filters=#{filters}&order_by=#{order_by}&detailed=true&period=day&page=1&limit=100"
+
+ conn = get(conn, "/api/stats/#{site.domain}/screen-sizes#{q}")
+
+ assert json_response(conn, 200)["results"] == [
+ %{
+ "average_revenue" => %{
+ "currency" => "USD",
+ "long" => "$600.00",
+ "short" => "$600.0",
+ "value" => 600.0
+ },
+ "conversion_rate" => 100.0,
+ "name" => "(not set)",
+ "total_revenue" => %{
+ "currency" => "USD",
+ "long" => "$600.00",
+ "short" => "$600.0",
+ "value" => 600.0
+ },
+ "total_visitors" => 2,
+ "visitors" => 2
+ },
+ %{
+ "average_revenue" => %{
+ "currency" => "USD",
+ "long" => "$1,500.00",
+ "short" => "$1.5K",
+ "value" => 1500.0
+ },
+ "conversion_rate" => 66.67,
+ "name" => "Mobile",
+ "total_revenue" => %{
+ "currency" => "USD",
+ "long" => "$3,000.00",
+ "short" => "$3.0K",
+ "value" => 3000.0
+ },
+ "total_visitors" => 3,
+ "visitors" => 2
+ },
+ %{
+ "average_revenue" => %{
+ "currency" => "USD",
+ "long" => "$500.00",
+ "short" => "$500.0",
+ "value" => 500.0
+ },
+ "conversion_rate" => 50.0,
+ "name" => "Desktop",
+ "total_revenue" => %{
+ "currency" => "USD",
+ "long" => "$500.00",
+ "short" => "$500.0",
+ "value" => 500.0
+ },
+ "total_visitors" => 2,
+ "visitors" => 1
+ }
+ ]
+ end
+ end
+end
diff --git a/test/plausible_web/controllers/api/stats_controller/screen_sizes_test.exs b/test/plausible_web/controllers/api/stats_controller/screen_sizes_test.exs
index bf01a0ddb7..dade756c05 100644
--- a/test/plausible_web/controllers/api/stats_controller/screen_sizes_test.exs
+++ b/test/plausible_web/controllers/api/stats_controller/screen_sizes_test.exs
@@ -1,6 +1,22 @@
defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
use PlausibleWeb.ConnCase
+ defp query_screen_sizes(conn, site, opts) do
+ params = %{
+ "dimensions" => Keyword.get(opts, :dimensions, ["visit:device"]),
+ "date_range" => Keyword.get(opts, :date_range, "all"),
+ "filters" => Keyword.get(opts, :filters, []),
+ "metrics" => Keyword.get(opts, :metrics, ["visitors", "percentage"]),
+ "include" => Keyword.get(opts, :include, nil),
+ "pagination" => Keyword.get(opts, :pagination, nil),
+ "order_by" => Keyword.get(opts, :order_by, nil)
+ }
+
+ conn
+ |> post("/api/stats/#{site.domain}/query", params)
+ |> json_response(200)
+ end
+
describe "GET /api/stats/:domain/screen-sizes" do
setup [:create_user, :log_in, :create_site, :create_legacy_site_import]
@@ -11,11 +27,11 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
build(:pageview, screen_size: "Laptop")
])
- conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day")
+ response = query_screen_sizes(conn, site, date_range: "day")
- assert json_response(conn, 200)["results"] == [
- %{"name" => "Desktop", "visitors" => 2, "percentage" => 66.67},
- %{"name" => "Laptop", "visitors" => 1, "percentage" => 33.33}
+ assert response["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [2, 66.67]},
+ %{"dimensions" => ["Laptop"], "metrics" => [1, 33.33]}
]
end
@@ -35,27 +51,15 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
build(:pageview, timestamp: ~N[2021-01-01 12:00:00], screen_size: "Laptop")
])
- conn =
- get(
- conn,
- "/api/stats/#{site.domain}/screen-sizes?period=day&date=2021-01-01&detailed=true"
+ response =
+ query_screen_sizes(conn, site,
+ date_range: ["2021-01-01", "2021-01-01"],
+ metrics: ["visitors", "bounce_rate", "visit_duration", "percentage"]
)
- assert json_response(conn, 200)["results"] == [
- %{
- "name" => "Desktop",
- "visitors" => 2,
- "bounce_rate" => 50,
- "visit_duration" => 300,
- "percentage" => 66.67
- },
- %{
- "name" => "Laptop",
- "visitors" => 1,
- "bounce_rate" => 100,
- "visit_duration" => 0,
- "percentage" => 33.33
- }
+ assert response["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [2, 50, 300, 66.67]},
+ %{"dimensions" => ["Laptop"], "metrics" => [1, 100, 0, 33.33]}
]
end
@@ -73,15 +77,15 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
)
])
- conn =
- get(conn, "/api/stats/#{site.domain}/screen-sizes", %{
- "period" => "day",
- "date" => "2021-01-01"
- })
+ response =
+ query_screen_sizes(conn, site,
+ date_range: ["2021-01-01", "2021-01-01"],
+ order_by: [["visit:device", "asc"]]
+ )
- assert json_response(conn, 200)["results"] == [
- %{"name" => "Desktop", "visitors" => 1, "percentage" => 100},
- %{"name" => "Laptop", "visitors" => 1, "percentage" => 100}
+ assert response["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [1, 100.0]},
+ %{"dimensions" => ["Laptop"], "metrics" => [1, 100.0]}
]
end
@@ -95,18 +99,25 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
)
])
- conn1 = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day")
+ response1 =
+ query_screen_sizes(conn, site,
+ date_range: "day",
+ order_by: [["visit:device", "asc"]]
+ )
- assert json_response(conn1, 200)["results"] == [
- %{"name" => "(not set)", "visitors" => 1, "percentage" => 50},
- %{"name" => "Desktop", "visitors" => 1, "percentage" => 50}
+ assert response1["results"] == [
+ %{"dimensions" => ["(not set)"], "metrics" => [1, 50.0]},
+ %{"dimensions" => ["Desktop"], "metrics" => [1, 50.0]}
]
- filters = Jason.encode!([[:is, "visit:screen", ["(not set)"]]])
- conn2 = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+ response2 =
+ query_screen_sizes(conn, site,
+ date_range: "day",
+ filters: [["is", "visit:device", ["(not set)"]]]
+ )
- assert json_response(conn2, 200)["results"] == [
- %{"name" => "(not set)", "visitors" => 1, "percentage" => 100}
+ assert response2["results"] == [
+ %{"dimensions" => ["(not set)"], "metrics" => [1, 100.0]}
]
end
@@ -120,10 +131,11 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
build(:imported_visitors, visitors: 1)
])
- conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&with_imported=true")
+ response =
+ query_screen_sizes(conn, site, date_range: "day", include: %{"imports" => true})
- assert json_response(conn, 200)["results"] == [
- %{"name" => "(not set)", "visitors" => 2, "percentage" => 100.0}
+ assert response["results"] == [
+ %{"dimensions" => ["(not set)"], "metrics" => [2, 100.0]}
]
end
@@ -152,11 +164,14 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
)
])
- filters = Jason.encode!([[:is, "event:props:author", ["John Doe"]]])
- conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+ response =
+ query_screen_sizes(conn, site,
+ date_range: "day",
+ filters: [["is", "event:props:author", ["John Doe"]]]
+ )
- assert json_response(conn, 200)["results"] == [
- %{"name" => "Desktop", "visitors" => 1, "percentage" => 100}
+ assert response["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [1, 100.0]}
]
end
@@ -187,12 +202,16 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
)
])
- filters = Jason.encode!([["is_not", "event:props:author", ["John Doe"]]])
- conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+ response =
+ query_screen_sizes(conn, site,
+ date_range: "day",
+ filters: [["is_not", "event:props:author", ["John Doe"]]],
+ order_by: [["visit:device", "asc"]]
+ )
- assert json_response(conn, 200)["results"] == [
- %{"name" => "Mobile", "visitors" => 1, "percentage" => 50},
- %{"name" => "Tablet", "visitors" => 1, "percentage" => 50}
+ assert response["results"] == [
+ %{"dimensions" => ["Mobile"], "metrics" => [1, 50.0]},
+ %{"dimensions" => ["Tablet"], "metrics" => [1, 50.0]}
]
end
@@ -209,19 +228,20 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
build(:imported_visitors, visitors: 2)
])
- conn1 = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day")
+ response1 = query_screen_sizes(conn, site, date_range: "day")
- assert json_response(conn1, 200)["results"] == [
- %{"name" => "Desktop", "visitors" => 2, "percentage" => 66.67},
- %{"name" => "Laptop", "visitors" => 1, "percentage" => 33.33}
+ assert response1["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [2, 66.67]},
+ %{"dimensions" => ["Laptop"], "metrics" => [1, 33.33]}
]
- conn2 = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&with_imported=true")
+ response2 =
+ query_screen_sizes(conn, site, date_range: "day", include: %{"imports" => true})
- assert json_response(conn2, 200)["results"] == [
- %{"name" => "Desktop", "visitors" => 2, "percentage" => 40},
- %{"name" => "Laptop", "visitors" => 2, "percentage" => 40},
- %{"name" => "Mobile", "visitors" => 1, "percentage" => 20}
+ assert response2["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [2, 40.0]},
+ %{"dimensions" => ["Laptop"], "metrics" => [2, 40.0]},
+ %{"dimensions" => ["Mobile"], "metrics" => [1, 20.0]}
]
end
@@ -233,16 +253,15 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
build(:imported_visitors, visitors: 2)
])
- filters = Jason.encode!([[:is, "visit:screen", ["Desktop"]]])
-
- conn =
- get(
- conn,
- "/api/stats/#{site.domain}/screen-sizes?filters=#{filters}&period=day&with_imported=true"
+ response =
+ query_screen_sizes(conn, site,
+ date_range: "day",
+ filters: [["is", "visit:device", ["Desktop"]]],
+ include: %{"imports" => true}
)
- assert json_response(conn, 200)["results"] == [
- %{"name" => "Desktop", "visitors" => 2, "percentage" => 100.0}
+ assert response["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [2, 100.0]}
]
end
@@ -267,16 +286,16 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
build(:imported_visitors, visitors: 1, date: ~D[2021-01-01])
])
- conn =
- get(conn, "/api/stats/#{site.domain}/screen-sizes", %{
- "period" => "day",
- "date" => "2021-01-01",
- "with_imported" => "true"
- })
+ response =
+ query_screen_sizes(conn, site,
+ date_range: ["2021-01-01", "2021-01-01"],
+ include: %{"imports" => true},
+ order_by: [["visit:device", "asc"]]
+ )
- assert json_response(conn, 200)["results"] == [
- %{"name" => "Desktop", "visitors" => 2, "percentage" => 100},
- %{"name" => "Laptop", "visitors" => 2, "percentage" => 100}
+ assert response["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [2, 100.0]},
+ %{"dimensions" => ["Laptop"], "metrics" => [2, 100.0]}
]
end
@@ -289,17 +308,15 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
build(:event, user_id: 1, name: "Signup")
])
- filters = Jason.encode!([[:is, "event:goal", ["Signup"]]])
-
- conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+ response =
+ query_screen_sizes(conn, site,
+ date_range: "day",
+ filters: [["is", "event:goal", ["Signup"]]],
+ metrics: ["visitors", "total_visitors", "group_conversion_rate"]
+ )
- assert json_response(conn, 200)["results"] == [
- %{
- "name" => "Desktop",
- "total_visitors" => 2,
- "visitors" => 1,
- "conversion_rate" => 50.0
- }
+ assert response["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [1, 2, 50.0]}
]
end
@@ -315,13 +332,15 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
)
])
- filters = Jason.encode!([["is_not", "visit:source", ["Bad source", "Second bad source"]]])
-
- conn = get(conn, "/api/stats/#{site.domain}/screen-sizes?period=day&filters=#{filters}")
+ response =
+ query_screen_sizes(conn, site,
+ date_range: "day",
+ filters: [["is_not", "visit:source", ["Bad source", "Second bad source"]]]
+ )
- assert json_response(conn, 200)["results"] == [
- %{"name" => "Desktop", "visitors" => 2, "percentage" => 66.67},
- %{"name" => "Mobile", "visitors" => 1, "percentage" => 33.33}
+ assert response["results"] == [
+ %{"dimensions" => ["Desktop"], "metrics" => [2, 66.67]},
+ %{"dimensions" => ["Mobile"], "metrics" => [1, 33.33]}
]
end
@@ -368,67 +387,80 @@ defmodule PlausibleWeb.Api.StatsController.ScreenSizesTest do
insert(:goal, %{site: site, event_name: "Payment", currency: :USD})
- filters = Jason.encode!([[:is, "event:goal", ["Payment"]]])
- order_by = Jason.encode!([["visitors", "desc"]])
-
- q = "?filters=#{filters}&order_by=#{order_by}&detailed=true&period=day&page=1&limit=100"
-
- conn = get(conn, "/api/stats/#{site.domain}/screen-sizes#{q}")
+ response =
+ query_screen_sizes(conn, site,
+ date_range: "day",
+ filters: [["is", "event:goal", ["Payment"]]],
+ metrics: [
+ "visitors",
+ "total_visitors",
+ "group_conversion_rate",
+ "average_revenue",
+ "total_revenue"
+ ],
+ order_by: [["visitors", "desc"], ["visit:device", "asc"]]
+ )
- assert json_response(conn, 200)["results"] == [
+ assert response["results"] == [
%{
- "average_revenue" => %{
- "currency" => "USD",
- "long" => "$600.00",
- "short" => "$600.0",
- "value" => 600.0
- },
- "conversion_rate" => 100.0,
- "name" => "(not set)",
- "total_revenue" => %{
- "currency" => "USD",
- "long" => "$600.00",
- "short" => "$600.0",
- "value" => 600.0
- },
- "total_visitors" => 2,
- "visitors" => 2
+ "dimensions" => ["(not set)"],
+ "metrics" => [
+ 2,
+ 2,
+ 100.0,
+ %{
+ "currency" => "USD",
+ "long" => "$600.00",
+ "short" => "$600.0",
+ "value" => 600.0
+ },
+ %{
+ "currency" => "USD",
+ "long" => "$600.00",
+ "short" => "$600.0",
+ "value" => 600.0
+ }
+ ]
},
%{
- "average_revenue" => %{
- "currency" => "USD",
- "long" => "$1,500.00",
- "short" => "$1.5K",
- "value" => 1500.0
- },
- "conversion_rate" => 66.67,
- "name" => "Mobile",
- "total_revenue" => %{
- "currency" => "USD",
- "long" => "$3,000.00",
- "short" => "$3.0K",
- "value" => 3000.0
- },
- "total_visitors" => 3,
- "visitors" => 2
+ "dimensions" => ["Mobile"],
+ "metrics" => [
+ 2,
+ 3,
+ 66.67,
+ %{
+ "currency" => "USD",
+ "long" => "$1,500.00",
+ "short" => "$1.5K",
+ "value" => 1500.0
+ },
+ %{
+ "currency" => "USD",
+ "long" => "$3,000.00",
+ "short" => "$3.0K",
+ "value" => 3000.0
+ }
+ ]
},
%{
- "average_revenue" => %{
- "currency" => "USD",
- "long" => "$500.00",
- "short" => "$500.0",
- "value" => 500.0
- },
- "conversion_rate" => 50.0,
- "name" => "Desktop",
- "total_revenue" => %{
- "currency" => "USD",
- "long" => "$500.00",
- "short" => "$500.0",
- "value" => 500.0
- },
- "total_visitors" => 2,
- "visitors" => 1
+ "dimensions" => ["Desktop"],
+ "metrics" => [
+ 1,
+ 2,
+ 50.0,
+ %{
+ "currency" => "USD",
+ "long" => "$500.00",
+ "short" => "$500.0",
+ "value" => 500.0
+ },
+ %{
+ "currency" => "USD",
+ "long" => "$500.00",
+ "short" => "$500.0",
+ "value" => 500.0
+ }
+ ]
}
]
end