verify-application-entrypoints.ts 7.9 KB

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