File size: 16,530 Bytes
ec8acdf | 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 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | // Shared static import-graph machinery for the Dockerfile/container guard
// tests (#5231 review follow-up). Single home for the comment-stripping
// tokenizer, edge extraction, resolution, Dockerfile COPY parsing, and BFS
// walks that were previously hand-copied across three guards:
// - tests/resilience-validation-import-graph.test.mjs (walkContainerGraph)
// - tests/dockerfile-relay-imports.test.mjs (collectRelativeImports/resolveNodeRelative)
// - tests/dockerfile-digest-notifications-imports.test.mjs (same scanner, copied)
// A fix to an extraction edge case lands here once and covers all three.
//
// This module is test infrastructure only β it lives under tests/ and is
// never COPY'd into any container image.
import { existsSync, readFileSync, statSync } from 'node:fs';
import { isBuiltin } from 'node:module';
import { dirname, extname, join, relative, resolve, sep } from 'node:path';
// Keywords after which a `/` in code position starts a REGEX LITERAL, not
// division (`return /x/.test(s)`, `typeof /x/`, `case /x/:` ...).
const REGEX_PRECEDING_KEYWORDS = /(?:^|[^$\w.])(?:return|typeof|case|delete|void|in|of|new|instanceof|yield|await|do|else)\s*$/;
// Structure-preserving comment strip. A state machine, not regexes: naive
// regex stripping misreads `/*` inside comment text or strings (a comment
// mentioning `@upstash/*` swallowed everything to the next `*/`, silently
// deleting real imports from extraction) and misreads `//` inside string
// literals. Comments are removed exactly; string/template/regex-literal
// contents and line structure are preserved.
//
// Regex literals get their own state: `/[/*]/` or `/a\/\*b/` would otherwise
// flip the tokenizer into block-comment state and swallow everything to the
// next `*/` or EOF β and a swallowed BARE import produces no visited node and
// no violation, so the deep-node canaries could NOT backstop that case (they
// only see dropped relative edges). Regex-vs-division at a `/` is decided by
// expression position: the last significant char (or a preceding keyword like
// `return`) says whether a regex can start there. Known residual limit: an
// exotic ASI shape could still misclassify division as a regex start β the
// self-test fixtures pin the realistic cases (char-class slashes, division,
// URLs in strings).
export function stripComments(src) {
let out = '';
let state = 'code'; // code | line | block | squote | dquote | template | regex
let inClass = false; // inside [...] while state === 'regex'
let lastSig = ''; // last non-whitespace char emitted in code state
let i = 0;
const regexCanStart = () =>
lastSig === '' ||
'([{,;=:?!&|^~%*+-<>'.includes(lastSig) ||
(lastSig === '/' ? false : /[$\w]/.test(lastSig) && REGEX_PRECEDING_KEYWORDS.test(out));
while (i < src.length) {
const c = src[i];
const n = src[i + 1];
if (state === 'code') {
if (c === '/' && n === '/') { state = 'line'; i += 2; continue; }
if (c === '/' && n === '*') { state = 'block'; i += 2; continue; }
if (c === '/' && regexCanStart()) { state = 'regex'; inClass = false; out += c; i += 1; continue; }
if (c === "'") state = 'squote';
else if (c === '"') state = 'dquote';
else if (c === '`') state = 'template';
if (!/\s/.test(c)) lastSig = c;
out += c; i += 1; continue;
}
if (state === 'line') {
if (c === '\n') { state = 'code'; out += c; }
i += 1; continue;
}
if (state === 'block') {
if (c === '*' && n === '/') { state = 'code'; i += 2; continue; }
if (c === '\n') out += c;
i += 1; continue;
}
if (state === 'regex') {
if (c === '\\') { out += c + (n ?? ''); i += 2; continue; }
if (c === '[') inClass = true;
else if (c === ']') inClass = false;
else if (c === '/' && !inClass) { state = 'code'; lastSig = '/'; out += c; i += 1; continue; }
else if (c === '\n') { state = 'code'; } // regex literals cannot span lines; bail defensively
out += c; i += 1; continue;
}
// Inside a string or template literal: pass through, honor escapes.
if (c === '\\') { out += c + (n ?? ''); i += 2; continue; }
if ((state === 'squote' && c === "'") || (state === 'dquote' && c === '"') || (state === 'template' && c === '`')) {
state = 'code';
lastSig = c; // a closing quote is a value terminator: `/` after it is division
}
out += c; i += 1;
}
return out;
}
// True when a named-import/export clause consists ONLY of `type` bindings
// (`{ type Foo, type Bar }`). tsx/esbuild erase those at runtime, so the
// specifier is not a runtime edge. A mixed clause (`{ type Foo, real }`) or
// any default/namespace binding keeps the edge.
function isAllTypeNamedClause(clause) {
const inner = clause.trim();
if (!inner.startsWith('{') || !inner.endsWith('}')) return false;
const bindings = inner.slice(1, -1).split(',').map((b) => b.trim()).filter(Boolean);
return bindings.length > 0 && bindings.every((b) => /^type\s/.test(b));
}
// Extract import edges from one source file (comments already stripped).
export function extractEdges(src) {
const staticSpecs = [];
const dynamicSpecs = [];
const requireSpecs = [];
// import ... from '...' (multi-line safe; skips `import type` and clauses
// whose named bindings are all inline `type` modifiers β tsx erases both)
for (const m of src.matchAll(/(?:^|;)[ \t]*import\s+(?!type\s)([^'";]*?)\bfrom\s*['"]([^'"]+)['"]/gms)) {
if (isAllTypeNamedClause(m[1])) continue;
staticSpecs.push(m[2]);
}
// side-effect: import '...'
for (const m of src.matchAll(/(?:^|;)[ \t]*import\s*['"]([^'"]+)['"]/gm)) {
staticSpecs.push(m[1]);
}
// export { ... } from '...' / export * from '...' (skips `export type` and
// all-inline-type clauses)
for (const m of src.matchAll(/(?:^|;)[ \t]*export\s+(?!type\b)(\*(?:\s+as\s+\w+)?|\{[^}]*\})\s*from\s*['"]([^'"]+)['"]/gms)) {
if (m[1].startsWith('{') && isAllTypeNamedClause(m[1])) continue;
staticSpecs.push(m[2]);
}
// dynamic import('...') literals
for (const m of src.matchAll(/\bimport\(\s*['"]([^'"]+)['"]/g)) {
dynamicSpecs.push(m[1]);
}
// require('...') literals (plain require in .cjs, or a createRequire-bound
// local named require)
for (const m of src.matchAll(/\brequire\(\s*['"]([^'"]+)['"]\s*\)/g)) {
requireSpecs.push(m[1]);
}
// createRequire(...)('...') β immediately-invoked form; the plain require
// regex cannot see it (no lowercase `require(` substring). The argument may
// itself contain one level of call parens β the common
// createRequire(fileURLToPath(import.meta.url))('./x') idiom.
for (const m of src.matchAll(/\bcreateRequire\((?:[^()]|\([^()]*\))*\)\(\s*['"]([^'"]+)['"]\s*\)/g)) {
requireSpecs.push(m[1]);
}
return { staticSpecs, dynamicSpecs, requireSpecs };
}
export function isBare(spec) {
return !spec.startsWith('.') && !spec.startsWith('/');
}
// --- Dockerfile COPY parsing -------------------------------------------------
// Parse every `COPY [--flags] <src> [<src> ...] <dest>` line into file-level
// and directory-level (recursive) coverage. A trailing slash on a source
// means recursive directory coverage; the trailing slash is stripped from
// the returned directory names. `--from=`/`--chown=` style flags are skipped.
// Line continuations are NOT supported β none of the guarded Dockerfiles use
// them, and an unparsed line surfaces via the callers' loud sanity asserts.
// Single home for the three container guards' COPY knowledge (#5236 review).
export function parseDockerfileCopy(src) {
const files = new Set();
const directories = new Set();
for (const m of src.matchAll(/^COPY\s+([^\n]+)$/gm)) {
const tokens = m[1].trim().split(/\s+/).filter((t) => !t.startsWith('--'));
if (tokens.length < 2) continue; // need at least <src> <dest>
for (const arg of tokens.slice(0, -1)) {
if (arg.endsWith('/')) directories.add(arg.replace(/\/+$/, ''));
else files.add(arg);
}
}
return { files, directories };
}
// --- Bundle-member parsing ---------------------------------------------------
// Extract the member scripts a bundle entry declares (`script: 'seed-x.mjs'`).
// Each member is spawned as its OWN process by _bundle-runner.mjs, so every one
// is an independent resolution root for the container guards.
//
// Comments are stripped FIRST (#5289 review). A commented-out member β the
// natural way to temporarily disable a section β otherwise still matches the
// regex, and the callers' `existsSync` assert then throws while the describe()
// tree is being built, aborting the whole suite instead of failing one service.
// A disabled member whose file still exists would be walked and could raise a
// violation for code the container never loads. Quote-agnostic on purpose: a
// member added with double quotes or a template literal must not silently
// escape the walk.
export function extractBundleMembers(src) {
return [...stripComments(src).matchAll(/script:\s*(["'`])([^"'`]+)\1/g)].map((m) => m[2]);
}
// --- Resolution ---------------------------------------------------------------
// Source extensions plain node can load when written explicitly. The runtime-
// loadable set additionally includes .json (via import attributes / require).
export const NODE_SOURCE_EXTS = ['.mjs', '.cjs', '.js'];
const PLAIN_NODE_LOADABLE_EXTS = new Set([...NODE_SOURCE_EXTS, '.json']);
// tsx's extension-guessing order for extensionless specifiers, plus the
// directory-index candidates it probes.
const TSX_EXT_CANDIDATES = ['.ts', '.mts', '.js', '.mjs', '.cjs'];
const TSX_INDEX_CANDIDATES = ['index.ts', 'index.js', 'index.mjs'];
// Node-style resolution against an explicit extension candidate list (COPY-
// closure guard style: literal hit or listed extension appended). Skips
// directory hits β a bare directory match is never what plain node loads.
export function resolveNodeRelative(fromFile, relImport, exts = NODE_SOURCE_EXTS) {
const abs = resolve(dirname(fromFile), relImport);
if (existsSync(abs) && !statSync(abs).isDirectory()) return abs;
for (const ext of exts) {
if (existsSync(abs + ext)) return abs + ext;
}
return null;
}
// tsx-style resolution: extension guessing (including TypeScript), directory
// index probing, and the TS idiom where an explicit .js/.mjs specifier maps
// to a .ts/.mts source.
export function resolveTsxRelative(fromFile, spec) {
const base = resolve(dirname(fromFile), spec);
const candidates = [base, ...TSX_EXT_CANDIDATES.map((ext) => base + ext), ...TSX_INDEX_CANDIDATES.map((ix) => join(base, ix))];
if (spec.endsWith('.js')) candidates.push(base.replace(/\.js$/, '.ts'));
if (spec.endsWith('.mjs')) candidates.push(base.replace(/\.mjs$/, '.mts'));
return candidates.find((p) => existsSync(p) && statSync(p).isFile()) ?? null;
}
// Relative specifiers a file mentions via static import / export-from /
// require / createRequire (dynamic import() literals are deliberately NOT
// included β the COPY-closure guards never followed those). Used by the
// relay and digest-notifications Dockerfile guards.
export function collectRelativeImports(filePath) {
const src = stripComments(readFileSync(filePath, 'utf-8'));
const { staticSpecs, requireSpecs } = extractEdges(src);
const imports = new Set();
for (const spec of [...staticSpecs, ...requireSpecs]) {
if (spec.startsWith('.')) imports.add(spec);
}
return imports;
}
// Scripts-only packaging guards must cover every literal runtime edge. Unlike
// Dockerfile COPY-closure callers, they cannot safely ignore dynamic imports:
// a conditional import that escapes scripts/ still crashes when that branch
// executes in Railway's /app scripts root.
export function collectRelativeRuntimeImports(filePath) {
const src = stripComments(readFileSync(filePath, 'utf-8'));
const { staticSpecs, dynamicSpecs, requireSpecs } = extractEdges(src);
const imports = new Set();
for (const spec of [...staticSpecs, ...dynamicSpecs, ...requireSpecs]) {
if (spec.startsWith('.')) imports.add(spec);
}
return imports;
}
// --- Container-contract walk ---------------------------------------------------
// Walk the container-reachable graph from `rootFiles` under `contract`:
// contract.repoRoot β absolute path imports may not escape reporting-wise
// contract.copyRootDirs β absolute dirs the image COPYs (containment set)
// contract.dynamicRootDirs β absolute dirs dynamic import() literals are
// followed into (executed-unconditionally set)
// contract.installedPackages β bare-specifier budget beyond node builtins
// contract.hasTsx β false = the container runs plain node: no
// extension guessing, no index resolution, no
// TypeScript. Omitted/true = tsx-shaped resolution.
// Returns violations/unresolved (each with the import chain from a root) and
// the visited set for reachability assertions.
export function walkContainerGraph(rootFiles, contract) {
const parent = new Map();
const visited = new Set();
const queue = [...rootFiles];
const violations = [];
const unresolved = [];
const hasTsx = contract.hasTsx !== false;
const chainOf = (file) => {
const chain = [];
for (let f = file; f; f = parent.get(f)) chain.unshift(relative(contract.repoRoot, f));
return chain.join('\n -> ');
};
const inside = (dirs, p) => dirs.some((d) => p.startsWith(d + sep));
const followRelative = (file, spec) => {
const resolved = resolveTsxRelative(file, spec);
if (!resolved) {
unresolved.push(`'${spec}' imported from\n ${chainOf(file)}`);
return;
}
if (!hasTsx) {
// Plain node resolves ONLY the literal specifier, and only for
// extensions it can load. An edge that needed extension guessing or
// TypeScript would work under tsx elsewhere in the repo yet crash
// this container at import time.
const literal = resolve(dirname(file), spec);
if (resolved !== literal || !PLAIN_NODE_LOADABLE_EXTS.has(extname(resolved))) {
violations.push(
`'${spec}' resolves only under a tsx loader (extension guessing / TypeScript -> ${relative(contract.repoRoot, resolved)}), but this container runs plain node via\n ${chainOf(file)}`,
);
return;
}
}
if (!inside(contract.copyRootDirs, resolved)) {
violations.push(
`'${spec}' resolves in the repo but OUTSIDE the container COPY set (${relative(contract.repoRoot, resolved)}) via\n ${chainOf(file)}`,
);
return;
}
if (!visited.has(resolved) && !parent.has(resolved)) parent.set(resolved, file);
queue.push(resolved);
};
const checkBare = (file, spec, how) => {
const pkg = spec.split('/').slice(0, spec.startsWith('@') ? 2 : 1).join('/');
if (!isBuiltin(spec) && !contract.installedPackages.has(pkg)) {
violations.push(`'${spec}' ${how} via\n ${chainOf(file)}`);
}
};
while (queue.length > 0) {
const file = queue.shift();
if (visited.has(file)) continue;
visited.add(file);
if (extname(file) === '.json') continue; // data, no imports
const src = stripComments(readFileSync(file, 'utf-8'));
const { staticSpecs, dynamicSpecs, requireSpecs } = extractEdges(src);
for (const spec of staticSpecs) {
if (isBare(spec)) checkBare(file, spec, 'statically imported');
else followRelative(file, spec);
}
for (const spec of requireSpecs) {
// A top-level require in a walked file loads eagerly at startup (e.g.
// _seed-utils.mjs createRequire()s _proxy-utils.cjs at module scope),
// so bare requires get the same budget check as static imports. The
// walked graph is require-clean today; if a genuinely-lazy bare
// require ever appears, exempt that one site explicitly.
if (isBare(spec)) checkBare(file, spec, 'require()d');
else followRelative(file, spec);
}
for (const spec of dynamicSpecs) {
if (isBare(spec)) continue; // lazy; cannot classify statically
const resolved = resolveTsxRelative(file, spec);
if (resolved && inside(contract.dynamicRootDirs, resolved)) {
if (!visited.has(resolved) && !parent.has(resolved)) parent.set(resolved, file);
queue.push(resolved);
}
}
}
return { violations, unresolved, visited };
}
|