Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

3.4 KB
Raw Blame
import { useActions, useValues } from 'kea'
import posthog from 'posthog-js'
import { useState } from 'react'

import { LemonTag } from '@posthog/lemon-ui'

import { RestrictionScope, useRestrictedArea } from 'lib/components/RestrictedArea'
import { TeamMembershipLevel } from 'lib/constants'
import { LemonButton } from 'lib/lemon-ui/LemonButton'
import { LemonRadio, LemonRadioOption } from 'lib/lemon-ui/LemonRadio'
import { eventUsageLogic } from 'lib/utils/eventUsageLogic'
import { teamLogic } from 'scenes/teamLogic'

import { HogQLQueryModifiers } from '~/queries/schema/schema-general'

type PoEMode = NonNullable<HogQLQueryModifiers['personsOnEventsMode']>

const POE_OPTIONS: LemonRadioOption<PoEMode>[] = [
    {
        value: 'person_id_override_properties_on_events',
        label: (
            <span className="inline-flex items-center gap-1.5">
                Use person properties from the time of the event<LemonTag>RECOMMENDED</LemonTag>
            </span>
        ),
        description: (
            <>
                Fast queries. If the person property is updated, query results on past data <em>won't</em> change.
            </>
        ),
    },
    {
        value: 'person_id_override_properties_joined',
        label: 'Use person properties as of running the query',
        description: (
            <>
                Slower queries. If the person property is updated, query results on past data <em>will</em> change
                accordingly.
            </>
        ),
    },
    {
        value: 'person_id_no_override_properties_on_events',
        label: 'Use person IDs and person properties from the time of the event',
        description: (
            <>
                Fastest queries,{' '}
                <span className="underline">but funnels and unique user counts will be inaccurate</span>. If the person
                property is updated, query results on past data <em>won't</em> change.
            </>
        ),
    },
]

export function PersonsOnEvents(): JSX.Element {
    const { updateCurrentTeam } = useActions(teamLogic)
    const { reportPoEModeUpdated } = useActions(eventUsageLogic)
    const { currentTeam } = useValues(teamLogic)
    const savedPoEMode: PoEMode =
        currentTeam?.modifiers?.personsOnEventsMode ?? currentTeam?.default_modifiers?.personsOnEventsMode ?? 'disabled'
    const [poeMode, setPoeMode] = useState<PoEMode>(savedPoEMode)
    const restrictedReason = useRestrictedArea({
        scope: RestrictionScope.Project,
        minimumAccessLevel: TeamMembershipLevel.Admin,
    })
    const poeOptions = POE_OPTIONS.map((o) => ({ ...o, disabledReason: restrictedReason ?? undefined }))

    const handleChange = (mode: PoEMode): void => {
        updateCurrentTeam({ modifiers: { ...currentTeam?.modifiers, personsOnEventsMode: mode } })
        posthog.capture('user changed personsOnEventsMode setting', { personsOnEventsMode: mode })
        reportPoEModeUpdated(mode)
    }

    return (
        <>
            <LemonRadio value={poeMode} onChange={setPoeMode} options={poeOptions} />
            <div className="mt-4">
                <LemonButton
                    type="primary"
                    onClick={() => handleChange(poeMode)}
                    disabledReason={poeMode === savedPoEMode ? 'No changes to save' : restrictedReason}
                >
                    Save
                </LemonButton>
            </div>
        </>
    )
}