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
FE sources migration (#6411)
RobertJoonasc3c3da88bf44
diff --git a/assets/js/dashboard/hooks/use-query-api.ts b/assets/js/dashboard/hooks/use-query-api.tsindex 0d65ff5883..3f2ded0d6c 100644--- a/assets/js/dashboard/hooks/use-query-api.ts+++ b/assets/js/dashboard/hooks/use-query-api.ts@@ -52,7 +52,9 @@ function withExtraContext<T extends QueryApiResponse | MainGraphResponse>(return { ...response, extraContext } as T}-const defaultGetStatsQuery = (queryKey: StatsReportQueryKey): StatsQuery => {+export const defaultGetStatsQuery = (+ queryKey: StatsReportQueryKey+): StatsQuery => {const [_, keyOpts] = queryKeyreturn createStatsQuery(keyOpts.dashboardState, keyOpts.reportParams)}@@ -145,16 +147,15 @@ export function useQueryApi<* Optionally supports search, appending a `['contains', dimensions[0], search]`* filter to the query filters.*/-export function useSearchAndPaginateQueryAPI({- site,- statsReportQueryKey-}: {- site: PlausibleSite- statsReportQueryKey: StatsReportQueryKey-}) {+export function useSearchAndPaginateQueryAPI(+ site: PlausibleSite,+ statsReportQueryKey: StatsReportQueryKey,+ opts?: Pick<ReportOpts, 'getStatsQuery'>+) {const queryClient = useQueryClient()const key = statsReportQueryKey[0]const { dashboardState } = statsReportQueryKey[1]+ const getStatsQuery = opts?.getStatsQuery ?? defaultGetStatsQueryuseEffect(() => {return () => {@@ -170,7 +171,7 @@ export function useSearchAndPaginateQueryAPI({queryFn: async ({ pageParam, queryKey }): Promise<QueryApiResponse> => {const { dashboardState, reportParams, search } = queryKey[1]- let statsQuery = createStatsQuery(dashboardState, reportParams)+ let statsQuery = getStatsQuery(queryKey)if (search && search !== '') {const searchBy = reportParams.dimensions[0]diff --git a/assets/js/dashboard/router.tsx b/assets/js/dashboard/router.tsxindex 90df8f75c8..b19c9a2aff 100644--- a/assets/js/dashboard/router.tsx+++ b/assets/js/dashboard/router.tsx@@ -8,8 +8,6 @@ import {SomethingWentWrongMessage} from './error/something-went-wrong'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/details'import { DevicesDetails } from './stats/devices/details'@@ -26,6 +24,8 @@ import { DashboardKeybinds } from './dashboard-keybinds'import LastLoadContextProvider from './last-load-context'import { RoutelessModalsContextProvider } from './navigation/routeless-modals-context'import { RoutelessSegmentModals } from './segments/routeless-segment-modals'+import { GOOGLE_SEARCH_TERMS_DETAILS_PATH } from './stats/sources/fetch-search-terms'+import { SourcesDetails } from './stats/sources/details'const queryClient = new QueryClient({defaultOptions: {@@ -58,42 +58,42 @@ export const rootRoute = {}export const sourcesRoute = {- path: 'sources',- element: <SourcesModal currentView="sources" />+ path: BREAKDOWN_REPORTS.sources.detailsPath,+ element: <SourcesDetails reportKey={BreakdownReportKey.sources} />}export const channelsRoute = {- path: 'channels',- element: <SourcesModal currentView="channels" />+ path: BREAKDOWN_REPORTS.channels.detailsPath,+ element: <SourcesDetails reportKey={BreakdownReportKey.channels} />}export const utmMediumsRoute = {- path: 'utm_mediums',- element: <SourcesModal currentView="utm_mediums" />+ path: BREAKDOWN_REPORTS.utmMediums.detailsPath,+ element: <SourcesDetails reportKey={BreakdownReportKey.utmMediums} />}export const utmSourcesRoute = {- path: 'utm_sources',- element: <SourcesModal currentView="utm_sources" />+ path: BREAKDOWN_REPORTS.utmSources.detailsPath,+ element: <SourcesDetails reportKey={BreakdownReportKey.utmSources} />}export const utmCampaignsRoute = {- path: 'utm_campaigns',- element: <SourcesModal currentView="utm_campaigns" />+ path: BREAKDOWN_REPORTS.utmCampaigns.detailsPath,+ element: <SourcesDetails reportKey={BreakdownReportKey.utmCampaigns} />}export const utmContentsRoute = {- path: 'utm_contents',- element: <SourcesModal currentView="utm_contents" />+ path: BREAKDOWN_REPORTS.utmContents.detailsPath,+ element: <SourcesDetails reportKey={BreakdownReportKey.utmContents} />}export const utmTermsRoute = {- path: 'utm_terms',- element: <SourcesModal currentView="utm_terms" />+ path: BREAKDOWN_REPORTS.utmTerms.detailsPath,+ element: <SourcesDetails reportKey={BreakdownReportKey.utmTerms} />}export const referrersGoogleRoute = {- path: 'referrers/Google',+ path: GOOGLE_SEARCH_TERMS_DETAILS_PATH,element: <GoogleKeywordsModal />}@@ -165,8 +165,8 @@ export const conversionsRoute = {}export const referrersDrilldownRoute = {- path: 'referrers/:referrer',- element: <ReferrersDrilldownModal />+ path: BREAKDOWN_REPORTS.referrers.detailsPath,+ element: <SourcesDetails reportKey={BreakdownReportKey.referrers} />}export const customPropsRoute = {diff --git a/assets/js/dashboard/stats/breakdowns.tsx b/assets/js/dashboard/stats/breakdowns.tsxindex 377abdf125..d8128121b0 100644--- a/assets/js/dashboard/stats/breakdowns.tsx+++ b/assets/js/dashboard/stats/breakdowns.tsx@@ -14,15 +14,17 @@ import {} from '../stats-query'import { Filter } from '../dashboard-state'import { MetricsByContext } from './reports/reports-config'+import {+ defaultGetStatsQuery,+ StatsReportQueryKey+} from '../hooks/use-query-api'+import classNames from 'classnames'+import { DIRECT_NONE } from './sources'export type SharedBreakdownReportProps = {dimensionLabel: stringdimensions: NonTimeDimension[]metrics: Metric[]- getFilterInfo?: (- dimension: NonTimeDimension,- row: QueryResultRow- ) => FilterInfo | null}export type ColumnConfiguration<T> = {@@ -41,10 +43,46 @@ export type ColumnConfiguration<T> = {align?: 'left' | 'right'}+const FILTER_DIMENSIONS_NOT = {+ 'visit:city': [0],+ 'visit:country': ['\0\0', 'ZZ'],+ 'visit:region': [''],+ 'visit:utm_medium': [''],+ 'visit:utm_source': [''],+ 'visit:utm_campaign': [''],+ 'visit:utm_content': [''],+ 'visit:utm_term': [''],+ 'visit:entry_page': [''],+ 'visit:exit_page': ['']+}++export function getStatsQueryWithImplicitNotEmptyFilter(+ queryKey: StatsReportQueryKey+) {+ let statsQuery = defaultGetStatsQuery(queryKey)++ const dimension = queryKey[1].reportParams.dimensions[0]++ if (Object.keys(FILTER_DIMENSIONS_NOT).includes(dimension)) {+ statsQuery = addFilter(statsQuery, [+ 'is_not',+ dimension,+ FILTER_DIMENSIONS_NOT[dimension as keyof typeof FILTER_DIMENSIONS_NOT]+ ])+ }++ return statsQuery+}++export type GetFilterInfo = (+ dimension: NonTimeDimension,+ row: QueryResultRow+) => FilterInfo | null+export function defaultGetFilterInfo(dimension: NonTimeDimension,row: QueryResultRow-) {+): FilterInfo {const dimensionWithoutPrefix = dimension.replace(/^(event|visit):/, '')return {@@ -53,6 +91,47 @@ export function defaultGetFilterInfo(}}+export function getReferrerUrlFilterInfo(+ _dimension: NonTimeDimension,+ row: QueryResultRow+): FilterInfo | null {+ if (row.dimensions[0] === DIRECT_NONE) {+ return null+ }+ return {+ prefix: 'referrer',+ filter: ['is', 'referrer', [row.dimensions[0]]]+ }+}++export const getScreenFilterInfo = (+ _dimension: NonTimeDimension,+ row: QueryResultRow+): FilterInfo => ({+ filter: ['is', 'screen', [row.dimensions[0]]],+ prefix: 'screen'+})++export function MetricValueWrapper({+ className,+ children+}: {+ className?: string+ children: ReactNode+}) {+ return (+ <span+ className={classNames(+ 'font-medium text-sm block text-gray-800 dark:text-gray-200',+ className+ )}+ data-testid="metric-value"+ >+ {children}+ </span>+ )+}+export function MetricValueTooltipContent({value,comparison,diff --git a/assets/js/dashboard/stats/devices/details.tsx b/assets/js/dashboard/stats/devices/details.tsxindex 36bd6379a4..6eb91a21e4 100644--- a/assets/js/dashboard/stats/devices/details.tsx+++ b/assets/js/dashboard/stats/devices/details.tsx@@ -4,7 +4,11 @@ import {hasConversionGoalFilter,isRealTimeDashboard} from '../../util/filters'-import { chooseBreakdownMetricsByContext } from '../breakdowns'+import {+ chooseBreakdownMetricsByContext,+ defaultGetFilterInfo,+ getScreenFilterInfo+} from '../breakdowns'import {BREAKDOWN_REPORTS,BreakdownReportKey@@ -16,7 +20,6 @@ import {} from '../modals/details-breakdown'import Modal from '../modals/modal'import { BrowserIcon, OsIcon, ScreenSizeIcon } from './icons'-import { getScreenFilterInfo } from '.'type DevicesReportKey =| BreakdownReportKey.browsers@@ -64,11 +67,6 @@ export function DevicesDetails({defaultOrderBy={[['visitors', 'desc']]}searchEnabled={searchEnabled}DimensionElement={DimensionElement}- getFilterInfo={- reportKey === BreakdownReportKey.screenSizes- ? getScreenFilterInfo- : undefined- }/></Modal>)@@ -77,6 +75,7 @@ export function DevicesDetails({const BrowsersDimensionCell = (props: DimensionCellProps) => (<DimensionCell{...props}+ getFilterInfo={defaultGetFilterInfo}text={props.row.dimensions[0]}icon={<BrowserIcon dimensionValue={props.row.dimensions[0]} />}/>@@ -85,6 +84,7 @@ const BrowsersDimensionCell = (props: DimensionCellProps) => (const BrowserVersionsDimensionCell = (props: DimensionCellProps) => (<DimensionCell{...props}+ getFilterInfo={defaultGetFilterInfo}text={props.row.dimensions[0]}icon={<BrowserIcon dimensionValue={props.row.dimensions[1]} />}/>@@ -93,6 +93,7 @@ const BrowserVersionsDimensionCell = (props: DimensionCellProps) => (const OperatingSystemsDimensionCell = (props: DimensionCellProps) => (<DimensionCell{...props}+ getFilterInfo={defaultGetFilterInfo}text={props.row.dimensions[0]}icon={<OsIcon dimensionValue={props.row.dimensions[0]} />}/>@@ -101,6 +102,7 @@ const OperatingSystemsDimensionCell = (props: DimensionCellProps) => (const OperatingSystemVersionsDimensionCell = (props: DimensionCellProps) => (<DimensionCell{...props}+ getFilterInfo={defaultGetFilterInfo}text={props.row.dimensions[0]}icon={<OsIcon dimensionValue={props.row.dimensions[1]} />}/>@@ -108,6 +110,7 @@ const OperatingSystemVersionsDimensionCell = (props: DimensionCellProps) => (const ScreenSizesDimensionCell = (props: DimensionCellProps) => (<DimensionCell+ getFilterInfo={getScreenFilterInfo}{...props}text={props.row.dimensions[0]}icon={<ScreenSizeIcon dimensionValue={props.row.dimensions[0]} />}diff --git a/assets/js/dashboard/stats/devices/index.tsx b/assets/js/dashboard/stats/devices/index.tsxindex 38e91e6772..876c460ad5 100644--- a/assets/js/dashboard/stats/devices/index.tsx+++ b/assets/js/dashboard/stats/devices/index.tsx@@ -24,10 +24,13 @@ import {DimensionCellWithBarProps,IndexBreakdown} from '../reports/index-breakdown'-import { chooseBreakdownMetricsByContext } from '../breakdowns'+import {+ chooseBreakdownMetricsByContext,+ defaultGetFilterInfo,+ getScreenFilterInfo+} 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'@@ -111,11 +114,6 @@ export function Devices() {dimensionLabel={reportConfig.dimensionLabel}DimensionElement={DimensionElement}onDataReady={setCurrentData}- getFilterInfo={- reportKey === BreakdownReportKey.screenSizes- ? getScreenFilterInfo- : undefined- }/></ReportLayout>)@@ -125,6 +123,7 @@ const BrowsersDimensionCell = (props: DimensionCellWithBarProps) => (<DimensionCellWithBar{...props}barClassName={BAR_COLOR}+ getFilterInfo={defaultGetFilterInfo}text={props.row.dimensions[0]}icon={<BrowserIcon dimensionValue={props.row.dimensions[0]} />}/>@@ -134,6 +133,7 @@ const BrowserVersionsDimensionCell = (props: DimensionCellWithBarProps) => (<DimensionCellWithBar{...props}barClassName={BAR_COLOR}+ getFilterInfo={defaultGetFilterInfo}text={formatTwoDimensionsText(props.row)}icon={<BrowserIcon dimensionValue={props.row.dimensions[1]} />}/>@@ -143,6 +143,7 @@ const OperatingSystemsDimensionCell = (props: DimensionCellWithBarProps) => (<DimensionCellWithBar{...props}barClassName={BAR_COLOR}+ getFilterInfo={defaultGetFilterInfo}text={props.row.dimensions[0]}icon={<OsIcon dimensionValue={props.row.dimensions[0]} />}/>@@ -154,6 +155,7 @@ const OperatingSystemVersionsDimensionCell = (<DimensionCellWithBar{...props}barClassName={BAR_COLOR}+ getFilterInfo={defaultGetFilterInfo}text={formatTwoDimensionsText(props.row)}icon={<OsIcon dimensionValue={props.row.dimensions[1]} />}/>@@ -163,6 +165,7 @@ const ScreenSizesDimensionCell = (props: DimensionCellWithBarProps) => (<DimensionCellWithBar{...props}barClassName={BAR_COLOR}+ getFilterInfo={getScreenFilterInfo}text={props.row.dimensions[0]}icon={<ScreenSizeIcon dimensionValue={props.row.dimensions[0]} />}/>@@ -173,14 +176,6 @@ const formatTwoDimensionsText = (row: QueryResultRow) =>? '(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:diff --git a/assets/js/dashboard/stats/modals/details-breakdown.tsx b/assets/js/dashboard/stats/modals/details-breakdown.tsxindex 9ee84bf551..2a3e8f2955 100644--- a/assets/js/dashboard/stats/modals/details-breakdown.tsx+++ b/assets/js/dashboard/stats/modals/details-breakdown.tsx@@ -22,7 +22,7 @@ import { Metric, getBreakdownMetricLabel, isSortable } from '../metrics'import { BreakdownTable } from './breakdown-table'import { NonTimeDimension, OrderByEntry } from '../../stats-query'import { useSiteContext } from '../../site-context'-import { DrilldownLink, FilterInfo } from '../../components/drilldown-link'+import { DrilldownLink } from '../../components/drilldown-link'import {ColumnConfiguration,MetricValueTooltipContent,@@ -30,7 +30,8 @@ import {formatDateRangeLabel,useBodyPortalRef,extractMetricValue,- defaultGetFilterInfo+ getStatsQueryWithImplicitNotEmptyFilter,+ GetFilterInfo} from '../breakdowns'import {QueryResultRow,@@ -87,7 +88,6 @@ export function DetailsBreakdown({dimensions,metrics,defaultOrderBy = [] as MetricOrderBy,- getFilterInfo = defaultGetFilterInfo,DimensionElement,searchEnabled = true,onDataReady@@ -130,7 +130,9 @@ export function DetailsBreakdown({}]- const apiState = useSearchAndPaginateQueryAPI({ site, statsReportQueryKey })+ const apiState = useSearchAndPaginateQueryAPI(site, statsReportQueryKey, {+ getStatsQuery: getStatsQueryWithImplicitNotEmptyFilter+ })useEffect(() => {const pages = apiState.data?.pages@@ -172,9 +174,7 @@ export function DetailsBreakdown({renderCell: (row, isActive) => (<DimensionElementrow={row}- getFilterInfo={(row: QueryResultRow) =>- getFilterInfo(filterDimension, row)- }+ filterDimension={filterDimension}isActive={isActive}/>),@@ -233,7 +233,6 @@ export function DetailsBreakdown({dimensionLabel,query,meta,- getFilterInfo,orderByDictionary,toggleSortByMetric,metricLabelFor@@ -470,8 +469,8 @@ function MetricLabel({}export type DimensionCellProps = {+ filterDimension: NonTimeDimensionrow: QueryResultRow- getFilterInfo: (row: QueryResultRow) => FilterInfo | nullisActive?: boolean}@@ -479,15 +478,20 @@ export const DimensionCell = ({text,icon,externalLink,+ filterDimension,getFilterInfo,row}: {text: stringicon?: ReactNodeexternalLink?: ReactNode+ getFilterInfo: GetFilterInfo} & DimensionCellProps) => (<div className="break-all flex items-center gap-x-1">- <DrilldownLink path={rootRoute.path} filterInfo={getFilterInfo(row)}>+ <DrilldownLink+ path={rootRoute.path}+ filterInfo={getFilterInfo(filterDimension, row)}+ >{icon}{text}</DrilldownLink>diff --git a/assets/js/dashboard/stats/modals/google-keywords.test.tsx b/assets/js/dashboard/stats/modals/google-keywords.test.tsxindex 146689b52a..74ce33c36d 100644--- a/assets/js/dashboard/stats/modals/google-keywords.test.tsx+++ b/assets/js/dashboard/stats/modals/google-keywords.test.tsx@@ -33,7 +33,7 @@ afterEach(() => {describe('GoogleKeywordsModal', () => {test('opening the modal for a second time with the same dashboardState gets response from cache', async () => {const googleKeywordsHandler = mockAPI.get(- `/api/stats/${domain}/referrers/Google/`,+ `/api/stats/${domain}/google-search-terms/`,{ results: [] })diff --git a/assets/js/dashboard/stats/modals/google-keywords.tsx b/assets/js/dashboard/stats/modals/google-keywords.tsxindex 256d172eb3..9f96c34d32 100644--- a/assets/js/dashboard/stats/modals/google-keywords.tsx+++ b/assets/js/dashboard/stats/modals/google-keywords.tsx@@ -1,103 +1,83 @@import React, { useMemo, useState } from 'react'import Modal from './modal'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import { usePaginatedGetAPI } from '../../hooks/api-client'-import { createVisitors, Metric } from '../reports/metrics'import {numberShortFormatter,percentageFormatter} from '../../util/number-formatter'-import { apiPath } from '../../util/url'-import { DashboardState } from '../../dashboard-state'-import { ColumnConfiguraton } from '../../components/table-legacy'-import { BreakdownTable } from './breakdown-table-legacy'--type GoogleKeywordItem = {- visitors: string- name: string- impressions: number- ctr: number- position: number-}+import { ColumnConfiguration } from '../breakdowns'+import { BreakdownTable } from './breakdown-table'+import {+ SearchTermsResultItem,+ useDetailedGoogleSearchTermsQuery+} from '../sources/fetch-search-terms'-const metrics = [- createVisitors({ renderLabel: () => 'Visitors', sortable: false }),- new Metric({- width: 'w-28',+const metricColumns = [+ {+ key: 'visitors',+ label: 'Visitors',+ formatter: numberShortFormatter,+ width: 'w-28'+ },+ {key: 'impressions',- renderLabel: () => 'Impressions',+ label: 'Impressions',formatter: numberShortFormatter,- sortable: false- }),- new Metric({- width: 'w-16',- key: 'ctr',- renderLabel: () => 'CTR',- formatter: percentageFormatter,- sortable: false- }),- new Metric({- width: 'w-28',+ width: 'w-28'+ },+ { key: 'ctr', label: 'CTR', formatter: percentageFormatter, width: 'w-24' },+ {key: 'position',- renderLabel: () => 'Position',+ label: 'Position',formatter: numberShortFormatter,- sortable: false- })+ width: 'w-24'+ }]function GoogleKeywordsModal() {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()- const endpoint = apiPath(site, '/referrers/Google')-const [search, setSearch] = useState('')- const apiState = usePaginatedGetAPI<- { results: GoogleKeywordItem[] },- [string, { dashboardState: DashboardState; search: string }]- >({- siteTimezoneOffset: site.offset,- siteStatsBegin: site.statsBegin,- key: [endpoint, { dashboardState, search }],- getRequestParams: (key) => {- const [_endpoint, { dashboardState, search }] = key- const params = { detailed: true }+ const apiState = useDetailedGoogleSearchTermsQuery({ search })- return [dashboardState, search === '' ? params : { ...params, search }]- },- initialPageParam: 0- })-- const columns: ColumnConfiguraton<GoogleKeywordItem>[] = useMemo(+ const columns: ColumnConfiguration<SearchTermsResultItem>[] = useMemo(() => [{- label: 'Search term',key: 'name',- width: 'w-48 md:w-56 lg:w-1/3',+ renderLabel: () => 'Search term',+ renderCell: (item) => item.name,+ width: 'w-48 max-w-48 md:w-56 md:max-w-56',align: 'left'},- ...metrics.map(- (m): ColumnConfiguraton<GoogleKeywordItem> => ({- label: m.renderLabel(dashboardState),- key: m.key,++ ...metricColumns.map((m): ColumnConfiguration<SearchTermsResultItem> => {+ const metric = m.key as keyof SearchTermsResultItem++ return {+ key: metric,+ renderLabel: () => m.label,+ renderCell: (item) => item[metric],width: m.width,align: 'right'- })- )+ }+ })],- [dashboardState]+ [])+ const tableData = apiState.data+ ? { pages: apiState.data.pages.map((p) => p.results) }+ : undefined+return (<Modal>- <BreakdownTable+ <BreakdownTable<SearchTermsResultItem>title="Google search terms"- displayError={true}onSearch={setSearch}{...apiState}+ error={apiState.error}+ data={tableData}columns={columns}+ getRowKey={(row: SearchTermsResultItem) => row.name}/></Modal>)diff --git a/assets/js/dashboard/stats/modals/referrer-drilldown.js b/assets/js/dashboard/stats/modals/referrer-drilldown.jsdeleted file mode 100644index 991ea29607..0000000000--- a/assets/js/dashboard/stats/modals/referrer-drilldown.js+++ /dev/null@@ -1,121 +0,0 @@-import React, { useCallback } from 'react'-import { useParams } from 'react-router-dom'--import Modal from './modal'-import {- hasConversionGoalFilter,- isRealTimeDashboard-} from '../../util/filters'-import BreakdownModal from './breakdown-modal-legacy'-import * as metrics from '../reports/metrics'-import * as url from '../../util/url'-import { addFilter, revenueAvailable } from '../../dashboard-state'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import { SourceFavicon } from '../sources/source-favicon'--function ReferrerDrilldownModal() {- const { referrer } = useParams()- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- /*global BUILD_EXTRA*/- const showRevenueMetrics =- BUILD_EXTRA && revenueAvailable(dashboardState, site)-- const reportInfo = {- title: 'Referrer drilldown',- dimension: 'referrer',- endpoint: url.apiPath(- site,- `/referrers/${url.maybeEncodeRouteParam(referrer)}`- ),- dimensionLabel: 'Referrer',- 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]- )-- function chooseMetrics() {- if (hasConversionGoalFilter(dashboardState)) {- return [- metrics.createTotalVisitors(),- metrics.createVisitors({- renderLabel: (_dashboardState) => 'Conversions',- width: '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'- })- ]- }-- return [- metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),- metrics.createBounceRate(),- metrics.createVisitDuration()- ]- }-- const renderIcon = useCallback((listItem) => {- return (- <SourceFavicon- name={listItem.name}- className="size-4 mr-2 align-middle inline"- />- )- }, [])-- const getExternalLinkURL = useCallback((listItem) => {- if (listItem.name !== 'Direct / None') {- return '//' + listItem.name- }- }, [])-- return (- <Modal>- <BreakdownModal- reportInfo={reportInfo}- metrics={chooseMetrics()}- getFilterInfo={getFilterInfo}- addSearchFilter={addSearchFilter}- renderIcon={renderIcon}- getExternalLinkURL={getExternalLinkURL}- />- </Modal>- )-}--export default ReferrerDrilldownModaldiff --git a/assets/js/dashboard/stats/modals/sources.js b/assets/js/dashboard/stats/modals/sources.jsdeleted file mode 100644index 5322870c13..0000000000--- a/assets/js/dashboard/stats/modals/sources.js+++ /dev/null@@ -1,171 +0,0 @@-import React, { useCallback } from 'react'-import Modal from './modal'-import {- hasConversionGoalFilter,- isRealTimeDashboard-} from '../../util/filters'-import BreakdownModal from './breakdown-modal-legacy'-import * as metrics from '../reports/metrics'-import * as url from '../../util/url'-import { addFilter, revenueAvailable } from '../../dashboard-state'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import { SourceFavicon } from '../sources/source-favicon'--const VIEWS = {- sources: {- info: {- title: 'Top sources',- dimension: 'source',- endpoint: '/sources',- dimensionLabel: 'Source',- defaultOrder: ['visitors', 'desc']- },- renderIcon: (listItem) => {- return (- <SourceFavicon- name={listItem.name}- className="size-4 mr-2 align-middle inline"- />- )- }- },- channels: {- info: {- title: 'Top acquisition channels',- dimension: 'channel',- endpoint: '/channels',- dimensionLabel: 'Channel',- defaultOrder: ['visitors', 'desc']- }- },- utm_mediums: {- info: {- title: 'Top UTM mediums',- dimension: 'utm_medium',- endpoint: '/utm_mediums',- dimensionLabel: 'UTM medium',- defaultOrder: ['visitors', 'desc']- }- },- utm_sources: {- info: {- title: 'Top UTM sources',- dimension: 'utm_source',- endpoint: '/utm_sources',- dimensionLabel: 'UTM source',- defaultOrder: ['visitors', 'desc']- }- },- utm_campaigns: {- info: {- title: 'Top UTM campaigns',- dimension: 'utm_campaign',- endpoint: '/utm_campaigns',- dimensionLabel: 'UTM campaign',- defaultOrder: ['visitors', 'desc']- }- },- utm_contents: {- info: {- title: 'Top UTM contents',- dimension: 'utm_content',- endpoint: '/utm_contents',- dimensionLabel: 'UTM content',- defaultOrder: ['visitors', 'desc']- }- },- utm_terms: {- info: {- title: 'Top UTM terms',- dimension: 'utm_term',- endpoint: '/utm_terms',- dimensionLabel: 'UTM term',- defaultOrder: ['visitors', 'desc']- }- }-}--function SourcesModal({ currentView }) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- /*global BUILD_EXTRA*/- const showRevenueMetrics =- BUILD_EXTRA && revenueAvailable(dashboardState, site)-- let reportInfo = VIEWS[currentView].info- reportInfo = {- ...reportInfo,- endpoint: url.apiPath(site, reportInfo.endpoint)- }-- 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]- )-- function chooseMetrics() {- if (hasConversionGoalFilter(dashboardState)) {- return [- metrics.createTotalVisitors(),- metrics.createVisitors({- renderLabel: (_dashboardState) => 'Conversions',- width: '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'- })- ]- }-- return [- metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),- metrics.createBounceRate(),- metrics.createVisitDuration()- ]- }-- return (- <Modal>- <BreakdownModal- reportInfo={reportInfo}- metrics={chooseMetrics()}- getFilterInfo={getFilterInfo}- addSearchFilter={addSearchFilter}- renderIcon={VIEWS[currentView].renderIcon}- />- </Modal>- )-}--export default SourcesModaldiff --git a/assets/js/dashboard/stats/pages/details.tsx b/assets/js/dashboard/stats/pages/details.tsxindex 1eec093666..d68d562c09 100644--- a/assets/js/dashboard/stats/pages/details.tsx+++ b/assets/js/dashboard/stats/pages/details.tsx@@ -7,7 +7,10 @@ import {hasEventFilters,isRealTimeDashboard} from '../../util/filters'-import { chooseBreakdownMetricsByContext } from '../breakdowns'+import {+ chooseBreakdownMetricsByContext,+ defaultGetFilterInfo+} from '../breakdowns'import {BREAKDOWN_REPORTS,BreakdownReportKey@@ -71,6 +74,7 @@ const PagesDimensionElement = (props: DimensionCellProps) => {isActive={props.isActive}/>}+ getFilterInfo={defaultGetFilterInfo}{...props}/>)diff --git a/assets/js/dashboard/stats/pages/index.tsx b/assets/js/dashboard/stats/pages/index.tsxindex 3bbb3acac2..04b78e6d5b 100644--- a/assets/js/dashboard/stats/pages/index.tsx+++ b/assets/js/dashboard/stats/pages/index.tsx@@ -23,7 +23,10 @@ import {IndexBreakdown,DimensionCellWithBarProps} from '../reports/index-breakdown'-import { chooseBreakdownMetricsByContext } from '../breakdowns'+import {+ chooseBreakdownMetricsByContext,+ defaultGetFilterInfo+} from '../breakdowns'import { externalLinkForPage, trimURL } from '../../util/url'import { IndexExternalLink } from './external-link'@@ -122,6 +125,7 @@ function PagesDimensionCell(props: DimensionCellWithBarProps) {const displayValue = trimURL(props.row.dimensions[0], MAX_DIMENSION_LENGTH)return (<DimensionCellWithBar+ getFilterInfo={defaultGetFilterInfo}text={displayValue}barClassName={BAR_COLOR}externalLink={diff --git a/assets/js/dashboard/stats/reports/index-breakdown.tsx b/assets/js/dashboard/stats/reports/index-breakdown.tsxindex 1ca270d819..ffc2881ed6 100644--- a/assets/js/dashboard/stats/reports/index-breakdown.tsx+++ b/assets/js/dashboard/stats/reports/index-breakdown.tsx@@ -18,9 +18,11 @@ import {formatDateRangeLabel,useBodyPortalRef,extractMetricValue,- defaultGetFilterInfo+ getStatsQueryWithImplicitNotEmptyFilter,+ MetricValueWrapper,+ GetFilterInfo} from '../breakdowns'-import { DrilldownLink, FilterInfo } from '../../components/drilldown-link'+import { DrilldownLink } from '../../components/drilldown-link'import { QueryResultRow, QueryResultQuery, QueryApiResponse } from '../../api'import classNames from 'classnames'import { Tooltip } from '../../util/tooltip'@@ -43,7 +45,7 @@ const ROW_GAP_HEIGHT = 4const DATA_CONTAINER_HEIGHT =(ROW_HEIGHT + ROW_GAP_HEIGHT) * (MAX_ITEMS - 1) + ROW_HEIGHT-const DEFAULT_METRIC_COLUMN_WIDTH = 'w-16 min-w-16'+export const DEFAULT_METRIC_COLUMN_WIDTH = 'w-16 min-w-16'const VISITORS_WITH_PERCENTAGE_COLUMN_WIDTH = 'w-32 min-w-32'const BAR_METRIC = 'visitors'@@ -58,7 +60,6 @@ export function IndexBreakdown({metrics,dimensions,DimensionElement,- getFilterInfo = defaultGetFilterInfo,dimensionLabel,onDataReady,metricColumnWidth = DEFAULT_METRIC_COLUMN_WIDTH@@ -86,7 +87,7 @@ export function IndexBreakdown({const { apiState, isRealtimeSilentUpdate } = useQueryApi(site,statsReportQueryKey,- { enabled: visible }+ { enabled: visible, getStatsQuery: getStatsQueryWithImplicitNotEmptyFilter })useEffect(() => {@@ -126,6 +127,7 @@ 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')@@ -138,13 +140,11 @@ export function IndexBreakdown({renderLabel: () => dimensionLabel,renderCell: (row, isActive) => (<DimensionElement+ filterDimension={filterDimension}row={row}barWidthPercent={((row.metrics[barMetricIndex] as number) / barMaxValue) * 100}- getFilterInfo={(row: QueryResultRow) =>- getFilterInfo(filterDimension, row)- }isActive={isActive}/>),@@ -188,14 +188,15 @@ export function IndexBreakdown({metricLabelFor,barMaxValue,query,- getFilterInfo,metricColumnWidth])return (<LazyLoader onVisible={() => setVisible(true)}>- <IndexBreakdownRenderer+ <IndexBreakdownRenderer<QueryResultRow>{...apiState}+ rows={apiState.data?.results?.slice(0, MAX_ITEMS) ?? []}+ getDimensionValue={(row) => row.dimensions[0]}isRealtimeSilentUpdate={isRealtimeSilentUpdate}columns={columns}/>@@ -204,31 +205,35 @@ export function IndexBreakdown({}export type DimensionCellWithBarProps = {+ filterDimension: NonTimeDimensionrow: QueryResultRowbarWidthPercent: numberisActive?: boolean- getFilterInfo: (row: QueryResultRow) => FilterInfo | null}export const DimensionCellWithBar = ({text,icon,+ onClick,externalLink,getFilterInfo,+ filterDimension,barWidthPercent,barClassName,row}: {text: stringicon?: ReactNode+ onClick?: () => voidexternalLink?: ReactNode+ getFilterInfo: GetFilterInfobarClassName: string} & DimensionCellWithBarProps) => (- <div className="w-full h-full relative">- <Bar barWidthPercent={barWidthPercent} className={barClassName}></Bar>- <div className="flex justify-start items-center gap-x-1.5 px-2 py-1.5 text-sm dark:text-gray-300 relative z-9 break-all w-full">+ <Bar barWidthPercent={barWidthPercent} className={barClassName}>+ <div className="flex justify-start items-center gap-x-1.5 w-full"><DrilldownLink- filterInfo={getFilterInfo(row)}+ onClick={onClick}+ filterInfo={getFilterInfo(filterDimension, row)}extraClass="max-w-max w-full flex items-center md:overflow-hidden">{icon}@@ -236,7 +241,7 @@ export const DimensionCellWithBar = ({</DrilldownLink>{externalLink}</div>- </div>+ </Bar>)function VisitorsWithPercentageCell({@@ -389,13 +394,7 @@ function MetricValueCell({const showTooltip = !!comparison || isAbbreviatedconst valueContent = (- <span- className={classNames(- 'font-medium text-sm block text-gray-800 dark:text-gray-200',- showTooltip && 'cursor-default'- )}- data-testid="metric-value"- >+ <MetricValueWrapper className={showTooltip ? 'cursor-default' : undefined}>{shortFormatter(value)}{comparison && (<ChangeArrow@@ -405,7 +404,7 @@ function MetricValueCell({hideNumber/>)}- </span>+ </MetricValueWrapper>)if (!showTooltip) return valueContent@@ -434,21 +433,22 @@ function MetricValueCell({)}-export function IndexBreakdownRenderer({- data,+export function IndexBreakdownRenderer<TRow>({+ rows,+ getDimensionValue,isPending,isPlaceholderData,isRealtimeSilentUpdate,columns}: {- data?: QueryApiResponse+ rows: TRow[]+ getDimensionValue: (row: TRow) => stringisPending: booleanisPlaceholderData: booleanisRealtimeSilentUpdate: boolean- columns: ColumnConfiguration<QueryResultRow>[] | null+ columns: ColumnConfiguration<TRow>[] | null}) {const [tappedRow, setTappedRow] = useState<string | null>(null)- const rows = data?.results?.slice(0, MAX_ITEMS) ?? []if (!columns || isPending || (isPlaceholderData && !isRealtimeSilentUpdate)) {return (@@ -501,20 +501,20 @@ export function IndexBreakdownRenderer({><FlipMove disableAllAnimations={!isRealtimeSilentUpdate}>{rows.map((row) => {- const dimension = row.dimensions[0]- const isActive = tappedRow === dimension+ const dimensionValue = getDimensionValue(row)+ const isActive = tappedRow === dimensionValueconst handleClick = (e: React.MouseEvent) => {if (window.innerWidth < 768 &&!(e.target as HTMLElement).closest('a')) {- setTappedRow(isActive ? null : dimension)+ setTappedRow(isActive ? null : dimensionValue)}}return (- <div key={dimension} style={{ minHeight: ROW_HEIGHT }}>+ <div key={dimensionValue} style={{ minHeight: ROW_HEIGHT }}><divdata-testid="report-row"className="group/row flex w-full items-center hover:bg-gray-100/60 dark:hover:bg-gray-850 rounded-sm md:cursor-default cursor-pointer"@@ -542,18 +542,25 @@ export function IndexBreakdownRenderer({)}-const Bar = ({+export const Bar = ({barWidthPercent,- className+ className,+ children}: {barWidthPercent: numberclassName: string+ children: ReactNode}) => (- <div- className={classNames(- `absolute top-0 left-0 h-full rounded-sm dark:bg-gray-500/15 dark:group-hover/row:bg-gray-500/30`,- className- )}- style={{ width: `${barWidthPercent}%` }}- />+ <div className="w-full h-full relative">+ <div+ className={classNames(+ `absolute top-0 left-0 h-full rounded-sm dark:bg-gray-500/15 dark:group-hover/row:bg-gray-500/30`,+ className+ )}+ style={{ width: `${barWidthPercent}%` }}+ ></div>+ <div className="px-2 py-1.5 text-sm dark:text-gray-300 relative z-9 break-all">+ {children}+ </div>+ </div>)diff --git a/assets/js/dashboard/stats/reports/reports-config.ts b/assets/js/dashboard/stats/reports/reports-config.tsindex de048724a8..e0d6433a11 100644--- a/assets/js/dashboard/stats/reports/reports-config.ts+++ b/assets/js/dashboard/stats/reports/reports-config.ts@@ -42,7 +42,15 @@ export enum BreakdownReportKey {'browserVersions' = 'browserVersions','operatingSystems' = 'operatingSystems','operatingSystemVersions' = 'operatingSystemVersions',- 'screenSizes' = 'screenSizes'+ 'screenSizes' = 'screenSizes',+ 'channels' = 'channels',+ 'sources' = 'sources',+ 'referrers' = 'referrers',+ 'utmMediums' = 'utmMediums',+ 'utmSources' = 'utmSources',+ 'utmCampaigns' = 'utmCampaigns',+ 'utmContents' = 'utmContents',+ 'utmTerms' = 'utmTerms'}export const BREAKDOWN_REPORTS: Record<@@ -126,5 +134,61 @@ export const BREAKDOWN_REPORTS: Record<detailsTitle: 'Devices',detailsPath: 'screen-sizes',dimensionLabel: 'Device'+ },+ [BreakdownReportKey.channels]: {+ dimensions: ['visit:channel'],+ metricsByContext: COMMON_METRICS_BY_CONTEXT,+ detailsTitle: 'Top acquisition channels',+ detailsPath: 'channels',+ dimensionLabel: 'Channel'+ },+ [BreakdownReportKey.sources]: {+ dimensions: ['visit:source'],+ metricsByContext: COMMON_METRICS_BY_CONTEXT,+ detailsTitle: 'Top sources',+ detailsPath: 'sources',+ dimensionLabel: 'Source'+ },+ [BreakdownReportKey.referrers]: {+ dimensions: ['visit:referrer'],+ metricsByContext: COMMON_METRICS_BY_CONTEXT,+ detailsTitle: 'Referrer drilldown',+ detailsPath: 'referrers/:referrer',+ dimensionLabel: 'Referrer'+ },+ [BreakdownReportKey.utmMediums]: {+ dimensions: ['visit:utm_medium'],+ metricsByContext: COMMON_METRICS_BY_CONTEXT,+ detailsTitle: 'UTM mediums',+ detailsPath: 'utm_mediums',+ dimensionLabel: 'UTM medium'+ },+ [BreakdownReportKey.utmSources]: {+ dimensions: ['visit:utm_source'],+ metricsByContext: COMMON_METRICS_BY_CONTEXT,+ detailsTitle: 'UTM sources',+ detailsPath: 'utm_sources',+ dimensionLabel: 'UTM source'+ },+ [BreakdownReportKey.utmCampaigns]: {+ dimensions: ['visit:utm_campaign'],+ metricsByContext: COMMON_METRICS_BY_CONTEXT,+ detailsTitle: 'UTM campaigns',+ detailsPath: 'utm_campaigns',+ dimensionLabel: 'UTM campaign'+ },+ [BreakdownReportKey.utmContents]: {+ dimensions: ['visit:utm_content'],+ metricsByContext: COMMON_METRICS_BY_CONTEXT,+ detailsTitle: 'UTM contents',+ detailsPath: 'utm_contents',+ dimensionLabel: 'UTM content'+ },+ [BreakdownReportKey.utmTerms]: {+ dimensions: ['visit:utm_term'],+ metricsByContext: COMMON_METRICS_BY_CONTEXT,+ detailsTitle: 'UTM terms',+ detailsPath: 'utm_terms',+ dimensionLabel: 'UTM term'}}diff --git a/assets/js/dashboard/stats/sources/details.tsx b/assets/js/dashboard/stats/sources/details.tsxnew file mode 100644index 0000000000..7b1217e808--- /dev/null+++ b/assets/js/dashboard/stats/sources/details.tsx@@ -0,0 +1,129 @@+import React from 'react'+import { revenueAvailable } from '../../dashboard-state'+import { useDashboardStateContext } from '../../dashboard-state-context'+import { useSiteContext } from '../../site-context'+import {+ hasConversionGoalFilter,+ isRealTimeDashboard+} from '../../util/filters'+import {+ chooseBreakdownMetricsByContext,+ defaultGetFilterInfo,+ getReferrerUrlFilterInfo+} from '../breakdowns'+import {+ BREAKDOWN_REPORTS,+ BreakdownReportKey+} from '../reports/reports-config'+import {+ DetailsBreakdown,+ DimensionCell,+ DimensionCellProps+} from '../modals/details-breakdown'+import Modal from '../modals/modal'+import { SourceFavicon } from './source-favicon'+import { DIRECT_NONE } from '.'+import { DetailsExternalLink } from '../pages/external-link'++type SourcesReportKey =+ | BreakdownReportKey.channels+ | BreakdownReportKey.sources+ | BreakdownReportKey.referrers+ | BreakdownReportKey.utmMediums+ | BreakdownReportKey.utmSources+ | BreakdownReportKey.utmCampaigns+ | BreakdownReportKey.utmContents+ | BreakdownReportKey.utmTerms++export function SourcesDetails({ reportKey }: { reportKey: SourcesReportKey }) {+ const { dashboardState } = useDashboardStateContext()+ const site = useSiteContext()++ const reportConfig = BREAKDOWN_REPORTS[reportKey]++ /*global BUILD_EXTRA*/+ const isRevenueAvailable =+ BUILD_EXTRA && revenueAvailable(dashboardState, site)++ const metrics = chooseBreakdownMetricsByContext(+ reportConfig.metricsByContext,+ {+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRealtime: isRealTimeDashboard(dashboardState),+ isDetailed: true,+ isRevenueAvailable: isRevenueAvailable+ }+ )++ const DimensionElement =+ reportKey === BreakdownReportKey.sources+ ? SourcesDimensionCell+ : reportKey === BreakdownReportKey.referrers+ ? ReferrerUrlDimensionCell+ : SimpleDimensionCell++ return (+ <Modal>+ <DetailsBreakdown+ title={reportConfig.detailsTitle}+ dimensionLabel={reportConfig.dimensionLabel}+ dimensions={reportConfig.dimensions}+ metrics={metrics}+ defaultOrderBy={[['visitors', 'desc']]}+ DimensionElement={DimensionElement}+ />+ </Modal>+ )+}++const SourcesDimensionCell = (props: DimensionCellProps) => {+ return (+ <DimensionCell+ icon={+ <SourceFavicon+ name={props.row.dimensions[0]}+ className="size-4 mr-2 align-middle inline"+ />+ }+ text={props.row.dimensions[0]}+ getFilterInfo={defaultGetFilterInfo}+ {...props}+ />+ )+}++const ReferrerUrlDimensionCell = (props: DimensionCellProps) => {+ const dimensionValue = props.row.dimensions[0]++ const externalUrl =+ dimensionValue === DIRECT_NONE ? null : `https://${dimensionValue}`++ return (+ <DimensionCell+ text={dimensionValue}+ icon={+ <SourceFavicon+ name={dimensionValue}+ className="size-4 mr-2 align-middle inline"+ />+ }+ externalLink={+ externalUrl && (+ <DetailsExternalLink href={externalUrl} isActive={props.isActive} />+ )+ }+ getFilterInfo={getReferrerUrlFilterInfo}+ {...props}+ />+ )+}++const SimpleDimensionCell = (props: DimensionCellProps) => {+ return (+ <DimensionCell+ text={props.row.dimensions[0]}+ getFilterInfo={defaultGetFilterInfo}+ {...props}+ />+ )+}diff --git a/assets/js/dashboard/stats/sources/fetch-search-terms.tsx b/assets/js/dashboard/stats/sources/fetch-search-terms.tsxnew file mode 100644index 0000000000..700ca1debc--- /dev/null+++ b/assets/js/dashboard/stats/sources/fetch-search-terms.tsx@@ -0,0 +1,133 @@+import { InfiniteData, useInfiniteQuery, useQuery } from '@tanstack/react-query'+import { useDashboardStateContext } from '../../dashboard-state-context'+import { useSiteContext } from '../../site-context'+import { DashboardState } from '../../dashboard-state'+import * as api from '../../api'+import { ApiError } from '../../api'+import * as url from '../../util/url'+import { getStaleTime, PAGINATION_LIMIT } from '../../hooks/api-client'++const INDEX_SEARCH_TERMS_REPORT_ID = 'index-search-terms'+const DETAILED_SEARCH_TERMS_REPORT_ID = 'detailed-search-terms'+const SEARCH_TERMS_ENDPOINT = '/google-search-terms'++export const GOOGLE_SEARCH_TERMS_DETAILS_PATH = 'referrers/Google'++type IndexSearchTermsQueryKey = [+ typeof INDEX_SEARCH_TERMS_REPORT_ID,+ { dashboardState: DashboardState }+]++type DetailedSearchTermsQueryKey = [+ typeof DETAILED_SEARCH_TERMS_REPORT_ID,+ { dashboardState: DashboardState; search?: string }+]++export type SearchTermsResultItem = {+ name: string+ position: number+ visitors: number+ ctr: number+ impressions: number+}+export type SearchTermsSuccessResponse = {+ results: SearchTermsResultItem[]+}++export type SearchTermsErrorCode =+ | 'not_configured'+ | 'unsupported_filters'+ | 'period_too_recent'+export type SearchTermsErrorPayload = {+ error_code: SearchTermsErrorCode+ is_admin: boolean+}++export function useIndexGoogleSearchTermsQuery({+ enabled+}: {+ enabled: boolean+}) {+ const site = useSiteContext()+ const { dashboardState } = useDashboardStateContext()++ const searchTermsQueryKey: IndexSearchTermsQueryKey = [+ INDEX_SEARCH_TERMS_REPORT_ID,+ { dashboardState }+ ]++ return useQuery<+ SearchTermsSuccessResponse,+ ApiError,+ SearchTermsSuccessResponse,+ IndexSearchTermsQueryKey+ >({+ queryKey: searchTermsQueryKey,+ enabled: enabled,+ retry: false,+ queryFn: ({ queryKey }) => {+ return api.get(+ url.apiPath(site, SEARCH_TERMS_ENDPOINT),+ queryKey[1].dashboardState+ )+ },+ placeholderData: (previousData) => previousData,+ staleTime: ({ queryKey }) => {+ return getStaleTime({+ siteTimezoneOffset: site.offset,+ siteStatsBegin: site.statsBegin,+ ...queryKey[1].dashboardState+ })+ }+ })+}++export function useDetailedGoogleSearchTermsQuery({+ search+}: {+ search?: string+}) {+ const site = useSiteContext()+ const { dashboardState } = useDashboardStateContext()++ const searchTermsQueryKey: DetailedSearchTermsQueryKey = [+ DETAILED_SEARCH_TERMS_REPORT_ID,+ { dashboardState, search }+ ]++ return useInfiniteQuery<+ SearchTermsSuccessResponse,+ ApiError,+ InfiniteData<SearchTermsSuccessResponse>,+ DetailedSearchTermsQueryKey,+ number+ >({+ queryKey: searchTermsQueryKey,+ retry: false,+ queryFn: ({ pageParam, queryKey }) => {+ const { dashboardState, search } = queryKey[1]++ return api.get(url.apiPath(site, SEARCH_TERMS_ENDPOINT), dashboardState, {+ detailed: true,+ search: search,+ limit: PAGINATION_LIMIT,+ page: pageParam+ })+ },+ placeholderData: (previousData) => previousData,+ getNextPageParam: (lastPageResults, _, lastPageIndex) => {+ return lastPageResults.results.length === PAGINATION_LIMIT+ ? lastPageIndex + 1+ : null+ },+ initialPageParam: 0,+ staleTime: ({ queryKey }) => {+ const [_, opts] = queryKey+ return getStaleTime({+ siteTimezoneOffset: site.offset,+ siteStatsBegin: site.statsBegin,+ ...opts.dashboardState+ })+ }+ })+}diff --git a/assets/js/dashboard/stats/sources/index.js b/assets/js/dashboard/stats/sources/index.jsdeleted file mode 100644index 8a63182bfe..0000000000--- a/assets/js/dashboard/stats/sources/index.js+++ /dev/null@@ -1,377 +0,0 @@-import React, { useCallback, useEffect, useState } from 'react'--import * as storage from '../../util/storage'-import * as url from '../../util/url'-import * as api from '../../api'-import usePrevious from '../../hooks/use-previous'-import ListReport from '../reports/list-legacy'-import * as metrics from '../reports/metrics'-import {- getFiltersByKeyPrefix,- hasConversionGoalFilter,- isFilteringOnFixedValue-} from '../../util/filters'-import ImportedQueryUnsupportedWarning from '../imported-query-unsupported-warning'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import { SourceFavicon } from './source-favicon'-import {- sourcesRoute,- referrersDrilldownRoute,- referrersGoogleRoute,- channelsRoute,- utmCampaignsRoute,- utmContentsRoute,- utmMediumsRoute,- utmSourcesRoute,- utmTermsRoute-} from '../../router'-import Referrers from './referrer-list'-import { SearchTerms } from './search-terms'-import { ReportLayout } from '../reports/report-layout'-import { ReportHeader } from '../reports/report-header'-import { DropdownTabButton, TabButton, TabWrapper } from '../../components/tabs'-import MoreLink from '../more-link'-import { MoreLinkState } from '../more-link-state'--const UTM_TAGS = {- utm_medium: {- title: 'UTM mediums',- label: 'Medium',- endpoint: '/utm_mediums'- },- utm_source: {- title: 'UTM sources',- label: 'Source',- endpoint: '/utm_sources'- },- utm_campaign: {- title: 'UTM campaigns',- label: 'Campaign',- endpoint: '/utm_campaigns'- },- utm_content: {- title: 'UTM contents',- label: 'Content',- endpoint: '/utm_contents'- },- utm_term: { title: 'UTM terms', label: 'Term', endpoint: '/utm_terms' }-}--function AllSources({ afterFetchData }) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()- function fetchData() {- return api.get(url.apiPath(site, '/sources'), dashboardState, { limit: 9 })- }-- function getFilterInfo(listItem) {- return {- prefix: 'source',- filter: ['is', 'source', [listItem['name']]]- }- }-- function renderIcon(listItem) {- return <SourceFavicon name={listItem.name} className="size-4 mr-2" />- }-- 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="Source"- metrics={chooseMetrics()}- renderIcon={renderIcon}- color="bg-blue-50 group-hover/row:bg-blue-100"- />- )-}--function Channels({ onClick, afterFetchData }) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- function fetchData() {- return api.get(url.apiPath(site, '/channels'), dashboardState, { limit: 9 })- }-- function getFilterInfo(listItem) {- return {- prefix: 'channel',- filter: ['is', 'channel', [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="Channel"- onClick={onClick}- metrics={chooseMetrics()}- color="bg-blue-50 group-hover/row:bg-blue-100"- />- )-}--function UTMSources({ tab, afterFetchData }) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()- const utmTag = UTM_TAGS[tab]-- function fetchData() {- return api.get(url.apiPath(site, utmTag.endpoint), dashboardState, {- limit: 9- })- }-- function getFilterInfo(listItem) {- return {- prefix: tab,- filter: ['is', tab, [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={utmTag.label}- metrics={chooseMetrics()}- color="bg-blue-50 group-hover/row:bg-blue-100"- />- )-}--export default function Sources() {- const site = useSiteContext()- const { dashboardState } = useDashboardStateContext()- const tabKey = 'sourceTab__' + site.domain- const storedTab = storage.getItem(tabKey)- const [currentTab, setCurrentTab] = useState(storedTab || 'all')- const [loading, setLoading] = useState(true)- const [skipImportedReason, setSkipImportedReason] = useState(null)- const [moreLinkState, setMoreLinkState] = useState(MoreLinkState.LOADING)- const previousDashboardState = usePrevious(dashboardState)-- useEffect(() => {- setLoading(true)- setMoreLinkState(MoreLinkState.LOADING)- }, [dashboardState, currentTab])-- useEffect(() => {- const isRemovingFilter = (filterName) => {- if (!previousDashboardState) return false-- return (- getFiltersByKeyPrefix(previousDashboardState, filterName).length > 0 &&- getFiltersByKeyPrefix(dashboardState, filterName).length == 0- )- }-- if (currentTab == 'all' && isRemovingFilter('channel')) {- setTab('channels')()- }- // eslint-disable-next-line react-hooks/exhaustive-deps- }, [dashboardState, currentTab])-- function setTab(tab) {- return () => {- storage.setItem(tabKey, tab)- setCurrentTab(tab)- }- }-- function sourceTabLabel() {- if (isFilteringOnFixedValue(dashboardState, 'source', 'Google')) {- return 'Search terms'- } else if (isFilteringOnFixedValue(dashboardState, 'source')) {- return 'Top referrers'- } else {- return 'Sources'- }- }-- function onChannelClick() {- setTab('all')()- }-- const onLoadStart = useCallback(() => {- setLoading(true)- setMoreLinkState(MoreLinkState.LOADING)- }, [])-- const afterFetchData = useCallback((apiResponse) => {- setLoading(false)- if (apiResponse) {- setSkipImportedReason(apiResponse.skip_imported_reason)- if (apiResponse.results && apiResponse.results.length > 0) {- setMoreLinkState(MoreLinkState.READY)- } else {- setMoreLinkState(MoreLinkState.HIDDEN)- }- } else {- setLoading(false)- setMoreLinkState(MoreLinkState.HIDDEN)- }- }, [])-- function sourceMoreLinkProps() {- if (isFilteringOnFixedValue(dashboardState, 'source', 'Google')) {- return {- path: referrersGoogleRoute.path,- search: (search) => search- }- } else if (isFilteringOnFixedValue(dashboardState, 'source')) {- const [[_operation, _filterKey, clauses]] = getFiltersByKeyPrefix(- dashboardState,- 'source'- )-- return {- path: referrersDrilldownRoute.path,- params: { referrer: url.maybeEncodeRouteParam(clauses[0]) },- search: (search) => search- }- } else {- return {- path: sourcesRoute.path,- search: (search) => search- }- }- }-- function moreLinkProps() {- if (Object.keys(UTM_TAGS).includes(currentTab)) {- const route = {- utm_medium: utmMediumsRoute,- utm_source: utmSourcesRoute,- utm_campaign: utmCampaignsRoute,- utm_content: utmContentsRoute,- utm_term: utmTermsRoute- }[currentTab]- return route- ? {- path: route.path,- search: (search) => search- }- : null- }-- if (currentTab === 'channels') {- return {- path: channelsRoute.path,- search: (search) => search- }- } else {- return sourceMoreLinkProps()- }- }-- function renderSourceContent() {- if (isFilteringOnFixedValue(dashboardState, 'source', 'Google')) {- return (- <SearchTerms- loading={loading}- afterFetchData={afterFetchData}- onLoadStart={onLoadStart}- />- )- } else if (isFilteringOnFixedValue(dashboardState, 'source')) {- const [[_operation, _filterKey, clauses]] = getFiltersByKeyPrefix(- dashboardState,- 'source'- )- return <Referrers source={clauses[0]} afterFetchData={afterFetchData} />- } else {- return <AllSources afterFetchData={afterFetchData} />- }- }-- function renderContent() {- if (Object.keys(UTM_TAGS).includes(currentTab)) {- return <UTMSources tab={currentTab} afterFetchData={afterFetchData} />- }-- if (currentTab === 'channels') {- return (- <Channels onClick={onChannelClick} afterFetchData={afterFetchData} />- )- } else {- return renderSourceContent()- }- }-- return (- <ReportLayout testId="report-sources" className="overflow-x-hidden">- <ReportHeader>- <div className="flex gap-x-3">- <TabWrapper>- {[- { value: 'channels', label: 'Channels' },- { value: 'all', label: sourceTabLabel() }- ].map(({ value, label }) => (- <TabButton- key={value}- onClick={setTab(value)}- active={currentTab === value}- >- {label}- </TabButton>- ))}- <DropdownTabButton- className="md:relative"- transitionClassName="md:left-auto md:w-56 md:origin-top-right"- active={Object.keys(UTM_TAGS).includes(currentTab)}- options={Object.entries(UTM_TAGS).map(([value, { title }]) => ({- value,- label: title,- onClick: setTab(value),- selected: currentTab === value- }))}- >- {UTM_TAGS[currentTab] ? UTM_TAGS[currentTab].title : 'Campaigns'}- </DropdownTabButton>- </TabWrapper>- <ImportedQueryUnsupportedWarning- loading={loading}- skipImportedReason={skipImportedReason}- />- </div>- <MoreLink state={moreLinkState} linkProps={moreLinkProps()} />- </ReportHeader>- {renderContent()}- </ReportLayout>- )-}diff --git a/assets/js/dashboard/stats/sources/index.tsx b/assets/js/dashboard/stats/sources/index.tsxnew file mode 100644index 0000000000..5f08011001--- /dev/null+++ b/assets/js/dashboard/stats/sources/index.tsx@@ -0,0 +1,366 @@+import React, { useCallback, useEffect, useState } from 'react'++import * as storage from '../../util/storage'+import * as url from '../../util/url'+import * as api from '../../api'+import usePrevious from '../../hooks/use-previous'+import {+ getFiltersByKeyPrefix,+ hasConversionGoalFilter,+ isFilteringOnFixedValue,+ isRealTimeDashboard+} from '../../util/filters'+import { useDashboardStateContext } from '../../dashboard-state-context'+import { useSiteContext } from '../../site-context'+import { SourceFavicon } from './source-favicon'+import { ReportLayout } from '../reports/report-layout'+import { ReportHeader } from '../reports/report-header'+import { DropdownTabButton, TabButton, TabWrapper } from '../../components/tabs'+import MoreLink from '../more-link'+import { MoreLinkState } from '../more-link-state'+import { DashboardState } from '../../dashboard-state'+import {+ BREAKDOWN_REPORTS,+ BreakdownReportKey+} from '../reports/reports-config'+import {+ DimensionCellWithBar,+ DimensionCellWithBarProps,+ IndexBreakdown+} from '../reports/index-breakdown'+import {+ chooseBreakdownMetricsByContext,+ defaultGetFilterInfo+} from '../breakdowns'+import ImportedWarningBubble from '../imported-warning-bubble'+import { IndexExternalLink } from '../pages/external-link'+import { SearchTerms } from './search-terms'+import {+ GOOGLE_SEARCH_TERMS_DETAILS_PATH,+ SearchTermsSuccessResponse+} from './fetch-search-terms'++const BAR_COLOR = 'bg-blue-50 group-hover/row:bg-blue-100'+const MAX_DIMENSION_LENGTH = 70+const SEARCH_TERMS_KEY = 'searchTerms'+export const DIRECT_NONE = 'Direct / None'++const UTM_TAB_KEYS = [+ BreakdownReportKey.utmMediums,+ BreakdownReportKey.utmSources,+ BreakdownReportKey.utmCampaigns,+ BreakdownReportKey.utmContents,+ BreakdownReportKey.utmTerms+] as const++type TabKey =+ | BreakdownReportKey.channels+ | BreakdownReportKey.sources+ | (typeof UTM_TAB_KEYS)[number]++type ReportKey = TabKey | BreakdownReportKey.referrers | typeof SEARCH_TERMS_KEY++const isGoogleSourceFilter = (dashboardState: DashboardState) => {+ return isFilteringOnFixedValue(dashboardState, 'source', 'Google')+}++const isFixedSourceFilter = (dashboardState: DashboardState) => {+ return isFilteringOnFixedValue(dashboardState, 'source')+}++const getFixedSourceFilterClause = (dashboardState: DashboardState) => {+ if (isFixedSourceFilter(dashboardState)) {+ const [[_operation, _filterKey, clauses]] = getFiltersByKeyPrefix(+ dashboardState,+ 'source'+ )++ return clauses[0]+ }+ return null+}++const getCurrentReportKey = (+ currentTab: TabKey,+ dashboardState: DashboardState+): ReportKey => {+ if (+ currentTab === BreakdownReportKey.sources &&+ isGoogleSourceFilter(dashboardState)+ ) {+ return SEARCH_TERMS_KEY+ }+ if (+ currentTab === BreakdownReportKey.sources &&+ isFixedSourceFilter(dashboardState)+ ) {+ return BreakdownReportKey.referrers+ }+ return currentTab+}++function initTab(storedMode: string): TabKey {+ if (['channels', BreakdownReportKey.channels].includes(storedMode)) {+ return BreakdownReportKey.channels+ }+ if (['utm_mediums', BreakdownReportKey.utmMediums].includes(storedMode)) {+ return BreakdownReportKey.utmMediums+ }+ if (['utm_sources', BreakdownReportKey.utmSources].includes(storedMode)) {+ return BreakdownReportKey.utmSources+ }+ if (['utm_campaigns', BreakdownReportKey.utmCampaigns].includes(storedMode)) {+ return BreakdownReportKey.utmCampaigns+ }+ if (['utm_contents', BreakdownReportKey.utmContents].includes(storedMode)) {+ return BreakdownReportKey.utmContents+ }+ if (['utm_terms', BreakdownReportKey.utmTerms].includes(storedMode)) {+ return BreakdownReportKey.utmTerms+ }+ return BreakdownReportKey.sources+}++function isUtmTab(tabKey: TabKey) {+ return (UTM_TAB_KEYS as ReadonlyArray<TabKey>).includes(tabKey)+}++export default function Sources() {+ const site = useSiteContext()+ const { dashboardState } = useDashboardStateContext()+ const tabStorageKey = 'sourceTab__' + site.domain+ const [currentTab, setTab] = useState<TabKey>(+ initTab(storage.getItem(tabStorageKey))+ )+ const [currentQueryApiData, setCurrentQueryApiData] =+ useState<api.QueryApiResponse | null>(null)+ const [currentSearchTermsData, setCurrentSearchTermsData] =+ useState<SearchTermsSuccessResponse | null>(null)++ const previousDashboardState = usePrevious(dashboardState)++ const currentReportKey = getCurrentReportKey(currentTab, dashboardState)++ const setAndStoreTab = useCallback(+ (tab: TabKey) => {+ storage.setItem(tabStorageKey, tab)+ setTab(tab)+ },+ [tabStorageKey]+ )++ function moreLinkProps() {+ if (currentReportKey === SEARCH_TERMS_KEY) {+ return {+ path: GOOGLE_SEARCH_TERMS_DETAILS_PATH,+ search: (search: string) => search+ }+ }+ if (currentReportKey === BreakdownReportKey.referrers) {+ return {+ path: BREAKDOWN_REPORTS[currentReportKey].detailsPath,+ params: {+ referrer: url.maybeEncodeRouteParam(+ getFixedSourceFilterClause(dashboardState)+ )+ },+ search: (search: string) => search+ }+ }+ return {+ path: BREAKDOWN_REPORTS[currentReportKey].detailsPath,+ search: (search: string) => search+ }+ }++ const ChannelsDimensionCell = useCallback(+ (props: DimensionCellWithBarProps) => (+ <DimensionCellWithBar+ text={url.trimURL(props.row.dimensions[0], MAX_DIMENSION_LENGTH)}+ onClick={() => setAndStoreTab(BreakdownReportKey.sources)}+ barClassName={BAR_COLOR}+ getFilterInfo={defaultGetFilterInfo}+ {...props}+ />+ ),+ [setAndStoreTab]+ )++ function renderContent() {+ if (currentReportKey === SEARCH_TERMS_KEY) {+ return <SearchTerms onDataReady={setCurrentSearchTermsData} />+ }++ const reportConfig = BREAKDOWN_REPORTS[currentReportKey]++ const metrics = chooseBreakdownMetricsByContext(+ reportConfig.metricsByContext,+ {+ isRealtime: isRealTimeDashboard(dashboardState),+ isDetailed: false,+ hasConversionGoalFilter: hasConversionGoalFilter(dashboardState),+ isRevenueAvailable: false+ }+ )++ const DimensionElement = {+ [BreakdownReportKey.channels]: ChannelsDimensionCell,+ [BreakdownReportKey.sources]: SourcesDimensionCell,+ [BreakdownReportKey.referrers]: ReferrerUrlDimensionCell,+ [BreakdownReportKey.utmMediums]: UtmDimensionCell,+ [BreakdownReportKey.utmSources]: UtmDimensionCell,+ [BreakdownReportKey.utmCampaigns]: UtmDimensionCell,+ [BreakdownReportKey.utmContents]: UtmDimensionCell,+ [BreakdownReportKey.utmTerms]: UtmDimensionCell+ }[currentReportKey]++ return (+ <IndexBreakdown+ metrics={metrics}+ dimensions={reportConfig.dimensions}+ dimensionLabel={reportConfig.dimensionLabel}+ DimensionElement={DimensionElement}+ onDataReady={setCurrentQueryApiData}+ />+ )+ }++ const activeData =+ currentReportKey === SEARCH_TERMS_KEY+ ? currentSearchTermsData+ : currentQueryApiData++ const moreLinkState = activeData+ ? activeData.results.length > 0+ ? MoreLinkState.READY+ : MoreLinkState.HIDDEN+ : MoreLinkState.LOADING++ useEffect(() => {+ const isRemovingFilter = (filterName: string) => {+ if (!previousDashboardState) return false++ return (+ getFiltersByKeyPrefix(previousDashboardState, filterName).length > 0 &&+ getFiltersByKeyPrefix(dashboardState, filterName).length == 0+ )+ }++ if (+ currentTab == BreakdownReportKey.sources &&+ isRemovingFilter('channel')+ ) {+ setAndStoreTab(BreakdownReportKey.channels)+ }+ // eslint-disable-next-line react-hooks/exhaustive-deps+ }, [dashboardState, currentTab])++ function sourceTabLabel() {+ if (isGoogleSourceFilter(dashboardState)) {+ return 'Search terms'+ } else if (isFixedSourceFilter(dashboardState)) {+ return 'Top referrers'+ } else {+ return 'Sources'+ }+ }++ return (+ <ReportLayout testId="report-sources" className="overflow-x-hidden">+ <ReportHeader>+ <div className="flex gap-x-3">+ <TabWrapper>+ {[+ { value: BreakdownReportKey.channels, label: 'Channels' },+ { value: BreakdownReportKey.sources, label: sourceTabLabel() }+ ].map(({ value, label }) => (+ <TabButton+ key={value}+ onClick={() => setAndStoreTab(value as TabKey)}+ active={currentTab === value}+ >+ {label}+ </TabButton>+ ))}+ <DropdownTabButton+ className="md:relative"+ transitionClassName="md:left-auto md:w-56 md:origin-top-right"+ active={isUtmTab(currentTab)}+ options={UTM_TAB_KEYS.map((utmTabKey) => ({+ label: BREAKDOWN_REPORTS[utmTabKey].detailsTitle,+ onClick: () => setAndStoreTab(utmTabKey),+ selected: currentTab === utmTabKey+ }))}+ >+ {isUtmTab(currentTab)+ ? BREAKDOWN_REPORTS[currentTab].detailsTitle+ : 'Campaigns'}+ </DropdownTabButton>+ </TabWrapper>+ {currentReportKey !== SEARCH_TERMS_KEY && (+ <ImportedWarningBubble queryApiResponse={currentQueryApiData} />+ )}+ </div>+ <MoreLink state={moreLinkState} linkProps={moreLinkProps()} />+ </ReportHeader>+ {renderContent()}+ </ReportLayout>+ )+}++function UtmDimensionCell(props: DimensionCellWithBarProps) {+ const displayValue = url.trimURL(+ props.row.dimensions[0],+ MAX_DIMENSION_LENGTH+ )+ return (+ <DimensionCellWithBar+ text={displayValue}+ barClassName={BAR_COLOR}+ getFilterInfo={defaultGetFilterInfo}+ {...props}+ />+ )+}++function SourcesDimensionCell(props: DimensionCellWithBarProps) {+ const displayValue = url.trimURL(+ props.row.dimensions[0],+ MAX_DIMENSION_LENGTH+ )++ return (+ <DimensionCellWithBar+ text={displayValue}+ icon={+ <SourceFavicon name={props.row.dimensions[0]} className="size-4 mr-2" />+ }+ barClassName={BAR_COLOR}+ getFilterInfo={defaultGetFilterInfo}+ {...props}+ />+ )+}++function ReferrerUrlDimensionCell(props: DimensionCellWithBarProps) {+ const dimensionValue = props.row.dimensions[0]+ const displayValue = url.trimURL(dimensionValue, MAX_DIMENSION_LENGTH)++ const externalUrl =+ dimensionValue === DIRECT_NONE ? null : `https://${dimensionValue}`++ return (+ <DimensionCellWithBar+ text={displayValue}+ icon={<SourceFavicon name={dimensionValue} className="size-4 mr-2" />}+ externalLink={+ externalUrl && (+ <IndexExternalLink href={externalUrl} isActive={props.isActive} />+ )+ }+ barClassName={BAR_COLOR}+ getFilterInfo={defaultGetFilterInfo}+ {...props}+ />+ )+}diff --git a/assets/js/dashboard/stats/sources/referrer-list.js b/assets/js/dashboard/stats/sources/referrer-list.jsdeleted file mode 100644index 99b8a5a48f..0000000000--- a/assets/js/dashboard/stats/sources/referrer-list.js+++ /dev/null@@ -1,71 +0,0 @@-import React from 'react'-import * as api from '../../api'-import * as url from '../../util/url'-import * as metrics from '../reports/metrics'-import { hasConversionGoalFilter } from '../../util/filters'-import ListReport from '../reports/list-legacy'-import { useDashboardStateContext } from '../../dashboard-state-context'-import { useSiteContext } from '../../site-context'-import { SourceFavicon } from './source-favicon'--const NO_REFERRER = 'Direct / None'--export default function Referrers({ source, afterFetchData }) {- const { dashboardState } = useDashboardStateContext()- const site = useSiteContext()-- function fetchReferrers() {- return api.get(- url.apiPath(site, `/referrers/${encodeURIComponent(source)}`),- dashboardState,- { limit: 9 }- )- }-- function getExternalLinkUrl(referrer) {- if (referrer.name === NO_REFERRER) {- return null- }- return `https://${referrer.name}`- }-- function getFilterInfo(referrer) {- if (referrer.name === NO_REFERRER) {- return null- }-- return {- prefix: 'referrer',- filter: ['is', 'referrer', [referrer.name]]- }- }-- function renderIcon(listItem) {- return (- <SourceFavicon- name={listItem.name}- className="inline size-4 mr-2 -mt-px align-middle"- />- )- }-- function chooseMetrics() {- return [- metrics.createVisitors({ meta: { plot: true } }),- hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()- ].filter((metric) => !!metric)- }-- return (- <ListReport- fetchData={fetchReferrers}- afterFetchData={afterFetchData}- getFilterInfo={getFilterInfo}- keyLabel="Referrer"- metrics={chooseMetrics()}- getExternalLinkUrl={getExternalLinkUrl}- renderIcon={renderIcon}- color="bg-blue-50"- />- )-}diff --git a/assets/js/dashboard/stats/sources/search-terms.tsx b/assets/js/dashboard/stats/sources/search-terms.tsxindex 525f706eb5..a277690abc 100644--- a/assets/js/dashboard/stats/sources/search-terms.tsx+++ b/assets/js/dashboard/stats/sources/search-terms.tsx@@ -1,26 +1,23 @@-import React, { useEffect, useCallback } from 'react'-import FadeIn from '../../fade-in'-import Bar from '../bar'+import React, { useEffect, useMemo } from 'react'import { numberShortFormatter } from '../../util/number-formatter'import RocketIcon from '../modals/rocket-icon'-import * as api from '../../api'import LazyLoader from '../../components/lazy-loader'-import { useDashboardStateContext } from '../../dashboard-state-context'import { PlausibleSite, useSiteContext } from '../../site-context'--interface SearchTerm {- name: string- visitors: number-}--type ErrorCode = 'not_configured' | 'unsupported_filters' | 'period_too_recent'--interface ErrorPayload {- error_code: ErrorCode- is_admin: boolean-}--function ErrorMessage({ code }: { code: ErrorCode }): JSX.Element {+import {+ SearchTermsErrorCode,+ SearchTermsErrorPayload,+ SearchTermsResultItem,+ SearchTermsSuccessResponse,+ useIndexGoogleSearchTermsQuery+} from './fetch-search-terms'+import {+ Bar,+ DEFAULT_METRIC_COLUMN_WIDTH,+ IndexBreakdownRenderer+} from '../reports/index-breakdown'+import { ColumnConfiguration, MetricValueWrapper } from '../breakdowns'++function ErrorMessage({ code }: { code: SearchTermsErrorCode }): JSX.Element {if (code === 'not_configured') {return <div>The site is not connected to Google Search Keywords</div>} else if (code === 'unsupported_filters') {@@ -69,140 +66,86 @@ function ConfigureSearchTermsCTA({)}-interface SearchTermsProps {- loading: boolean- afterFetchData: (res: object | null) => void- onLoadStart: () => void-}-export function SearchTerms({- loading,- afterFetchData,- onLoadStart-}: SearchTermsProps) {+ onDataReady+}: {+ onDataReady: (data: SearchTermsSuccessResponse) => void+}) {const site = useSiteContext()- const { dashboardState } = useDashboardStateContext()- const [errorPayload, setErrorPayload] = React.useState<null | ErrorPayload>(- null- )- const [searchTerms, setSearchTerms] = React.useState<null | SearchTerm[]>(- null- )const [visible, setVisible] = React.useState(false)- const fetchSearchTerms = useCallback(() => {- api- .get(- `/api/stats/${encodeURIComponent(site.domain)}/referrers/Google`,- dashboardState- )- .then((res) => {- setSearchTerms(res.results)- setErrorPayload(null)- afterFetchData(res)- })- .catch((error) => {- setSearchTerms(null)- setErrorPayload(error.payload)- afterFetchData(null)- })- }, [dashboardState, afterFetchData, site.domain])+ const apiState = useIndexGoogleSearchTermsQuery({ enabled: visible })useEffect(() => {- if (visible) {- onLoadStart()- setSearchTerms([])- fetchSearchTerms()+ if (apiState.data) {+ onDataReady(apiState.data)}- }, [dashboardState, fetchSearchTerms, onLoadStart, visible])-- const onVisible = () => {- setVisible(true)- }-- const renderList = () => {- if (searchTerms && searchTerms.length > 0) {- return (- <React.Fragment>- <div className="flex items-center mt-3 mb-2 justify-between text-gray-500 dark:text-gray-400 text-xs font-bold tracking-wide">- <span data-testid="report-header">Search term</span>- <span data-testid="report-header">Visitors</span>- </div>- {searchTerms &&- searchTerms.map((term: SearchTerm) => (- <div- data-testid="report-row"- className="flex items-center justify-between my-1 text-sm"- key={term.name}- >- <Bar- count={term.visitors}- all={searchTerms}- bg="bg-blue-50 dark:bg-gray-500/15"- maxWidthDeduction="4rem"- >- <span className="flex px-2 py-1.5 dark:text-gray-300 z-9 relative break-all">- <span className="md:truncate block">{term.name}</span>- </span>- </Bar>- <span- className="font-medium dark:text-gray-200"- data-testid="metric-value"- >- {numberShortFormatter(term.visitors)}- </span>- </div>- ))}- </React.Fragment>- )- }- }-- const renderNoDataYet = () => {- if (searchTerms && searchTerms.length === 0) {- return (- <div className="text-center text-gray-700 dark:text-gray-300 ">- <div className="mt-44 mx-auto font-medium text-gray-500 dark:text-gray-400">- No data yet- </div>- </div>- )+ }, [apiState.data, onDataReady])++ const barMaxValue = useMemo(() => {+ if (!apiState.data) return null+ return Math.max(...apiState.data.results.map((item) => item.visitors))+ }, [apiState.data])++ const columns = useMemo(():+ | ColumnConfiguration<SearchTermsResultItem>[]+ | null => {+ if (barMaxValue === null) {+ return null}- }- const renderError = () => {- if (errorPayload) {- const { is_admin, error_code } = errorPayload+ return [+ {+ key: 'dimension',+ renderLabel: () => 'Search term',+ renderCell: (item, _isActive) => (+ <Bar+ barWidthPercent={(item.visitors / barMaxValue) * 100}+ className="bg-blue-50 group-hover/row:bg-blue-100"+ >+ {item.name}+ </Bar>+ ),+ align: 'left'+ },+ {+ key: 'visitors',+ renderLabel: () => 'Visitors',+ renderCell: (item, _isActive) => (+ <MetricValueWrapper>+ {numberShortFormatter(item.visitors)}+ </MetricValueWrapper>+ ),+ width: DEFAULT_METRIC_COLUMN_WIDTH,+ align: 'right'+ }+ ]+ }, [barMaxValue])++ if (apiState.error) {+ const { is_admin, error_code } = apiState.error+ .payload as SearchTermsErrorPayload- return (- <div className="text-center text-gray-700 dark:text-gray-300 text-sm mt-20">- <RocketIcon />- <ErrorMessage code={error_code} />- {error_code === 'not_configured' && is_admin && (- <ConfigureSearchTermsCTA site={site} />- )}- </div>- )- }+ return (+ <div className="text-center text-gray-700 dark:text-gray-300 text-sm mt-20">+ <RocketIcon />+ <ErrorMessage code={error_code} />+ {error_code === 'not_configured' && is_admin && (+ <ConfigureSearchTermsCTA site={site} />+ )}+ </div>+ )}-return (- <div className="relative grow">- {loading && (- <div className="absolute inset-0 flex justify-center items-center">- <div className="loading">- <div />- </div>- </div>- )}- <FadeIn show={!loading} className="grow">- <LazyLoader onVisible={onVisible}>- {searchTerms && searchTerms.length > 0 && renderList()}- {searchTerms && searchTerms.length === 0 && renderNoDataYet()}- {errorPayload && renderError()}- </LazyLoader>- </FadeIn>- </div>+ <LazyLoader onVisible={() => setVisible(true)}>+ <IndexBreakdownRenderer<SearchTermsResultItem>+ {...apiState}+ rows={apiState.data?.results ?? []}+ getDimensionValue={(row) => row.name}+ isRealtimeSilentUpdate={false}+ columns={columns}+ />+ </LazyLoader>)}diff --git a/e2e/tests/dashboard/breakdowns.spec.ts b/e2e/tests/dashboard/breakdowns.spec.tsindex 9d0fa65d68..cf13664d60 100644--- a/e2e/tests/dashboard/breakdowns.spec.ts+++ b/e2e/tests/dashboard/breakdowns.spec.ts@@ -244,7 +244,7 @@ test('sources breakdown', async ({ page, request }) => {'true')- await expectHeaders(report, ['Medium', 'Visitors'])+ await expectHeaders(report, ['UTM medium', 'Visitors'])await expectRows(report, ['SomeUTMMedium', 'paid'])@@ -256,7 +256,7 @@ test('sources breakdown', async ({ page, request }) => {await detailsLink(report).click()await expect(- modal(page).getByRole('heading', { name: 'Top UTM mediums' })+ modal(page).getByRole('heading', { name: 'UTM mediums' })).toBeVisible()await expectHeaders(modal(page), [@@ -282,7 +282,7 @@ test('sources breakdown', async ({ page, request }) => {'true')- await expectHeaders(report, ['Source', 'Visitors'])+ await expectHeaders(report, ['UTM source', 'Visitors'])await expectRows(report, ['SomeUTMSource', 'fb'])@@ -294,7 +294,7 @@ test('sources breakdown', async ({ page, request }) => {await detailsLink(report).click()await expect(- modal(page).getByRole('heading', { name: 'Top UTM sources' })+ modal(page).getByRole('heading', { name: 'UTM sources' })).toBeVisible()await expectHeaders(modal(page), [@@ -322,7 +322,7 @@ test('sources breakdown', async ({ page, request }) => {'true')- await expectHeaders(report, ['Campaign', 'Visitors'])+ await expectHeaders(report, ['UTM campaign', 'Visitors'])await expectRows(report, ['SomeUTMCampaign'])@@ -333,7 +333,7 @@ test('sources breakdown', async ({ page, request }) => {await detailsLink(report).click()await expect(- modal(page).getByRole('heading', { name: 'Top UTM campaigns' })+ modal(page).getByRole('heading', { name: 'UTM campaigns' })).toBeVisible()await expectHeaders(modal(page), [@@ -363,7 +363,7 @@ test('sources breakdown', async ({ page, request }) => {'true')- await expectHeaders(report, ['Content', 'Visitors'])+ await expectHeaders(report, ['UTM content', 'Visitors'])await expectRows(report, ['SomeUTMContent'])@@ -374,7 +374,7 @@ test('sources breakdown', async ({ page, request }) => {await detailsLink(report).click()await expect(- modal(page).getByRole('heading', { name: 'Top UTM contents' })+ modal(page).getByRole('heading', { name: 'UTM contents' })).toBeVisible()await expectHeaders(modal(page), [@@ -400,7 +400,7 @@ test('sources breakdown', async ({ page, request }) => {'true')- await expectHeaders(report, ['Term', 'Visitors'])+ await expectHeaders(report, ['UTM term', 'Visitors'])await expectRows(report, ['SomeUTMTerm'])@@ -411,7 +411,7 @@ test('sources breakdown', async ({ page, request }) => {await detailsLink(report).click()await expect(- modal(page).getByRole('heading', { name: 'Top UTM terms' })+ modal(page).getByRole('heading', { name: 'UTM terms' })).toBeVisible()await expectHeaders(modal(page), [diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.exindex d783b63fb0..945f2e23d3 100644--- a/lib/plausible_web/controllers/api/stats_controller.ex+++ b/lib/plausible_web/controllers/api/stats_controller.ex@@ -524,7 +524,7 @@ defmodule PlausibleWeb.Api.StatsController doendend- def referrer_drilldown(conn, %{"referrer" => "Google"} = params) do+ def google_search_terms(conn, params) dosite = conn.assigns[:site]query = Query.from(site, params, debug_metadata: debug_metadata(conn))diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.exindex be2c099abe..e655de73e0 100644--- a/lib/plausible_web/router.ex+++ b/lib/plausible_web/router.ex@@ -281,6 +281,7 @@ defmodule PlausibleWeb.Router doscope private: %{allow_consolidated_views: true} dopost "/:domain/query", StatsController, :query+ get "/:domain/google-search-terms", StatsController, :google_search_termsget "/:domain/current-visitors", StatsController, :current_visitorsget "/:domain/sources", StatsController, :sourcesget "/:domain/channels", StatsController, :channelsdiff --git a/test/plausible_web/controllers/api/stats_controller/sources_legacy_test.exs b/test/plausible_web/controllers/api/stats_controller/sources_legacy_test.exsindex db82f75a8e..c8487c8719 100644--- a/test/plausible_web/controllers/api/stats_controller/sources_legacy_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/sources_legacy_test.exs@@ -2635,7 +2635,7 @@ defmodule PlausibleWeb.Api.StatsController.SourcesLegacyTest dosetup [:create_user, :log_in, :create_site]test "gets keywords from Google", %{conn: conn, site: site} do- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day")+ conn = get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day")assert %{"results" => [@@ -2663,7 +2663,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesLegacyTest do} dofilters = Jason.encode!([[:is, "event:page", ["/empty"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=30d&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=30d&filters=#{filters}")assert json_response(conn, 200) == %{"results" => []}end@@ -2674,7 +2675,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesLegacyTest do} dofilters = Jason.encode!([[:is, "event:page", ["/empty"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")assert json_response(conn, 422) == %{"error_code" => "period_too_recent"}end@@ -2685,7 +2687,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesLegacyTest do} dofilters = Jason.encode!([[:is, "event:page", ["/not-configured"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")assert %{"error_code" => "not_configured", "is_admin" => true} = json_response(conn, 422)end@@ -2695,7 +2698,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesLegacyTest dofilters = Jason.encode!([[:is, "event:page", ["/not-configured"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")%{"error_code" => "not_configured",@@ -2706,7 +2710,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesLegacyTest dotest "returns 422 with error when unsupported filters used", %{conn: conn, site: site} dofilters = Jason.encode!([[:is, "event:page", ["/unsupported-filters"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")assert %{"error_code" => "unsupported_filters"} = json_response(conn, 422)end@@ -2718,7 +2723,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesLegacyTest do} dofilters = Jason.encode!([[:is, "event:page", ["/unexpected-error"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")assert %{"error_code" => "not_configured"} = json_response(conn, 502)enddiff --git a/test/plausible_web/controllers/api/stats_controller/sources_test.exs b/test/plausible_web/controllers/api/stats_controller/sources_test.exsindex c10e35177a..b831fdda95 100644--- a/test/plausible_web/controllers/api/stats_controller/sources_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/sources_test.exs@@ -2501,7 +2501,7 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest dosetup [:create_user, :log_in, :create_site]test "gets keywords from Google", %{conn: conn, site: site} do- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day")+ conn = get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day")assert %{"results" => [@@ -2529,7 +2529,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest do} dofilters = Jason.encode!([[:is, "event:page", ["/empty"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=30d&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=30d&filters=#{filters}")assert json_response(conn, 200) == %{"results" => []}end@@ -2540,7 +2541,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest do} dofilters = Jason.encode!([[:is, "event:page", ["/empty"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")assert json_response(conn, 422) == %{"error_code" => "period_too_recent"}end@@ -2551,7 +2553,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest do} dofilters = Jason.encode!([[:is, "event:page", ["/not-configured"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")assert %{"error_code" => "not_configured", "is_admin" => true} = json_response(conn, 422)end@@ -2561,7 +2564,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest dofilters = Jason.encode!([[:is, "event:page", ["/not-configured"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")%{"error_code" => "not_configured",@@ -2572,7 +2576,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest dotest "returns 422 with error when unsupported filters used", %{conn: conn, site: site} dofilters = Jason.encode!([[:is, "event:page", ["/unsupported-filters"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")assert %{"error_code" => "unsupported_filters"} = json_response(conn, 422)end@@ -2584,7 +2589,8 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest do} dofilters = Jason.encode!([[:is, "event:page", ["/unexpected-error"]]])- conn = get(conn, "/api/stats/#{site.domain}/referrers/Google?period=day&filters=#{filters}")+ conn =+ get(conn, "/api/stats/#{site.domain}/google-search-terms?period=day&filters=#{filters}")assert %{"error_code" => "not_configured"} = json_response(conn, 502)end