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 onboarding steps in the database

Blue Moused8d98286d2ba
diff --git a/backend/apps/cloud/src/user/entities/user.entity.ts b/backend/apps/cloud/src/user/entities/user.entity.ts
index 26ae0b149..48c6d3410 100644
--- a/backend/apps/cloud/src/user/entities/user.entity.ts
+++ b/backend/apps/cloud/src/user/entities/user.entity.ts
@@ -204,9 +204,15 @@ export enum TimeFormat {
}
export enum OnboardingStep {
+ LANGUAGE = 'language',
+ WELCOME = 'welcome',
+ FEATURE_TRAFFIC = 'feature_traffic',
+ FEATURE_ERRORS = 'feature_errors',
+ FEATURE_SESSIONS = 'feature_sessions',
CREATE_PROJECT = 'create_project',
SETUP_TRACKING = 'setup_tracking',
WAITING_FOR_EVENTS = 'waiting_for_events',
+ VERIFY_EMAIL = 'verify_email',
COMPLETED = 'completed',
}
@@ -390,7 +396,7 @@ export class User {
@Column({
type: 'enum',
enum: OnboardingStep,
- default: OnboardingStep.CREATE_PROJECT,
+ default: OnboardingStep.LANGUAGE,
})
onboardingStep: OnboardingStep
diff --git a/backend/apps/community/src/user/entities/user.entity.ts b/backend/apps/community/src/user/entities/user.entity.ts
index 6e8147c9d..16b5cedac 100644
--- a/backend/apps/community/src/user/entities/user.entity.ts
+++ b/backend/apps/community/src/user/entities/user.entity.ts
@@ -8,8 +8,14 @@ export enum TimeFormat {
export const DEFAULT_TIMEZONE = 'Etc/GMT'
export enum OnboardingStep {
+ LANGUAGE = 'language',
+ WELCOME = 'welcome',
+ FEATURE_TRAFFIC = 'feature_traffic',
+ FEATURE_ERRORS = 'feature_errors',
+ FEATURE_SESSIONS = 'feature_sessions',
CREATE_PROJECT = 'create_project',
SETUP_TRACKING = 'setup_tracking',
WAITING_FOR_EVENTS = 'waiting_for_events',
+ VERIFY_EMAIL = 'verify_email',
COMPLETED = 'completed',
}
diff --git a/backend/apps/community/src/user/user.service.ts b/backend/apps/community/src/user/user.service.ts
index 3a9a6d13b..157c4ab55 100644
--- a/backend/apps/community/src/user/user.service.ts
+++ b/backend/apps/community/src/user/user.service.ts
@@ -141,7 +141,7 @@ export class UserService {
timezone: DEFAULT_TIMEZONE,
timeFormat: TimeFormat['24-hour'],
showLiveVisitorsInTitle: 0,
- onboardingStep: OnboardingStep.CREATE_PROJECT,
+ onboardingStep: OnboardingStep.LANGUAGE,
hasCompletedOnboarding: 0,
apiKey: null,
},
diff --git a/backend/migrations/mysql/2026_02_06_onboarding_steps.sql b/backend/migrations/mysql/2026_02_06_onboarding_steps.sql
new file mode 100644
index 000000000..17d2b02d4
--- /dev/null
+++ b/backend/migrations/mysql/2026_02_06_onboarding_steps.sql
@@ -0,0 +1 @@
+ALTER TABLE user MODIFY COLUMN `onboardingStep` enum('language','welcome','feature_traffic','feature_errors','feature_sessions','create_project','setup_tracking','waiting_for_events','verify_email','completed') NOT NULL DEFAULT 'language';
diff --git a/web/app/lib/models/User.ts b/web/app/lib/models/User.ts
index 18a64b2a9..b72f4558e 100644
--- a/web/app/lib/models/User.ts
+++ b/web/app/lib/models/User.ts
@@ -23,10 +23,15 @@ enum PlanCode {
}
enum OnboardingStep {
+ LANGUAGE = 'language',
WELCOME = 'welcome',
+ FEATURE_TRAFFIC = 'feature_traffic',
+ FEATURE_ERRORS = 'feature_errors',
+ FEATURE_SESSIONS = 'feature_sessions',
CREATE_PROJECT = 'create_project',
SETUP_TRACKING = 'setup_tracking',
WAITING_FOR_EVENTS = 'waiting_for_events',
+ VERIFY_EMAIL = 'verify_email',
COMPLETED = 'completed',
}
diff --git a/web/app/pages/Onboarding/Onboarding.tsx b/web/app/pages/Onboarding/Onboarding.tsx
index 9b4bb5e48..5bea4f1fd 100644
--- a/web/app/pages/Onboarding/Onboarding.tsx
+++ b/web/app/pages/Onboarding/Onboarding.tsx
@@ -406,19 +406,33 @@ const Onboarding = () => {
const { t, i18n } = useTranslation('common')
const { theme } = useTheme()
const prefersReducedMotion = useReducedMotion()
- const { project: loaderProject, deviceInfo, metainfo } =
- useLoaderData<OnboardingLoaderData>()
+ const {
+ project: loaderProject,
+ deviceInfo,
+ metainfo,
+ onboardingStep: loaderStep,
+ } = useLoaderData<OnboardingLoaderData>()
const { user, loadUser, logout } = useAuth()
const { authMe } = useAuthProxy()
const navigate = useNavigate()
const fetcher = useFetcher<OnboardingActionData>()
+ const stepFetcher = useFetcher()
const lastHandledFetcherDataRef = useRef<OnboardingActionData | null>(null)
- const [currentStepIndex, setCurrentStepIndex] = useState(0)
+ const [currentStepIndex, setCurrentStepIndex] = useState(() => {
+ if (!loaderStep) return 0
+ if (loaderStep === 'waiting_for_events') {
+ return STEPS.indexOf('setup_tracking')
+ }
+ const index = STEPS.indexOf(loaderStep as OnboardingStep)
+ return index !== -1 ? index : 0
+ })
const [direction, setDirection] = useState(0)
const [projectName, setProjectName] = useState('')
const [project, setProject] = useState<Project | null>(loaderProject)
- const [isWaitingForEvents, setIsWaitingForEvents] = useState(false)
+ const [isWaitingForEvents, setIsWaitingForEvents] = useState(
+ () => loaderStep === 'waiting_for_events',
+ )
const [hasEvents, setHasEvents] = useState(false)
const [selectedLanguage, setSelectedLanguage] = useState(i18n.language)
@@ -449,7 +463,7 @@ const Onboarding = () => {
if (intent === 'create-project' && newProject) {
setTimeout(() => setProject(newProject), 0)
- goToStep('setup_tracking')
+ goToStep('setup_tracking', { persist: true })
} else if (intent === 'update-step') {
loadUser()
} else if (intent === 'complete-onboarding') {
@@ -474,24 +488,6 @@ const Onboarding = () => {
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [fetcher.data, fetcher.submit, loadUser, logout, navigate])
- useEffect(() => {
- if (user?.hasCompletedOnboarding) {
- navigate(routes.dashboard)
- return
- }
-
- if (user?.onboardingStep === 'setup_tracking' && project) {
- goToStep('setup_tracking')
- return
- }
-
- if (user?.onboardingStep === 'waiting_for_events' && project) {
- goToStep('setup_tracking')
- setIsWaitingForEvents(true)
- }
- // eslint-disable-next-line react-hooks/exhaustive-deps
- }, [user, navigate, project])
-
useEffect(() => {
if (!isWaitingForEvents || !project) return
@@ -511,28 +507,45 @@ const Onboarding = () => {
return () => clearInterval(interval)
}, [isWaitingForEvents, project, authMe])
- const goToStep = useCallback(
+ const persistStep = useCallback(
(step: OnboardingStep) => {
+ const formData = new FormData()
+ formData.set('intent', 'update-step')
+ formData.set('step', step)
+ stepFetcher.submit(formData, { method: 'post' })
+ },
+ [stepFetcher],
+ )
+
+ const goToStep = useCallback(
+ (step: OnboardingStep, { persist = false } = {}) => {
const newIndex = STEPS.indexOf(step)
setDirection(newIndex > currentStepIndex ? 1 : -1)
setCurrentStepIndex(newIndex)
+ if (persist) {
+ persistStep(step)
+ }
},
- [currentStepIndex],
+ [currentStepIndex, persistStep],
)
const goNext = useCallback(() => {
if (currentStepIndex < STEPS.length - 1) {
+ const nextStep = STEPS[currentStepIndex + 1]
setDirection(1)
setCurrentStepIndex((prev) => prev + 1)
+ persistStep(nextStep)
}
- }, [currentStepIndex])
+ }, [currentStepIndex, persistStep])
const goBack = useCallback(() => {
if (currentStepIndex > 0) {
+ const prevStep = STEPS[currentStepIndex - 1]
setDirection(-1)
setCurrentStepIndex((prev) => prev - 1)
+ persistStep(prevStep)
}
- }, [currentStepIndex])
+ }, [currentStepIndex, persistStep])
const handleLanguageSelect = (lng: string) => {
setSelectedLanguage(lng)
@@ -1008,48 +1021,56 @@ const Onboarding = () => {
{t('onboarding.confirm.title')}
</Text>
- <Text as='h2' size='lg' weight='semibold' className='mb-4 mt-8'>
- {t('onboarding.confirm.emailVerification')}
- </Text>
-
- <Alert variant='info' title={t('onboarding.confirm.verifyTitle')}>
- <Trans
- t={t}
- i18nKey='onboarding.confirm.linkSent'
- values={{ email: user?.email }}
- components={{
- email: <span className='font-semibold' />,
- }}
- />
- </Alert>
-
- <div className='mt-6'>
- <Text as='p' size='sm' colour='secondary' className='mb-2'>
- {t('onboarding.confirm.didNotReceive')}
- </Text>
- <Button
- onClick={handleResendEmail}
- disabled={hasResentEmail}
- secondary
- small
- >
- {hasResentEmail && (
- <CheckCircleIcon className='mr-2 size-4' />
- )}
- {hasResentEmail
- ? t('onboarding.confirm.emailResent')
- : t('onboarding.confirm.resend')}
- </Button>
- </div>
+ {user?.isActive ? (
+ <Alert variant='success' className='mt-8'>
+ {t('onboarding.confirm.emailVerified')}
+ </Alert>
+ ) : (
+ <>
+ <Text as='h2' size='lg' weight='semibold' className='mb-4 mt-8'>
+ {t('onboarding.confirm.emailVerification')}
+ </Text>
+
+ <Alert variant='info' title={t('onboarding.confirm.verifyTitle')}>
+ <Trans
+ t={t}
+ i18nKey='onboarding.confirm.linkSent'
+ values={{ email: user?.email }}
+ components={{
+ email: <span className='font-semibold' />,
+ }}
+ />
+ </Alert>
+
+ <div className='mt-6'>
+ <Text as='p' size='sm' colour='secondary' className='mb-2'>
+ {t('onboarding.confirm.didNotReceive')}
+ </Text>
+ <Button
+ onClick={handleResendEmail}
+ disabled={hasResentEmail}
+ secondary
+ small
+ >
+ {hasResentEmail && (
+ <CheckCircleIcon className='mr-2 size-4' />
+ )}
+ {hasResentEmail
+ ? t('onboarding.confirm.emailResent')
+ : t('onboarding.confirm.resend')}
+ </Button>
+ </div>
- <div className='mt-6'>
- <Text as='p' size='sm' colour='secondary' className='mb-2'>
- {t('onboarding.confirm.troubleOrChange')}
- </Text>
- <Button onClick={handleDeleteAccount} secondary small>
- {t('onboarding.confirm.logoutAndRegister')}
- </Button>
- </div>
+ <div className='mt-6'>
+ <Text as='p' size='sm' colour='secondary' className='mb-2'>
+ {t('onboarding.confirm.troubleOrChange')}
+ </Text>
+ <Button onClick={handleDeleteAccount} secondary small>
+ {t('onboarding.confirm.logoutAndRegister')}
+ </Button>
+ </div>
+ </>
+ )}
</div>
)}
</motion.div>
@@ -1058,11 +1079,13 @@ const Onboarding = () => {
<div className='shrink-0 border-t border-gray-200 px-6 py-4 dark:border-white/10'>
<div className='flex items-center justify-end gap-3'>
- {currentStepIndex > 0 && (
- <Button onClick={goBack} secondary large>
- {t('common.back')}
- </Button>
- )}
+ {currentStepIndex > 0 &&
+ STEPS.indexOf(currentStep) <
+ STEPS.indexOf('setup_tracking') && (
+ <Button onClick={goBack} secondary large>
+ {t('common.back')}
+ </Button>
+ )}
{currentStep === 'language' && (
<Button onClick={handleLanguageConfirm} primary large>
{t('common.next')}
diff --git a/web/app/routes/onboarding.tsx b/web/app/routes/onboarding.tsx
index 2c347a490..de434ce3c 100644
--- a/web/app/routes/onboarding.tsx
+++ b/web/app/routes/onboarding.tsx
@@ -4,7 +4,7 @@ import type {
LoaderFunctionArgs,
MetaFunction,
} from 'react-router'
-import { data } from 'react-router'
+import { data, redirect } from 'react-router'
import { SitemapFunction } from 'remix-sitemap'
import { getAuthenticatedUser, serverFetch } from '~/api/api.server'
@@ -40,6 +40,7 @@ export interface OnboardingLoaderData {
os: string | null
}
metainfo: Metainfo
+ onboardingStep: string | null
}
export async function loader({ request }: LoaderFunctionArgs) {
@@ -71,9 +72,22 @@ export async function loader({ request }: LoaderFunctionArgs) {
const metainfo = metainfoResult.data ?? DEFAULT_METAINFO
const allCookies = [...cookies, ...metainfoResult.cookies]
+ if (user?.user?.hasCompletedOnboarding) {
+ if (allCookies.length > 0) {
+ return redirect('/dashboard', {
+ headers: createHeadersWithCookies(allCookies),
+ })
+ }
+
+ return redirect('/dashboard')
+ }
+
+ const onboardingStep = user?.user?.onboardingStep as string | undefined
+
if (
- user?.user?.onboardingStep === 'setup_tracking' ||
- user?.user?.onboardingStep === 'waiting_for_events'
+ onboardingStep === 'setup_tracking' ||
+ onboardingStep === 'waiting_for_events' ||
+ onboardingStep === 'verify_email'
) {
const projectsResult = await serverFetch<{
results: Project[]
@@ -83,7 +97,7 @@ export async function loader({ request }: LoaderFunctionArgs) {
const project = projectsResult.data?.results?.[0] || null
const finalCookies = [...allCookies, ...projectsResult.cookies]
- const loaderData: OnboardingLoaderData = { project, deviceInfo, metainfo }
+ const loaderData: OnboardingLoaderData = { project, deviceInfo, metainfo, onboardingStep: onboardingStep ?? null }
if (finalCookies.length > 0) {
return data(loaderData, {
@@ -96,14 +110,14 @@ export async function loader({ request }: LoaderFunctionArgs) {
if (allCookies.length > 0) {
return data(
- { project: null, deviceInfo, metainfo } as OnboardingLoaderData,
+ { project: null, deviceInfo, metainfo, onboardingStep: onboardingStep ?? null } as OnboardingLoaderData,
{
headers: createHeadersWithCookies(allCookies),
},
)
}
- return { project: null, deviceInfo, metainfo } as OnboardingLoaderData
+ return { project: null, deviceInfo, metainfo, onboardingStep: onboardingStep ?? null } as OnboardingLoaderData
}
export interface OnboardingActionData {
diff --git a/web/public/locales/en.json b/web/public/locales/en.json
index 2279082d7..26d581e3b 100644
--- a/web/public/locales/en.json
+++ b/web/public/locales/en.json
@@ -2115,6 +2115,7 @@
"troubleOrChange": "Do you have trouble or want to change your email address?",
"logoutAndRegister": "Logout and register again",
"letsGo": "Let's go!",
+ "emailVerified": "Your email is verified",
"spam": "Can't see the email? Please check your spam folder.",
"wrongEmail": "Wrong email? <url>Create a new account.</url>",
"checkVerification": "I've verified my email"