Skip to content

Commit 83900da

Browse files
committed
Clean deleted-branch pins of every variant package
Branch pin cleanup treated a named root manifest as proof that a repository has no variants, so pins of variants that override the name were never removed after their branch was deleted (e.g. juno-sepolia and pathfinder-sepolia; nethermind, ollama and madara have the same layout). Variants are now discovered independently of the root name, and the root name plus every merged variant name are cleaned once each.
1 parent aee11ae commit 83900da

2 files changed

Lines changed: 136 additions & 14 deletions

File tree

‎src/commands/githubActions/build/cleanPinsFromDeletedBranches.ts‎

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1+
import fs from "fs";
12
import path from "path";
3+
import { Manifest } from "@dappnode/types";
24
import { defaultVariantsDirName } from "../../../params.js";
35
import { getAllVariantsInPath } from "../../../files/variants/getAllPackageVariants.js";
46
import { fetchPinsGroupedByBranch } from "../../../pinStrategy/index.js";
@@ -17,19 +19,7 @@ export async function cleanPinsFromDeletedBranches({
1719
dir: string;
1820
variantsDirName?: string;
1921
}): Promise<void> {
20-
// Read manifest from disk to get package name
21-
const { manifest } = readManifest([{ dir }]);
22-
23-
const variantsPath = path.join(dir, variantsDirName);
24-
const manifests = manifest.name
25-
? [manifest]
26-
: getAllVariantsInPath(variantsPath).map(
27-
variant =>
28-
readManifest([{ dir }, { dir: path.join(variantsPath, variant) }])
29-
.manifest
30-
);
31-
if (manifests.some(item => !item.name))
32-
throw new Error("Cannot clean pins without a package name");
22+
const manifests = getPackageManifestsToClean({ dir, variantsDirName });
3323

3424
// Connect to Github Octokit REST API to know existing branches
3525
const github = Github.fromLocal(dir);
@@ -65,3 +55,42 @@ export async function cleanPinsFromDeletedBranches({
6555
}
6656
}
6757
}
58+
59+
/**
60+
* Every package name this repository can pin, deduplicated:
61+
* - the root manifest's name, used when building without variant flags, and
62+
* - each variant's merged name (root + variant), which may inherit or override the root name,
63+
* e.g. juno.dnp.dappnode.eth (mainnet) and juno-sepolia.dnp.dappnode.eth (sepolia).
64+
* Variants are discovered whether or not the root manifest has a name.
65+
*/
66+
export function getPackageManifestsToClean({
67+
dir,
68+
variantsDirName = defaultVariantsDirName
69+
}: {
70+
dir: string;
71+
variantsDirName?: string;
72+
}): Manifest[] {
73+
const byName = new Map<string, Manifest>();
74+
const { manifest: rootManifest } = readManifest([{ dir }]);
75+
if (rootManifest.name) byName.set(rootManifest.name, rootManifest);
76+
77+
const variantsPath = path.join(dir, variantsDirName);
78+
const variants = fs.existsSync(variantsPath)
79+
? getAllVariantsInPath(variantsPath)
80+
: [];
81+
for (const variant of variants) {
82+
const { manifest } = readManifest([
83+
{ dir },
84+
{ dir: path.join(variantsPath, variant) }
85+
]);
86+
if (!manifest.name)
87+
throw new Error(
88+
`Cannot clean pins without a package name for variant ${variant}`
89+
);
90+
if (!byName.has(manifest.name)) byName.set(manifest.name, manifest);
91+
}
92+
93+
if (byName.size === 0)
94+
throw new Error("Cannot clean pins without a package name");
95+
return [...byName.values()];
96+
}

‎test/pinStrategySafety.test.ts‎

Lines changed: 94 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ import Listr from "listr";
77
import { fetchPinsWithBranchToDelete } from "../src/pinStrategy/index.js";
88
import { PinataPinManager } from "../src/providers/pinata/pinManager.js";
99
import { Github } from "../src/providers/github/Github.js";
10-
import { cleanPinsFromDeletedBranches } from "../src/commands/githubActions/build/cleanPinsFromDeletedBranches.js";
10+
import {
11+
cleanPinsFromDeletedBranches,
12+
getPackageManifestsToClean
13+
} from "../src/commands/githubActions/build/cleanPinsFromDeletedBranches.js";
1114
import { getDeleteOldPinsTask } from "../src/tasks/buildAndUpload/getDeleteOldPinsTask.js";
1215
import {
1316
executable,
@@ -164,3 +167,93 @@ describe("old pin cleanup on shallow CI checkouts", function () {
164167
expect(pins.map(pin => pin.commit)).to.deep.equal(commits.slice(0, 2));
165168
});
166169
});
170+
171+
describe("branch pin cleanup for template packages", () => {
172+
let dir: string;
173+
const write = (rel: string, data: object) => {
174+
fs.mkdirSync(path.dirname(path.join(dir, rel)), { recursive: true });
175+
fs.writeFileSync(path.join(dir, rel), JSON.stringify(data));
176+
};
177+
beforeEach(() => {
178+
dir = temporaryDirectory();
179+
// Same shape as DAppNodePackage-juno-generic: a named root, a variant that
180+
// inherits the name and one that overrides it.
181+
write("dappnode_package.json", { name: "juno.dnp.dappnode.eth" });
182+
write("package_variants/mainnet/dappnode_package.json", {
183+
name: "juno.dnp.dappnode.eth",
184+
version: "0.1.0"
185+
});
186+
write("package_variants/sepolia/dappnode_package.json", {
187+
name: "juno-sepolia.dnp.dappnode.eth",
188+
version: "0.1.0"
189+
});
190+
});
191+
afterEach(() => {
192+
mock.restoreAll();
193+
fs.rmSync(dir, { recursive: true, force: true });
194+
});
195+
196+
it("finds variant package names even when the root manifest has a name", () => {
197+
expect(
198+
getPackageManifestsToClean({ dir }).map(manifest => manifest.name)
199+
).to.deep.equal(["juno.dnp.dappnode.eth", "juno-sepolia.dnp.dappnode.eth"]);
200+
});
201+
202+
it("uses only variant names when the root manifest has none", () => {
203+
write("dappnode_package.json", { upstreamRepo: "x/y" });
204+
expect(
205+
getPackageManifestsToClean({ dir }).map(manifest => manifest.name)
206+
).to.deep.equal(["juno.dnp.dappnode.eth", "juno-sepolia.dnp.dappnode.eth"]);
207+
});
208+
209+
it("unpins deleted-branch pins of every variant package", async () => {
210+
const original = {
211+
key: process.env.PINATA_API_KEY,
212+
secret: process.env.PINATA_SECRET_API_KEY
213+
};
214+
process.env.PINATA_API_KEY = "fake";
215+
process.env.PINATA_SECRET_API_KEY = "fake";
216+
mock.method(Github, "fromLocal", () => ({
217+
listBranches: async () => [{ name: "main" }],
218+
branchExists: async (branch: string) => branch === "main"
219+
}));
220+
const queried: string[] = [];
221+
mock.method(
222+
PinataPinManager.prototype,
223+
"pinList",
224+
async (filters: { keyvalues: { dnpName: { value: string } } }) => {
225+
const dnpName = filters.keyvalues.dnpName.value;
226+
queried.push(dnpName);
227+
return [
228+
{
229+
ipfs_pin_hash: `${dnpName}-deleted`,
230+
metadata: {
231+
keyvalues: { dnpName, branch: "deleted", commit: "1111111" }
232+
}
233+
}
234+
];
235+
}
236+
);
237+
const removed: string[] = [];
238+
mock.method(PinataPinManager.prototype, "unpin", async (hash: string) => {
239+
removed.push(hash);
240+
});
241+
try {
242+
await cleanPinsFromDeletedBranches({ dir });
243+
} finally {
244+
if (original.key === undefined) delete process.env.PINATA_API_KEY;
245+
else process.env.PINATA_API_KEY = original.key;
246+
if (original.secret === undefined)
247+
delete process.env.PINATA_SECRET_API_KEY;
248+
else process.env.PINATA_SECRET_API_KEY = original.secret;
249+
}
250+
expect(queried).to.deep.equal([
251+
"juno.dnp.dappnode.eth",
252+
"juno-sepolia.dnp.dappnode.eth"
253+
]);
254+
expect(removed).to.deep.equal([
255+
"juno.dnp.dappnode.eth-deleted",
256+
"juno-sepolia.dnp.dappnode.eth-deleted"
257+
]);
258+
});
259+
});

0 commit comments

Comments
 (0)