Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Tolerate stale self entries in the side-effect registry spec (#80401)

Fraser79f3813c3e15
diff --git a/frontend/lint/scripts/side-effect-files.js b/frontend/lint/scripts/side-effect-files.js
index 4960c22e724..8dc986912fe 100644
--- a/frontend/lint/scripts/side-effect-files.js
+++ b/frontend/lint/scripts/side-effect-files.js
@@ -141,6 +141,13 @@ function diffRegistry(registry, effectFiles) {
return { missing, stale };
}
+// The stale entries the registry spec fails on: the rule rejects imports of a file classified
+// "global" or "entry", so a stale entry keeps rejecting imports of a file that is now clean,
+// while a stale "self" entry affects nothing and can wait for an --update sweep.
+function enforcedStale(registry, stale) {
+ return stale.filter((file) => classify(registry, file) !== "self");
+}
+
function updateRegistry(registryPath, { missing, stale }) {
const raw = JSON.parse(fs.readFileSync(registryPath, "utf8"));
const staleSet = new Set(stale);
@@ -211,6 +218,7 @@ module.exports = {
listSourceFiles,
scanEffectFiles,
diffRegistry,
+ enforcedStale,
unimportedPackages,
};
diff --git a/frontend/lint/tests/side-effect-files.unit.spec.js b/frontend/lint/tests/side-effect-files.unit.spec.js
index 6aa368a0ab1..21adb5a7b05 100644
--- a/frontend/lint/tests/side-effect-files.unit.spec.js
+++ b/frontend/lint/tests/side-effect-files.unit.spec.js
@@ -3,6 +3,7 @@ import path from "path";
import {
diffRegistry,
+ enforcedStale,
listSourceFiles,
scanEffectFiles,
unimportedPackages,
@@ -24,16 +25,49 @@ describe("side-effect-files.json", () => {
const registry = loadRegistry(DEFAULT_REGISTRY_PATH);
const effectFiles = [...scanEffectFiles().keys()];
- it("lists every file the rule reports and nothing else", () => {
+ it("lists every file the rule reports, with no stale global or entry entries", () => {
const { missing, stale } = diffRegistry(registry, effectFiles);
const report = [
- ...missing.map((file) => `unregistered effect file: ${file}`),
- ...stale.map((file) => `registered but clean: ${file}`),
+ ...missing.map(
+ (file) =>
+ `${file} gained an import-time effect: run \`bun frontend/lint/scripts/side-effect-files.js --update\`, then classify the new entry`,
+ ),
+ ...enforcedStale(registry, stale).map(
+ (file) =>
+ `${file} no longer has an import-time effect: remove its entry with \`bun frontend/lint/scripts/side-effect-files.js --update\``,
+ ),
];
- // Run `bun frontend/lint/scripts/side-effect-files.js --update`, then classify the new entries.
expect(report).toEqual([]);
});
+ it("fails a stale global or entry entry but tolerates a stale self one", () => {
+ const stubRegistry = {
+ facades: [],
+ files: {
+ "frontend/src/clean-entry.ts": "entry",
+ "frontend/src/clean-global.ts": "global",
+ "frontend/src/clean-self.ts": "self",
+ "frontend/src/effect-file.ts": "global",
+ },
+ packages: {},
+ patterns: [],
+ unclassified: new Set(),
+ };
+ const { stale } = diffRegistry(stubRegistry, [
+ "frontend/src/effect-file.ts",
+ ]);
+ // diffRegistry reports all three, so --update prunes the self entry too.
+ expect(stale).toEqual([
+ "frontend/src/clean-entry.ts",
+ "frontend/src/clean-global.ts",
+ "frontend/src/clean-self.ts",
+ ]);
+ expect(enforcedStale(stubRegistry, stale)).toEqual([
+ "frontend/src/clean-entry.ts",
+ "frontend/src/clean-global.ts",
+ ]);
+ });
+
it("is well formed", () => {
expect(validateRegistry(registry, effectFiles)).toEqual([]);
});