mirror of
https://github.com/stablyai/orca.git
synced 2026-11-04 19:17:28 +00:00
Blue Daydreaming
0b604956ec
Only srcset is a comma-separated candidate list; src and href hold one URL. Splitting them invented missing targets for paths containing commas or spaces and could pass a missing target whose fragments were tracked. Fixes #34815
217 lines
8.0 KiB
JavaScript
217 lines
8.0 KiB
JavaScript
import { execFileSync } from 'node:child_process'
|
|
import { existsSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs'
|
|
import { tmpdir } from 'node:os'
|
|
import path from 'node:path'
|
|
import { runInNewContext } from 'node:vm'
|
|
import { afterEach, describe, expect, it, vi } from 'vitest'
|
|
import { parse } from 'yaml'
|
|
import { findBrokenReadmeLinks, main } from './check-readme-local-links.mjs'
|
|
import { LINT_STEPS } from './run-lint.mjs'
|
|
|
|
const projectDir = path.resolve(import.meta.dirname, '../..')
|
|
const tempDirs = []
|
|
|
|
function git(cwd, args) {
|
|
return execFileSync('git', args, { cwd, encoding: 'utf8' }).trim()
|
|
}
|
|
|
|
function writeFiles(root, files) {
|
|
for (const [relativePath, contents] of Object.entries(files)) {
|
|
const target = path.join(root, relativePath)
|
|
mkdirSync(path.dirname(target), { recursive: true })
|
|
writeFileSync(target, contents)
|
|
}
|
|
}
|
|
|
|
function makeFixture(files, { untracked = {} } = {}) {
|
|
const root = mkdtempSync(path.join(tmpdir(), 'orca-readme-links-'))
|
|
tempDirs.push(root)
|
|
git(root, ['init', '--quiet'])
|
|
git(root, ['config', 'user.email', 'readme-links-test@example.com'])
|
|
git(root, ['config', 'user.name', 'README Links Test'])
|
|
writeFiles(root, files)
|
|
git(root, ['add', '-A'])
|
|
git(root, ['commit', '--quiet', '-m', 'fixture'])
|
|
writeFiles(root, untracked)
|
|
return root
|
|
}
|
|
|
|
const validReadmes = {
|
|
'README.md': [
|
|
'<img src="resources/build/icon.png" />',
|
|
'<picture><source srcset="docs/site/public/docs/tab-split.gif" type="image/gif"><img src="resources/onboarding/feature-wall/tile-01.poster.jpg" /></picture>',
|
|
'<a href="docs/readme/README.ja.md">日本語</a>',
|
|
"<img src='resources/build/icon.png' />",
|
|
'<img src="https://img.shields.io/badge/x-y-z" />',
|
|
'[Contributing](.github/CONTRIBUTING.md) [Docs](https://example.com/docs) [Top](#top)',
|
|
'',
|
|
// src/href hold one URL; only srcset is a comma-separated list.
|
|
'<img src="docs/assets/hero image,wide.jpg" /> <a href=\'https://example.com/docs?pages=one,two\'>Docs</a>'
|
|
].join('\n'),
|
|
'docs/readme/README.ja.md': [
|
|
'<img src="../../resources/build/icon.png" />',
|
|
'<source srcset="../site/public/docs/tab-split.gif">',
|
|
'<a href="../../README.md">English</a> <a href="README.ja.md#top">self</a>',
|
|
'[LICENSE](../../LICENSE)'
|
|
].join('\n'),
|
|
'resources/build/icon.png': 'png',
|
|
'resources/onboarding/feature-wall/tile-01.poster.jpg': 'jpg',
|
|
'docs/site/public/docs/tab-split.gif': 'gif',
|
|
'docs/assets/hero image.jpg': 'jpg',
|
|
'docs/assets/hero image,wide.jpg': 'jpg',
|
|
'.github/CONTRIBUTING.md': 'contributing',
|
|
LICENSE: 'mit'
|
|
}
|
|
|
|
afterEach(() => {
|
|
vi.restoreAllMocks()
|
|
while (tempDirs.length > 0) {
|
|
rmSync(tempDirs.pop(), { force: true, recursive: true })
|
|
}
|
|
})
|
|
|
|
describe('README local link check', () => {
|
|
it('accepts the checked-in READMEs', () => {
|
|
vi.spyOn(console, 'log').mockImplementation(() => {})
|
|
expect(main(projectDir)).toBe(0)
|
|
})
|
|
|
|
it('accepts local links in every supported shape', () => {
|
|
expect(findBrokenReadmeLinks(makeFixture(validReadmes))).toEqual([])
|
|
})
|
|
|
|
it('rejects a missing full URL even when its split fragments are tracked', () => {
|
|
const root = makeFixture({
|
|
...validReadmes,
|
|
'README.md': '<img src="docs/assets/missing image,wide.jpg" />',
|
|
'docs/assets/missing': 'fragment',
|
|
'wide.jpg': 'fragment'
|
|
})
|
|
|
|
expect(findBrokenReadmeLinks(root)).toEqual([
|
|
{
|
|
readme: 'README.md',
|
|
target: 'docs/assets/missing image,wide.jpg',
|
|
resolved: 'docs/assets/missing image,wide.jpg'
|
|
}
|
|
])
|
|
})
|
|
|
|
it('continues checking each srcset candidate without its descriptor', () => {
|
|
const root = makeFixture({
|
|
...validReadmes,
|
|
'README.md': '<source srcset="resources/build/icon.png 1x, docs/assets/missing.png 2x">'
|
|
})
|
|
|
|
expect(findBrokenReadmeLinks(root)).toEqual([
|
|
{
|
|
readme: 'README.md',
|
|
target: 'docs/assets/missing.png',
|
|
resolved: 'docs/assets/missing.png'
|
|
}
|
|
])
|
|
})
|
|
|
|
it('checks tracked media outside the detector sparse checkout', () => {
|
|
const root = makeFixture(validReadmes)
|
|
const workflow = parse(readFileSync(path.join(projectDir, '.github/workflows/pr.yml'), 'utf8'))
|
|
const checkout = workflow.jobs.code_paths.steps.find((step) =>
|
|
step.uses?.startsWith('actions/checkout@')
|
|
)
|
|
const patterns = checkout.with['sparse-checkout'].trim().split('\n')
|
|
expect(checkout.with['sparse-checkout-cone-mode']).toBe(false)
|
|
git(root, ['sparse-checkout', 'set', '--no-cone', ...patterns])
|
|
|
|
expect(existsSync(path.join(root, 'resources/build/icon.png'))).toBe(false)
|
|
expect(findBrokenReadmeLinks(root)).toEqual([])
|
|
git(root, ['update-index', '--force-remove', 'resources/build/icon.png'])
|
|
expect(findBrokenReadmeLinks(root).map((link) => link.resolved)).toEqual([
|
|
'resources/build/icon.png',
|
|
'resources/build/icon.png'
|
|
])
|
|
})
|
|
|
|
it('reports a deleted media file for the root and translated READMEs', () => {
|
|
const { 'docs/site/public/docs/tab-split.gif': _gif, ...files } = validReadmes
|
|
vi.spyOn(console, 'error').mockImplementation(() => {})
|
|
const root = makeFixture(files)
|
|
|
|
expect(findBrokenReadmeLinks(root)).toEqual([
|
|
{
|
|
readme: 'README.md',
|
|
target: 'docs/site/public/docs/tab-split.gif',
|
|
resolved: 'docs/site/public/docs/tab-split.gif'
|
|
},
|
|
{
|
|
readme: 'docs/readme/README.ja.md',
|
|
target: '../site/public/docs/tab-split.gif',
|
|
resolved: 'docs/site/public/docs/tab-split.gif'
|
|
}
|
|
])
|
|
expect(main(root)).toBe(1)
|
|
expect(console.error).toHaveBeenCalledWith(
|
|
expect.stringContaining('README.md: docs/site/public/docs/tab-split.gif')
|
|
)
|
|
})
|
|
|
|
// Why: GitHub renders the commit, so a file that only exists on disk is broken.
|
|
it('reports a referenced file that exists on disk but is not tracked', () => {
|
|
const { 'resources/build/icon.png': icon, ...files } = validReadmes
|
|
const root = makeFixture(files, { untracked: { 'resources/build/icon.png': icon } })
|
|
|
|
expect(findBrokenReadmeLinks(root).map((link) => link.resolved)).toEqual([
|
|
'resources/build/icon.png',
|
|
'resources/build/icon.png'
|
|
])
|
|
})
|
|
|
|
it('reports a link that escapes the repository', () => {
|
|
const root = makeFixture({
|
|
...validReadmes,
|
|
'docs/readme/README.ja.md': '<img src="../../../outside.png" />'
|
|
})
|
|
|
|
expect(findBrokenReadmeLinks(root)).toEqual([
|
|
{ readme: 'docs/readme/README.ja.md', target: '../../../outside.png', resolved: null }
|
|
])
|
|
})
|
|
|
|
// Single-quoted HTML is valid; double-quote-only parsing would miss this broken image.
|
|
it('reports a missing target in a single-quoted attribute', () => {
|
|
const files = {
|
|
...validReadmes,
|
|
'README.md': `${validReadmes['README.md']}\n<img src='docs/assets/missing.gif' />`
|
|
}
|
|
|
|
expect(findBrokenReadmeLinks(makeFixture(files))).toEqual([
|
|
{
|
|
readme: 'README.md',
|
|
target: 'docs/assets/missing.gif',
|
|
resolved: 'docs/assets/missing.gif'
|
|
}
|
|
])
|
|
})
|
|
|
|
// Ready docs-only diffs skip preflight, so the detector must check README links.
|
|
it('checks ready PRs through the detector and in the lint script', () => {
|
|
const { scripts } = JSON.parse(readFileSync(path.join(projectDir, 'package.json'), 'utf8'))
|
|
const workflow = parse(readFileSync(path.join(projectDir, '.github/workflows/pr.yml'), 'utf8'))
|
|
const guardJob = workflow.jobs.code_paths
|
|
const step = guardJob.steps.find((candidate) => candidate.name === 'Check README local links')
|
|
const runsFor = (draft) =>
|
|
runInNewContext(guardJob.if, {
|
|
github: { event_name: 'pull_request', event: { pull_request: { draft } } }
|
|
})
|
|
|
|
expect(runsFor(false)).toBe(true)
|
|
expect(runsFor(true)).toBe(false)
|
|
expect(guardJob.needs).toBeUndefined()
|
|
expect(step.if).toBeUndefined()
|
|
expect(step.run).toBe('node config/scripts/check-readme-local-links.mjs')
|
|
expect(scripts['check:readme-local-links']).toBe(
|
|
'node config/scripts/check-readme-local-links.mjs'
|
|
)
|
|
expect(LINT_STEPS).toContain('check:readme-local-links')
|
|
})
|
|
})
|