Repository navigation
Expand file tree
/
Copy pathverify-application-entrypoints.ts
More file actions
203 lines (183 loc) · 8.26 KB
/
Copy pathverify-application-entrypoints.ts
File metadata and controls
203 lines (183 loc) · 8.26 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/**
* 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 LauncherPolicy {
readonly kind: 'dsh-direct' | 'dsh-wrapper'
readonly wrapper?: string
}
/** Public product launcher plus the 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 JavaScript executable in an application or packaging workspace has one explicit role. */
const EXECUTABLE_SOURCE_ALLOWLIST = new Map<string, string>([
['apps/cli/src/bin.ts', 'supported dsh application launcher'],
['apps/desktop/scripts/logged-notarytool.mjs', 'build-only notarization logging wrapper'],
['packages/context/time-context/tests/fixtures/driver.ts', 'test-only subprocess driver'],
['packages/experimental/webworker-packer/bin.js', 'build-only wrapper'],
['packages/experimental/webworker-packer/src/bin.ts', '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'],
['python/sdk-runtime/runtime-bootstrap.mjs', 'private packaging-only runtime dispatcher'],
])
/**
* Root scripts that start an application must visibly select dsh: every `demo:*`
* script needs a row here, and the Web start and development scripts are pinned
* by name.
*/
const ROOT_LAUNCHER_POLICIES = new Map<string, LauncherPolicy>([
['demo:ptc', { kind: 'dsh-wrapper', wrapper: 'scripts/demo-ptc.mjs' }],
['demo:inspector', { kind: 'dsh-direct' }],
['start:web', { kind: 'dsh-direct' }],
['dev:web', { kind: 'dsh-wrapper', wrapper: 'scripts/dev-web.ts' }],
])
const SOURCE_PATTERNS = [
'*.ts',
'*.js',
'*.mjs',
'*.cjs',
'apps/**/*.ts',
'apps/**/*.js',
'apps/**/*.mjs',
'apps/**/*.cjs',
'packages/**/*.ts',
'packages/**/*.js',
'packages/**/*.mjs',
'packages/**/*.cjs',
'python/sdk-runtime/*.mjs',
]
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 rootLauncherViolations(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))) {
const policy = ROOT_LAUNCHER_POLICIES.get(name)
if (policy === undefined) {
if (name.startsWith('demo:')) {
failures.push(`package.json scripts.${name}: demo launcher has no explicit dsh or in-process classification`)
}
continue
}
const command = typeof commandValue === 'string' ? commandValue : ''
if (policy.kind === 'dsh-direct') {
if (!referencesDshCli(command)) failures.push(`package.json scripts.${name}: application launcher script must launch apps/cli/src/bin.ts`)
if (referencesPackageEntry(command)) failures.push(`package.json scripts.${name}: application launcher script 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 launcher wrapper is missing`)
continue
}
const source = readFileSync(wrapperPath, 'utf8')
if (!referencesDshCli(source)) failures.push(`${wrapper}: application launcher wrapper must launch apps/cli/src/bin.ts`)
if (referencesPackageEntry(source)) failures.push(`${wrapper}: application launcher 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),
...rootLauncherViolations(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.')
}
}