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.

4.0 KB
Raw Blame
import { NodeKind, QuerySchema, WebStatsBreakdown } from '~/queries/schema/schema-general'

import { TileId, WebAnalyticsTile } from './common'
import { getNewInsightUrlFactory, getNewInsightUrlForQuery } from './insightsUtils'
import { applyWebQueryModifiers, withWebQueryModifiers } from './webQueryModifiers'

const overview: QuerySchema = {
    kind: NodeKind.WebOverviewQuery,
    properties: [],
    useWebAnalyticsPrecompute: true,
}
const statsTable: QuerySchema = {
    kind: NodeKind.DataTableNode,
    source: { kind: NodeKind.WebStatsTableQuery, properties: [], breakdownBy: WebStatsBreakdown.Page },
}
const trends: QuerySchema = {
    kind: NodeKind.InsightVizNode,
    source: { kind: NodeKind.TrendsQuery, series: [] },
}
const webVitals: QuerySchema = {
    kind: NodeKind.WebVitalsQuery,
    properties: [],
    source: { kind: NodeKind.TrendsQuery, series: [] },
}

const layout = { colSpanClassName: 'md:col-span-full' as const }
const insightProps = { dashboardItemId: 'new-test' as const }

const tiles: WebAnalyticsTile[] = [
    { kind: 'query', tileId: TileId.OVERVIEW, layout, query: overview, insightProps },
    {
        kind: 'section',
        tileId: TileId.PATHS,
        layout,
        tiles: [
            {
                kind: 'tabs',
                tileId: TileId.PATHS,
                layout,
                activeTabId: 'paths',
                setTabId: () => {},
                tabs: [{ id: 'paths', title: 'Paths', linkText: 'Paths', query: statsTable, insightProps }],
            },
        ],
    },
    { kind: 'query', tileId: TileId.GRAPHS, layout, query: trends, insightProps },
    { kind: 'replay', tileId: TileId.REPLAY, layout },
    { kind: 'query', tileId: TileId.WEB_VITALS, layout, query: webVitals, insightProps },
]

describe('webQueryModifiers', () => {
    it('keeps the same tiles when there are no modifiers', () => {
        expect(applyWebQueryModifiers(tiles, {})).toBe(tiles)
    })

    it('sets the modifiers on web analytics queries only, including wrapped sources inside sections and tabs', () => {
        const [overviewTile, sectionTile, trendsTile, replayTile, webVitalsTile] = applyWebQueryModifiers(tiles, {
            useDimensionalTables: true,
        })

        expect(overviewTile).toMatchObject({
            query: { useWebAnalyticsPrecompute: true, webQueryModifiers: { useDimensionalTables: true } },
        })
        expect(sectionTile).toMatchObject({
            tiles: [{ tabs: [{ query: { source: { webQueryModifiers: { useDimensionalTables: true } } } }] }],
        })
        // TrendsQuery does not accept the field, so the backend would reject the whole tile.
        expect(trendsTile).toMatchObject({ query: { source: trends.source } })
        expect((trendsTile as { query: { source: object } }).query.source).not.toHaveProperty('webQueryModifiers')
        expect(replayTile).toBe(tiles[3])
        expect(webVitalsTile).toMatchObject({ query: { webQueryModifiers: { useDimensionalTables: true } } })
        expect((webVitalsTile as { query: { source: object } }).query.source).not.toHaveProperty('webQueryModifiers')
    })

    it.each([[TileId.OVERVIEW], [TileId.WEB_VITALS]])(
        'leaves the modifiers out of the new insight url for %s',
        (tileId) => {
            const getNewInsightUrl = getNewInsightUrlFactory(
                applyWebQueryModifiers(tiles, { useDimensionalTables: true })
            )

            const url = decodeURIComponent(getNewInsightUrl(tileId) ?? '')

            expect(url).toContain('/insights/new')
            expect(url).not.toContain('webQueryModifiers')
        }
    )

    it.each([
        ['overview', overview],
        ['stats table', statsTable],
    ])('leaves the modifiers out of the modal new insight url for the %s', (_, query) => {
        const url = decodeURIComponent(
            getNewInsightUrlForQuery(withWebQueryModifiers(query, { useDimensionalTables: true }))
        )

        expect(url).toContain('/insights/new')
        expect(url).not.toContain('webQueryModifiers')
    })
})