verify-application-entrypoints.ts 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. /**
  2. * Enforce dsh profiles as the only supported Node application launcher.
  3. * Vendor CLIs, build tools, and test tools are explicit classifications
  4. * rather than implicit holes.
  5. */
  6. import { existsSync, globSync, readFileSync } from 'node:fs'
  7. import { resolve, sep } from 'node:path'
  8. import { pathToFileURL } from 'node:url'
  9. type ManifestBin = string | Record<string, string>
  10. interface PackageManifest {
  11. readonly bin?: unknown
  12. }
  13. interface RootManifest {
  14. readonly scripts?: Record<string, unknown>
  15. }
  16. interface DemoPolicy {
  17. readonly kind: 'dsh-direct' | 'dsh-wrapper'
  18. readonly wrapper?: string
  19. }
  20. /** Public product launcher plus the private build-only WebWorker packer. */
  21. const MANIFEST_BIN_ALLOWLIST = new Map<string, ManifestBin>([
  22. ['apps/cli/package.json', { dsh: 'lib/bin.js' }],
  23. ['packages/experimental/webworker-packer/package.json', { 'dsh-pack-vfs-image': './bin.js' }],
  24. ])
  25. /** Every executable in a Node application workspace has one explicit role. */
  26. const EXECUTABLE_SOURCE_ALLOWLIST = new Map<string, string>([
  27. ['apps/cli/src/bin.ts', 'supported dsh application launcher'],
  28. ['packages/context/time-context/tests/fixtures/driver.ts', 'test-only subprocess driver'],
  29. ['packages/experimental/webworker-packer/bin.js', 'private build-only wrapper'],
  30. ['packages/experimental/webworker-packer/src/bin.ts', 'private build-only implementation'],
  31. ['packages/sdk/client/tests/fake-runtime.ts', 'test-only SDK runtime peer'],
  32. ['packages/session/session-telemetry-otel/tests/fixtures/driver.ts', 'test-only subprocess driver'],
  33. ['packages/shell/tool-pwsh/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
  34. ['packages/subagent/subagent-acp/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
  35. ['packages/subagent/subagent-claude-code/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
  36. ['packages/subagent/subagent-codex/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
  37. ['packages/subagent/subagent-dsh-sdk/tests/fixtures/loader/driver.ts', 'test-only subprocess driver'],
  38. ['packages/test-support/loader-smoke/tests/fixtures/headless-driver.ts', 'test-only subprocess driver'],
  39. ['packages/test-support/llm-mock-server/src/bin.ts', 'test-only model server'],
  40. ])
  41. /** Root demos are application wrappers and therefore must visibly select dsh. */
  42. const ROOT_DEMO_POLICIES = new Map<string, DemoPolicy>([
  43. ['demo:ptc', { kind: 'dsh-wrapper', wrapper: 'scripts/demo-ptc.mjs' }],
  44. ['demo:inspector', { kind: 'dsh-direct' }],
  45. ])
  46. const SOURCE_PATTERNS = [
  47. '*.ts',
  48. '*.js',
  49. '*.mjs',
  50. '*.cjs',
  51. 'apps/**/*.ts',
  52. 'apps/**/*.js',
  53. 'apps/**/*.mjs',
  54. 'apps/**/*.cjs',
  55. 'packages/**/*.ts',
  56. 'packages/**/*.js',
  57. 'packages/**/*.mjs',
  58. 'packages/**/*.cjs',
  59. ]
  60. const SOURCE_EXCLUDES = [
  61. '**/node_modules/**',
  62. '**/lib/**',
  63. '**/dist/**',
  64. '**/coverage/**',
  65. ]
  66. /** Convert a host path from glob output to the repository's slash form. */
  67. function repositoryPath(path: string): string {
  68. return path.split(sep).join('/')
  69. }
  70. /** Stable comparison for string and object npm `bin` declarations. */
  71. function normalizedBin(value: unknown): string | undefined {
  72. if (typeof value === 'string') return JSON.stringify(value)
  73. if (!isRecord(value)) return undefined
  74. const entries = Object.entries(value)
  75. if (!entries.every(([, target]) => typeof target === 'string')) return undefined
  76. return JSON.stringify(Object.fromEntries(entries.sort(([left], [right]) => left.localeCompare(right))))
  77. }
  78. function manifestBinViolations(root: string): string[] {
  79. const failures: string[] = []
  80. const manifests = globSync(['apps/*/package.json', 'packages/*/*/package.json'], { cwd: root }).sort()
  81. for (const rawPath of manifests) {
  82. const path = repositoryPath(rawPath)
  83. const manifest = JSON.parse(readFileSync(resolve(root, path), 'utf8')) as PackageManifest
  84. if (manifest.bin === undefined) continue
  85. const expected = MANIFEST_BIN_ALLOWLIST.get(path)
  86. if (expected === undefined) {
  87. failures.push(`${path}: package bin bypasses the dsh launcher; applications use apps/cli profiles`)
  88. continue
  89. }
  90. if (normalizedBin(manifest.bin) !== normalizedBin(expected)) {
  91. failures.push(`${path}: classified bin must remain ${JSON.stringify(expected)}, got ${JSON.stringify(manifest.bin)}`)
  92. }
  93. }
  94. return failures
  95. }
  96. function executableSourceViolations(root: string): string[] {
  97. const failures: string[] = []
  98. for (const rawPath of globSync(SOURCE_PATTERNS, { cwd: root, exclude: SOURCE_EXCLUDES }).sort()) {
  99. const path = repositoryPath(rawPath)
  100. const source = readFileSync(resolve(root, path), 'utf8')
  101. if (!source.startsWith('#!')) continue
  102. if (!EXECUTABLE_SOURCE_ALLOWLIST.has(path)) {
  103. failures.push(`${path}: executable source has no application/build/test classification`)
  104. }
  105. }
  106. return failures
  107. }
  108. function referencesDshCli(source: string): boolean {
  109. return source.includes('apps/cli/src/bin.ts')
  110. }
  111. function referencesPackageEntry(source: string): boolean {
  112. return /packages\/[^/\s'"`]+\/[^/\s'"`]+\/(?:src|lib)\/[^\s'"`]+/.test(source)
  113. }
  114. function rootDemoViolations(root: string): string[] {
  115. const manifestPath = resolve(root, 'package.json')
  116. if (!existsSync(manifestPath)) return []
  117. const manifest = JSON.parse(readFileSync(manifestPath, 'utf8')) as RootManifest
  118. const failures: string[] = []
  119. for (const [name, commandValue] of Object.entries(manifest.scripts ?? {}).sort(([left], [right]) => left.localeCompare(right))) {
  120. if (!name.startsWith('demo:')) continue
  121. const command = typeof commandValue === 'string' ? commandValue : ''
  122. const policy = ROOT_DEMO_POLICIES.get(name)
  123. if (policy === undefined) {
  124. failures.push(`package.json scripts.${name}: demo launcher has no explicit dsh or in-process classification`)
  125. continue
  126. }
  127. if (policy.kind === 'dsh-direct') {
  128. if (!referencesDshCli(command)) failures.push(`package.json scripts.${name}: application demo must launch apps/cli/src/bin.ts`)
  129. if (referencesPackageEntry(command)) failures.push(`package.json scripts.${name}: application demo must not launch a package entry directly`)
  130. continue
  131. }
  132. const wrapper = policy.wrapper
  133. if (wrapper === undefined || !command.includes(wrapper)) {
  134. failures.push(`package.json scripts.${name}: classified wrapper must be ${String(wrapper)}`)
  135. continue
  136. }
  137. const wrapperPath = resolve(root, wrapper)
  138. if (!existsSync(wrapperPath)) {
  139. failures.push(`${wrapper}: classified demo wrapper is missing`)
  140. continue
  141. }
  142. const source = readFileSync(wrapperPath, 'utf8')
  143. if (!referencesDshCli(source)) failures.push(`${wrapper}: application demo wrapper must launch apps/cli/src/bin.ts`)
  144. if (referencesPackageEntry(source)) failures.push(`${wrapper}: application demo wrapper must not launch a package entry directly`)
  145. }
  146. return failures
  147. }
  148. /**
  149. * Find unsupported application entrypoints below a repository root.
  150. * @param root - repository or test-fixture root.
  151. * @returns deterministic path-qualified violations.
  152. */
  153. export function applicationEntrypointViolations(root: string): string[] {
  154. return [
  155. ...manifestBinViolations(root),
  156. ...executableSourceViolations(root),
  157. ...rootDemoViolations(root),
  158. ]
  159. }
  160. function isRecord(value: unknown): value is Record<string, unknown> {
  161. return typeof value === 'object' && value !== null && !Array.isArray(value)
  162. }
  163. if (process.argv[1] !== undefined && import.meta.url === pathToFileURL(resolve(process.argv[1])).href) {
  164. const root = resolve(import.meta.dirname, '..')
  165. const failures = applicationEntrypointViolations(root)
  166. if (failures.length > 0) {
  167. console.error('verify-application-entrypoints: unsupported launcher(s):')
  168. for (const failure of failures) console.error(` ${failure}`)
  169. process.exitCode = 1
  170. } else {
  171. console.log('verify-application-entrypoints: dsh is the only supported Node application launcher.')
  172. }
  173. }