The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
import { FIRST_REFERRER_COOKIE_NAME } from 'common/first-referrer-cookie'
import { NextRequest } from 'next/server'
import { describe, expect, it, vi } from 'vitest'
import { proxy } from './proxy'
// content.generated.ts is produced by scripts/generateMdContent.mjs at
// content:build time and gitignored, so it isn't on disk in CI before tests
// run. The mock seeds a representative allowlist so the .md-routing branches
// are actually exercised below.
vi.mock('./app/api-v2/md/content.generated', () => ({
MD_CONTENT: new Map<string, string>(),
MD_PAGES: new Set<string>(['index', 'auth', 'pricing']),
CHANGELOG_PAGES: new Set<string>(['changelog', 'changelog/100', 'changelog/pipelines']),
}))
function makeRequest(
url: string,
{
referer,
hasCookie,
accept,
userAgent,
routerStateTree,
}: {
referer?: string
hasCookie?: boolean
accept?: string
userAgent?: string
routerStateTree?: string
} = {}
): NextRequest {
const headers: Record<string, string> = {}
if (referer) headers.referer = referer
if (accept) headers.accept = accept
if (userAgent) headers['user-agent'] = userAgent
if (routerStateTree) headers['next-router-state-tree'] = routerStateTree
const req = new NextRequest(new URL(url, 'https://supabase.com'), { headers })
if (hasCookie) {
req.cookies.set(FIRST_REFERRER_COOKIE_NAME, 'existing')
}
return req
}
describe('www proxy', () => {
describe('Next.js 15 router state tree', () => {
// Shape sent by a Next.js 15 client: the root layout segment has `isRootLayout: true`.
const v15Tree = encodeURIComponent(
JSON.stringify(['', { children: ['blog', { children: ['__PAGE__', {}] }] }, null, null, true])
)
// Shape sent by a Next.js 16 client: the fifth element is a numeric flags bitmask.
const v16Tree = encodeURIComponent(
JSON.stringify(['', { children: ['blog', { children: ['__PAGE__', {}] }] }, null, null, 1])
)
it('rejects v15-shaped state with a 400 instead of letting the renderer throw', () => {
const res = proxy(makeRequest('/blog?_rsc=abc', { routerStateTree: v15Tree }))
expect(res.status).toBe(400)
expect(res.headers.get('Cache-Control')).toBe('no-store')
})
it.each(['/docs/guides/auth', '/docs', '/dashboard/project/x', '/kb/guides/x'])(
'does not touch v15-shaped state on other zones (%s)',
(path) => {
const res = proxy(makeRequest(`${path}?_rsc=abc`, { routerStateTree: v15Tree }))
expect(res.status).toBe(200)
}
)
it('passes v16-shaped state through', () => {
const res = proxy(makeRequest('/blog?_rsc=abc', { routerStateTree: v16Tree }))
expect(res.status).toBe(200)
})
it('passes requests without the header through', () => {
expect(proxy(makeRequest('/blog')).status).toBe(200)
})
it('leaves malformed state for Next.js to handle', () => {
const res = proxy(makeRequest('/blog?_rsc=abc', { routerStateTree: '%7Bnot-json' }))
expect(res.status).toBe(200)
})
})
describe('cookie stamping on www paths', () => {
it('stamps cookie for external referrer on www path', () => {
const req = makeRequest('/pricing', { referer: 'https://google.com' })
const res = proxy(req)
expect(res.cookies.get(FIRST_REFERRER_COOKIE_NAME)).toBeDefined()
})
it('does not stamp cookie for internal referrer', () => {
const req = makeRequest('/pricing', { referer: 'https://supabase.com/docs' })
const res = proxy(req)
expect(res.cookies.get(FIRST_REFERRER_COOKIE_NAME)).toBeUndefined()
})
})
describe('cookie stamping on /dashboard paths', () => {
it('stamps cookie for external referrer', () => {
const req = makeRequest('/dashboard/project/123', { referer: 'https://google.com' })
const res = proxy(req)
expect(res.cookies.get(FIRST_REFERRER_COOKIE_NAME)).toBeDefined()
})
it('does not stamp cookie for internal referrer', () => {
const req = makeRequest('/dashboard/project/123', {
referer: 'https://supabase.com/pricing',
})
const res = proxy(req)
expect(res.cookies.get(FIRST_REFERRER_COOKIE_NAME)).toBeUndefined()
})
it('does not stamp cookie for direct navigation (no referrer)', () => {
const req = makeRequest('/dashboard/project/123')
const res = proxy(req)
expect(res.cookies.get(FIRST_REFERRER_COOKIE_NAME)).toBeUndefined()
})
})
describe('cookie stamping on /docs paths', () => {
it('stamps cookie for external referrer', () => {
const req = makeRequest('/docs/guides/auth', { referer: 'https://google.com' })
const res = proxy(req)
expect(res.cookies.get(FIRST_REFERRER_COOKIE_NAME)).toBeDefined()
})
it('does not stamp cookie for internal referrer', () => {
const req = makeRequest('/docs/guides/auth', {
referer: 'https://supabase.com/pricing',
})
const res = proxy(req)
expect(res.cookies.get(FIRST_REFERRER_COOKIE_NAME)).toBeUndefined()
})
it('does not stamp cookie for direct navigation (no referrer)', () => {
const req = makeRequest('/docs/guides/auth')
const res = proxy(req)
expect(res.cookies.get(FIRST_REFERRER_COOKIE_NAME)).toBeUndefined()
})
})
describe('.md suffix routing', () => {
it('rewrites /<slug>.md for allowlisted slugs', () => {
const req = makeRequest('/auth.md')
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/auth')
})
it('falls through for non-allowlisted .md slugs', () => {
const req = makeRequest('/not-a-page.md')
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
})
it('rewrites /index.md to the homepage markdown', () => {
const req = makeRequest('/index.md')
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/index')
})
it('falls back to serving /.md as homepage markdown if the config 308 is ever removed', () => {
const req = makeRequest('/.md')
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/index')
})
it('rewrites changelog entry .md requests without doubling the suffix', () => {
const req = makeRequest('/changelog/100.md', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/changelog/100.md')
})
it('serves markdown for explicit changelog .md requests even when Accept excludes it', () => {
const req = makeRequest('/changelog/100.md', {
accept: 'application/x-content-negotiation-probe',
})
const res = proxy(req)
expect(res.status).not.toBe(406)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/changelog/100.md')
})
it('serves markdown for explicit non-legacy changelog .md requests even when Accept excludes it', () => {
const req = makeRequest('/changelog/pipelines.md', {
accept: 'application/x-content-negotiation-probe',
})
const res = proxy(req)
expect(res.status).not.toBe(406)
expect(res.headers.get('x-middleware-rewrite')).toBe(
'https://supabase.com/changelog/pipelines.md'
)
})
it('rewrites the changelog index .md request without doubling the suffix', () => {
const req = makeRequest('/changelog.md', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/changelog.md')
})
})
describe('Accept: text/markdown content negotiation', () => {
it('rewrites / to the homepage index slug when Accept: text/markdown', () => {
const req = makeRequest('/', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/index')
})
it('rewrites /<slug> when Accept: text/markdown matches the allowlist', () => {
const req = makeRequest('/auth', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/auth')
})
it('rewrites /<slug>/ (trailing slash) the same as /<slug>', () => {
const req = makeRequest('/auth/', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/auth')
})
it('falls through when Accept does not include text/markdown', () => {
const req = makeRequest('/auth', { accept: 'text/html' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
})
it('falls through when slug is not in the allowlist', () => {
const req = makeRequest('/not-a-page', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
})
it('rewrites changelog entries to their static .md file', () => {
const req = makeRequest('/changelog/100', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/changelog/100.md')
})
it('negotiates markdown for non-legacy changelog slugs', () => {
const req = makeRequest('/changelog/pipelines', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe(
'https://supabase.com/changelog/pipelines.md'
)
})
it('passes through unpublished numeric-prefix changelog slugs', () => {
const req = makeRequest('/changelog/999-not-published', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
expect(res.status).not.toBe(406)
})
it('passes through deep paths under a published changelog slug', () => {
const req = makeRequest('/changelog/100/bar', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
expect(res.status).not.toBe(406)
})
it('rewrites the bare changelog index to its static .md file', () => {
const req = makeRequest('/changelog', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/changelog.md')
})
})
describe('Accept header q-value parsing', () => {
it('serves markdown for Cursor-style Accept (markdown preferred, plain fallback)', () => {
const req = makeRequest('/auth', {
accept: 'text/markdown, text/plain;q=0.9, */*;q=0.8',
})
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/auth')
})
it('serves markdown when md and html have equal q-values', () => {
const req = makeRequest('/auth', { accept: 'text/markdown, text/html, */*' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/auth')
})
it('serves HTML when html q-value beats markdown q-value', () => {
const req = makeRequest('/auth', { accept: 'text/html;q=1.0, text/markdown;q=0.5' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
})
it('serves HTML for browser-style Accept (html with */* fallback)', () => {
const req = makeRequest('/auth', {
accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8',
})
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
})
it('serves markdown when md q-value beats html q-value', () => {
const req = makeRequest('/auth', { accept: 'text/html;q=0.5, text/markdown;q=1.0' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/auth')
})
it('tolerates OWS around the q parameter (per RFC 9110)', () => {
const req = makeRequest('/auth', { accept: 'text/html ; q = 1.0, text/markdown ; q = 0.5' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
})
it('ignores out-of-range q-values rather than treating them as preference', () => {
const req = makeRequest('/auth', { accept: 'text/html;q=2.0, text/markdown;q=1.0' })
const res = proxy(req)
// text/html's q=2.0 is invalid and falls back to default 1.0; tie -> markdown.
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/auth')
})
})
describe('406 Not Acceptable', () => {
it('returns 406 on MD-eligible page when Accept excludes every type we serve', () => {
const req = makeRequest('/pricing', { accept: 'application/x-content-negotiation-probe' })
const res = proxy(req)
expect(res.status).toBe(406)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
})
it('does not return 406 on non-MD pages (no negotiation contract there)', () => {
const req = makeRequest('/not-a-page', { accept: 'application/x-content-negotiation-probe' })
const res = proxy(req)
expect(res.status).not.toBe(406)
})
it('does not return 406 when Accept includes */*', () => {
const req = makeRequest('/pricing', { accept: '*/*' })
const res = proxy(req)
expect(res.status).not.toBe(406)
})
it('returns 406 for a probe Accept header regardless of user agent', () => {
const req = makeRequest('/pricing', {
accept: 'application/x-content-negotiation-probe',
userAgent: 'Claude-User/1.0',
})
const res = proxy(req)
expect(res.status).toBe(406)
})
it('returns 406 on changelog entries when Accept excludes every type', () => {
const req = makeRequest('/changelog/100', {
accept: 'application/x-content-negotiation-probe',
})
const res = proxy(req)
expect(res.status).toBe(406)
})
it('returns 406 for non-legacy changelog entries when Accept matches nothing', () => {
const req = makeRequest('/changelog/pipelines', {
accept: 'application/x-content-negotiation-probe',
})
const res = proxy(req)
expect(res.status).toBe(406)
})
it('sets Cache-Control: no-store and Vary: Accept on 406 responses', () => {
const req = makeRequest('/pricing', { accept: 'application/x-content-negotiation-probe' })
const res = proxy(req)
expect(res.status).toBe(406)
expect(res.headers.get('Cache-Control')).toBe('no-store')
expect(res.headers.get('Vary')).toBe('Accept')
})
})
describe('user-agent independence', () => {
it('serves HTML to agent and bot user agents that send no markdown Accept preference', () => {
for (const ua of [
'Claude-User (claude-code/2.1.119; +https://support.anthropic.com/)',
'Claude-Web/1.0',
'Mozilla/5.0 (compatible; ChatGPT-User/1.0)',
'PerplexityBot/1.0',
'GPTBot/1.0',
'ClaudeBot/1.0',
'CCBot/2.0',
'chatgpt-userscript/2.0',
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36',
]) {
const req = makeRequest('/auth', { userAgent: ua })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
}
})
it('negotiates by Accept as usual when an agent user agent is present', () => {
const req = makeRequest('/auth', {
accept: 'text/markdown',
userAgent: 'Claude-User (claude-code/2.1.119; +https://support.anthropic.com/)',
})
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBe('https://supabase.com/api-v2/md/auth')
})
it('falls through when slug is not in the allowlist', () => {
const req = makeRequest('/not-a-page', { accept: 'text/markdown' })
const res = proxy(req)
expect(res.headers.get('x-middleware-rewrite')).toBeNull()
})
})
})