| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193 |
- /**
- * Enforce dsh profiles as the only supported Node application launcher.
- * Vendor CLIs, build tools, and test tools are explicit classifications
- * rather than implicit holes.
- */
- import { existsSync, globSync, readFileSync } from 'node:fs'
- import { resolve, sep } from 'node:path'
- import { pathToFileURL } from 'node:url'
- type ManifestBin = string | Record<string, string>
- interface PackageManifest {
- readonly bin?: unknown
- }
- interface RootManifest {
- readonly scripts?: Record<string, unknown>
- }
- interface DemoPolicy {
- readonly kind: 'dsh-direct' | 'dsh-wrapper'
- readonly wrapper?: string
- }
- /** Public product launcher plus the private build-only WebWorker packer. */
- const MANIFEST_BIN_ALLOWLIST = new Map<string, ManifestBin>([
- ['apps/cli/package.json', { dsh: 'lib/bin.js' }],
- ['packages/experimental/webworker-packer/package.json', { 'dsh-pack-vfs-image': './bin.js' }],
- ])
- /** Every executable in a Node application workspace has one explicit role. */
- const EXECUTABLE_SOURCE_ALLOWLIST = new Map<string, string>([
- ['apps/cli/src/bin.ts', 'supported dsh application launcher'],
- ['packages/context/time-context/tests/fixtures/driver.ts', 'test-only subprocess driver'],
- ['packages/experimental/webworker-packer/bin.js', 'private build-only wrapper'],
- ['packages/experimental/webworker-packer/src/bin.ts', 'private build-only implementation'],
- ['packages/sdk/client/tests/fake-runtime.ts', 'test-only SDK runtime peer'],
- ['packages/session/session-telemetry-otel/tests/fixtures/driver.ts', 'test-only subprocess driver'],
- ['packages/shell/tool-pwsh/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
- ['packages/subagent/subagent-acp/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
- ['packages/subagent/subagent-claude-code/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
- ['packages/subagent/subagent-codex/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
- ['packages/subagent/subagent-dsh-sdk/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
- ['packages/test-support/loader-smoke/tests/fixtures/headless-driver.ts', 'test-only subprocess driver'],
- ['packages/test-support/llm-mock-server/src/bin.ts', 'test-only model server'],
- ])
- /** Root demos are application wrappers and therefore must visibly select dsh. */
- const ROOT_DEMO_POLICIES = new Map<string, DemoPolicy>([
- ['demo:ptc', { kind: 'dsh-wrapper', wrapper: 'scripts/demo-ptc.mjs' }],
- ['demo:inspector', { kind: 'dsh-direct' }],
- ])
- const SOURCE_PATTERNS = [
- '*.ts',
- '*.js',
- '*.mjs',
- '*.cjs',
- 'apps/**/*.ts',
- 'apps/**/*.js',
- 'apps/**/*.mjs',
- 'apps/**/*.cjs',
- 'packages/**/*.ts',
- 'packages/**/*.js',
- 'packages/**/*.mjs',
- 'packages/**/*.cjs',
- ]
- const SOURCE_EXCLUDES = [
- '**/node_modules/**',
- '**/lib/**',
- '**/dist/**',
- '**/coverage/**',
- ]
- /** Convert a host path from glob output to the repository's slash form. */
- function repositoryPath(path: string): string {
- return path.split(sep).join('/')
- }
- /** Stable comparison for string and object npm `bin` declarations. */
- function normalizedBin(value: unknown): string | undefined {
- if (typeof value === 'string') return JSON.stringify(value)
- if (!isRecord(value)) return undefined
- const entries = Object.entries(value)
- if (!entries.every(([, target]) => typeof target === 'string')) return undefined
- return JSON.stringify(Object.fromEntries(entries.sort(([left], [right]) => left.localeCompare(right))))
- }
- function manifestBinViolations(root: string): string[] {
- const failures: string[] = []
- const manifests = globSync(['apps/*/package.json', 'packages/*/*/package.json'], { cwd: root }).sort()
- for (const rawPath of manifests) {
- const path = repositoryPath(rawPath)
- const manifest = JSON.parse(readFileSync(resolve(root, path), 'utf8')) as PackageManifest
- if (manifest.bin === undefined) continue
- const expected = MANIFEST_BIN_ALLOWLIST.get(path)
- if (expected === undefined) {
- failures.push(`${path}: package bin bypasses the dsh launcher; applications use apps/cli profiles`)
- continue
- }
- if (normalizedBin(manifest.bin) !== normalizedBin(expected)) {
- failures.push(`${path}: classified bin must remain ${JSON.stringify(expected)}, got ${JSON.stringify(manifest.bin)}`)
- }
- }
- return failures
- }
- function executableSourceViolations(root: string): string[] {
- const failures: string[] = []
- for (const rawPath of globSync(SOURCE_PATTERNS, { cwd: root, exclude: SOURCE_EXCLUDES }).sort()) {
- const path = repositoryPath(rawPath)
- const source = readFileSync(resolve(root, path), 'utf8')
- if (!source.startsWith('#!')) continue
- if (!EXECUTABLE_SOURCE_ALLOWLIST.has(path)) {
- failures.push(`${path}: executable source has no application/build/test classification`)
- }
- }
- return failures
- }
- function referencesDshCli(source: string): boolean {
- return source.includes('apps/cli/src/bin.ts')
- }
- function referencesPackageEntry(source: string): boolean {
- return /packages\/[^/\s'"`]+\/[^/\s'"`]+\/(?:src|lib)\/[^\s'"`]+/.test(source)
- }
- function rootDemoViolations(root: string): string[] {
- const manifestPath = resolve(root, 'package.json')
- if (!existsSync(manifestPath)) return []
- const manifest = JSON.parse(readFileSync(manifestPath, 'utf8')) as RootManifest
- const failures: string[] = []
- for (const [name, commandValue] of Object.entries(manifest.scripts ?? {}).sort(([left], [right]) => left.localeCompare(right))) {
- if (!name.startsWith('demo:')) continue
- const command = typeof commandValue === 'string' ? commandValue : ''
- const policy = ROOT_DEMO_POLICIES.get(name)
- if (policy === undefined) {
- failures.push(`package.json scripts.${name}: demo launcher has no explicit dsh or in-process classification`)
- continue
- }
- if (policy.kind === 'dsh-direct') {
- if (!referencesDshCli(command)) failures.push(`package.json scripts.${name}: application demo must launch apps/cli/src/bin.ts`)
- if (referencesPackageEntry(command)) failures.push(`package.json scripts.${name}: application demo must not launch a package entry directly`)
- continue
- }
- const wrapper = policy.wrapper
- if (wrapper === undefined || !command.includes(wrapper)) {
- failures.push(`package.json scripts.${name}: classified wrapper must be ${String(wrapper)}`)
- continue
- }
- const wrapperPath = resolve(root, wrapper)
- if (!existsSync(wrapperPath)) {
- failures.push(`${wrapper}: classified demo wrapper is missing`)
- continue
- }
- const source = readFileSync(wrapperPath, 'utf8')
- if (!referencesDshCli(source)) failures.push(`${wrapper}: application demo wrapper must launch apps/cli/src/bin.ts`)
- if (referencesPackageEntry(source)) failures.push(`${wrapper}: application demo wrapper must not launch a package entry directly`)
- }
- return failures
- }
- /**
- * Find unsupported application entrypoints below a repository root.
- * @param root - repository or test-fixture root.
- * @returns deterministic path-qualified violations.
- */
- export function applicationEntrypointViolations(root: string): string[] {
- return [
- ...manifestBinViolations(root),
- ...executableSourceViolations(root),
- ...rootDemoViolations(root),
- ]
- }
- function isRecord(value: unknown): value is Record<string, unknown> {
- return typeof value === 'object' && value !== null && !Array.isArray(value)
- }
- if (process.argv[1] !== undefined && import.meta.url === pathToFileURL(resolve(process.argv[1])).href) {
- const root = resolve(import.meta.dirname, '..')
- const failures = applicationEntrypointViolations(root)
- if (failures.length > 0) {
- console.error('verify-application-entrypoints: unsupported launcher(s):')
- for (const failure of failures) console.error(` ${failure}`)
- process.exitCode = 1
- } else {
- console.log('verify-application-entrypoints: dsh is the only supported Node application launcher.')
- }
- }
|