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.8 KB
Raw Blame
import { SetupGuideInputs, deriveSetupGuideSteps } from './setupGuideSteps'

const LOADED: SetupGuideInputs = {
    emailChannels: [],
    pushChannelCount: 0,
    reachChannels: null,
    optOutCategoryCount: 0,
    emailTemplateCount: 0,
    hasMessagingWorkflow: false,
}

describe('deriveSetupGuideSteps', () => {
    test.each<[string, Partial<SetupGuideInputs>]>([
        ['email channels', { emailChannels: null }],
        ['push channels', { pushChannelCount: null }],
        ['opt-out categories', { optOutCategoryCount: null }],
        ['email templates', { emailTemplateCount: null }],
        ['messaging workflows', { hasMessagingWorkflow: null }],
    ])('is unknown while %s are loading', (_, missing) => {
        expect(deriveSetupGuideSteps({ ...LOADED, ...missing })).toBeNull()
    })

    test.each<[string, Partial<SetupGuideInputs>, string[]]>([
        ['nothing set up', {}, []],
        [
            'an unverified channel completes only the channel step',
            { emailChannels: [{ verified: false }] },
            ['channel'],
        ],
        [
            'one verified channel among several completes the domain step',
            { emailChannels: [{ verified: false }, { verified: true }] },
            ['channel', 'domain'],
        ],
        [
            'everything set up',
            {
                emailChannels: [{ verified: true }],
                optOutCategoryCount: 2,
                emailTemplateCount: 1,
                hasMessagingWorkflow: true,
            },
            ['channel', 'domain', 'opt-outs', 'email-template', 'first-journey'],
        ],
    ])('%s', (_, inputs, expectedDone) => {
        const steps = deriveSetupGuideSteps({ ...LOADED, ...inputs })
        expect(steps?.filter((step) => step.done).map((step) => step.key)).toEqual(expectedDone)
    })

    test.each<[string, Partial<SetupGuideInputs>, string[]]>([
        [
            'a push-only project skips the email steps',
            { pushChannelCount: 1 },
            ['channel', 'opt-outs', 'first-journey'],
        ],
        [
            'picking push only skips the email steps before anything is connected',
            { reachChannels: ['push'] },
            ['channel', 'opt-outs', 'first-journey'],
        ],
        [
            'a connected email channel keeps the email steps even when only push was picked',
            { emailChannels: [{ verified: false }], reachChannels: ['push'] },
            ['channel', 'domain', 'opt-outs', 'email-template', 'first-journey'],
        ],
        [
            'nothing picked or connected keeps the email steps',
            {},
            ['channel', 'domain', 'opt-outs', 'email-template', 'first-journey'],
        ],
    ])('%s', (_, inputs, expectedKeys) => {
        expect(deriveSetupGuideSteps({ ...LOADED, ...inputs })?.map((step) => step.key)).toEqual(expectedKeys)
    })
})