Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

Preserve metrics visualisation state

Blue Mouseacde5ed35e8a
diff --git a/web/app/pages/Project/View/ViewProject.helpers.tsx b/web/app/pages/Project/View/ViewProject.helpers.tsx
index bf1a2986c..8cc413861 100644
--- a/web/app/pages/Project/View/ViewProject.helpers.tsx
+++ b/web/app/pages/Project/View/ViewProject.helpers.tsx
@@ -167,7 +167,7 @@ const CHART_METRICS_MAPPING = {
sessionDuration: 'sessionDuration',
customEvents: 'customEvents',
cumulativeMode: 'cumulativeMode',
-}
+} as const
const CHART_METRICS_MAPPING_PERF = {
quantiles: 'quantiles',
diff --git a/web/app/pages/Project/View/ViewProject.tsx b/web/app/pages/Project/View/ViewProject.tsx
index a081d1d1f..ff64e809f 100644
--- a/web/app/pages/Project/View/ViewProject.tsx
+++ b/web/app/pages/Project/View/ViewProject.tsx
@@ -296,7 +296,7 @@ const ViewProject = () => {
const [searchParams, setSearchParams] = useSearchParams()
- const [liveVisitors, setLiveVisitors] = useState<number>(0)
+ const [liveVisitors, setLiveVisitors] = useState(0)
const [areFiltersParsed, setAreFiltersParsed] = useState(false)
@@ -320,7 +320,7 @@ const ViewProject = () => {
const [chartData, setChartData] = useState<any>({})
const [mainChart, setMainChart] = useState<any>(null)
const [dataLoading, setDataLoading] = useState(false)
- const [activeChartMetrics, setActiveChartMetrics] = useState<Record<string, boolean>>({
+ const [activeChartMetrics, setActiveChartMetrics] = useState<Record<keyof typeof CHART_METRICS_MAPPING, boolean>>({
[CHART_METRICS_MAPPING.unique]: true,
[CHART_METRICS_MAPPING.views]: false,
[CHART_METRICS_MAPPING.sessionDuration]: false,
@@ -328,6 +328,8 @@ const ViewProject = () => {
[CHART_METRICS_MAPPING.viewsPerUnique]: false,
[CHART_METRICS_MAPPING.trendlines]: false,
[CHART_METRICS_MAPPING.cumulativeMode]: false,
+ [CHART_METRICS_MAPPING.customEvents]: false,
+ ...(preferences.metricsVisualisation || {}),
})
const [errorOptions, setErrorOptions] = useState<Record<string, boolean>>({
[ERROR_FILTERS_MAPPING.showResolved]: false,
@@ -872,7 +874,7 @@ const ViewProject = () => {
const activeTabLabel = useMemo(() => _find(tabs, (tab) => tab.id === activeTab)?.label, [tabs, activeTab])
- const switchTrafficChartMetric = (pairID: string, conflicts?: string[]) => {
+ const switchTrafficChartMetric = (pairID: keyof typeof CHART_METRICS_MAPPING, conflicts?: string[]) => {
if (isConflicted(conflicts)) {
toast.error(t('project.conflictMetric'))
return
@@ -882,7 +884,13 @@ const ViewProject = () => {
return
}
- setActiveChartMetrics((prev) => ({ ...prev, [pairID]: !prev[pairID] }))
+ setActiveChartMetrics((prev) => {
+ const newActiveChartMetrics = { ...prev, [pairID]: !prev[pairID] }
+ updatePreferences({
+ metricsVisualisation: newActiveChartMetrics,
+ })
+ return newActiveChartMetrics
+ })
}
const switchCustomEventChart = (id: string) => {
diff --git a/web/app/pages/Project/View/providers/CurrentProjectProvider.tsx b/web/app/pages/Project/View/providers/CurrentProjectProvider.tsx
index ef458d24b..824460a78 100644
--- a/web/app/pages/Project/View/providers/CurrentProjectProvider.tsx
+++ b/web/app/pages/Project/View/providers/CurrentProjectProvider.tsx
@@ -13,6 +13,7 @@ import { getItem, removeItem } from '~/utils/localstorage'
import routes from '~/utils/routes'
import { getProjectPreferences, setProjectPreferences } from '../utils/cache'
+import { CHART_METRICS_MAPPING } from '../ViewProject.helpers'
interface CurrentProjectContextType {
id: string
@@ -117,6 +118,7 @@ export type ProjectPreferences = {
timeBucket?: string
rangeDate?: Date[]
customEvents?: any
+ metricsVisualisation?: Record<keyof typeof CHART_METRICS_MAPPING, boolean>
}
const useProjectPreferences = (id: string) => {
diff --git a/web/app/pages/Project/View/utils/cache.ts b/web/app/pages/Project/View/utils/cache.ts
index c474929b9..abe049294 100644
--- a/web/app/pages/Project/View/utils/cache.ts
+++ b/web/app/pages/Project/View/utils/cache.ts
@@ -4,7 +4,7 @@ import { getItem, removeItem, setItem } from '~/utils/localstorage'
import { ProjectPreferences } from '../providers/CurrentProjectProvider'
-import { filterInvalidViewPrefs } from './filters'
+import { filterInvalidPreferences } from './filters'
export const getAllProjectPreferences = (): Record<string, ProjectPreferences> => {
if (!isBrowser) {
@@ -14,7 +14,7 @@ export const getAllProjectPreferences = (): Record<string, ProjectPreferences> =
const storedPrefs = (getItem(LS_VIEW_PREFS_SETTING) as Record<string, ProjectPreferences>) || {}
try {
- return filterInvalidViewPrefs(storedPrefs)
+ return filterInvalidPreferences(storedPrefs)
} catch {
removeItem(LS_VIEW_PREFS_SETTING)
}
diff --git a/web/app/pages/Project/View/utils/filters.tsx b/web/app/pages/Project/View/utils/filters.tsx
index be83b20ec..3167947e8 100644
--- a/web/app/pages/Project/View/utils/filters.tsx
+++ b/web/app/pages/Project/View/utils/filters.tsx
@@ -7,6 +7,7 @@ import _startsWith from 'lodash/startsWith'
import React from 'react'
import { Filter } from '../interfaces/traffic'
+import { ProjectPreferences } from '../providers/CurrentProjectProvider'
export const ERROR_FILTERS_MAPPING = {
showResolved: 'showResolved',
@@ -40,7 +41,9 @@ const validFilters = [
// this is done to build a connnection between dynamic column and value (e.g. for custom event metadata or page properties)
const validDynamicFilters = ['ev:key:', 'tag:key:']
-export const filterInvalidViewPrefs = (prefs: any): any => {
+export const filterInvalidPreferences = (
+ prefs: Record<string, ProjectPreferences>,
+): Record<string, ProjectPreferences> => {
const pids = _keys(prefs)
const filtered = _reduce(
pids,