forked from heygen-com/hyperframes
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathverify-packed-manifests.mjs
More file actions
496 lines (434 loc) · 16.8 KB
/
Copy pathverify-packed-manifests.mjs
File metadata and controls
496 lines (434 loc) · 16.8 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
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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
#!/usr/bin/env node
// The verifier normalizes conditional exports and materializes multi-runtime
// fixtures; its branch matrix is covered by focused tests plus the live pack gate.
// fallow-ignore-file complexity
import { execFileSync } from "node:child_process";
import {
existsSync,
mkdirSync,
mkdtempSync,
readdirSync,
readFileSync,
rmSync,
writeFileSync,
} from "node:fs";
import { extname, join, posix } from "node:path";
import { tmpdir } from "node:os";
import { fileURLToPath } from "node:url";
const ROOT = join(import.meta.dirname, "..");
const PACKAGES_DIR = join(ROOT, "packages");
const DEP_FIELDS = ["dependencies", "devDependencies", "peerDependencies", "optionalDependencies"];
const RUNTIME_IMPORT_EXTENSIONS = new Set([".js", ".mjs", ".cjs", ".json", ".wasm", ".node"]);
const PACKED_JAVASCRIPT_FILE_PATTERN = /\.(?:js|mjs|cjs)$/;
function listWorkspacePackageDirs() {
return readdirSync(PACKAGES_DIR)
.map((dir) => join("packages", dir))
.filter((dir) => existsSync(join(ROOT, dir, "package.json")));
}
function listWorkspaceRefs(pkg) {
return DEP_FIELDS.flatMap((field) =>
Object.entries(pkg[field] || {})
.filter(([, spec]) => String(spec).startsWith("workspace:"))
.map(([depName, spec]) => `${field}:${depName}=${spec}`),
);
}
function listMissingPublishedExports(pkg) {
if (!pkg.exports || !pkg.publishConfig?.exports) return [];
return Object.keys(pkg.exports).filter((exportKey) => !(exportKey in pkg.publishConfig.exports));
}
function normalizePackagePath(path) {
return path.replace(/^\.\//, "");
}
function isPackageLocalPath(path) {
return path.startsWith("./") || path.startsWith("dist/") || path.startsWith("src/");
}
function isPublishedSourceEntrypoint(path) {
return /^src\/.*\.(?:ts|tsx|mts|cts)$/.test(normalizePackagePath(path));
}
function appendManifestEntry(entries, trail, path) {
entries.push({ field: trail.join(".") || "<root>", path });
}
function collectStringEntrypoint(value, trail, entries) {
appendManifestEntry(entries, trail, value);
return entries;
}
function collectArrayEntrypoints(value, trail, entries) {
value.forEach((item, index) =>
collectManifestEntrypoints(item, [...trail, String(index)], entries),
);
return entries;
}
function collectObjectEntrypoints(value, trail, entries) {
Object.entries(value).forEach(([key, nested]) =>
collectManifestEntrypoints(nested, [...trail, key], entries),
);
return entries;
}
function isStringEntrypoint(value) {
return typeof value === "string";
}
function isArrayEntrypoint(value) {
return Array.isArray(value);
}
function isObjectEntrypoint(value) {
return Boolean(value) && typeof value === "object";
}
const MANIFEST_ENTRY_COLLECTORS = [
[isStringEntrypoint, collectStringEntrypoint],
[isArrayEntrypoint, collectArrayEntrypoints],
[isObjectEntrypoint, collectObjectEntrypoints],
];
function collectManifestEntrypoints(value, trail = [], entries = []) {
const collector = MANIFEST_ENTRY_COLLECTORS.find(([matches]) => matches(value));
return collector ? collector[1](value, trail, entries) : entries;
}
function listPackedEntrypoints(pkg) {
const entries = [];
for (const field of ["main", "module", "types", "typings"]) {
if (typeof pkg[field] === "string") {
entries.push({ field, path: pkg[field] });
}
}
if (pkg.exports != null) {
entries.push(...collectManifestEntrypoints(pkg.exports, ["exports"]));
}
return entries.filter((entry) => isPackageLocalPath(entry.path));
}
function listPackedFiles(filename) {
const output = execFileSync("tar", ["-tf", filename], {
cwd: ROOT,
encoding: "utf8",
});
return new Set(
output
.split("\n")
.filter(Boolean)
.map((path) => path.replace(/^package\//, "")),
);
}
function stripSpecifierQuery(specifier) {
return specifier.replace(/[?#].*$/, "");
}
function hasExplicitRuntimeExtension(specifier) {
return RUNTIME_IMPORT_EXTENSIONS.has(extname(stripSpecifierQuery(specifier)));
}
function listRelativeImportSpecifiers(source) {
const patterns = [
/^\s*import\s+["'](\.\.?\/[^"']+)["']/gm,
/^\s*(?:import|export)\b(?:(?!;)[\s\S])*?\s+from\s+["'](\.\.?\/[^"']+)["']/gm,
/\bimport\s*\(\s*["'](\.\.?\/[^"']+)["']\s*\)/gm,
/\brequire\s*\(\s*["'](\.\.?\/[^"']+)["']\s*\)/gm,
];
const specifiers = [];
for (const pattern of patterns) {
for (const match of source.matchAll(pattern)) {
specifiers.push({ index: match.index, specifier: match[1] });
}
}
return specifiers;
}
function lineNumberAt(source, index) {
return source.slice(0, index).split("\n").length;
}
function readPackedFile(filename, file) {
return execFileSync("tar", ["-xOf", filename, `package/${file}`], {
cwd: ROOT,
encoding: "utf8",
maxBuffer: 64 * 1024 * 1024,
});
}
function verifyPackedEntrypoints(workspace, packedPackage, packedFiles) {
const entries = listPackedEntrypoints(packedPackage);
const sourceEntries = entries.filter((entry) => isPublishedSourceEntrypoint(entry.path));
if (sourceEntries.length > 0) {
throw new Error(
`Packed manifest for ${workspace} exposes source TypeScript entrypoints: ` +
sourceEntries.map((entry) => `${entry.field}:${entry.path}`).join(", "),
);
}
const missingEntries = entries.filter((entry) => {
const normalized = normalizePackagePath(entry.path);
return !normalized.includes("*") && !packedFiles.has(normalized);
});
if (missingEntries.length > 0) {
throw new Error(
`Packed manifest for ${workspace} points at missing files: ` +
missingEntries.map((entry) => `${entry.field}:${entry.path}`).join(", "),
);
}
}
function resolvePackedRelativeImport(fromFile, specifier) {
return posix.normalize(posix.join(posix.dirname(fromFile), stripSpecifierQuery(specifier)));
}
export function listPackedJavaScriptImportIssues(filename, packedFiles) {
return [...packedFiles]
.filter((file) => PACKED_JAVASCRIPT_FILE_PATTERN.test(file))
.flatMap((file) => {
const source = readPackedFile(filename, file);
return listRelativeImportSpecifiers(source).flatMap(({ index, specifier }) => {
if (!hasExplicitRuntimeExtension(specifier)) {
return [`${file}:${lineNumberAt(source, index)} imports ${specifier}`];
}
const target = resolvePackedRelativeImport(file, specifier);
if (!packedFiles.has(target)) {
return [`${file}:${lineNumberAt(source, index)} imports missing ${specifier}`];
}
return [];
});
});
}
function verifyPackedJavaScriptImports(workspace, filename, packedFiles) {
const importIssues = listPackedJavaScriptImportIssues(filename, packedFiles);
if (importIssues.length > 0) {
throw new Error(
`Packed JavaScript for ${workspace} contains Node-incompatible relative imports: ` +
importIssues.slice(0, 10).join(", "),
);
}
}
function parsePackJson(output, workspace) {
try {
const parsed = JSON.parse(output);
return Array.isArray(parsed) ? parsed : [parsed];
} catch {
throw new Error(`Could not parse pnpm pack JSON output for ${workspace}`);
}
}
function readWorkspacePackage(workspace) {
return JSON.parse(readFileSync(join(ROOT, workspace, "package.json"), "utf8"));
}
function assertPublishedExportsMatchSource(workspace, sourcePackageJson) {
const missingPublishedExports = listMissingPublishedExports(sourcePackageJson);
if (missingPublishedExports.length === 0) return;
throw new Error(
`${workspace} publishConfig.exports is missing source exports: ${missingPublishedExports.join(", ")}`,
);
}
function packWorkspace(workspace, packDir) {
const packOutput = execFileSync("pnpm", ["pack", "--json", "--pack-destination", packDir], {
cwd: join(ROOT, workspace),
encoding: "utf8",
});
const [{ filename }] = parsePackJson(packOutput, workspace);
return filename;
}
function readPackedPackage(filename) {
const packedPackageJson = execFileSync("tar", ["-xOf", filename, "package/package.json"], {
cwd: ROOT,
encoding: "utf8",
});
return JSON.parse(packedPackageJson);
}
export function verifyCliLicense(workspace, sourcePackage, packedPackage) {
if (workspace !== "packages/cli") return;
const expectedLicense = "Apache-2.0";
if (sourcePackage.license !== expectedLicense) {
throw new Error(`${workspace} must declare license ${expectedLicense}`);
}
if (packedPackage.license !== sourcePackage.license) {
throw new Error(`${workspace} packed manifest must preserve license ${expectedLicense}`);
}
}
function assertNoWorkspaceRefs(workspace, packedPackage) {
const packedRefs = listWorkspaceRefs(packedPackage);
if (packedRefs.length === 0) return;
throw new Error(
`Packed manifest for ${workspace} still contains workspace refs: ${packedRefs.join(", ")}`,
);
}
function verifyPackedWorkspace(workspace, sourcePackage, filename) {
const packedPackage = readPackedPackage(filename);
const packedFiles = listPackedFiles(filename);
verifyCliLicense(workspace, sourcePackage, packedPackage);
assertNoWorkspaceRefs(workspace, packedPackage);
verifyPackedEntrypoints(workspace, packedPackage, packedFiles);
verifyPackedJavaScriptImports(workspace, filename, packedFiles);
}
export function packageExportSpecifier(packageName, exportKey) {
return exportKey === "." ? packageName : `${packageName}/${exportKey.replace(/^\.\//, "")}`;
}
export function listPackedExportContracts(packedWorkspaces) {
return packedWorkspaces.flatMap(({ workspace, packedPackage, descriptor }) => {
const sourceDescriptor =
descriptor ??
(workspace && existsSync(join(ROOT, workspace, "package-subpaths.json"))
? JSON.parse(readFileSync(join(ROOT, workspace, "package-subpaths.json"), "utf8"))
: null);
return Object.entries(packedPackage.exports ?? {}).map(([exportKey, target]) => ({
specifier: packageExportSpecifier(packedPackage.name, exportKey),
typechecked: Boolean(target?.types),
environments: sourceDescriptor?.subpaths?.[exportKey]?.environments ?? ["browser", "node"],
}));
});
}
/** Render browser imports as live namespace bindings so sideEffects:false cannot erase the gate. */
export function renderBrowserConsumer(specifiers) {
const bindings = specifiers.map((_, index) => `packedBrowserModule${index}`);
const imports = specifiers.map(
(specifier, index) => `import * as ${bindings[index]} from ${JSON.stringify(specifier)};`,
);
return [
...imports,
`const packedBrowserModules = [${bindings.join(", ")}];`,
`console.log("Packed browser exports", packedBrowserModules.map((module) => Object.keys(module)));`,
"",
].join("\n");
}
function writeConsumerFixture(packDir, packedWorkspaces) {
const fixtureDir = join(packDir, "consumer");
mkdirSync(fixtureDir);
const rootPackage = JSON.parse(readFileSync(join(ROOT, "package.json"), "utf8"));
const workspaceFileDeps = Object.fromEntries(
packedWorkspaces.map(({ filename, packedPackage }) => [packedPackage.name, `file:${filename}`]),
);
const dependencies = { ...workspaceFileDeps };
// Execute optional integration subpaths (for example aws-lambda/cdk) with
// their declared peer contract satisfied, exactly as an adopter would.
for (const { packedPackage } of packedWorkspaces) {
for (const [peer, version] of Object.entries(packedPackage.peerDependencies ?? {})) {
dependencies[peer] ??= version;
}
}
dependencies.typescript = rootPackage.devDependencies.typescript;
dependencies["@types/node"] = rootPackage.devDependencies["@types/node"];
const studioPackage = JSON.parse(
readFileSync(join(ROOT, "packages/studio/package.json"), "utf8"),
);
dependencies.vite = studioPackage.devDependencies.vite;
writeFileSync(
join(fixtureDir, "package.json"),
JSON.stringify(
{
name: "packed-consumer",
private: true,
type: "module",
dependencies,
// Each packed tarball pins its inter-@hyperframes deps to the exact
// release version. On a release bump that version is not on the registry
// yet, so a plain install fails to resolve those transitive deps. Force
// every @hyperframes/* to the sibling local tarball so the check is
// self-contained pre-publish (matches how the packages install together).
overrides: { ...workspaceFileDeps },
},
null,
2,
),
);
const contracts = listPackedExportContracts(packedWorkspaces);
const typeImports = contracts
.filter(({ typechecked }) => typechecked)
.map(({ specifier }) => `import ${JSON.stringify(specifier)};`)
.join("\n");
writeFileSync(join(fixtureDir, "consumer.ts"), `${typeImports}\n`);
writeFileSync(
join(fixtureDir, "tsconfig.json"),
JSON.stringify(
{
compilerOptions: {
target: "ES2022",
module: "NodeNext",
moduleResolution: "NodeNext",
lib: ["ES2022", "DOM", "DOM.Iterable"],
strict: true,
skipLibCheck: true,
noEmit: true,
},
include: ["consumer.ts"],
},
null,
2,
),
);
const specifiers = contracts.map(({ specifier }) => specifier);
const nodeSpecifiers = contracts
.filter(({ environments }) => environments.includes("node"))
.map(({ specifier }) => specifier);
const browserSpecifiers = contracts
.filter(({ environments, typechecked }) => environments.includes("browser") && typechecked)
.map(({ specifier }) => specifier);
writeFileSync(
join(fixtureDir, "consumer-smoke.mjs"),
`import { existsSync } from "node:fs";\n` +
`import { join } from "node:path";\n` +
`const specifiers = ${JSON.stringify(specifiers, null, 2)};\n` +
`const nodeSpecifiers = ${JSON.stringify(nodeSpecifiers, null, 2)};\n` +
`for (const specifier of specifiers) import.meta.resolve(specifier);\n` +
`for (const specifier of nodeSpecifiers) {\n` +
` const options = specifier.endsWith(".json") ? { with: { type: "json" } } : undefined;\n` +
` await import(specifier, options);\n` +
`}\n` +
`const terraform = await import("@hyperframes/gcp-cloud-run/terraform");\n` +
`if (!existsSync(join(terraform.getTerraformModuleDir(), "main.tf"))) throw new Error("packed Terraform module missing");\n` +
`console.log(\`Resolved \${specifiers.length} packed exports and executed \${nodeSpecifiers.length} Node exports.\`);\n` +
`process.exit(0);\n`,
);
writeFileSync(join(fixtureDir, "browser-consumer.ts"), renderBrowserConsumer(browserSpecifiers));
writeFileSync(
join(fixtureDir, "vite.config.mjs"),
`import { defineConfig } from "vite";\n` +
`export default defineConfig({ build: { lib: { entry: "browser-consumer.ts", formats: ["es"] }, outDir: "browser-dist" } });\n`,
);
return fixtureDir;
}
function verifyPackedConsumer(packDir, packedWorkspaces) {
const fixtureDir = writeConsumerFixture(packDir, packedWorkspaces);
execFileSync("bun", ["install", "--ignore-scripts"], {
cwd: fixtureDir,
encoding: "utf8",
stdio: "pipe",
});
execFileSync(process.execPath, [join(fixtureDir, "node_modules", "typescript", "bin", "tsc")], {
cwd: fixtureDir,
encoding: "utf8",
stdio: "pipe",
});
const smokeOutput = execFileSync("node", ["consumer-smoke.mjs"], {
cwd: fixtureDir,
encoding: "utf8",
});
execFileSync(join(fixtureDir, "node_modules", ".bin", "vite"), ["build"], {
cwd: fixtureDir,
encoding: "utf8",
stdio: "pipe",
});
const cliOutput = execFileSync(
join(fixtureDir, "node_modules", ".bin", "hyperframes"),
["--help"],
{
cwd: fixtureDir,
encoding: "utf8",
env: { ...process.env, HYPERFRAMES_TELEMETRY_DISABLED: "1" },
},
);
if (!cliOutput.toLowerCase().includes("hyperframes")) {
throw new Error("Packed CLI help did not identify HyperFrames");
}
console.log(smokeOutput.trim());
console.log(
"Verified clean packed consumer install, Node execution, TypeScript/Vite resolution, and CLI startup.",
);
}
function packAndVerifyWorkspace(workspace, packDir) {
const sourcePackageJson = readWorkspacePackage(workspace);
if (sourcePackageJson.private) return null;
assertPublishedExportsMatchSource(workspace, sourcePackageJson);
const filename = packWorkspace(workspace, packDir);
verifyPackedWorkspace(workspace, sourcePackageJson, filename);
const packedPackage = readPackedPackage(filename);
console.log(`Verified ${workspace}: packed manifest is publish-safe.`);
return { workspace, filename, packedPackage };
}
function main() {
const packDir = mkdtempSync(join(tmpdir(), "hyperframes-pack-"));
try {
const packedWorkspaces = listWorkspacePackageDirs()
.map((workspace) => packAndVerifyWorkspace(workspace, packDir))
.filter(Boolean);
verifyPackedConsumer(packDir, packedWorkspaces);
} finally {
rmSync(packDir, { force: true, recursive: true });
}
}
if (process.argv[1] === fileURLToPath(import.meta.url)) {
main();
}