|
|
@@ -0,0 +1,248 @@
|
|
|
+/** Coordinate single-worker Vitest coverage partitions and one merged report. */
|
|
|
+import { spawn } from 'node:child_process'
|
|
|
+import { lstat, mkdir, readdir, rm, unlink } from 'node:fs/promises'
|
|
|
+import { join, relative, sep } from 'node:path'
|
|
|
+
|
|
|
+/** Environment variable selecting the number of instrumented coverage processes. */
|
|
|
+export const COVERAGE_PARTITIONS_ENV = 'DSH_COVERAGE_PARTITIONS'
|
|
|
+
|
|
|
+/** Internal marker that suppresses reports and thresholds inside a partition process. */
|
|
|
+export const COVERAGE_PARTITION_MODE_ENV = 'DSH_COVERAGE_PARTITION_MODE'
|
|
|
+
|
|
|
+/** Environment variable overriding instrumented test and polling timeouts. */
|
|
|
+export const COVERAGE_TEST_TIMEOUT_ENV = 'DSH_COVERAGE_TEST_TIMEOUT_MS'
|
|
|
+
|
|
|
+/** One child command owned by the coverage coordinator. */
|
|
|
+export interface CoverageCommand {
|
|
|
+ /** Diagnostic identity. */
|
|
|
+ label: string
|
|
|
+ /** Node arguments; the first argument is pnpm's JavaScript entrypoint. */
|
|
|
+ args: string[]
|
|
|
+ /** Environment additions for the child. */
|
|
|
+ env: Record<string, string | undefined>
|
|
|
+ /** Working directory for the child. */
|
|
|
+ cwd: string
|
|
|
+ /** Blob the partition must produce; absent for the merge command. */
|
|
|
+ blobPath?: string
|
|
|
+}
|
|
|
+
|
|
|
+/** Observable child-process completion. */
|
|
|
+export interface CoverageCommandResult {
|
|
|
+ /** Numeric process status, or `null` when a signal ended the child. */
|
|
|
+ exitCode: number | null
|
|
|
+ /** Terminating signal, or `null` after an ordinary exit. */
|
|
|
+ signalCode: NodeJS.Signals | null
|
|
|
+ /** Spawn failure recorded independently from process completion. */
|
|
|
+ error?: string
|
|
|
+}
|
|
|
+
|
|
|
+/** Execute one coordinator command with inherited output. */
|
|
|
+export type CoverageCommandRunner = (command: CoverageCommand) => Promise<CoverageCommandResult>
|
|
|
+
|
|
|
+/** Construction inputs for {@link CoveragePartitionCoordinator}. */
|
|
|
+export interface CoveragePartitionCoordinatorOptions {
|
|
|
+ /** Repository root that owns coverage output. */
|
|
|
+ root: string
|
|
|
+ /** Number of concurrent single-worker Vitest processes. */
|
|
|
+ partitions: number
|
|
|
+ /** pnpm JavaScript entrypoint from `npm_execpath`. */
|
|
|
+ pnpmEntrypoint: string
|
|
|
+ /** Additional arguments shared by every partition. */
|
|
|
+ vitestArgs?: string[]
|
|
|
+ /** Child executor, injectable for scheduler tests. */
|
|
|
+ runCommand?: CoverageCommandRunner
|
|
|
+}
|
|
|
+
|
|
|
+/** Parse an optional coverage partition count. */
|
|
|
+export function parseCoveragePartitionCount(raw: string | undefined): number | undefined {
|
|
|
+ if (raw === undefined || raw === '') return undefined
|
|
|
+ const parsed = Number.parseInt(raw, 10)
|
|
|
+ if (!Number.isSafeInteger(parsed) || parsed < 2 || String(parsed) !== raw) {
|
|
|
+ throw new Error(`${COVERAGE_PARTITIONS_ENV} must be an integer greater than 1, got ${JSON.stringify(raw)}.`)
|
|
|
+ }
|
|
|
+ return parsed
|
|
|
+}
|
|
|
+
|
|
|
+/** Resolve the paired Vitest timeout arguments used by coverage partitions. */
|
|
|
+export function coverageTestTimeoutArgs(raw: string | undefined): string[] {
|
|
|
+ if (raw === undefined || raw === '') return []
|
|
|
+ const parsed = Number.parseInt(raw, 10)
|
|
|
+ if (!Number.isSafeInteger(parsed) || parsed < 1 || String(parsed) !== raw) {
|
|
|
+ throw new Error(`${COVERAGE_TEST_TIMEOUT_ENV} must be a positive integer, got ${JSON.stringify(raw)}.`)
|
|
|
+ }
|
|
|
+ return [`--testTimeout=${raw}`, `--expect.poll.timeout=${raw}`]
|
|
|
+}
|
|
|
+
|
|
|
+/** Remove pnpm's package-script separator before forwarding Vitest arguments. */
|
|
|
+export function forwardedCoverageArgs(args: readonly string[]): string[] {
|
|
|
+ return [...args.slice(args[0] === '--' ? 1 : 0)]
|
|
|
+}
|
|
|
+
|
|
|
+/** Run instrumented partitions, validate their blobs, and merge once. */
|
|
|
+export class CoveragePartitionCoordinator {
|
|
|
+ private readonly root: string
|
|
|
+ private readonly partitions: number
|
|
|
+ private readonly pnpmEntrypoint: string
|
|
|
+ private readonly vitestArgs: string[]
|
|
|
+ private readonly runCommand: CoverageCommandRunner
|
|
|
+ private readonly temporaryRoot: string
|
|
|
+ private readonly blobsRoot: string
|
|
|
+
|
|
|
+ /** Create a coordinator from validated process-independent inputs. */
|
|
|
+ public constructor(options: CoveragePartitionCoordinatorOptions) {
|
|
|
+ if (!Number.isSafeInteger(options.partitions) || options.partitions < 2) {
|
|
|
+ throw new Error(`coverage partitions must be an integer greater than 1, got ${String(options.partitions)}.`)
|
|
|
+ }
|
|
|
+ this.root = options.root
|
|
|
+ this.partitions = options.partitions
|
|
|
+ this.pnpmEntrypoint = options.pnpmEntrypoint
|
|
|
+ this.vitestArgs = options.vitestArgs ?? []
|
|
|
+ this.runCommand = options.runCommand ?? runCoverageCommand
|
|
|
+ this.temporaryRoot = join(this.root, 'coverage', '.partitioned')
|
|
|
+ this.blobsRoot = join(this.temporaryRoot, 'blobs')
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Run every partition before one merged threshold check.
|
|
|
+ * @returns zero only when every partition and the merge command succeed.
|
|
|
+ */
|
|
|
+ public async run(): Promise<number> {
|
|
|
+ await removeOwnedTree(join(this.root, 'coverage'))
|
|
|
+ await mkdir(this.blobsRoot, { recursive: true })
|
|
|
+
|
|
|
+ try {
|
|
|
+ const commands = Array.from(
|
|
|
+ { length: this.partitions },
|
|
|
+ (_, index) => this.partitionCommand(index + 1),
|
|
|
+ )
|
|
|
+ const results = await Promise.all(commands.map(async (command) => {
|
|
|
+ console.log(`coverage-partitions: start ${command.label}`)
|
|
|
+ const result = await this.runCommand(command)
|
|
|
+ if (commandFailed(result)) {
|
|
|
+ console.error(`coverage-partitions: FAIL ${command.label} (${commandFailureReason(result)})`)
|
|
|
+ }
|
|
|
+ return result
|
|
|
+ }))
|
|
|
+ await this.assertCompleteBlobSet(commands)
|
|
|
+
|
|
|
+ const mergeCommand = this.mergeCommand()
|
|
|
+ console.log(`coverage-partitions: start ${mergeCommand.label}`)
|
|
|
+ const mergeResult = await this.runCommand(mergeCommand)
|
|
|
+ return results.some(commandFailed) || commandFailed(mergeResult) ? 1 : 0
|
|
|
+ } finally {
|
|
|
+ await removeOwnedTree(this.temporaryRoot)
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ private partitionCommand(index: number): CoverageCommand {
|
|
|
+ const blobPath = join(this.blobsRoot, `partition-${index}.json`)
|
|
|
+ const reportsDirectory = join(this.temporaryRoot, `coverage-${index}`)
|
|
|
+ return {
|
|
|
+ label: `partition ${index}/${this.partitions}`,
|
|
|
+ args: [
|
|
|
+ this.pnpmEntrypoint,
|
|
|
+ 'exec',
|
|
|
+ 'vitest',
|
|
|
+ 'run',
|
|
|
+ '--coverage',
|
|
|
+ '--coverage.reportOnFailure',
|
|
|
+ '--maxWorkers=1',
|
|
|
+ `--shard=${index}/${this.partitions}`,
|
|
|
+ '--reporter=default',
|
|
|
+ '--reporter=blob',
|
|
|
+ `--outputFile.blob=${this.relativePath(blobPath)}`,
|
|
|
+ `--coverage.reportsDirectory=${this.relativePath(reportsDirectory)}`,
|
|
|
+ ...this.vitestArgs,
|
|
|
+ ],
|
|
|
+ env: {
|
|
|
+ [COVERAGE_PARTITIONS_ENV]: undefined,
|
|
|
+ [COVERAGE_PARTITION_MODE_ENV]: '1',
|
|
|
+ },
|
|
|
+ cwd: this.root,
|
|
|
+ blobPath,
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ private mergeCommand(): CoverageCommand {
|
|
|
+ return {
|
|
|
+ label: 'merged coverage report',
|
|
|
+ args: [
|
|
|
+ this.pnpmEntrypoint,
|
|
|
+ 'exec',
|
|
|
+ 'vitest',
|
|
|
+ `--merge-reports=${this.relativePath(this.blobsRoot)}`,
|
|
|
+ '--coverage',
|
|
|
+ ],
|
|
|
+ env: {
|
|
|
+ [COVERAGE_PARTITIONS_ENV]: undefined,
|
|
|
+ [COVERAGE_PARTITION_MODE_ENV]: undefined,
|
|
|
+ },
|
|
|
+ cwd: this.root,
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ private relativePath(path: string): string {
|
|
|
+ return relative(this.root, path).split(sep).join('/')
|
|
|
+ }
|
|
|
+
|
|
|
+ private async assertCompleteBlobSet(commands: CoverageCommand[]): Promise<void> {
|
|
|
+ const expected = commands.map((command) => {
|
|
|
+ if (command.blobPath === undefined) throw new Error(`${command.label} has no blob path.`)
|
|
|
+ return this.relativePath(command.blobPath)
|
|
|
+ }).sort()
|
|
|
+ const actual = (await readdir(this.blobsRoot))
|
|
|
+ .map(name => this.relativePath(join(this.blobsRoot, name)))
|
|
|
+ .sort()
|
|
|
+ if (actual.length !== expected.length || actual.some((name, index) => name !== expected[index])) {
|
|
|
+ throw new Error(`coverage partitions produced ${JSON.stringify(actual)}; expected ${JSON.stringify(expected)}.`)
|
|
|
+ }
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+/** Spawn one pnpm-backed command without a platform shell. */
|
|
|
+function runCoverageCommand(command: CoverageCommand): Promise<CoverageCommandResult> {
|
|
|
+ return new Promise((resolveCommand) => {
|
|
|
+ const env = { ...process.env }
|
|
|
+ for (const [name, value] of Object.entries(command.env)) {
|
|
|
+ if (value === undefined) Reflect.deleteProperty(env, name)
|
|
|
+ else env[name] = value
|
|
|
+ }
|
|
|
+ const child = spawn(process.execPath, command.args, {
|
|
|
+ cwd: command.cwd,
|
|
|
+ env,
|
|
|
+ stdio: 'inherit',
|
|
|
+ })
|
|
|
+ child.once('error', (error: Error) => {
|
|
|
+ resolveCommand({ exitCode: null, signalCode: null, error: error.message })
|
|
|
+ })
|
|
|
+ child.once('exit', (exitCode, signalCode) => {
|
|
|
+ resolveCommand({ exitCode, signalCode })
|
|
|
+ })
|
|
|
+ })
|
|
|
+}
|
|
|
+
|
|
|
+function commandFailed(result: CoverageCommandResult): boolean {
|
|
|
+ return result.exitCode !== 0 || result.signalCode !== null || result.error !== undefined
|
|
|
+}
|
|
|
+
|
|
|
+function commandFailureReason(result: CoverageCommandResult): string {
|
|
|
+ const facts = [
|
|
|
+ result.error,
|
|
|
+ result.exitCode === null ? undefined : `exit ${result.exitCode}`,
|
|
|
+ result.signalCode === null ? undefined : `signal ${result.signalCode}`,
|
|
|
+ ].filter((fact): fact is string => fact !== undefined)
|
|
|
+ return facts.join(', ') || 'no exit code or signal'
|
|
|
+}
|
|
|
+
|
|
|
+async function removeOwnedTree(path: string): Promise<void> {
|
|
|
+ const metadata = await lstat(path).catch((error: unknown) => {
|
|
|
+ if (error instanceof Error && 'code' in error && error.code === 'ENOENT') return undefined
|
|
|
+ throw error
|
|
|
+ })
|
|
|
+ if (metadata === undefined) return
|
|
|
+ if (metadata.isSymbolicLink() || !metadata.isDirectory()) {
|
|
|
+ await unlink(path)
|
|
|
+ return
|
|
|
+ }
|
|
|
+ await rm(path, { recursive: true, force: true })
|
|
|
+}
|