mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 01:45:10 +03:00
3e79df3ece
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Feature, bug fix. Part 3 of 6 in a stack that splits the library redesign into reviewable pieces. ## What is the current behavior? An agent can already fetch any guide as Markdown, but has no way to find out what guides exist: the entry point is a rendered React page. The exporter also fails quietly in ways that ship wrong output rather than failing the build: - An unknown component silently unwraps to its children, so a component rename drops its rendered content. - A registry item that cannot be read produces a page with no file listing. - A link to a missing page produces a 404 URL. - An unrecognized install framework produces a plausible command for the wrong CLI. - Only absolute `/library/docs` links are rewritten, so in-page anchors and sibling links break in the export. ## What is the new behavior? `/library` negotiates Markdown the same way the guides do — `Accept: text/markdown`, or an explicit `/library/index.md` — and returns a categorized catalog with every block, its description, its framework variants, and a link to each guide's Markdown. `config/library.ts` is the single catalog description the generator reads, and a test ties it to the content directory in both directions: a guide cannot be added without a catalog entry, or listed without a guide. Each quiet failure above now throws, and links resolve against the page they appear on and are checked against the set of published documents. ```bash curl -H 'Accept: text/markdown' https://supabase.com/library ``` ## Additional context `config/library.ts` also carries the category and preview metadata the redesigned homepage consumes in the last PR of the stack; here it is exercised by the Markdown index and its test. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Added a browsable library catalog covering categories, blocks, starter apps, and supported frameworks. - Added Markdown versions of the library homepage and documentation for compatible tools and workflows. - Added framework-aware links and expanded registry information, including dependencies and source details. - Markdown requests now work for the homepage and documentation, while browser requests continue receiving HTML. - **Bug Fixes** - Improved document link handling, metadata validation, slug consistency, and detection of duplicate or missing documentation entries. - **Tests** - Added coverage for catalog routes, Markdown generation, homepage negotiation, document parsing, and framework-specific links. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com> Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
78 lines
2.5 KiB
TypeScript
78 lines
2.5 KiB
TypeScript
import { NextRequest } from 'next/server'
|
|
import { describe, expect, it } from 'vitest'
|
|
|
|
import { middleware } from './middleware'
|
|
|
|
const DOCS_URL = 'https://supabase.com/library/docs/nextjs/client'
|
|
|
|
function request(url: string, headers: Record<string, string>) {
|
|
return new NextRequest(new Request(url, { headers }))
|
|
}
|
|
|
|
describe('middleware markdown negotiation', () => {
|
|
it('rewrites to the markdown route when Accept prefers markdown', () => {
|
|
const response = middleware(request(DOCS_URL, { accept: 'text/markdown' }))
|
|
|
|
expect(response.headers.get('x-middleware-rewrite')).toBe(
|
|
'https://supabase.com/library/api/docs-md/nextjs/client'
|
|
)
|
|
})
|
|
|
|
it('406s when Accept rejects both html and markdown', () => {
|
|
const response = middleware(request(DOCS_URL, { accept: 'application/json' }))
|
|
|
|
expect(response.status).toBe(406)
|
|
})
|
|
|
|
it('passes Server Action requests through untouched', () => {
|
|
// Server Actions POST to the page URL with `Accept: text/x-component`.
|
|
const response = middleware(
|
|
request(DOCS_URL, {
|
|
accept: 'text/x-component',
|
|
'next-action': '7f1e0c0d5a1b2c3d4e5f60718293a4b5c6d7e8f900',
|
|
})
|
|
)
|
|
|
|
expect(response.status).toBe(200)
|
|
expect(response.headers.get('x-middleware-rewrite')).toBeNull()
|
|
})
|
|
|
|
it('serves html to browsers', () => {
|
|
const response = middleware(
|
|
request(DOCS_URL, { accept: 'text/html,application/xhtml+xml,*/*;q=0.8' })
|
|
)
|
|
|
|
expect(response.status).toBe(200)
|
|
expect(response.headers.get('x-middleware-rewrite')).toBeNull()
|
|
})
|
|
})
|
|
|
|
describe('middleware homepage negotiation', () => {
|
|
const HOME_URL = 'https://supabase.com/library'
|
|
|
|
it('rewrites the homepage to the index markdown route when Accept prefers markdown', () => {
|
|
const response = middleware(request(HOME_URL, { accept: 'text/markdown' }))
|
|
|
|
expect(response.headers.get('x-middleware-rewrite')).toBe(
|
|
'https://supabase.com/library/api/index-md'
|
|
)
|
|
})
|
|
|
|
it('serves the index markdown at /index.md regardless of Accept', () => {
|
|
const response = middleware(request(`${HOME_URL}/index.md`, { accept: 'text/html' }))
|
|
|
|
expect(response.headers.get('x-middleware-rewrite')).toBe(
|
|
'https://supabase.com/library/api/index-md'
|
|
)
|
|
})
|
|
|
|
it('serves the homepage as html to browsers', () => {
|
|
const response = middleware(
|
|
request(`${HOME_URL}/`, { accept: 'text/html,application/xhtml+xml,*/*;q=0.8' })
|
|
)
|
|
|
|
expect(response.status).toBe(200)
|
|
expect(response.headers.get('x-middleware-rewrite')).toBeNull()
|
|
})
|
|
})
|