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.3 KB
Raw Blame
import { router } from 'kea-router'

import { navigateToHref } from 'lib/utils/navigateToHref'

import { AppContext } from '~/types'

jest.mock('kea-router', () => ({
    router: { actions: { push: jest.fn() } },
}))

const push = router.actions.push as jest.Mock

describe('navigateToHref', () => {
    const originalLocation = window.location
    const originalAppContext = window.POSTHOG_APP_CONTEXT

    beforeEach(() => {
        push.mockReset()
        Object.defineProperty(window, 'location', {
            value: { ...window.location, href: 'https://us.posthog.com/project/997/dashboard' },
            configurable: true,
        })
        window.POSTHOG_APP_CONTEXT = { current_team: { id: 997 } } as unknown as AppContext
    })

    afterEach(() => {
        Object.defineProperty(window, 'location', { value: originalLocation, configurable: true })
        window.POSTHOG_APP_CONTEXT = originalAppContext
    })

    it('routes an in-app path client-side', () => {
        navigateToHref('/insights/abc123')

        expect(push).toHaveBeenCalledWith('/insights/abc123')
        expect(window.location.href).toEqual('https://us.posthog.com/project/997/dashboard')
    })

    it.each([undefined, '', '#'])('navigates nowhere for %p', (href) => {
        navigateToHref(href)

        expect(push).not.toHaveBeenCalled()
        expect(window.location.href).toEqual('https://us.posthog.com/project/997/dashboard')
    })

    // A search item href is team-writable, so a script target must never reach the router or a
    // page load. `javascript:/api/...` is the reachable shape: `addProjectIdIfMissing` leaves it
    // intact, so it fails the same-origin check in `pushState` and lands in the fallback below.
    it.each([
        'javascript:alert(1)',
        'javascript:/api/,alert(document.cookie)',
        'JaVaScRiPt:/login/,alert(1)',
        '\t java\nscript:/me/,alert(1)',
        'vbscript:/api/,msgbox(1)',
    ])('refuses to navigate to %p', (href) => {
        push.mockImplementation(() => {
            throw new DOMException('The operation is insecure.', 'SecurityError')
        })

        navigateToHref(href)

        expect(push).not.toHaveBeenCalled()
        expect(window.location.href).toEqual('https://us.posthog.com/project/997/dashboard')
    })

    it.each(['https://posthog.com/docs', 'mailto:[email protected]', '/api/projects/997/exports/1'])(
        'loads %p as a page instead of routing it',
        (href) => {
            navigateToHref(href)

            expect(push).not.toHaveBeenCalled()
            expect(window.location.href).toEqual(href)
        }
    )

    it('falls back to a project-scoped page load when the History API rejects the push', () => {
        push.mockImplementation(() => {
            throw new DOMException('The operation is insecure.', 'SecurityError')
        })

        navigateToHref('/insights/abc123')

        expect(window.location.href).toEqual('/project/997/insights/abc123')
    })

    it('lets an error from a logic reacting to the navigation through', () => {
        push.mockImplementation(() => {
            throw new Error('a scene logic blew up')
        })

        expect(() => navigateToHref('/insights/abc123')).toThrow('a scene logic blew up')
        expect(window.location.href).toEqual('https://us.posthog.com/project/997/dashboard')
    })
})