Skip to content

fix(ci): a package fails its size budget only when more than 1% over it #6131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miguel-heygen merged 1 commit into from
Oct 23, 2026
+27 −5
Merged

fix(ci): a package fails its size budget only when more than 1% over it #6131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions scripts/verify-packed-manifests.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@ const PACKED_JAVASCRIPT_FILE_PATTERN = /\.(?:js|mjs|cjs)$/;
const SIZE_BUDGETS_FILE = "scripts/package-size-budgets.json";
// A budget sits 5% above the measured size; a package that shrinks 15% below
// its budget fails until the budget follows it down, so budgets only ratchet down.
// A few hundred bytes over the budget is not bloat: only more than 1% over fails.
const SIZE_BUDGET_HEADROOM = 1.05;
const SIZE_BUDGET_RATCHET = 0.85;
const SIZE_BUDGET_TOLERANCE = 1.01;

function listWorkspacePackageDirs() {
return readdirSync(PACKAGES_DIR)
Expand Down Expand Up @@ -568,9 +570,9 @@ export function listPackageSizeIssues(name, sizes, budget) {
if (!Number.isFinite(budget[kind]) || budget[kind] <= 0) {
return [`${name} has an invalid ${kind} budget in ${SIZE_BUDGETS_FILE}: use a byte count.`];
}
if (sizes[kind] > budget[kind]) {
if (sizes[kind] > budget[kind] * SIZE_BUDGET_TOLERANCE) {
return [
`${name} ${kind} size ${sizes[kind]} bytes is over its budget of ${budget[kind]}. Keep source maps, tests and unused assets out of the tarball; raise the budget in ${SIZE_BUDGETS_FILE} only with the reason in the PR.`,
`${name} ${kind} size ${sizes[kind]} bytes is over its budget of ${budget[kind]} by more than 1%. Keep source maps, tests and unused assets out of the tarball; raise the budget in ${SIZE_BUDGETS_FILE} only with the reason in the PR.`,
];
}
if (sizes[kind] < budget[kind] * SIZE_BUDGET_RATCHET) {
Expand Down
26 changes: 23 additions & 3 deletions scripts/verify-packed-manifests.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,34 @@ describe("packed manifest verifier", () => {
assert.deepEqual(listPackageSizeIssues("pkg", { packed: 950, unpacked: 3900 }, budget), []);
});

it("fails a package over its size budget", () => {
it("passes a package a few hundred bytes over its budget, within 1%", () => {
const budget = { packed: 73369, unpacked: 266805 };
// The sizes the 0.8.187 publish job measured for aws-lambda: 115 B and 208 B over.
assert.deepEqual(listPackageSizeIssues("pkg", { packed: 73484, unpacked: 267013 }, budget), []);
assert.deepEqual(
listPackageSizeIssues(
"pkg",
{ packed: 1010, unpacked: 4040 },
{
packed: 1000,
unpacked: 4000,
},
),
[],
);
});

it("fails a package more than 1% over its size budget", () => {
const issues = listPackageSizeIssues(
"pkg",
{ packed: 1001, unpacked: 3900 },
{ packed: 1011, unpacked: 3900 },
{ packed: 1000, unpacked: 4000 },
);
assert.equal(issues.length, 1);
assert.match(issues[0], /pkg packed size 1001 bytes is over its budget of 1000/);
assert.match(
issues[0],
/pkg packed size 1011 bytes is over its budget of 1000 by more than 1%/,
);
});

it("makes a budget follow a package down once it shrinks", () => {
Expand Down
Loading