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.9 KB
Raw Blame
import { MOCK_DEFAULT_USER } from 'lib/api.mock'

import { preflightLogic } from 'lib/logic/preflightLogic'
import { userLogic } from 'scenes/userLogic'

import { initKeaTests } from '~/test/init'
import type { UserType } from '~/types'

import { debugLogsLogic } from './debugLogsLogic'

describe('debugLogsLogic', () => {
    let logic: ReturnType<typeof debugLogsLogic.build>

    function setup({ user, isDev }: { user: Partial<UserType>; isDev: boolean }): void {
        userLogic.mount()
        userLogic.actions.loadUserSuccess({
            ...MOCK_DEFAULT_USER,
            is_staff: false,
            is_impersonated: false,
            ...user,
        } as UserType)
        preflightLogic.mount()
        preflightLogic.actions.loadPreflightSuccess({ is_debug: isDev } as any)
        logic = debugLogsLogic()
        logic.mount()
    }

    beforeEach(() => {
        localStorage.clear()
        initKeaTests()
    })

    afterEach(() => {
        logic?.unmount()
    })

    it('hides debug logs for staff with no stored preference until explicitly enabled', () => {
        setup({ user: { is_staff: true }, isDev: false })
        expect(logic.values.debugLogsEnabled).toBe(false)
        expect(logic.values.showDebugLogs).toBe(false)
    })

    it('ignores a value left under a superseded storage key', () => {
        localStorage.setItem('posthog_ai.debugLogsEnabled', 'true')
        setup({ user: { is_staff: true }, isDev: false })
        expect(logic.values.debugLogsEnabled).toBe(false)
        expect(logic.values.showDebugLogs).toBe(false)
    })

    it('offers no toggle to a staff user who is also impersonating, but still forces logs on', () => {
        // The toggle would be a no-op during impersonation (logs are force-shown), so it must not render.
        setup({ user: { is_staff: true, is_impersonated: true }, isDev: false })
        expect(logic.values.canControlDebugLogs).toBe(false)
        expect(logic.values.showDebugLogs).toBe(true)
    })

    it.each([
        { name: 'staff, toggle on', user: { is_staff: true }, isDev: false, enabled: true, expected: true },
        { name: 'staff, toggle off', user: { is_staff: true }, isDev: false, enabled: false, expected: false },
        { name: 'local dev, toggle on', user: {}, isDev: true, enabled: true, expected: true },
        { name: 'local dev, toggle off', user: {}, isDev: true, enabled: false, expected: false },
        {
            name: 'impersonation overrides toggle off',
            user: { is_impersonated: true },
            isDev: false,
            enabled: false,
            expected: true,
        },
        { name: 'non-staff, non-dev never sees', user: {}, isDev: false, enabled: true, expected: false },
    ])('showDebugLogs — $name', ({ user, isDev, enabled, expected }) => {
        setup({ user, isDev })
        logic.actions.setDebugLogsEnabled(enabled)
        expect(logic.values.showDebugLogs).toBe(expected)
    })
})