Skip to content

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

Render top referrers and search terms within the context of sources tabs (#6204)

Adrian Gruntkowskidb9ab08aeb9c
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9938709b34..4ed20bccee 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -21,6 +21,7 @@ All notable changes to this project will be documented in this file.
- Keybind hints are hidden on smaller screens
- Site index is sortable alphanumerically and by traffic
+- "Top referrers" and "Search terms" breakdowns are rendered side by side with other "Sources" tabs instead of replacing them
### Fixed
diff --git a/assets/js/dashboard/stats/sources/index.js b/assets/js/dashboard/stats/sources/index.js
index f37672b26a..48b8574255 100644
--- a/assets/js/dashboard/stats/sources/index.js
+++ b/assets/js/dashboard/stats/sources/index.js
@@ -1,25 +1,377 @@
-import React from 'react'
-import { SearchTerms } from './search-terms'
-import SourceList from './source-list'
-import ReferrerList from './referrer-list'
+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'
+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'
+ }
+ }
- if (isFilteringOnFixedValue(dashboardState, 'source', 'Google')) {
- return <SearchTerms />
- } else if (isFilteringOnFixedValue(dashboardState, 'source')) {
- const [[_operation, _filterKey, clauses]] = getFiltersByKeyPrefix(
- dashboardState,
- 'source'
- )
- return <ReferrerList source={clauses[0]} />
- } else {
- return <SourceList />
+ 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/referrer-list.js b/assets/js/dashboard/stats/sources/referrer-list.js
index 602fc6261e..f6b6c76280 100644
--- a/assets/js/dashboard/stats/sources/referrer-list.js
+++ b/assets/js/dashboard/stats/sources/referrer-list.js
@@ -1,33 +1,18 @@
-import React, { useEffect, useState } from 'react'
+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'
-import ImportedQueryUnsupportedWarning from '../../stats/imported-query-unsupported-warning'
import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
-import { referrersDrilldownRoute } from '../../router'
import { SourceFavicon } from './source-favicon'
-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'
const NO_REFERRER = 'Direct / None'
-export default function Referrers({ source }) {
+export default function Referrers({ source, afterFetchData }) {
const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
- const [skipImportedReason, setSkipImportedReason] = useState(null)
- const [loading, setLoading] = useState(true)
- const [moreLinkState, setMoreLinkState] = useState(MoreLinkState.LOADING)
-
- useEffect(() => {
- setLoading(true)
- setMoreLinkState(MoreLinkState.LOADING)
- }, [dashboardState])
function fetchReferrers() {
return api.get(
@@ -37,16 +22,6 @@ export default function Referrers({ source }) {
)
}
- function afterFetchReferrers(apiResponse) {
- setLoading(false)
- setSkipImportedReason(apiResponse.skip_imported_reason)
- if (apiResponse.results && apiResponse.results.length > 0) {
- setMoreLinkState(MoreLinkState.READY)
- } else {
- setMoreLinkState(MoreLinkState.HIDDEN)
- }
- }
-
function getExternalLinkUrl(referrer) {
if (referrer.name === NO_REFERRER) {
return null
@@ -82,38 +57,15 @@ export default function Referrers({ source }) {
}
return (
- <ReportLayout testId="report-referrers" className="overflow-x-hidden">
- <ReportHeader>
- <div className="flex gap-x-3">
- <TabWrapper>
- <TabButton active={true} onClick={() => {}}>
- Top referrers
- </TabButton>
- </TabWrapper>
- <ImportedQueryUnsupportedWarning
- loading={loading}
- skipImportedReason={skipImportedReason}
- />
- </div>
- <MoreLink
- state={moreLinkState}
- linkProps={{
- path: referrersDrilldownRoute.path,
- params: { referrer: url.maybeEncodeRouteParam(source) },
- search: (search) => search
- }}
- />
- </ReportHeader>
- <ListReport
- fetchData={fetchReferrers}
- afterFetchData={afterFetchReferrers}
- getFilterInfo={getFilterInfo}
- keyLabel="Referrer"
- metrics={chooseMetrics()}
- getExternalLinkUrl={getExternalLinkUrl}
- renderIcon={renderIcon}
- color="bg-blue-50"
- />
- </ReportLayout>
+ <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.tsx
index 0f9c4099f2..525f706eb5 100644
--- a/assets/js/dashboard/stats/sources/search-terms.tsx
+++ b/assets/js/dashboard/stats/sources/search-terms.tsx
@@ -7,12 +7,6 @@ import * as api from '../../api'
import LazyLoader from '../../components/lazy-loader'
import { useDashboardStateContext } from '../../dashboard-state-context'
import { PlausibleSite, 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 { referrersGoogleRoute } from '../../router'
interface SearchTerm {
name: string
@@ -75,14 +69,20 @@ function ConfigureSearchTermsCTA({
)
}
-export function SearchTerms() {
+interface SearchTermsProps {
+ loading: boolean
+ afterFetchData: (res: object | null) => void
+ onLoadStart: () => void
+}
+
+export function SearchTerms({
+ loading,
+ afterFetchData,
+ onLoadStart
+}: SearchTermsProps) {
const site = useSiteContext()
const { dashboardState } = useDashboardStateContext()
- const [moreLinkState, setMoreLinkState] = React.useState(
- MoreLinkState.LOADING
- )
- const [loading, setLoading] = React.useState(true)
const [errorPayload, setErrorPayload] = React.useState<null | ErrorPayload>(
null
)
@@ -98,31 +98,24 @@ export function SearchTerms() {
dashboardState
)
.then((res) => {
- setLoading(false)
setSearchTerms(res.results)
setErrorPayload(null)
- if (res.results && res.results.length > 0) {
- setMoreLinkState(MoreLinkState.READY)
- } else {
- setMoreLinkState(MoreLinkState.HIDDEN)
- }
+ afterFetchData(res)
})
.catch((error) => {
- setLoading(false)
setSearchTerms(null)
setErrorPayload(error.payload)
- setMoreLinkState(MoreLinkState.HIDDEN)
+ afterFetchData(null)
})
- }, [dashboardState, site.domain])
+ }, [dashboardState, afterFetchData, site.domain])
useEffect(() => {
if (visible) {
- setLoading(true)
+ onLoadStart()
setSearchTerms([])
- setMoreLinkState(MoreLinkState.LOADING)
fetchSearchTerms()
}
- }, [dashboardState, fetchSearchTerms, visible])
+ }, [dashboardState, fetchSearchTerms, onLoadStart, visible])
const onVisible = () => {
setVisible(true)
@@ -133,12 +126,13 @@ export function SearchTerms() {
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>Search term</span>
- <span>Visitors</span>
+ <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}
>
@@ -152,7 +146,10 @@ export function SearchTerms() {
<span className="md:truncate block">{term.name}</span>
</span>
</Bar>
- <span className="font-medium dark:text-gray-200">
+ <span
+ className="font-medium dark:text-gray-200"
+ data-testid="metric-value"
+ >
{numberShortFormatter(term.visitors)}
</span>
</div>
@@ -191,39 +188,21 @@ export function SearchTerms() {
}
return (
- <ReportLayout>
- <ReportHeader>
- <div className="flex gap-x-3">
- <TabWrapper>
- <TabButton active={true} onClick={() => {}}>
- Search terms
- </TabButton>
- </TabWrapper>
- </div>
- <MoreLink
- state={moreLinkState}
- linkProps={{
- path: referrersGoogleRoute.path,
- search: (search: URLSearchParams) => search
- }}
- />
- </ReportHeader>
- <div className="relative grow">
- {loading && (
- <div className="absolute inset-0 flex justify-center items-center">
- <div className="loading">
- <div />
- </div>
+ <div className="relative grow">
+ {loading && (
+ <div className="absolute inset-0 flex justify-center items-center">
+ <div className="loading">
+ <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>
- </ReportLayout>
+ </div>
+ )}
+ <FadeIn show={!loading} className="grow">
+ <LazyLoader onVisible={onVisible}>
+ {searchTerms && searchTerms.length > 0 && renderList()}
+ {searchTerms && searchTerms.length === 0 && renderNoDataYet()}
+ {errorPayload && renderError()}
+ </LazyLoader>
+ </FadeIn>
+ </div>
)
}
diff --git a/assets/js/dashboard/stats/sources/source-list.js b/assets/js/dashboard/stats/sources/source-list.js
deleted file mode 100644
index 495a3b3b8a..0000000000
--- a/assets/js/dashboard/stats/sources/source-list.js
+++ /dev/null
@@ -1,314 +0,0 @@
-import React, { 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'
-import * as metrics from '../reports/metrics'
-import {
- getFiltersByKeyPrefix,
- hasConversionGoalFilter
-} 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,
- channelsRoute,
- utmCampaignsRoute,
- utmContentsRoute,
- utmMediumsRoute,
- utmSourcesRoute,
- utmTermsRoute
-} from '../../router'
-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 SourceList() {
- 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 onChannelClick() {
- setTab('all')()
- }
-
- function afterFetchData(apiResponse) {
- setLoading(false)
- setSkipImportedReason(apiResponse.skip_imported_reason)
- if (apiResponse.results && apiResponse.results.length > 0) {
- setMoreLinkState(MoreLinkState.READY)
- } else {
- setMoreLinkState(MoreLinkState.HIDDEN)
- }
- }
-
- 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
- }
-
- switch (currentTab) {
- case 'channels':
- return {
- path: channelsRoute.path,
- search: (search) => search
- }
- case 'all':
- default:
- return {
- path: sourcesRoute.path,
- search: (search) => search
- }
- }
- }
-
- function renderContent() {
- if (Object.keys(UTM_TAGS).includes(currentTab)) {
- return <UTMSources tab={currentTab} afterFetchData={afterFetchData} />
- }
-
- switch (currentTab) {
- case 'channels':
- return (
- <Channels onClick={onChannelClick} afterFetchData={afterFetchData} />
- )
- case 'all':
- default:
- return <AllSources afterFetchData={afterFetchData} />
- }
- }
-
- return (
- <ReportLayout testId="report-sources" className="overflow-x-hidden">
- <ReportHeader>
- <div className="flex gap-x-3">
- <TabWrapper>
- {[
- { value: 'channels', label: 'Channels' },
- { value: 'all', label: 'Sources' }
- ].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/config/e2e_test.exs b/config/e2e_test.exs
index 697727ec3a..c881cdec49 100644
--- a/config/e2e_test.exs
+++ b/config/e2e_test.exs
@@ -4,7 +4,9 @@ config :plausible, PlausibleWeb.Endpoint,
server: true,
check_origin: false
-config :plausible, paddle_api: Plausible.Billing.DevPaddleApiMock
+config :plausible,
+ paddle_api: Plausible.Billing.DevPaddleApiMock,
+ google_api: Plausible.Google.API.Mock
config :phoenix, :stacktrace_depth, 20
config :phoenix, :plug_init_mode, :runtime
diff --git a/e2e/tests/dashboard/breakdowns.spec.ts b/e2e/tests/dashboard/breakdowns.spec.ts
index 34eaf3b03d..4e5596d913 100644
--- a/e2e/tests/dashboard/breakdowns.spec.ts
+++ b/e2e/tests/dashboard/breakdowns.spec.ts
@@ -39,6 +39,7 @@ test('sources breakdown', async ({ page, request }) => {
{ name: 'pageview', referrer_source: 'ablog.example.com' },
{
name: 'pageview',
+ referrer_source: 'Google',
utm_medium: 'SomeUTMMedium',
utm_source: 'SomeUTMSource',
utm_campaign: 'SomeUTMCampaign',
@@ -61,15 +62,15 @@ test('sources breakdown', async ({ page, request }) => {
await expectRows(report, [
'DuckDuckGo',
- 'Direct / None',
'Facebook',
+ 'Google',
'ablog.example.com',
'theguardian.com'
])
await expectMetricValues(report, 'DuckDuckGo', ['2', '33.3%'])
- await expectMetricValues(report, 'Direct / None', ['1', '16.7%'])
await expectMetricValues(report, 'Facebook', ['1', '16.7%'])
+ await expectMetricValues(report, 'Google', ['1', '16.7%'])
await expectMetricValues(report, 'ablog.example.com', ['1', '16.7%'])
await expectMetricValues(report, 'theguardian.com', ['1', '16.7%'])
})
@@ -90,8 +91,8 @@ test('sources breakdown', async ({ page, request }) => {
await expectRows(modal(page), [
'DuckDuckGo',
- 'Direct / None',
'Facebook',
+ 'Google',
'ablog.example.com',
'theguardian.com'
])
@@ -101,30 +102,28 @@ test('sources breakdown', async ({ page, request }) => {
await closeModalButton(page).click()
})
- const referrersReport = page.getByTestId('report-referrers')
-
await test.step('clicking sources entry shows referrers', async () => {
await rowLink(report, 'DuckDuckGo').click()
await expect(page).toHaveURL(/f=is,source,DuckDuckGo/)
- await expect(tabButton(referrersReport, 'Top referrers')).toHaveAttribute(
+ await expect(tabButton(report, 'Top referrers')).toHaveAttribute(
'data-active',
'true'
)
// Move mouse away from report rows
- await tabButton(referrersReport, 'Top referrers').hover()
+ await tabButton(report, 'Top referrers').hover()
- await expectHeaders(referrersReport, ['Referrer', 'Visitors'])
+ await expectHeaders(report, ['Referrer', 'Visitors'])
- await expectRows(referrersReport, [
+ await expectRows(report, [
'https://duckduckgo.com/a1',
'https://duckduckgo.com/a2'
])
})
await test.step('referrers modal', async () => {
- await detailsLink(referrersReport).click()
+ await detailsLink(report).click()
await expect(
modal(page).getByRole('heading', { name: 'Referrer drilldown' })
@@ -149,6 +148,47 @@ test('sources breakdown', async ({ page, request }) => {
.click()
})
+ // Tests against values from Plausible.Google.API.Mock
+ await test.step('clicking Google source entry opens search terms', async () => {
+ await rowLink(report, 'Google').click()
+ await expect(page).toHaveURL(/f=is,source,Google/)
+
+ await expect(tabButton(report, 'Search terms')).toHaveAttribute(
+ 'data-active',
+ 'true'
+ )
+
+ // Move mouse away from report rows
+ await tabButton(report, 'Search terms').hover()
+
+ await expectHeaders(report, ['Search term', 'Visitors'])
+
+ await expectMetricValues(report, 'simple web analytics', ['25'])
+ await expectMetricValues(report, 'open-source analytics', ['15'])
+ })
+
+ await test.step('search-terms modal', async () => {
+ await detailsLink(report).click()
+
+ await expect(
+ modal(page).getByRole('heading', { name: 'Google search terms' })
+ ).toBeVisible()
+
+ await expectHeaders(modal(page), [
+ 'Search term',
+ 'Visitors',
+ 'Impressions',
+ 'CTR',
+ 'Position'
+ ])
+
+ await closeModalButton(page).click()
+ })
+
+ await page
+ .getByRole('button', { name: 'Remove filter: Source is Google' })
+ .click()
+
await test.step('channels tab', async () => {
const channelsTabButton = tabButton(report, 'Channels')
await channelsTabButton.click()
@@ -157,16 +197,14 @@ test('sources breakdown', async ({ page, request }) => {
await expectHeaders(report, ['Channel', 'Visitors'])
await expectRows(report, [
- 'Referral',
- 'Direct',
'Organic Search',
+ 'Referral',
'Organic Social',
'Paid Search'
])
+ await expectMetricValues(report, 'Organic Search', ['2', '33.3%'])
await expectMetricValues(report, 'Referral', ['2', '33.3%'])
- await expectMetricValues(report, 'Direct', ['1', '16.7%'])
- await expectMetricValues(report, 'Organic Search', ['1', '16.7%'])
await expectMetricValues(report, 'Organic Social', ['1', '16.7%'])
await expectMetricValues(report, 'Paid Search', ['1', '16.7%'])
})
@@ -186,9 +224,8 @@ test('sources breakdown', async ({ page, request }) => {
])
await expectRows(modal(page), [
- 'Referral',
- 'Direct',
'Organic Search',
+ 'Referral',
'Organic Social',
'Paid Search'
])
@@ -392,6 +429,82 @@ test('sources breakdown', async ({ page, request }) => {
})
})
+// Tests against values from Plausible.Google.API.Mock
+test('sources breakdown - search terms failure modes', async ({
+ page,
+ request
+}) => {
+ const { domain } = await setupSite({ page, request })
+
+ await populateStats({
+ request,
+ domain,
+ events: [
+ { name: 'pageview', referrer_source: 'Google', pathname: '/empty' },
+ {
+ name: 'pageview',
+ referrer_source: 'Google',
+ pathname: '/unsupported-filters'
+ },
+ {
+ name: 'pageview',
+ referrer_source: 'Google',
+ pathname: '/not-configured'
+ }
+ ]
+ })
+
+ const report = page.getByTestId('report-sources')
+ const searchTermsTabButton = tabButton(report, 'Search terms')
+
+ await test.step('empty', async () => {
+ await page.goto('/' + domain + '?f=is,source,Google&f=is,page,%2Fempty', {
+ waitUntil: 'commit'
+ })
+
+ await searchTermsTabButton.scrollIntoViewIfNeeded()
+ await expect(searchTermsTabButton).toHaveAttribute('data-active', 'true')
+
+ await expect(report.getByText('No data yet')).toBeVisible()
+ })
+
+ await test.step('unsupported filters', async () => {
+ await page.goto(
+ '/' + domain + '?f=is,source,Google&f=is,page,%2Funsupported-filters',
+ {
+ waitUntil: 'commit'
+ }
+ )
+
+ await searchTermsTabButton.scrollIntoViewIfNeeded()
+ await expect(searchTermsTabButton).toHaveAttribute('data-active', 'true')
+
+ await expect(
+ report.getByText('Unable to fetch keyword data from Search Console')
+ ).toBeVisible()
+
+ await expect(
+ report.getByText('does not support the current set of filters')
+ ).toBeVisible()
+ })
+
+ await test.step('not configured', async () => {
+ await page.goto(
+ '/' + domain + '?f=is,source,Google&f=is,page,%2Fnot-configured',
+ {
+ waitUntil: 'commit'
+ }
+ )
+
+ await searchTermsTabButton.scrollIntoViewIfNeeded()
+ await expect(searchTermsTabButton).toHaveAttribute('data-active', 'true')
+
+ await expect(
+ report.getByText('The site is not connected to Google Search Keywords')
+ ).toBeVisible()
+ })
+})
+
test('pages breakdown', async ({ page, request }) => {
const { domain } = await setupSite({ page, request })
diff --git a/test/plausible_web/controllers/api/stats_controller/sources_test.exs b/test/plausible_web/controllers/api/stats_controller/sources_test.exs
index 0c4589cb5f..b0c9cb5d45 100644
--- a/test/plausible_web/controllers/api/stats_controller/sources_test.exs
+++ b/test/plausible_web/controllers/api/stats_controller/sources_test.exs
@@ -2636,8 +2636,20 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest do
assert %{
"results" => [
- %{"name" => "simple web analytics", "count" => 6},
- %{"name" => "open-source analytics", "count" => 2}
+ %{
+ "name" => "simple web analytics",
+ "visitors" => 25,
+ "impressions" => 50,
+ "position" => 2.0,
+ "ctr" => 37.0
+ },
+ %{
+ "name" => "open-source analytics",
+ "visitors" => 15,
+ "impressions" => 25,
+ "position" => 4.0,
+ "ctr" => 50.0
+ }
]
} = json_response(conn, 200)
end
diff --git a/test/support/google_api_mock.ex b/test/support/google_api_mock.ex
index 7d17f2c05d..2922228378 100644
--- a/test/support/google_api_mock.ex
+++ b/test/support/google_api_mock.ex
@@ -8,25 +8,44 @@ defmodule Plausible.Google.API.Mock do
parameter into StatsController) as a hack to mock different responses.
"""
def fetch_stats(_auth, query, _pagination, _search) do
- case query.filters do
- [[:is, "event:page", ["/empty"]]] ->
+ case page_filter_value(query) do
+ ["/empty"] ->
{:ok, []}
- [[:is, "event:page", ["/unsupported-filters"]]] ->
+ ["/unsupported-filters"] ->
{:error, :unsupported_filters}
- [[:is, "event:page", ["/not-configured"]]] ->
+ ["/not-configured"] ->
{:error, :google_property_not_configured}
- [[:is, "event:page", ["/unexpected-error"]]] ->
+ ["/unexpected-error"] ->
{:error, :some_unexpected_error}
_ ->
{:ok,
[
- %{"name" => "simple web analytics", "count" => 6},
- %{"name" => "open-source analytics", "count" => 2}
+ %{
+ name: "simple web analytics",
+ visitors: 25,
+ impressions: 50,
+ ctr: 37.0,
+ position: 2.0
+ },
+ %{
+ name: "open-source analytics",
+ visitors: 15,
+ impressions: 25,
+ ctr: 50.0,
+ position: 4.0
+ }
]}
end
end
+
+ defp page_filter_value(query) do
+ Enum.find_value(query.filters, fn
+ [:is, "event:page", value] -> value
+ _ -> nil
+ end)
+ end
end