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.

8.9 KB
Raw Blame
import { useActions, useValues } from 'kea'
import { useMemo } from 'react'

import { IconClock, IconInfo } from '@posthog/icons'
import { LemonBanner, LemonButton, LemonDialog, LemonDivider, LemonModal, Link, Tooltip } from '@posthog/lemon-ui'

import { dayjs } from 'lib/dayjs'
import { More } from 'lib/lemon-ui/LemonButton/More'
import { Spinner } from 'lib/lemon-ui/Spinner'
import { experimentTimeseriesLogic } from 'scenes/experiments/experimentTimeseriesLogic'
import { VariantTag } from 'scenes/experiments/ExperimentView/VariantTag'
import { ElapsedTime } from 'scenes/experiments/MetricsView/new/ElapsedTime'
import { VariantTimeseriesChart } from 'scenes/experiments/MetricsView/new/VariantTimeseriesChart'
import { MetricTitle } from 'scenes/experiments/MetricsView/shared/MetricTitle'
import { ExperimentVariantResult } from 'scenes/experiments/MetricsView/shared/utils'
import { urls } from 'scenes/urls'

import { ExperimentMetric, isExperimentRatioMetric } from '~/queries/schema/schema-general'
import type { Experiment } from '~/types'

import { EXPERIMENT_RECALCULATION_MAX_AGE_DAYS } from 'products/experiments/frontend/constants'
import { hasEnded, isLaunched } from 'products/experiments/frontend/experimentStatus'

interface TimeseriesModalProps {
    isOpen: boolean
    onClose: () => void
    metric: ExperimentMetric
    variantResult: ExperimentVariantResult
    experiment: Experiment
}

export function TimeseriesModal({
    isOpen,
    onClose,
    metric,
    variantResult,
    experiment,
}: TimeseriesModalProps): JSX.Element {
    const logic = experimentTimeseriesLogic({ experiment, metric: isOpen ? metric : undefined })
    const { chartData, progressMessage, hasTimeseriesData, timeseriesLoading, isRecalculating, timeseries } =
        useValues(logic)
    const { recalculateTimeseries, loadTimeseries } = useActions(logic)

    const processedChartData = useMemo(() => {
        return chartData(variantResult.key)
    }, [chartData, variantResult.key])

    const isStaleExperiment =
        isLaunched(experiment) && !hasEnded(experiment)
            ? dayjs(experiment.start_date).isBefore(dayjs().subtract(EXPERIMENT_RECALCULATION_MAX_AGE_DAYS, 'days'))
            : false

    const handleRecalculate = (): void => {
        LemonDialog.open({
            title: 'Recalculate timeseries data',
            content: (
                <div>
                    <p>
                        All existing timeseries data will be deleted and recalculated from scratch. This could take a
                        long time for large datasets.
                    </p>
                </div>
            ),
            primaryButton: {
                children: 'Recalculate',
                type: 'primary',
                onClick: () => recalculateTimeseries({ metric }),
            },
            secondaryButton: {
                children: 'Cancel',
            },
        })
    }

    return (
        <LemonModal
            isOpen={isOpen}
            onClose={onClose}
            width={1000}
            title={
                <div className="flex items-center gap-2 text-sm min-w-0">
                    <div className="flex items-center shrink-0">
                        <span>Time series</span>
                    </div>
                    <LemonDivider vertical className="h-4 self-stretch shrink-0" />
                    <div className="min-w-0 [&_span]:!line-clamp-1">
                        <MetricTitle metric={metric} />
                    </div>
                    <LemonDivider vertical className="h-4 self-stretch shrink-0" />
                    <div className="flex items-center shrink-0">
                        <VariantTag variantKey={variantResult.key} />
                    </div>
                </div>
            }
            footer={
                <LemonButton type="secondary" onClick={onClose}>
                    Close
                </LemonButton>
            }
        >
            <div>
                {timeseriesLoading ? (
                    <div
                        className="flex items-center justify-center gap-2 text-[14px] font-normal"
                        //eslint-disable-next-line react/forbid-dom-props
                        style={{ height: '200px' }}
                    >
                        <Spinner className="text-lg" />
                        <span>Loading timeseries&hellip;</span>
                    </div>
                ) : (
                    <div>
                        {isStaleExperiment && !isRecalculating && (
                            <div className="mb-2">
                                <LemonBanner type="warning">
                                    <div className="flex items-center justify-between">
                                        <div className="flex-1">
                                            <div className="text-sm">
                                                This experiment has been running for more than{' '}
                                                {EXPERIMENT_RECALCULATION_MAX_AGE_DAYS} days. Automatic timeseries
                                                updates are disabled. You can still manually recalculate the data.
                                            </div>
                                        </div>
                                        <LemonButton
                                            type="secondary"
                                            size="small"
                                            onClick={handleRecalculate}
                                            className="ml-4"
                                        >
                                            Recalculate
                                        </LemonButton>
                                    </div>
                                </LemonBanner>
                            </div>
                        )}
                        {isRecalculating && (
                            <div className="mb-4">
                                <LemonBanner type="info">
                                    <div className="flex items-center justify-between">
                                        <div className="flex items-center gap-2">
                                            <Spinner className="text-sm" />
                                            <span>
                                                Recalculating •{' '}
                                                <ElapsedTime startTime={timeseries?.recalculation_created_at} /> elapsed
                                                •
                                            </span>
                                            <Link onClick={() => loadTimeseries({ metric })}>Refresh</Link>
                                        </div>
                                    </div>
                                </LemonBanner>
                            </div>
                        )}
                        <div className="flex justify-between items-center mt-2 mb-4">
                            <div className="flex items-center gap-1">
                                <div className="text-xs text-muted">{progressMessage || ''}</div>
                                {progressMessage && (
                                    <Tooltip title="The chart displays data starting from the first day with meaningful results. Earlier days without sufficient data are excluded from the visualization.">
                                        <IconInfo className="text-muted text-base" />
                                    </Tooltip>
                                )}
                            </div>
                            <More
                                overlay={
                                    <>
                                        <LemonButton onClick={handleRecalculate}>Recalculate</LemonButton>
                                    </>
                                }
                            />
                        </div>
                        {hasTimeseriesData && processedChartData ? (
                            <VariantTimeseriesChart
                                chartData={processedChartData}
                                isRatioMetric={isExperimentRatioMetric(metric)}
                            />
                        ) : (
                            <div className="py-10 text-center text-muted flex flex-col items-center gap-2 max-w-80 mx-auto">
                                <IconClock className="text-2xl" />
                                <div>
                                    Timeseries data is calculated once per day. Check your calculation time in{' '}
                                    <Link to={`${urls.experiments()}?tab=settings`} target="_blank">
                                        settings
                                    </Link>
                                    .
                                </div>
                            </div>
                        )}
                    </div>
                )}
            </div>
        </LemonModal>
    )
}