Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Refactor to DRY pages reports + fix bug (#6395)
RobertJoonas318a803b98b9
diff --git a/assets/js/dashboard/router.tsx b/assets/js/dashboard/router.tsxindex 355bee142f..b9676b8284 100644--- a/assets/js/dashboard/router.tsx+++ b/assets/js/dashboard/router.tsx@@ -11,9 +11,11 @@ import Dashboard from './index'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/pages'-import { EntryPagesDetails } from './stats/pages/entry-pages'-import { ExitPagesDetails } from './stats/pages/exit-pages'+import { PagesDetails } from './stats/pages/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'@@ -100,18 +102,18 @@ export const referrersGoogleRoute = {}export const topPagesRoute = {- path: 'pages',- element: <PagesDetails />+ path: BREAKDOWN_REPORTS.pages.detailsPath,+ element: <PagesDetails breakdownReportKey={BreakdownReportKey.pages} />}export const entryPagesRoute = {- path: 'entry-pages',- element: <EntryPagesDetails />+ path: BREAKDOWN_REPORTS.entryPages.detailsPath,+ element: <PagesDetails breakdownReportKey={BreakdownReportKey.entryPages} />}export const exitPagesRoute = {- path: 'exit-pages',- element: <ExitPagesDetails />+ path: BREAKDOWN_REPORTS.exitPages.detailsPath,+ element: <PagesDetails breakdownReportKey={BreakdownReportKey.exitPages} />}export const countriesRoute = {diff --git a/assets/js/dashboard/stats/breakdowns.tsx b/assets/js/dashboard/stats/breakdowns.tsxindex 7a68aadd49..79bb3bd520 100644--- a/assets/js/dashboard/stats/breakdowns.tsx+++ b/assets/js/dashboard/stats/breakdowns.tsx@@ -12,13 +12,22 @@ import {NonTimeDimension,StatsQuery} from '../stats-query'+import { Filter } from '../dashboard-state'+import { MetricsByContext } from './reports/reports-config'+import { PlausibleSite } from '../site-context'export type SharedBreakdownReportProps = {dimensionLabel: stringdimensions: NonTimeDimension[]metrics: Metric[]- getFilterInfo: (row: QueryResultRow) => FilterInfo | null- getExternalLinkUrl?: (row: QueryResultRow) => string | null+ getFilterInfo?: (+ dimension: NonTimeDimension,+ row: QueryResultRow+ ) => FilterInfo | null+ getExternalLinkUrl?: (+ site: PlausibleSite,+ row: QueryResultRow+ ) => string | null}export type ColumnConfiguration<T> = {@@ -37,6 +46,18 @@ export type ColumnConfiguration<T> = {align?: 'left' | 'right'}+export function defaultGetFilterInfo(+ dimension: NonTimeDimension,+ row: QueryResultRow+) {+ const dimensionWithoutPrefix = dimension.replace(/^(event|visit):/, '')++ return {+ prefix: dimensionWithoutPrefix,+ filter: ['is', dimensionWithoutPrefix, [row.dimensions[0]]] as Filter+ }+}+export function MetricValueTooltipContent({value,comparison,@@ -153,48 +174,44 @@ export function extractMetricValue(return { metricIndex, value, comparison }}-const DEFAULT_DETAILED_METRICS = [- 'visitors',- 'percentage',- 'bounce_rate',- 'visit_duration'-] as Metric[]--export const getBreakdownMetrics = ({- hasConversionGoalFilter,- isRealtime,- isDetailed = false,- isRevenueAvailable = false,- detailedMetrics = DEFAULT_DETAILED_METRICS-}: {- hasConversionGoalFilter: boolean+type MetricContext = {isRealtime: boolean- isDetailed?: boolean- isRevenueAvailable?: boolean- detailedMetrics?: Metric[]-}): Metric[] => {+ isDetailed: boolean+ hasConversionGoalFilter: boolean+ isRevenueAvailable: boolean+}++export const chooseBreakdownMetricsByContext = (+ metricsByContext: MetricsByContext,+ context: MetricContext+): Metric[] => {+ const {+ isRealtime,+ isDetailed,+ hasConversionGoalFilter,+ isRevenueAvailable+ } = context+if (hasConversionGoalFilter && isDetailed && isRevenueAvailable) {return [- 'total_visitors',- 'visitors',- 'group_conversion_rate',+ ...metricsByContext.goalFilterDetailedMetrics,'total_revenue','average_revenue']}if (hasConversionGoalFilter && isDetailed) {- return ['total_visitors', 'visitors', 'group_conversion_rate']+ return metricsByContext.goalFilterDetailedMetrics}if (hasConversionGoalFilter) {- return ['visitors', 'group_conversion_rate']+ return metricsByContext.goalFilterIndexMetrics}if (isRealtime) {- return ['visitors', 'percentage']+ return metricsByContext.realtimeMetrics}if (isDetailed) {- return detailedMetrics+ return metricsByContext.defaultDetailedMetrics}- return ['visitors', 'percentage']+ return metricsByContext.defaultIndexMetrics}export function addDimensionSearchFilter(diff --git a/assets/js/dashboard/stats/graph/fetch-top-stats.ts b/assets/js/dashboard/stats/graph/fetch-top-stats.tsindex 0794baa5f0..c224f843b9 100644--- a/assets/js/dashboard/stats/graph/fetch-top-stats.ts+++ b/assets/js/dashboard/stats/graph/fetch-top-stats.ts@@ -15,26 +15,23 @@ import {isRealTimeDashboard} from '../../util/filters'import { StatsReportQueryKey, useQueryApi } from '../../hooks/use-query-api'-import { useMemo } from 'react'import { useDashboardStateContext } from '../../dashboard-state-context'export function useTopStatsQuery() {const site = useSiteContext()const { dashboardState } = useDashboardStateContext()- const topStatsQueryKey = useMemo((): StatsReportQueryKey => {- return [- 'top-stats',- {- dashboardState,- reportParams: {- metrics: chooseMetrics(site, dashboardState),- dimensions: [],- include: { imports_meta: true }- }+ const topStatsQueryKey: StatsReportQueryKey = [+ 'top-stats',+ {+ dashboardState,+ reportParams: {+ metrics: chooseMetrics(site, dashboardState),+ dimensions: [],+ include: { imports_meta: true }}- ]- }, [site, dashboardState])+ }+ ]const { apiState, isRealtimeSilentUpdate } = useQueryApi(site,diff --git a/assets/js/dashboard/stats/imported-warning-bubble.tsx b/assets/js/dashboard/stats/imported-warning-bubble.tsxnew file mode 100644index 0000000000..3d231b081f--- /dev/null+++ b/assets/js/dashboard/stats/imported-warning-bubble.tsx@@ -0,0 +1,31 @@+import React from 'react'+import { ExclamationCircleIcon } from '@heroicons/react/24/outline'+import { Tooltip } from '../util/tooltip'+import { useBodyPortalRef } from './breakdowns'+import { QueryApiResponse } from '../api'++export default function ImportedWarningBubble({+ queryApiResponse+}: {+ queryApiResponse: QueryApiResponse | null+}) {+ const portalRef = useBodyPortalRef()++ const importsSkipReason = queryApiResponse?.meta?.imports_skip_reason+ const isRealtime = queryApiResponse?.extraContext.isRealtime++ const tooltipMessage =+ importsSkipReason === 'unsupported_query' && !isRealtime+ ? 'Imported data is excluded due to applied filters'+ : null++ if (tooltipMessage) {+ return (+ <Tooltip info={tooltipMessage} containerRef={portalRef}>+ <ExclamationCircleIcon className="mb-1 size-4.5 text-gray-500 dark:text-gray-400" />+ </Tooltip>+ )+ } else {+ return null+ }+}diff --git a/assets/js/dashboard/stats/modals/details-breakdown.test.tsx b/assets/js/dashboard/stats/modals/details-breakdown.test.tsxindex f863c55926..6083bd6eb3 100644--- a/assets/js/dashboard/stats/modals/details-breakdown.test.tsx+++ b/assets/js/dashboard/stats/modals/details-breakdown.test.tsx@@ -1,18 +1,25 @@import React, { useState, Dispatch, SetStateAction } from 'react'import { act, render, screen, fireEvent } from '@testing-library/react'import { TestContextProviders } from '../../../../test-utils/app-context-providers'-import { PAGES_DETAILED_METRICS, PagesDetails } from '../pages/pages'+import { PagesDetails } from '../pages/details'import { MockAPI } from '../../../../test-utils/mock-api'import { PAGINATION_LIMIT } from '../../hooks/api-client'import { QueryApiResponse } from '../../api'import { StatsQuery } from '../../stats-query'import { DEBOUNCE_DELAY } from '../../custom-hooks'+import {+ BREAKDOWN_REPORTS,+ BreakdownReportKey+} from '../reports/reports-config'const domain = 'dummy.site'const queryPath = `/api/stats/${domain}/query/`const MOCK_RESPONSE_DELAY_MS = 50const SMALL_LOADING_SPINNER_TEST_ID = 'small-loading-spinner'+const PAGES_DETAILED_METRICS =+ BREAKDOWN_REPORTS.pages.metricsByContext.defaultDetailedMetrics+function buildResponse(results: { dimensions: string[]; metrics: number[] }[] = []): QueryApiResponse {@@ -124,7 +131,9 @@ function renderModal() {function ToggleableModal() {const [open, s] = useState(false)toggle = s- return open ? <PagesDetails /> : null+ return open ? (+ <PagesDetails breakdownReportKey={BreakdownReportKey.pages} />+ ) : null}render(diff --git a/assets/js/dashboard/stats/modals/details-breakdown.tsx b/assets/js/dashboard/stats/modals/details-breakdown.tsxindex f1b49c3f5c..e8f4022ad1 100644--- a/assets/js/dashboard/stats/modals/details-breakdown.tsx+++ b/assets/js/dashboard/stats/modals/details-breakdown.tsx@@ -21,7 +21,7 @@ import {import { SortDirection } from '../../../types/query-api'import { Metric, getBreakdownMetricLabel, isSortable } from '../metrics'import { BreakdownTable } from './breakdown-table'-import { OrderByEntry } from '../../stats-query'+import { NonTimeDimension, OrderByEntry } from '../../stats-query'import { useSiteContext } from '../../site-context'import { DrilldownLink, FilterInfo } from '../../components/drilldown-link'import {@@ -31,7 +31,8 @@ import {SharedBreakdownReportProps,formatDateRangeLabel,useBodyPortalRef,- extractMetricValue+ extractMetricValue,+ defaultGetFilterInfo} from '../breakdowns'import {QueryResultRow,@@ -86,7 +87,7 @@ export function DetailsBreakdown({dimensions,metrics,defaultOrderBy = [] as MetricOrderBy,- getFilterInfo,+ getFilterInfo = defaultGetFilterInfo,getExternalLinkUrl,searchEnabled = true,onDataReady@@ -113,23 +114,21 @@ export function DetailsBreakdown({dimensionLabel})- const statsReportQueryKey: StatsReportQueryKey = useMemo(() => {- return [- dimensions.join(',') as StatsReportId,- {- dashboardState,- reportParams: {- metrics,- dimensions,- order_by: [- ...(orderBy.length ? orderBy : storedOrderBy),- ...dimensions.map((dim): OrderByEntry => [dim, 'asc'])- ]- },- search- }- ]- }, [dashboardState, metrics, dimensions, orderBy, storedOrderBy, search])+ const statsReportQueryKey: StatsReportQueryKey = [+ dimensions.join(',') as StatsReportId,+ {+ dashboardState,+ reportParams: {+ metrics,+ dimensions,+ order_by: [+ ...(orderBy.length ? orderBy : storedOrderBy),+ ...dimensions.map((dim): OrderByEntry => [dim, 'asc'])+ ]+ },+ search+ }+ ]const apiState = useSearchAndPaginateQueryAPI({ site, statsReportQueryKey })@@ -160,10 +159,17 @@ export function DetailsBreakdown({const columns: ColumnConfiguration<QueryResultRow>[] | null = useMemo(() => {if (!query) return null+ const filterDimension = query.dimensions[0] as NonTimeDimension+const hasPercentage = query.metrics.includes('percentage')const isVisitorsWithPercentageCell = (m: Metric) =>hasPercentage && m === 'visitors'+ const externalLinkForRow =+ typeof getExternalLinkUrl === 'function'+ ? (row: QueryResultRow) => getExternalLinkUrl(site, row)+ : undefined+return [{key: 'dimension',@@ -171,8 +177,10 @@ export function DetailsBreakdown({renderCell: (row, isActive) => (<DimensionCellrow={row}- getFilterInfo={getFilterInfo}- getExternalLinkUrl={getExternalLinkUrl}+ getFilterInfo={(row: QueryResultRow) =>+ getFilterInfo(filterDimension, row)+ }+ externalLinkForRow={externalLinkForRow}isActive={isActive}/>),@@ -227,6 +235,7 @@ export function DetailsBreakdown({)]}, [+ site,dimensionLabel,query,meta,@@ -470,12 +479,12 @@ function MetricLabel({function DimensionCell({row,getFilterInfo,- getExternalLinkUrl,+ externalLinkForRow,isActive}: {row: QueryResultRowgetFilterInfo: (row: QueryResultRow) => FilterInfo | null- getExternalLinkUrl?: (row: QueryResultRow) => string | null+ externalLinkForRow?: (row: QueryResultRow) => string | nullisActive?: boolean}) {return (@@ -483,8 +492,8 @@ function DimensionCell({<DrilldownLink path={rootRoute.path} filterInfo={getFilterInfo(row)}>{row.dimensions[0]}</DrilldownLink>- {typeof getExternalLinkUrl === 'function' && (- <ExternalLink href={getExternalLinkUrl(row)} isActive={isActive} />+ {typeof externalLinkForRow === 'function' && (+ <ExternalLink href={externalLinkForRow(row)} isActive={isActive} />)}</div>)diff --git a/assets/js/dashboard/stats/pages/details.tsx b/assets/js/dashboard/stats/pages/details.tsxnew file mode 100644index 0000000000..05920d80f4--- /dev/null+++ b/assets/js/dashboard/stats/pages/details.tsx@@ -0,0 +1,55 @@+import React from 'react'+import { revenueAvailable } from '../../dashboard-state'+import { useDashboardStateContext } from '../../dashboard-state-context'+import { useSiteContext } from '../../site-context'+import {+ hasConversionGoalFilter,+ hasEventFilters,+ isRealTimeDashboard+} from '../../util/filters'+import { chooseBreakdownMetricsByContext } from '../breakdowns'+import {+ BREAKDOWN_REPORTS,+ BreakdownReportKey+} from '../reports/reports-config'+import { DetailsBreakdown } from '../modals/details-breakdown'+import Modal from '../modals/modal'++export function PagesDetails({+ breakdownReportKey+}: {+ breakdownReportKey: BreakdownReportKey+}) {+ const { dashboardState } = useDashboardStateContext()+ const site = useSiteContext()++ const reportConfig = BREAKDOWN_REPORTS[breakdownReportKey]++ /*global BUILD_EXTRA*/+ const isRevenueAvailable =+ BUILD_EXTRA && revenueAvailable(dashboardState, site)++ let metrics = chooseBreakdownMetricsByContext(reportConfig.metricsByContext, {+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState),+ isDetailed: true,+ isRevenueAvailable: isRevenueAvailable+ })++ if (metrics.includes('exit_rate') && hasEventFilters(dashboardState)) {+ metrics = metrics.filter((m) => m !== 'exit_rate')+ }++ return (+ <Modal>+ <DetailsBreakdown+ title={reportConfig.detailsTitle}+ dimensionLabel={reportConfig.dimensionLabel}+ dimensions={reportConfig.dimensions}+ metrics={metrics}+ defaultOrderBy={[['visitors', 'desc']]}+ getExternalLinkUrl={reportConfig.getExternalLinkUrl}+ />+ </Modal>+ )+}diff --git a/assets/js/dashboard/stats/pages/entry-pages.tsx b/assets/js/dashboard/stats/pages/entry-pages.tsxdeleted file mode 100644index a5821daffe..0000000000--- a/assets/js/dashboard/stats/pages/entry-pages.tsx+++ /dev/null@@ -1,99 +0,0 @@-import React, { useCallback } from 'react'-import Modal from '../modals/modal'-import { Metric } from '../metrics'-import * as url from '../../util/url'-import { IndexBreakdown } from '../reports/index-breakdown'-import { DetailsBreakdown } from '../modals/details-breakdown'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import {- hasConversionGoalFilter,- isRealTimeDashboard-} from '../../util/filters'-import { revenueAvailable, Filter } from '../../dashboard-state'-import { QueryApiResponse, QueryResultRow } from '../../api'-import { getBreakdownMetrics } from '../breakdowns'-import { PAGES_BAR_COLOR } from './pages'--const DIMENSION = 'visit:entry_page'-const DETAILED_METRICS: Metric[] = [- 'visitors',- 'percentage',- 'visits',- 'bounce_rate',- 'visit_duration'-]--function getFilterInfo(row: QueryResultRow) {- return {- prefix: 'entry_page',- filter: ['is', 'entry_page', [row.dimensions[0]]] as Filter- }-}--export function EntryPagesIndex({- onDataReady-}: {- onDataReady?: (data: QueryApiResponse) => void-}) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- const metrics = getBreakdownMetrics({- hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),- isRealtime: isRealTimeDashboard(dashboardState)- })-- const getExternalLinkUrl = useCallback(- (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),- [site]- )-- return (- <IndexBreakdown- metrics={metrics}- dimensions={[DIMENSION]}- color={PAGES_BAR_COLOR}- getExternalLinkUrl={getExternalLinkUrl}- getFilterInfo={getFilterInfo}- dimensionLabel="Entry page"- onDataReady={onDataReady}- />- )-}--export function EntryPagesDetails() {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- /*global BUILD_EXTRA*/- const isRevenueAvailable =- BUILD_EXTRA && revenueAvailable(dashboardState, site)-- const metrics = getBreakdownMetrics({- hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),- isRealtime: isRealTimeDashboard(dashboardState),- isDetailed: true,- isRevenueAvailable: isRevenueAvailable,- detailedMetrics: DETAILED_METRICS- })-- const getExternalLinkUrl = useCallback(- (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),- [site]- )-- return (- <Modal>- <DetailsBreakdown- title="Entry pages"- dimensionLabel="Entry page"- dimensions={[DIMENSION]}- metrics={metrics}- defaultOrderBy={[['visitors', 'desc']]}- getFilterInfo={getFilterInfo}- getExternalLinkUrl={getExternalLinkUrl}- />- </Modal>- )-}diff --git a/assets/js/dashboard/stats/pages/exit-pages.tsx b/assets/js/dashboard/stats/pages/exit-pages.tsxdeleted file mode 100644index 83452afe56..0000000000--- a/assets/js/dashboard/stats/pages/exit-pages.tsx+++ /dev/null@@ -1,98 +0,0 @@-import React, { useCallback } from 'react'-import Modal from '../modals/modal'-import { Metric } from '../metrics'-import * as url from '../../util/url'-import { IndexBreakdown } from '../reports/index-breakdown'-import { DetailsBreakdown } from '../modals/details-breakdown'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import {- hasConversionGoalFilter,- isRealTimeDashboard-} from '../../util/filters'-import { revenueAvailable, Filter } from '../../dashboard-state'-import { QueryApiResponse, QueryResultRow } from '../../api'-import { getBreakdownMetrics } from '../breakdowns'-import { PAGES_BAR_COLOR } from './pages'--const DIMENSION = 'visit:exit_page'-const DETAILED_METRICS: Metric[] = [- 'visitors',- 'percentage',- 'visits',- 'exit_rate'-]--function getFilterInfo(row: QueryResultRow) {- return {- prefix: 'exit_page',- filter: ['is', 'exit_page', [row.dimensions[0]]] as Filter- }-}--export function ExitPagesIndex({- onDataReady-}: {- onDataReady?: (data: QueryApiResponse) => void-}) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- const metrics = getBreakdownMetrics({- hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),- isRealtime: isRealTimeDashboard(dashboardState)- })-- const getExternalLinkUrl = useCallback(- (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),- [site]- )-- return (- <IndexBreakdown- metrics={metrics}- dimensions={[DIMENSION]}- color={PAGES_BAR_COLOR}- getExternalLinkUrl={getExternalLinkUrl}- getFilterInfo={getFilterInfo}- dimensionLabel="Exit page"- onDataReady={onDataReady}- />- )-}--export function ExitPagesDetails() {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- /*global BUILD_EXTRA*/- const isRevenueAvailable =- BUILD_EXTRA && revenueAvailable(dashboardState, site)-- const metrics = getBreakdownMetrics({- hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),- isRealtime: isRealTimeDashboard(dashboardState),- isDetailed: true,- isRevenueAvailable: isRevenueAvailable,- detailedMetrics: [...DETAILED_METRICS]- })-- const getExternalLinkUrl = useCallback(- (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),- [site]- )-- return (- <Modal>- <DetailsBreakdown- title="Exit pages"- dimensionLabel="Exit page"- dimensions={[DIMENSION]}- metrics={metrics}- defaultOrderBy={[['visitors', 'desc']]}- getFilterInfo={getFilterInfo}- getExternalLinkUrl={getExternalLinkUrl}- />- </Modal>- )-}diff --git a/assets/js/dashboard/stats/pages/index.js b/assets/js/dashboard/stats/pages/index.jsdeleted file mode 100644index 75d2d07354..0000000000--- a/assets/js/dashboard/stats/pages/index.js+++ /dev/null@@ -1,116 +0,0 @@-import React, { useEffect, useState } from 'react'--import * as storage from '../../util/storage'-import ImportedQueryUnsupportedWarning from '../imported-query-unsupported-warning'-import { hasConversionGoalFilter } from '../../util/filters'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import { entryPagesRoute, exitPagesRoute, topPagesRoute } from '../../router'-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 { PagesIndex } from './pages'-import { EntryPagesIndex } from './entry-pages'-import { ExitPagesIndex } from './exit-pages'--export default function Pages() {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- const tabKey = `pageTab__${site.domain}`- const storedTab = storage.getItem(tabKey)- const [mode, setMode] = useState(storedTab || 'pages')- 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 onDataReady(queryApiResponse) {- setLoading(false)- setSkipImportedReason(queryApiResponse.meta?.imports_skip_reason)- if (queryApiResponse.results && queryApiResponse.results.length > 0) {- setMoreLinkState(MoreLinkState.READY)- } else {- setMoreLinkState(MoreLinkState.HIDDEN)- }- }-- useEffect(() => {- setLoading(true)- setMoreLinkState(MoreLinkState.LOADING)- }, [dashboardState, mode])-- function moreLinkProps() {- switch (mode) {- case 'entry-pages':- return {- path: entryPagesRoute.path,- search: (search) => search- }- case 'exit-pages':- return {- path: exitPagesRoute.path,- search: (search) => search- }- case 'pages':- default:- return {- path: topPagesRoute.path,- search: (search) => search- }- }- }-- function renderContent() {- switch (mode) {- case 'entry-pages':- return <EntryPagesIndex onDataReady={onDataReady} />- case 'exit-pages':- return <ExitPagesIndex onDataReady={onDataReady} />- case 'pages':- default:- return <PagesIndex onDataReady={onDataReady} />- }- }-- return (- <ReportLayout testId="report-pages" className="overflow-x-hidden">- <ReportHeader>- <div className="flex gap-x-3">- <TabWrapper>- {[- {- label: hasConversionGoalFilter(dashboardState)- ? 'Conversion pages'- : 'Top pages',- value: 'pages'- },- { label: 'Entry pages', value: 'entry-pages' },- { label: 'Exit pages', value: 'exit-pages' }- ].map(({ value, label }) => (- <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>- )-}diff --git a/assets/js/dashboard/stats/pages/index.tsx b/assets/js/dashboard/stats/pages/index.tsxnew file mode 100644index 0000000000..7964905775--- /dev/null+++ b/assets/js/dashboard/stats/pages/index.tsx@@ -0,0 +1,122 @@+import React, { useState } from 'react'++import * as storage from '../../util/storage'+import {+ hasConversionGoalFilter,+ 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 } from '../../api'+import ImportedWarningBubble from '../imported-warning-bubble'+import {+ BREAKDOWN_REPORTS,+ BreakdownReportKey+} from '../reports/reports-config'+import { IndexBreakdown } from '../reports/index-breakdown'+import { chooseBreakdownMetricsByContext } from '../breakdowns'++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'++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 [currentData, setCurrentData] = useState<QueryApiResponse | null>(null)++ const currentModeReportConfig = BREAKDOWN_REPORTS[mode]++ const currentModeMetrics = chooseBreakdownMetricsByContext(+ currentModeReportConfig.metricsByContext,+ {+ isRealtime: isRealTimeDashboard(dashboardState),+ isDetailed: false,+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRevenueAvailable: false+ }+ )++ function switchTab(mode: Mode) {+ storage.setItem(tabKey, mode)+ setMode(mode)+ }++ function moreLinkProps() {+ return {+ path: currentModeReportConfig.detailsPath,+ search: (search: string) => search+ }+ }++ function renderContent() {+ return (+ <IndexBreakdown+ metrics={currentModeMetrics}+ dimensions={currentModeReportConfig.dimensions}+ dimensionLabel={currentModeReportConfig.dimensionLabel}+ color={BAR_COLOR}+ getExternalLinkUrl={currentModeReportConfig.getExternalLinkUrl}+ onDataReady={setCurrentData}+ />+ )+ }++ const moreLinkState = currentData+ ? currentData.results.length > 0+ ? MoreLinkState.READY+ : MoreLinkState.HIDDEN+ : MoreLinkState.LOADING++ return (+ <ReportLayout testId="report-pages" className="overflow-x-hidden">+ <ReportHeader>+ <div className="flex gap-x-3">+ <TabWrapper>+ {(+ [+ {+ label: hasConversionGoalFilter(dashboardState)+ ? 'Conversion pages'+ : 'Top pages',+ value: BreakdownReportKey.pages+ },+ { label: 'Entry pages', value: BreakdownReportKey.entryPages },+ { label: 'Exit pages', value: BreakdownReportKey.exitPages }+ ] as const+ ).map(({ value, label }) => (+ <TabButton+ key={value}+ active={mode === value}+ onClick={() => switchTab(value)}+ >+ {label}+ </TabButton>+ ))}+ </TabWrapper>+ <ImportedWarningBubble queryApiResponse={currentData} />+ </div>+ <MoreLink state={moreLinkState} linkProps={moreLinkProps()} />+ </ReportHeader>+ {renderContent()}+ </ReportLayout>+ )+}diff --git a/assets/js/dashboard/stats/pages/pages.tsx b/assets/js/dashboard/stats/pages/pages.tsxdeleted file mode 100644index 4f27cf3645..0000000000--- a/assets/js/dashboard/stats/pages/pages.tsx+++ /dev/null@@ -1,101 +0,0 @@-import React, { useCallback } from 'react'-import Modal from '../modals/modal'-import { Metric } from '../metrics'-import * as url from '../../util/url'-import { IndexBreakdown } from '../reports/index-breakdown'-import { DetailsBreakdown } from '../modals/details-breakdown'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import {- hasConversionGoalFilter,- isRealTimeDashboard-} from '../../util/filters'-import { revenueAvailable, Filter } from '../../dashboard-state'-import { QueryApiResponse, QueryResultRow } from '../../api'-import { getBreakdownMetrics } from '../breakdowns'--export const PAGES_BAR_COLOR = 'bg-orange-50 group-hover/row:bg-orange-100'--const DIMENSION = 'event:page'-export const PAGES_DETAILED_METRICS: Metric[] = [- 'visitors',- 'percentage',- 'pageviews',- 'bounce_rate',- 'time_on_page',- 'scroll_depth'-]--function getFilterInfo(row: QueryResultRow) {- return {- prefix: 'page',- filter: ['is', 'page', [row.dimensions[0]]] as Filter- }-}--export function PagesIndex({- onDataReady-}: {- onDataReady?: (data: QueryApiResponse) => void-}) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- const metrics = getBreakdownMetrics({- hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),- isRealtime: isRealTimeDashboard(dashboardState)- })-- const getExternalLinkUrl = useCallback(- (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),- [site]- )-- return (- <IndexBreakdown- metrics={metrics}- dimensions={[DIMENSION]}- color={PAGES_BAR_COLOR}- getExternalLinkUrl={getExternalLinkUrl}- getFilterInfo={getFilterInfo}- dimensionLabel="Page"- onDataReady={onDataReady}- />- )-}--export function PagesDetails() {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- /*global BUILD_EXTRA*/- const isRevenueAvailable =- BUILD_EXTRA && revenueAvailable(dashboardState, site)-- const metrics = getBreakdownMetrics({- hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),- isRealtime: isRealTimeDashboard(dashboardState),- isDetailed: true,- isRevenueAvailable: isRevenueAvailable,- detailedMetrics: PAGES_DETAILED_METRICS- })-- const getExternalLinkUrl = useCallback(- (row: QueryResultRow) => url.externalLinkForPage(site, row.dimensions[0]),- [site]- )-- return (- <Modal>- <DetailsBreakdown- title="Top pages"- dimensionLabel="Page url"- dimensions={[DIMENSION]}- metrics={metrics}- defaultOrderBy={[['visitors', 'desc']]}- getFilterInfo={getFilterInfo}- getExternalLinkUrl={getExternalLinkUrl}- />- </Modal>- )-}diff --git a/assets/js/dashboard/stats/reports/index-breakdown.tsx b/assets/js/dashboard/stats/reports/index-breakdown.tsxindex 5548a26748..6769d5d7b0 100644--- a/assets/js/dashboard/stats/reports/index-breakdown.tsx+++ b/assets/js/dashboard/stats/reports/index-breakdown.tsx@@ -4,7 +4,7 @@ import LazyLoader from '../../components/lazy-loader'import { trimURL } from '../../util/url'import { useDashboardStateContext } from '../../dashboard-state-context'import { useSiteContext } from '../../site-context'-import { OrderByEntry } from '../../stats-query'+import { NonTimeDimension, OrderByEntry } from '../../stats-query'import { Metric, getBreakdownMetricLabel } from '../metrics'import {ColumnConfiguration,@@ -13,7 +13,8 @@ import {SharedBreakdownReportProps,formatDateRangeLabel,useBodyPortalRef,- extractMetricValue+ extractMetricValue,+ defaultGetFilterInfo} from '../breakdowns'import { DrilldownLink, FilterInfo } from '../../components/drilldown-link'import { QueryResultRow, QueryResultQuery, QueryApiResponse } from '../../api'@@ -55,7 +56,7 @@ export function IndexBreakdown({metrics,dimensions,color,- getFilterInfo,+ getFilterInfo = defaultGetFilterInfo,getExternalLinkUrl,dimensionLabel,onDataReady,@@ -65,23 +66,21 @@ export function IndexBreakdown({const { dashboardState } = useDashboardStateContext()const [visible, setVisible] = useState(false)- const statsReportQueryKey: StatsReportQueryKey = useMemo(() => {- return [- dimensions.join(',') as StatsReportId,- {- dashboardState,- reportParams: {- metrics,- dimensions,- order_by: [- ['visitors', 'desc'],- ...dimensions.map((dim): OrderByEntry => [dim, 'asc'])- ],- pagination: { limit: MAX_ITEMS, offset: 0 }- }+ const statsReportQueryKey: StatsReportQueryKey = [+ dimensions.join(',') as StatsReportId,+ {+ dashboardState,+ reportParams: {+ metrics,+ dimensions,+ order_by: [+ ['visitors', 'desc'],+ ...dimensions.map((dim): OrderByEntry => [dim, 'asc'])+ ],+ pagination: { limit: MAX_ITEMS, offset: 0 }}- ]- }, [dashboardState, metrics, dimensions])+ }+ ]const { apiState, isRealtimeSilentUpdate } = useQueryApi(site,@@ -126,11 +125,17 @@ export function IndexBreakdown({// percentage is not its own column —- it's shown inline in the// visitors cell instead.const filteredMetrics = query.metrics.filter((m) => m !== 'percentage')+ const filterDimension = query.dimensions[0] as NonTimeDimensionconst hasPercentage = query.metrics.includes('percentage')const isVisitorsWithPercentageCell = (m: Metric) =>hasPercentage && m === 'visitors'+ const externalLinkForRow =+ typeof getExternalLinkUrl === 'function'+ ? (row: QueryResultRow) => getExternalLinkUrl(site, row)+ : undefined+return [{key: 'dimension',@@ -142,8 +147,10 @@ export function IndexBreakdown({barWidthPercent={((row.metrics[barMetricIndex] as number) / barMaxValue) * 100}- getFilterInfo={getFilterInfo}- getExternalLinkUrl={getExternalLinkUrl}+ getFilterInfo={(row: QueryResultRow) =>+ getFilterInfo(filterDimension, row)+ }+ externalLinkForRow={externalLinkForRow}isActive={isActive}/>),@@ -181,6 +188,7 @@ export function IndexBreakdown({)]}, [+ site,dimensionLabel,color,barMetricIndex,@@ -208,17 +216,17 @@ function DimensionCell({color,barWidthPercent,getFilterInfo,- getExternalLinkUrl,+ externalLinkForRow,isActive}: {row: QueryResultRowcolor: stringbarWidthPercent: numbergetFilterInfo: (row: QueryResultRow) => FilterInfo | null- getExternalLinkUrl?: (row: QueryResultRow) => string | null+ externalLinkForRow?: (row: QueryResultRow) => string | nullisActive?: boolean}) {- const externalUrl = getExternalLinkUrl?.(row)+ const externalUrl = externalLinkForRow?.(row)return (<div className="w-full h-full relative"><div@@ -438,18 +446,20 @@ function MetricValueCell({export function IndexBreakdownRenderer({data,isPending,+ isPlaceholderData,isRealtimeSilentUpdate,columns}: {data?: QueryApiResponseisPending: boolean+ isPlaceholderData: booleanisRealtimeSilentUpdate: booleancolumns: ColumnConfiguration<QueryResultRow>[] | null}) {const [tappedRow, setTappedRow] = useState<string | null>(null)const rows = data?.results?.slice(0, MAX_ITEMS) ?? []- if (!columns || isPending) {+ if (!columns || isPending || (isPlaceholderData && !isRealtimeSilentUpdate)) {return (<divclassName="w-full flex flex-col justify-center"diff --git a/assets/js/dashboard/stats/reports/report-layout.js b/assets/js/dashboard/stats/reports/report-layout.tsxsimilarity index 80%rename from assets/js/dashboard/stats/reports/report-layout.jsrename to assets/js/dashboard/stats/reports/report-layout.tsxindex 8342c84909..e7428a1be3 100644--- a/assets/js/dashboard/stats/reports/report-layout.js+++ b/assets/js/dashboard/stats/reports/report-layout.tsx@@ -3,8 +3,12 @@ import classNames from 'classnames'export function ReportLayout({children,- testId = undefined,- className = undefined+ testId,+ className+}: {+ children: React.ReactNode+ testId?: string+ className?: string}) {return (<divdiff --git a/assets/js/dashboard/stats/reports/reports-config.ts b/assets/js/dashboard/stats/reports/reports-config.tsnew file mode 100644index 0000000000..afe960edf4--- /dev/null+++ b/assets/js/dashboard/stats/reports/reports-config.ts@@ -0,0 +1,99 @@+import { PlausibleSite } from '../../site-context'+import { NonTimeDimension } from '../../stats-query'+import { Metric } from '../metrics'+import * as url from '../../util/url'+import { QueryResultRow } from '../../api'++export type MetricsByContext = {+ realtimeMetrics: Metric[]+ defaultIndexMetrics: Metric[]+ defaultDetailedMetrics: Metric[]+ goalFilterIndexMetrics: Metric[]+ goalFilterDetailedMetrics: Metric[]+}++type BreakdownReportConfig = {+ dimensions: [NonTimeDimension] | [NonTimeDimension, NonTimeDimension]+ metricsByContext: MetricsByContext+ detailsTitle: string+ detailsPath: string+ dimensionLabel: string+ getExternalLinkUrl?: (+ site: PlausibleSite,+ row: QueryResultRow+ ) => string | null+}++const COMMON_METRICS_BY_CONTEXT: MetricsByContext = {+ realtimeMetrics: ['visitors', 'percentage'],+ defaultIndexMetrics: ['visitors', 'percentage'],+ defaultDetailedMetrics: [+ 'visitors',+ 'percentage',+ 'visits',+ 'bounce_rate',+ 'visit_duration'+ ],+ goalFilterIndexMetrics: ['visitors', 'group_conversion_rate'],+ goalFilterDetailedMetrics: [+ 'total_visitors',+ 'visitors',+ 'group_conversion_rate'+ ]+}++function getExternalLinkUrlForPage(+ site: PlausibleSite,+ row: QueryResultRow+): string | null {+ return url.externalLinkForPage(site, row.dimensions[0])+}++export enum BreakdownReportKey {+ 'pages' = 'pages',+ 'entryPages' = 'entryPages',+ 'exitPages' = 'exitPages'+}++export const BREAKDOWN_REPORTS: Record<+ BreakdownReportKey,+ BreakdownReportConfig+> = {+ [BreakdownReportKey.pages]: {+ dimensions: ['event:page'],+ metricsByContext: {+ ...COMMON_METRICS_BY_CONTEXT,+ defaultDetailedMetrics: [+ 'visitors',+ 'percentage',+ 'pageviews',+ 'bounce_rate',+ 'time_on_page',+ 'scroll_depth'+ ]+ },+ detailsTitle: 'Top pages',+ detailsPath: 'pages',+ dimensionLabel: 'Page',+ getExternalLinkUrl: getExternalLinkUrlForPage+ },+ [BreakdownReportKey.entryPages]: {+ dimensions: ['visit:entry_page'],+ metricsByContext: COMMON_METRICS_BY_CONTEXT,+ detailsTitle: 'Entry pages',+ detailsPath: 'entry-pages',+ dimensionLabel: 'Entry page',+ getExternalLinkUrl: getExternalLinkUrlForPage+ },+ [BreakdownReportKey.exitPages]: {+ dimensions: ['visit:exit_page'],+ metricsByContext: {+ ...COMMON_METRICS_BY_CONTEXT,+ defaultDetailedMetrics: ['visitors', 'percentage', 'visits', 'exit_rate']+ },+ detailsTitle: 'Exit pages',+ detailsPath: 'exit-pages',+ dimensionLabel: 'Exit page',+ getExternalLinkUrl: getExternalLinkUrlForPage+ }+}diff --git a/assets/js/dashboard/util/filters.js b/assets/js/dashboard/util/filters.jsindex 4e15f3ef83..6a960d3531 100644--- a/assets/js/dashboard/util/filters.js+++ b/assets/js/dashboard/util/filters.js@@ -199,6 +199,12 @@ const EVENT_FILTER_KEYS = new Set(['name', 'page', 'goal', 'hostname'])const EVENT_PREFIX = 'event:'const VISIT_PREFIX = 'visit:'+export function hasEventFilters(dashboardState) {+ return dashboardState.resolvedFilters.some(+ ([_operation, filterKey, _clauses]) => EVENT_FILTER_KEYS.has(filterKey)+ )+}+function remapFilterKey(filterKey) {if (NO_PREFIX_KEYS.has(filterKey)) {return filterKeydiff --git a/e2e/tests/dashboard/breakdowns.spec.ts b/e2e/tests/dashboard/breakdowns.spec.tsindex 2f8c4b4f69..9d0fa65d68 100644--- a/e2e/tests/dashboard/breakdowns.spec.ts+++ b/e2e/tests/dashboard/breakdowns.spec.ts@@ -611,6 +611,29 @@ test('pages breakdown', async ({ page, request }) => {await closeModalButton(page).click()})++ await test.step('exit pages modal with an event filter applied', async () => {+ await page.goto('/' + domain + '?f=is,page,/page1', { waitUntil: 'commit' })+ await detailsLink(report).click()++ await expect(+ modal(page).getByRole('heading', { name: 'Exit pages' })+ ).toBeVisible()++ await expectHeaders(modal(page), [+ 'Exit page',+ /Unique exits/,+ /Total exits/+ ])++ await expectRows(modal(page), ['/page1', '/page2', '/page3'])++ await expectMetricValues(modal(page), '/page1', ['1', '1'])+ await expectMetricValues(modal(page), '/page2', ['1', '1'])+ await expectMetricValues(modal(page), '/page3', ['1', '1'])++ await closeModalButton(page).click()+ })})test('pages breakdown modal', async ({ page, request }) => {@@ -651,7 +674,7 @@ test('pages breakdown modal', async ({ page, request }) => {).toBeVisible()await expectHeaders(modal(page), [- 'Page url',+ 'Page',/Visitors/,/Pageviews/,/Bounce rate/,@@ -819,7 +842,7 @@ test('pages breakdown with a pageview goal filter applied', async ({).toBeVisible()await expectHeaders(modal(page), [- 'Page url',+ 'Page',/Total visitors/,/Conversions/,/CR/@@ -856,7 +879,7 @@ test('pages breakdown with a pageview goal filter applied', async ({).toBeVisible()await expectHeaders(modal(page), [- 'Page url',+ 'Page',/Total visitors/,/Conversions/,/CR/,diff --git a/e2e/tests/dashboard/general.spec.ts b/e2e/tests/dashboard/general.spec.tsindex ec2c800d21..a3b54cf6e6 100644--- a/e2e/tests/dashboard/general.spec.ts+++ b/e2e/tests/dashboard/general.spec.ts@@ -140,7 +140,7 @@ test('tab selection user preferences are preserved across reloads', async ({domain)- expect(currentTab).toEqual('entry-pages')+ expect(currentTab).toEqual('entryPages')await page.getByRole('button', { name: 'Exit pages' }).click()@@ -151,7 +151,7 @@ test('tab selection user preferences are preserved across reloads', async ({domain)- expect(currentTab).toEqual('exit-pages')+ expect(currentTab).toEqual('exitPages')})test('back navigation closes the modal', async ({ page, request, baseURL }) => {