Skip to content

Commit 99bc2ff

Browse files
committed
build: use dependency-aware workspace ordering
1 parent 936b47a commit 99bc2ff

4 files changed

Lines changed: 249 additions & 2 deletions

File tree

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"type": "module",
1212
"scripts": {
1313
"dev": "bun run studio",
14-
"build": "bun run --filter '!@hyperframes/cli' build && bun run --filter @hyperframes/cli build",
14+
"build": "node scripts/build-workspaces.mjs",
1515
"build:producer": "bun run --filter @hyperframes/producer build",
1616
"studio": "bun run --filter @hyperframes/studio dev",
1717
"build:hyperframes-runtime": "bun run --filter @hyperframes/core build:hyperframes-runtime",
@@ -24,7 +24,7 @@
2424
"lint:skills": "tsx scripts/lint-skills.ts",
2525
"lint:fix": "oxlint --fix .",
2626
"format": "oxfmt .",
27-
"test": "bun run --filter '*' test",
27+
"test": "bun run --filter '*' test && node --test scripts/build-workspaces.test.mjs",
2828
"format:check": "oxfmt --check .",
2929
"knip": "knip",
3030
"generate:previews": "tsx scripts/generate-template-previews.ts",

‎scripts/build-workspaces-lib.mjs‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
import { existsSync, readFileSync, readdirSync } from "node:fs";
2+
import { join, resolve } from "node:path";
3+
4+
function readJson(path) {
5+
return JSON.parse(readFileSync(path, "utf8"));
6+
}
7+
8+
function expandWorkspaceGlob(rootDir, pattern) {
9+
if (!pattern.endsWith("/*")) {
10+
throw new Error(`Unsupported workspace pattern: ${pattern}`);
11+
}
12+
13+
const baseDir = resolve(rootDir, pattern.slice(0, -2));
14+
return readdirSync(baseDir, { withFileTypes: true })
15+
.filter((entry) => entry.isDirectory())
16+
.map((entry) => join(baseDir, entry.name));
17+
}
18+
19+
function getWorkspaceDepNames(pkg, workspaceNames) {
20+
const depNames = new Set();
21+
22+
for (const section of ["dependencies", "devDependencies", "optionalDependencies"]) {
23+
const deps = pkg[section] ?? {};
24+
for (const name of Object.keys(deps)) {
25+
if (workspaceNames.has(name)) depNames.add(name);
26+
}
27+
}
28+
29+
return [...depNames].sort();
30+
}
31+
32+
export function readBuildWorkspaces(rootDir) {
33+
const rootPkg = readJson(join(rootDir, "package.json"));
34+
const workspaceDirs = (rootPkg.workspaces ?? []).flatMap((pattern) =>
35+
expandWorkspaceGlob(rootDir, pattern),
36+
);
37+
38+
const packages = workspaceDirs.map((dir) => {
39+
const pkgPath = join(dir, "package.json");
40+
if (!existsSync(pkgPath)) return null;
41+
42+
const pkg = readJson(pkgPath);
43+
return {
44+
dir,
45+
name: pkg.name,
46+
hasBuild: typeof pkg.scripts?.build === "string",
47+
pkg,
48+
};
49+
});
50+
51+
const buildPackages = packages.filter((pkg) => pkg?.hasBuild);
52+
const workspaceNames = new Set(buildPackages.map((pkg) => pkg.name));
53+
54+
return buildPackages
55+
.map((pkg) => ({
56+
name: pkg.name,
57+
dir: pkg.dir,
58+
deps: getWorkspaceDepNames(pkg.pkg, workspaceNames),
59+
}))
60+
.sort((a, b) => a.name.localeCompare(b.name));
61+
}
62+
63+
export function createBuildBatches(workspaces) {
64+
const names = new Set(workspaces.map((workspace) => workspace.name));
65+
const nodes = new Map(
66+
workspaces.map((workspace) => [
67+
workspace.name,
68+
{
69+
...workspace,
70+
deps: [...workspace.deps].filter((dep) => names.has(dep)).sort(),
71+
},
72+
]),
73+
);
74+
const inDegree = new Map();
75+
const dependents = new Map();
76+
77+
for (const workspace of nodes.values()) {
78+
inDegree.set(workspace.name, workspace.deps.length);
79+
for (const dep of workspace.deps) {
80+
if (!nodes.has(dep)) continue;
81+
const names = dependents.get(dep) ?? [];
82+
names.push(workspace.name);
83+
dependents.set(dep, names);
84+
}
85+
}
86+
87+
const batches = [];
88+
let ready = [...nodes.values()]
89+
.filter((workspace) => inDegree.get(workspace.name) === 0)
90+
.map((workspace) => workspace.name)
91+
.sort();
92+
let seen = 0;
93+
94+
while (ready.length > 0) {
95+
const batch = ready;
96+
batches.push(batch);
97+
ready = [];
98+
seen += batch.length;
99+
100+
for (const name of batch) {
101+
for (const dependent of (dependents.get(name) ?? []).sort()) {
102+
const nextDegree = (inDegree.get(dependent) ?? 0) - 1;
103+
inDegree.set(dependent, nextDegree);
104+
if (nextDegree === 0) ready.push(dependent);
105+
}
106+
}
107+
108+
ready.sort();
109+
}
110+
111+
if (seen !== nodes.size) {
112+
const remaining = [...nodes.keys()].filter((name) => (inDegree.get(name) ?? 0) > 0).sort();
113+
throw new Error(`Workspace build graph contains a cycle: ${remaining.join(", ")}`);
114+
}
115+
116+
return batches;
117+
}

‎scripts/build-workspaces.mjs‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
import { spawn } from "node:child_process";
2+
import { dirname } from "node:path";
3+
import { fileURLToPath } from "node:url";
4+
5+
import { createBuildBatches, readBuildWorkspaces } from "./build-workspaces-lib.mjs";
6+
7+
const ROOT_DIR = dirname(fileURLToPath(new URL("../package.json", import.meta.url)));
8+
9+
function runCommand(name) {
10+
return new Promise((resolve, reject) => {
11+
const child = spawn("bun", ["run", "--filter", name, "build"], {
12+
cwd: ROOT_DIR,
13+
stdio: "inherit",
14+
});
15+
16+
child.on("error", reject);
17+
child.on("exit", (code, signal) => {
18+
if (code === 0) {
19+
resolve();
20+
return;
21+
}
22+
23+
reject(
24+
new Error(
25+
`Build failed for ${name} (code: ${code ?? "null"}, signal: ${signal ?? "none"})`,
26+
),
27+
);
28+
});
29+
});
30+
}
31+
32+
async function main() {
33+
const workspaces = readBuildWorkspaces(ROOT_DIR);
34+
const batches = createBuildBatches(workspaces);
35+
36+
for (const [index, batch] of batches.entries()) {
37+
console.log(`[build-workspaces] batch ${index + 1}/${batches.length}: ${batch.join(", ")}`);
38+
await Promise.all(batch.map((name) => runCommand(name)));
39+
}
40+
}
41+
42+
await main();

‎scripts/build-workspaces.test.mjs‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
import test from "node:test";
2+
import assert from "node:assert/strict";
3+
import { mkdtempSync, mkdirSync, rmSync, writeFileSync } from "node:fs";
4+
import { join } from "node:path";
5+
import { tmpdir } from "node:os";
6+
7+
import { createBuildBatches, readBuildWorkspaces } from "./build-workspaces-lib.mjs";
8+
9+
test("creates deterministic topological build batches from workspace deps", () => {
10+
const batches = createBuildBatches([
11+
{
12+
name: "@hyperframes/cli",
13+
deps: [
14+
"@hyperframes/core",
15+
"@hyperframes/engine",
16+
"@hyperframes/producer",
17+
"@hyperframes/studio",
18+
],
19+
},
20+
{ name: "@hyperframes/core", deps: [] },
21+
{ name: "@hyperframes/engine", deps: ["@hyperframes/core"] },
22+
{ name: "@hyperframes/player", deps: [] },
23+
{ name: "@hyperframes/producer", deps: ["@hyperframes/core", "@hyperframes/engine"] },
24+
{ name: "@hyperframes/shader-transitions", deps: [] },
25+
{
26+
name: "@hyperframes/studio",
27+
deps: ["@hyperframes/core", "@hyperframes/player", "@hyperframes/producer"],
28+
},
29+
]);
30+
31+
assert.deepEqual(batches, [
32+
["@hyperframes/core", "@hyperframes/player", "@hyperframes/shader-transitions"],
33+
["@hyperframes/engine"],
34+
["@hyperframes/producer"],
35+
["@hyperframes/studio"],
36+
["@hyperframes/cli"],
37+
]);
38+
});
39+
40+
test("ignores dependencies that are not part of the workspace build set", () => {
41+
const batches = createBuildBatches([
42+
{ name: "@hyperframes/core", deps: [] },
43+
{ name: "@hyperframes/engine", deps: ["@hyperframes/core", "puppeteer"] },
44+
]);
45+
46+
assert.deepEqual(batches, [["@hyperframes/core"], ["@hyperframes/engine"]]);
47+
});
48+
49+
test("throws a helpful error when the workspace build graph contains a cycle", () => {
50+
assert.throws(
51+
() =>
52+
createBuildBatches([
53+
{ name: "@hyperframes/a", deps: ["@hyperframes/b"] },
54+
{ name: "@hyperframes/b", deps: ["@hyperframes/a"] },
55+
]),
56+
/cycle/i,
57+
);
58+
});
59+
60+
test("ignores workspace directories that do not contain a package.json", () => {
61+
const rootDir = mkdtempSync(join(tmpdir(), "hyperframes-build-graph-"));
62+
63+
try {
64+
mkdirSync(join(rootDir, "packages"));
65+
mkdirSync(join(rootDir, "packages", ".debug"));
66+
mkdirSync(join(rootDir, "packages", "core"));
67+
68+
writeFileSync(join(rootDir, "package.json"), JSON.stringify({ workspaces: ["packages/*"] }));
69+
writeFileSync(
70+
join(rootDir, "packages", "core", "package.json"),
71+
JSON.stringify({
72+
name: "@hyperframes/core",
73+
scripts: { build: "tsc" },
74+
}),
75+
);
76+
77+
const workspaces = readBuildWorkspaces(rootDir);
78+
assert.deepEqual(workspaces, [
79+
{
80+
name: "@hyperframes/core",
81+
dir: join(rootDir, "packages", "core"),
82+
deps: [],
83+
},
84+
]);
85+
} finally {
86+
rmSync(rootDir, { recursive: true, force: true });
87+
}
88+
});

0 commit comments

Comments
 (0)