The windows-test-parity ratchet greps test source for fs.rmSync-without-
maxRetries (and six other Windows-portability anti-patterns), failing when an
integer offender COUNT exceeds a frozen baseline (rmSync: 95). A count ratchet
is a Goodhart metric: fixing one offender and adding another keeps the count
constant, so a new defect slips through green. Replace it — and every other
count ratchet in the repo — with a layered, masking-proof design.
Behavioral seam test
- tests/helpers-cleanup.test.cjs proves helpers.cleanup() carries the Windows
EBUSY retry budget. cleanup() delegates retries to Node's fs.rmSync via
maxRetries (it owns no loop), so the test asserts the option contract
(recursive/force/maxRetries>0/retryDelay>0) + real-FS removal + the cwd-guard,
rather than a loop that does not exist. The EBUSY risk is now tested ONCE at
the helper, not approximated textually at every call site.
Write-time ESLint rule (AST-accurate, replaces the grep)
- eslint-rules/no-raw-rmsync-in-tests.cjs (error in tests/**/*.test.cjs) bans
raw fs.rmSync, steering to cleanup(). Catches member, computed (fs['rmSync']),
destructured and aliased forms; escape hatch is inline
`// eslint-disable-next-line local/no-raw-rmsync-in-tests -- <reason>` only.
- Migrated 336 raw fs.rmSync teardown calls across ~116 test files to cleanup().
~18 genuinely load-bearing sites (mid-test SUT/fault-injection removals,
error-swallowing or name-colliding local teardown helpers) keep the raw call
with an inline eslint-disable + reason.
Shared anti-ratchet primitive
- scripts/lib/allowlist-ratchet.cjs:
- assertWithinAllowlist: fails on NOVEL ids (new offender introduced) AND on
STALE ids (a known offender was fixed but not pruned) — identity, not count,
and a ratchet DOWN toward zero.
- assertTightCeiling: a size/length budget whose ceiling must stay within a
grace band of the high-water mark, so budgets may only tighten, never creep.
Ratchets converted onto the primitive
- windows-test-parity-guard.test.cjs: rmSync rule deleted (now ESLint-enforced);
the remaining six patterns moved from integer baselines to named-set
allowlists with ratchet-down.
- scripts/lint-test-file-count.{cjs,allowlist.json}: per-module integer counts →
named filename sets (closes the swap-a-file-keep-the-count blind spot); a
module dropping under cap now FAILS to force pruning its allowlist entry.
- enh-2790 skill-count `<= 63` → named skill allowlist (ratchets toward ~58).
Size budgets hardened (tighten-only)
- agent-size / workflow-size / feat-3039 help-tiered: ceilings lowered to the
current high-water mark and an assertTightCeiling anti-creep check added per
tier. Fixed external-contract limits (description ≤100 chars, agent ≤100 KB)
are intentionally left as-is — they are not grandfathered creeping budgets.
No user-facing behavior change (tests + tooling only); no USER_FACING_PREFIXES
touched, so no changeset fragment is required.
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
198
eslint-rules/no-raw-rmsync-in-tests.cjs
Normal file
198
eslint-rules/no-raw-rmsync-in-tests.cjs
Normal file
@@ -0,0 +1,198 @@
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* no-raw-rmsync-in-tests
|
||||
*
|
||||
* In *.test.cjs files, flag any call that invokes fs.rmSync (directly or via
|
||||
* destructuring/aliasing). Covers:
|
||||
*
|
||||
* (a) MemberExpression with identifier property "rmSync":
|
||||
* fs.rmSync(d, opts) nodeFs.rmSync(d, opts)
|
||||
*
|
||||
* (b) MemberExpression with computed string-literal property "rmSync":
|
||||
* fs['rmSync'](d, opts)
|
||||
*
|
||||
* (c) Bare Identifier whose name is known to be bound to an fs rmSync via:
|
||||
* const { rmSync } = require('fs'|'node:fs')
|
||||
* const alias = fs.rmSync (where fs is a require('fs') binding)
|
||||
* const alias = require('fs').rmSync
|
||||
*
|
||||
* The only escape hatch is the native inline disable comment:
|
||||
* // eslint-disable-next-line local/no-raw-rmsync-in-tests -- <reason>
|
||||
* (ESLint handles that automatically — this rule does not implement it.)
|
||||
*
|
||||
* NOTE: The file-level `// allow-test-rule:` annotation does NOT apply to this
|
||||
* rule. That annotation is for no-source-grep only.
|
||||
*/
|
||||
|
||||
/** @type {import('eslint').Rule.RuleModule} */
|
||||
const rule = {
|
||||
meta: {
|
||||
type: 'problem',
|
||||
docs: {
|
||||
description:
|
||||
'Disallow raw fs.rmSync() calls in test files; use helpers.cleanup() instead',
|
||||
category: 'Best Practices',
|
||||
},
|
||||
schema: [],
|
||||
messages: {
|
||||
noRawRmSync:
|
||||
'Raw fs.rmSync() in a test. Use helpers.cleanup(dir) instead — it carries the Windows-EBUSY retry budget (maxRetries/retryDelay). To suppress a rare legit case, use `// eslint-disable-next-line local/no-raw-rmsync-in-tests -- <reason>`.',
|
||||
},
|
||||
},
|
||||
create(context) {
|
||||
const filename = context.getFilename();
|
||||
|
||||
// Only applies in test files
|
||||
if (!filename.endsWith('.test.cjs')) return {};
|
||||
|
||||
// --- Track fs-derived bindings ---
|
||||
// fsBindings: Set of local variable names bound to require('fs'|'node:fs')
|
||||
// rmSyncBindings: Set of local variable names bound to an fs.rmSync value
|
||||
const fsBindings = new Set();
|
||||
const rmSyncBindings = new Set();
|
||||
|
||||
/**
|
||||
* Returns true if `node` is a require('fs') or require('node:fs') call.
|
||||
*/
|
||||
function isFsRequire(node) {
|
||||
return (
|
||||
node.type === 'CallExpression' &&
|
||||
node.callee.type === 'Identifier' &&
|
||||
node.callee.name === 'require' &&
|
||||
node.arguments.length === 1 &&
|
||||
node.arguments[0].type === 'Literal' &&
|
||||
(node.arguments[0].value === 'fs' ||
|
||||
node.arguments[0].value === 'node:fs')
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if `node` is a reference to a known fs binding (Identifier
|
||||
* whose name is in fsBindings).
|
||||
*/
|
||||
function isFsBinding(node) {
|
||||
return node.type === 'Identifier' && fsBindings.has(node.name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if `node` is an expression that resolves to fs.rmSync:
|
||||
* - fsBinding.rmSync (MemberExpression, identifier property)
|
||||
* - require('fs').rmSync
|
||||
*/
|
||||
function isFsRmSyncExpression(node) {
|
||||
if (node.type !== 'MemberExpression') return false;
|
||||
const prop = node.property;
|
||||
const isRmSyncProp =
|
||||
(!node.computed &&
|
||||
prop.type === 'Identifier' &&
|
||||
prop.name === 'rmSync') ||
|
||||
(node.computed &&
|
||||
prop.type === 'Literal' &&
|
||||
prop.value === 'rmSync');
|
||||
if (!isRmSyncProp) return false;
|
||||
return isFsBinding(node.object) || isFsRequire(node.object);
|
||||
}
|
||||
|
||||
return {
|
||||
// ── Track `const fs = require('fs')` ──────────────────────────────────
|
||||
VariableDeclaration(node) {
|
||||
for (const decl of node.declarations) {
|
||||
if (!decl.init) continue;
|
||||
|
||||
// const fs = require('fs')
|
||||
if (
|
||||
decl.id.type === 'Identifier' &&
|
||||
isFsRequire(decl.init)
|
||||
) {
|
||||
fsBindings.add(decl.id.name);
|
||||
continue;
|
||||
}
|
||||
|
||||
// const { rmSync } = require('fs')
|
||||
// const { rmSync: del } = require('fs')
|
||||
if (
|
||||
decl.id.type === 'ObjectPattern' &&
|
||||
isFsRequire(decl.init)
|
||||
) {
|
||||
for (const prop of decl.id.properties) {
|
||||
if (
|
||||
prop.type === 'Property' &&
|
||||
prop.key.type === 'Identifier' &&
|
||||
prop.key.name === 'rmSync' &&
|
||||
prop.value.type === 'Identifier'
|
||||
) {
|
||||
rmSyncBindings.add(prop.value.name);
|
||||
}
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
// const { rmSync } = fs (where fs is already a known binding)
|
||||
if (
|
||||
decl.id.type === 'ObjectPattern' &&
|
||||
isFsBinding(decl.init)
|
||||
) {
|
||||
for (const prop of decl.id.properties) {
|
||||
if (
|
||||
prop.type === 'Property' &&
|
||||
prop.key.type === 'Identifier' &&
|
||||
prop.key.name === 'rmSync' &&
|
||||
prop.value.type === 'Identifier'
|
||||
) {
|
||||
rmSyncBindings.add(prop.value.name);
|
||||
}
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
// const alias = fs.rmSync (or require('fs').rmSync)
|
||||
if (
|
||||
decl.id.type === 'Identifier' &&
|
||||
isFsRmSyncExpression(decl.init)
|
||||
) {
|
||||
rmSyncBindings.add(decl.id.name);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
// ── Flag rmSync calls ─────────────────────────────────────────────────
|
||||
CallExpression(node) {
|
||||
const callee = node.callee;
|
||||
|
||||
// (a) obj.rmSync(...) — identifier property
|
||||
if (
|
||||
callee.type === 'MemberExpression' &&
|
||||
!callee.computed &&
|
||||
callee.property.type === 'Identifier' &&
|
||||
callee.property.name === 'rmSync'
|
||||
) {
|
||||
context.report({ node, messageId: 'noRawRmSync' });
|
||||
return;
|
||||
}
|
||||
|
||||
// (b) obj['rmSync'](...) — computed string-literal property
|
||||
if (
|
||||
callee.type === 'MemberExpression' &&
|
||||
callee.computed &&
|
||||
callee.property.type === 'Literal' &&
|
||||
callee.property.value === 'rmSync'
|
||||
) {
|
||||
context.report({ node, messageId: 'noRawRmSync' });
|
||||
return;
|
||||
}
|
||||
|
||||
// (c) bare identifier known to be fs.rmSync
|
||||
if (
|
||||
callee.type === 'Identifier' &&
|
||||
rmSyncBindings.has(callee.name)
|
||||
) {
|
||||
context.report({ node, messageId: 'noRawRmSync' });
|
||||
}
|
||||
},
|
||||
};
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = rule;
|
||||
Reference in New Issue
Block a user