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!

Migrate Redux cache to Project Provider

Blue Mouse55f01728578e
diff --git a/web/app/lib/constants/index.ts b/web/app/lib/constants/index.ts
index c45802f4b..ff4e1620d 100644
--- a/web/app/lib/constants/index.ts
+++ b/web/app/lib/constants/index.ts
@@ -392,8 +392,8 @@ export const TOKEN = 'access_token'
export const REFRESH_TOKEN = 'refresh_token'
// LocalStorage
-export const LS_PROJECTS_PROTECTED = 'projects_protected'
-export const LS_IS_ACTIVE_COMPARE = 'is-active-compare'
+export const LS_PROJECTS_PROTECTED_KEY = 'projects_protected'
+export const LS_IS_ACTIVE_COMPARE_KEY = 'is-active-compare'
// Funnels
export const MIN_FUNNEL_STEPS = 2
diff --git a/web/app/lib/reducers/ui/cache.ts b/web/app/lib/reducers/ui/cache.ts
deleted file mode 100644
index 07ec32ea0..000000000
--- a/web/app/lib/reducers/ui/cache.ts
+++ /dev/null
@@ -1,128 +0,0 @@
-import { createSlice, PayloadAction } from '@reduxjs/toolkit'
-
-import { LS_VIEW_PREFS_SETTING, LS_CAPTCHA_VIEW_PREFS_SETTING, isBrowser } from '~/lib/constants'
-import { filterInvalidViewPrefs } from '~/pages/Project/View/utils/filters'
-import { getItem, removeItem, setItem } from '~/utils/localstorage'
-
-const getInitialViewPrefs = (LS_VIEW: string) => {
- if (!isBrowser) {
- return {}
- }
-
- const storedPrefs = getItem(LS_VIEW)
-
- try {
- return filterInvalidViewPrefs(storedPrefs)
- } catch {
- removeItem(LS_VIEW)
- }
-
- return {}
-}
-
-interface InitialState {
- captchaProjectsViewPrefs: any
- customEventsPrefs: any
- projectViewPrefs: Record<
- string,
- {
- period: string
- timeBucket: string
- rangeDate?: Date[]
- }
- > | null
-}
-
-const initialState: InitialState = {
- captchaProjectsViewPrefs: getInitialViewPrefs(LS_CAPTCHA_VIEW_PREFS_SETTING) || {},
- projectViewPrefs: getInitialViewPrefs(LS_VIEW_PREFS_SETTING),
- customEventsPrefs: {},
-}
-
-const cacheSlice = createSlice({
- name: 'cache',
- initialState,
- reducers: {
- setProjectViewPrefs(
- state,
- { payload }: PayloadAction<{ pid: string; period: string; timeBucket: string; rangeDate?: Date[] }>,
- ) {
- const { pid, period, timeBucket, rangeDate } = payload
- const viewPrefs = rangeDate
- ? {
- period,
- timeBucket,
- rangeDate,
- }
- : {
- period,
- timeBucket,
- }
- const storedPrefs = getItem(LS_VIEW_PREFS_SETTING) as Record<
- string,
- {
- period: string
- timeBucket: string
- rangeDate?: Date[]
- }
- >
- if (typeof storedPrefs === 'object' && storedPrefs !== null) {
- storedPrefs[pid] = viewPrefs
- setItem(LS_VIEW_PREFS_SETTING, JSON.stringify(storedPrefs))
- } else {
- setItem(LS_VIEW_PREFS_SETTING, JSON.stringify({ [pid]: viewPrefs }))
- }
- state.projectViewPrefs = {
- ...state.projectViewPrefs,
- [pid]: viewPrefs,
- }
- },
- setCaptchaProjectViewPrefs(
- state,
- { payload }: PayloadAction<{ pid: string; period: string; timeBucket: string; rangeDate?: Date[] | null }>,
- ) {
- const { pid, period, timeBucket, rangeDate } = payload
- const viewPrefs = rangeDate
- ? {
- period,
- timeBucket,
- rangeDate,
- }
- : {
- period,
- timeBucket,
- }
- const storedPrefs = getItem(LS_CAPTCHA_VIEW_PREFS_SETTING) as Record<
- string,
- {
- period: string
- timeBucket: string
- rangeDate?: Date[]
- }
- >
- if (typeof storedPrefs === 'object' && storedPrefs !== null) {
- storedPrefs[pid] = viewPrefs
- setItem(LS_CAPTCHA_VIEW_PREFS_SETTING, JSON.stringify(storedPrefs))
- } else {
- setItem(LS_CAPTCHA_VIEW_PREFS_SETTING, JSON.stringify({ [pid]: viewPrefs }))
- }
- state.captchaProjectsViewPrefs = {
- ...state.captchaProjectsViewPrefs,
- [pid]: viewPrefs,
- }
- },
- setCustomEventsPrefs(state, { payload }: PayloadAction<{ pid: string; data: any }>) {
- state.customEventsPrefs = {
- ...state.customEventsPrefs,
- [payload.pid]: {
- ...state.customEventsPrefs[payload.pid],
- ...payload.data,
- },
- }
- },
- },
-})
-
-export const cacheActions = cacheSlice.actions
-
-export default cacheSlice.reducer
diff --git a/web/app/lib/reducers/ui/index.ts b/web/app/lib/reducers/ui/index.ts
index 94669fbae..84cd1bcda 100644
--- a/web/app/lib/reducers/ui/index.ts
+++ b/web/app/lib/reducers/ui/index.ts
@@ -1,9 +1,7 @@
-import { cacheActions } from './cache'
import { miscActions } from './misc'
import { themeActions } from './theme'
const UIActions = {
- ...cacheActions,
...miscActions,
...themeActions,
}
diff --git a/web/app/lib/reducers/ui/misc.ts b/web/app/lib/reducers/ui/misc.ts
index e096b4e3a..6528a5f17 100644
--- a/web/app/lib/reducers/ui/misc.ts
+++ b/web/app/lib/reducers/ui/misc.ts
@@ -1,11 +1,10 @@
import { createSlice, PayloadAction } from '@reduxjs/toolkit'
-import { LOW_EVENTS_WARNING, LS_PROJECTS_PROTECTED } from '~/lib/constants'
+import { LOW_EVENTS_WARNING } from '~/lib/constants'
import { Metainfo } from '~/lib/models/Metainfo'
import { Stats } from '~/lib/models/Stats'
import { setCookie } from '~/utils/cookie'
import { secondsTillNextMonth } from '~/utils/generic'
-import { getItem, setItem } from '~/utils/localstorage'
interface InitialState {
stats: Stats
@@ -15,7 +14,6 @@ interface InitialState {
showNoEventsLeftBanner: boolean
lastBlogPost: any
extensions: any[]
- projectPasswords: Record<string, string>
}
const initialState: InitialState = {
@@ -31,7 +29,6 @@ const initialState: InitialState = {
symbol: '$',
code: 'USD',
},
- projectPasswords: getItem(LS_PROJECTS_PROTECTED) || {},
paddleLoaded: false,
paddle: {},
showNoEventsLeftBanner: false,
@@ -46,15 +43,6 @@ const miscSlice = createSlice({
setGeneralStats(state, { payload }: PayloadAction<Stats>) {
state.stats = payload
},
- setProjectPassword: (state, { payload }: PayloadAction<{ id: string; password: string }>) => {
- const { id, password } = payload
-
- state.projectPasswords = {
- ...state.projectPasswords,
- [id]: password,
- }
- setItem(LS_PROJECTS_PROTECTED, JSON.stringify(state.projectPasswords))
- },
setPaddleLastEvent(state, { payload }: PayloadAction<any>) {
state.paddle = { ...state.paddle, lastEvent: payload }
},
diff --git a/web/app/pages/Captcha/View/ViewCaptcha.tsx b/web/app/pages/Captcha/View/ViewCaptcha.tsx
index 20bbad884..923754fb0 100644
--- a/web/app/pages/Captcha/View/ViewCaptcha.tsx
+++ b/web/app/pages/Captcha/View/ViewCaptcha.tsx
@@ -16,11 +16,9 @@ import { useTranslation } from 'react-i18next'
import { useSelector } from 'react-redux'
import { useNavigate, useSearchParams } from 'react-router'
import { ClientOnly } from 'remix-utils/client-only'
-import { toast } from 'sonner'
-import { getProject, getCaptchaData } from '~/api'
+import { getCaptchaData } from '~/api'
import EventsRunningOutBanner from '~/components/EventsRunningOutBanner'
-import { useRequiredParams } from '~/hooks/useRequiredParams'
import useSize from '~/hooks/useSize'
import {
captchaTbPeriodPairs,
@@ -37,10 +35,9 @@ import {
ThemeType,
DEFAULT_TIMEZONE,
} from '~/lib/constants'
-import { CaptchaProject } from '~/lib/models/Project'
-import UIActions from '~/lib/reducers/ui'
-import { StateType, useAppDispatch } from '~/lib/store'
+import { StateType } from '~/lib/store'
import { Panel } from '~/pages/Project/View/Panels'
+import { useCurrentProject } from '~/pages/Project/View/providers/CurrentProjectProvider'
import { parseFiltersFromUrl } from '~/pages/Project/View/utils/filters'
import { ViewProjectContext } from '~/pages/Project/View/ViewProject'
import { deviceIconMapping, onCSVExportClick } from '~/pages/Project/View/ViewProject.helpers'
@@ -81,11 +78,10 @@ interface ViewCaptchaProps {
}
const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
+ const { id, project, preferences, updatePreferences } = useCurrentProject()
+
const { loading: authLoading, user } = useSelector((state: StateType) => state.auth)
const { theme } = useSelector((state: StateType) => state.ui.theme)
- const { captchaProjectsViewPrefs } = useSelector((state: StateType) => state.ui.cache)
-
- const dispatch = useAppDispatch()
const {
t,
@@ -93,23 +89,14 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
} = useTranslation('common')
const [periodPairs, setPeriodPairs] = useState(captchaTbPeriodPairs(t, undefined, undefined, language))
const dashboardRef = useRef(null)
- const { id } = useRequiredParams<{ id: string }>()
const navigate = useNavigate()
- const [project, setProject] = useState<CaptchaProject | null>(null)
-
const [areFiltersParsed, setAreFiltersParsed] = useState(false)
const [panelsData, setPanelsData] = useState<any>({})
const [isPanelsDataEmpty, setIsPanelsDataEmpty] = useState(false)
const [analyticsLoading, setAnalyticsLoading] = useState(true)
- const [period, setPeriod] = useState<string>(
- captchaProjectsViewPrefs ? captchaProjectsViewPrefs[id]?.period || periodPairs[4].period : periodPairs[4].period,
- )
- const [timeBucket, setTimebucket] = useState<string>(
- captchaProjectsViewPrefs
- ? captchaProjectsViewPrefs[id]?.timeBucket || periodPairs[4].tbs[1]
- : periodPairs[4].tbs[1],
- )
+ const [period, setPeriod] = useState<string>(preferences?.period || periodPairs[4].period)
+ const [timeBucket, setTimebucket] = useState<string>(preferences?.timeBucket || periodPairs[4].tbs[1])
const activePeriod: {
period: string
label: string
@@ -128,9 +115,8 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
const [filters, setFilters] = useState<any[]>([])
const tnMapping = typeNameMapping(t)
const refCalendar = useRef(null)
- const localStorageDateRange = captchaProjectsViewPrefs ? captchaProjectsViewPrefs[id]?.rangeDate : null
const [dateRange, setDateRange] = useState<Date[] | null>(
- localStorageDateRange ? [new Date(localStorageDateRange[0]), new Date(localStorageDateRange[1])] : null,
+ preferences?.rangeDate ? [new Date(preferences.rangeDate[0]), new Date(preferences.rangeDate[1])] : null,
)
const [searchParams] = useSearchParams()
@@ -164,11 +150,6 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
}
}, [t])
- const onErrorLoading = () => {
- toast.error(t('project.noExist'))
- navigate(routes.dashboard)
- }
-
const loadCaptcha = async () => {
setDataLoading(true)
@@ -365,14 +346,12 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
// @ts-expect-error
const url = new URL(window.location)
const { searchParams } = url
- const intialPeriod = captchaProjectsViewPrefs
- ? searchParams.get('period') || captchaProjectsViewPrefs[id]?.period
- : searchParams.get('period') || '7d'
- if (!_includes(validPeriods, intialPeriod)) {
+ const initialPeriod = searchParams.get('period') || preferences?.period || '7d'
+ if (!_includes(validPeriods, initialPeriod)) {
return
}
- if (intialPeriod === 'custom') {
+ if (initialPeriod === 'custom') {
// @ts-expect-error
const from = new Date(searchParams.get('from'))
// @ts-expect-error
@@ -386,7 +365,7 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
setPeriodPairs(captchaTbPeriodPairs(t, undefined, undefined, language))
setDateRange(null)
- updatePeriod({ period: intialPeriod })
+ updatePeriod({ period: initialPeriod })
} catch (reason) {
console.error('[ERROR](useEffect) Setting period failed:', reason)
}
@@ -422,15 +401,13 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
const parsePeriodFilters = () => {
try {
- const intialPeriod = captchaProjectsViewPrefs
- ? searchParams.get('period') || captchaProjectsViewPrefs[id]?.period
- : searchParams.get('period') || '7d'
+ const initialPeriod = searchParams.get('period') || preferences?.period || '7d'
- if (!_includes(validPeriods, intialPeriod)) {
+ if (!_includes(validPeriods, initialPeriod)) {
return
}
- if (intialPeriod === 'custom') {
+ if (initialPeriod === 'custom') {
// @ts-expect-error
const from = new Date(searchParams.get('from'))
// @ts-expect-error
@@ -445,7 +422,7 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
setPeriodPairs(captchaTbPeriodPairs(t, undefined, undefined, language))
setDateRange(null)
updatePeriod({
- period: intialPeriod,
+ period: initialPeriod,
})
} catch {
//
@@ -504,14 +481,11 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
setPeriodPairs(captchaTbPeriodPairs(t, timeBucketToDays[index].tb, dates, language))
setPeriod('custom')
- dispatch(
- UIActions.setCaptchaProjectViewPrefs({
- pid: id,
- period: 'custom',
- timeBucket: timeBucketToDays[4].tb[0],
- rangeDate: dates,
- }),
- )
+ updatePreferences({
+ period: 'custom',
+ timeBucket: timeBucketToDays[index].tb[0],
+ rangeDate: dates,
+ })
break
}
@@ -524,25 +498,6 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
}
}, [dateRange, areFiltersParsed]) // eslint-disable-line
- useEffect(() => {
- if (authLoading || !_isEmpty(project)) {
- return
- }
-
- getProject(id)
- .then((result) => {
- if (_isEmpty(result)) {
- onErrorLoading()
- } else {
- setProject(result as CaptchaProject)
- }
- })
- .catch((reason) => {
- console.error(reason)
- onErrorLoading()
- })
- }, [authLoading, project, id]) // eslint-disable-line
-
const updatePeriod = (newPeriod: any) => {
const newPeriodFull = _find(periodPairs, (el) => el.period === newPeriod.period)
let tb: any = timeBucket
@@ -562,13 +517,10 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
url.searchParams.delete('from')
url.searchParams.delete('to')
url.searchParams.append('period', newPeriod.period)
- dispatch(
- UIActions.setCaptchaProjectViewPrefs({
- pid: id,
- period: newPeriod.period,
- timeBucket: tb,
- }),
- )
+ updatePreferences({
+ period: newPeriod.period,
+ timeBucket: tb,
+ })
setPeriod(newPeriod.period)
setDateRange(null)
}
@@ -584,14 +536,9 @@ const ViewCaptcha = ({ ssrTheme }: ViewCaptchaProps) => {
const { pathname, search } = url
navigate(`${pathname}${search}`)
setTimebucket(newTimebucket)
- dispatch(
- UIActions.setCaptchaProjectViewPrefs({
- pid: id,
- period,
- timeBucket: newTimebucket,
- rangeDate: dateRange,
- }),
- )
+ updatePreferences({
+ timeBucket: newTimebucket,
+ })
}
const openSettingsHandler = () => {
diff --git a/web/app/pages/Project/ProjectProtectedPassword/index.tsx b/web/app/pages/Project/ProjectProtectedPassword/index.tsx
index 6acd6254c..9c17a1981 100644
--- a/web/app/pages/Project/ProjectProtectedPassword/index.tsx
+++ b/web/app/pages/Project/ProjectProtectedPassword/index.tsx
@@ -4,18 +4,18 @@ import _replace from 'lodash/replace'
import _size from 'lodash/size'
import React, { useState, useEffect, memo } from 'react'
import { useTranslation } from 'react-i18next'
-import { useDispatch } from 'react-redux'
import { Link, useNavigate } from 'react-router'
import { checkPassword } from '~/api'
import Footer from '~/components/Footer'
import Header from '~/components/Header'
import { useRequiredParams } from '~/hooks/useRequiredParams'
-import UIActions from '~/lib/reducers/ui'
import Button from '~/ui/Button'
import Input from '~/ui/Input'
import routes from '~/utils/routes'
+import { setProjectPassword } from '../View/utils/cache'
+
interface ProjectProtectedPasswordForm {
password: string
}
@@ -41,7 +41,6 @@ const ProjectProtectedPassword = ({ ssrTheme, embedded, isAuth }: ProjectProtect
const [beenSubmitted, setBeenSubmitted] = useState(false)
const [isLoading, setIsLoading] = useState(false)
const navigate = useNavigate()
- const dispatch = useDispatch()
const validate = () => {
const allErrors = {} as {
@@ -72,12 +71,7 @@ const ProjectProtectedPassword = ({ ssrTheme, embedded, isAuth }: ProjectProtect
await checkPassword(id, data.password)
.then((result) => {
if (result) {
- dispatch(
- UIActions.setProjectPassword({
- id,
- password: data.password,
- }),
- )
+ setProjectPassword(id, data.password)
navigate({
pathname: _replace(routes.project, ':id', id),
search: `?embedded=${embedded}&theme=${ssrTheme}`,
diff --git a/web/app/pages/Project/View/ViewProject.tsx b/web/app/pages/Project/View/ViewProject.tsx
index 93a47f29e..3fb4381e0 100644
--- a/web/app/pages/Project/View/ViewProject.tsx
+++ b/web/app/pages/Project/View/ViewProject.tsx
@@ -57,20 +57,18 @@ import { toast } from 'sonner'
import {
getProjectData,
- getProject,
getOverallStats,
getLiveVisitors,
getPerfData,
getProjectDataCustomEvents,
getTrafficCompareData,
getPerformanceCompareData,
- checkPassword,
getCustomEventsMetadata,
addFunnel,
updateFunnel,
deleteFunnel,
getFunnelData,
- getFunnels,
+ // getFunnels,
getPerformanceOverallStats,
getSessions,
getSession,
@@ -84,7 +82,6 @@ import {
import EventsRunningOutBanner from '~/components/EventsRunningOutBanner'
import Footer from '~/components/Footer'
import Header from '~/components/Header'
-import { useRequiredParams } from '~/hooks/useRequiredParams'
import useSize from '~/hooks/useSize'
import {
tbPeriodPairs,
@@ -103,8 +100,7 @@ import {
tbPeriodPairsCompare,
PERIOD_PAIRS_COMPARE,
FILTERS_PERIOD_PAIRS,
- LS_IS_ACTIVE_COMPARE,
- LS_PROJECTS_PROTECTED,
+ LS_IS_ACTIVE_COMPARE_KEY,
isBrowser,
TITLE_SUFFIX,
KEY_FOR_ALL_TIME,
@@ -119,9 +115,8 @@ import {
ThemeType,
} from '~/lib/constants'
import { CountryEntry } from '~/lib/models/Entry'
-import { Project, Funnel, AnalyticsFunnel, OverallObject, OverallPerformanceObject } from '~/lib/models/Project'
-import UIActions from '~/lib/reducers/ui'
-import { StateType, useAppDispatch } from '~/lib/store'
+import { Funnel, AnalyticsFunnel, OverallObject, OverallPerformanceObject } from '~/lib/models/Project'
+import { StateType } from '~/lib/store'
import NewFunnel from '~/modals/NewFunnel'
import ViewProjectHotkeys from '~/modals/ViewProjectHotkeys'
import Checkbox from '~/ui/Checkbox'
@@ -134,7 +129,7 @@ import Select from '~/ui/Select'
import { trackCustom } from '~/utils/analytics'
import { periodToCompareDate } from '~/utils/compareConvertDate'
import { getTimeFromSeconds, getStringFromTime, getLocaleDisplayName, nLocaleFormatter } from '~/utils/generic'
-import { getItem, setItem, removeItem } from '~/utils/localstorage'
+import { getItem, setItem } from '~/utils/localstorage'
import routes from '~/utils/routes'
import ProjectAlertsView from '../Alerts/View'
@@ -180,6 +175,7 @@ import {
TrafficLogResponse,
} from './interfaces/traffic'
import { Panel, Metadata } from './Panels'
+import { useCurrentProject, useProjectPassword } from './providers/CurrentProjectProvider'
import {
handleNavigationParams,
updateFilterState,
@@ -255,29 +251,26 @@ export const useViewProjectContext = () => {
}
const ViewProject = () => {
- const dispatch = useAppDispatch()
+ const { id, project, preferences, updatePreferences } = useCurrentProject()
+ const projectPassword = useProjectPassword(id)
const {
theme: ssrTheme,
embedded,
isAuth: ssrAuthenticated,
- queryPassword,
tabs: projectQueryTabs,
} = useLoaderData<{
theme: ThemeType
embedded: boolean
isAuth: boolean
- queryPassword: string | null
tabs: string[]
}>()
- const { projectViewPrefs, customEventsPrefs } = useSelector((state: StateType) => state.ui.cache)
-
const { loading: authLoading, authenticated: csrAuthenticated, user } = useSelector((state: StateType) => state.auth)
const { theme } = useSelector((state: StateType) => state.ui.theme)
- const { extensions, projectPasswords } = useSelector((state: StateType) => state.ui.misc)
+ const { extensions } = useSelector((state: StateType) => state.ui.misc)
const authenticated = isBrowser ? (authLoading ? ssrAuthenticated : csrAuthenticated) : ssrAuthenticated
const { timezone = DEFAULT_TIMEZONE } = user || {}
@@ -299,19 +292,12 @@ const ViewProject = () => {
const dashboardRef = useRef<HTMLDivElement>(null)
- const { id } = useRequiredParams<{ id: string }>()
const navigate = useNavigate()
const [searchParams, setSearchParams] = useSearchParams()
- const [project, setProject] = useState<Project | null>(null)
const [liveVisitors, setLiveVisitors] = useState<number>(0)
- const projectPassword = useMemo(
- () => projectPasswords[id] || queryPassword || (getItem(LS_PROJECTS_PROTECTED)?.[id] as string) || '',
- [id, projectPasswords, queryPassword],
- )
-
const [areFiltersParsed, setAreFiltersParsed] = useState(false)
const [panelsData, setPanelsData] = useState<{
@@ -328,12 +314,8 @@ const ViewProject = () => {
const [isNewFunnelOpened, setIsNewFunnelOpened] = useState(false)
const [isAddAViewOpened, setIsAddAViewOpened] = useState(false)
const [analyticsLoading, setAnalyticsLoading] = useState(true)
- const [period, setPeriod] = useState(
- projectViewPrefs ? projectViewPrefs[id]?.period || periodPairs[4].period : periodPairs[4].period,
- )
- const [timeBucket, setTimebucket] = useState(
- projectViewPrefs ? projectViewPrefs[id]?.timeBucket || periodPairs[4].tbs[1] : periodPairs[4].tbs[1],
- )
+ const [period, setPeriod] = useState(preferences.period || periodPairs[4].period)
+ const [timeBucket, setTimebucket] = useState(preferences.timeBucket || periodPairs[4].tbs[1])
const activePeriod = useMemo(() => _find(periodPairs, (p) => p.period === period), [period, periodPairs])
const [chartData, setChartData] = useState<any>({})
const [mainChart, setMainChart] = useState<any>(null)
@@ -368,9 +350,8 @@ const ViewProject = () => {
const tnMapping = typeNameMapping(t)
const refCalendar = useRef(null)
const refCalendarCompare = useRef(null)
- const localStorageDateRange = projectViewPrefs ? projectViewPrefs[id]?.rangeDate : null
const [dateRange, setDateRange] = useState<null | Date[]>(
- localStorageDateRange ? [new Date(localStorageDateRange[0]), new Date(localStorageDateRange[1])] : null,
+ preferences.rangeDate ? [new Date(preferences.rangeDate[0]), new Date(preferences.rangeDate[1])] : null,
)
const [activeTab, setActiveTab] = useState(() => {
const tab = searchParams.get('tab') as keyof typeof PROJECT_TABS
@@ -469,8 +450,9 @@ const ViewProject = () => {
}
try {
- const funnels = await getFunnels(id, projectPassword)
- setProject((prev) => (prev ? { ...prev, funnels } : null))
+ // const funnels = await getFunnels(id, projectPassword)
+ // TODO
+ // setProject((prev) => (prev ? { ...prev, funnels } : null))
} catch (reason: any) {
console.error('[ERROR] (onFunnelCreate)(getFunnels)', reason)
}
@@ -494,8 +476,9 @@ const ViewProject = () => {
}
try {
- const funnels = await getFunnels(id, projectPassword)
- setProject((prev) => (prev ? { ...prev, funnels } : null))
+ // const funnels = await getFunnels(id, projectPassword)
+ // TODO
+ // setProject((prev) => (prev ? { ...prev, funnels } : null))
} catch (reason: any) {
console.error('[ERROR] (onFunnelCreate)(getFunnels)', reason)
}
@@ -519,8 +502,9 @@ const ViewProject = () => {
}
try {
- const funnels = await getFunnels(id, projectPassword)
- setProject((prev) => (prev ? { ...prev, funnels } : null))
+ // const funnels = await getFunnels(id, projectPassword)
+ // TODO
+ // setProject((prev) => (prev ? { ...prev, funnels } : null))
} catch (reason: any) {
console.error('[ERROR] (onFunnelCreate)(getFunnels)', reason)
}
@@ -549,10 +533,10 @@ const ViewProject = () => {
const rotateXAxis = useMemo(() => size.width > 0 && size.width < 500, [size])
const customEventsChartData = useMemo(
() =>
- _pickBy(customEventsPrefs[id], (value, keyCustomEvents) =>
+ _pickBy(preferences.customEvents, (value, keyCustomEvents) =>
_includes(activeChartMetricsCustomEvents, keyCustomEvents),
),
- [customEventsPrefs, id, activeChartMetricsCustomEvents],
+ [preferences.customEvents, id, activeChartMetricsCustomEvents],
)
const [chartType, setChartType] = useState((getItem('chartType') as string) || chartTypes.line)
@@ -563,7 +547,7 @@ const ViewProject = () => {
}[]
>(tbPeriodPairsCompare(t, undefined, language))
const [isActiveCompare, setIsActiveCompare] = useState(() => {
- const activeCompare = getItem(LS_IS_ACTIVE_COMPARE)
+ const activeCompare = getItem(LS_IS_ACTIVE_COMPARE_KEY)
if (typeof activeCompare === 'string') {
return activeCompare === 'true'
@@ -983,31 +967,6 @@ const ViewProject = () => {
setErrorStatusUpdating(false)
}
- const onErrorLoading = () => {
- if (projectPassword) {
- checkPassword(id, projectPassword).then((res) => {
- if (res) {
- navigate({
- pathname: _replace(routes.project, ':id', id),
- search: `?theme=${ssrTheme}&embedded=${embedded}`,
- })
- return
- }
-
- toast.error(t('apiNotifications.incorrectPassword'))
- navigate({
- pathname: _replace(routes.project_protected_password, ':id', id),
- search: `?theme=${ssrTheme}&embedded=${embedded}`,
- })
- removeItem(LS_PROJECTS_PROTECTED)
- })
- return
- }
-
- toast.error(t('project.noExist'))
- navigate(routes.dashboard)
- }
-
const loadCustomEvents = async () => {
if (_isEmpty(panelsData.customs)) {
return
@@ -1059,12 +1018,9 @@ const ViewProject = () => {
const events = data?.chart ? data.chart.events : customEventsChartData
- dispatch(
- UIActions.setCustomEventsPrefs({
- pid: id,
- data: events,
- }),
- )
+ updatePreferences({
+ customEvents: events,
+ })
const applyRegions = !_includes(noRegionPeriods, activePeriod?.period)
const bbSettings = getSettings(
@@ -1243,12 +1199,9 @@ const ViewProject = () => {
customEventsChart = customEventsChart?.chart ? customEventsChart.chart.events : customEventsChartData
- dispatch(
- UIActions.setCustomEventsPrefs({
- pid: id,
- data: customEventsChart,
- }),
- )
+ updatePreferences({
+ customEvents: customEventsChart,
+ })
data.overall = rawOverall[id]
setOverall(rawOverall[id])
@@ -2073,15 +2026,13 @@ const ViewProject = () => {
const parsePeriodFilters = () => {
try {
- const intialPeriod = projectViewPrefs
- ? searchParams.get('period') || projectViewPrefs[id]?.period
- : searchParams.get('period') || '7d'
+ const initialPeriod = searchParams.get('period') || preferences.period || '7d'
- if (!_includes(validPeriods, intialPeriod)) {
+ if (!_includes(validPeriods, initialPeriod)) {
return
}
- if (intialPeriod === 'custom') {
+ if (initialPeriod === 'custom') {
// @ts-expect-error
const from = new Date(searchParams.get('from'))
// @ts-expect-error
@@ -2096,7 +2047,7 @@ const ViewProject = () => {
setPeriodPairs(tbPeriodPairs(t, undefined, undefined, language))
setDateRange(null)
updatePeriod({
- period: intialPeriod,
+ period: initialPeriod,
})
} catch {
//
@@ -2477,14 +2428,11 @@ const ViewProject = () => {
setPeriodPairs(tbPeriodPairs(t, timeBucketToDays[index].tb, dates, language))
setPeriod('custom')
- dispatch(
- UIActions.setProjectViewPrefs({
- pid: id,
- period: 'custom',
- timeBucket: timeBucketToDays[index].tb[0],
- rangeDate: dates,
- }),
- )
+ updatePreferences({
+ period: 'custom',
+ timeBucket: timeBucketToDays[index].tb[0],
+ rangeDate: dates,
+ })
setCanLoadMoreSessions(false)
resetSessions()
@@ -2534,33 +2482,6 @@ const ViewProject = () => {
return () => clearInterval(interval)
}, [project, projectPassword])
- useEffect(() => {
- if (authLoading || !_isEmpty(project)) {
- return
- }
-
- getProject(id, projectPassword)
- .then((result) => {
- if (_isEmpty(result)) {
- onErrorLoading()
- }
-
- if (result.isPasswordProtected && !result.role && _isEmpty(projectPassword)) {
- navigate({
- pathname: _replace(routes.project_protected_password, ':id', id),
- search: `?theme=${ssrTheme}&embedded=${embedded}`,
- })
- return
- }
-
- setProject(result)
- })
- .catch((reason) => {
- console.error('[ERROR] (getProject)', reason)
- onErrorLoading()
- })
- }, [authLoading, project, id])
-
const updatePeriod = (newPeriod: { period: string; label?: string }) => {
if (period === newPeriod.period) {
return
@@ -2580,13 +2501,10 @@ const ViewProject = () => {
searchParams.delete('from')
searchParams.delete('to')
searchParams.set('period', newPeriod.period)
- dispatch(
- UIActions.setProjectViewPrefs({
- pid: id,
- period: newPeriod.period,
- timeBucket: tb,
- }),
- )
+ updatePreferences({
+ period: newPeriod.period,
+ timeBucket: tb,
+ })
setPeriod(newPeriod.period)
setCanLoadMoreSessions(false)
@@ -2612,14 +2530,9 @@ const ViewProject = () => {
searchParams.set('timeBucket', newTimebucket)
setSearchParams(searchParams)
setTimebucket(newTimebucket)
- dispatch(
- UIActions.setProjectViewPrefs({
- pid: id,
- period,
- timeBucket: newTimebucket,
- rangeDate: dateRange as Date[],
- }),
- )
+ updatePreferences({
+ timeBucket: newTimebucket,
+ })
sdkInstance?._emitEvent('timeupdate', {
period,
timeBucket: newTimebucket,
diff --git a/web/app/pages/Project/View/providers/CurrentProjectProvider.tsx b/web/app/pages/Project/View/providers/CurrentProjectProvider.tsx
new file mode 100644
index 000000000..2cb721a6d
--- /dev/null
+++ b/web/app/pages/Project/View/providers/CurrentProjectProvider.tsx
@@ -0,0 +1,172 @@
+import _replace from 'lodash/replace'
+import { createContext, useCallback, useContext, useEffect, useMemo, useState } from 'react'
+import { useTranslation } from 'react-i18next'
+import { useSelector } from 'react-redux'
+import { useLoaderData, useNavigate, useSearchParams } from 'react-router'
+import { toast } from 'sonner'
+
+import { checkPassword, getProject } from '~/api'
+import { LS_PROJECTS_PROTECTED_KEY, ThemeType } from '~/lib/constants'
+import { type Project } from '~/lib/models/Project'
+import { type StateType } from '~/lib/store'
+import { getItem, removeItem } from '~/utils/localstorage'
+import routes from '~/utils/routes'
+
+import { getProjectPreferences, setProjectPreferences } from '../utils/cache'
+
+interface CurrentProjectContextType {
+ id: string
+ project: Project | null
+ preferences: ProjectPreferences
+ updatePreferences: (prefs: ProjectPreferences) => void
+}
+
+const CurrentProjectContext = createContext<CurrentProjectContextType | undefined>(undefined)
+
+interface CurrentProjectProviderProps {
+ id: string
+ children: React.ReactNode
+}
+
+export const useProjectPassword = (id: string) => {
+ const [searchParams] = useSearchParams()
+
+ const projectPassword = useMemo(
+ () => searchParams.get('password') || (getItem(LS_PROJECTS_PROTECTED_KEY) as Record<string, string>)?.[id] || '',
+ [id, searchParams],
+ )
+
+ return projectPassword
+}
+
+const useIsEmbedded = () => {
+ const [searchParams] = useSearchParams()
+
+ return searchParams.get('embedded') === 'true'
+}
+
+const useProject = (id: string) => {
+ const { t } = useTranslation('common')
+ const navigate = useNavigate()
+ const { loading: authLoading } = useSelector((state: StateType) => state.auth)
+ const projectPassword = useProjectPassword(id)
+ const isEmbedded = useIsEmbedded()
+ const [project, setProject] = useState<Project | null>(null)
+
+ const { theme: ssrTheme } = useLoaderData<{
+ theme: ThemeType
+ }>()
+
+ const onErrorLoading = useCallback(() => {
+ if (projectPassword) {
+ checkPassword(id, projectPassword).then((res) => {
+ if (res) {
+ navigate({
+ pathname: _replace(routes.project, ':id', id),
+ search: `?theme=${ssrTheme}&embedded=${isEmbedded}`,
+ })
+ return
+ }
+
+ toast.error(t('apiNotifications.incorrectPassword'))
+ navigate({
+ pathname: _replace(routes.project_protected_password, ':id', id),
+ search: `?theme=${ssrTheme}&embedded=${isEmbedded}`,
+ })
+ removeItem(LS_PROJECTS_PROTECTED_KEY)
+ })
+ return
+ }
+
+ toast.error(t('project.noExist'))
+ navigate(routes.dashboard)
+ }, [id, projectPassword, navigate, t, isEmbedded, ssrTheme])
+
+ useEffect(() => {
+ if (authLoading || project) {
+ return
+ }
+
+ getProject(id, projectPassword)
+ .then((result) => {
+ if (!result) {
+ onErrorLoading()
+ }
+
+ if (result.isPasswordProtected && !result.role && projectPassword) {
+ navigate({
+ pathname: _replace(routes.project_protected_password, ':id', id),
+ search: `?theme=${ssrTheme}&embedded=${isEmbedded}`,
+ })
+ return
+ }
+
+ setProject(result)
+ })
+ .catch((reason) => {
+ console.error('[ERROR] (getProject)', reason)
+ onErrorLoading()
+ })
+ }, [authLoading, project, id, projectPassword, navigate, onErrorLoading, isEmbedded, ssrTheme])
+
+ return project
+}
+
+export type ProjectPreferences = {
+ period?: string
+ timeBucket?: string
+ rangeDate?: Date[]
+ customEvents?: any
+}
+
+const useProjectPreferences = (id: string) => {
+ const [preferences, setPreferences] = useState<ProjectPreferences>(getProjectPreferences(id) as ProjectPreferences)
+
+ const updatePreferences = useCallback(
+ (prefs: ProjectPreferences) => {
+ setPreferences((prev) => {
+ const { period, timeBucket, rangeDate, ...rest } = prefs
+
+ // This bullshit is needed for backward compatibility with the old Redux state preferences
+ // One day I'll refactor the code properly, until then, here's a TODO so I don't forget
+ const viewPrefs = rangeDate
+ ? {
+ period,
+ timeBucket,
+ rangeDate,
+ }
+ : {
+ period,
+ timeBucket,
+ }
+
+ const newPrefs = { ...prev, ...viewPrefs, ...rest }
+ setProjectPreferences(id, newPrefs)
+ return newPrefs
+ })
+ },
+ [id],
+ )
+
+ return { preferences, updatePreferences }
+}
+
+export const CurrentProjectProvider = ({ children, id }: CurrentProjectProviderProps) => {
+ const project = useProject(id)
+ const { preferences, updatePreferences } = useProjectPreferences(id)
+ return (
+ <CurrentProjectContext.Provider value={{ id, project, preferences, updatePreferences }}>
+ {children}
+ </CurrentProjectContext.Provider>
+ )
+}
+
+export const useCurrentProject = () => {
+ const context = useContext(CurrentProjectContext)
+
+ if (context === undefined) {
+ throw new Error('useCurrentProject must be used within a CurrentProjectProvider')
+ }
+
+ return context
+}
diff --git a/web/app/pages/Project/View/utils/cache.ts b/web/app/pages/Project/View/utils/cache.ts
new file mode 100644
index 000000000..c474929b9
--- /dev/null
+++ b/web/app/pages/Project/View/utils/cache.ts
@@ -0,0 +1,50 @@
+import { isBrowser, LS_PROJECTS_PROTECTED_KEY, LS_VIEW_PREFS_SETTING } from '~/lib/constants'
+import { type Project } from '~/lib/models/Project'
+import { getItem, removeItem, setItem } from '~/utils/localstorage'
+
+import { ProjectPreferences } from '../providers/CurrentProjectProvider'
+
+import { filterInvalidViewPrefs } from './filters'
+
+export const getAllProjectPreferences = (): Record<string, ProjectPreferences> => {
+ if (!isBrowser) {
+ return {}
+ }
+
+ const storedPrefs = (getItem(LS_VIEW_PREFS_SETTING) as Record<string, ProjectPreferences>) || {}
+
+ try {
+ return filterInvalidViewPrefs(storedPrefs)
+ } catch {
+ removeItem(LS_VIEW_PREFS_SETTING)
+ }
+
+ return {}
+}
+
+export const getProjectPreferences = (id: Project['id']): ProjectPreferences => {
+ const preferences = getAllProjectPreferences()
+ return preferences?.[id] || {}
+}
+
+export const setProjectPreferences = (id: Project['id'], preferences: ProjectPreferences) => {
+ setItem(
+ LS_VIEW_PREFS_SETTING,
+ JSON.stringify({
+ ...getAllProjectPreferences(),
+ [id]: preferences,
+ }),
+ )
+}
+
+export const getAllProjectPasswords = () => (getItem(LS_PROJECTS_PROTECTED_KEY) as Record<string, string>) || {}
+
+export const setProjectPassword = (id: Project['id'], password: string) => {
+ setItem(
+ LS_PROJECTS_PROTECTED_KEY,
+ JSON.stringify({
+ ...getAllProjectPasswords(),
+ [id]: password,
+ }),
+ )
+}
diff --git a/web/app/routes/captchas.$id.tsx b/web/app/routes/captchas.$id.tsx
index 67b0d3859..01206f20a 100644
--- a/web/app/routes/captchas.$id.tsx
+++ b/web/app/routes/captchas.$id.tsx
@@ -1,7 +1,9 @@
import type { LinksFunction, LoaderFunctionArgs } from 'react-router'
import { useLoaderData } from 'react-router'
-import CaptchaView from '~/pages/Captcha/View'
+import { useRequiredParams } from '~/hooks/useRequiredParams'
+import ViewCaptcha from '~/pages/Captcha/View'
+import { CurrentProjectProvider } from '~/pages/Project/View/providers/CurrentProjectProvider'
import ProjectViewStyle from '~/styles/ProjectViewStyle.css?url'
import { detectTheme } from '~/utils/server'
@@ -17,6 +19,11 @@ export async function loader({ request }: LoaderFunctionArgs) {
export default function Index() {
const { theme } = useLoaderData<typeof loader>()
+ const { id } = useRequiredParams<{ id: string }>()
- return <CaptchaView ssrTheme={theme} />
+ return (
+ <CurrentProjectProvider id={id}>
+ <ViewCaptcha ssrTheme={theme} />
+ </CurrentProjectProvider>
+ )
}
diff --git a/web/app/routes/projects.$id.password.tsx b/web/app/routes/projects.$id.password.tsx
index 55b56caee..1da04e83e 100644
--- a/web/app/routes/projects.$id.password.tsx
+++ b/web/app/routes/projects.$id.password.tsx
@@ -2,18 +2,16 @@ import type { LoaderFunctionArgs } from 'react-router'
import { useLoaderData } from 'react-router'
import ProjectProtectedPassword from '~/pages/Project/ProjectProtectedPassword'
-import { detectTheme, isEmbedded, getProjectPassword, isAuthenticated } from '~/utils/server'
+import { detectTheme, isEmbedded, isAuthenticated } from '~/utils/server'
export async function loader({ request }: LoaderFunctionArgs) {
const embedded = isEmbedded(request)
- const queryPassword = getProjectPassword(request)
const [theme] = detectTheme(request)
const isAuth = isAuthenticated(request)
return {
theme,
embedded,
- queryPassword,
isAuth,
}
}
diff --git a/web/app/routes/projects.$id.tsx b/web/app/routes/projects.$id.tsx
index 259940cad..dfa65e5d1 100644
--- a/web/app/routes/projects.$id.tsx
+++ b/web/app/routes/projects.$id.tsx
@@ -1,10 +1,12 @@
import _split from 'lodash/split'
-import type { LinksFunction, LoaderFunctionArgs, MetaFunction } from 'react-router'
+import { type LinksFunction, type LoaderFunctionArgs, type MetaFunction } from 'react-router'
+import { useRequiredParams } from '~/hooks/useRequiredParams'
import { API_URL } from '~/lib/constants'
import ViewProject from '~/pages/Project/View'
+import { CurrentProjectProvider } from '~/pages/Project/View/providers/CurrentProjectProvider'
import ProjectViewStyle from '~/styles/ProjectViewStyle.css?url'
-import { detectTheme, isEmbedded, isAuthenticated, getProjectPassword, getProjectTabs } from '~/utils/server'
+import { detectTheme, isEmbedded, isAuthenticated, getProjectTabs } from '~/utils/server'
export const links: LinksFunction = () => [{ rel: 'stylesheet', href: ProjectViewStyle }]
@@ -21,7 +23,6 @@ export const meta: MetaFunction = ({ location }) => {
export async function loader({ request }: LoaderFunctionArgs) {
const embedded = isEmbedded(request)
- const queryPassword = getProjectPassword(request)
const [theme] = detectTheme(request)
const isAuth = isAuthenticated(request)
const tabs = getProjectTabs(request)
@@ -30,11 +31,16 @@ export async function loader({ request }: LoaderFunctionArgs) {
theme,
embedded,
isAuth,
- queryPassword,
tabs,
}
}
export default function Index() {
- return <ViewProject />
+ const { id } = useRequiredParams<{ id: string }>()
+
+ return (
+ <CurrentProjectProvider id={id}>
+ <ViewProject />
+ </CurrentProjectProvider>
+ )
}
diff --git a/web/app/utils/localstorage.ts b/web/app/utils/localstorage.ts
index bc27e498c..f62e0c5a8 100644
--- a/web/app/utils/localstorage.ts
+++ b/web/app/utils/localstorage.ts
@@ -7,12 +7,9 @@ import { isBrowser } from '~/lib/constants'
* how any localStorage item was modified after first access
*/
-type currentLocalStorageType = Record<string, string | null>
-const currentLocalStorage: currentLocalStorageType = {}
+const currentLocalStorage: Record<string, string> = {}
-type setItemType = (key: string, value: string) => void
-
-export const setItem: setItemType = (key, value) => {
+export const setItem = (key: string, value: string) => {
currentLocalStorage[key] = value
if (!isBrowser) {
@@ -22,18 +19,20 @@ export const setItem: setItemType = (key, value) => {
localStorage.setItem(key, value)
}
-type getItemType = (key: string) => any
-
-export const getItem: getItemType = (key) => {
+export const getItem = (key: string): Record<string, any> | string | null => {
if (currentLocalStorage[key]) {
return currentLocalStorage[key]
}
if (!isBrowser) {
- return
+ return null
}
- const storedValue: any = localStorage.getItem(key)
+ const storedValue: string | null = localStorage.getItem(key)
+
+ if (storedValue === null) {
+ return null
+ }
try {
return JSON.parse(storedValue)
@@ -42,9 +41,7 @@ export const getItem: getItemType = (key) => {
}
}
-type removeItemType = (key: string) => void
-
-export const removeItem: removeItemType = (key) => {
+export const removeItem = (key: string) => {
delete currentLocalStorage[key]
if (!isBrowser) {
diff --git a/web/app/utils/server.ts b/web/app/utils/server.ts
index dadffdd46..9ad0a69a6 100644
--- a/web/app/utils/server.ts
+++ b/web/app/utils/server.ts
@@ -51,10 +51,6 @@ export function getProjectTabs(request: Request): string[] {
return _split(tabs, ',')
}
-export function getProjectPassword(request: Request): string | null {
- return new URL(request.url).searchParams.get('password')
-}
-
function getAccessToken(request: Request): string | null {
const cookie = request.headers.get('Cookie')
const accessToken = cookie?.match(/(?<=access_token=)[^;]*/)?.[0]