verify-application-entrypoints.ts 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  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:code-mode', { kind: 'dsh-wrapper', wrapper: 'scripts/demo-code-mode.mjs' }],
  44. ])
  45. const SOURCE_PATTERNS = [
  46. '*.ts',
  47. '*.js',
  48. '*.mjs',
  49. '*.cjs',
  50. 'apps/**/*.ts',
  51. 'apps/**/*.js',
  52. 'apps/**/*.mjs',
  53. 'apps/**/*.cjs',
  54. 'packages/**/*.ts',
  55. 'packages/**/*.js',
  56. 'packages/**/*.mjs',
  57. 'packages/**/*.cjs',
  58. ]
  59. const SOURCE_EXCLUDES = [
  60. '**/node_modules/**',
  61. '**/lib/**',
  62. '**/dist/**',
  63. '**/coverage/**',
  64. ]
  65. /** Convert a host path from glob output to the repository's slash form. */
  66. function repositoryPath(path: string): string {
  67. return path.split(sep).join('/')
  68. }
  69. /** Stable comparison for string and object npm `bin` declarations. */
  70. function normalizedBin(value: unknown): string | undefined {
  71. if (typeof value === 'string') return JSON.stringify(value)
  72. if (!isRecord(value)) return undefined
  73. const entries = Object.entries(value)
  74. if (!entries.every(([, target]) => typeof target === 'string')) return undefined
  75. return JSON.stringify(Object.fromEntries(entries.sort(([left], [right]) => left.localeCompare(right))))
  76. }
  77. function manifestBinViolations(root: string): string[] {
  78. const failures: string[] = []
  79. const manifests = globSync(['apps/*/package.json', 'packages/*/*/package.json'], { cwd: root }).sort()
  80. for (const rawPath of manifests) {
  81. const path = repositoryPath(rawPath)
  82. const manifest = JSON.parse(readFileSync(resolve(root, path), 'utf8')) as PackageManifest
  83. if (manifest.bin === undefined) continue
  84. const expected = MANIFEST_BIN_ALLOWLIST.get(path)
  85. if (expected === undefined) {
  86. failures.push(`${path}: package bin bypasses the dsh launcher; applications use apps/cli profiles`)
  87. continue
  88. }
  89. if (normalizedBin(manifest.bin) !== normalizedBin(expected)) {
  90. failures.push(`${path}: classified bin must remain ${JSON.stringify(expected)}, got ${JSON.stringify(manifest.bin)}`)
  91. }
  92. }
  93. return failures
  94. }
  95. function executableSourceViolations(root: string): string[] {
  96. const failures: string[] = []
  97. for (const rawPath of globSync(SOURCE_PATTERNS, { cwd: root, exclude: SOURCE_EXCLUDES }).sort()) {
  98. const path = repositoryPath(rawPath)
  99. const source = readFileSync(resolve(root, path), 'utf8')
  100. if (!source.startsWith('#!')) continue
  101. if (!EXECUTABLE_SOURCE_ALLOWLIST.has(path)) {
  102. failures.push(`${path}: executable source has no application/build/test classification`)
  103. }
  104. }
  105. return failures
  106. }
  107. function referencesDshCli(source: string): boolean {
  108. return source.includes('apps/cli/src/bin.ts')
  109. }
  110. function referencesPackageEntry(source: string): boolean {
  111. return /packages\/[^/\s'"`]+\/[^/\s'"`]+\/(?:src|lib)\/[^\s'"`]+/.test(source)
  112. }
  113. function rootDemoViolations(root: string): string[] {
  114. const manifestPath = resolve(root, 'package.json')
  115. if (!existsSync(manifestPath)) return []
  116. const manifest = JSON.parse(readFileSync(manifestPath, 'utf8')) as RootManifest
  117. const failures: string[] = []
  118. for (const [name, commandValue] of Object.entries(manifest.scripts ?? {}).sort(([left], [right]) => left.localeCompare(right))) {
  119. if (!name.startsWith('demo:')) continue
  120. const command = typeof commandValue === 'string' ? commandValue : ''
  121. const policy = ROOT_DEMO_POLICIES.get(name)
  122. if (policy === undefined) {
  123. failures.push(`package.json scripts.${name}: demo launcher has no explicit dsh or in-process classification`)
  124. continue
  125. }
  126. if (policy.kind === 'dsh-direct') {
  127. if (!referencesDshCli(command)) failures.push(`package.json scripts.${name}: application demo must launch apps/cli/src/bin.ts`)
  128. if (referencesPackageEntry(command)) failures.push(`package.json scripts.${name}: application demo must not launch a package entry directly`)
  129. continue
  130. }
  131. const wrapper = policy.wrapper
  132. if (wrapper === undefined || !command.includes(wrapper)) {
  133. failures.push(`package.json scripts.${name}: classified wrapper must be ${String(wrapper)}`)
  134. continue
  135. }
  136. const wrapperPath = resolve(root, wrapper)
  137. if (!existsSync(wrapperPath)) {
  138. failures.push(`${wrapper}: classified demo wrapper is missing`)
  139. continue
  140. }
  141. const source = readFileSync(wrapperPath, 'utf8')
  142. if (!referencesDshCli(source)) failures.push(`${wrapper}: application demo wrapper must launch apps/cli/src/bin.ts`)
  143. if (referencesPackageEntry(source)) failures.push(`${wrapper}: application demo wrapper must not launch a package entry directly`)
  144. }
  145. return failures
  146. }
  147. /**
  148. * Find unsupported application entrypoints below a repository root.
  149. * @param root - repository or test-fixture root.
  150. * @returns deterministic path-qualified violations.
  151. */
  152. export function applicationEntrypointViolations(root: string): string[] {
  153. return [
  154. ...manifestBinViolations(root),
  155. ...executableSourceViolations(root),
  156. ...rootDemoViolations(root),
  157. ]
  158. }
  159. function isRecord(value: unknown): value is Record<string, unknown> {
  160. return typeof value === 'object' && value !== null && !Array.isArray(value)
  161. }
  162. if (process.argv[1] !== undefined && import.meta.url === pathToFileURL(resolve(process.argv[1])).href) {
  163. const root = resolve(import.meta.dirname, '..')
  164. const failures = applicationEntrypointViolations(root)
  165. if (failures.length > 0) {
  166. console.error('verify-application-entrypoints: unsupported launcher(s):')
  167. for (const failure of failures) console.error(` ${failure}`)
  168. process.exitCode = 1
  169. } else {
  170. console.log('verify-application-entrypoints: dsh is the only supported Node application launcher.')
  171. }
  172. }