Skip to content

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

A major renaming: DashboardQuery -> DashboardState (#6059)

RobertJoonasc7eaba1751eb
diff --git a/assets/js/dashboard/api.ts b/assets/js/dashboard/api.ts
index fa407178e4..57ab30ba68 100644
--- a/assets/js/dashboard/api.ts
+++ b/assets/js/dashboard/api.ts
@@ -1,4 +1,4 @@
-import { DashboardQuery } from './query'
+import { DashboardState } from './dashboard-state'
import { formatISO } from './util/date'
import { serializeApiFilters } from './util/filters'
@@ -32,39 +32,39 @@ export function cancelAll() {
abortController = new AbortController()
}
-export function queryToSearchParams(
- query: DashboardQuery,
+export function dashboardStateToSearchParams(
+ dashboardState: DashboardState,
extraQuery: unknown[] = []
): string {
const queryObj: Record<string, string> = {}
- if (query.period) {
- queryObj.period = query.period
+ if (dashboardState.period) {
+ queryObj.period = dashboardState.period
}
- if (query.date) {
- queryObj.date = formatISO(query.date)
+ if (dashboardState.date) {
+ queryObj.date = formatISO(dashboardState.date)
}
- if (query.from) {
- queryObj.from = formatISO(query.from)
+ if (dashboardState.from) {
+ queryObj.from = formatISO(dashboardState.from)
}
- if (query.to) {
- queryObj.to = formatISO(query.to)
+ if (dashboardState.to) {
+ queryObj.to = formatISO(dashboardState.to)
}
- if (query.filters) {
- queryObj.filters = serializeApiFilters(query.filters)
+ if (dashboardState.filters) {
+ queryObj.filters = serializeApiFilters(dashboardState.filters)
}
- if (query.with_imported) {
- queryObj.with_imported = String(query.with_imported)
+ if (dashboardState.with_imported) {
+ queryObj.with_imported = String(dashboardState.with_imported)
}
- if (query.comparison) {
- queryObj.comparison = query.comparison
- queryObj.compare_from = query.compare_from
- ? formatISO(query.compare_from)
+ if (dashboardState.comparison) {
+ queryObj.comparison = dashboardState.comparison
+ queryObj.compare_from = dashboardState.compare_from
+ ? formatISO(dashboardState.compare_from)
: undefined
- queryObj.compare_to = query.compare_to
- ? formatISO(query.compare_to)
+ queryObj.compare_to = dashboardState.compare_to
+ ? formatISO(dashboardState.compare_to)
: undefined
- queryObj.match_day_of_week = String(query.match_day_of_week)
+ queryObj.match_day_of_week = String(dashboardState.match_day_of_week)
}
const sharedLinkParams = getSharedLinkSearchParams()
@@ -96,11 +96,11 @@ function getSharedLinkSearchParams(): Record<string, string> {
export async function get(
url: string,
- query?: DashboardQuery,
+ dashboardState?: DashboardState,
...extraQueryParams: unknown[]
) {
- const queryString = query
- ? queryToSearchParams(query, [...extraQueryParams])
+ const queryString = dashboardState
+ ? dashboardStateToSearchParams(dashboardState, [...extraQueryParams])
: serializeUrlParams(getSharedLinkSearchParams())
const response = await fetch(queryString ? `${url}?${queryString}` : url, {
diff --git a/assets/js/dashboard/components/drilldown-link.tsx b/assets/js/dashboard/components/drilldown-link.tsx
index 7e66ab643e..e9f20483a1 100644
--- a/assets/js/dashboard/components/drilldown-link.tsx
+++ b/assets/js/dashboard/components/drilldown-link.tsx
@@ -6,8 +6,8 @@ import {
import classNames from 'classnames'
import { cleanLabels, replaceFilterByPrefix } from '../util/filters'
import { plainFilterText } from '../util/filter-text'
-import { useQueryContext } from '../query-context'
-import { Filter, FilterClauseLabels } from '../query'
+import { useDashboardStateContext } from '../dashboard-state-context'
+import { Filter, FilterClauseLabels } from '../dashboard-state'
export type FilterInfo = {
prefix: string
@@ -25,19 +25,24 @@ export function DrilldownLink({
extraClass?: string
filterInfo: FilterInfo | null
}) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const className = classNames(`${extraClass}`, {
'hover:underline': !!filterInfo
})
if (filterInfo) {
const { prefix, filter, labels } = filterInfo
- const newFilters = replaceFilterByPrefix(query, prefix, filter)
- const newLabels = cleanLabels(newFilters, query.labels, filter[1], labels)
+ const newFilters = replaceFilterByPrefix(dashboardState, prefix, filter)
+ const newLabels = cleanLabels(
+ newFilters,
+ dashboardState.labels,
+ filter[1],
+ labels
+ )
return (
<AppNavigationLink
- title={`Add filter: ${plainFilterText({ ...query, labels: newLabels }, filter)}`}
+ title={`Add filter: ${plainFilterText({ ...dashboardState, labels: newLabels }, filter)}`}
className={className}
path={path}
onClick={onClick}
diff --git a/assets/js/dashboard/query-context.tsx b/assets/js/dashboard/dashboard-state-context.tsx
similarity index 78%
rename from assets/js/dashboard/query-context.tsx
rename to assets/js/dashboard/dashboard-state-context.tsx
index 05571dc3dc..3fd6946299 100644
--- a/assets/js/dashboard/query-context.tsx
+++ b/assets/js/dashboard/dashboard-state-context.tsx
@@ -9,35 +9,36 @@ import { nowForSite, yesterday } from './util/date'
import {
getDashboardTimeSettings,
getSavedTimePreferencesFromStorage,
- QueryPeriod,
+ DashboardPeriod,
useSaveTimePreferencesToStorage
-} from './query-time-periods'
+} from './dashboard-time-periods'
import {
Filter,
FilterClauseLabels,
- queryDefaultValue,
+ dashboardStateDefaultValue,
postProcessFilters
-} from './query'
+} from './dashboard-state'
import { resolveFilters, SavedSegment, SegmentData } from './filtering/segments'
import { useDefiniteLocationState } from './navigation/use-definite-location-state'
import { useClearExpandedSegmentModeOnFilterClear } from './nav-menu/segments/segment-menu'
import { useSegmentsContext } from './filtering/segments-context'
-const queryContextDefaultValue = {
- query: queryDefaultValue,
+const dashboardStateContextDefaultValue = {
+ dashboardState: dashboardStateDefaultValue,
otherSearch: {} as Record<string, unknown>,
expandedSegment: null as (SavedSegment & { segment_data: SegmentData }) | null
}
-export type QueryContextValue = typeof queryContextDefaultValue
+export type DashboardStateContextValue =
+ typeof dashboardStateContextDefaultValue
-const QueryContext = createContext(queryContextDefaultValue)
+const DashboardStateContext = createContext(dashboardStateContextDefaultValue)
-export const useQueryContext = () => {
- return useContext(QueryContext)
+export const useDashboardStateContext = () => {
+ return useContext(DashboardStateContext)
}
-export default function QueryContextProvider({
+export default function DashboardStateContextProvider({
children
}: {
children: ReactNode
@@ -64,10 +65,10 @@ export default function QueryContextProvider({
...otherSearch
} = useMemo(() => parseSearch(location.search), [location.search])
- const query = useMemo(() => {
- const defaultValues = queryDefaultValue
+ const dashboardState = useMemo(() => {
+ const defaultValues = dashboardStateDefaultValue
const storedValues = getSavedTimePreferencesFromStorage({ site })
- const timeQuery = getDashboardTimeSettings({
+ const timeSettings = getDashboardTimeSettings({
site,
searchValues: { period, comparison, match_day_of_week },
storedValues,
@@ -82,7 +83,7 @@ export default function QueryContextProvider({
const resolvedFilters = resolveFilters(filters, segmentsContext.segments)
return {
- ...timeQuery,
+ ...timeSettings,
compare_from:
typeof compare_from === 'string' && compare_from.length
? dayjs.utc(compare_from)
@@ -98,13 +99,13 @@ export default function QueryContextProvider({
from:
typeof from === 'string' && from.length
? dayjs.utc(from)
- : timeQuery.period === QueryPeriod.custom
+ : timeSettings.period === DashboardPeriod.custom
? yesterday(site)
: defaultValues.from,
to:
typeof to === 'string' && to.length
? dayjs.utc(to)
- : timeQuery.period === QueryPeriod.custom
+ : timeSettings.period === DashboardPeriod.custom
? nowForSite(site)
: defaultValues.to,
with_imported: [true, false].includes(with_imported as boolean)
@@ -131,7 +132,7 @@ export default function QueryContextProvider({
segmentsContext.segments
])
- useClearExpandedSegmentModeOnFilterClear({ expandedSegment, query })
+ useClearExpandedSegmentModeOnFilterClear({ expandedSegment, dashboardState })
useSaveTimePreferencesToStorage({
site,
period,
@@ -144,14 +145,14 @@ export default function QueryContextProvider({
}, [])
return (
- <QueryContext.Provider
+ <DashboardStateContext.Provider
value={{
- query,
+ dashboardState,
otherSearch,
expandedSegment
}}
>
{children}
- </QueryContext.Provider>
+ </DashboardStateContext.Provider>
)
}
diff --git a/assets/js/dashboard/query.ts b/assets/js/dashboard/dashboard-state.ts
similarity index 75%
rename from assets/js/dashboard/query.ts
rename to assets/js/dashboard/dashboard-state.ts
index 5b2d2b71b8..3e5175c9f3 100644
--- a/assets/js/dashboard/query.ts
+++ b/assets/js/dashboard/dashboard-state.ts
@@ -9,7 +9,7 @@ import {
} from './util/date'
import { FILTER_OPERATIONS, getFiltersByKeyPrefix } from './util/filters'
import { PlausibleSite } from './site-context'
-import { ComparisonMode, QueryPeriod } from './query-time-periods'
+import { ComparisonMode, DashboardPeriod } from './dashboard-time-periods'
import { AppNavigationTarget } from './navigation/use-app-navigate'
import { Dayjs } from 'dayjs'
@@ -31,8 +31,8 @@ export type Filter = [FilterOperator, FilterKey, FilterClause[]]
* */
export type FilterClauseLabels = Record<string, string>
-export type DashboardQuery = {
- period: QueryPeriod
+export type DashboardState = {
+ period: DashboardPeriod
comparison: ComparisonMode | null
match_day_of_week: boolean
date: Dayjs | null
@@ -52,8 +52,8 @@ export type DashboardQuery = {
with_imported: boolean
}
-export const queryDefaultValue: DashboardQuery = {
- period: '28d' as QueryPeriod,
+export const dashboardStateDefaultValue: DashboardState = {
+ period: '28d' as DashboardPeriod,
comparison: null,
match_day_of_week: true,
date: null,
@@ -74,10 +74,10 @@ export type BreakdownResultMeta = {
}
export function addFilter(
- query: DashboardQuery,
+ dashboardState: DashboardState,
filter: Filter
-): DashboardQuery {
- return { ...query, filters: [...query.filters, filter] }
+): DashboardState {
+ return { ...dashboardState, filters: [...dashboardState.filters, filter] }
}
export function postProcessFilters(filters: Array<Filter>): Array<Filter> {
@@ -90,13 +90,16 @@ export function postProcessFilters(filters: Array<Filter>): Array<Filter> {
})
}
-// Returns a boolean indicating whether the given query includes a
+// Returns a boolean indicating whether the given dashboardState includes a
// non-empty goal filterset containing a single, or multiple revenue
// goals with the same currency. Used to decide whether to render
// revenue metrics in a dashboard report or not.
-export function revenueAvailable(query: DashboardQuery, site: PlausibleSite) {
+export function revenueAvailable(
+ dashboardState: DashboardState,
+ site: PlausibleSite
+) {
const revenueGoalsInFilter = site.revenueGoals.filter((revenueGoal) => {
- const goalFilters: Filter[] = getFiltersByKeyPrefix(query, 'goal')
+ const goalFilters: Filter[] = getFiltersByKeyPrefix(dashboardState, 'goal')
return goalFilters.some(([operation, _key, clauses]) => {
return (
@@ -135,7 +138,7 @@ export function isDateOnOrAfterStatsStartDate({
}: {
site: PlausibleSite
date: string
- period: QueryPeriod
+ period: DashboardPeriod
}) {
return !isBefore(parseUTCDate(date), parseUTCDate(site.statsBegin), period)
}
@@ -147,7 +150,7 @@ export function isDateBeforeOrOnCurrentDate({
}: {
site: PlausibleSite
date: string
- period: QueryPeriod
+ period: DashboardPeriod
}) {
const currentDate = nowForSite(site)
return !isAfter(parseUTCDate(date), currentDate, period)
@@ -155,29 +158,33 @@ export function isDateBeforeOrOnCurrentDate({
export function getDateForShiftedPeriod({
site,
- query,
+ dashboardState,
direction
}: {
site: PlausibleSite
direction: -1 | 1
- query: DashboardQuery
+ dashboardState: DashboardState
}) {
const isWithinRangeByDirection = {
'-1': isDateOnOrAfterStatsStartDate,
'1': isDateBeforeOrOnCurrentDate
}
const shiftByPeriod = {
- [QueryPeriod.day]: { shift: shiftDays, amount: 1 },
- [QueryPeriod.month]: { shift: shiftMonths, amount: 1 },
- [QueryPeriod.year]: { shift: shiftMonths, amount: 12 }
+ [DashboardPeriod.day]: { shift: shiftDays, amount: 1 },
+ [DashboardPeriod.month]: { shift: shiftMonths, amount: 1 },
+ [DashboardPeriod.year]: { shift: shiftMonths, amount: 12 }
} as const
const { shift, amount } =
- shiftByPeriod[query.period as keyof typeof shiftByPeriod] ?? {}
+ shiftByPeriod[dashboardState.period as keyof typeof shiftByPeriod] ?? {}
if (shift) {
- const date = shift(query.date, direction * amount)
+ const date = shift(dashboardState.date, direction * amount)
if (
- isWithinRangeByDirection[direction]({ site, date, period: query.period })
+ isWithinRangeByDirection[direction]({
+ site,
+ date,
+ period: dashboardState.period
+ })
) {
return date
}
@@ -185,12 +192,12 @@ export function getDateForShiftedPeriod({
return null
}
-function setQueryPeriodAndDate({
+function setDashboardPeriodAndDate({
period,
date = null,
keybindHint = null
}: {
- period: QueryPeriod
+ period: DashboardPeriod
date?: null | string
keybindHint?: null | string
}): AppNavigationTarget['search'] {
@@ -205,21 +212,21 @@ function setQueryPeriodAndDate({
}
}
-export function shiftQueryPeriod({
+export function shiftDashboardPeriod({
site,
- query,
+ dashboardState,
direction,
keybindHint
}: {
site: PlausibleSite
- query: DashboardQuery
+ dashboardState: DashboardState
direction: -1 | 1
keybindHint?: null | string
}): AppNavigationTarget['search'] {
- const date = getDateForShiftedPeriod({ site, query, direction })
+ const date = getDateForShiftedPeriod({ site, dashboardState, direction })
if (date !== null) {
- return setQueryPeriodAndDate({
- period: query.period,
+ return setDashboardPeriodAndDate({
+ period: dashboardState.period,
date: formatISO(date),
keybindHint
})
diff --git a/assets/js/dashboard/query-time-periods.test.ts b/assets/js/dashboard/dashboard-time-periods.test.ts
similarity index 85%
rename from assets/js/dashboard/query-time-periods.test.ts
rename to assets/js/dashboard/dashboard-time-periods.test.ts
index f293d68ebc..44e0b8b198 100644
--- a/assets/js/dashboard/query-time-periods.test.ts
+++ b/assets/js/dashboard/dashboard-time-periods.test.ts
@@ -4,8 +4,8 @@ import {
getDashboardTimeSettings,
getPeriodStorageKey,
getStoredPeriod,
- QueryPeriod
-} from './query-time-periods'
+ DashboardPeriod
+} from './dashboard-time-periods'
import { formatISO, utcNow } from './util/date'
describe(`${getStoredPeriod.name}`, () => {
@@ -18,13 +18,13 @@ describe(`${getStoredPeriod.name}`, () => {
})
it('returns correct value if value stored', () => {
- localStorage.setItem(key, QueryPeriod['7d'])
- expect(getStoredPeriod(domain, null)).toEqual(QueryPeriod['7d'])
+ localStorage.setItem(key, DashboardPeriod['7d'])
+ expect(getStoredPeriod(domain, null)).toEqual(DashboardPeriod['7d'])
})
it('returns correct value for 24h period if stored', () => {
- localStorage.setItem(key, QueryPeriod['24h'])
- expect(getStoredPeriod(domain, null)).toEqual(QueryPeriod['24h'])
+ localStorage.setItem(key, DashboardPeriod['24h'])
+ expect(getStoredPeriod(domain, null)).toEqual(DashboardPeriod['24h'])
})
})
@@ -32,7 +32,7 @@ describe(`${getDashboardTimeSettings.name}`, () => {
const site = DEFAULT_SITE
const defaultValues = {
- period: QueryPeriod['28d'],
+ period: DashboardPeriod['28d'],
comparison: null,
match_day_of_week: true
}
@@ -92,7 +92,7 @@ describe(`${getDashboardTimeSettings.name}`, () => {
site: site,
searchValues: emptySearchValues,
storedValues: {
- period: QueryPeriod['12mo'],
+ period: DashboardPeriod['12mo'],
comparison: ComparisonMode.year_over_year,
match_day_of_week: false
},
@@ -100,7 +100,7 @@ describe(`${getDashboardTimeSettings.name}`, () => {
segmentIsExpanded: false
})
).toEqual({
- period: QueryPeriod['12mo'],
+ period: DashboardPeriod['12mo'],
comparison: ComparisonMode.year_over_year,
match_day_of_week: false
})
@@ -111,12 +111,12 @@ describe(`${getDashboardTimeSettings.name}`, () => {
getDashboardTimeSettings({
site: site,
searchValues: {
- period: QueryPeriod['year'],
+ period: DashboardPeriod['year'],
comparison: ComparisonMode.off,
match_day_of_week: true
},
storedValues: {
- period: QueryPeriod['12mo'],
+ period: DashboardPeriod['12mo'],
comparison: ComparisonMode.year_over_year,
match_day_of_week: false
},
@@ -124,7 +124,7 @@ describe(`${getDashboardTimeSettings.name}`, () => {
segmentIsExpanded: false
})
).toEqual({
- period: QueryPeriod['year'],
+ period: DashboardPeriod['year'],
comparison: null,
match_day_of_week: true
})
@@ -135,7 +135,7 @@ describe(`${getDashboardTimeSettings.name}`, () => {
getDashboardTimeSettings({
site: site,
searchValues: {
- period: QueryPeriod['custom'],
+ period: DashboardPeriod['custom'],
comparison: ComparisonMode.previous_period,
match_day_of_week: true
},
@@ -144,7 +144,7 @@ describe(`${getDashboardTimeSettings.name}`, () => {
segmentIsExpanded: true
})
).toEqual({
- period: QueryPeriod['custom'],
+ period: DashboardPeriod['custom'],
comparison: null,
match_day_of_week: true
})
diff --git a/assets/js/dashboard/query-time-periods.ts b/assets/js/dashboard/dashboard-time-periods.ts
similarity index 72%
rename from assets/js/dashboard/query-time-periods.ts
rename to assets/js/dashboard/dashboard-time-periods.ts
index c4e8191a26..4ed6a260f4 100644
--- a/assets/js/dashboard/query-time-periods.ts
+++ b/assets/js/dashboard/dashboard-time-periods.ts
@@ -2,8 +2,8 @@ import { useEffect } from 'react'
import {
clearedComparisonSearch,
clearedDateSearch,
- DashboardQuery
-} from './query'
+ DashboardState
+} from './dashboard-state'
import { PlausibleSite } from './site-context'
import {
formatDateRange,
@@ -25,7 +25,7 @@ import {
import { AppNavigationTarget } from './navigation/use-app-navigate'
import { getDomainScopedStorageKey, getItem, setItem } from './util/storage'
-export enum QueryPeriod {
+export enum DashboardPeriod {
'realtime' = 'realtime',
'day' = 'day',
'month' = 'month',
@@ -67,13 +67,16 @@ export const COMPARISON_MATCH_MODE_LABELS = {
export const DEFAULT_COMPARISON_MODE = ComparisonMode.previous_period
-const COMPARISON_DISABLED_PERIODS = [QueryPeriod.realtime, QueryPeriod.all]
+const COMPARISON_DISABLED_PERIODS = [
+ DashboardPeriod.realtime,
+ DashboardPeriod.all
+]
export const isComparisonForbidden = ({
period,
segmentIsExpanded
}: {
- period: QueryPeriod
+ period: DashboardPeriod
segmentIsExpanded: boolean
}) => COMPARISON_DISABLED_PERIODS.includes(period) || segmentIsExpanded
@@ -83,19 +86,19 @@ export function getPeriodStorageKey(domain: string): string {
return getDomainScopedStorageKey('period', domain)
}
-export function isValidPeriod(period: unknown): period is QueryPeriod {
- return Object.values<unknown>(QueryPeriod).includes(period)
+export function isValidPeriod(period: unknown): period is DashboardPeriod {
+ return Object.values<unknown>(DashboardPeriod).includes(period)
}
export function getStoredPeriod(
domain: string,
- fallbackValue: QueryPeriod | null
+ fallbackValue: DashboardPeriod | null
) {
const item = getItem(getPeriodStorageKey(domain))
return isValidPeriod(item) ? item : fallbackValue
}
-function storePeriod(domain: string, value: QueryPeriod) {
+function storePeriod(domain: string, value: DashboardPeriod) {
return setItem(getPeriodStorageKey(domain), value)
}
@@ -168,13 +171,13 @@ export const isComparisonEnabled = function (
export const getSearchToToggleComparison = ({
site,
- query
+ dashboardState
}: {
site: PlausibleSite
- query: DashboardQuery
+ dashboardState: DashboardState
}): Required<AppNavigationTarget>['search'] => {
return (search) => {
- if (isComparisonEnabled(query.comparison)) {
+ if (isComparisonEnabled(dashboardState.comparison)) {
return {
...search,
...clearedComparisonSearch,
@@ -209,7 +212,7 @@ export const getSearchToApplyCustomDates = ([selectionStart, selectionEnd]: [
return (search) => ({
...search,
...clearedDateSearch,
- period: QueryPeriod.day,
+ period: DashboardPeriod.day,
date: formatISO(from),
keybindHint: 'C'
})
@@ -218,7 +221,7 @@ export const getSearchToApplyCustomDates = ([selectionStart, selectionEnd]: [
return (search) => ({
...search,
...clearedDateSearch,
- period: QueryPeriod.custom,
+ period: DashboardPeriod.custom,
from: formatISO(from),
to: formatISO(to),
keybindHint: 'C'
@@ -249,7 +252,7 @@ export type LinkItem = [
search: AppNavigationTarget['search']
isActive: (options: {
site: PlausibleSite
- query: DashboardQuery
+ dashboardState: DashboardState
}) => boolean
onEvent?: (event: Pick<Event, 'preventDefault' | 'stopPropagation'>) => void
hidden?: boolean
@@ -280,13 +283,13 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod.day,
+ period: DashboardPeriod.day,
date: formatISO(nowForSite(site)),
keybindHint: 'D'
}),
- isActive: ({ query }) =>
- query.period === QueryPeriod.day &&
- isSameDate(query.date, nowForSite(site)),
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod.day &&
+ isSameDate(dashboardState.date, nowForSite(site)),
onEvent
}
],
@@ -296,13 +299,13 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod.day,
+ period: DashboardPeriod.day,
date: formatISO(yesterday(site)),
keybindHint: 'E'
}),
- isActive: ({ query }) =>
- query.period === QueryPeriod.day &&
- isSameDate(query.date, yesterday(site)),
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod.day &&
+ isSameDate(dashboardState.date, yesterday(site)),
onEvent
}
],
@@ -312,10 +315,11 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod.realtime,
+ period: DashboardPeriod.realtime,
keybindHint: 'R'
}),
- isActive: ({ query }) => query.period === QueryPeriod.realtime,
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod.realtime,
onEvent
}
]
@@ -327,10 +331,11 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod['24h'],
+ period: DashboardPeriod['24h'],
keybindHint: 'H'
}),
- isActive: ({ query }) => query.period === QueryPeriod['24h'],
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod['24h'],
onEvent
}
],
@@ -340,10 +345,11 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod['7d'],
+ period: DashboardPeriod['7d'],
keybindHint: 'W'
}),
- isActive: ({ query }) => query.period === QueryPeriod['7d'],
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod['7d'],
onEvent
}
],
@@ -353,10 +359,11 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod['28d'],
+ period: DashboardPeriod['28d'],
keybindHint: 'F'
}),
- isActive: ({ query }) => query.period === QueryPeriod['28d'],
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod['28d'],
onEvent
}
],
@@ -367,10 +374,11 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod['30d'],
+ period: DashboardPeriod['30d'],
keybindHint: 'T'
}),
- isActive: ({ query }) => query.period === QueryPeriod['30d'],
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod['30d'],
onEvent
}
],
@@ -380,10 +388,11 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod['91d'],
+ period: DashboardPeriod['91d'],
keybindHint: 'N'
}),
- isActive: ({ query }) => query.period === QueryPeriod['91d'],
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod['91d'],
onEvent
}
]
@@ -395,12 +404,12 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod.month,
+ period: DashboardPeriod.month,
keybindHint: 'M'
}),
- isActive: ({ query }) =>
- query.period === QueryPeriod.month &&
- isSameMonth(query.date, nowForSite(site)),
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod.month &&
+ isSameMonth(dashboardState.date, nowForSite(site)),
onEvent
}
],
@@ -410,13 +419,13 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod.month,
+ period: DashboardPeriod.month,
date: formatISO(lastMonth(site)),
keybindHint: 'P'
}),
- isActive: ({ query }) =>
- query.period === QueryPeriod.month &&
- isSameMonth(query.date, lastMonth(site)),
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod.month &&
+ isSameMonth(dashboardState.date, lastMonth(site)),
onEvent
}
]
@@ -428,11 +437,12 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod.year,
+ period: DashboardPeriod.year,
keybindHint: 'Y'
}),
- isActive: ({ query }) =>
- query.period === QueryPeriod.year && isThisYear(site, query.date),
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod.year &&
+ isThisYear(site, dashboardState.date),
onEvent
}
],
@@ -443,10 +453,11 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod['6mo'],
+ period: DashboardPeriod['6mo'],
keybindHint: 'S'
}),
- isActive: ({ query }) => query.period === QueryPeriod['6mo']
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod['6mo']
}
],
[
@@ -455,10 +466,11 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod['12mo'],
+ period: DashboardPeriod['12mo'],
keybindHint: 'L'
}),
- isActive: ({ query }) => query.period === QueryPeriod['12mo'],
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod['12mo'],
onEvent
}
]
@@ -472,10 +484,11 @@ export const getDatePeriodGroups = ({
search: (s) => ({
...s,
...clearedDateSearch,
- period: QueryPeriod.all,
+ period: DashboardPeriod.all,
keybindHint: 'A'
}),
- isActive: ({ query }) => query.period === QueryPeriod.all,
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod.all,
onEvent
}
]
@@ -487,21 +500,23 @@ export const getDatePeriodGroups = ({
}
export const getCompareLinkItem = ({
- query,
+ dashboardState,
site,
onEvent
}: {
- query: DashboardQuery
+ dashboardState: DashboardState
site: PlausibleSite
onEvent: () => void
}): LinkItem => [
[
- isComparisonEnabled(query.comparison) ? 'Disable comparison' : 'Compare',
+ isComparisonEnabled(dashboardState.comparison)
+ ? 'Disable comparison'
+ : 'Compare',
'X'
],
{
onEvent,
- search: getSearchToToggleComparison({ site, query }),
+ search: getSearchToToggleComparison({ site, dashboardState }),
isActive: () => false
}
]
@@ -520,7 +535,7 @@ export function useSaveTimePreferencesToStorage({
useEffect(() => {
if (
isValidPeriod(period) &&
- ![QueryPeriod.custom, QueryPeriod.realtime].includes(period)
+ ![DashboardPeriod.custom, DashboardPeriod.realtime].includes(period)
) {
storePeriod(site.domain, period)
}
@@ -538,7 +553,7 @@ export function getSavedTimePreferencesFromStorage({
}: {
site: PlausibleSite
}): {
- period: null | QueryPeriod
+ period: null | DashboardPeriod
comparison: null | ComparisonMode
match_day_of_week: boolean | null
} {
@@ -561,18 +576,18 @@ export function getDashboardTimeSettings({
searchValues: Record<'period' | 'comparison' | 'match_day_of_week', unknown>
storedValues: ReturnType<typeof getSavedTimePreferencesFromStorage>
defaultValues: Pick<
- DashboardQuery,
+ DashboardState,
'period' | 'comparison' | 'match_day_of_week'
>
segmentIsExpanded: boolean
-}): Pick<DashboardQuery, 'period' | 'comparison' | 'match_day_of_week'> {
- let period: QueryPeriod
+}): Pick<DashboardState, 'period' | 'comparison' | 'match_day_of_week'> {
+ let period: DashboardPeriod
if (isValidPeriod(searchValues.period)) {
period = searchValues.period
} else if (isValidPeriod(storedValues.period)) {
period = storedValues.period
} else if (isTodayOrYesterday(site.nativeStatsBegin)) {
- period = QueryPeriod.day
+ period = DashboardPeriod.day
} else {
period = defaultValues.period
}
@@ -607,73 +622,78 @@ export function getDashboardTimeSettings({
}
export function getCurrentPeriodDisplayName({
- query,
+ dashboardState,
site
}: {
- query: DashboardQuery
+ dashboardState: DashboardState
site: PlausibleSite
}) {
- if (query.period === 'day') {
- if (isToday(site, query.date)) {
+ if (dashboardState.period === 'day') {
+ if (isToday(site, dashboardState.date)) {
return 'Today'
}
- return formatDay(query.date)
+ return formatDay(dashboardState.date)
}
- if (query.period === '24h') {
+
+ if (dashboardState.period === '24h') {
return 'Last 24 Hours'
}
- if (query.period === '7d') {
+ if (dashboardState.period === '7d') {
return 'Last 7 days'
}
- if (query.period === '28d') {
+ if (dashboardState.period === '28d') {
return 'Last 28 days'
}
- if (query.period === '30d') {
+ if (dashboardState.period === '30d') {
return 'Last 30 days'
}
- if (query.period === '91d') {
+ if (dashboardState.period === '91d') {
return 'Last 91 days'
}
- if (query.period === 'month') {
- if (isThisMonth(site, query.date)) {
+ if (dashboardState.period === 'month') {
+ if (isThisMonth(site, dashboardState.date)) {
return 'Month to Date'
}
- return formatMonthYYYY(query.date)
+ return formatMonthYYYY(dashboardState.date)
}
- if (query.period === '6mo') {
+ if (dashboardState.period === '6mo') {
return 'Last 6 months'
}
- if (query.period === '12mo') {
+ if (dashboardState.period === '12mo') {
return 'Last 12 months'
}
- if (query.period === 'year') {
- if (isThisYear(site, query.date)) {
+ if (dashboardState.period === 'year') {
+ if (isThisYear(site, dashboardState.date)) {
return 'Year to Date'
}
- return formatYear(query.date)
+ return formatYear(dashboardState.date)
}
- if (query.period === 'all') {
+ if (dashboardState.period === 'all') {
return 'All time'
}
- if (query.period === 'custom') {
- return formatDateRange(site, query.from, query.to)
+ if (dashboardState.period === 'custom') {
+ return formatDateRange(site, dashboardState.from, dashboardState.to)
}
return 'Realtime'
}
export function getCurrentComparisonPeriodDisplayName({
- query,
+ dashboardState,
site
}: {
- query: DashboardQuery
+ dashboardState: DashboardState
site: PlausibleSite
}) {
- if (!query.comparison) {
+ if (!dashboardState.comparison) {
return null
}
- return query.comparison === ComparisonMode.custom &&
- query.compare_from &&
- query.compare_to
- ? formatDateRange(site, query.compare_from, query.compare_to)
- : COMPARISON_MODES[query.comparison]
+ return dashboardState.comparison === ComparisonMode.custom &&
+ dashboardState.compare_from &&
+ dashboardState.compare_to
+ ? formatDateRange(
+ site,
+ dashboardState.compare_from,
+ dashboardState.compare_to
+ )
+ : COMPARISON_MODES[dashboardState.comparison]
}
diff --git a/assets/js/dashboard/extra/funnel.js b/assets/js/dashboard/extra/funnel.js
index a818e02a65..b3987c31df 100644
--- a/assets/js/dashboard/extra/funnel.js
+++ b/assets/js/dashboard/extra/funnel.js
@@ -10,7 +10,7 @@ import RocketIcon from '../stats/modals/rocket-icon'
import * as api from '../api'
import LazyLoader from '../components/lazy-loader'
-import { useQueryContext } from '../query-context'
+import { useDashboardStateContext } from '../dashboard-state-context'
import { useSiteContext } from '../site-context'
import { UIMode, useTheme } from '../theme-context'
@@ -44,7 +44,7 @@ const getPalette = (theme) => {
export default function Funnel({ funnelName, tabs }) {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const [loading, setLoading] = useState(true)
const [visible, setVisible] = useState(false)
const [error, setError] = useState(undefined)
@@ -76,7 +76,7 @@ export default function Funnel({ funnelName, tabs }) {
}
}
// eslint-disable-next-line react-hooks/exhaustive-deps
- }, [query, funnelName, visible, isSmallScreen])
+ }, [dashboardState, funnelName, visible, isSmallScreen])
useEffect(() => {
if (canvasRef.current && funnel && visible && !isSmallScreen) {
@@ -153,7 +153,7 @@ export default function Funnel({ funnelName, tabs }) {
} else {
return api.get(
`/api/stats/${encodeURIComponent(site.domain)}/funnels/${funnelMeta.id}`,
- query
+ dashboardState
)
}
}
diff --git a/assets/js/dashboard/filtering/segments.test.ts b/assets/js/dashboard/filtering/segments.test.ts
index 932d9eb79f..b356be9255 100644
--- a/assets/js/dashboard/filtering/segments.test.ts
+++ b/assets/js/dashboard/filtering/segments.test.ts
@@ -12,7 +12,7 @@ import {
SegmentData,
canExpandSegment
} from './segments'
-import { Filter } from '../query'
+import { Filter } from '../dashboard-state'
import { PlausibleSite } from '../site-context'
import { Role, UserContextValue } from '../user-context'
diff --git a/assets/js/dashboard/filtering/segments.ts b/assets/js/dashboard/filtering/segments.ts
index ff3e324cd3..e25dfdeac3 100644
--- a/assets/js/dashboard/filtering/segments.ts
+++ b/assets/js/dashboard/filtering/segments.ts
@@ -1,4 +1,4 @@
-import { DashboardQuery, Filter } from '../query'
+import { DashboardState, Filter } from '../dashboard-state'
import { cleanLabels, remapFromApiFilters } from '../util/filters'
import { plainFilterText } from '../util/filter-text'
import { AppNavigationTarget } from '../navigation/use-app-navigate'
@@ -77,14 +77,14 @@ export function handleSegmentResponse(
}
export const getSegmentNamePlaceholder = (
- query: Pick<DashboardQuery, 'labels' | 'filters'>
+ dashboardState: Pick<DashboardState, 'labels' | 'filters'>
) =>
- query.filters
+ dashboardState.filters
.reduce(
(combinedName, filter) =>
combinedName.length > 100
? combinedName
- : `${combinedName}${combinedName.length ? ' and ' : ''}${plainFilterText(query, filter)}`,
+ : `${combinedName}${combinedName.length ? ' and ' : ''}${plainFilterText(dashboardState, filter)}`,
''
)
.slice(0, 255)
diff --git a/assets/js/dashboard/hooks/api-client.ts b/assets/js/dashboard/hooks/api-client.ts
index 7db4063436..05dcb51887 100644
--- a/assets/js/dashboard/hooks/api-client.ts
+++ b/assets/js/dashboard/hooks/api-client.ts
@@ -5,18 +5,18 @@ import {
QueryFilters
} from '@tanstack/react-query'
import * as api from '../api'
-import { DashboardQuery } from '../query'
+import { DashboardState } from '../dashboard-state'
const LIMIT = 100
/** full endpoint URL */
type Endpoint = string
-type PaginatedQueryKeyBase = [Endpoint, { query: DashboardQuery }]
+type PaginatedQueryKeyBase = [Endpoint, { dashboardState: DashboardState }]
type GetRequestParams<TKey extends PaginatedQueryKeyBase> = (
k: TKey
-) => [DashboardQuery, Record<string, unknown>]
+) => [DashboardState, Record<string, unknown>]
/**
* Hook that fetches the first page from the defined GET endpoint on mount,
@@ -53,9 +53,9 @@ export function usePaginatedGetAPI<
return useInfiniteQuery({
queryKey: key,
queryFn: async ({ pageParam, queryKey }): Promise<TResponse['results']> => {
- const [query, params] = getRequestParams(queryKey)
+ const [dashboardState, params] = getRequestParams(queryKey)
- const response: TResponse = await api.get(endpoint, query, {
+ const response: TResponse = await api.get(endpoint, dashboardState, {
...params,
limit: LIMIT,
page: pageParam
diff --git a/assets/js/dashboard/index.tsx b/assets/js/dashboard/index.tsx
index 0820ac5e01..ed22e0c22a 100644
--- a/assets/js/dashboard/index.tsx
+++ b/assets/js/dashboard/index.tsx
@@ -6,7 +6,7 @@ import Locations from './stats/locations'
import Devices from './stats/devices'
import { TopBar } from './nav-menu/top-bar'
import Behaviours from './stats/behaviours'
-import { useQueryContext } from './query-context'
+import { useDashboardStateContext } from './dashboard-state-context'
import { isRealTimeDashboard } from './util/filters'
function DashboardStats({
@@ -30,8 +30,8 @@ function DashboardStats({
function useIsRealtimeDashboard() {
const {
- query: { period }
- } = useQueryContext()
+ dashboardState: { period }
+ } = useDashboardStateContext()
return useMemo(() => isRealTimeDashboard({ period }), [period])
}
diff --git a/assets/js/dashboard/nav-menu/filter-pills-list.tsx b/assets/js/dashboard/nav-menu/filter-pills-list.tsx
index 307eae994e..9b04d6cb35 100644
--- a/assets/js/dashboard/nav-menu/filter-pills-list.tsx
+++ b/assets/js/dashboard/nav-menu/filter-pills-list.tsx
@@ -1,5 +1,5 @@
import React, { DetailedHTMLProps, HTMLAttributes } from 'react'
-import { useQueryContext } from '../query-context'
+import { useDashboardStateContext } from '../dashboard-state-context'
import { FilterPill, FilterPillProps } from './filter-pill'
import {
cleanLabels,
@@ -49,14 +49,14 @@ export const AppliedFilterPillsList = React.forwardRef<
HTMLDivElement,
AppliedFilterPillsListProps
>(({ className, style, slice, direction, pillClassName }, ref) => {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const { limitedToSegment } = useSegmentsContext()
const navigate = useAppNavigate()
const renderableFilters =
slice?.type === 'no-render-outside'
- ? query.filters.slice(slice.start, slice.end)
- : query.filters
+ ? dashboardState.filters.slice(slice.start, slice.end)
+ : dashboardState.filters
const indexAdjustment =
slice?.type === 'no-render-outside' ? (slice.start ?? 0) : 0
@@ -64,7 +64,7 @@ export const AppliedFilterPillsList = React.forwardRef<
const isInvisible = (index: number) => {
return slice?.type === 'invisible-outside'
? index < (slice.start ?? 0) ||
- index > (slice.end ?? query.filters.length) - 1
+ index > (slice.end ?? dashboardState.filters.length) - 1
: false
}
@@ -72,8 +72,8 @@ export const AppliedFilterPillsList = React.forwardRef<
<FilterPillsList
pills={renderableFilters.map((filter, index) => ({
className: classNames(isInvisible(index) && 'invisible', pillClassName),
- plainText: plainFilterText(query, filter),
- children: styledFilterText(query, filter),
+ plainText: plainFilterText(dashboardState, filter),
+ children: styledFilterText(dashboardState, filter),
interactive: {
navigationTarget: {
path: filterRoute.path,
@@ -87,7 +87,7 @@ export const AppliedFilterPillsList = React.forwardRef<
},
onRemoveClick: canRemoveFilter(filter, limitedToSegment)
? () => {
- const newFilters = query.filters.filter(
+ const newFilters = dashboardState.filters.filter(
(_, i) => i !== index + indexAdjustment
)
@@ -95,7 +95,7 @@ export const AppliedFilterPillsList = React.forwardRef<
search: (searchRecord) => ({
...searchRecord,
filters: newFilters,
- labels: cleanLabels(newFilters, query.labels)
+ labels: cleanLabels(newFilters, dashboardState.labels)
})
})
}
diff --git a/assets/js/dashboard/nav-menu/filters-bar.tsx b/assets/js/dashboard/nav-menu/filters-bar.tsx
index d91a57e831..976e11b17e 100644
--- a/assets/js/dashboard/nav-menu/filters-bar.tsx
+++ b/assets/js/dashboard/nav-menu/filters-bar.tsx
@@ -2,13 +2,13 @@ import { EllipsisHorizontalIcon } from '@heroicons/react/24/solid'
import classNames from 'classnames'
import React, { useRef, useState, useLayoutEffect } from 'react'
import { AppliedFilterPillsList, PILL_X_GAP_PX } from './filter-pills-list'
-import { useQueryContext } from '../query-context'
+import { useDashboardStateContext } from '../dashboard-state-context'
import { AppNavigationLink } from '../navigation/use-app-navigate'
import { Popover, Transition } from '@headlessui/react'
import { popover, BlurMenuButtonOnEscape } from '../components/popover'
import { isSegmentFilter } from '../filtering/segments'
import { useRoutelessModalsContext } from '../navigation/routeless-modals-context'
-import { DashboardQuery } from '../query'
+import { DashboardState } from '../dashboard-state'
// Component structure is
// `..[ filter (x) ]..[ filter (x) ]..[ three dot menu ]..`
@@ -108,23 +108,25 @@ interface FiltersBarProps {
const canShowClearAllAction = ({
filters
-}: Pick<DashboardQuery, 'filters'>): boolean => filters.length >= 2
+}: Pick<DashboardState, 'filters'>): boolean => filters.length >= 2
const canShowSaveAsSegmentAction = ({
filters,
isEditingSegment
-}: Pick<DashboardQuery, 'filters'> & { isEditingSegment: boolean }): boolean =>
+}: Pick<DashboardState, 'filters'> & { isEditingSegment: boolean }): boolean =>
filters.length >= 1 && !filters.some(isSegmentFilter) && !isEditingSegment
export const FiltersBar = ({ accessors }: FiltersBarProps) => {
const containerRef = useRef<HTMLDivElement>(null)
const pillsRef = useRef<HTMLDivElement>(null)
const [visibility, setVisibility] = useState<null | VisibilityState>(null)
- const { query, expandedSegment } = useQueryContext()
+ const { dashboardState, expandedSegment } = useDashboardStateContext()
- const showingClearAll = canShowClearAllAction({ filters: query.filters })
+ const showingClearAll = canShowClearAllAction({
+ filters: dashboardState.filters
+ })
const showingSaveAsSegment = canShowSaveAsSegmentAction({
- filters: query.filters,
+ filters: dashboardState.filters,
isEditingSegment: !!expandedSegment
})
@@ -173,9 +175,9 @@ export const FiltersBar = ({ accessors }: FiltersBarProps) => {
return () => {
resizeObserver.disconnect()
}
- }, [accessors, query.filters, mustShowSeeMoreMenu])
+ }, [accessors, dashboardState.filters, mustShowSeeMoreMenu])
- if (!query.filters.length) {
+ if (!dashboardState.filters.length) {
// functions as spacer between elements.leftSection and elements.rightSection
return <div className="w-4" />
}
@@ -203,12 +205,12 @@ export const FiltersBar = ({ accessors }: FiltersBarProps) => {
/>
</div>
{visibility !== null &&
- (query.filters.length !== visibility.visibleCount ||
+ (dashboardState.filters.length !== visibility.visibleCount ||
mustShowSeeMoreMenu) && (
<SeeMoreMenu
actions={actionsInSeeMoreMenu}
className="md:relative"
- filtersCount={query.filters.length}
+ filtersCount={dashboardState.filters.length}
visibleFiltersCount={visibility.visibleCount}
/>
)}
diff --git a/assets/js/dashboard/nav-menu/query-periods/comparison-period-menu.tsx b/assets/js/dashboard/nav-menu/query-periods/comparison-period-menu.tsx
index 942062ebfe..34f17cc47c 100644
--- a/assets/js/dashboard/nav-menu/query-periods/comparison-period-menu.tsx
+++ b/assets/js/dashboard/nav-menu/query-periods/comparison-period-menu.tsx
@@ -1,7 +1,7 @@
import React, { useRef } from 'react'
-import { clearedComparisonSearch } from '../../query'
+import { clearedComparisonSearch } from '../../dashboard-state'
import classNames from 'classnames'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import {
AppNavigationLink,
@@ -15,7 +15,7 @@ import {
ComparisonMatchMode,
getCurrentComparisonPeriodDisplayName,
getSearchToApplyCustomComparisonDates
-} from '../../query-time-periods'
+} from '../../dashboard-time-periods'
import { Popover, Transition } from '@headlessui/react'
import { popover, BlurMenuButtonOnEscape } from '../../components/popover'
import {
@@ -37,9 +37,9 @@ export const ComparisonPeriodMenuItems = ({
closeDropdown: () => void
toggleCalendar: () => void
}) => {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
- if (!isComparisonEnabled(query.comparison)) {
+ if (!isComparisonEnabled(dashboardState.comparison)) {
return null
}
@@ -60,7 +60,7 @@ export const ComparisonPeriodMenuItems = ({
].map((comparisonMode) => (
<AppNavigationLink
key={comparisonMode}
- data-selected={query.comparison === comparisonMode}
+ data-selected={dashboardState.comparison === comparisonMode}
className={linkClassName}
search={(search) => ({
...search,
@@ -73,18 +73,18 @@ export const ComparisonPeriodMenuItems = ({
</AppNavigationLink>
))}
<AppNavigationLink
- data-selected={query.comparison === ComparisonMode.custom}
+ data-selected={dashboardState.comparison === ComparisonMode.custom}
className={linkClassName}
search={(s) => s}
onClick={toggleCalendar}
>
{COMPARISON_MODES[ComparisonMode.custom]}
</AppNavigationLink>
- {query.comparison !== ComparisonMode.custom && (
+ {dashboardState.comparison !== ComparisonMode.custom && (
<>
<MenuSeparator />
<AppNavigationLink
- data-selected={query.match_day_of_week === true}
+ data-selected={dashboardState.match_day_of_week === true}
className={linkClassName}
search={(s) => ({ ...s, match_day_of_week: true })}
onClick={closeDropdown}
@@ -92,7 +92,7 @@ export const ComparisonPeriodMenuItems = ({
{COMPARISON_MATCH_MODE_LABELS[ComparisonMatchMode.MatchDayOfWeek]}
</AppNavigationLink>
<AppNavigationLink
- data-selected={query.match_day_of_week === false}
+ data-selected={dashboardState.match_day_of_week === false}
className={linkClassName}
search={(s) => ({ ...s, match_day_of_week: false })}
onClick={closeDropdown}
@@ -111,7 +111,7 @@ export const ComparisonPeriodMenu = ({
closeDropdown
}: PopoverMenuProps) => {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const buttonRef = useRef<HTMLButtonElement>(null)
const toggleCalendar = () => {
@@ -125,7 +125,7 @@ export const ComparisonPeriodMenu = ({
<BlurMenuButtonOnEscape targetRef={buttonRef} />
<Popover.Button className={datemenuButtonClassName} ref={buttonRef}>
<span className={popover.toggleButton.classNames.truncatedText}>
- {getCurrentComparisonPeriodDisplayName({ site, query })}
+ {getCurrentComparisonPeriodDisplayName({ site, dashboardState })}
</span>
<DateMenuChevron />
</Popover.Button>
@@ -143,7 +143,7 @@ export const ComparisonCalendarMenu = ({
}: PopoverMenuProps) => {
const site = useSiteContext()
const navigate = useAppNavigate()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
return (
<>
@@ -165,8 +165,11 @@ export const ComparisonCalendarMenu = ({
minDate={site.statsBegin}
maxDate={formatISO(nowForSite(site))}
defaultDates={
- query.compare_from && query.compare_to
- ? [formatISO(query.compare_from), formatISO(query.compare_to)]
+ dashboardState.compare_from && dashboardState.compare_to
+ ? [
+ formatISO(dashboardState.compare_from),
+ formatISO(dashboardState.compare_to)
+ ]
: undefined
}
/>
diff --git a/assets/js/dashboard/nav-menu/query-periods/query-dates.test.tsx b/assets/js/dashboard/nav-menu/query-periods/dashboard-dates.test.tsx
similarity index 84%
rename from assets/js/dashboard/nav-menu/query-periods/query-dates.test.tsx
rename to assets/js/dashboard/nav-menu/query-periods/dashboard-dates.test.tsx
index d56e065f30..64d3eca180 100644
--- a/assets/js/dashboard/nav-menu/query-periods/query-dates.test.tsx
+++ b/assets/js/dashboard/nav-menu/query-periods/dashboard-dates.test.tsx
@@ -5,18 +5,18 @@ import { TestContextProviders } from '../../../../test-utils/app-context-provide
import { stringifySearch } from '../../util/url-search-params'
import { useNavigate } from 'react-router-dom'
import { getRouterBasepath } from '../../router'
-import { QueryPeriodsPicker } from './query-periods-picker'
+import { DashboardPeriodPicker } from './dashboard-period-picker'
import { mockAnimationsApi, mockResizeObserver } from 'jsdom-testing-mocks'
mockAnimationsApi()
mockResizeObserver()
-const domain = 'picking-query-dates.test'
+const domain = 'picking-dashboard-dates.test'
const periodStorageKey = `period__${domain}`
test('if no period is stored, loads with default value of "Last 28 days", all expected options are present', async () => {
expect(localStorage.getItem(periodStorageKey)).toBe(null)
- render(<QueryPeriodsPicker />, {
+ render(<DashboardPeriodPicker />, {
wrapper: (props) => (
<TestContextProviders siteOptions={{ domain }} {...props} />
)
@@ -46,7 +46,7 @@ test('if no period is stored, loads with default value of "Last 28 days", all ex
})
test('user can select a new period and its value is stored', async () => {
- render(<QueryPeriodsPicker />, {
+ render(<DashboardPeriodPicker />, {
wrapper: (props) => (
<TestContextProviders siteOptions={{ domain }} {...props} />
)
@@ -63,7 +63,7 @@ test('user can select a new period and its value is stored', async () => {
test('period "all" is respected, and Compare option is not present for it in menu', async () => {
localStorage.setItem(periodStorageKey, 'all')
- render(<QueryPeriodsPicker />, {
+ render(<DashboardPeriodPicker />, {
wrapper: (props) => (
<TestContextProviders siteOptions={{ domain }} {...props} />
)
@@ -79,11 +79,11 @@ test.each([
[{ period: 'month' }, 'Month to Date'],
[{ period: 'year' }, 'Year to Date']
])(
- 'the query period from search %p is respected and stored',
+ 'the dashboardState period from search %p is respected and stored',
async (searchRecord, buttonText) => {
const startUrl = `${getRouterBasepath({ domain, shared: false })}${stringifySearch(searchRecord)}`
- render(<QueryPeriodsPicker />, {
+ render(<DashboardPeriodPicker />, {
wrapper: (props) => (
<TestContextProviders
siteOptions={{ domain }}
@@ -105,11 +105,11 @@ test.each([
],
[{ period: 'realtime' }, 'Realtime']
])(
- 'the query period from search %p is respected but not stored',
+ 'the dashboardState period from search %p is respected but not stored',
async (searchRecord, buttonText) => {
const startUrl = `${getRouterBasepath({ domain, shared: false })}${stringifySearch(searchRecord)}`
- render(<QueryPeriodsPicker />, {
+ render(<DashboardPeriodPicker />, {
wrapper: (props) => (
<TestContextProviders
siteOptions={{ domain }}
@@ -127,12 +127,12 @@ test.each([
['all', '7d', 'Last 7 days'],
['30d', 'month', 'Month to Date']
])(
- 'if the stored period is %p but query period is %p, query is respected and the stored period is overwritten',
- async (storedPeriod, queryPeriod, buttonText) => {
+ 'if the stored period is %p but dashboardState period is %p, dashboardState is respected and the stored period is overwritten',
+ async (storedPeriod, dashboardPeriod, buttonText) => {
localStorage.setItem(periodStorageKey, storedPeriod)
- const startUrl = `${getRouterBasepath({ domain, shared: false })}${stringifySearch({ period: queryPeriod })}`
+ const startUrl = `${getRouterBasepath({ domain, shared: false })}${stringifySearch({ period: dashboardPeriod })}`
- render(<QueryPeriodsPicker />, {
+ render(<DashboardPeriodPicker />, {
wrapper: (props) => (
<TestContextProviders
siteOptions={{ domain, shared: false }}
@@ -146,11 +146,11 @@ test.each([
await userEvent.click(screen.getByText(buttonText))
expect(screen.getByTestId('datemenu')).toBeVisible()
- expect(localStorage.getItem(periodStorageKey)).toBe(queryPeriod)
+ expect(localStorage.getItem(periodStorageKey)).toBe(dashboardPeriod)
}
)
-test('going back resets the stored query period to previous value', async () => {
+test('going back resets the stored dashboardState period to previous value', async () => {
const BrowserBackButton = () => {
const navigate = useNavigate()
return (
@@ -159,7 +159,7 @@ test('going back resets the stored query period to previous value', async () =>
}
render(
<>
- <QueryPeriodsPicker />
+ <DashboardPeriodPicker />
<BrowserBackButton />
</>,
{
diff --git a/assets/js/dashboard/nav-menu/query-periods/query-period-menu.tsx b/assets/js/dashboard/nav-menu/query-periods/dashboard-period-menu.tsx
similarity index 83%
rename from assets/js/dashboard/nav-menu/query-periods/query-period-menu.tsx
rename to assets/js/dashboard/nav-menu/query-periods/dashboard-period-menu.tsx
index 6674479c48..99b8edd220 100644
--- a/assets/js/dashboard/nav-menu/query-periods/query-period-menu.tsx
+++ b/assets/js/dashboard/nav-menu/query-periods/dashboard-period-menu.tsx
@@ -1,6 +1,6 @@
import React, { useMemo, useRef } from 'react'
import classNames from 'classnames'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import {
isModifierPressed,
@@ -16,11 +16,11 @@ import {
getCompareLinkItem,
getDatePeriodGroups,
LinkItem,
- QueryPeriod,
+ DashboardPeriod,
getCurrentPeriodDisplayName,
getSearchToApplyCustomDates,
isComparisonForbidden
-} from '../../query-time-periods'
+} from '../../dashboard-time-periods'
import { useMatch } from 'react-router-dom'
import { rootRoute } from '../../router'
import { Popover, Transition } from '@headlessui/react'
@@ -37,7 +37,7 @@ import { DateRangeCalendar } from './date-range-calendar'
import { formatISO, nowForSite } from '../../util/date'
import { MenuSeparator } from '../nav-menu-components'
-function QueryPeriodMenuKeybinds({
+function DashboardPeriodMenuKeybinds({
closeDropdown,
groups
}: {
@@ -79,12 +79,12 @@ function QueryPeriodMenuKeybinds({
)
}
-export const QueryPeriodMenu = ({
+export const DashboardPeriodMenu = ({
closeDropdown,
calendarButtonRef
}: PopoverMenuProps) => {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const buttonRef = useRef<HTMLButtonElement>(null)
const toggleCalendar = () => {
if (typeof calendarButtonRef.current?.click === 'function') {
@@ -97,11 +97,11 @@ export const QueryPeriodMenu = ({
<BlurMenuButtonOnEscape targetRef={buttonRef} />
<Popover.Button ref={buttonRef} className={datemenuButtonClassName}>
<span className={popover.toggleButton.classNames.truncatedText}>
- {getCurrentPeriodDisplayName({ query, site })}
+ {getCurrentPeriodDisplayName({ dashboardState, site })}
</span>
<DateMenuChevron />
</Popover.Button>
- <QueryPeriodMenuInner
+ <DashboardPeriodMenuInner
toggleCalendar={toggleCalendar}
closeDropdown={closeDropdown}
/>
@@ -109,7 +109,7 @@ export const QueryPeriodMenu = ({
)
}
-const QueryPeriodMenuInner = ({
+const DashboardPeriodMenuInner = ({
closeDropdown,
toggleCalendar
}: {
@@ -117,12 +117,12 @@ const QueryPeriodMenuInner = ({
toggleCalendar: () => void
}) => {
const site = useSiteContext()
- const { query, expandedSegment } = useQueryContext()
+ const { dashboardState, expandedSegment } = useDashboardStateContext()
const groups = useMemo(() => {
const compareLink = getCompareLinkItem({
site,
- query,
+ dashboardState,
onEvent: closeDropdown
})
return getDatePeriodGroups({
@@ -133,23 +133,27 @@ const QueryPeriodMenuInner = ({
['Custom Range', 'C'],
{
search: (s) => s,
- isActive: ({ query }) => query.period === QueryPeriod.custom,
+ isActive: ({ dashboardState }) =>
+ dashboardState.period === DashboardPeriod.custom,
onEvent: toggleCalendar
}
]
],
extraGroups: isComparisonForbidden({
- period: query.period,
+ period: dashboardState.period,
segmentIsExpanded: !!expandedSegment
})
? []
: [[compareLink]]
})
- }, [site, query, closeDropdown, toggleCalendar, expandedSegment])
+ }, [site, dashboardState, closeDropdown, toggleCalendar, expandedSegment])
return (
<>
- <QueryPeriodMenuKeybinds closeDropdown={closeDropdown} groups={groups} />
+ <DashboardPeriodMenuKeybinds
+ closeDropdown={closeDropdown}
+ groups={groups}
+ />
<Transition
as="div"
{...popover.transition.props}
@@ -173,7 +177,7 @@ const QueryPeriodMenuInner = ({
return (
<AppNavigationLink
key={label}
- data-selected={isActive({ site, query })}
+ data-selected={isActive({ site, dashboardState })}
className={linkClassName}
search={search}
onClick={onEvent && ((e) => onEvent(e))}
@@ -201,7 +205,7 @@ export const MainCalendar = ({
calendarButtonRef
}: PopoverMenuProps) => {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const navigate = useAppNavigate()
return (
@@ -224,8 +228,8 @@ export const MainCalendar = ({
minDate={site.statsBegin}
maxDate={formatISO(nowForSite(site))}
defaultDates={
- query.from && query.to
- ? [formatISO(query.from), formatISO(query.to)]
+ dashboardState.from && dashboardState.to
+ ? [formatISO(dashboardState.from), formatISO(dashboardState.to)]
: undefined
}
/>
diff --git a/assets/js/dashboard/nav-menu/query-periods/query-periods-picker.tsx b/assets/js/dashboard/nav-menu/query-periods/dashboard-period-picker.tsx
similarity index 79%
rename from assets/js/dashboard/nav-menu/query-periods/query-periods-picker.tsx
rename to assets/js/dashboard/nav-menu/query-periods/dashboard-period-picker.tsx
index ce5960368f..38caa5b876 100644
--- a/assets/js/dashboard/nav-menu/query-periods/query-periods-picker.tsx
+++ b/assets/js/dashboard/nav-menu/query-periods/dashboard-period-picker.tsx
@@ -1,18 +1,18 @@
import React, { useRef } from 'react'
import classNames from 'classnames'
-import { useQueryContext } from '../../query-context'
-import { isComparisonEnabled } from '../../query-time-periods'
+import { useDashboardStateContext } from '../../dashboard-state-context'
+import { isComparisonEnabled } from '../../dashboard-time-periods'
import { MovePeriodArrows } from './move-period-arrows'
-import { MainCalendar, QueryPeriodMenu } from './query-period-menu'
+import { MainCalendar, DashboardPeriodMenu } from './dashboard-period-menu'
import {
ComparisonCalendarMenu,
ComparisonPeriodMenu
} from './comparison-period-menu'
import { Popover } from '@headlessui/react'
-export function QueryPeriodsPicker({ className }: { className?: string }) {
- const { query } = useQueryContext()
- const isComparing = isComparisonEnabled(query.comparison)
+export function DashboardPeriodPicker({ className }: { className?: string }) {
+ const { dashboardState } = useDashboardStateContext()
+ const isComparing = isComparisonEnabled(dashboardState.comparison)
const mainCalendarButtonRef = useRef<HTMLButtonElement>(null)
const compareCalendarButtonRef = useRef<HTMLButtonElement>(null)
@@ -21,7 +21,7 @@ export function QueryPeriodsPicker({ className }: { className?: string }) {
<MovePeriodArrows className={isComparing ? 'hidden md:flex' : ''} />
<Popover className="min-w-36 md:relative lg:w-48">
{({ close }) => (
- <QueryPeriodMenu
+ <DashboardPeriodMenu
closeDropdown={close}
calendarButtonRef={mainCalendarButtonRef}
/>
diff --git a/assets/js/dashboard/nav-menu/query-periods/move-period-arrows.tsx b/assets/js/dashboard/nav-menu/query-periods/move-period-arrows.tsx
index ad41fe725a..f14e4d3832 100644
--- a/assets/js/dashboard/nav-menu/query-periods/move-period-arrows.tsx
+++ b/assets/js/dashboard/nav-menu/query-periods/move-period-arrows.tsx
@@ -1,11 +1,14 @@
import React, { useMemo } from 'react'
-import { shiftQueryPeriod, getDateForShiftedPeriod } from '../../query'
+import {
+ shiftDashboardPeriod,
+ getDateForShiftedPeriod
+} from '../../dashboard-state'
import classNames from 'classnames'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { NavigateKeybind } from '../../keybinding'
import { AppNavigationLink } from '../../navigation/use-app-navigate'
-import { QueryPeriod } from '../../query-time-periods'
+import { DashboardPeriod } from '../../dashboard-time-periods'
import { useMatch } from 'react-router-dom'
import { rootRoute } from '../../router'
@@ -15,17 +18,17 @@ const ArrowKeybind = ({
keyboardKey: 'ArrowLeft' | 'ArrowRight'
}) => {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const search = useMemo(
() =>
- shiftQueryPeriod({
- query,
+ shiftDashboardPeriod({
+ dashboardState,
site,
direction: ({ ArrowLeft: -1, ArrowRight: 1 } as const)[keyboardKey],
keybindHint: keyboardKey
}),
- [site, query, keyboardKey]
+ [site, dashboardState, keyboardKey]
)
return (
@@ -68,22 +71,22 @@ function ArrowIcon({
export function MovePeriodArrows({ className }: { className?: string }) {
const periodsWithArrows = [
- QueryPeriod.year,
- QueryPeriod.month,
- QueryPeriod.day
+ DashboardPeriod.year,
+ DashboardPeriod.month,
+ DashboardPeriod.day
]
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const dashboardRouteMatch = useMatch(rootRoute.path)
- if (!periodsWithArrows.includes(query.period)) {
+ if (!periodsWithArrows.includes(dashboardState.period)) {
return null
}
const canGoBack =
- getDateForShiftedPeriod({ site, query, direction: -1 }) !== null
+ getDateForShiftedPeriod({ site, dashboardState, direction: -1 }) !== null
const canGoForward =
- getDateForShiftedPeriod({ site, query, direction: 1 }) !== null
+ getDateForShiftedPeriod({ site, dashboardState, direction: 1 }) !== null
const sharedClass =
'flex items-center px-1 sm:px-2 dark:text-gray-100 transition-colors duration-150'
@@ -105,9 +108,9 @@ export function MovePeriodArrows({ className }: { className?: string }) {
)}
search={
canGoBack
- ? shiftQueryPeriod({
+ ? shiftDashboardPeriod({
site,
- query,
+ dashboardState,
direction: -1,
keybindHint: null
})
@@ -123,9 +126,9 @@ export function MovePeriodArrows({ className }: { className?: string }) {
})}
search={
canGoForward
- ? shiftQueryPeriod({
+ ? shiftDashboardPeriod({
site,
- query,
+ dashboardState,
direction: 1,
keybindHint: null
})
diff --git a/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx b/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx
index bf40d00a8b..2d1436317d 100644
--- a/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx
+++ b/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx
@@ -1,5 +1,5 @@
import React, { RefObject } from 'react'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import {
SavedSegmentPublic,
@@ -38,7 +38,7 @@ export const SearchableSegmentsSection = ({
const site = useSiteContext()
const segmentsContext = useSegmentsContext()
- const { expandedSegment } = useQueryContext()
+ const { expandedSegment } = useDashboardStateContext()
const user = useUserContext()
const isPublicListQuery = !user.loggedIn || user.role === Role.public
diff --git a/assets/js/dashboard/nav-menu/segments/segment-menu.tsx b/assets/js/dashboard/nav-menu/segments/segment-menu.tsx
index 60368fc435..e6dd231d11 100644
--- a/assets/js/dashboard/nav-menu/segments/segment-menu.tsx
+++ b/assets/js/dashboard/nav-menu/segments/segment-menu.tsx
@@ -12,10 +12,10 @@ import {
XMarkIcon
} from '@heroicons/react/24/outline'
import { ChevronDownIcon } from '@heroicons/react/20/solid'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useRoutelessModalsContext } from '../../navigation/routeless-modals-context'
import { SavedSegment } from '../../filtering/segments'
-import { DashboardQuery } from '../../query'
+import { DashboardState } from '../../dashboard-state'
const linkClassName = classNames(
popover.items.classNames.navigationLink,
@@ -28,15 +28,15 @@ const buttonClassName = classNames(
export const useClearExpandedSegmentModeOnFilterClear = ({
expandedSegment,
- query
+ dashboardState
}: {
expandedSegment: SavedSegment | null
- query: DashboardQuery
+ dashboardState: DashboardState
}) => {
const navigate = useAppNavigate()
useEffect(() => {
// clear edit mode on clearing all filters or removing last filter
- if (!!expandedSegment && !query.filters.length) {
+ if (!!expandedSegment && !dashboardState.filters.length) {
navigate({
search: (s) => s,
state: {
@@ -45,12 +45,12 @@ export const useClearExpandedSegmentModeOnFilterClear = ({
replace: true
})
}
- }, [query.filters, expandedSegment, navigate])
+ }, [dashboardState.filters, expandedSegment, navigate])
}
export const SegmentMenu = () => {
const { setModal } = useRoutelessModalsContext()
- const { expandedSegment } = useQueryContext()
+ const { expandedSegment } = useDashboardStateContext()
if (!expandedSegment) {
return null
diff --git a/assets/js/dashboard/nav-menu/top-bar.tsx b/assets/js/dashboard/nav-menu/top-bar.tsx
index d9b48aa1e6..287398fec3 100644
--- a/assets/js/dashboard/nav-menu/top-bar.tsx
+++ b/assets/js/dashboard/nav-menu/top-bar.tsx
@@ -6,7 +6,7 @@ import classNames from 'classnames'
import { useInView } from 'react-intersection-observer'
import { FilterMenu } from './filter-menu'
import { FiltersBar } from './filters-bar'
-import { QueryPeriodsPicker } from './query-periods/query-periods-picker'
+import { DashboardPeriodPicker } from './query-periods/dashboard-period-picker'
import { SegmentMenu } from './segments/segment-menu'
interface TopBarProps {
@@ -70,7 +70,7 @@ function TopBarInner({ showCurrentVisitors }: TopBarProps) {
<div className="flex gap-x-4 shrink-0">
<FilterMenu />
<SegmentMenu />
- <QueryPeriodsPicker />
+ <DashboardPeriodPicker />
</div>
</div>
)
diff --git a/assets/js/dashboard/router.tsx b/assets/js/dashboard/router.tsx
index eff35b3e73..df0d707851 100644
--- a/assets/js/dashboard/router.tsx
+++ b/assets/js/dashboard/router.tsx
@@ -23,7 +23,7 @@ import ScreenSizesModal from './stats/modals/devices/screen-sizes'
import PropsModal from './stats/modals/props'
import ConversionsModal from './stats/modals/conversions'
import FilterModal from './stats/modals/filter-modal'
-import QueryContextProvider from './query-context'
+import DashboardStateContextProvider from './dashboard-state-context'
import { DashboardKeybinds } from './dashboard-keybinds'
import LastLoadContextProvider from './last-load-context'
import { RoutelessModalsContextProvider } from './navigation/routeless-modals-context'
@@ -41,14 +41,14 @@ function DashboardElement() {
return (
<QueryClientProvider client={queryClient}>
<RoutelessModalsContextProvider>
- <QueryContextProvider>
+ <DashboardStateContextProvider>
<LastLoadContextProvider>
<Dashboard />
{/** render any children of the root route below */}
</LastLoadContextProvider>
<Outlet />
<RoutelessSegmentModals />
- </QueryContextProvider>
+ </DashboardStateContextProvider>
</RoutelessModalsContextProvider>
</QueryClientProvider>
)
diff --git a/assets/js/dashboard/segments/routeless-segment-modals.tsx b/assets/js/dashboard/segments/routeless-segment-modals.tsx
index 6541b5d93a..3f8f2dc9a4 100644
--- a/assets/js/dashboard/segments/routeless-segment-modals.tsx
+++ b/assets/js/dashboard/segments/routeless-segment-modals.tsx
@@ -16,7 +16,7 @@ import { useMutation, useQueryClient } from '@tanstack/react-query'
import { useSiteContext } from '../site-context'
import { cleanLabels, remapToApiFilters } from '../util/filters'
import { useAppNavigate } from '../navigation/use-app-navigate'
-import { useQueryContext } from '../query-context'
+import { useDashboardStateContext } from '../dashboard-state-context'
import { useUserContext } from '../user-context'
import { mutation } from '../api'
import { useRoutelessModalsContext } from '../navigation/routeless-modals-context'
@@ -30,7 +30,7 @@ export const RoutelessSegmentModals = () => {
const queryClient = useQueryClient()
const site = useSiteContext()
const { modal, setModal } = useRoutelessModalsContext()
- const { query, expandedSegment } = useQueryContext()
+ const { dashboardState, expandedSegment } = useDashboardStateContext()
const user = useUserContext()
const patchSegment = useMutation({
@@ -158,7 +158,7 @@ export const RoutelessSegmentModals = () => {
user={user}
siteSegmentsAvailable={site.siteSegmentsAvailable}
segment={expandedSegment}
- namePlaceholder={getSegmentNamePlaceholder(query)}
+ namePlaceholder={getSegmentNamePlaceholder(dashboardState)}
onClose={() => {
setModal(null)
patchSegment.reset()
@@ -169,8 +169,8 @@ export const RoutelessSegmentModals = () => {
name,
type,
segment_data: {
- filters: query.filters,
- labels: query.labels
+ filters: dashboardState.filters,
+ labels: dashboardState.labels
}
})
}
@@ -183,7 +183,7 @@ export const RoutelessSegmentModals = () => {
<CreateSegmentModal
user={user}
siteSegmentsAvailable={site.siteSegmentsAvailable}
- namePlaceholder={getSegmentNamePlaceholder(query)}
+ namePlaceholder={getSegmentNamePlaceholder(dashboardState)}
segment={expandedSegment ?? undefined}
onClose={() => {
setModal(null)
@@ -194,8 +194,8 @@ export const RoutelessSegmentModals = () => {
name,
type,
segment_data: {
- filters: query.filters,
- labels: query.labels
+ filters: dashboardState.filters,
+ labels: dashboardState.labels
}
})
}
diff --git a/assets/js/dashboard/stats/behaviours/conversions.js b/assets/js/dashboard/stats/behaviours/conversions.js
index 128b72b105..aa5ff34dc1 100644
--- a/assets/js/dashboard/stats/behaviours/conversions.js
+++ b/assets/js/dashboard/stats/behaviours/conversions.js
@@ -5,14 +5,16 @@ import * as url from '../../util/url'
import * as metrics from '../reports/metrics'
import ListReport from '../reports/list'
import { useSiteContext } from '../../site-context'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
export default function Conversions({ afterFetchData, onGoalFilterClick }) {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
function fetchConversions() {
- return api.get(url.apiPath(site, '/conversions'), query, { limit: 9 })
+ return api.get(url.apiPath(site, '/conversions'), dashboardState, {
+ limit: 9
+ })
}
function getFilterInfo(listItem) {
@@ -25,11 +27,11 @@ export default function Conversions({ afterFetchData, onGoalFilterClick }) {
function chooseMetrics() {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Uniques',
+ renderLabel: (_dashboardState) => 'Uniques',
meta: { plot: true }
}),
metrics.createEvents({
- renderLabel: (_query) => 'Total',
+ renderLabel: (_dashboardState) => 'Total',
meta: { hiddenOnMobile: true }
}),
metrics.createConversionRate(),
diff --git a/assets/js/dashboard/stats/behaviours/index.js b/assets/js/dashboard/stats/behaviours/index.js
index 93d99ea674..d49fc7f58e 100644
--- a/assets/js/dashboard/stats/behaviours/index.js
+++ b/assets/js/dashboard/stats/behaviours/index.js
@@ -9,7 +9,7 @@ import {
FILTER_OPERATIONS
} from '../../util/filters'
import { useSiteContext } from '../../site-context'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useUserContext } from '../../user-context'
import { DropdownTabButton, TabButton, TabWrapper } from '../../components/tabs'
import { ReportLayout } from '../reports/report-layout'
@@ -43,8 +43,8 @@ function maybeRequire() {
const Funnel = maybeRequire().default
-function singleGoalFilterApplied(query) {
- const goalFilter = getGoalFilter(query)
+function singleGoalFilterApplied(dashboardState) {
+ const goalFilter = getGoalFilter(dashboardState)
if (goalFilter) {
const [operation, _filterKey, clauses] = goalFilter
return operation === FILTER_OPERATIONS.is && clauses.length === 1
@@ -68,9 +68,9 @@ const STORAGE_KEYS = {
}
}
-function getPropKeyFromStorage({ site, query }) {
- if (singleGoalFilterApplied(query)) {
- const [_operation, _dimension, [goalName]] = getGoalFilter(query)
+function getPropKeyFromStorage({ site, dashboardState }) {
+ if (singleGoalFilterApplied(dashboardState)) {
+ const [_operation, _dimension, [goalName]] = getGoalFilter(dashboardState)
const storedForGoal = storage.getItem(
STORAGE_KEYS.getForPropKeyForGoal({ goalName, site })
)
@@ -82,9 +82,9 @@ function getPropKeyFromStorage({ site, query }) {
return storage.getItem(STORAGE_KEYS.getForPropKey({ site }))
}
-function storePropKey({ site, propKey, query }) {
- if (singleGoalFilterApplied(query)) {
- const [_operation, _dimension, [goalName]] = getGoalFilter(query)
+function storePropKey({ site, propKey, dashboardState }) {
+ if (singleGoalFilterApplied(dashboardState)) {
+ const [_operation, _dimension, [goalName]] = getGoalFilter(dashboardState)
storage.setItem(
STORAGE_KEYS.getForPropKeyForGoal({ goalName, site }),
propKey
@@ -108,8 +108,8 @@ function getDefaultSelectedFunnel({ site }) {
}
function Behaviours({ importedDataInView, setMode, mode }) {
- const { query } = useQueryContext()
- const goalFilter = getGoalFilter(query)
+ const { dashboardState } = useDashboardStateContext()
+ const goalFilter = getGoalFilter(dashboardState)
const specialGoal = goalFilter ? getSpecialGoal(goalFilter) : null
const site = useSiteContext()
const user = useUserContext()
@@ -122,7 +122,8 @@ function Behaviours({ importedDataInView, setMode, mode }) {
const [selectedFunnel, setSelectedFunnel] = useState(
getDefaultSelectedFunnel({ site })
)
- const initialSelectedPropKey = getPropKeyFromStorage({ site, query }) || null
+ const initialSelectedPropKey =
+ getPropKeyFromStorage({ site, dashboardState }) || null
const [selectedPropKey, setSelectedPropKey] = useState(initialSelectedPropKey)
const [propertyKeys, setPropertyKeys] = useState(
selectedPropKey !== null ? [selectedPropKey] : []
@@ -154,7 +155,7 @@ function Behaviours({ importedDataInView, setMode, mode }) {
)
useEffect(() => {
- const justRemovedGoalFilter = !hasConversionGoalFilter(query)
+ const justRemovedGoalFilter = !hasConversionGoalFilter(dashboardState)
if (
mode === Mode.PROPS &&
justRemovedGoalFilter &&
@@ -164,16 +165,16 @@ function Behaviours({ importedDataInView, setMode, mode }) {
setMode(Mode.CONVERSIONS)
}
// eslint-disable-next-line react-hooks/exhaustive-deps
- }, [hasConversionGoalFilter(query)])
+ }, [hasConversionGoalFilter(dashboardState)])
- useEffect(() => setLoading(true), [query, mode])
+ useEffect(() => setLoading(true), [dashboardState, mode])
useEffect(() => {
if (mode === Mode.PROPS && !selectedPropKey) {
setMoreLinkState(MoreLinkState.HIDDEN)
} else {
setMoreLinkState(MoreLinkState.LOADING)
}
- }, [query, mode, selectedPropKey])
+ }, [dashboardState, mode, selectedPropKey])
function setFunnelFactory(selectedFunnelName) {
return () => {
@@ -187,7 +188,7 @@ function Behaviours({ importedDataInView, setMode, mode }) {
function setPropKeyFactory(selectedPropKeyName) {
return () => {
storage.setItem(STORAGE_KEYS.getForTab({ site }), Mode.PROPS)
- storePropKey({ site, propKey: selectedPropKeyName, query })
+ storePropKey({ site, propKey: selectedPropKeyName, dashboardState })
setMode(Mode.PROPS)
setSelectedPropKey(selectedPropKeyName)
}
@@ -202,14 +203,14 @@ function Behaviours({ importedDataInView, setMode, mode }) {
site.propsAvailable
) {
api
- .get(url.apiPath(site, '/suggestions/prop_key'), query, {
+ .get(url.apiPath(site, '/suggestions/prop_key'), dashboardState, {
q: ''
})
.then((propKeys) => {
const propKeyValues = propKeys.map((entry) => entry.value)
setPropertyKeys(propKeyValues)
if (propKeyValues.length > 0) {
- const stored = getPropKeyFromStorage({ site, query })
+ const stored = getPropKeyFromStorage({ site, dashboardState })
const storedExists = stored && propKeyValues.includes(stored)
if (storedExists) {
@@ -217,7 +218,7 @@ function Behaviours({ importedDataInView, setMode, mode }) {
} else {
const firstAvailable = propKeyValues[0]
setSelectedPropKey(firstAvailable)
- storePropKey({ site, propKey: firstAvailable, query })
+ storePropKey({ site, propKey: firstAvailable, dashboardState })
}
} else {
setSelectedPropKey(null)
@@ -233,7 +234,7 @@ function Behaviours({ importedDataInView, setMode, mode }) {
setPropertyKeys([])
setSelectedPropKey(null)
}
- }, [site, query, enabledModes])
+ }, [site, dashboardState, enabledModes])
function setTabFactory(tab) {
return () => {
@@ -414,7 +415,7 @@ function Behaviours({ importedDataInView, setMode, mode }) {
}
function isRealtime() {
- return query.period === 'realtime'
+ return dashboardState.period === 'realtime'
}
function renderImportedQueryUnsupportedWarning() {
diff --git a/assets/js/dashboard/stats/behaviours/props.js b/assets/js/dashboard/stats/behaviours/props.js
index 2a453c654e..30b2331219 100644
--- a/assets/js/dashboard/stats/behaviours/props.js
+++ b/assets/js/dashboard/stats/behaviours/props.js
@@ -4,17 +4,17 @@ import * as metrics from '../reports/metrics'
import * as api from '../../api'
import * as url from '../../util/url'
import { EVENT_PROPS_PREFIX, hasConversionGoalFilter } from '../../util/filters'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
export default function Properties({ propKey, afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
function fetchProps() {
return api.get(
url.apiPath(site, `/custom-prop-values/${encodeURIComponent(propKey)}`),
- query
+ dashboardState
)
}
@@ -22,15 +22,15 @@ export default function Properties({ propKey, afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Visitors',
+ renderLabel: (_dashboardState) => 'Visitors',
meta: { plot: true }
}),
metrics.createEvents({
- renderLabel: (_query) => 'Events',
+ renderLabel: (_dashboardState) => 'Events',
meta: { hiddenOnMobile: true }
}),
- hasConversionGoalFilter(query) && metrics.createConversionRate(),
- !hasConversionGoalFilter(query) && metrics.createPercentage(),
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate(),
+ !hasConversionGoalFilter(dashboardState) && metrics.createPercentage(),
BUILD_EXTRA &&
metrics.createTotalRevenue({ meta: { hiddenOnMobile: true } }),
BUILD_EXTRA &&
diff --git a/assets/js/dashboard/stats/behaviours/special-goal-prop-breakdown.js b/assets/js/dashboard/stats/behaviours/special-goal-prop-breakdown.js
index 2301ad2608..700b920425 100644
--- a/assets/js/dashboard/stats/behaviours/special-goal-prop-breakdown.js
+++ b/assets/js/dashboard/stats/behaviours/special-goal-prop-breakdown.js
@@ -5,14 +5,17 @@ import * as url from '../../util/url'
import * as api from '../../api'
import { EVENT_PROPS_PREFIX } from '../../util/filters'
import { useSiteContext } from '../../site-context'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
export function SpecialGoalPropBreakdown({ prop, afterFetchData }) {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
function fetchData() {
- return api.get(url.apiPath(site, `/custom-prop-values/${prop}`), query)
+ return api.get(
+ url.apiPath(site, `/custom-prop-values/${prop}`),
+ dashboardState
+ )
}
function getExternalLinkUrlFactory() {
@@ -35,11 +38,11 @@ export function SpecialGoalPropBreakdown({ prop, afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Visitors',
+ renderLabel: (_dashboardState) => 'Visitors',
meta: { plot: true }
}),
metrics.createEvents({
- renderLabel: (_query) => 'Events',
+ renderLabel: (_dashboardState) => 'Events',
meta: { hiddenOnMobile: true }
}),
metrics.createConversionRate()
diff --git a/assets/js/dashboard/stats/current-visitors.js b/assets/js/dashboard/stats/current-visitors.js
index 4d95c76942..79e149dcfb 100644
--- a/assets/js/dashboard/stats/current-visitors.js
+++ b/assets/js/dashboard/stats/current-visitors.js
@@ -3,7 +3,7 @@ import { AppNavigationLink } from '../navigation/use-app-navigate'
import * as api from '../api'
import { Tooltip } from '../util/tooltip'
import { SecondsSinceLastLoad } from '../util/seconds-since-last-load'
-import { useQueryContext } from '../query-context'
+import { useDashboardStateContext } from '../dashboard-state-context'
import { useSiteContext } from '../site-context'
import { useLastLoadContext } from '../last-load-context'
import classNames from 'classnames'
@@ -12,7 +12,7 @@ export default function CurrentVisitors({
className = '',
tooltipBoundaryRef
}) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const lastLoadTimestamp = useLastLoadContext()
const site = useSiteContext()
const [currentVisitors, setCurrentVisitors] = useState(null)
@@ -33,9 +33,9 @@ export default function CurrentVisitors({
useEffect(() => {
updateCount()
- }, [query, updateCount])
+ }, [dashboardState, updateCount])
- if (currentVisitors !== null && query.filters.length === 0) {
+ if (currentVisitors !== null && dashboardState.filters.length === 0) {
return (
<Tooltip
info={
diff --git a/assets/js/dashboard/stats/devices/index.js b/assets/js/dashboard/stats/devices/index.js
index 98b323392e..68ff92bbc0 100644
--- a/assets/js/dashboard/stats/devices/index.js
+++ b/assets/js/dashboard/stats/devices/index.js
@@ -10,7 +10,7 @@ import * as metrics from '../reports/metrics'
import * as api from '../../api'
import * as url from '../../util/url'
import ImportedQueryUnsupportedWarning from '../imported-query-unsupported-warning'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { ReportLayout } from '../reports/report-layout'
import { ReportHeader } from '../reports/report-header'
@@ -61,9 +61,9 @@ export function browserIconFor(browser) {
function Browsers({ afterFetchData }) {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
function fetchData() {
- return api.get(url.apiPath(site, '/browsers'), query)
+ return api.get(url.apiPath(site, '/browsers'), dashboardState)
}
function getFilterInfo(listItem) {
@@ -80,9 +80,9 @@ function Browsers({ afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -99,10 +99,10 @@ function Browsers({ afterFetchData }) {
}
function BrowserVersions({ afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
function fetchData() {
- return api.get(url.apiPath(site, '/browser-versions'), query)
+ return api.get(url.apiPath(site, '/browser-versions'), dashboardState)
}
function renderIcon(listItem) {
@@ -110,7 +110,7 @@ function BrowserVersions({ afterFetchData }) {
}
function getFilterInfo(listItem) {
- if (getSingleFilter(query, 'browser') == '(not set)') {
+ if (getSingleFilter(dashboardState, 'browser') == '(not set)') {
return null
}
return {
@@ -122,9 +122,9 @@ function BrowserVersions({ afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -169,10 +169,10 @@ export function osIconFor(os) {
}
function OperatingSystems({ afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
function fetchData() {
- return api.get(url.apiPath(site, '/operating-systems'), query)
+ return api.get(url.apiPath(site, '/operating-systems'), dashboardState)
}
function getFilterInfo(listItem) {
@@ -185,11 +185,11 @@ function OperatingSystems({ afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({
meta: { showOnHover: true }
}),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -210,11 +210,14 @@ function OperatingSystems({ afterFetchData }) {
}
function OperatingSystemVersions({ afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
function fetchData() {
- return api.get(url.apiPath(site, '/operating-system-versions'), query)
+ return api.get(
+ url.apiPath(site, '/operating-system-versions'),
+ dashboardState
+ )
}
function renderIcon(listItem) {
@@ -222,7 +225,7 @@ function OperatingSystemVersions({ afterFetchData }) {
}
function getFilterInfo(listItem) {
- if (getSingleFilter(query, 'os') == '(not set)') {
+ if (getSingleFilter(dashboardState, 'os') == '(not set)') {
return null
}
return {
@@ -234,9 +237,9 @@ function OperatingSystemVersions({ afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -253,11 +256,11 @@ function OperatingSystemVersions({ afterFetchData }) {
}
function ScreenSizes({ afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
function fetchData() {
- return api.get(url.apiPath(site, '/screen-sizes'), query)
+ return api.get(url.apiPath(site, '/screen-sizes'), dashboardState)
}
function renderIcon(listItem) {
@@ -274,9 +277,9 @@ function ScreenSizes({ afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -418,7 +421,7 @@ export function screenSizeIconFor(screenSize) {
}
export default function Devices() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const tabKey = `deviceTab__${site.domain}`
@@ -446,12 +449,12 @@ export default function Devices() {
useEffect(() => {
setLoading(true)
setMoreLinkState(MoreLinkState.LOADING)
- }, [query, mode])
+ }, [dashboardState, mode])
function moreLinkProps() {
switch (mode) {
case 'browser':
- if (isFilteringOnFixedValue(query, 'browser')) {
+ if (isFilteringOnFixedValue(dashboardState, 'browser')) {
return {
path: browserVersionsRoute.path,
search: (search) => search
@@ -462,7 +465,7 @@ export default function Devices() {
search: (search) => search
}
case 'os':
- if (isFilteringOnFixedValue(query, 'os')) {
+ if (isFilteringOnFixedValue(dashboardState, 'os')) {
return {
path: operatingSystemVersionsRoute.path,
search: (search) => search
@@ -484,12 +487,12 @@ export default function Devices() {
function renderContent() {
switch (mode) {
case 'browser':
- if (isFilteringOnFixedValue(query, 'browser')) {
+ if (isFilteringOnFixedValue(dashboardState, 'browser')) {
return <BrowserVersions afterFetchData={afterFetchData} />
}
return <Browsers afterFetchData={afterFetchData} />
case 'os':
- if (isFilteringOnFixedValue(query, 'os')) {
+ if (isFilteringOnFixedValue(dashboardState, 'os')) {
return <OperatingSystemVersions afterFetchData={afterFetchData} />
}
return <OperatingSystems afterFetchData={afterFetchData} />
@@ -530,8 +533,8 @@ export default function Devices() {
)
}
-function getSingleFilter(query, filterKey) {
- const matches = getFiltersByKeyPrefix(query, filterKey)
+function getSingleFilter(dashboardState, filterKey) {
+ const matches = getFiltersByKeyPrefix(dashboardState, filterKey)
if (matches.length != 1) {
return null
}
diff --git a/assets/js/dashboard/stats/graph/date-formatter.js b/assets/js/dashboard/stats/graph/date-formatter.js
index 690dc36f5a..caf6461119 100644
--- a/assets/js/dashboard/stats/graph/date-formatter.js
+++ b/assets/js/dashboard/stats/graph/date-formatter.js
@@ -92,10 +92,10 @@ const factory = {
* while other intervals require dates to be displayed.
* @param {Object} config - Configuration object for determining formatter.
*
- * @param {string} config.interval - The interval of the query, e.g. `minute`, `hour`
+ * @param {string} config.interval - The interval of the dashboardState, e.g. `minute`, `hour`
* @param {boolean} config.longForm - Whether the formatted result should be in long or
* short form.
- * @param {string} config.period - The period of the query, e.g. `12mo`, `day`
+ * @param {string} config.period - The `DashboardPeriod`, e.g. `12mo`, `day`
* @param {boolean} config.isPeriodFull - Indicates whether the interval has been cut
* off by the requested date range or not. If false, the returned formatted date
* indicates this cut off, e.g. `Partial week of November 8`.
diff --git a/assets/js/dashboard/stats/graph/graph-tooltip.js b/assets/js/dashboard/stats/graph/graph-tooltip.js
index c1fb1f402d..269b6b44b4 100644
--- a/assets/js/dashboard/stats/graph/graph-tooltip.js
+++ b/assets/js/dashboard/stats/graph/graph-tooltip.js
@@ -7,7 +7,7 @@ import { ChangeArrow } from '../reports/change-arrow'
import { UIMode } from '../../theme-context'
const renderBucketLabel = function (
- query,
+ dashboardState,
graphData,
label,
comparison = false
@@ -20,16 +20,16 @@ const renderBucketLabel = function (
const formattedLabel = dateFormatter({
interval: graphData.interval,
longForm: true,
- period: query.period,
+ period: dashboardState.period,
isPeriodFull,
shouldShowYear
})(label)
- if (query.period === 'realtime') {
+ if (dashboardState.period === 'realtime') {
return dateFormatter({
interval: graphData.interval,
longForm: true,
- period: query.period,
+ period: dashboardState.period,
shouldShowYear
})(label)
}
@@ -38,7 +38,7 @@ const renderBucketLabel = function (
const date = dateFormatter({
interval: 'day',
longForm: true,
- period: query.period,
+ period: dashboardState.period,
shouldShowYear
})(label)
return `${date}, ${formattedLabel}`
@@ -57,7 +57,12 @@ const calculatePercentageDifference = function (oldValue, newValue) {
}
}
-const buildTooltipData = function (query, graphData, metric, tooltipModel) {
+const buildTooltipData = function (
+ dashboardState,
+ graphData,
+ metric,
+ tooltipModel
+) {
const data = tooltipModel.dataPoints.find(
(dataPoint) => dataPoint.dataset.yAxisID == 'y'
)
@@ -67,11 +72,15 @@ const buildTooltipData = function (query, graphData, metric, tooltipModel) {
const label =
data &&
- renderBucketLabel(query, graphData, graphData.labels[data.dataIndex])
+ renderBucketLabel(
+ dashboardState,
+ graphData,
+ graphData.labels[data.dataIndex]
+ )
const comparisonLabel =
comparisonData &&
renderBucketLabel(
- query,
+ dashboardState,
graphData,
graphData.comparison_labels[comparisonData.dataIndex],
true
@@ -100,7 +109,7 @@ const buildTooltipData = function (query, graphData, metric, tooltipModel) {
let tooltipRoot
-export default function GraphTooltip(graphData, metric, query, theme) {
+export default function GraphTooltip(graphData, metric, dashboardState, theme) {
return (context) => {
const tooltipModel = context.tooltip
const offset = document
@@ -136,7 +145,7 @@ export default function GraphTooltip(graphData, metric, query, theme) {
if (tooltipModel.body) {
const tooltipData = buildTooltipData(
- query,
+ dashboardState,
graphData,
metric,
tooltipModel
diff --git a/assets/js/dashboard/stats/graph/interval-picker.tsx b/assets/js/dashboard/stats/graph/interval-picker.tsx
index 52528ab922..aadc285ac6 100644
--- a/assets/js/dashboard/stats/graph/interval-picker.tsx
+++ b/assets/js/dashboard/stats/graph/interval-picker.tsx
@@ -4,14 +4,14 @@ import { ChevronDownIcon } from '@heroicons/react/20/solid'
import classNames from 'classnames'
import * as storage from '../../util/storage'
import { isModifierPressed, isTyping, Keybind } from '../../keybinding'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext, PlausibleSite } from '../../site-context'
import { useMatch } from 'react-router-dom'
import { rootRoute } from '../../router'
import { BlurMenuButtonOnEscape, popover } from '../../components/popover'
-import { DashboardQuery } from '../../query'
+import { DashboardState } from '../../dashboard-state'
import { Dayjs } from 'dayjs'
-import { QueryPeriod } from '../../query-time-periods'
+import { DashboardPeriod } from '../../dashboard-time-periods'
const INTERVAL_LABELS: Record<string, string> = {
minute: 'Minutes',
@@ -21,24 +21,31 @@ const INTERVAL_LABELS: Record<string, string> = {
month: 'Months'
}
-function validIntervals(site: PlausibleSite, query: DashboardQuery): string[] {
- if (query.period === QueryPeriod.custom && query.from && query.to) {
- if (query.to.diff(query.from, 'days') < 7) {
+function validIntervals(
+ site: PlausibleSite,
+ dashboardState: DashboardState
+): string[] {
+ if (
+ dashboardState.period === DashboardPeriod.custom &&
+ dashboardState.from &&
+ dashboardState.to
+ ) {
+ if (dashboardState.to.diff(dashboardState.from, 'days') < 7) {
return ['day']
- } else if (query.to.diff(query.from, 'months') < 1) {
+ } else if (dashboardState.to.diff(dashboardState.from, 'months') < 1) {
return ['day', 'week']
- } else if (query.to.diff(query.from, 'months') < 12) {
+ } else if (dashboardState.to.diff(dashboardState.from, 'months') < 12) {
return ['day', 'week', 'month']
} else {
return ['week', 'month']
}
} else {
- return site.validIntervalsByPeriod[query.period]
+ return site.validIntervalsByPeriod[dashboardState.period]
}
}
function getDefaultInterval(
- query: DashboardQuery,
+ dashboardState: DashboardState,
validIntervals: string[]
): string {
const defaultByPeriod: Record<string, string> = {
@@ -50,10 +57,14 @@ function getDefaultInterval(
year: 'month'
}
- if (query.period === QueryPeriod.custom && query.from && query.to) {
- return defaultForCustomPeriod(query.from, query.to)
+ if (
+ dashboardState.period === DashboardPeriod.custom &&
+ dashboardState.from &&
+ dashboardState.to
+ ) {
+ return defaultForCustomPeriod(dashboardState.from, dashboardState.to)
} else {
- return defaultByPeriod[query.period] || validIntervals[0]
+ return defaultByPeriod[dashboardState.period] || validIntervals[0]
}
}
@@ -83,12 +94,12 @@ function storeInterval(period: string, domain: string, interval: string): void {
export const getCurrentInterval = function (
site: PlausibleSite,
- query: DashboardQuery
+ dashboardState: DashboardState
): string {
- const options = validIntervals(site, query)
+ const options = validIntervals(site, dashboardState)
- const storedInterval = getStoredInterval(query.period, site.domain)
- const defaultInterval = getDefaultInterval(query, options)
+ const storedInterval = getStoredInterval(dashboardState.period, site.domain)
+ const defaultInterval = getDefaultInterval(dashboardState, options)
if (storedInterval && options.includes(storedInterval)) {
return storedInterval
@@ -103,19 +114,19 @@ export function IntervalPicker({
onIntervalUpdate: (interval: string) => void
}): JSX.Element | null {
const menuElement = useRef<HTMLButtonElement>(null)
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const dashboardRouteMatch = useMatch(rootRoute.path)
- if (query.period == 'realtime') {
+ if (dashboardState.period == 'realtime') {
return null
}
- const options = validIntervals(site, query)
- const currentInterval = getCurrentInterval(site, query)
+ const options = validIntervals(site, dashboardState)
+ const currentInterval = getCurrentInterval(site, dashboardState)
function updateInterval(interval: string): void {
- storeInterval(query.period, site.domain, interval)
+ storeInterval(dashboardState.period, site.domain, interval)
onIntervalUpdate(interval)
}
diff --git a/assets/js/dashboard/stats/graph/line-graph.js b/assets/js/dashboard/stats/graph/line-graph.js
index 4b10e73409..cca26000a1 100644
--- a/assets/js/dashboard/stats/graph/line-graph.js
+++ b/assets/js/dashboard/stats/graph/line-graph.js
@@ -1,6 +1,6 @@
import React from 'react'
import { useAppNavigate } from '../../navigation/use-app-navigate'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import Chart from 'chart.js/auto'
import GraphTooltip from './graph-tooltip'
import { buildDataSet, METRIC_LABELS, hasMultipleYears } from './graph-util'
@@ -33,7 +33,10 @@ class LineGraph extends React.Component {
getGraphMetric() {
let metric = this.props.graphData.metric
- if (metric == 'visitors' && hasConversionGoalFilter(this.props.query)) {
+ if (
+ metric == 'visitors' &&
+ hasConversionGoalFilter(this.props.dashboardState)
+ ) {
return 'conversions'
} else {
return metric
@@ -41,7 +44,7 @@ class LineGraph extends React.Component {
}
regenerateChart() {
- const { graphData, query, theme } = this.props
+ const { graphData, dashboardState, theme } = this.props
const metric = this.getGraphMetric()
const graphEl = document.getElementById('main-graph-canvas')
this.ctx = graphEl.getContext('2d')
@@ -68,7 +71,7 @@ class LineGraph extends React.Component {
mode: 'index',
intersect: false,
position: 'average',
- external: GraphTooltip(graphData, metric, query, theme)
+ external: GraphTooltip(graphData, metric, dashboardState, theme)
}
},
responsive: true,
@@ -111,42 +114,45 @@ class LineGraph extends React.Component {
const shouldShowYear = hasMultipleYears(graphData)
- if (graphData.interval === 'hour' && query.period !== 'day') {
+ if (
+ graphData.interval === 'hour' &&
+ dashboardState.period !== 'day'
+ ) {
const date = dateFormatter({
interval: 'day',
longForm: false,
- period: query.period,
+ period: dashboardState.period,
shouldShowYear
})(this.getLabelForValue(val))
const hour = dateFormatter({
interval: graphData.interval,
longForm: false,
- period: query.period,
+ period: dashboardState.period,
shouldShowYear
})(this.getLabelForValue(val))
// Returns a combination of date and hour. This is because
// small intervals like hour may return multiple days
- // depending on the query period.
+ // depending on the queried period.
return `${date}, ${hour}`
}
if (
graphData.interval === 'minute' &&
- query.period !== 'realtime'
+ dashboardState.period !== 'realtime'
) {
return dateFormatter({
interval: 'hour',
longForm: false,
- period: query.period
+ period: dashboardState.period
})(this.getLabelForValue(val))
}
return dateFormatter({
interval: graphData.interval,
longForm: false,
- period: query.period,
+ period: dashboardState.period,
shouldShowYear
})(this.getLabelForValue(val))
},
@@ -273,10 +279,15 @@ class LineGraph extends React.Component {
}
export default function LineGraphWrapped(props) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const navigate = useAppNavigate()
const theme = useTheme()
return (
- <LineGraph {...props} navigate={navigate} query={query} theme={theme} />
+ <LineGraph
+ {...props}
+ navigate={navigate}
+ dashboardState={dashboardState}
+ theme={theme}
+ />
)
}
diff --git a/assets/js/dashboard/stats/graph/stats-export.tsx b/assets/js/dashboard/stats/graph/stats-export.tsx
index 675819b26e..bd300fb24b 100644
--- a/assets/js/dashboard/stats/graph/stats-export.tsx
+++ b/assets/js/dashboard/stats/graph/stats-export.tsx
@@ -2,12 +2,12 @@ import React, { useState } from 'react'
import * as api from '../../api'
import { getCurrentInterval } from './interval-picker'
import { useSiteContext } from '../../site-context'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { Tooltip } from '../../util/tooltip'
export default function StatsExport() {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const [exporting, setExporting] = useState(false)
function startExport() {
@@ -50,11 +50,11 @@ export default function StatsExport() {
}
function renderExportLink() {
- const interval = getCurrentInterval(site, query)
- const queryParams = api.queryToSearchParams(query, [
+ const interval = getCurrentInterval(site, dashboardState)
+ const params = api.dashboardStateToSearchParams(dashboardState, [
{ interval, comparison: undefined }
])
- const endpoint = `/${encodeURIComponent(site.domain)}/export?${queryParams}`
+ const endpoint = `/${encodeURIComponent(site.domain)}/export?${params}`
return (
<a
diff --git a/assets/js/dashboard/stats/graph/top-stats.js b/assets/js/dashboard/stats/graph/top-stats.js
index e370dca7c5..87e8a6e14f 100644
--- a/assets/js/dashboard/stats/graph/top-stats.js
+++ b/assets/js/dashboard/stats/graph/top-stats.js
@@ -4,7 +4,7 @@ import { SecondsSinceLastLoad } from '../../util/seconds-since-last-load'
import classNames from 'classnames'
import * as storage from '../../util/storage'
import { formatDateRange } from '../../util/date'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { useLastLoadContext } from '../../last-load-context'
import { ChangeArrow } from '../reports/change-arrow'
@@ -29,11 +29,11 @@ export default function TopStats({
tooltipBoundary,
graphableMetrics
}) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const lastLoadTimestamp = useLastLoadContext()
const site = useSiteContext()
- const isComparison = query.comparison && data && data.comparing_from
+ const isComparison = dashboardState.comparison && data && data.comparing_from
function tooltip(stat) {
let statName = stat.name.toLowerCase()
@@ -161,7 +161,7 @@ export default function TopStats({
return (
<Tooltip
key={stat.name}
- info={tooltip(stat, query)}
+ info={tooltip(stat, dashboardState)}
className={className}
onClick={() => {
maybeUpdateMetric(stat)
@@ -211,7 +211,7 @@ export default function TopStats({
const stats =
data && data.top_stats.filter((stat) => stat.value !== null).map(renderStat)
- if (stats && query.period === 'realtime') {
+ if (stats && dashboardState.period === 'realtime') {
stats.push(blinkingDot())
}
diff --git a/assets/js/dashboard/stats/graph/visitor-graph.js b/assets/js/dashboard/stats/graph/visitor-graph.js
index c9e19a538c..196b7b4e5b 100644
--- a/assets/js/dashboard/stats/graph/visitor-graph.js
+++ b/assets/js/dashboard/stats/graph/visitor-graph.js
@@ -9,31 +9,34 @@ import WithImportedSwitch from './with-imported-switch'
import { getSamplingNotice, NoticesIcon } from './notices'
import FadeIn from '../../fade-in'
import * as url from '../../util/url'
-import { isComparisonEnabled } from '../../query-time-periods'
+import { isComparisonEnabled } from '../../dashboard-time-periods'
import LineGraphWithRouter from './line-graph'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
-function fetchTopStats(site, query) {
- const q = { ...query }
+function fetchTopStats(site, dashboardState) {
+ const q = { ...dashboardState }
- if (!isComparisonEnabled(q.comparison) && query.period !== 'realtime') {
+ if (
+ !isComparisonEnabled(q.comparison) &&
+ dashboardState.period !== 'realtime'
+ ) {
q.comparison = 'previous_period'
}
return api.get(url.apiPath(site, '/top-stats'), q)
}
-function fetchMainGraph(site, query, metric, interval) {
+function fetchMainGraph(site, dashboardState, metric, interval) {
const params = { metric, interval }
- return api.get(url.apiPath(site, '/main-graph'), query, params)
+ return api.get(url.apiPath(site, '/main-graph'), dashboardState, params)
}
export default function VisitorGraph({ updateImportedDataInView }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
- const isRealtime = query.period === 'realtime'
+ const isRealtime = dashboardState.period === 'realtime'
const topStatsBoundary = useRef(null)
@@ -54,16 +57,16 @@ export default function VisitorGraph({ updateImportedDataInView }) {
setGraphRefreshing(true)
fetchGraphData(getStoredMetric(), newInterval)
},
- [query]
+ [dashboardState]
)
const onMetricUpdate = useCallback(
(newMetric) => {
setGraphData(null)
setGraphRefreshing(true)
- fetchGraphData(newMetric, getCurrentInterval(site, query))
+ fetchGraphData(newMetric, getCurrentInterval(site, dashboardState))
},
- [query]
+ [dashboardState]
)
useEffect(() => {
@@ -80,7 +83,7 @@ export default function VisitorGraph({ updateImportedDataInView }) {
return () => {
document.removeEventListener('tick', fetchTopStatsAndGraphData)
}
- }, [query])
+ }, [dashboardState])
useEffect(() => {
if (topStatData) {
@@ -89,7 +92,7 @@ export default function VisitorGraph({ updateImportedDataInView }) {
}, [topStatData])
async function fetchTopStatsAndGraphData() {
- const response = await fetchTopStats(site, query)
+ const response = await fetchTopStats(site, dashboardState)
let metric = getStoredMetric()
const availableMetrics = response.graphable_metrics
@@ -99,7 +102,7 @@ export default function VisitorGraph({ updateImportedDataInView }) {
storage.setItem(`metric__${site.domain}`, metric)
}
- const interval = getCurrentInterval(site, query)
+ const interval = getCurrentInterval(site, dashboardState)
if (response.updateImportedDataInView) {
updateImportedDataInView(response.includes_imported)
@@ -112,7 +115,7 @@ export default function VisitorGraph({ updateImportedDataInView }) {
}
function fetchGraphData(metric, interval) {
- fetchMainGraph(site, query, metric, interval).then((res) => {
+ fetchMainGraph(site, dashboardState, metric, interval).then((res) => {
setGraphData(res)
setGraphLoading(false)
setGraphRefreshing(false)
@@ -151,10 +154,10 @@ export default function VisitorGraph({ updateImportedDataInView }) {
function getImportedIntervalUnsupportedNotice() {
const unsupportedInterval = ['hour', 'minute'].includes(
- getCurrentInterval(site, query)
+ getCurrentInterval(site, dashboardState)
)
const showingImported =
- importedSwitchVisible() && query.with_imported === true
+ importedSwitchVisible() && dashboardState.with_imported === true
if (showingImported && unsupportedInterval) {
return 'Interval is too short to graph imported data'
@@ -205,7 +208,7 @@ export default function VisitorGraph({ updateImportedDataInView }) {
<LineGraphWithRouter
graphData={{
...graphData,
- interval: getCurrentInterval(site, query)
+ interval: getCurrentInterval(site, dashboardState)
}}
/>
</div>
diff --git a/assets/js/dashboard/stats/graph/with-imported-switch.tsx b/assets/js/dashboard/stats/graph/with-imported-switch.tsx
index c5ef778e2f..b432c0b39f 100644
--- a/assets/js/dashboard/stats/graph/with-imported-switch.tsx
+++ b/assets/js/dashboard/stats/graph/with-imported-switch.tsx
@@ -1,7 +1,7 @@
import React from 'react'
import { BarsArrowUpIcon } from '@heroicons/react/20/solid'
import classNames from 'classnames'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { AppNavigationLink } from '../../navigation/use-app-navigate'
import { Tooltip } from '../../util/tooltip'
@@ -12,8 +12,8 @@ export default function WithImportedSwitch({
tooltipMessage: string
disabled?: boolean
}) {
- const { query } = useQueryContext()
- const importsSwitchedOn = query.with_imported
+ const { dashboardState } = useDashboardStateContext()
+ const importsSwitchedOn = dashboardState.with_imported
const iconClass = classNames('size-4', {
'dark:text-gray-300 text-gray-700': importsSwitchedOn,
diff --git a/assets/js/dashboard/stats/imported-query-unsupported-warning.js b/assets/js/dashboard/stats/imported-query-unsupported-warning.js
index 3f442fb459..f17719bc50 100644
--- a/assets/js/dashboard/stats/imported-query-unsupported-warning.js
+++ b/assets/js/dashboard/stats/imported-query-unsupported-warning.js
@@ -1,7 +1,7 @@
import React, { useRef, useEffect } from 'react'
import { ExclamationCircleIcon } from '@heroicons/react/24/outline'
import FadeIn from '../fade-in'
-import { useQueryContext } from '../query-context'
+import { useDashboardStateContext } from '../dashboard-state-context'
import { Tooltip } from '../util/tooltip'
export default function ImportedQueryUnsupportedWarning({
@@ -10,15 +10,15 @@ export default function ImportedQueryUnsupportedWarning({
altCondition,
message
}) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const portalRef = useRef(null)
const tooltipMessage =
message || 'Imported data is excluded due to applied filters'
const show =
- query &&
- query.with_imported &&
+ dashboardState &&
+ dashboardState.with_imported &&
skipImportedReason === 'unsupported_query' &&
- query.period !== 'realtime'
+ dashboardState.period !== 'realtime'
useEffect(() => {
if (typeof document !== 'undefined') {
diff --git a/assets/js/dashboard/stats/locations/index.js b/assets/js/dashboard/stats/locations/index.js
index 073b151809..7490b48ae0 100644
--- a/assets/js/dashboard/stats/locations/index.js
+++ b/assets/js/dashboard/stats/locations/index.js
@@ -13,7 +13,7 @@ import {
} from '../../util/filters'
import ImportedQueryUnsupportedWarning from '../imported-query-unsupported-warning'
import { citiesRoute, countriesRoute, regionsRoute } from '../../router'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { ReportLayout } from '../reports/report-layout'
import { ReportHeader } from '../reports/report-header'
@@ -21,9 +21,9 @@ import { TabButton, TabWrapper } from '../../components/tabs'
import MoreLink from '../more-link'
import { MoreLinkState } from '../more-link-state'
-function Countries({ query, site, onClick, afterFetchData }) {
+function Countries({ dashboardState, site, onClick, afterFetchData }) {
function fetchData() {
- return api.get(apiPath(site, '/countries'), query, { limit: 9 })
+ return api.get(apiPath(site, '/countries'), dashboardState, { limit: 9 })
}
function renderIcon(country) {
@@ -41,9 +41,9 @@ function Countries({ query, site, onClick, afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -61,9 +61,9 @@ function Countries({ query, site, onClick, afterFetchData }) {
)
}
-function Regions({ query, site, onClick, afterFetchData }) {
+function Regions({ dashboardState, site, onClick, afterFetchData }) {
function fetchData() {
- return api.get(apiPath(site, '/regions'), query, { limit: 9 })
+ return api.get(apiPath(site, '/regions'), dashboardState, { limit: 9 })
}
function renderIcon(region) {
@@ -81,9 +81,9 @@ function Regions({ query, site, onClick, afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -101,9 +101,9 @@ function Regions({ query, site, onClick, afterFetchData }) {
)
}
-function Cities({ query, site, afterFetchData }) {
+function Cities({ dashboardState, site, afterFetchData }) {
function fetchData() {
- return api.get(apiPath(site, '/cities'), query, { limit: 9 })
+ return api.get(apiPath(site, '/cities'), dashboardState, { limit: 9 })
}
function renderIcon(city) {
@@ -121,9 +121,9 @@ function Cities({ query, site, afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -159,8 +159,9 @@ class Locations extends React.Component {
componentDidUpdate(prevProps, prevState) {
const isRemovingFilter = (filterName) => {
return (
- getFiltersByKeyPrefix(prevProps.query, filterName).length > 0 &&
- getFiltersByKeyPrefix(this.props.query, filterName).length == 0
+ getFiltersByKeyPrefix(prevProps.dashboardState, filterName).length >
+ 0 &&
+ getFiltersByKeyPrefix(this.props.dashboardState, filterName).length == 0
)
}
@@ -173,7 +174,7 @@ class Locations extends React.Component {
}
if (
- this.props.query !== prevProps.query ||
+ this.props.dashboardState !== prevProps.dashboardState ||
this.state.mode !== prevState.mode
) {
this.setState({ loading: true, moreLinkState: MoreLinkState.LOADING })
@@ -219,7 +220,7 @@ class Locations extends React.Component {
return (
<Cities
site={this.props.site}
- query={this.props.query}
+ dashboardState={this.props.dashboardState}
afterFetchData={this.afterFetchData}
/>
)
@@ -228,7 +229,7 @@ class Locations extends React.Component {
<Regions
onClick={this.onRegionFilter}
site={this.props.site}
- query={this.props.query}
+ dashboardState={this.props.dashboardState}
afterFetchData={this.afterFetchData}
/>
)
@@ -237,7 +238,7 @@ class Locations extends React.Component {
<Countries
onClick={this.onCountryFilter('countries')}
site={this.props.site}
- query={this.props.query}
+ dashboardState={this.props.dashboardState}
afterFetchData={this.afterFetchData}
/>
)
@@ -306,8 +307,8 @@ class Locations extends React.Component {
}
function LocationsWithContext() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
- return <Locations site={site} query={query} />
+ return <Locations site={site} dashboardState={dashboardState} />
}
export default LocationsWithContext
diff --git a/assets/js/dashboard/stats/locations/map.tsx b/assets/js/dashboard/stats/locations/map.tsx
index 6b0d3d8fd6..33dd356aac 100644
--- a/assets/js/dashboard/stats/locations/map.tsx
+++ b/assets/js/dashboard/stats/locations/map.tsx
@@ -13,14 +13,14 @@ import { numberShortFormatter } from '../../util/number-formatter'
import * as topojson from 'topojson-client'
import { useQuery } from '@tanstack/react-query'
import { useSiteContext } from '../../site-context'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import worldJson from 'visionscarto-world-atlas/world/110m.json'
import { UIMode, useTheme } from '../../theme-context'
import { apiPath } from '../../util/url'
import { MIN_HEIGHT } from '../reports/list'
import { MapTooltip } from './map-tooltip'
import { GeolocationNotice } from './geolocation-notice'
-import { DashboardQuery } from '../../query'
+import { DashboardState } from '../../dashboard-state'
const width = 475
const height = 335
@@ -33,11 +33,11 @@ type CountryData = {
}
type WorldJsonCountryData = { properties: { name: string; a3: string } }
-function getMetricLabel(query: DashboardQuery) {
- if (hasConversionGoalFilter(query)) {
+function getMetricLabel(dashboardState: DashboardState) {
+ if (hasConversionGoalFilter(dashboardState)) {
return { singular: 'Conversion', plural: 'Conversions' }
}
- if (isRealTimeDashboard(query)) {
+ if (isRealTimeDashboard(dashboardState)) {
return { singular: 'Current visitor', plural: 'Current visitors' }
}
return { singular: 'Visitor', plural: 'Visitors' }
@@ -53,7 +53,7 @@ const WorldMap = ({
const navigate = useAppNavigate()
const { mode } = useTheme()
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const svgRef = useRef<SVGSVGElement | null>(null)
const [tooltip, setTooltip] = useState<{
x: number
@@ -61,15 +61,18 @@ const WorldMap = ({
hoveredCountryAlpha3Code: string | null
}>({ x: 0, y: 0, hoveredCountryAlpha3Code: null })
- const metricLabel = useMemo(() => getMetricLabel(query), [query])
+ const metricLabel = useMemo(
+ () => getMetricLabel(dashboardState),
+ [dashboardState]
+ )
const { data, refetch, isFetching, isError } = useQuery({
- queryKey: ['countries', 'map', query],
+ queryKey: ['countries', 'map', dashboardState],
placeholderData: (previousData) => previousData,
queryFn: async (): Promise<{
results: CountryData[]
}> => {
- return await api.get(apiPath(site, '/countries'), query, {
+ return await api.get(apiPath(site, '/countries'), dashboardState, {
limit: 300
})
}
@@ -77,13 +80,13 @@ const WorldMap = ({
useEffect(() => {
const onTickRefetchData = () => {
- if (query.period === 'realtime') {
+ if (dashboardState.period === 'realtime') {
refetch()
}
}
document.addEventListener('tick', onTickRefetchData)
return () => document.removeEventListener('tick', onTickRefetchData)
- }, [query.period, refetch])
+ }, [dashboardState.period, refetch])
useEffect(() => {
if (data) {
@@ -108,12 +111,12 @@ const WorldMap = ({
const country = dataByCountryCode.get(d.properties.a3)
const clickable = country && country.visitors
if (clickable) {
- const filters = replaceFilterByPrefix(query, 'country', [
+ const filters = replaceFilterByPrefix(dashboardState, 'country', [
'is',
'country',
[country.code]
])
- const labels = cleanLabels(filters, query.labels, 'country', {
+ const labels = cleanLabels(filters, dashboardState.labels, 'country', {
[country.code]: country.name
})
onCountrySelect()
@@ -122,7 +125,7 @@ const WorldMap = ({
})
}
},
- [navigate, query, dataByCountryCode, onCountrySelect]
+ [navigate, dashboardState, dataByCountryCode, onCountrySelect]
)
useEffect(() => {
diff --git a/assets/js/dashboard/stats/modals/breakdown-modal.tsx b/assets/js/dashboard/stats/modals/breakdown-modal.tsx
index f36a631d28..ea18a68177 100644
--- a/assets/js/dashboard/stats/modals/breakdown-modal.tsx
+++ b/assets/js/dashboard/stats/modals/breakdown-modal.tsx
@@ -1,6 +1,6 @@
import React, { useState, ReactNode, useMemo } from 'react'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { usePaginatedGetAPI } from '../../hooks/api-client'
import { rootRoute } from '../../router'
import {
@@ -12,7 +12,7 @@ import {
} from '../../hooks/use-order-by'
import { Metric } from '../reports/metrics'
import * as metricsModule from '../reports/metrics'
-import { BreakdownResultMeta, DashboardQuery } from '../../query'
+import { BreakdownResultMeta, DashboardState } from '../../dashboard-state'
import { ColumnConfiguraton } from '../../components/table'
import { BreakdownTable } from './breakdown-table'
import { useSiteContext } from '../../site-context'
@@ -34,8 +34,8 @@ export type ReportInfo = {
type BreakdownModalProps = {
/** Dimension and title of the breakdown. */
reportInfo: ReportInfo
- /** Function that must return a new query that contains appropriate search filter for searchValue param. */
- addSearchFilter?: (q: DashboardQuery, searchValue: string) => DashboardQuery
+ /** Function that must return a new dashboardState that contains appropriate search filter for searchValue param. */
+ addSearchFilter?: (q: DashboardState, searchValue: string) => DashboardState
searchEnabled?: boolean
/** When true, keep the percentage metric as a permanently visible, sortable column. */
showPercentageColumn?: boolean
@@ -47,7 +47,7 @@ type BreakdownModalProps = {
BreakdownModal is expected to be rendered inside a `<Modal>`, which has it's own
specific URL pathname (e.g. /plausible.io/sources). During the lifecycle of a
- BreakdownModal, the `query` object is not expected to change.
+ BreakdownModal, the `dashboardState` object is not expected to change.
### Search As You Type
@see BreakdownTable
@@ -73,16 +73,16 @@ export default function BreakdownModal<TListItem extends { name: string }>({
getFilterInfo
}: Omit<SharedReportProps<TListItem>, 'fetchData'> & BreakdownModalProps) {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const [meta, setMeta] = useState<BreakdownResultMeta | null>(null)
const breakdownMetrics = useMemo(() => {
const hasPercentage = metrics.some((m) => m.key === 'percentage')
- if (!hasPercentage && !hasConversionGoalFilter(query)) {
+ if (!hasPercentage && !hasConversionGoalFilter(dashboardState)) {
return [...metrics, metricsModule.createPercentage()]
}
return metrics
- }, [metrics, query])
+ }, [metrics, dashboardState])
const [search, setSearch] = useState('')
const defaultOrderBy = getStoredOrderBy({
@@ -102,24 +102,27 @@ export default function BreakdownModal<TListItem extends { name: string }>({
})
const apiState = usePaginatedGetAPI<
{ results: Array<TListItem>; meta: BreakdownResultMeta },
- [string, { query: DashboardQuery; search: string; orderBy: OrderBy }]
+ [
+ string,
+ { dashboardState: DashboardState; search: string; orderBy: OrderBy }
+ ]
>({
- key: [reportInfo.endpoint, { query, search, orderBy }],
+ key: [reportInfo.endpoint, { dashboardState, search, orderBy }],
getRequestParams: (key) => {
- const [_endpoint, { query, search }] = key
+ const [_endpoint, { dashboardState, search }] = key
- let queryWithSearchFilter = { ...query }
+ let dashboardStateWithSearchFilter = { ...dashboardState }
if (
searchEnabled &&
typeof addSearchFilter === 'function' &&
search !== ''
) {
- queryWithSearchFilter = addSearchFilter(query, search)
+ dashboardStateWithSearchFilter = addSearchFilter(dashboardState, search)
}
return [
- queryWithSearchFilter,
+ dashboardStateWithSearchFilter,
{
detailed: true,
order_by: JSON.stringify(orderBy)
@@ -153,7 +156,7 @@ export default function BreakdownModal<TListItem extends { name: string }>({
.filter((m) => showPercentageColumn || m.key !== 'percentage')
.map(
(m): ColumnConfiguraton<TListItem> => ({
- label: m.renderLabel(query),
+ label: m.renderLabel(dashboardState),
key: m.key,
width: m.width,
align: 'right',
@@ -175,7 +178,7 @@ export default function BreakdownModal<TListItem extends { name: string }>({
reportInfo.dimensionLabel,
breakdownMetrics,
getFilterInfo,
- query,
+ dashboardState,
orderByDictionary,
toggleSortByMetric,
renderIcon,
diff --git a/assets/js/dashboard/stats/modals/conversions.js b/assets/js/dashboard/stats/modals/conversions.js
index 32517c593e..92d6834f1b 100644
--- a/assets/js/dashboard/stats/modals/conversions.js
+++ b/assets/js/dashboard/stats/modals/conversions.js
@@ -5,7 +5,7 @@ import BreakdownModal from './breakdown-modal'
import * as metrics from '../reports/metrics'
import * as url from '../../util/url'
import { useSiteContext } from '../../site-context'
-import { addFilter } from '../../query'
+import { addFilter } from '../../dashboard-state'
/*global BUILD_EXTRA*/
function ConversionsModal() {
@@ -30,8 +30,8 @@ function ConversionsModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -43,8 +43,8 @@ function ConversionsModal() {
function chooseMetrics() {
return [
- metrics.createVisitors({ renderLabel: (_query) => 'Uniques' }),
- metrics.createEvents({ renderLabel: (_query) => 'Total' }),
+ metrics.createVisitors({ renderLabel: (_dashboardState) => 'Uniques' }),
+ metrics.createEvents({ renderLabel: (_dashboardState) => 'Total' }),
metrics.createConversionRate(),
showRevenue && metrics.createAverageRevenue(),
showRevenue && metrics.createTotalRevenue()
diff --git a/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js b/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js
index 841e05c99e..460a04aaca 100644
--- a/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js
+++ b/assets/js/dashboard/stats/modals/devices/browser-versions-modal.js
@@ -1,16 +1,16 @@
import React, { useCallback } from 'react'
import Modal from './../modal'
-import { addFilter } from '../../../query'
+import { addFilter } from '../../../dashboard-state'
import BreakdownModal from './../breakdown-modal'
import * as url from '../../../util/url'
-import { useQueryContext } from '../../../query-context'
+import { useDashboardStateContext } from '../../../dashboard-state-context'
import { useSiteContext } from '../../../site-context'
import { browserIconFor } from '../../devices'
import chooseMetrics from './choose-metrics'
import { SortDirection } from '../../../hooks/use-order-by'
function BrowserVersionsModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const reportInfo = {
@@ -32,8 +32,8 @@ function BrowserVersionsModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -52,7 +52,7 @@ function BrowserVersionsModal() {
<Modal>
<BreakdownModal
reportInfo={reportInfo}
- metrics={chooseMetrics(query, site)}
+ metrics={chooseMetrics(dashboardState, site)}
getFilterInfo={getFilterInfo}
addSearchFilter={addSearchFilter}
renderIcon={renderIcon}
diff --git a/assets/js/dashboard/stats/modals/devices/browsers-modal.js b/assets/js/dashboard/stats/modals/devices/browsers-modal.js
index 0e007c3d2a..7cbc87d7dc 100644
--- a/assets/js/dashboard/stats/modals/devices/browsers-modal.js
+++ b/assets/js/dashboard/stats/modals/devices/browsers-modal.js
@@ -1,16 +1,16 @@
import React, { useCallback } from 'react'
import Modal from './../modal'
-import { addFilter } from '../../../query'
+import { addFilter } from '../../../dashboard-state'
import BreakdownModal from './../breakdown-modal'
import * as url from '../../../util/url'
-import { useQueryContext } from '../../../query-context'
+import { useDashboardStateContext } from '../../../dashboard-state-context'
import { useSiteContext } from '../../../site-context'
import { browserIconFor } from '../../devices'
import chooseMetrics from './choose-metrics'
import { SortDirection } from '../../../hooks/use-order-by'
function BrowsersModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const reportInfo = {
@@ -32,8 +32,8 @@ function BrowsersModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -52,7 +52,7 @@ function BrowsersModal() {
<Modal>
<BreakdownModal
reportInfo={reportInfo}
- metrics={chooseMetrics(query, site)}
+ metrics={chooseMetrics(dashboardState, site)}
getFilterInfo={getFilterInfo}
addSearchFilter={addSearchFilter}
renderIcon={renderIcon}
diff --git a/assets/js/dashboard/stats/modals/devices/choose-metrics.js b/assets/js/dashboard/stats/modals/devices/choose-metrics.js
index 34959eddcb..d50696298b 100644
--- a/assets/js/dashboard/stats/modals/devices/choose-metrics.js
+++ b/assets/js/dashboard/stats/modals/devices/choose-metrics.js
@@ -2,18 +2,19 @@ import {
hasConversionGoalFilter,
isRealTimeDashboard
} from '../../../util/filters'
-import { revenueAvailable } from '../../../query'
+import { revenueAvailable } from '../../../dashboard-state'
import * as metrics from '../../reports/metrics'
-export default function chooseMetrics(query, site) {
+export default function chooseMetrics(dashboardState, site) {
/*global BUILD_EXTRA*/
- const showRevenueMetrics = BUILD_EXTRA && revenueAvailable(query, site)
+ const showRevenueMetrics =
+ BUILD_EXTRA && revenueAvailable(dashboardState, site)
- if (hasConversionGoalFilter(query)) {
+ if (hasConversionGoalFilter(dashboardState)) {
return [
metrics.createTotalVisitors(),
metrics.createVisitors({
- renderLabel: (_query) => 'Conversions',
+ renderLabel: (_dashboardState) => 'Conversions',
width: 'w-32 md:w-28'
}),
metrics.createConversionRate(),
@@ -22,10 +23,13 @@ export default function chooseMetrics(query, site) {
].filter((metric) => !!metric)
}
- if (isRealTimeDashboard(query) && !hasConversionGoalFilter(query)) {
+ if (
+ isRealTimeDashboard(dashboardState) &&
+ !hasConversionGoalFilter(dashboardState)
+ ) {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Current visitors',
+ renderLabel: (_dashboardState) => 'Current visitors',
width: 'w-32'
}),
metrics.createPercentage()
@@ -33,7 +37,7 @@ export default function chooseMetrics(query, site) {
}
return [
- metrics.createVisitors({ renderLabel: (_query) => 'Visitors' }),
+ metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),
metrics.createPercentage(),
metrics.createBounceRate(),
metrics.createVisitDuration()
diff --git a/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js b/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js
index cb90d04b1a..ca3ae19193 100644
--- a/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js
+++ b/assets/js/dashboard/stats/modals/devices/operating-system-versions-modal.js
@@ -1,16 +1,16 @@
import React, { useCallback } from 'react'
import Modal from './../modal'
-import { addFilter } from '../../../query'
+import { addFilter } from '../../../dashboard-state'
import BreakdownModal from './../breakdown-modal'
import * as url from '../../../util/url'
-import { useQueryContext } from '../../../query-context'
+import { useDashboardStateContext } from '../../../dashboard-state-context'
import { useSiteContext } from '../../../site-context'
import { osIconFor } from '../../devices'
import chooseMetrics from './choose-metrics'
import { SortDirection } from '../../../hooks/use-order-by'
function OperatingSystemVersionsModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const reportInfo = {
@@ -32,8 +32,8 @@ function OperatingSystemVersionsModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -49,7 +49,7 @@ function OperatingSystemVersionsModal() {
<Modal>
<BreakdownModal
reportInfo={reportInfo}
- metrics={chooseMetrics(query, site)}
+ metrics={chooseMetrics(dashboardState, site)}
getFilterInfo={getFilterInfo}
addSearchFilter={addSearchFilter}
renderIcon={renderIcon}
diff --git a/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js b/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js
index db80525a0c..d5f36b2f81 100644
--- a/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js
+++ b/assets/js/dashboard/stats/modals/devices/operating-systems-modal.js
@@ -1,16 +1,16 @@
import React, { useCallback } from 'react'
import Modal from './../modal'
-import { addFilter } from '../../../query'
+import { addFilter } from '../../../dashboard-state'
import BreakdownModal from './../breakdown-modal'
import * as url from '../../../util/url'
-import { useQueryContext } from '../../../query-context'
+import { useDashboardStateContext } from '../../../dashboard-state-context'
import { useSiteContext } from '../../../site-context'
import { osIconFor } from '../../devices'
import chooseMetrics from './choose-metrics'
import { SortDirection } from '../../../hooks/use-order-by'
function OperatingSystemsModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const reportInfo = {
@@ -32,8 +32,8 @@ function OperatingSystemsModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -49,7 +49,7 @@ function OperatingSystemsModal() {
<Modal>
<BreakdownModal
reportInfo={reportInfo}
- metrics={chooseMetrics(query, site)}
+ metrics={chooseMetrics(dashboardState, site)}
getFilterInfo={getFilterInfo}
addSearchFilter={addSearchFilter}
renderIcon={renderIcon}
diff --git a/assets/js/dashboard/stats/modals/devices/screen-sizes.js b/assets/js/dashboard/stats/modals/devices/screen-sizes.js
index 637ea4bcfd..79c3f5da6d 100644
--- a/assets/js/dashboard/stats/modals/devices/screen-sizes.js
+++ b/assets/js/dashboard/stats/modals/devices/screen-sizes.js
@@ -2,14 +2,14 @@ import React, { useCallback } from 'react'
import Modal from './../modal'
import BreakdownModal from './../breakdown-modal'
import * as url from '../../../util/url'
-import { useQueryContext } from '../../../query-context'
+import { useDashboardStateContext } from '../../../dashboard-state-context'
import { useSiteContext } from '../../../site-context'
import { screenSizeIconFor } from '../../devices'
import chooseMetrics from './choose-metrics'
import { SortDirection } from '../../../hooks/use-order-by'
function ScreenSizesModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const reportInfo = {
@@ -39,7 +39,7 @@ function ScreenSizesModal() {
<Modal>
<BreakdownModal
reportInfo={reportInfo}
- metrics={chooseMetrics(query, site)}
+ metrics={chooseMetrics(dashboardState, site)}
getFilterInfo={getFilterInfo}
searchEnabled={false}
renderIcon={renderIcon}
diff --git a/assets/js/dashboard/stats/modals/entry-pages.js b/assets/js/dashboard/stats/modals/entry-pages.js
index 51840cd36e..a443248ca9 100644
--- a/assets/js/dashboard/stats/modals/entry-pages.js
+++ b/assets/js/dashboard/stats/modals/entry-pages.js
@@ -4,20 +4,21 @@ import {
hasConversionGoalFilter,
isRealTimeDashboard
} from '../../util/filters'
-import { addFilter, revenueAvailable } from '../../query'
+import { addFilter, revenueAvailable } from '../../dashboard-state'
import BreakdownModal from './breakdown-modal'
import * as metrics from '../reports/metrics'
import * as url from '../../util/url'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { SortDirection } from '../../hooks/use-order-by'
function EntryPagesModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
/*global BUILD_EXTRA*/
- const showRevenueMetrics = BUILD_EXTRA && revenueAvailable(query, site)
+ const showRevenueMetrics =
+ BUILD_EXTRA && revenueAvailable(dashboardState, site)
const reportInfo = {
title: 'Entry pages',
@@ -38,8 +39,8 @@ function EntryPagesModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -50,11 +51,11 @@ function EntryPagesModal() {
)
function chooseMetrics() {
- if (hasConversionGoalFilter(query)) {
+ if (hasConversionGoalFilter(dashboardState)) {
return [
metrics.createTotalVisitors(),
metrics.createVisitors({
- renderLabel: (_query) => 'Conversions',
+ renderLabel: (_dashboardState) => 'Conversions',
width: 'w-28'
}),
metrics.createConversionRate(),
@@ -63,19 +64,22 @@ function EntryPagesModal() {
].filter((metric) => !!metric)
}
- if (isRealTimeDashboard(query) && !hasConversionGoalFilter(query)) {
+ if (
+ isRealTimeDashboard(dashboardState) &&
+ !hasConversionGoalFilter(dashboardState)
+ ) {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Current visitors',
+ renderLabel: (_dashboardState) => 'Current visitors',
width: 'w-32'
})
]
}
return [
- metrics.createVisitors({ renderLabel: (_query) => 'Visitors' }),
+ metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),
metrics.createVisits({
- renderLabel: (_query) => 'Total entrances',
+ renderLabel: (_dashboardState) => 'Total entrances',
width: 'w-32'
}),
metrics.createBounceRate(),
diff --git a/assets/js/dashboard/stats/modals/exit-pages.js b/assets/js/dashboard/stats/modals/exit-pages.js
index 0cb072a764..84a5b6f59b 100644
--- a/assets/js/dashboard/stats/modals/exit-pages.js
+++ b/assets/js/dashboard/stats/modals/exit-pages.js
@@ -4,20 +4,21 @@ import {
hasConversionGoalFilter,
isRealTimeDashboard
} from '../../util/filters'
-import { addFilter, revenueAvailable } from '../../query'
+import { addFilter, revenueAvailable } from '../../dashboard-state'
import BreakdownModal from './breakdown-modal'
import * as metrics from '../reports/metrics'
import * as url from '../../util/url'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { SortDirection } from '../../hooks/use-order-by'
function ExitPagesModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
/*global BUILD_EXTRA*/
- const showRevenueMetrics = BUILD_EXTRA && revenueAvailable(query, site)
+ const showRevenueMetrics =
+ BUILD_EXTRA && revenueAvailable(dashboardState, site)
const reportInfo = {
title: 'Exit pages',
@@ -38,8 +39,8 @@ function ExitPagesModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -50,11 +51,11 @@ function ExitPagesModal() {
)
function chooseMetrics() {
- if (hasConversionGoalFilter(query)) {
+ if (hasConversionGoalFilter(dashboardState)) {
return [
metrics.createTotalVisitors(),
metrics.createVisitors({
- renderLabel: (_query) => 'Conversions',
+ renderLabel: (_dashboardState) => 'Conversions',
width: 'w-28'
}),
metrics.createConversionRate(),
@@ -63,10 +64,13 @@ function ExitPagesModal() {
].filter((metric) => !!metric)
}
- if (isRealTimeDashboard(query) && !hasConversionGoalFilter(query)) {
+ if (
+ isRealTimeDashboard(dashboardState) &&
+ !hasConversionGoalFilter(dashboardState)
+ ) {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Current visitors',
+ renderLabel: (_dashboardState) => 'Current visitors',
width: 'w-32'
})
]
@@ -74,11 +78,11 @@ function ExitPagesModal() {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Visitors',
+ renderLabel: (_dashboardState) => 'Visitors',
sortable: true
}),
metrics.createVisits({
- renderLabel: (_query) => 'Total exits',
+ renderLabel: (_dashboardState) => 'Total exits',
width: 'w-32',
sortable: true
}),
diff --git a/assets/js/dashboard/stats/modals/filter-modal-props-row.js b/assets/js/dashboard/stats/modals/filter-modal-props-row.js
index 18666aa337..96e6195abc 100644
--- a/assets/js/dashboard/stats/modals/filter-modal-props-row.js
+++ b/assets/js/dashboard/stats/modals/filter-modal-props-row.js
@@ -12,7 +12,7 @@ import {
getPropertyKeyFromFilterKey,
isFreeChoiceFilterOperation
} from '../../util/filters'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
export default function FilterModalPropsRow({
@@ -22,7 +22,7 @@ export default function FilterModalPropsRow({
onUpdate,
onDelete
}) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const [operation, filterKey, clauses] = filter
@@ -39,7 +39,7 @@ export default function FilterModalPropsRow({
function fetchPropKeyOptions(input) {
return fetchSuggestions(
apiPath(site, `/suggestions/prop_key`),
- query,
+ dashboardState,
input
)
}
@@ -58,7 +58,7 @@ export default function FilterModalPropsRow({
site,
`/suggestions/custom-prop-values/${encodeURIComponent(propKey)}`
),
- query,
+ dashboardState,
input,
[FILTER_OPERATIONS.isNot, filterKey, ['(none)']]
)
diff --git a/assets/js/dashboard/stats/modals/filter-modal-row.js b/assets/js/dashboard/stats/modals/filter-modal-row.js
index 2914b151f4..e69adf2748 100644
--- a/assets/js/dashboard/stats/modals/filter-modal-row.js
+++ b/assets/js/dashboard/stats/modals/filter-modal-row.js
@@ -13,7 +13,7 @@ import {
formattedFilters
} from '../../util/filters'
import { apiPath } from '../../util/url'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
export default function FilterModalRow({
@@ -24,7 +24,7 @@ export default function FilterModalRow({
onUpdate,
onDelete
}) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const [operation, filterKey, clauses] = filter
@@ -64,7 +64,7 @@ export default function FilterModalRow({
return fetchSuggestions(
apiPath(site, `/suggestions/${filterKey}`),
- query,
+ dashboardState,
input,
additionalFilter
)
diff --git a/assets/js/dashboard/stats/modals/filter-modal.js b/assets/js/dashboard/stats/modals/filter-modal.js
index 71d6c8a495..115d47f918 100644
--- a/assets/js/dashboard/stats/modals/filter-modal.js
+++ b/assets/js/dashboard/stats/modals/filter-modal.js
@@ -13,7 +13,7 @@ import {
cleanLabels,
getAvailableFilterModals
} from '../../util/filters'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { isModifierPressed, isTyping } from '../../keybinding'
import FilterModalGroup from './filter-modal-group'
@@ -62,18 +62,18 @@ class FilterModal extends React.Component {
const modalType = this.props.modalType
- const query = this.props.query
+ const dashboardState = this.props.dashboardState
const { filterState, otherFilters, hasRelevantFilters } = partitionFilters(
modalType,
- query.filters
+ dashboardState.filters
)
this.handleKeydown = this.handleKeydown.bind(this)
this.closeModal = this.closeModal.bind(this)
this.state = {
- query,
+ dashboardState,
filterState,
- labelState: query.labels,
+ labelState: dashboardState.labels,
otherFilters,
hasRelevantFilters
}
@@ -139,7 +139,7 @@ class FilterModal extends React.Component {
},
labelState: cleanLabels(
Object.values(this.state.filterState).concat(
- this.state.query.filters
+ this.state.dashboardState.filters
),
prevState.labelState,
filterKey,
@@ -244,14 +244,14 @@ class FilterModal extends React.Component {
export default function FilterModalWithRouter(props) {
const navigate = useAppNavigate()
const { field } = useParams()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
if (!Object.keys(getAvailableFilterModals(site)).includes(field)) {
return null
}
const appliedSegmentFilter =
field === 'segment'
- ? findAppliedSegmentFilter({ filters: query.filters })
+ ? findAppliedSegmentFilter({ filters: dashboardState.filters })
: null
if (appliedSegmentFilter) {
const [_operation, _dimension, [segmentId]] = appliedSegmentFilter
@@ -261,7 +261,7 @@ export default function FilterModalWithRouter(props) {
<FilterModal
{...props}
modalType={field || 'page'}
- query={query}
+ dashboardState={dashboardState}
navigate={navigate}
site={site}
/>
diff --git a/assets/js/dashboard/stats/modals/google-keywords.tsx b/assets/js/dashboard/stats/modals/google-keywords.tsx
index 01bd2c65fc..d2e8937893 100644
--- a/assets/js/dashboard/stats/modals/google-keywords.tsx
+++ b/assets/js/dashboard/stats/modals/google-keywords.tsx
@@ -1,7 +1,7 @@
import React, { useMemo, useState } from 'react'
import Modal from './modal'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { usePaginatedGetAPI } from '../../hooks/api-client'
import { createVisitors, Metric } from '../reports/metrics'
@@ -10,7 +10,7 @@ import {
percentageFormatter
} from '../../util/number-formatter'
import { apiPath } from '../../util/url'
-import { DashboardQuery } from '../../query'
+import { DashboardState } from '../../dashboard-state'
import { ColumnConfiguraton } from '../../components/table'
import { BreakdownTable } from './breakdown-table'
@@ -48,7 +48,7 @@ const metrics = [
]
function GoogleKeywordsModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const endpoint = apiPath(site, '/referrers/Google')
@@ -56,14 +56,14 @@ function GoogleKeywordsModal() {
const apiState = usePaginatedGetAPI<
{ results: GoogleKeywordItem[] },
- [string, { query: DashboardQuery; search: string }]
+ [string, { dashboardState: DashboardState; search: string }]
>({
- key: [endpoint, { query, search }],
+ key: [endpoint, { dashboardState, search }],
getRequestParams: (key) => {
- const [_endpoint, { query, search }] = key
+ const [_endpoint, { dashboardState, search }] = key
const params = { detailed: true }
- return [query, search === '' ? params : { ...params, search }]
+ return [dashboardState, search === '' ? params : { ...params, search }]
},
initialPageParam: 0
})
@@ -78,14 +78,14 @@ function GoogleKeywordsModal() {
},
...metrics.map(
(m): ColumnConfiguraton<GoogleKeywordItem> => ({
- label: m.renderLabel(query),
+ label: m.renderLabel(dashboardState),
key: m.key,
width: m.width,
align: 'right'
})
)
],
- [query]
+ [dashboardState]
)
return (
diff --git a/assets/js/dashboard/stats/modals/locations-modal.js b/assets/js/dashboard/stats/modals/locations-modal.js
index c4f313ac58..ec3a5c5548 100644
--- a/assets/js/dashboard/stats/modals/locations-modal.js
+++ b/assets/js/dashboard/stats/modals/locations-modal.js
@@ -8,9 +8,9 @@ import {
import BreakdownModal from './breakdown-modal'
import * as metrics from '../reports/metrics'
import * as url from '../../util/url'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
-import { addFilter, revenueAvailable } from '../../query'
+import { addFilter, revenueAvailable } from '../../dashboard-state'
import { SortDirection } from '../../hooks/use-order-by'
const VIEWS = {
@@ -38,11 +38,12 @@ const VIEWS = {
}
function LocationsModal({ currentView }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
/*global BUILD_EXTRA*/
- const showRevenueMetrics = BUILD_EXTRA && revenueAvailable(query, site)
+ const showRevenueMetrics =
+ BUILD_EXTRA && revenueAvailable(dashboardState, site)
let reportInfo = VIEWS[currentView]
reportInfo = {
@@ -62,8 +63,8 @@ function LocationsModal({ currentView }) {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
`${reportInfo.dimension}_name`,
[searchString],
@@ -74,11 +75,11 @@ function LocationsModal({ currentView }) {
)
function chooseMetrics() {
- if (hasConversionGoalFilter(query)) {
+ if (hasConversionGoalFilter(dashboardState)) {
return [
metrics.createTotalVisitors(),
metrics.createVisitors({
- renderLabel: (_query) => 'Conversions',
+ renderLabel: (_dashboardState) => 'Conversions',
width: 'w-28'
}),
metrics.createConversionRate(),
@@ -87,17 +88,20 @@ function LocationsModal({ currentView }) {
].filter((metric) => !!metric)
}
- if (isRealTimeDashboard(query) && !hasConversionGoalFilter(query)) {
+ if (
+ isRealTimeDashboard(dashboardState) &&
+ !hasConversionGoalFilter(dashboardState)
+ ) {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Current visitors',
+ renderLabel: (_dashboardState) => 'Current visitors',
width: 'w-32'
})
]
}
return [
- metrics.createVisitors({ renderLabel: (_query) => 'Visitors' }),
+ metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),
currentView === 'countries' && metrics.createPercentage()
].filter((metric) => !!metric)
}
diff --git a/assets/js/dashboard/stats/modals/pages.js b/assets/js/dashboard/stats/modals/pages.js
index 3445480abf..b93ab5869e 100644
--- a/assets/js/dashboard/stats/modals/pages.js
+++ b/assets/js/dashboard/stats/modals/pages.js
@@ -4,20 +4,21 @@ import {
hasConversionGoalFilter,
isRealTimeDashboard
} from '../../util/filters'
-import { addFilter, revenueAvailable } from '../../query'
+import { addFilter, revenueAvailable } from '../../dashboard-state'
import BreakdownModal from './breakdown-modal'
import * as metrics from '../reports/metrics'
import * as url from '../../util/url'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { SortDirection } from '../../hooks/use-order-by'
function PagesModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
/*global BUILD_EXTRA*/
- const showRevenueMetrics = BUILD_EXTRA && revenueAvailable(query, site)
+ const showRevenueMetrics =
+ BUILD_EXTRA && revenueAvailable(dashboardState, site)
const reportInfo = {
title: 'Top pages',
@@ -38,8 +39,8 @@ function PagesModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -50,11 +51,11 @@ function PagesModal() {
)
function chooseMetrics() {
- if (hasConversionGoalFilter(query)) {
+ if (hasConversionGoalFilter(dashboardState)) {
return [
metrics.createTotalVisitors(),
metrics.createVisitors({
- renderLabel: (_query) => 'Conversions',
+ renderLabel: (_dashboardState) => 'Conversions',
width: 'w-28'
}),
metrics.createConversionRate(),
@@ -63,17 +64,20 @@ function PagesModal() {
].filter((metric) => !!metric)
}
- if (isRealTimeDashboard(query) && !hasConversionGoalFilter(query)) {
+ if (
+ isRealTimeDashboard(dashboardState) &&
+ !hasConversionGoalFilter(dashboardState)
+ ) {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Current visitors',
+ renderLabel: (_dashboardState) => 'Current visitors',
width: 'w-32'
})
]
}
return [
- metrics.createVisitors({ renderLabel: (_query) => 'Visitors' }),
+ metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),
metrics.createPageviews(),
metrics.createBounceRate(),
metrics.createTimeOnPage(),
diff --git a/assets/js/dashboard/stats/modals/props.js b/assets/js/dashboard/stats/modals/props.js
index 452506f46c..8dcc8e6e0b 100644
--- a/assets/js/dashboard/stats/modals/props.js
+++ b/assets/js/dashboard/stats/modals/props.js
@@ -2,7 +2,7 @@ import React, { useCallback } from 'react'
import { useParams } from 'react-router-dom'
import Modal from './modal'
-import { addFilter, revenueAvailable } from '../../query'
+import { addFilter, revenueAvailable } from '../../dashboard-state'
import { getSpecialGoal } from '../../util/goals'
import {
EVENT_PROPS_PREFIX,
@@ -12,19 +12,20 @@ import {
import BreakdownModal from './breakdown-modal'
import * as metrics from '../reports/metrics'
import * as url from '../../util/url'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { SortDirection } from '../../hooks/use-order-by'
function PropsModal() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const { propKey } = useParams()
/*global BUILD_EXTRA*/
- const showRevenueMetrics = BUILD_EXTRA && revenueAvailable(query, site)
+ const showRevenueMetrics =
+ BUILD_EXTRA && revenueAvailable(dashboardState, site)
- const goalFilter = getGoalFilter(query)
+ const goalFilter = getGoalFilter(dashboardState)
const specialGoal = goalFilter ? getSpecialGoal(goalFilter) : null
const reportInfo = {
@@ -49,8 +50,8 @@ function PropsModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
`${EVENT_PROPS_PREFIX}${propKey}`,
[searchString],
@@ -62,10 +63,10 @@ function PropsModal() {
function chooseMetrics() {
return [
- metrics.createVisitors({ renderLabel: (_query) => 'Visitors' }),
- metrics.createEvents({ renderLabel: (_query) => 'Events' }),
- hasConversionGoalFilter(query) && metrics.createConversionRate(),
- !hasConversionGoalFilter(query) && metrics.createPercentage(),
+ metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),
+ metrics.createEvents({ renderLabel: (_dashboardState) => 'Events' }),
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate(),
+ !hasConversionGoalFilter(dashboardState) && metrics.createPercentage(),
showRevenueMetrics && metrics.createAverageRevenue(),
showRevenueMetrics && metrics.createTotalRevenue()
].filter((metric) => !!metric)
diff --git a/assets/js/dashboard/stats/modals/referrer-drilldown.js b/assets/js/dashboard/stats/modals/referrer-drilldown.js
index 21b1b9bf38..9a9037dddb 100644
--- a/assets/js/dashboard/stats/modals/referrer-drilldown.js
+++ b/assets/js/dashboard/stats/modals/referrer-drilldown.js
@@ -9,19 +9,20 @@ import {
import BreakdownModal from './breakdown-modal'
import * as metrics from '../reports/metrics'
import * as url from '../../util/url'
-import { addFilter, revenueAvailable } from '../../query'
-import { useQueryContext } from '../../query-context'
+import { addFilter, revenueAvailable } from '../../dashboard-state'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { SortDirection } from '../../hooks/use-order-by'
import { SourceFavicon } from '../sources/source-favicon'
function ReferrerDrilldownModal() {
const { referrer } = useParams()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
/*global BUILD_EXTRA*/
- const showRevenueMetrics = BUILD_EXTRA && revenueAvailable(query, site)
+ const showRevenueMetrics =
+ BUILD_EXTRA && revenueAvailable(dashboardState, site)
const reportInfo = {
title: 'Referrer Drilldown',
@@ -45,8 +46,8 @@ function ReferrerDrilldownModal() {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -57,11 +58,11 @@ function ReferrerDrilldownModal() {
)
function chooseMetrics() {
- if (hasConversionGoalFilter(query)) {
+ if (hasConversionGoalFilter(dashboardState)) {
return [
metrics.createTotalVisitors(),
metrics.createVisitors({
- renderLabel: (_query) => 'Conversions',
+ renderLabel: (_dashboardState) => 'Conversions',
width: 'w-28'
}),
metrics.createConversionRate(),
@@ -70,17 +71,20 @@ function ReferrerDrilldownModal() {
].filter((metric) => !!metric)
}
- if (isRealTimeDashboard(query) && !hasConversionGoalFilter(query)) {
+ if (
+ isRealTimeDashboard(dashboardState) &&
+ !hasConversionGoalFilter(dashboardState)
+ ) {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Current visitors',
+ renderLabel: (_dashboardState) => 'Current visitors',
width: 'w-32'
})
]
}
return [
- metrics.createVisitors({ renderLabel: (_query) => 'Visitors' }),
+ metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),
metrics.createBounceRate(),
metrics.createVisitDuration()
]
diff --git a/assets/js/dashboard/stats/modals/sources.js b/assets/js/dashboard/stats/modals/sources.js
index 383c4937a3..b52b8e20e2 100644
--- a/assets/js/dashboard/stats/modals/sources.js
+++ b/assets/js/dashboard/stats/modals/sources.js
@@ -7,8 +7,8 @@ import {
import BreakdownModal from './breakdown-modal'
import * as metrics from '../reports/metrics'
import * as url from '../../util/url'
-import { addFilter, revenueAvailable } from '../../query'
-import { useQueryContext } from '../../query-context'
+import { addFilter, revenueAvailable } from '../../dashboard-state'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { SortDirection } from '../../hooks/use-order-by'
import { SourceFavicon } from '../sources/source-favicon'
@@ -88,11 +88,12 @@ const VIEWS = {
}
function SourcesModal({ currentView }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
/*global BUILD_EXTRA*/
- const showRevenueMetrics = BUILD_EXTRA && revenueAvailable(query, site)
+ const showRevenueMetrics =
+ BUILD_EXTRA && revenueAvailable(dashboardState, site)
let reportInfo = VIEWS[currentView].info
reportInfo = {
@@ -111,8 +112,8 @@ function SourcesModal({ currentView }) {
)
const addSearchFilter = useCallback(
- (query, searchString) => {
- return addFilter(query, [
+ (dashboardState, searchString) => {
+ return addFilter(dashboardState, [
'contains',
reportInfo.dimension,
[searchString],
@@ -123,11 +124,11 @@ function SourcesModal({ currentView }) {
)
function chooseMetrics() {
- if (hasConversionGoalFilter(query)) {
+ if (hasConversionGoalFilter(dashboardState)) {
return [
metrics.createTotalVisitors(),
metrics.createVisitors({
- renderLabel: (_query) => 'Conversions',
+ renderLabel: (_dashboardState) => 'Conversions',
width: 'w-28'
}),
metrics.createConversionRate(),
@@ -136,17 +137,20 @@ function SourcesModal({ currentView }) {
].filter((metric) => !!metric)
}
- if (isRealTimeDashboard(query) && !hasConversionGoalFilter(query)) {
+ if (
+ isRealTimeDashboard(dashboardState) &&
+ !hasConversionGoalFilter(dashboardState)
+ ) {
return [
metrics.createVisitors({
- renderLabel: (_query) => 'Current visitors',
+ renderLabel: (_dashboardState) => 'Current visitors',
width: 'w-32'
})
]
}
return [
- metrics.createVisitors({ renderLabel: (_query) => 'Visitors' }),
+ metrics.createVisitors({ renderLabel: (_dashboardState) => 'Visitors' }),
metrics.createBounceRate(),
metrics.createVisitDuration()
]
diff --git a/assets/js/dashboard/stats/pages/index.js b/assets/js/dashboard/stats/pages/index.js
index 30650a2d51..d8e38b82cd 100644
--- a/assets/js/dashboard/stats/pages/index.js
+++ b/assets/js/dashboard/stats/pages/index.js
@@ -7,7 +7,7 @@ import ListReport from './../reports/list'
import * as metrics from './../reports/metrics'
import ImportedQueryUnsupportedWarning from '../imported-query-unsupported-warning'
import { hasConversionGoalFilter } from '../../util/filters'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { entryPagesRoute, exitPagesRoute, topPagesRoute } from '../../router'
import { ReportLayout } from '../reports/report-layout'
@@ -17,10 +17,12 @@ import MoreLink from '../more-link'
import { MoreLinkState } from '../more-link-state'
function EntryPages({ afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
function fetchData() {
- return api.get(url.apiPath(site, '/entry-pages'), query, { limit: 9 })
+ return api.get(url.apiPath(site, '/entry-pages'), dashboardState, {
+ limit: 9
+ })
}
function getExternalLinkUrl(page) {
@@ -41,9 +43,9 @@ function EntryPages({ afterFetchData }) {
width: 'w-36',
meta: { plot: true }
}),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -62,9 +64,11 @@ function EntryPages({ afterFetchData }) {
function ExitPages({ afterFetchData }) {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
function fetchData() {
- return api.get(url.apiPath(site, '/exit-pages'), query, { limit: 9 })
+ return api.get(url.apiPath(site, '/exit-pages'), dashboardState, {
+ limit: 9
+ })
}
function getExternalLinkUrl(page) {
@@ -85,9 +89,9 @@ function ExitPages({ afterFetchData }) {
width: 'w-36',
meta: { plot: true }
}),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -105,10 +109,10 @@ function ExitPages({ afterFetchData }) {
}
function TopPages({ afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
function fetchData() {
- return api.get(url.apiPath(site, '/pages'), query, { limit: 9 })
+ return api.get(url.apiPath(site, '/pages'), dashboardState, { limit: 9 })
}
function getExternalLinkUrl(page) {
@@ -125,9 +129,9 @@ function TopPages({ afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -145,7 +149,7 @@ function TopPages({ afterFetchData }) {
}
export default function Pages() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const tabKey = `pageTab__${site.domain}`
@@ -173,7 +177,7 @@ export default function Pages() {
useEffect(() => {
setLoading(true)
setMoreLinkState(MoreLinkState.LOADING)
- }, [query, mode])
+ }, [dashboardState, mode])
function moreLinkProps() {
switch (mode) {
@@ -215,7 +219,7 @@ export default function Pages() {
<TabWrapper>
{[
{
- label: hasConversionGoalFilter(query)
+ label: hasConversionGoalFilter(dashboardState)
? 'Conversion pages'
: 'Top pages',
value: 'pages'
diff --git a/assets/js/dashboard/stats/reports/list.tsx b/assets/js/dashboard/stats/reports/list.tsx
index 79cf70cddb..f3ed82437e 100644
--- a/assets/js/dashboard/stats/reports/list.tsx
+++ b/assets/js/dashboard/stats/reports/list.tsx
@@ -9,10 +9,10 @@ import {
isRealTimeDashboard,
hasConversionGoalFilter
} from '../../util/filters'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { Metric } from './metrics'
import { DrilldownLink, FilterInfo } from '../../components/drilldown-link'
-import { BreakdownResultMeta } from '../../query'
+import { BreakdownResultMeta } from '../../dashboard-state'
const MAX_ITEMS = 9
export const MIN_HEIGHT = 356
@@ -99,10 +99,10 @@ type ListReportProps = {
/**
* @returns {HTMLElement} Table of metrics, in the following format:
- * | keyLabel | METRIC_1.renderLabel(query) | METRIC_2.renderLabel(query) | ...
- * |--------------------|-----------------------------|-----------------------------| ---
- * | LISTITEM_1.name | LISTITEM_1[METRIC_1.key] | LISTITEM_1[METRIC_2.key] | ...
- * | LISTITEM_2.name | LISTITEM_2[METRIC_1.key] | LISTITEM_2[METRIC_2.key] | ...
+ * | keyLabel | METRIC_1.renderLabel(dashboardState) | METRIC_2.renderLabel(dashboardState) | ...
+ * |--------------------|--------------------------------------|--------------------------------------| ---
+ * | LISTITEM_1.name | LISTITEM_1[METRIC_1.key] | LISTITEM_1[METRIC_2.key] | ...
+ * | LISTITEM_2.name | LISTITEM_2[METRIC_1.key] | LISTITEM_2[METRIC_2.key] | ...
*/
export default function ListReport<
TListItem extends Record<string, unknown> & { name: string }
@@ -118,7 +118,7 @@ export default function ListReport<
getExternalLinkUrl,
fetchData
}: Omit<SharedReportProps<TListItem>, 'afterFetchNextPage'> & ListReportProps) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const [state, setState] = useState<{
loading: boolean
list: TListItem[] | null
@@ -127,8 +127,8 @@ export default function ListReport<
const [visible, setVisible] = useState(false)
const [tappedRow, setTappedRow] = useState<string | null>(null)
- const isRealtime = isRealTimeDashboard(query)
- const goalFilterApplied = hasConversionGoalFilter(query)
+ const isRealtime = isRealTimeDashboard(dashboardState)
+ const goalFilterApplied = hasConversionGoalFilter(dashboardState)
const getData = useCallback(() => {
if (!isRealtime) {
@@ -142,7 +142,7 @@ export default function ListReport<
setState({ loading: false, list: response.results, meta: response.meta })
})
// eslint-disable-next-line react-hooks/exhaustive-deps
- }, [keyLabel, query])
+ }, [keyLabel, dashboardState])
const onVisible = () => {
setVisible(true)
@@ -170,7 +170,7 @@ export default function ListReport<
document.removeEventListener('tick', getData)
}
// eslint-disable-next-line react-hooks/exhaustive-deps
- }, [keyLabel, query, visible])
+ }, [keyLabel, dashboardState, visible])
// returns a filtered `metrics` list. Since currently, the backend can return different
// metrics based on filters and existing data, this function validates that the metrics
@@ -253,7 +253,7 @@ export default function ListReport<
className={`${metric.key} text-right ${hiddenOnMobileClass(metric)}`}
style={{ minWidth: colMinWidth }}
>
- {metric.renderLabel(query)}
+ {metric.renderLabel(dashboardState)}
</div>
)
})
diff --git a/assets/js/dashboard/stats/reports/metric-value.test.tsx b/assets/js/dashboard/stats/reports/metric-value.test.tsx
index 032be2863f..e18b91e907 100644
--- a/assets/js/dashboard/stats/reports/metric-value.test.tsx
+++ b/assets/js/dashboard/stats/reports/metric-value.test.tsx
@@ -223,7 +223,7 @@ function valueProps<T>(
date_range_label: '01 Aug - 31 Aug',
comparison_date_range_label: '01 July - 31 July'
},
- renderLabel: (_query: unknown) => metric.toUpperCase()
+ renderLabel: (_dashboardState: unknown) => metric.toUpperCase()
} as any /* eslint-disable-line @typescript-eslint/no-explicit-any */
}
diff --git a/assets/js/dashboard/stats/reports/metric-value.tsx b/assets/js/dashboard/stats/reports/metric-value.tsx
index ed70963509..820005bd70 100644
--- a/assets/js/dashboard/stats/reports/metric-value.tsx
+++ b/assets/js/dashboard/stats/reports/metric-value.tsx
@@ -7,8 +7,8 @@ import {
MetricFormatterShort,
ValueType
} from './metric-formatter'
-import { BreakdownResultMeta, DashboardQuery } from '../../query'
-import { useQueryContext } from '../../query-context'
+import { BreakdownResultMeta, DashboardState } from '../../dashboard-state'
+import { useDashboardStateContext } from '../../dashboard-state-context'
type MetricValues = Record<Metric, ValueType>
@@ -33,13 +33,13 @@ function valueRenderProps(listItem: ListItem, metric: Metric) {
export default function MetricValue(props: {
listItem: ListItem
metric: Metric
- renderLabel: (query: DashboardQuery) => string
+ renderLabel: (dashboardState: DashboardState) => string
formatter?: (value: ValueType) => string
meta: BreakdownResultMeta | null
detailedView?: boolean
isRowHovered?: boolean
}) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const portalRef = useRef<HTMLElement | null>(null)
useEffect(() => {
@@ -53,7 +53,10 @@ export default function MetricValue(props: {
() => valueRenderProps(listItem, metric),
[listItem, metric]
)
- const metricLabel = useMemo(() => props.renderLabel(query), [query, props])
+ const metricLabel = useMemo(
+ () => props.renderLabel(dashboardState),
+ [dashboardState, props]
+ )
const shortFormatter = props.formatter ?? MetricFormatterShort[metric]
const longFormatter = props.formatter ?? MetricFormatterLong[metric]
diff --git a/assets/js/dashboard/stats/reports/metrics.js b/assets/js/dashboard/stats/reports/metrics.js
index 107b373f2e..dc6fba1562 100644
--- a/assets/js/dashboard/stats/reports/metrics.js
+++ b/assets/js/dashboard/stats/reports/metrics.js
@@ -16,7 +16,7 @@ import { hasConversionGoalFilter } from '../../util/filters'
// and returns the "rendered" version of it. Can be JSX or a string.
// * `renderLabel` - a function rendering a label for this metric given a
-// query argument. Returns string.
+// dashboardState argument. Returns string.
// ### Optional props
@@ -72,15 +72,15 @@ export const createVisitors = (props) => {
if (typeof props.renderLabel === 'function') {
renderLabel = props.renderLabel
} else {
- renderLabel = (query) => {
+ renderLabel = (dashboardState) => {
const defaultLabel = props.defaultLabel || 'Visitors'
const realtimeLabel = props.realtimeLabel || 'Current visitors'
const goalFilterLabel = props.goalFilterLabel || 'Conversions'
- if (query && hasConversionGoalFilter(query)) {
+ if (dashboardState && hasConversionGoalFilter(dashboardState)) {
return goalFilterLabel
}
- if (query.period === 'realtime') {
+ if (dashboardState.period === 'realtime') {
return realtimeLabel
}
return defaultLabel
@@ -97,7 +97,7 @@ export const createVisitors = (props) => {
}
export const createConversionRate = (props) => {
- const renderLabel = (_query) => 'CR'
+ const renderLabel = (_dashboardState) => 'CR'
return new Metric({
width: 'w-28 md:w-24',
...props,
@@ -108,7 +108,7 @@ export const createConversionRate = (props) => {
}
export const createPercentage = (props) => {
- const renderLabel = (_query) => '%'
+ const renderLabel = (_dashboardState) => '%'
return new Metric({
width: 'w-24',
...props,
@@ -123,7 +123,7 @@ export const createEvents = (props) => {
}
export const createTotalRevenue = (props) => {
- const renderLabel = (_query) => 'Revenue'
+ const renderLabel = (_dashboardState) => 'Revenue'
return new Metric({
width: 'w-32',
...props,
@@ -134,7 +134,7 @@ export const createTotalRevenue = (props) => {
}
export const createAverageRevenue = (props) => {
- const renderLabel = (_query) => 'Average'
+ const renderLabel = (_dashboardState) => 'Average'
return new Metric({
width: 'w-28',
...props,
@@ -145,7 +145,7 @@ export const createAverageRevenue = (props) => {
}
export const createTotalVisitors = (props) => {
- const renderLabel = (_query) => 'Total visitors'
+ const renderLabel = (_dashboardState) => 'Total visitors'
return new Metric({
width: 'w-32',
...props,
@@ -160,7 +160,7 @@ export const createVisits = (props) => {
}
export const createVisitDuration = (props) => {
- const renderLabel = (_query) => 'Visit duration'
+ const renderLabel = (_dashboardState) => 'Visit duration'
return new Metric({
width: 'w-28 md:w-24',
...props,
@@ -171,7 +171,7 @@ export const createVisitDuration = (props) => {
}
export const createBounceRate = (props) => {
- const renderLabel = (_query) => 'Bounce rate'
+ const renderLabel = (_dashboardState) => 'Bounce rate'
return new Metric({
width: 'w-28 md:w-24',
...props,
@@ -182,7 +182,7 @@ export const createBounceRate = (props) => {
}
export const createPageviews = (props) => {
- const renderLabel = (_query) => 'Pageviews'
+ const renderLabel = (_dashboardState) => 'Pageviews'
return new Metric({
width: 'w-28',
...props,
@@ -193,7 +193,7 @@ export const createPageviews = (props) => {
}
export const createTimeOnPage = (props) => {
- const renderLabel = (_query) => 'Time on page'
+ const renderLabel = (_dashboardState) => 'Time on page'
return new Metric({
width: 'w-28 md:w-24',
...props,
@@ -204,7 +204,7 @@ export const createTimeOnPage = (props) => {
}
export const createExitRate = (props) => {
- const renderLabel = (_query) => 'Exit rate'
+ const renderLabel = (_dashboardState) => 'Exit rate'
return new Metric({
width: 'w-28 md:w-24',
...props,
@@ -215,7 +215,7 @@ export const createExitRate = (props) => {
}
export const createScrollDepth = (props) => {
- const renderLabel = (_query) => 'Scroll depth'
+ const renderLabel = (_dashboardState) => 'Scroll depth'
return new Metric({
width: 'w-28 md:w-24',
...props,
diff --git a/assets/js/dashboard/stats/sources/index.js b/assets/js/dashboard/stats/sources/index.js
index 01aa552e82..f37672b26a 100644
--- a/assets/js/dashboard/stats/sources/index.js
+++ b/assets/js/dashboard/stats/sources/index.js
@@ -6,16 +6,16 @@ import {
getFiltersByKeyPrefix,
isFilteringOnFixedValue
} from '../../util/filters'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
export default function Sources() {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
- if (isFilteringOnFixedValue(query, 'source', 'Google')) {
+ if (isFilteringOnFixedValue(dashboardState, 'source', 'Google')) {
return <SearchTerms />
- } else if (isFilteringOnFixedValue(query, 'source')) {
+ } else if (isFilteringOnFixedValue(dashboardState, 'source')) {
const [[_operation, _filterKey, clauses]] = getFiltersByKeyPrefix(
- query,
+ dashboardState,
'source'
)
return <ReferrerList source={clauses[0]} />
diff --git a/assets/js/dashboard/stats/sources/referrer-list.js b/assets/js/dashboard/stats/sources/referrer-list.js
index 42ce1d3e28..9cf3d54709 100644
--- a/assets/js/dashboard/stats/sources/referrer-list.js
+++ b/assets/js/dashboard/stats/sources/referrer-list.js
@@ -5,7 +5,7 @@ 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 { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { referrersDrilldownRoute } from '../../router'
import { SourceFavicon } from './source-favicon'
@@ -18,7 +18,7 @@ import { MoreLinkState } from '../more-link-state'
const NO_REFERRER = 'Direct / None'
export default function Referrers({ source }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const [skipImportedReason, setSkipImportedReason] = useState(null)
const [loading, setLoading] = useState(true)
@@ -27,12 +27,12 @@ export default function Referrers({ source }) {
useEffect(() => {
setLoading(true)
setMoreLinkState(MoreLinkState.LOADING)
- }, [query])
+ }, [dashboardState])
function fetchReferrers() {
return api.get(
url.apiPath(site, `/referrers/${encodeURIComponent(source)}`),
- query,
+ dashboardState,
{ limit: 9 }
)
}
@@ -77,7 +77,7 @@ export default function Referrers({ source }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
diff --git a/assets/js/dashboard/stats/sources/search-terms.tsx b/assets/js/dashboard/stats/sources/search-terms.tsx
index 7cb15c2d55..0f9c4099f2 100644
--- a/assets/js/dashboard/stats/sources/search-terms.tsx
+++ b/assets/js/dashboard/stats/sources/search-terms.tsx
@@ -5,7 +5,7 @@ import { numberShortFormatter } from '../../util/number-formatter'
import RocketIcon from '../modals/rocket-icon'
import * as api from '../../api'
import LazyLoader from '../../components/lazy-loader'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { PlausibleSite, useSiteContext } from '../../site-context'
import { ReportLayout } from '../reports/report-layout'
import { ReportHeader } from '../reports/report-header'
@@ -77,7 +77,7 @@ function ConfigureSearchTermsCTA({
export function SearchTerms() {
const site = useSiteContext()
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const [moreLinkState, setMoreLinkState] = React.useState(
MoreLinkState.LOADING
)
@@ -95,7 +95,7 @@ export function SearchTerms() {
api
.get(
`/api/stats/${encodeURIComponent(site.domain)}/referrers/Google`,
- query
+ dashboardState
)
.then((res) => {
setLoading(false)
@@ -113,7 +113,7 @@ export function SearchTerms() {
setErrorPayload(error.payload)
setMoreLinkState(MoreLinkState.HIDDEN)
})
- }, [query, site.domain])
+ }, [dashboardState, site.domain])
useEffect(() => {
if (visible) {
@@ -122,7 +122,7 @@ export function SearchTerms() {
setMoreLinkState(MoreLinkState.LOADING)
fetchSearchTerms()
}
- }, [query, fetchSearchTerms, visible])
+ }, [dashboardState, fetchSearchTerms, visible])
const onVisible = () => {
setVisible(true)
diff --git a/assets/js/dashboard/stats/sources/source-list.js b/assets/js/dashboard/stats/sources/source-list.js
index 44d3c9f2e8..3bdddaa1c8 100644
--- a/assets/js/dashboard/stats/sources/source-list.js
+++ b/assets/js/dashboard/stats/sources/source-list.js
@@ -11,7 +11,7 @@ import {
hasConversionGoalFilter
} from '../../util/filters'
import ImportedQueryUnsupportedWarning from '../imported-query-unsupported-warning'
-import { useQueryContext } from '../../query-context'
+import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { SourceFavicon } from './source-favicon'
import {
@@ -54,10 +54,10 @@ const UTM_TAGS = {
}
function AllSources({ afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
function fetchData() {
- return api.get(url.apiPath(site, '/sources'), query, { limit: 9 })
+ return api.get(url.apiPath(site, '/sources'), dashboardState, { limit: 9 })
}
function getFilterInfo(listItem) {
@@ -74,9 +74,9 @@ function AllSources({ afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -94,11 +94,11 @@ function AllSources({ afterFetchData }) {
}
function Channels({ onClick, afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
function fetchData() {
- return api.get(url.apiPath(site, '/channels'), query, { limit: 9 })
+ return api.get(url.apiPath(site, '/channels'), dashboardState, { limit: 9 })
}
function getFilterInfo(listItem) {
@@ -111,9 +111,9 @@ function Channels({ onClick, afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -131,12 +131,14 @@ function Channels({ onClick, afterFetchData }) {
}
function UTMSources({ tab, afterFetchData }) {
- const { query } = useQueryContext()
+ const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
const utmTag = UTM_TAGS[tab]
function fetchData() {
- return api.get(url.apiPath(site, utmTag.endpoint), query, { limit: 9 })
+ return api.get(url.apiPath(site, utmTag.endpoint), dashboardState, {
+ limit: 9
+ })
}
function getFilterInfo(listItem) {
@@ -149,9 +151,9 @@ function UTMSources({ tab, afterFetchData }) {
function chooseMetrics() {
return [
metrics.createVisitors({ meta: { plot: true } }),
- !hasConversionGoalFilter(query) &&
+ !hasConversionGoalFilter(dashboardState) &&
metrics.createPercentage({ meta: { showOnHover: true } }),
- hasConversionGoalFilter(query) && metrics.createConversionRate()
+ hasConversionGoalFilter(dashboardState) && metrics.createConversionRate()
].filter((metric) => !!metric)
}
@@ -169,27 +171,27 @@ function UTMSources({ tab, afterFetchData }) {
export default function SourceList() {
const site = useSiteContext()
- const { query } = useQueryContext()
+ 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 previousQuery = usePrevious(query)
+ const previousDashboardState = usePrevious(dashboardState)
useEffect(() => {
setLoading(true)
setMoreLinkState(MoreLinkState.LOADING)
- }, [query, currentTab])
+ }, [dashboardState, currentTab])
useEffect(() => {
const isRemovingFilter = (filterName) => {
- if (!previousQuery) return false
+ if (!previousDashboardState) return false
return (
- getFiltersByKeyPrefix(previousQuery, filterName).length > 0 &&
- getFiltersByKeyPrefix(query, filterName).length == 0
+ getFiltersByKeyPrefix(previousDashboardState, filterName).length > 0 &&
+ getFiltersByKeyPrefix(dashboardState, filterName).length == 0
)
}
@@ -197,7 +199,7 @@ export default function SourceList() {
setTab('channels')()
}
// eslint-disable-next-line react-hooks/exhaustive-deps
- }, [query, currentTab])
+ }, [dashboardState, currentTab])
function setTab(tab) {
return () => {
diff --git a/assets/js/dashboard/util/filter-text.test.tsx b/assets/js/dashboard/util/filter-text.test.tsx
index ca2dc815a9..0e02d49dcc 100644
--- a/assets/js/dashboard/util/filter-text.test.tsx
+++ b/assets/js/dashboard/util/filter-text.test.tsx
@@ -1,5 +1,5 @@
import React from 'react'
-import { Filter, FilterClauseLabels } from '../query'
+import { Filter, FilterClauseLabels } from '../dashboard-state'
import { plainFilterText, styledFilterText } from './filter-text'
import { render, screen } from '@testing-library/react'
@@ -25,11 +25,15 @@ describe('styledFilterText() and plainFilterText()', () => {
])(
'when filter is %p and labels are %p, functions return %p',
(filter, labels, expectedPlainText) => {
- const query = { labels }
+ const dashboardState = { labels }
- expect(plainFilterText(query, filter)).toBe(expectedPlainText)
+ expect(plainFilterText(dashboardState, filter)).toBe(expectedPlainText)
- render(<p data-testid="filter-text">{styledFilterText(query, filter)}</p>)
+ render(
+ <p data-testid="filter-text">
+ {styledFilterText(dashboardState, filter)}
+ </p>
+ )
expect(screen.getByTestId('filter-text')).toHaveTextContent(
expectedPlainText
)
diff --git a/assets/js/dashboard/util/filter-text.tsx b/assets/js/dashboard/util/filter-text.tsx
index 1a92b6453c..444adf0d51 100644
--- a/assets/js/dashboard/util/filter-text.tsx
+++ b/assets/js/dashboard/util/filter-text.tsx
@@ -1,5 +1,5 @@
import React, { ReactNode, isValidElement, Fragment } from 'react'
-import { DashboardQuery, Filter } from '../query'
+import { DashboardState, Filter } from '../dashboard-state'
import {
EVENT_PROPS_PREFIX,
FILTER_OPERATIONS_DISPLAY_NAMES,
@@ -9,7 +9,7 @@ import {
} from './filters'
export function styledFilterText(
- query: Pick<DashboardQuery, 'labels'>,
+ dashboardState: Pick<DashboardState, 'labels'>,
[operation, filterKey, clauses]: Filter
) {
if (filterKey.startsWith(EVENT_PROPS_PREFIX)) {
@@ -26,7 +26,7 @@ export function styledFilterText(
formattedFilters as Record<string, string | undefined>
)[filterKey]
const clausesLabels = clauses.map((value) =>
- getLabel(query.labels, filterKey, value)
+ getLabel(dashboardState.labels, filterKey, value)
)
if (!formattedFilter) {
@@ -42,10 +42,10 @@ export function styledFilterText(
}
export function plainFilterText(
- query: Pick<DashboardQuery, 'labels'>,
+ dashboardState: Pick<DashboardState, 'labels'>,
filter: Filter
) {
- return reactNodeToString(styledFilterText(query, filter))
+ return reactNodeToString(styledFilterText(dashboardState, filter))
}
function formatClauses(labels: Array<string | number>): ReactNode[] {
diff --git a/assets/js/dashboard/util/filters.js b/assets/js/dashboard/util/filters.js
index 2415d2943b..d4f19394f4 100644
--- a/assets/js/dashboard/util/filters.js
+++ b/assets/js/dashboard/util/filters.js
@@ -86,8 +86,8 @@ export function getPropertyKeyFromFilterKey(filterKey) {
return filterKey.slice(EVENT_PROPS_PREFIX.length)
}
-export function getFiltersByKeyPrefix(query, prefix) {
- return query.filters.filter(hasDimensionPrefix(prefix))
+export function getFiltersByKeyPrefix(dashboardState, prefix) {
+ return dashboardState.filters.filter(hasDimensionPrefix(prefix))
}
const hasDimensionPrefix =
@@ -95,18 +95,24 @@ const hasDimensionPrefix =
([_operation, dimension, _clauses]) =>
dimension.startsWith(prefix)
-function omitFiltersByKeyPrefix(query, prefix) {
- return query.filters.filter(
+function omitFiltersByKeyPrefix(dashboardState, prefix) {
+ return dashboardState.filters.filter(
([_operation, filterKey, _clauses]) => !filterKey.startsWith(prefix)
)
}
-export function replaceFilterByPrefix(query, prefix, filter) {
- return omitFiltersByKeyPrefix(query, prefix).concat([filter])
+export function replaceFilterByPrefix(dashboardState, prefix, filter) {
+ return omitFiltersByKeyPrefix(dashboardState, prefix).concat([filter])
}
-export function isFilteringOnFixedValue(query, filterKey, expectedValue) {
- const filters = query.filters.filter(([_operation, key]) => filterKey == key)
+export function isFilteringOnFixedValue(
+ dashboardState,
+ filterKey,
+ expectedValue
+) {
+ const filters = dashboardState.filters.filter(
+ ([_operation, key]) => filterKey == key
+ )
if (filters.length == 1) {
const [operation, _filterKey, clauses] = filters[0]
return (
@@ -118,8 +124,8 @@ export function isFilteringOnFixedValue(query, filterKey, expectedValue) {
return false
}
-export function hasConversionGoalFilter(query) {
- const resolvedGoalFilters = query.resolvedFilters.filter(
+export function hasConversionGoalFilter(dashboardState) {
+ const resolvedGoalFilters = dashboardState.resolvedFilters.filter(
hasDimensionPrefix('goal')
)
@@ -128,13 +134,13 @@ export function hasConversionGoalFilter(query) {
})
}
-export function isRealTimeDashboard(query) {
- return query?.period === 'realtime'
+export function isRealTimeDashboard(dashboardState) {
+ return dashboardState?.period === 'realtime'
}
// Note: Currently only a single goal filter can be applied at a time.
-export function getGoalFilter(query) {
- return getFiltersByKeyPrefix(query, 'goal')[0] || null
+export function getGoalFilter(dashboardState) {
+ return getFiltersByKeyPrefix(dashboardState, 'goal')[0] || null
}
export function formatFilterGroup(filterGroup) {
@@ -260,24 +266,33 @@ function remapToApiFilter([operation, filterKey, clauses, ...modifiers]) {
}
}
-export function fetchSuggestions(apiPath, query, input, additionalFilter) {
- const updatedQuery = queryForSuggestions(query, additionalFilter)
+export function fetchSuggestions(
+ apiPath,
+ dashboardState,
+ input,
+ additionalFilter
+) {
+ const updatedQuery = queryForSuggestions(dashboardState, additionalFilter)
return api.get(apiPath, updatedQuery, { q: input.trim() })
}
-function queryForSuggestions(query, additionalFilter) {
- let filters = query.filters
+function queryForSuggestions(dashboardState, additionalFilter) {
+ let filters = dashboardState.filters
if (additionalFilter) {
const [_operation, filterKey, clauses] = additionalFilter
- // For suggestions, we remove already-applied filter with same key from query and add new filter (if feasible)
+ // For suggestions, we remove already-applied filter with same key from dashboardState and add new filter (if feasible)
if (clauses.length > 0) {
- filters = replaceFilterByPrefix(query, filterKey, additionalFilter)
+ filters = replaceFilterByPrefix(
+ dashboardState,
+ filterKey,
+ additionalFilter
+ )
} else {
- filters = omitFiltersByKeyPrefix(query, filterKey)
+ filters = omitFiltersByKeyPrefix(dashboardState, filterKey)
}
}
- return { ...query, filters }
+ return { ...dashboardState, filters }
}
export function getFilterGroup([_operation, filterKey, _clauses]) {
diff --git a/assets/js/dashboard/util/goals.ts b/assets/js/dashboard/util/goals.ts
index 47608351ff..cd6ca0c211 100644
--- a/assets/js/dashboard/util/goals.ts
+++ b/assets/js/dashboard/util/goals.ts
@@ -1,4 +1,4 @@
-import { Filter } from '../query'
+import { Filter } from '../dashboard-state'
import { FILTER_OPERATIONS } from './filters'
export const isPageViewGoal = (goalName: string) => {
diff --git a/assets/js/dashboard/util/url-search-params-v1.ts b/assets/js/dashboard/util/url-search-params-v1.ts
index 88843081f3..c7cc740af7 100644
--- a/assets/js/dashboard/util/url-search-params-v1.ts
+++ b/assets/js/dashboard/util/url-search-params-v1.ts
@@ -1,4 +1,4 @@
-import { DashboardQuery, Filter } from '../query'
+import { DashboardState, Filter } from '../dashboard-state'
import { EVENT_PROPS_PREFIX, FILTER_OPERATIONS } from './filters'
// As of March 2023, Safari does not support negative lookbehind regexes. In case it throws an error, falls back to plain | matching. This means
@@ -53,7 +53,7 @@ function parseSearch(searchString: string): Record<string, unknown> {
const searchParams = new URLSearchParams(searchString)
const updatedSearchRecordEntries = []
const filters: Filter[] = []
- let labels: DashboardQuery['labels'] = {}
+ let labels: DashboardState['labels'] = {}
for (const [key, value] of searchParams.entries()) {
if (LEGACY_URL_PARAMETERS.hasOwnProperty(key)) {
diff --git a/assets/js/dashboard/util/url-search-params.test.ts b/assets/js/dashboard/util/url-search-params.test.ts
index 6f99dfa4c1..cab2c86f0a 100644
--- a/assets/js/dashboard/util/url-search-params.test.ts
+++ b/assets/js/dashboard/util/url-search-params.test.ts
@@ -1,4 +1,4 @@
-import { Filter } from '../query'
+import { Filter } from '../dashboard-state'
import {
encodeURIComponentPermissive,
getSearchWithEnforcedSegment,
diff --git a/assets/js/dashboard/util/url-search-params.ts b/assets/js/dashboard/util/url-search-params.ts
index ab9bbfa996..da07588e58 100644
--- a/assets/js/dashboard/util/url-search-params.ts
+++ b/assets/js/dashboard/util/url-search-params.ts
@@ -2,7 +2,7 @@ import {
getSearchToSetSegmentFilter,
SavedSegment
} from '../filtering/segments'
-import { Filter, FilterClauseLabels } from '../query'
+import { Filter, FilterClauseLabels } from '../dashboard-state'
import { v1 } from './url-search-params-v1'
import { v2 } from './url-search-params-v2'
diff --git a/assets/test-utils/app-context-providers.tsx b/assets/test-utils/app-context-providers.tsx
index d5e059a112..d6f2564d85 100644
--- a/assets/test-utils/app-context-providers.tsx
+++ b/assets/test-utils/app-context-providers.tsx
@@ -8,7 +8,7 @@ import UserContextProvider, {
} from '../js/dashboard/user-context'
import { MemoryRouter, MemoryRouterProps } from 'react-router-dom'
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
-import QueryContextProvider from '../js/dashboard/query-context'
+import DashboardStateContextProvider from '../js/dashboard/dashboard-state-context'
import { getRouterBasepath } from '../js/dashboard/router'
import { RoutelessModalsContextProvider } from '../js/dashboard/navigation/routeless-modals-context'
import { SegmentsContextProvider } from '../js/dashboard/filtering/segments-context'
@@ -91,7 +91,9 @@ export const TestContextProviders = ({
>
<QueryClientProvider client={queryClient}>
<RoutelessModalsContextProvider>
- <QueryContextProvider>{children}</QueryContextProvider>
+ <DashboardStateContextProvider>
+ {children}
+ </DashboardStateContextProvider>
</RoutelessModalsContextProvider>
</QueryClientProvider>
</MemoryRouter>