ewilliams28/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-08-27 12:56:01 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix(packaging): serialize packs when the docs map is already generated (#130538)

Browse Source
This commit is contained in:
Peter Steinberger
2026-08-26 18:01:28 -07:00
committed by GitHub
parent de70b00d95
commit 2d386c2ea6
2 changed files with 29 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/package-docs-map.mjs
+2 -4
View File
@@ -77,10 +77,8 @@ export async function preparePackageDocsMap(cwd = process.cwd()) {
const mapPath = path.join(cwd, DOCS_MAP_PATH);
const content = renderDocsHeadingMap(path.join(cwd, "docs"));
const original = existsSync(mapPath) ? await readFile(mapPath, "utf8") : null;
if (original === content) {
return false;
}
// The receipt owns every source-mutating pack step, even when the map is
// already generated; skipping it lets another pack restore our prepared files.
await mkdir(path.dirname(receiptPath), { recursive: true });
try {
await writeFile(
test/scripts/package-docs-map.test.ts
+27 -32
View File
@@ -41,17 +41,6 @@ describe("package docs map", () => {
expect(existsSync(mapPath)).toBe(false);
});
it("preserves an identical map that existed before packaging", async () => {
const root = makePackageRoot();
const mapPath = path.join(root, "docs", "docs_map.md");
const content = renderDocsHeadingMap(path.join(root, "docs"));
writeFileSync(mapPath, content, "utf8");
await expect(preparePackageDocsMap(root)).resolves.toBe(false);
await expect(restorePackageDocsMap(root)).resolves.toBe(false);
expect(readFileSync(mapPath, "utf8")).toBe(content);
});
it("restores a tracked source stub after packaging", async () => {
const root = makePackageRoot();
const mapPath = path.join(root, "docs", "docs_map.md");
@@ -64,29 +53,35 @@ describe("package docs map", () => {
expect(readFileSync(mapPath, "utf8")).toBe(stub);
});
it("serializes concurrent package preparations with the receipt", async () => {
const root = makePackageRoot();
const mapPath = path.join(root, "docs", "docs_map.md");
const stub = "# Docs map source\n";
writeFileSync(mapPath, stub, "utf8");
it.each(["source stub", "generated map"])(
"serializes preparations starting from a %s",
async (initialMap) => {
const root = makePackageRoot();
const mapPath = path.join(root, "docs", "docs_map.md");
const original =
initialMap === "generated map"
? renderDocsHeadingMap(path.join(root, "docs"))
: "# Docs map source\n";
writeFileSync(mapPath, original, "utf8");
const results = await Promise.allSettled([
preparePackageDocsMap(root),
preparePackageDocsMap(root),
]);
const results = await Promise.allSettled([
preparePackageDocsMap(root),
preparePackageDocsMap(root),
]);
expect(results.filter((result) => result.status === "fulfilled")).toHaveLength(1);
const rejected = results.find((result) => result.status === "rejected");
expect(rejected).toMatchObject({
reason: expect.objectContaining({
code: "PACKAGE_DOCS_MAP_ACTIVE",
message: expect.stringContaining("node scripts/openclaw-postpack.mjs"),
}),
});
expect(readFileSync(mapPath, "utf8")).toBe(renderDocsHeadingMap(path.join(root, "docs")));
await expect(restorePackageDocsMap(root)).resolves.toBe(true);
expect(readFileSync(mapPath, "utf8")).toBe(stub);
});
expect(results.filter((result) => result.status === "fulfilled")).toHaveLength(1);
const rejected = results.find((result) => result.status === "rejected");
expect(rejected).toMatchObject({
reason: expect.objectContaining({
code: "PACKAGE_DOCS_MAP_ACTIVE",
message: expect.stringContaining("node scripts/openclaw-postpack.mjs"),
}),
});
expect(readFileSync(mapPath, "utf8")).toBe(renderDocsHeadingMap(path.join(root, "docs")));
await expect(restorePackageDocsMap(root)).resolves.toBe(true);
expect(readFileSync(mapPath, "utf8")).toBe(original);
},
);
it("refuses to remove a transient map changed after prepack", async () => {
const root = makePackageRoot();