Software/platform
1
1
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity

Finish up event queue abstraction

Browse Source
This commit is contained in:
Dominic Ferrando
2026-07-12 01:06:56 -04:00
parent 29a7a05a08
commit 80f8962a3b
4 changed files with 123 additions and 231 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/api/src/services/commerce.ts
+54 -189
View File
@@ -1,28 +1,32 @@
import { PrintfulClient, ProductSyncer, WebflowClient, type ProductSyncerOptions } from "@blade-and-brawn/commerce";
import { PrintfulClient, ProductSyncer, WebflowClient } from "@blade-and-brawn/commerce";
import { env, log } from "../util";
import { db } from "../database/db";
import type { Selectable, Transaction } from "kysely";
import type { DB } from "../database/out/db";
import { sleep } from "bun";
import { EventQueueService, type EventType } from "./event-queue";
import { Type as t } from "@sinclair/typebox";
import type { Static } from "@sinclair/typebox";
import { Value } from "@sinclair/typebox/value";
import { sql } from "kysely";
type EventStatus = "queued" | "active" | "failed" | "fulfilled";
const ProductSyncPayloadSchema = t.Object({
session: t.Object({
name: t.String(),
id: t.String()
}),
filter: t.Optional(
t.Object({
pProductIds: t.Optional(t.Array(t.Number()))
})
)
});
type ProductSyncPayload = Static<typeof ProductSyncPayloadSchema>;
export type ProductSyncPayload = {
session: {
name: string,
id: string
},
filter: ProductSyncerOptions["filter"]
}
export type ProductSyncState = {
syncingPProductIds: number[]
}
type ProductSyncHandler = (id: string, payload: ProductSyncPayload, setState: (state: ProductSyncState) => Promise<void>) => Promise<void>
class AlreadyClaimedEventError extends Error { }
class ActiveEventLimitReachedError extends Error { }
const ProductSyncStateSchema = t.Union([
t.Object({
pProductIds: t.Optional(t.Array(t.Number()))
}),
t.Null()
]);
type ProductSyncState = Static<typeof ProductSyncStateSchema>;
export class CommerceService {
public readonly Printful = new PrintfulClient({
@@ -39,188 +43,49 @@ export class CommerceService {
}
class ProductSyncService {
// TODO: make service have their own logger, so we can enforce .child({component: <ServiceName>})
readonly Queue: ProductSyncQueueService;
static readonly EVENT_TYPE: EventType = "product_sync";
readonly Queue: EventQueueService<ProductSyncPayload, ProductSyncState>;
private readonly ProductSyncer: ProductSyncer;
// TODO: make each service have their own logger, so we can enforce .child({component: <ServiceName>})
constructor(private readonly Printful: PrintfulClient, private readonly Webflow: WebflowClient) {
this.ProductSyncer = new ProductSyncer(this.Printful, this.Webflow, log);
this.Queue = new ProductSyncQueueService(async (_id, payload, setState) => {
await this.ProductSyncer.run({
filter: payload.filter,
beforeStep: async (syncingPProductIds: number[]) => {
await setState({ syncingPProductIds });
}
});
this.Queue = new EventQueueService({
type: ProductSyncService.EVENT_TYPE,
schemas: { payload: ProductSyncPayloadSchema, state: ProductSyncStateSchema },
cfg: {
retry: { limit: 3, delayMs: 10000 },
concurrency: { limit: 1, timeoutMs: 600000 }
},
handler: async (id, payload, setState) => {
await this.ProductSyncer.run({
filter: payload.filter,
beforeStep: async (pProductIds: number[]) => {
await setState({ pProductIds });
}
});
}
});
}
async getSessionSyncState(sessionId: string) {
const latestSync = await db.selectFrom("product_syncs")
.selectAll()
.where("session_id", "=", sessionId)
const latestSync = await db.selectFrom("events")
.select(["started_at", "ended_at", "has_failed", "state"])
.where("type", "=", ProductSyncService.EVENT_TYPE)
.where(sql<string>`payload->'session'->>'id'`, "=", sessionId)
.orderBy("created_at", "desc")
.limit(1)
.executeTakeFirst();
if (!latestSync) return;
Value.Assert(ProductSyncStateSchema, latestSync.state);
return {
startDate: latestSync.started_at,
status: ProductSyncQueueService.status(latestSync),
syncingPProductIds: latestSync.syncing_p_product_ids
}
}
}
class ProductSyncQueueService {
private static DRAIN_SLEEP_TIME = 10000; // 10 seconds
private static EVENT_TIMEOUT = 600000; // 10 min
private static MAX_ACTIVE_EVENTS = 1;
constructor(private handler: ProductSyncHandler) { }
static status(event: Selectable<ProductSyncs>): EventStatus {
if (!event.started_at) return "queued";
if (!event.ended_at) return "active";
return event.has_failed ? "failed" : "fulfilled";
}
async drain(): Promise<void> {
log.trace("draining queue");
while (true) {
try {
const nextActiveEvent = await this.dequeue();
if (!nextActiveEvent) break;
}
catch (err) {
if (err instanceof AlreadyClaimedEventError) {
log.warn("event handling already claimed by another worker, skipping");
continue;
}
if (err instanceof ActiveEventLimitReachedError) {
await sleep(ProductSyncQueueService.DRAIN_SLEEP_TIME);
continue;
}
else {
log.error("failed to drain queue");
throw err;
};
}
}
}
async dequeue() {
log.trace("attempting to dequeue");
const eventToHandle = await db.transaction().execute(async (trx) => {
const activeEvents = await this.activeEvents(trx);
let activeEventCount = activeEvents.length;
for (const activeEvent of activeEvents) {
// If event has been active past max active time, fail it
const activeEventTimedOut = (Date.now() - (activeEvent.started_at?.getTime() ?? 0) > ProductSyncQueueService.EVENT_TIMEOUT);
if (activeEventTimedOut) {
log.info({ name: activeEvent.id }, "active event has timed out. failing it and continuing...");
await this.fail(activeEvent.id, trx);
--activeEventCount;
}
}
if (activeEventCount >= ProductSyncQueueService.MAX_ACTIVE_EVENTS)
throw new ActiveEventLimitReachedError();
const front = await this.front(trx);
if (!front) return;
const result = await trx.updateTable("product_syncs")
.set({ started_at: new Date() })
.where("id", "=", front.id)
.where("started_at", "is", null)
.executeTakeFirstOrThrow();
// Guard against another worker/machine having already claimed this event
if (result.numUpdatedRows === 0n) throw new AlreadyClaimedEventError();
return front;
});
if (eventToHandle) {
log.trace({ name: eventToHandle.id }, "dequeuing event");
await this.handleEvent(eventToHandle.id, {
session: {
id: eventToHandle.session_id,
name: eventToHandle.session_name
},
filter: { pProductIds: eventToHandle.p_product_id_filter }
});
return eventToHandle;
}
}
async enqueue(payload: ProductSyncPayload): Promise<string> {
log.info({ payload }, "enqueuing");
const result = await db.insertInto("product_syncs")
.values({
session_id: payload.session.id,
session_name: payload.session.name,
p_product_id_filter: payload.filter?.pProductIds ?? null,
started_at: null,
})
.returning(["id"])
.executeTakeFirstOrThrow();
return result.id;
}
async fail(id: string, trx?: Transaction<DB>): Promise<void> {
await (trx ?? db).updateTable("product_syncs")
.set({ syncing_p_product_ids: [], ended_at: new Date(), has_failed: true })
.where("id", "=", id)
.execute();
}
async fulfill(id: string, trx?: Transaction<DB>): Promise<void> {
await (trx ?? db).updateTable("product_syncs")
.set({ syncing_p_product_ids: [], ended_at: new Date() })
.where("id", "=", id)
.execute();
}
async clean() {
// TODO
}
async front(trx?: Transaction<DB>) {
const result = await (trx ?? db).selectFrom("product_syncs")
.selectAll()
.where("started_at", "is", null)
.orderBy("created_at", "asc")
.limit(1)
.executeTakeFirst();
return result;
}
async activeEvents(trx?: Transaction<DB>) {
return await (trx ?? db).selectFrom("product_syncs")
.select(["started_at", "id"])
.where("started_at", "is not", null)
.where("ended_at", "is", null)
.execute();
}
private async handleEvent(id: string, payload: ProductSyncPayload) {
log.info({ id, payload }, "handling event");
try {
await this.handler(id, payload, async (state) => {
// set event state
await db.updateTable("product_syncs")
.set({ syncing_p_product_ids: state.syncingPProductIds })
.where("id", "=", id)
.execute();
});
}
catch (err) {
await this.fail(id);
throw err;
}
await this.fulfill(id);
status: EventQueueService.status(latestSync),
syncingPProductIds: latestSync.state?.pProductIds ?? []
};
}
}
apps/api/src/services/event-queue.ts
+40 -32
View File
@@ -6,8 +6,8 @@ import { db } from "../database/db";
import { Value } from "@sinclair/typebox/value";
import type { TSchema } from "@sinclair/typebox";
type EventType = "product_sync" | "product_order_created" /* TODO: more events... */;
type Source = "portal" | "printful" | "webflow";
export type EventType = "product_sync" | "product_order_created" /* TODO: more events... */;
export type EventSource = "portal" | "printful" | "webflow";
type EventHandler<Payload extends JsonValue, State extends JsonValue> =
(id: string, payload: Payload, setState: (state: State) => Promise<void>) => Promise<void>;
@@ -16,27 +16,33 @@ type EventStatus = "queued" | "active" | "failed" | "fulfilled";
class AlreadyClaimedEventError extends Error { }
class ConcurrencyLimitReachedError extends Error { }
type EventQueueServiceOptions = {
retry: {
limit: number,
delayMs: number,
type EventQueueServiceOptions<Payload extends JsonValue, State extends JsonValue> = {
type: EventType,
schemas: {
payload: TSchema & { static: Payload },
state: TSchema & { static: State },
},
concurrency: {
limit: number,
timeoutMs: number,
}
cfg: {
retry: {
limit: number,
delayMs: number,
},
concurrency: {
limit: number,
timeoutMs: number,
},
},
handler: EventHandler<Payload, State>,
}
export class EventQueueService<Payload extends JsonValue, State extends JsonValue> {
constructor(
readonly type: EventType,
private payloadSchema: TSchema & { static: Payload },
private stateSchema: TSchema & { static: State },
private handler: EventHandler<Payload, State>,
readonly opt: EventQueueServiceOptions
) { }
private _lastCleanDate: Date = new Date(0);
static status(event: Selectable<DB["events"]>): EventStatus {
constructor(private opt: EventQueueServiceOptions<Payload, State>) { }
get lastCleanDate() { return this._lastCleanDate; };
static status(event: Pick<Selectable<DB["events"]>, "started_at" | "ended_at" | "has_failed">): EventStatus {
if (!event.started_at) return "queued";
if (!event.ended_at) return "active";
return event.has_failed ? "failed" : "fulfilled";
@@ -57,17 +63,17 @@ export class EventQueueService<Payload extends JsonValue, State extends JsonValu
continue;
}
if (err instanceof ConcurrencyLimitReachedError) {
await sleep(this.opt.retry.delayMs);
await sleep(this.opt.cfg.retry.delayMs);
continue;
}
if (++consecutiveFailures <= this.opt.retry.limit) {
if (++consecutiveFailures <= this.opt.cfg.retry.limit) {
log.warn({ err, consecutiveFailures }, "Dequeue failed, retrying")
await sleep(this.opt.retry.delayMs);
await sleep(this.opt.cfg.retry.delayMs);
continue;
}
log.error({ err }, "failed to drain queue");
log.error({ err, consecutiveFailures }, "failed to drain queue");
throw err;
}
}
@@ -87,11 +93,11 @@ export class EventQueueService<Payload extends JsonValue, State extends JsonValu
eb(
eb.selectFrom("events")
.select(eb.fn.countAll().as("count"))
.where("type", "=", this.type)
.where("type", "=", this.opt.type)
.where("started_at", "is not", null)
.where("ended_at", "is", null),
"<",
this.opt.concurrency.limit
this.opt.cfg.concurrency.limit
)
)
.executeTakeFirstOrThrow();
@@ -113,10 +119,10 @@ export class EventQueueService<Payload extends JsonValue, State extends JsonValu
return front;
}
async enqueue(source: Source, payload: Payload): Promise<string> {
async enqueue({ source, payload }: { source: EventSource, payload: Payload }): Promise<string> {
log.info({ payload }, "enqueuing");
const result = await db.insertInto("events")
.values({ type: this.type, source, payload })
.values({ type: this.opt.type, source, payload })
.returning(["id"])
.executeTakeFirstOrThrow();
return result.id;
@@ -140,18 +146,20 @@ export class EventQueueService<Payload extends JsonValue, State extends JsonValu
// Find and fail any timed out active events
const activeEvents = await this.activeEvents();
for (const activeEvent of activeEvents) {
const activeEventTimedOut = (Date.now() - (activeEvent.started_at?.getTime() ?? 0) > this.opt.concurrency.timeoutMs);
const activeEventTimedOut = (Date.now() - (activeEvent.started_at?.getTime() ?? 0) > this.opt.cfg.concurrency.timeoutMs);
if (activeEventTimedOut) {
log.info({ name: activeEvent.id }, "active event has timed out. failing it and continuing...");
log.warn({ name: activeEvent.id }, "active event has timed out. failing it and continuing...");
await this.fail(activeEvent.id);
}
}
this._lastCleanDate = new Date();
}
async front(trx?: Transaction<DB>) {
const result = await (trx ?? db).selectFrom("events")
.selectAll()
.where("type", "=", this.type)
.where("type", "=", this.opt.type)
.where("started_at", "is", null)
.orderBy("created_at", "asc")
.limit(1)
@@ -162,7 +170,7 @@ export class EventQueueService<Payload extends JsonValue, State extends JsonValu
async activeEvents(trx?: Transaction<DB>) {
return await (trx ?? db).selectFrom("events")
.select(["started_at", "id"])
.where("type", "=", this.type)
.where("type", "=", this.opt.type)
.where("started_at", "is not", null)
.where("ended_at", "is", null)
.execute();
@@ -171,8 +179,8 @@ export class EventQueueService<Payload extends JsonValue, State extends JsonValu
private async handleEvent(id: string, payload: JsonValue) {
log.info({ id, payload }, "handling event");
try {
Value.Assert(this.payloadSchema, payload);
await this.handler(id, payload, async (state) => {
Value.Assert(this.opt.schemas.payload, payload);
await this.opt.handler(id, payload, async (state) => {
await db.updateTable("events")
.set({ state })
.where("id", "=", id)