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.

5.6 KB
Raw Blame
import './LiveEventsTable.scss'

import clsx from 'clsx'
import { type ReactNode, useMemo } from 'react'

import { IconPauseFilled } from '@posthog/icons'
import { Spinner, Tooltip } from '@posthog/lemon-ui'

import { PropertyKeyInfo } from 'lib/components/PropertyKeyInfo'
import { TaxonomicFilterGroupType } from 'lib/components/TaxonomicFilter/types'
import { TZLabel } from 'lib/components/TZLabel'
import ViewRecordingButton, { RecordingPlayerType } from 'lib/components/ViewRecordingButton/ViewRecordingButton'
import { More } from 'lib/lemon-ui/LemonButton/More'
import { LemonTable, LemonTableColumn } from 'lib/lemon-ui/LemonTable'

import { EventCopyLinkButton } from '~/queries/nodes/DataTable/EventRowActions'
import { LiveEvent } from '~/types'

import { PersonDisplay } from 'products/persons/frontend/components/PersonDisplay'

export type LiveEventsFeedColumn = 'event' | 'person' | 'url' | 'recording' | 'timestamp' | 'more'

const ALL_COLUMNS: LiveEventsFeedColumn[] = ['event', 'person', 'url', 'recording', 'timestamp', 'more']

export function getWebAnalyticsLiveFeedColumns(sessionRecordingOptIn: boolean): LiveEventsFeedColumn[] {
    return sessionRecordingOptIn
        ? ['event', 'person', 'url', 'timestamp', 'recording']
        : ['event', 'person', 'url', 'timestamp']
}

const COLUMN_DEFINITIONS: Record<LiveEventsFeedColumn, LemonTableColumn<LiveEvent, keyof LiveEvent | undefined>> = {
    event: {
        title: 'Event',
        key: 'event',
        className: 'max-w-80',
        render: function Render(_, event: LiveEvent) {
            return <PropertyKeyInfo value={event.event} type={TaxonomicFilterGroupType.Events} />
        },
    },
    person: {
        title: 'Person distinct ID',
        tooltip:
            'Some events may be missing a person profile – this is expected, because live events are streamed before person processing completes',
        key: 'person' as any,
        className: 'max-w-80',
        render: function Render(_, event: LiveEvent) {
            return <PersonDisplay person={{ distinct_id: event.distinct_id }} />
        },
    },
    url: {
        title: 'URL / Screen',
        key: '$current_url' as any,
        className: 'max-w-80',
        render: function Render(_, event: LiveEvent) {
            return (
                <span>
                    {event.properties['$current_url'] ||
                        event.properties['$screen_name'] ||
                        event.properties['$pathname']}
                </span>
            )
        },
    },
    recording: {
        title: '',
        key: 'recording' as any,
        width: 56,
        render: function Render(_, event: LiveEvent) {
            const sessionId = event.properties.$session_id
            if (typeof sessionId !== 'string' || !sessionId) {
                return null
            }
            return (
                <ViewRecordingButton
                    iconOnly
                    sessionId={sessionId}
                    timestamp={event.timestamp}
                    openPlayerIn={RecordingPlayerType.NewTab}
                    size="xsmall"
                    type="secondary"
                    data-attr="live-events-feed-watch"
                />
            )
        },
    },
    timestamp: {
        title: 'Time',
        key: 'timestamp',
        className: 'max-w-80',
        render: function Render(_, event: LiveEvent) {
            return <TZLabel time={event.timestamp} />
        },
    },
    more: {
        dataIndex: '__more' as any,
        render: function Render(_, event: LiveEvent) {
            return (
                <More
                    overlay={
                        <Tooltip title="It may take up to a few minutes for the event to show up in the Explore view">
                            <EventCopyLinkButton event={event} />
                        </Tooltip>
                    }
                />
            )
        },
        width: 0,
    },
}

export interface LiveEventsFeedProps {
    events: LiveEvent[]
    columns?: LiveEventsFeedColumn[]
    emptyState?: ReactNode
    streamPaused?: boolean
    className?: string
}

export function LiveEventsFeed({
    events,
    columns = ALL_COLUMNS,
    emptyState,
    streamPaused = false,
    className,
}: LiveEventsFeedProps): JSX.Element {
    const tableColumns = useMemo(() => columns.map((col) => COLUMN_DEFINITIONS[col]), [columns])

    const defaultEmptyState = (
        <div className="flex flex-col justify-center items-center gap-4 p-6">
            {!streamPaused ? <Spinner className="text-4xl" textColored /> : <IconPauseFilled className="text-4xl" />}
            <span className="text-lg font-title font-semibold leading-tight">
                {!streamPaused ? 'Waiting for events…' : 'Stream paused'}
            </span>
        </div>
    )

    return (
        <LemonTable
            className={clsx('LiveEventsTable__table', className)}
            columns={tableColumns}
            data-attr="live-events-table"
            rowKey="uuid"
            // Each incoming batch re-keys the whole feed, so React removes and reorders row text on
            // almost every streaming update. On a translated page each of those text nodes is a
            // `<font>` wrapper React does not own, and the commit throws (react#11538). Rows hold
            // event names, distinct IDs, URLs, and timestamps, so nothing here needs translation.
            // The column headers stay outside the opt-out and stay translatable.
            onRow={() => ({ translate: 'no' })}
            dataSource={events}
            useURLForSorting={false}
            emptyState={emptyState ?? defaultEmptyState}
            nouns={['event', 'events']}
        />
    )
}