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.

2.4 KB
Raw Blame
import { escapePropertyAsHogQLIdentifier } from 'lib/utils/hogql'
import { getDefaultEventsSceneQuery } from 'scenes/activity/explore/defaults'

import { EventsQuery, NodeKind } from '~/queries/schema/schema-general'
import { TeamType } from '~/types'

/** Indicates HogQL usage if team.live_events_columns = [HOGQL_COLUMNS_KEY, ...] */
export const HOGQL_COLUMNS_KEY = '--v2:hogql'

export function cleanLiveEventsColumns(columns: string[]): string[] {
    // new columns
    if (columns.length > 0 && columns[0] === HOGQL_COLUMNS_KEY) {
        return columns.slice(1)
    }
    // legacy columns
    return [
        '*',
        ...columns.map((column) => {
            if (column === 'event' || column === 'person') {
                return column
            }
            if (column === 'url') {
                return 'coalesce(properties.$current_url, properties.$screen_name) -- Url / Screen'
            }
            if (column === 'source') {
                return 'properties.$lib'
            }
            return `properties.${escapePropertyAsHogQLIdentifier(String(column))}`
        }),
        'timestamp',
    ]
}

export function getDefaultEventsQueryForTeam(team: Partial<TeamType>): EventsQuery | null {
    const liveColumns = team?.live_events_columns ? cleanLiveEventsColumns(team.live_events_columns) : null

    // Always prepend '*' — the column configurator saves `live_events_columns` without it
    // (see ColumnConfigurator.tsx), but the row-expand toggle relies on '*' being present in
    // the response columns.
    const select = liveColumns ? (liveColumns.includes('*') ? liveColumns : ['*', ...liveColumns]) : null

    return select
        ? {
              kind: NodeKind.EventsQuery,
              select,
              after: '-1h',
              orderBy: select.includes('timestamp') ? ['timestamp DESC'] : [],
          }
        : null
}

export function getEventsQueriesForTeam(team: Partial<TeamType>): Record<string, EventsQuery> {
    const projectDefault = getDefaultEventsQueryForTeam(team)
    return {
        ...(projectDefault ? { 'Project default view': projectDefault } : {}),
        'PostHog default view': getDefaultEventsSceneQuery().source as EventsQuery,
        'Event counts view': {
            kind: NodeKind.EventsQuery,
            select: ['event', 'count()'],
            after: '-1h',
            orderBy: ['count() DESC'],
        } as EventsQuery,
    }
}