fix(core-eslint): resolve event descriptors in no-undeclared-event-publish
The rule only matched bus.publish("string-literal", ...), but the
canonical pattern that `gen event` prescribes is
bus.publish(eventDescriptor, payload) — an imported identifier, never a
literal. The rule therefore never fired on real code, which is how the
auth signUp publish drifted from its manifest undetected.
Add `_event-ast.js`: resolves a `bus.publish(<identifier>)` argument by
following the import to the event-contract file and extracting the name
from either `defineEvent("...", schema)` or an inline `{ name }` object.
Unresolvable arguments are skipped, so the rule never false-positives.
This commit is contained in:
@@ -5,13 +5,16 @@ import os from "node:os";
|
||||
import fs from "node:fs";
|
||||
import rule from "./no-undeclared-event-publish.js";
|
||||
|
||||
function makeFixture({ manifestUseCases, useCaseBody }) {
|
||||
function makeFixture({ manifestUseCases, useCaseBody, eventFile }) {
|
||||
const repoRoot = fs.mkdtempSync(path.join(os.tmpdir(), "nuep-"));
|
||||
const featureDir = path.join(repoRoot, "packages", "demo");
|
||||
fs.mkdirSync(path.join(featureDir, "src", "application", "use-cases"), { recursive: true });
|
||||
fs.mkdirSync(path.join(featureDir, "src", "application", "use-cases"), {
|
||||
recursive: true,
|
||||
});
|
||||
const useCasesObj = Object.entries(manifestUseCases)
|
||||
.map(([name, uc]) =>
|
||||
` ${name}: { mutates: ${uc.mutates}, audits: [${uc.audits.map((a) => `"${a}"`).join(", ")}], publishes: [${uc.publishes.map((p) => `"${p}"`).join(", ")}], consumes: [] },`,
|
||||
.map(
|
||||
([name, uc]) =>
|
||||
` ${name}: { mutates: ${uc.mutates}, audits: [${uc.audits.map((a) => `"${a}"`).join(", ")}], publishes: [${uc.publishes.map((p) => `"${p}"`).join(", ")}], consumes: [] },`,
|
||||
)
|
||||
.join("\n");
|
||||
fs.writeFileSync(
|
||||
@@ -26,7 +29,21 @@ ${useCasesObj}
|
||||
jobs: [],
|
||||
} as const);`,
|
||||
);
|
||||
const useCaseFile = path.join(featureDir, "src", "application", "use-cases", "sign-up.use-case.ts");
|
||||
if (eventFile) {
|
||||
const eventsDir = path.join(featureDir, "src", "events");
|
||||
fs.mkdirSync(eventsDir, { recursive: true });
|
||||
fs.writeFileSync(
|
||||
path.join(eventsDir, eventFile.filename),
|
||||
eventFile.contents,
|
||||
);
|
||||
}
|
||||
const useCaseFile = path.join(
|
||||
featureDir,
|
||||
"src",
|
||||
"application",
|
||||
"use-cases",
|
||||
"sign-up.use-case.ts",
|
||||
);
|
||||
fs.writeFileSync(useCaseFile, useCaseBody);
|
||||
return { repoRoot, useCaseFile };
|
||||
}
|
||||
@@ -42,39 +59,148 @@ const tester = new RuleTester({
|
||||
describe("no-undeclared-event-publish", () => {
|
||||
it("passes when bus.publish event name matches manifest publishes[]", () => {
|
||||
const { repoRoot, useCaseFile } = makeFixture({
|
||||
manifestUseCases: { signUp: { mutates: true, audits: [], publishes: ["demo.signed-up"] } },
|
||||
manifestUseCases: {
|
||||
signUp: { mutates: true, audits: [], publishes: ["demo.signed-up"] },
|
||||
},
|
||||
useCaseBody: `export const signUpUseCase = (bus) => async () => { bus.publish("demo.signed-up", {}); };`,
|
||||
});
|
||||
tester.run("no-undeclared-event-publish", rule, {
|
||||
valid: [{ filename: useCaseFile, code: fs.readFileSync(useCaseFile, "utf8"), options: [{ repoRoot }] }],
|
||||
valid: [
|
||||
{
|
||||
filename: useCaseFile,
|
||||
code: fs.readFileSync(useCaseFile, "utf8"),
|
||||
options: [{ repoRoot }],
|
||||
},
|
||||
],
|
||||
invalid: [],
|
||||
});
|
||||
});
|
||||
|
||||
it("fires when bus.publish event name is not in manifest", () => {
|
||||
const { repoRoot, useCaseFile } = makeFixture({
|
||||
manifestUseCases: { signUp: { mutates: true, audits: [], publishes: [] } },
|
||||
manifestUseCases: {
|
||||
signUp: { mutates: true, audits: [], publishes: [] },
|
||||
},
|
||||
useCaseBody: `export const signUpUseCase = (bus) => async () => { bus.publish("demo.signed-up", {}); };`,
|
||||
});
|
||||
tester.run("no-undeclared-event-publish", rule, {
|
||||
valid: [],
|
||||
invalid: [{
|
||||
filename: useCaseFile,
|
||||
code: fs.readFileSync(useCaseFile, "utf8"),
|
||||
options: [{ repoRoot }],
|
||||
errors: [{ messageId: "undeclared", data: { event: "demo.signed-up", useCase: "signUp" } }],
|
||||
}],
|
||||
invalid: [
|
||||
{
|
||||
filename: useCaseFile,
|
||||
code: fs.readFileSync(useCaseFile, "utf8"),
|
||||
options: [{ repoRoot }],
|
||||
errors: [
|
||||
{
|
||||
messageId: "undeclared",
|
||||
data: { event: "demo.signed-up", useCase: "signUp" },
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
it("is a no-op when bus.publish is called with a non-literal argument", () => {
|
||||
it("is a no-op when bus.publish is called with an unresolvable identifier", () => {
|
||||
const { repoRoot, useCaseFile } = makeFixture({
|
||||
manifestUseCases: { signUp: { mutates: true, audits: [], publishes: [] } },
|
||||
manifestUseCases: {
|
||||
signUp: { mutates: true, audits: [], publishes: [] },
|
||||
},
|
||||
useCaseBody: `export const signUpUseCase = (bus, name) => async () => { bus.publish(name, {}); };`,
|
||||
});
|
||||
tester.run("no-undeclared-event-publish", rule, {
|
||||
valid: [{ filename: useCaseFile, code: fs.readFileSync(useCaseFile, "utf8"), options: [{ repoRoot }] }],
|
||||
valid: [
|
||||
{
|
||||
filename: useCaseFile,
|
||||
code: fs.readFileSync(useCaseFile, "utf8"),
|
||||
options: [{ repoRoot }],
|
||||
},
|
||||
],
|
||||
invalid: [],
|
||||
});
|
||||
});
|
||||
|
||||
it("passes when an imported inline event descriptor is declared", () => {
|
||||
const { repoRoot, useCaseFile } = makeFixture({
|
||||
manifestUseCases: {
|
||||
signUp: { mutates: true, audits: [], publishes: ["demo.signed-up"] },
|
||||
},
|
||||
eventFile: {
|
||||
filename: "signed-up.event.ts",
|
||||
contents: `export const signedUpEvent = { name: "demo.signed-up" as const, schema: {} };`,
|
||||
},
|
||||
useCaseBody: `import { signedUpEvent } from "../../events/signed-up.event";
|
||||
export const signUpUseCase = (bus) => async () => { bus.publish(signedUpEvent, {}); };`,
|
||||
});
|
||||
tester.run("no-undeclared-event-publish", rule, {
|
||||
valid: [
|
||||
{
|
||||
filename: useCaseFile,
|
||||
code: fs.readFileSync(useCaseFile, "utf8"),
|
||||
options: [{ repoRoot }],
|
||||
},
|
||||
],
|
||||
invalid: [],
|
||||
});
|
||||
});
|
||||
|
||||
it("fires when an imported inline event descriptor is not declared", () => {
|
||||
const { repoRoot, useCaseFile } = makeFixture({
|
||||
manifestUseCases: {
|
||||
signUp: { mutates: true, audits: [], publishes: [] },
|
||||
},
|
||||
eventFile: {
|
||||
filename: "signed-up.event.ts",
|
||||
contents: `export const signedUpEvent = { name: "demo.signed-up" as const, schema: {} };`,
|
||||
},
|
||||
useCaseBody: `import { signedUpEvent } from "../../events/signed-up.event";
|
||||
export const signUpUseCase = (bus) => async () => { bus.publish(signedUpEvent, {}); };`,
|
||||
});
|
||||
tester.run("no-undeclared-event-publish", rule, {
|
||||
valid: [],
|
||||
invalid: [
|
||||
{
|
||||
filename: useCaseFile,
|
||||
code: fs.readFileSync(useCaseFile, "utf8"),
|
||||
options: [{ repoRoot }],
|
||||
errors: [
|
||||
{
|
||||
messageId: "undeclared",
|
||||
data: { event: "demo.signed-up", useCase: "signUp" },
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
it("fires when an imported defineEvent() descriptor is not declared", () => {
|
||||
const { repoRoot, useCaseFile } = makeFixture({
|
||||
manifestUseCases: {
|
||||
signUp: { mutates: true, audits: [], publishes: [] },
|
||||
},
|
||||
eventFile: {
|
||||
filename: "signed-up.event.ts",
|
||||
contents: `export const signedUpEvent = defineEvent("demo.signed-up", {});`,
|
||||
},
|
||||
useCaseBody: `import { signedUpEvent } from "../../events/signed-up.event";
|
||||
export const signUpUseCase = (bus) => async () => { bus.publish(signedUpEvent, {}); };`,
|
||||
});
|
||||
tester.run("no-undeclared-event-publish", rule, {
|
||||
valid: [],
|
||||
invalid: [
|
||||
{
|
||||
filename: useCaseFile,
|
||||
code: fs.readFileSync(useCaseFile, "utf8"),
|
||||
options: [{ repoRoot }],
|
||||
errors: [
|
||||
{
|
||||
messageId: "undeclared",
|
||||
data: { event: "demo.signed-up", useCase: "signUp" },
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user