verify-application-entrypoints.ts 8.0 KB

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