mirror of
https://github.com/juherr/kill-the-news.git
synced 2026-06-20 22:03:48 +00:00
refactor: introduce domain events for feed side effects (Track E — point 5)
Light "collect + dispatch" variant: the Feed aggregate records FeedEvents (FeedCreated, EmailIngested) on the mutations that have consequences, exposed via pullEvents(). A new application dispatcher (feed-events.applyFeedEvents) maps those events to their side effects — counters (awaited) plus WebSub pings and favicon fetches handed to a BackgroundScheduler. This removes the inline, scattered side effects from the ingest hot path (email-processor) and from createFeedRecord; the aggregate is now the source of truth for "what happened". Side effects with no aggregate mutation (rejected email, feed deletion bypassing the aggregate, bulk admin ops, the cron, unsubscribes-sent) stay imperative by design — there is no aggregate event for them to ride on. BackgroundScheduler type moved to infrastructure/worker.ts (shared). CLAUDE.md updated. 355 tests pass (+4 event tests); tsc --noEmit clean. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -1,14 +1,12 @@
|
||||
import { EmailParser } from "../domain/email-parser";
|
||||
import { AttachmentData, EmailMetadata, Env } from "../types";
|
||||
import { notifySubscribers } from "../infrastructure/websub";
|
||||
import { bumpCounters } from "../application/stats";
|
||||
import {
|
||||
cacheFaviconForDomain,
|
||||
extractEmailDomain,
|
||||
} from "../infrastructure/favicon-fetcher";
|
||||
import { applyFeedEvents } from "../application/feed-events";
|
||||
import { extractEmailDomain } from "../infrastructure/favicon-fetcher";
|
||||
import { parseOneClickUnsubscribe } from "../infrastructure/unsubscribe";
|
||||
import { getAttachmentBucket } from "../infrastructure/attachments";
|
||||
import { FeedRepository } from "../infrastructure/feed-repository";
|
||||
import { BackgroundScheduler } from "../infrastructure/worker";
|
||||
import { Feed } from "../domain/feed.aggregate";
|
||||
import { logger } from "../infrastructure/logger";
|
||||
import { FEED_MAX_BYTES } from "../config/constants";
|
||||
@@ -183,12 +181,14 @@ async function storeEmail(
|
||||
]);
|
||||
|
||||
logger.info("Email processed", { feedId: feed.id.value });
|
||||
if (ctx) {
|
||||
ctx.waitUntil(notifySubscribers(feed.id.value, env));
|
||||
if (iconDomain) {
|
||||
ctx.waitUntil(cacheFaviconForDomain(iconDomain, env));
|
||||
}
|
||||
}
|
||||
|
||||
// The aggregate recorded an EmailIngested event; the dispatcher applies its
|
||||
// side effects (received counter, WebSub ping, favicon fetch). Background work
|
||||
// rides on ctx.waitUntil when present, and is skipped in its absence (tests).
|
||||
const schedule: BackgroundScheduler = ctx
|
||||
? (p) => ctx.waitUntil(p)
|
||||
: () => {};
|
||||
await applyFeedEvents(feed.id, feed.pullEvents(), env, schedule);
|
||||
}
|
||||
|
||||
export async function processEmail(
|
||||
@@ -203,9 +203,5 @@ export async function processEmail(
|
||||
}
|
||||
|
||||
await storeEmail(validation.feed, input, env, ctx);
|
||||
await bumpCounters(env.EMAIL_STORAGE, {
|
||||
emails_received: 1,
|
||||
last_email_at: new Date().toISOString(),
|
||||
});
|
||||
return { ok: true, feedId: validation.feed.id.value };
|
||||
}
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
import { Env } from "../types";
|
||||
import { FeedEvent } from "../domain/events";
|
||||
import { FeedId } from "../domain/value-objects/feed-id";
|
||||
import { BackgroundScheduler } from "../infrastructure/worker";
|
||||
import { bumpCounters } from "./stats";
|
||||
import { notifySubscribers } from "../infrastructure/websub";
|
||||
import { cacheFaviconForDomain } from "../infrastructure/favicon-fetcher";
|
||||
|
||||
/**
|
||||
* Apply the side effects of a feed's domain events — the single place that maps
|
||||
* "what happened" (FeedCreated, EmailIngested) to its consequences. Counter
|
||||
* writes are awaited (they must land); WebSub pings and favicon fetches are
|
||||
* handed to the caller's background scheduler (`ctx.waitUntil` at the edge, a
|
||||
* no-op when none is available).
|
||||
*/
|
||||
export async function applyFeedEvents(
|
||||
feedId: FeedId,
|
||||
events: FeedEvent[],
|
||||
env: Env,
|
||||
schedule: BackgroundScheduler,
|
||||
): Promise<void> {
|
||||
for (const event of events) {
|
||||
switch (event.type) {
|
||||
case "FeedCreated":
|
||||
await bumpCounters(env.EMAIL_STORAGE, {
|
||||
feeds_created: 1,
|
||||
last_feed_created_at: new Date().toISOString(),
|
||||
});
|
||||
break;
|
||||
case "EmailIngested":
|
||||
await bumpCounters(env.EMAIL_STORAGE, {
|
||||
emails_received: 1,
|
||||
last_email_at: new Date().toISOString(),
|
||||
});
|
||||
schedule(notifySubscribers(feedId.value, env));
|
||||
if (event.iconDomain) {
|
||||
schedule(cacheFaviconForDomain(event.iconDomain, env));
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
import { describe, it, expect } from "vitest";
|
||||
import { createMockEnv } from "../test/setup";
|
||||
import { createFeedRecord, editFeed } from "./feed-service";
|
||||
import { getCounters } from "./stats";
|
||||
import type { Env } from "../types";
|
||||
|
||||
const mkEnv = (overrides: Partial<Env> = {}) =>
|
||||
@@ -42,6 +43,14 @@ describe("createFeedRecord — TTL policy", () => {
|
||||
// 1h (server) wins over 9999h (client).
|
||||
expect(config.expires_at!).toBeLessThan(before + TWO_HOURS);
|
||||
});
|
||||
|
||||
it("bumps the feeds_created counter via the FeedCreated domain event", async () => {
|
||||
const env = mkEnv();
|
||||
await createFeedRecord(env, { ...baseInput });
|
||||
const counters = await getCounters(env.EMAIL_STORAGE);
|
||||
expect(counters.feeds_created).toBe(1);
|
||||
expect(counters.last_feed_created_at).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe("editFeed — TTL policy", () => {
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
import { Env, FeedConfig } from "../types";
|
||||
import { bumpCounters } from "../application/stats";
|
||||
import { applyFeedEvents } from "./feed-events";
|
||||
import { sendUnsubscribes } from "../infrastructure/unsubscribe";
|
||||
import { getAttachmentBucket } from "../infrastructure/attachments";
|
||||
import { FeedRepository } from "../infrastructure/feed-repository";
|
||||
import { BackgroundScheduler } from "../infrastructure/worker";
|
||||
import { FeedId } from "../domain/value-objects/feed-id";
|
||||
import {
|
||||
Feed,
|
||||
@@ -50,10 +52,8 @@ export async function createFeedRecord(
|
||||
feed.config.expires_at,
|
||||
);
|
||||
|
||||
await bumpCounters(env.EMAIL_STORAGE, {
|
||||
feeds_created: 1,
|
||||
last_feed_created_at: new Date().toISOString(),
|
||||
});
|
||||
// FeedCreated → bumps the feeds_created counter (no background work to schedule).
|
||||
await applyFeedEvents(feed.id, feed.pullEvents(), env, () => {});
|
||||
|
||||
return { feedId: feed.id.value, config: feed.config };
|
||||
}
|
||||
@@ -162,13 +162,6 @@ export async function deleteFeedFastDetailed(
|
||||
return { ok: configDeleted, configDeleted, metadataDeleted, errors };
|
||||
}
|
||||
|
||||
/**
|
||||
* Schedules a fire-and-forget background task. The HTTP edge passes an adapter
|
||||
* over `ctx.waitUntil` (e.g. `(p) => waitUntilSafe(c, p)`); keeping it a plain
|
||||
* function means the application layer never imports Hono's `Context`.
|
||||
*/
|
||||
export type BackgroundScheduler = (task: Promise<unknown>) => void;
|
||||
|
||||
/**
|
||||
* Delete a single feed end-to-end: capture unsubscribe URLs, drop its config +
|
||||
* metadata, remove it from the list, bump the counter, and hand the background
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* Domain events the Feed aggregate records when it mutates. They describe *what
|
||||
* happened* in business terms; the application layer decides which side effects
|
||||
* to run (counters, WebSub pings, favicon caching) via a dispatcher. This keeps
|
||||
* the aggregate ignorant of infrastructure and the orchestration code free of
|
||||
* scattered, inline side effects.
|
||||
*
|
||||
* Only mutations that currently have side effects emit events — feed creation
|
||||
* and email ingestion. Edits and removals carry no side effect, so they emit
|
||||
* nothing. Side effects that don't flow through the aggregate (a rejected email,
|
||||
* a feed deletion that bypasses the aggregate, bulk admin operations) stay
|
||||
* outside this mechanism by design — they have no aggregate event to ride on.
|
||||
*/
|
||||
export type FeedEvent =
|
||||
| { type: "FeedCreated" }
|
||||
| { type: "EmailIngested"; iconDomain?: string };
|
||||
@@ -173,6 +173,43 @@ describe("Feed.removeEmails", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("Feed events", () => {
|
||||
it("records FeedCreated on create and drains it once", () => {
|
||||
const feed = Feed.create(FID, createInput());
|
||||
expect(feed.pullEvents()).toEqual([{ type: "FeedCreated" }]);
|
||||
// Draining clears: a second pull is empty.
|
||||
expect(feed.pullEvents()).toEqual([]);
|
||||
});
|
||||
|
||||
it("records EmailIngested (with icon domain) on ingest", () => {
|
||||
const feed = Feed.reconstitute(
|
||||
FID,
|
||||
{ title: "T", language: "en", created_at: 0 },
|
||||
{ emails: [] },
|
||||
);
|
||||
feed.ingest(entry({ key: "k" }), {
|
||||
maxBytes: 1_000_000,
|
||||
iconDomain: "example.com",
|
||||
});
|
||||
expect(feed.pullEvents()).toEqual([
|
||||
{ type: "EmailIngested", iconDomain: "example.com" },
|
||||
]);
|
||||
});
|
||||
|
||||
it("emits no events for editDetails / edit / removeEmails", () => {
|
||||
const feed = Feed.reconstitute(
|
||||
FID,
|
||||
{ title: "T", language: "en", created_at: 0, expires_at: 9_999_999_999 },
|
||||
{ emails: [entry({ key: "k1" })] },
|
||||
fixedClock(1000),
|
||||
);
|
||||
feed.editDetails({ title: "X" });
|
||||
feed.edit({ description: "Y" }, { recomputeExpiry: false });
|
||||
feed.removeEmails(["k1"]);
|
||||
expect(feed.pullEvents()).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("FeedRepository.load / save round-trip", () => {
|
||||
it("persists a created feed and reflects later mutations", async () => {
|
||||
const repo = new FeedRepository(mockEnv().EMAIL_STORAGE);
|
||||
|
||||
@@ -2,6 +2,7 @@ import { FeedConfig, FeedMetadata, EmailMetadata } from "../types";
|
||||
import { FeedId } from "./value-objects/feed-id";
|
||||
import { SenderPolicy, SenderDecision } from "./value-objects/sender-policy";
|
||||
import { Clock, systemClock } from "./clock";
|
||||
import { FeedEvent } from "./events";
|
||||
import { resolveExpiresAt, isExpired, trimToByteBudget } from "./feed";
|
||||
|
||||
export interface CreateFeedInput {
|
||||
@@ -65,6 +66,8 @@ export interface IngestOptions {
|
||||
* concurrent writers (see email-processor.ts).
|
||||
*/
|
||||
export class Feed {
|
||||
private readonly _events: FeedEvent[] = [];
|
||||
|
||||
private constructor(
|
||||
readonly id: FeedId,
|
||||
private _config: FeedConfig,
|
||||
@@ -91,7 +94,9 @@ export class Feed {
|
||||
updated_at: now,
|
||||
...(expiresAt !== undefined ? { expires_at: expiresAt } : {}),
|
||||
};
|
||||
return new Feed(id, config, { emails: [] }, clock);
|
||||
const feed = new Feed(id, config, { emails: [] }, clock);
|
||||
feed._events.push({ type: "FeedCreated" });
|
||||
return feed;
|
||||
}
|
||||
|
||||
/** Rebuild an aggregate from persisted state. */
|
||||
@@ -112,6 +117,16 @@ export class Feed {
|
||||
return this._metadata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Drain the domain events recorded since the last pull. The application layer
|
||||
* calls this after persisting and feeds them to a dispatcher that runs the
|
||||
* side effects (counters, WebSub, favicon). Clearing on read keeps a long-lived
|
||||
* aggregate from re-emitting.
|
||||
*/
|
||||
pullEvents(): FeedEvent[] {
|
||||
return this._events.splice(0, this._events.length);
|
||||
}
|
||||
|
||||
isExpired(now: number = this.clock.now()): boolean {
|
||||
return isExpired(this._config, now);
|
||||
}
|
||||
@@ -145,6 +160,7 @@ export class Feed {
|
||||
};
|
||||
}
|
||||
|
||||
this._events.push({ type: "EmailIngested", iconDomain: opts.iconDomain });
|
||||
return trimToByteBudget(this._metadata, opts.maxBytes);
|
||||
}
|
||||
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
import { Context } from "hono";
|
||||
|
||||
/**
|
||||
* Schedules a fire-and-forget background task. The HTTP edge adapts this over
|
||||
* `ctx.waitUntil`; the application/domain layers depend on this plain function
|
||||
* type instead of Hono's `Context`.
|
||||
*/
|
||||
export type BackgroundScheduler = (task: Promise<unknown>) => void;
|
||||
|
||||
/** Calls ctx.waitUntil() without throwing when the ExecutionContext is absent (e.g. Node tests). */
|
||||
export function waitUntilSafe(c: Context, promise: Promise<unknown>): void {
|
||||
try {
|
||||
|
||||
Reference in New Issue
Block a user