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.0 KB
Raw Blame
import { HogFunctionInvocationGlobals } from '../../../types'
import { TemplateTester } from '../../test/test-helpers'
import { template } from './taxonomy.template'

describe('taxonomy.template', () => {
    const tester = new TemplateTester(template)

    beforeEach(async () => {
        await tester.beforeEach()
    })

    const rename = async (namingConvention: string, eventName: string): Promise<string> => {
        const globals: HogFunctionInvocationGlobals = tester.createGlobals({
            event: { event: eventName, properties: {} },
        })
        const response = await tester.invoke({ namingConvention }, globals)
        expect(response.finished).toBe(true)
        expect(response.error).toBeUndefined()
        return (response.execResult as any).event
    }

    it.each([
        ['user_signed_up', 'userSignedUp'],
        ['User Logged In', 'userLoggedIn'],
        ['checkout-completed', 'checkoutCompleted'],
        ['userSignedUp', 'userSignedUp'],
        ['APIResponse', 'apiResponse'],
        ['api_response', 'apiResponse'],
    ])('converts %s to camelCase', async (input, expected) => {
        expect(await rename('camelCase', input)).toBe(expected)
    })

    it.each([
        ['user_signed_up', 'UserSignedUp'],
        ['user logged in', 'UserLoggedIn'],
        ['checkout-completed', 'CheckoutCompleted'],
        ['HTTPError', 'HttpError'],
    ])('converts %s to PascalCase', async (input, expected) => {
        expect(await rename('PascalCase', input)).toBe(expected)
    })

    it.each([
        ['userSignedUp', 'user_signed_up'],
        ['User Logged In', 'user_logged_in'],
        ['checkout-completed', 'checkout_completed'],
        ['URLChanged', 'url_changed'],
        ['viewedFAQ', 'viewed_faq'],
        ['caféOrder', 'café_order'],
    ])('converts %s to snake_case', async (input, expected) => {
        expect(await rename('snake_case', input)).toBe(expected)
    })

    it.each([
        ['userSignedUp', 'user-signed-up'],
        ['User Logged In', 'user-logged-in'],
        ['checkout_completed', 'checkout-completed'],
    ])('converts %s to kebab-case', async (input, expected) => {
        expect(await rename('kebab-case', input)).toBe(expected)
    })

    it.each([
        ['userSignedUp', 'user signed up'],
        ['checkout_completed', 'checkout completed'],
    ])('converts %s to spaces', async (input, expected) => {
        expect(await rename('spaces', input)).toBe(expected)
    })

    it('leaves the name alone for a convention outside the list', async () => {
        expect(await rename('spaces in between', 'user_signed_up')).toBe('user_signed_up')
    })

    it('leaves PostHog events and survey events untouched', async () => {
        expect(await rename('snake_case', '$pageview')).toBe('$pageview')
        expect(await rename('snake_case', 'survey sent')).toBe('survey sent')
    })

    it('leaves an oversized event name unchanged', async () => {
        const oversized = 'aVeryLongEventName'.repeat(20)
        expect(await rename('snake_case', oversized)).toBe(oversized)
    })
})