perf: update tests for readme routes

Author: alexdln

test/unit/server/utils/readme-loaders.spec.ts

@@ -0,0 +1,81 @@
+import { describe, expect, it, vi } from 'vitest'
+
+// Mock Nitro globals before importing the module
+vi.stubGlobal('defineCachedFunction', (fn: Function) => fn)
+const $fetchMock = vi.fn()
+vi.stubGlobal('$fetch', $fetchMock)
+
+const { fetchReadmeFromJsdelivr, isStandardReadme } =
+  await import('../../../../server/utils/readme-loaders')
+
+describe('isStandardReadme', () => {
+  it('returns true for standard README filenames', () => {
+    expect(isStandardReadme('README.md')).toBe(true)
+    expect(isStandardReadme('readme.md')).toBe(true)
+    expect(isStandardReadme('Readme.md')).toBe(true)
+    expect(isStandardReadme('README')).toBe(true)
+    expect(isStandardReadme('readme')).toBe(true)
+    expect(isStandardReadme('README.markdown')).toBe(true)
+    expect(isStandardReadme('readme.markdown')).toBe(true)
+  })
+
+  it('returns false for non-standard filenames', () => {
+    expect(isStandardReadme('CONTRIBUTING.md')).toBe(false)
+    expect(isStandardReadme('README.txt')).toBe(false)
+    expect(isStandardReadme('readme.rst')).toBe(false)
+    expect(isStandardReadme(undefined)).toBe(false)
+    expect(isStandardReadme('')).toBe(false)
+  })
+})
+
+describe('fetchReadmeFromJsdelivr', () => {
+  it('returns content when first filename succeeds', async () => {
+    const content = '# Package'
+    const fetchMock = vi.fn().mockResolvedValue({
+      ok: true,
+      text: async () => content,
+    })
+    vi.stubGlobal('fetch', fetchMock)
+
+    const result = await fetchReadmeFromJsdelivr('some-pkg', ['README.md'])
+
+    expect(result).toBe(content)
+    expect(fetchMock).toHaveBeenCalledWith('https://cdn.jsdelivr.net/npm/some-pkg/README.md')
+  })
+
+  it('tries next filename when response is not ok', async () => {
+    const content = '# Fallback'
+    const fetchMock = vi
+      .fn()
+      .mockResolvedValueOnce({ ok: false })
+      .mockResolvedValueOnce({ ok: true, text: async () => content })
+    vi.stubGlobal('fetch', fetchMock)
+
+    const result = await fetchReadmeFromJsdelivr('pkg', ['README.md', 'readme.md'])
+
+    expect(result).toBe(content)
+    expect(fetchMock).toHaveBeenCalledTimes(2)
+  })
+
+  it('includes version in URL when version is passed', async () => {
+    const fetchMock = vi.fn().mockResolvedValue({
+      ok: true,
+      text: async () => '',
+    })
+    vi.stubGlobal('fetch', fetchMock)
+
+    await fetchReadmeFromJsdelivr('pkg', ['README.md'], '1.2.3')
+
+    expect(fetchMock).toHaveBeenCalledWith('https://cdn.jsdelivr.net/npm/pkg@1.2.3/README.md')
+  })
+
+  it('returns null when all fetches fail', async () => {
+    const fetchMock = vi.fn().mockResolvedValue({ ok: false })
+    vi.stubGlobal('fetch', fetchMock)
+
+    const result = await fetchReadmeFromJsdelivr('pkg', ['README.md', 'readme.md'])
+
+    expect(result).toBeNull()
+    expect(fetchMock).toHaveBeenCalledTimes(2)
+  })
+})

test/unit/server/utils/readme.spec.ts

@@ -331,23 +331,52 @@ describe('Markdown File URL Resolution', () => {
   })
 })
 
-describe('Markdown Content Extraction', () => {
-  describe('Markdown', () => {
-    it('returns original markdown content unchanged', async () => {
-      const markdown = `# Title\n\nSome **bold** text and a [link](https://example.com).`
-      const result = await renderReadmeHtml(markdown, 'test-pkg')
+describe('ReadmeResponse shape (HTML route contract)', () => {
+  it('returns ReadmeResponse with html, mdExists, playgroundLinks, toc', async () => {
+    const markdown = `# Title\n\nSome **bold** text.`
+    const result = await renderReadmeHtml(markdown, 'test-pkg')
+
+    expect(result).toMatchObject({
+      html: expect.any(String),
+      mdExists: true,
+      playgroundLinks: [],
+      toc: expect.any(Array),
+    })
+    expect(result.html).toContain('Title')
+    expect(result.html).toContain('bold')
+  })
+
+  it('returns empty-state shape when content is empty', async () => {
+    const result = await renderReadmeHtml('', 'test-pkg')
 
-      expect(result.md).toBe(markdown)
+    expect(result).toMatchObject({
+      html: '',
+      playgroundLinks: [],
+      toc: [],
     })
+    expect(result.playgroundLinks).toHaveLength(0)
+    expect(result.toc).toHaveLength(0)
   })
-  describe('HTML', () => {
-    it('returns sanitized html', async () => {
-      const markdown = `# Title\n\nSome **bold** text and a [link](https://example.com).`
-      const result = await renderReadmeHtml(markdown, 'test-pkg')
 
-      expect(result.html).toBe(`<h3 id="user-content-title" data-level="1">Title</h3>
+  it('extracts toc from headings', async () => {
+    const markdown = `# Install\n\n## CLI\n\n## API`
+    const result = await renderReadmeHtml(markdown, 'test-pkg')
+
+    expect(result.toc).toHaveLength(3)
+    expect(result.toc[0]).toMatchObject({ text: 'Install', depth: 1 })
+    expect(result.toc[1]).toMatchObject({ text: 'CLI', depth: 2 })
+    expect(result.toc[2]).toMatchObject({ text: 'API', depth: 2 })
+    expect(result.toc.every(t => t.id.startsWith('user-content-'))).toBe(true)
+  })
+})
+
+describe('HTML output', () => {
+  it('returns sanitized html', async () => {
+    const markdown = `# Title\n\nSome **bold** text and a [link](https://example.com).`
+    const result = await renderReadmeHtml(markdown, 'test-pkg')
+
+    expect(result.html).toBe(`<h3 id="user-content-title" data-level="1">Title</h3>
 <p>Some <strong>bold</strong> text and a <a href="https://example.com" rel="nofollow noreferrer noopener" target="_blank">link</a>.</p>
 `)
-    })
   })
 })