| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201 |
- import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
- import { tmpdir } from 'node:os'
- import { join } from 'node:path'
- import { afterEach, describe, expect, it } from 'vitest'
- import {
- collectPackageInvariantViolations,
- } from './package-invariants.ts'
- const roots: string[] = []
- afterEach(() => {
- for (const root of roots.splice(0)) rmSync(root, { recursive: true, force: true })
- })
- function handwrittenInvariant(packageName: string): string {
- return `
- export const name = 'probe-invariant'
- export const inject = ['invariants']
- const install = (ctx: { on(name: string, listener: (value: number) => void): void }, fail: (message: string) => never) => {
- ctx.on('probe/value', (value) => {
- if (value < 0) fail('observed values must be non-negative')
- })
- }
- export const apply = (ctx: { invariants: { register(name: string, install: typeof install): () => void } }) =>
- Promise.resolve(ctx.invariants.register(${JSON.stringify(packageName)}, install))
- `
- }
- function fixture(options: {
- packageName?: string
- source?: string
- invariantExport?: boolean
- invariantDependency?: boolean
- invariantReference?: boolean
- buildEntry?: boolean
- } = {}): string {
- const root = mkdtempSync(join(tmpdir(), 'dsh-package-invariants-'))
- roots.push(root)
- const dir = join(root, 'packages/core/probe')
- mkdirSync(join(dir, 'src'), { recursive: true })
- const packageName = options.packageName ?? '@deepseek-ai/dsh-probe'
- const manifest = {
- name: packageName,
- exports: options.invariantExport === false ? {} : {
- './invariant': {
- types: './lib/types/invariant.d.ts',
- default: './lib/invariant.js',
- },
- },
- files: ['lib/index.js', 'lib/invariant.js'],
- peerDependencies: options.invariantDependency === false ? {} : {
- '@deepseek-ai/dsh-invariants': 'workspace:^',
- },
- devDependencies: options.invariantDependency === false ? {} : {
- '@deepseek-ai/dsh-invariants': 'workspace:^',
- },
- }
- writeFileSync(join(dir, 'package.json'), `${JSON.stringify(manifest, null, 2)}\n`)
- writeFileSync(join(dir, 'tsconfig.json'), `${JSON.stringify({
- references: options.invariantReference === false ? [] : [{ path: '../../runtime-diagnostics/invariants' }],
- }, null, 2)}\n`)
- writeFileSync(join(dir, 'src/invariant.ts'), options.source ?? handwrittenInvariant(packageName))
- writeFileSync(
- join(dir, 'tsdown.config.ts'),
- options.buildEntry === false ? "export default { entry: ['lib/types/index.js'] }\n" : "export default { entry: ['lib/types/index.js', 'lib/types/invariant.js'] }\n",
- )
- return root
- }
- describe('package invariant gate', () => {
- it('accepts a hand-owned checking companion with publication metadata', () => {
- expect(collectPackageInvariantViolations(fixture())).toEqual([])
- })
- it('accepts an invariant reference owned by a package-local leaf project', () => {
- const root = fixture({ invariantReference: false })
- const dir = join(root, 'packages/core/probe')
- writeFileSync(join(dir, 'tsconfig.json'), `${JSON.stringify({
- files: [],
- references: [{ path: './tsconfig.host.json' }],
- }, null, 2)}\n`)
- writeFileSync(join(dir, 'tsconfig.host.json'), `${JSON.stringify({
- references: [{ path: '../../runtime-diagnostics/invariants' }],
- }, null, 2)}\n`)
- expect(collectPackageInvariantViolations(root)).toEqual([])
- })
- it('rejects missing publication metadata and build output', () => {
- const violations = collectPackageInvariantViolations(fixture({
- invariantExport: false,
- invariantDependency: false,
- invariantReference: false,
- buildEntry: false,
- }))
- expect(violations.map(violation => violation.message)).toEqual(expect.arrayContaining([
- expect.stringContaining('exports["./invariant"]'),
- expect.stringContaining('peerDependency'),
- expect.stringContaining('devDependency'),
- expect.stringContaining('TypeScript project references'),
- expect.stringContaining('must bundle lib/types/invariant.js'),
- ]))
- })
- it('rejects foreign, duplicate, and unresolved registrations', () => {
- const source = `
- export const name = 'probe-invariant'
- export const inject = ['invariants']
- const selected = process.env.PACKAGE_NAME
- const install = (_ctx: unknown, fail: (message: string) => never) => { fail('probe') }
- export const apply = (ctx: { invariants: { register(name: string, install: typeof install): () => void } }) => {
- ctx.invariants.register('@deepseek-ai/dsh-foreign', install)
- return ctx.invariants.register(selected!, install)
- }
- `
- const violations = collectPackageInvariantViolations(fixture({ source }))
- expect(violations.map(violation => violation.message)).toEqual(expect.arrayContaining([
- expect.stringContaining('must resolve to a local string constant'),
- expect.stringContaining('must register exactly its own package name'),
- ]))
- })
- it('rejects generated markers and reporter-free executable installers', () => {
- const generated = fixture({
- source: `/** @generated */\n${handwrittenInvariant('@deepseek-ai/dsh-probe')}`,
- })
- expect(collectPackageInvariantViolations(generated).map(violation => violation.message))
- .toContain('invariant companions must be hand-owned and may not carry @generated markers')
- const reporterFree = fixture({
- source: `
- export const name = 'probe-invariant'
- export const inject = ['invariants']
- const install = () => { void 0 }
- export const apply = (ctx: { invariants: { register(name: string, install: typeof install): () => void } }) =>
- Promise.resolve(ctx.invariants.register('@deepseek-ai/dsh-probe', install))
- `,
- })
- expect(collectPackageInvariantViolations(reporterFree).map(violation => violation.message))
- .toContain('install function must accept the bound failure reporter as its second parameter')
- const unused = fixture({
- source: `
- export const name = 'probe-invariant'
- export const inject = ['invariants']
- const install = (_ctx: unknown, _fail: (message: string) => never) => { void 0 }
- export const apply = (ctx: { invariants: { register(name: string, install: typeof install): () => void } }) =>
- Promise.resolve(ctx.invariants.register('@deepseek-ai/dsh-probe', install))
- `,
- })
- expect(collectPackageInvariantViolations(unused).map(violation => violation.message))
- .toContain('install function must use its bound failure reporter')
- })
- it('rejects registering a different installer than the checked local function', () => {
- const decoy = fixture({
- source: `
- export const name = 'probe-invariant'
- export const inject = ['invariants']
- const install = (_ctx: unknown, fail: (message: string) => never) => { fail('checked decoy') }
- export const apply = (ctx: { invariants: { register(name: string, install: () => void): () => void } }) =>
- ctx.invariants.register('@deepseek-ai/dsh-probe', () => {})
- `,
- })
- expect(collectPackageInvariantViolations(decoy).map(violation => violation.message))
- .toContain('line 6: ctx.invariants.register must use the checked local install function')
- })
- it.each([
- 'export default { name, inject, apply }',
- "export * as default from './probe.ts'",
- ])('rejects a default export that would collapse the Loader namespace', (defaultExport) => {
- const source = `${handwrittenInvariant('@deepseek-ai/dsh-probe')}\n${defaultExport}\n`
- expect(collectPackageInvariantViolations(fixture({ source })).map(violation => violation.message))
- .toContain('must not default-export; Loader must retain the companion namespace')
- })
- it('accepts explained empty installers and rejects unexplained ones', () => {
- const explained = `
- export const name = 'probe-invariant'
- export const inject = ['invariants']
- const PACKAGE_NAME = '@deepseek-ai/dsh-probe'
- /** No runtime invariant: this pure package owns no events or mutable data. */
- const install = () => {}
- export const apply = (ctx: { invariants: { register(name: string, install: () => void): () => void } }) =>
- ctx.invariants.register(PACKAGE_NAME, install)
- `
- expect(collectPackageInvariantViolations(fixture({ source: explained }))).toEqual([])
- const unexplained = `
- export const name = 'probe-invariant'
- export const inject = ['invariants']
- const PACKAGE_NAME = '@deepseek-ai/dsh-probe'
- const install = () => {}
- export const apply = (ctx: { invariants: { register(name: string, install: () => void): () => void } }) =>
- ctx.invariants.register(PACKAGE_NAME, install)
- `
- expect(collectPackageInvariantViolations(fixture({ source: unexplained })).map(violation => violation.message))
- .toContain('empty install function must explain why with a "No runtime invariant:" comment')
- })
- })
|