: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.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { Request, Response } from 'ultimate-express'
import { createInternalApiAuthMiddleware } from './internal-api-auth'
describe('createInternalApiAuthMiddleware', () => {
const mockResponse = () => {
const res = {} as Response
res.status = jest.fn().mockReturnValue(res)
res.json = jest.fn().mockReturnValue(res)
return res
}
const mockRequest = (path: string, headers: Record<string, string> = {}) => {
return {
headers,
path,
method: 'GET',
} as unknown as Request
}
describe('when no secret configured', () => {
it.each([
['no secret configured', ''],
['empty secret configured', ''],
])('should allow request when %s', (_, configuredSecret) => {
const middleware = createInternalApiAuthMiddleware({ secret: configuredSecret })
const req = mockRequest('/api/test')
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).toHaveBeenCalled()
expect(res.status).not.toHaveBeenCalled()
})
})
describe('when secret configured', () => {
it('should reject request when header is missing', () => {
const middleware = createInternalApiAuthMiddleware({ secret: 'test-secret' })
const req = mockRequest('/api/test', {})
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).not.toHaveBeenCalled()
expect(res.status).toHaveBeenCalledWith(401)
expect(res.json).toHaveBeenCalledWith({ error: 'Unauthorized: Missing authentication header' })
})
it('should reject request when secret does not match', () => {
const middleware = createInternalApiAuthMiddleware({ secret: 'correct-secret' })
const req = mockRequest('/api/test', { 'x-internal-api-secret': 'wrong-secret' })
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).not.toHaveBeenCalled()
expect(res.status).toHaveBeenCalledWith(401)
expect(res.json).toHaveBeenCalledWith({ error: 'Unauthorized: Invalid authentication' })
})
it.each([['x-internal-api-secret'], ['X-Internal-Api-Secret'], ['X-INTERNAL-API-SECRET']])(
'should allow request when secret matches with %s header',
(headerName) => {
const middleware = createInternalApiAuthMiddleware({ secret: 'correct-secret' })
const req = mockRequest('/api/test', { [headerName]: 'correct-secret' })
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).toHaveBeenCalled()
expect(res.status).not.toHaveBeenCalled()
}
)
it('should reject when secrets have different lengths', () => {
const middleware = createInternalApiAuthMiddleware({ secret: 'short' })
const req = mockRequest('/api/test', { 'x-internal-api-secret': 'much-longer-secret' })
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).not.toHaveBeenCalled()
expect(res.status).toHaveBeenCalledWith(401)
})
it('should reject when header value is not a string', () => {
const middleware = createInternalApiAuthMiddleware({ secret: 'test-secret' })
const req = {
headers: { 'x-internal-api-secret': ['array', 'of', 'values'] },
path: '/api/test',
method: 'GET',
} as unknown as Request
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).not.toHaveBeenCalled()
expect(res.status).toHaveBeenCalledWith(401)
expect(res.json).toHaveBeenCalledWith({ error: 'Unauthorized: Missing authentication header' })
})
})
describe('when fallback secrets configured', () => {
it.each([
['primary', 'new-secret'],
['first fallback', 'old-secret'],
['second fallback', 'older-secret'],
])('should allow request when %s matches', (_, provided) => {
const middleware = createInternalApiAuthMiddleware({
secret: 'new-secret',
fallbacks: ['old-secret', 'older-secret'],
})
const req = mockRequest('/api/test', { 'x-internal-api-secret': provided })
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).toHaveBeenCalled()
expect(res.status).not.toHaveBeenCalled()
})
it('should reject request when secret matches neither primary nor fallback', () => {
const middleware = createInternalApiAuthMiddleware({ secret: 'new-secret', fallbacks: ['old-secret'] })
const req = mockRequest('/api/test', { 'x-internal-api-secret': 'bogus-secret' })
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).not.toHaveBeenCalled()
expect(res.status).toHaveBeenCalledWith(401)
})
it('should skip auth when primary and all fallbacks are empty', () => {
const middleware = createInternalApiAuthMiddleware({ secret: '', fallbacks: ['', ''] })
const req = mockRequest('/api/test', {})
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).toHaveBeenCalled()
expect(res.status).not.toHaveBeenCalled()
})
})
describe('whitespace handling', () => {
it.each([
['configured secret has a trailing newline', 'my-secret\n', 'my-secret'],
['provided secret has surrounding whitespace', 'my-secret', ' my-secret '],
])('matches when %s', (_, configured, provided) => {
const middleware = createInternalApiAuthMiddleware({ secret: configured })
const req = mockRequest('/api/test', { 'x-internal-api-secret': provided })
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).toHaveBeenCalled()
expect(res.status).not.toHaveBeenCalled()
})
})
describe('path exclusions', () => {
it.each([
['/public/webhooks/123', 'public path'],
['/_health', 'health check'],
['/_ready', 'ready check'],
['/_metrics', 'metrics'],
['/metrics', 'prometheus metrics'],
])('should skip auth for %s (%s)', (path) => {
const middleware = createInternalApiAuthMiddleware({ secret: 'test-secret' })
const req = mockRequest(path, {})
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).toHaveBeenCalled()
expect(res.status).not.toHaveBeenCalled()
})
it.each([
['/api/projects/1/hog_flows/some-uuid/reschedule_parked'],
['/api/projects/1/hog_flows/some-uuid/invocations/cancel'],
['/api/projects/1/hog_flows/some-uuid/batch_jobs/some-job-id/cancel'],
['/api/projects/1/hog_flows/some-uuid/transactional_email'],
['/api/projects/1/hog_flows/some-uuid/transactional_email/send'],
])('should skip auth for scoped-JWT route %s, which authenticates in its handler', (path) => {
const middleware = createInternalApiAuthMiddleware({ secret: 'test-secret' })
const req = mockRequest(path, {})
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).toHaveBeenCalled()
expect(res.status).not.toHaveBeenCalled()
})
it.each([
// batch_invocations' last segment is a caller-controlled :parent_run_id and its handler
// verifies no token, so the literal id "cancel" must not inherit the scoped-JWT exemption.
['/api/projects/1/hog_flows/some-uuid/batch_invocations/cancel'],
['/api/some/other/route/cancel'],
['/api/projects/1/hog_flows/some-uuid/reschedule_parked/extra'],
['/api/projects/1/hog_flows/some-uuid/transactional_email/send/extra'],
])('should still require the secret for %s despite resembling a scoped route', (path) => {
const middleware = createInternalApiAuthMiddleware({ secret: 'test-secret' })
const req = mockRequest(path, {})
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).not.toHaveBeenCalled()
expect(res.status).toHaveBeenCalledWith(401)
})
it('should allow custom excluded path prefixes', () => {
const middleware = createInternalApiAuthMiddleware({
secret: 'test-secret',
excludedPathPrefixes: ['/custom/'],
})
const req = mockRequest('/custom/endpoint', {})
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).toHaveBeenCalled()
expect(res.status).not.toHaveBeenCalled()
})
it('should still require auth for non-excluded paths', () => {
const middleware = createInternalApiAuthMiddleware({ secret: 'test-secret' })
const req = mockRequest('/api/some/endpoint', {})
const res = mockResponse()
const next = jest.fn()
middleware(req, res, next)
expect(next).not.toHaveBeenCalled()
expect(res.status).toHaveBeenCalledWith(401)
})
})
})