@outbox-event-bus/sqlite-better-sqlite3-outbox 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +759 -0
- package/dist/index.cjs +259 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +75 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +75 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +228 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +54 -0
- package/src/error-handling.test.ts +145 -0
- package/src/index.ts +2 -0
- package/src/integration.e2e.ts +258 -0
- package/src/schema.sql +30 -0
- package/src/sqlite-better-sqlite3-outbox.ts +291 -0
- package/src/sync-transaction.test.ts +117 -0
- package/src/transaction-storage.ts +42 -0
- package/src/transactions.test.ts +196 -0
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
import Database from "better-sqlite3";
|
|
2
|
+
import { EventStatus, PollingService, formatErrorMessage, reportEventError } from "outbox-event-bus";
|
|
3
|
+
import { AsyncLocalStorage } from "node:async_hooks";
|
|
4
|
+
|
|
5
|
+
//#region src/sqlite-better-sqlite3-outbox.ts
|
|
6
|
+
const DEFAULT_EXPIRE_IN_SECONDS = 300;
|
|
7
|
+
const getOutboxSchema = (tableName, archiveTableName) => `
|
|
8
|
+
CREATE TABLE IF NOT EXISTS ${tableName} (
|
|
9
|
+
id TEXT PRIMARY KEY,
|
|
10
|
+
type TEXT NOT NULL,
|
|
11
|
+
payload TEXT NOT NULL,
|
|
12
|
+
occurred_at TEXT NOT NULL,
|
|
13
|
+
status TEXT NOT NULL DEFAULT '${EventStatus.CREATED}',
|
|
14
|
+
retry_count INTEGER NOT NULL DEFAULT 0,
|
|
15
|
+
last_error TEXT,
|
|
16
|
+
next_retry_at TEXT,
|
|
17
|
+
created_on TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now')),
|
|
18
|
+
started_on TEXT,
|
|
19
|
+
completed_on TEXT,
|
|
20
|
+
keep_alive TEXT,
|
|
21
|
+
expire_in_seconds INTEGER NOT NULL DEFAULT ${DEFAULT_EXPIRE_IN_SECONDS}
|
|
22
|
+
);
|
|
23
|
+
|
|
24
|
+
CREATE TABLE IF NOT EXISTS ${archiveTableName} (
|
|
25
|
+
id TEXT PRIMARY KEY,
|
|
26
|
+
type TEXT NOT NULL,
|
|
27
|
+
payload TEXT NOT NULL,
|
|
28
|
+
occurred_at TEXT NOT NULL,
|
|
29
|
+
status TEXT NOT NULL,
|
|
30
|
+
retry_count INTEGER NOT NULL,
|
|
31
|
+
last_error TEXT,
|
|
32
|
+
created_on TEXT NOT NULL,
|
|
33
|
+
started_on TEXT,
|
|
34
|
+
completed_on TEXT NOT NULL
|
|
35
|
+
);
|
|
36
|
+
|
|
37
|
+
CREATE INDEX IF NOT EXISTS idx_${tableName}_status_retry ON ${tableName} (status, next_retry_at);
|
|
38
|
+
`;
|
|
39
|
+
var SqliteBetterSqlite3Outbox = class {
|
|
40
|
+
config;
|
|
41
|
+
db;
|
|
42
|
+
poller;
|
|
43
|
+
constructor(config) {
|
|
44
|
+
if (config.db) this.db = config.db;
|
|
45
|
+
else {
|
|
46
|
+
if (!config.dbPath) throw new Error("dbPath is required if db is not provided");
|
|
47
|
+
this.db = new Database(config.dbPath);
|
|
48
|
+
this.db.pragma("journal_mode = WAL");
|
|
49
|
+
}
|
|
50
|
+
this.config = {
|
|
51
|
+
batchSize: config.batchSize ?? 50,
|
|
52
|
+
pollIntervalMs: config.pollIntervalMs ?? 1e3,
|
|
53
|
+
maxRetries: config.maxRetries ?? 5,
|
|
54
|
+
baseBackoffMs: config.baseBackoffMs ?? 1e3,
|
|
55
|
+
processingTimeoutMs: config.processingTimeoutMs ?? 3e4,
|
|
56
|
+
maxErrorBackoffMs: config.maxErrorBackoffMs ?? 3e4,
|
|
57
|
+
dbPath: config.dbPath ?? "",
|
|
58
|
+
db: this.db,
|
|
59
|
+
getTransaction: config.getTransaction,
|
|
60
|
+
tableName: config.tableName ?? "outbox_events",
|
|
61
|
+
archiveTableName: config.archiveTableName ?? "outbox_events_archive"
|
|
62
|
+
};
|
|
63
|
+
this.init();
|
|
64
|
+
this.poller = new PollingService({
|
|
65
|
+
pollIntervalMs: this.config.pollIntervalMs,
|
|
66
|
+
baseBackoffMs: this.config.baseBackoffMs,
|
|
67
|
+
maxErrorBackoffMs: this.config.maxErrorBackoffMs,
|
|
68
|
+
processBatch: (handler) => this.processBatch(handler)
|
|
69
|
+
});
|
|
70
|
+
}
|
|
71
|
+
init() {
|
|
72
|
+
this.db.exec(getOutboxSchema(this.config.tableName, this.config.archiveTableName));
|
|
73
|
+
}
|
|
74
|
+
async publish(events, transaction) {
|
|
75
|
+
if (events.length === 0) return;
|
|
76
|
+
const executor = transaction ?? this.config.getTransaction?.() ?? this.db;
|
|
77
|
+
const insert = executor.prepare(`
|
|
78
|
+
INSERT INTO ${this.config.tableName} (id, type, payload, occurred_at, status)
|
|
79
|
+
VALUES (?, ?, ?, ?, '${EventStatus.CREATED}')
|
|
80
|
+
`);
|
|
81
|
+
executor.transaction(() => {
|
|
82
|
+
for (const event of events) insert.run(event.id, event.type, JSON.stringify(event.payload), event.occurredAt.toISOString());
|
|
83
|
+
})();
|
|
84
|
+
}
|
|
85
|
+
async getFailedEvents() {
|
|
86
|
+
return this.db.prepare(`
|
|
87
|
+
SELECT * FROM ${this.config.tableName}
|
|
88
|
+
WHERE status = '${EventStatus.FAILED}'
|
|
89
|
+
ORDER BY occurred_at DESC
|
|
90
|
+
LIMIT 100
|
|
91
|
+
`).all().map((row) => {
|
|
92
|
+
const event = {
|
|
93
|
+
id: row.id,
|
|
94
|
+
type: row.type,
|
|
95
|
+
payload: JSON.parse(row.payload),
|
|
96
|
+
occurredAt: new Date(row.occurred_at),
|
|
97
|
+
retryCount: row.retry_count
|
|
98
|
+
};
|
|
99
|
+
if (row.last_error) event.error = row.last_error;
|
|
100
|
+
if (row.started_on) event.lastAttemptAt = new Date(row.started_on);
|
|
101
|
+
return event;
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
async retryEvents(eventIds) {
|
|
105
|
+
if (eventIds.length === 0) return;
|
|
106
|
+
const placeholders = eventIds.map(() => "?").join(",");
|
|
107
|
+
this.db.prepare(`
|
|
108
|
+
UPDATE ${this.config.tableName}
|
|
109
|
+
SET status = '${EventStatus.CREATED}',
|
|
110
|
+
retry_count = 0,
|
|
111
|
+
next_retry_at = NULL,
|
|
112
|
+
last_error = NULL
|
|
113
|
+
WHERE id IN (${placeholders})
|
|
114
|
+
`).run(...eventIds);
|
|
115
|
+
}
|
|
116
|
+
start(handler, onError) {
|
|
117
|
+
this.poller.start(handler, onError);
|
|
118
|
+
}
|
|
119
|
+
async stop() {
|
|
120
|
+
await this.poller.stop();
|
|
121
|
+
}
|
|
122
|
+
async processBatch(handler) {
|
|
123
|
+
const now = (/* @__PURE__ */ new Date()).toISOString();
|
|
124
|
+
const msNow = Date.now();
|
|
125
|
+
const lockedEvents = this.db.transaction(() => {
|
|
126
|
+
const rows = this.db.prepare(`
|
|
127
|
+
SELECT * FROM ${this.config.tableName}
|
|
128
|
+
WHERE status = '${EventStatus.CREATED}'
|
|
129
|
+
OR (status = '${EventStatus.FAILED}' AND retry_count < ? AND next_retry_at <= ?)
|
|
130
|
+
OR (status = '${EventStatus.ACTIVE}' AND datetime(keep_alive, '+' || expire_in_seconds || ' seconds') < datetime(?))
|
|
131
|
+
LIMIT ?
|
|
132
|
+
`).all(this.config.maxRetries, now, now, this.config.batchSize);
|
|
133
|
+
if (rows.length === 0) return [];
|
|
134
|
+
const ids = rows.map((r) => r.id);
|
|
135
|
+
const placeholders = ids.map(() => "?").join(",");
|
|
136
|
+
this.db.prepare(`
|
|
137
|
+
UPDATE ${this.config.tableName}
|
|
138
|
+
SET status = '${EventStatus.ACTIVE}',
|
|
139
|
+
started_on = ?,
|
|
140
|
+
keep_alive = ?
|
|
141
|
+
WHERE id IN (${placeholders})
|
|
142
|
+
`).run(now, now, ...ids);
|
|
143
|
+
return rows;
|
|
144
|
+
})();
|
|
145
|
+
if (lockedEvents.length === 0) return;
|
|
146
|
+
const busEvents = lockedEvents.map((row) => ({
|
|
147
|
+
id: row.id,
|
|
148
|
+
type: row.type,
|
|
149
|
+
payload: JSON.parse(row.payload),
|
|
150
|
+
occurredAt: new Date(row.occurred_at)
|
|
151
|
+
}));
|
|
152
|
+
const completedEvents = [];
|
|
153
|
+
for (let index = 0; index < busEvents.length; index++) {
|
|
154
|
+
const event = busEvents[index];
|
|
155
|
+
const lockedEvent = lockedEvents[index];
|
|
156
|
+
try {
|
|
157
|
+
await handler(event);
|
|
158
|
+
completedEvents.push({
|
|
159
|
+
event,
|
|
160
|
+
lockedEvent
|
|
161
|
+
});
|
|
162
|
+
} catch (error) {
|
|
163
|
+
const retryCount = lockedEvent.retry_count + 1;
|
|
164
|
+
reportEventError(this.poller.onError, error, event, retryCount, this.config.maxRetries);
|
|
165
|
+
const delay = this.poller.calculateBackoff(retryCount);
|
|
166
|
+
this.db.prepare(`
|
|
167
|
+
UPDATE ${this.config.tableName}
|
|
168
|
+
SET status = '${EventStatus.FAILED}',
|
|
169
|
+
retry_count = ?,
|
|
170
|
+
last_error = ?,
|
|
171
|
+
next_retry_at = ?
|
|
172
|
+
WHERE id = ?
|
|
173
|
+
`).run(retryCount, formatErrorMessage(error), new Date(msNow + delay).toISOString(), lockedEvent.id);
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
if (completedEvents.length > 0) this.db.transaction(() => {
|
|
177
|
+
const insertArchive = this.db.prepare(`
|
|
178
|
+
INSERT INTO ${this.config.archiveTableName} (
|
|
179
|
+
id, type, payload, occurred_at, status, retry_count, last_error, created_on, started_on, completed_on
|
|
180
|
+
) VALUES (?, ?, ?, ?, '${EventStatus.COMPLETED}', ?, ?, ?, ?, ?)
|
|
181
|
+
`);
|
|
182
|
+
const deleteEvent = this.db.prepare(`DELETE FROM ${this.config.tableName} WHERE id = ?`);
|
|
183
|
+
const completionTime = (/* @__PURE__ */ new Date()).toISOString();
|
|
184
|
+
for (const { lockedEvent } of completedEvents) {
|
|
185
|
+
insertArchive.run(lockedEvent.id, lockedEvent.type, lockedEvent.payload, lockedEvent.occurred_at, lockedEvent.retry_count, lockedEvent.last_error, lockedEvent.created_on, now, completionTime);
|
|
186
|
+
deleteEvent.run(lockedEvent.id);
|
|
187
|
+
}
|
|
188
|
+
})();
|
|
189
|
+
}
|
|
190
|
+
};
|
|
191
|
+
|
|
192
|
+
//#endregion
|
|
193
|
+
//#region src/transaction-storage.ts
|
|
194
|
+
const betterSqlite3TransactionStorage = new AsyncLocalStorage();
|
|
195
|
+
async function withBetterSqlite3Transaction(db, fn) {
|
|
196
|
+
return betterSqlite3TransactionStorage.run(db, async () => {
|
|
197
|
+
if (db.inTransaction) {
|
|
198
|
+
const savepointName = `sp_${Date.now()}_${Math.random().toString(36).slice(2)}`;
|
|
199
|
+
db.prepare(`SAVEPOINT ${savepointName}`).run();
|
|
200
|
+
try {
|
|
201
|
+
const result = await fn(db);
|
|
202
|
+
db.prepare(`RELEASE ${savepointName}`).run();
|
|
203
|
+
return result;
|
|
204
|
+
} catch (error) {
|
|
205
|
+
db.prepare(`ROLLBACK TO ${savepointName}`).run();
|
|
206
|
+
db.prepare(`RELEASE ${savepointName}`).run();
|
|
207
|
+
throw error;
|
|
208
|
+
}
|
|
209
|
+
} else {
|
|
210
|
+
db.prepare("BEGIN").run();
|
|
211
|
+
try {
|
|
212
|
+
const result = await fn(db);
|
|
213
|
+
db.prepare("COMMIT").run();
|
|
214
|
+
return result;
|
|
215
|
+
} catch (error) {
|
|
216
|
+
db.prepare("ROLLBACK").run();
|
|
217
|
+
throw error;
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
function getBetterSqlite3Transaction() {
|
|
223
|
+
return () => betterSqlite3TransactionStorage.getStore();
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
//#endregion
|
|
227
|
+
export { SqliteBetterSqlite3Outbox, betterSqlite3TransactionStorage, getBetterSqlite3Transaction, withBetterSqlite3Transaction };
|
|
228
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","names":["event: FailedBusEvent","busEvents: BusEvent[]","completedEvents: { event: BusEvent; lockedEvent: OutboxRow }[]","betterSqlite3TransactionStorage: AsyncLocalStorage<Database>"],"sources":["../src/sqlite-better-sqlite3-outbox.ts","../src/transaction-storage.ts"],"sourcesContent":["import Database from \"better-sqlite3\"\nimport {\n type BusEvent,\n type ErrorHandler,\n EventStatus,\n type FailedBusEvent,\n formatErrorMessage,\n type IOutbox,\n type OutboxConfig,\n PollingService,\n reportEventError,\n} from \"outbox-event-bus\"\n\nconst DEFAULT_EXPIRE_IN_SECONDS = 300\n\nconst getOutboxSchema = (tableName: string, archiveTableName: string) => `\n CREATE TABLE IF NOT EXISTS ${tableName} (\n id TEXT PRIMARY KEY,\n type TEXT NOT NULL,\n payload TEXT NOT NULL,\n occurred_at TEXT NOT NULL,\n status TEXT NOT NULL DEFAULT '${EventStatus.CREATED}',\n retry_count INTEGER NOT NULL DEFAULT 0,\n last_error TEXT,\n next_retry_at TEXT,\n created_on TEXT NOT NULL DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now')),\n started_on TEXT,\n completed_on TEXT,\n keep_alive TEXT,\n expire_in_seconds INTEGER NOT NULL DEFAULT ${DEFAULT_EXPIRE_IN_SECONDS}\n );\n\n CREATE TABLE IF NOT EXISTS ${archiveTableName} (\n id TEXT PRIMARY KEY,\n type TEXT NOT NULL,\n payload TEXT NOT NULL,\n occurred_at TEXT NOT NULL,\n status TEXT NOT NULL,\n retry_count INTEGER NOT NULL,\n last_error TEXT,\n created_on TEXT NOT NULL,\n started_on TEXT,\n completed_on TEXT NOT NULL\n );\n\n CREATE INDEX IF NOT EXISTS idx_${tableName}_status_retry ON ${tableName} (status, next_retry_at);\n`\n\nexport interface SqliteBetterSqlite3OutboxConfig extends OutboxConfig {\n dbPath?: string\n db?: Database.Database\n getTransaction?: (() => Database.Database | undefined) | undefined\n tableName?: string\n archiveTableName?: string\n}\n\ninterface OutboxRow {\n id: string\n type: string\n payload: string\n occurred_at: string\n status: EventStatus\n retry_count: number\n next_retry_at: string | null\n last_error: string | null\n created_on: string\n started_on: string | null\n completed_on: string | null\n keep_alive: string | null\n expire_in_seconds: number\n}\n\nexport class SqliteBetterSqlite3Outbox implements IOutbox<Database.Database> {\n private readonly config: Required<SqliteBetterSqlite3OutboxConfig>\n private readonly db: Database.Database\n private readonly poller: PollingService\n\n constructor(config: SqliteBetterSqlite3OutboxConfig) {\n if (config.db) {\n this.db = config.db\n } else {\n if (!config.dbPath) throw new Error(\"dbPath is required if db is not provided\")\n this.db = new Database(config.dbPath)\n this.db.pragma(\"journal_mode = WAL\")\n }\n\n this.config = {\n batchSize: config.batchSize ?? 50,\n pollIntervalMs: config.pollIntervalMs ?? 1000,\n maxRetries: config.maxRetries ?? 5,\n baseBackoffMs: config.baseBackoffMs ?? 1000,\n processingTimeoutMs: config.processingTimeoutMs ?? 30000,\n maxErrorBackoffMs: config.maxErrorBackoffMs ?? 30000,\n dbPath: config.dbPath ?? \"\",\n db: this.db,\n getTransaction: config.getTransaction,\n tableName: config.tableName ?? \"outbox_events\",\n archiveTableName: config.archiveTableName ?? \"outbox_events_archive\",\n } as Required<SqliteBetterSqlite3OutboxConfig>\n\n this.init()\n\n this.poller = new PollingService({\n pollIntervalMs: this.config.pollIntervalMs,\n baseBackoffMs: this.config.baseBackoffMs,\n maxErrorBackoffMs: this.config.maxErrorBackoffMs,\n processBatch: (handler) => this.processBatch(handler),\n })\n }\n\n private init() {\n this.db.exec(getOutboxSchema(this.config.tableName, this.config.archiveTableName))\n }\n\n async publish(events: BusEvent[], transaction?: Database.Database): Promise<void> {\n if (events.length === 0) return\n\n const executor = transaction ?? this.config.getTransaction?.() ?? this.db\n\n const insert = executor.prepare(`\n INSERT INTO ${this.config.tableName} (id, type, payload, occurred_at, status)\n VALUES (?, ?, ?, ?, '${EventStatus.CREATED}')\n `)\n\n executor.transaction(() => {\n for (const event of events) {\n insert.run(\n event.id,\n event.type,\n JSON.stringify(event.payload),\n event.occurredAt.toISOString()\n )\n }\n })()\n }\n\n async getFailedEvents(): Promise<FailedBusEvent[]> {\n const rows = this.db\n .prepare(`\n SELECT * FROM ${this.config.tableName}\n WHERE status = '${EventStatus.FAILED}'\n ORDER BY occurred_at DESC\n LIMIT 100\n `)\n .all() as OutboxRow[]\n\n return rows.map((row) => {\n const event: FailedBusEvent = {\n id: row.id,\n type: row.type,\n payload: JSON.parse(row.payload),\n occurredAt: new Date(row.occurred_at),\n retryCount: row.retry_count,\n }\n if (row.last_error) event.error = row.last_error\n if (row.started_on) event.lastAttemptAt = new Date(row.started_on)\n return event\n })\n }\n\n async retryEvents(eventIds: string[]): Promise<void> {\n if (eventIds.length === 0) return\n\n const placeholders = eventIds.map(() => \"?\").join(\",\")\n this.db\n .prepare(`\n UPDATE ${this.config.tableName}\n SET status = '${EventStatus.CREATED}',\n retry_count = 0,\n next_retry_at = NULL,\n last_error = NULL\n WHERE id IN (${placeholders})\n `)\n .run(...eventIds)\n }\n\n start(handler: (event: BusEvent) => Promise<void>, onError: ErrorHandler): void {\n this.poller.start(handler, onError)\n }\n\n async stop(): Promise<void> {\n await this.poller.stop()\n }\n\n private async processBatch(handler: (event: BusEvent) => Promise<void>) {\n const now = new Date().toISOString()\n const msNow = Date.now()\n\n const lockedEvents = this.db.transaction(() => {\n // Select events that are ready to process:\n // 1. New events (status = 'created')\n // 2. Failed events that can be retried (retry_count < max AND next_retry_at has passed)\n // 3. Stuck events (status = 'active' but keepAlive + expire_in_seconds < now)\n const rows = this.db\n .prepare(`\n SELECT * FROM ${this.config.tableName}\n WHERE status = '${EventStatus.CREATED}'\n OR (status = '${EventStatus.FAILED}' AND retry_count < ? AND next_retry_at <= ?)\n OR (status = '${EventStatus.ACTIVE}' AND datetime(keep_alive, '+' || expire_in_seconds || ' seconds') < datetime(?))\n LIMIT ?\n `)\n .all(this.config.maxRetries, now, now, this.config.batchSize) as OutboxRow[]\n\n if (rows.length === 0) return []\n\n const ids = rows.map((r) => r.id)\n const placeholders = ids.map(() => \"?\").join(\",\")\n\n this.db\n .prepare(`\n UPDATE ${this.config.tableName}\n SET status = '${EventStatus.ACTIVE}',\n started_on = ?,\n keep_alive = ?\n WHERE id IN (${placeholders})\n `)\n .run(now, now, ...ids)\n\n return rows\n })()\n\n if (lockedEvents.length === 0) return\n\n const busEvents: BusEvent[] = lockedEvents.map((row) => ({\n id: row.id,\n type: row.type,\n payload: JSON.parse(row.payload),\n occurredAt: new Date(row.occurred_at),\n }))\n\n const completedEvents: { event: BusEvent; lockedEvent: OutboxRow }[] = []\n\n for (let index = 0; index < busEvents.length; index++) {\n const event = busEvents[index]!\n const lockedEvent = lockedEvents[index]!\n\n try {\n await handler(event)\n completedEvents.push({ event, lockedEvent })\n } catch (error) {\n const retryCount = lockedEvent.retry_count + 1\n reportEventError(this.poller.onError, error, event, retryCount, this.config.maxRetries)\n\n const delay = this.poller.calculateBackoff(retryCount)\n\n this.db\n .prepare(`\n UPDATE ${this.config.tableName}\n SET status = '${EventStatus.FAILED}',\n retry_count = ?,\n last_error = ?,\n next_retry_at = ?\n WHERE id = ?\n `)\n .run(\n retryCount,\n formatErrorMessage(error),\n new Date(msNow + delay).toISOString(),\n lockedEvent.id\n )\n }\n }\n\n if (completedEvents.length > 0) {\n this.db.transaction(() => {\n const insertArchive = this.db.prepare(`\n INSERT INTO ${this.config.archiveTableName} (\n id, type, payload, occurred_at, status, retry_count, last_error, created_on, started_on, completed_on\n ) VALUES (?, ?, ?, ?, '${EventStatus.COMPLETED}', ?, ?, ?, ?, ?)\n `)\n const deleteEvent = this.db.prepare(`DELETE FROM ${this.config.tableName} WHERE id = ?`)\n\n const completionTime = new Date().toISOString()\n for (const { lockedEvent } of completedEvents) {\n insertArchive.run(\n lockedEvent.id,\n lockedEvent.type,\n lockedEvent.payload,\n lockedEvent.occurred_at,\n lockedEvent.retry_count,\n lockedEvent.last_error,\n lockedEvent.created_on,\n now,\n completionTime\n )\n deleteEvent.run(lockedEvent.id)\n }\n })()\n }\n }\n}\n","import { AsyncLocalStorage } from \"node:async_hooks\"\nimport type { Database } from \"better-sqlite3\"\n\nexport type { Database }\n\nexport const betterSqlite3TransactionStorage: AsyncLocalStorage<Database> =\n new AsyncLocalStorage<Database>()\n\nexport async function withBetterSqlite3Transaction<T>(\n db: Database,\n fn: (tx: Database) => Promise<T>\n): Promise<T> {\n return betterSqlite3TransactionStorage.run(db, async () => {\n if (db.inTransaction) {\n const savepointName = `sp_${Date.now()}_${Math.random().toString(36).slice(2)}`\n db.prepare(`SAVEPOINT ${savepointName}`).run()\n try {\n const result = await fn(db)\n db.prepare(`RELEASE ${savepointName}`).run()\n return result\n } catch (error) {\n db.prepare(`ROLLBACK TO ${savepointName}`).run()\n db.prepare(`RELEASE ${savepointName}`).run()\n throw error\n }\n } else {\n db.prepare(\"BEGIN\").run()\n try {\n const result = await fn(db)\n db.prepare(\"COMMIT\").run()\n return result\n } catch (error) {\n db.prepare(\"ROLLBACK\").run()\n throw error\n }\n }\n })\n}\n\nexport function getBetterSqlite3Transaction(): () => Database | undefined {\n return () => betterSqlite3TransactionStorage.getStore()\n}\n"],"mappings":";;;;;AAaA,MAAM,4BAA4B;AAElC,MAAM,mBAAmB,WAAmB,qBAA6B;+BAC1C,UAAU;;;;;oCAKL,YAAY,QAAQ;;;;;;;;iDAQP,0BAA0B;;;+BAG5C,iBAAiB;;;;;;;;;;;;;mCAab,UAAU,mBAAmB,UAAU;;AA2B1E,IAAa,4BAAb,MAA6E;CAC3E,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CAEjB,YAAY,QAAyC;AACnD,MAAI,OAAO,GACT,MAAK,KAAK,OAAO;OACZ;AACL,OAAI,CAAC,OAAO,OAAQ,OAAM,IAAI,MAAM,2CAA2C;AAC/E,QAAK,KAAK,IAAI,SAAS,OAAO,OAAO;AACrC,QAAK,GAAG,OAAO,qBAAqB;;AAGtC,OAAK,SAAS;GACZ,WAAW,OAAO,aAAa;GAC/B,gBAAgB,OAAO,kBAAkB;GACzC,YAAY,OAAO,cAAc;GACjC,eAAe,OAAO,iBAAiB;GACvC,qBAAqB,OAAO,uBAAuB;GACnD,mBAAmB,OAAO,qBAAqB;GAC/C,QAAQ,OAAO,UAAU;GACzB,IAAI,KAAK;GACT,gBAAgB,OAAO;GACvB,WAAW,OAAO,aAAa;GAC/B,kBAAkB,OAAO,oBAAoB;GAC9C;AAED,OAAK,MAAM;AAEX,OAAK,SAAS,IAAI,eAAe;GAC/B,gBAAgB,KAAK,OAAO;GAC5B,eAAe,KAAK,OAAO;GAC3B,mBAAmB,KAAK,OAAO;GAC/B,eAAe,YAAY,KAAK,aAAa,QAAQ;GACtD,CAAC;;CAGJ,AAAQ,OAAO;AACb,OAAK,GAAG,KAAK,gBAAgB,KAAK,OAAO,WAAW,KAAK,OAAO,iBAAiB,CAAC;;CAGpF,MAAM,QAAQ,QAAoB,aAAgD;AAChF,MAAI,OAAO,WAAW,EAAG;EAEzB,MAAM,WAAW,eAAe,KAAK,OAAO,kBAAkB,IAAI,KAAK;EAEvE,MAAM,SAAS,SAAS,QAAQ;oBAChB,KAAK,OAAO,UAAU;6BACb,YAAY,QAAQ;MAC3C;AAEF,WAAS,kBAAkB;AACzB,QAAK,MAAM,SAAS,OAClB,QAAO,IACL,MAAM,IACN,MAAM,MACN,KAAK,UAAU,MAAM,QAAQ,EAC7B,MAAM,WAAW,aAAa,CAC/B;IAEH,EAAE;;CAGN,MAAM,kBAA6C;AAUjD,SATa,KAAK,GACf,QAAQ;sBACO,KAAK,OAAO,UAAU;wBACpB,YAAY,OAAO;;;MAGrC,CACC,KAAK,CAEI,KAAK,QAAQ;GACvB,MAAMA,QAAwB;IAC5B,IAAI,IAAI;IACR,MAAM,IAAI;IACV,SAAS,KAAK,MAAM,IAAI,QAAQ;IAChC,YAAY,IAAI,KAAK,IAAI,YAAY;IACrC,YAAY,IAAI;IACjB;AACD,OAAI,IAAI,WAAY,OAAM,QAAQ,IAAI;AACtC,OAAI,IAAI,WAAY,OAAM,gBAAgB,IAAI,KAAK,IAAI,WAAW;AAClE,UAAO;IACP;;CAGJ,MAAM,YAAY,UAAmC;AACnD,MAAI,SAAS,WAAW,EAAG;EAE3B,MAAM,eAAe,SAAS,UAAU,IAAI,CAAC,KAAK,IAAI;AACtD,OAAK,GACF,QAAQ;eACA,KAAK,OAAO,UAAU;sBACf,YAAY,QAAQ;;;;qBAIrB,aAAa;MAC5B,CACC,IAAI,GAAG,SAAS;;CAGrB,MAAM,SAA6C,SAA6B;AAC9E,OAAK,OAAO,MAAM,SAAS,QAAQ;;CAGrC,MAAM,OAAsB;AAC1B,QAAM,KAAK,OAAO,MAAM;;CAG1B,MAAc,aAAa,SAA6C;EACtE,MAAM,uBAAM,IAAI,MAAM,EAAC,aAAa;EACpC,MAAM,QAAQ,KAAK,KAAK;EAExB,MAAM,eAAe,KAAK,GAAG,kBAAkB;GAK7C,MAAM,OAAO,KAAK,GACf,QAAQ;wBACO,KAAK,OAAO,UAAU;0BACpB,YAAY,QAAQ;wBACtB,YAAY,OAAO;wBACnB,YAAY,OAAO;;QAEnC,CACC,IAAI,KAAK,OAAO,YAAY,KAAK,KAAK,KAAK,OAAO,UAAU;AAE/D,OAAI,KAAK,WAAW,EAAG,QAAO,EAAE;GAEhC,MAAM,MAAM,KAAK,KAAK,MAAM,EAAE,GAAG;GACjC,MAAM,eAAe,IAAI,UAAU,IAAI,CAAC,KAAK,IAAI;AAEjD,QAAK,GACF,QAAQ;iBACA,KAAK,OAAO,UAAU;wBACf,YAAY,OAAO;;;uBAGpB,aAAa;QAC5B,CACC,IAAI,KAAK,KAAK,GAAG,IAAI;AAExB,UAAO;IACP,EAAE;AAEJ,MAAI,aAAa,WAAW,EAAG;EAE/B,MAAMC,YAAwB,aAAa,KAAK,SAAS;GACvD,IAAI,IAAI;GACR,MAAM,IAAI;GACV,SAAS,KAAK,MAAM,IAAI,QAAQ;GAChC,YAAY,IAAI,KAAK,IAAI,YAAY;GACtC,EAAE;EAEH,MAAMC,kBAAiE,EAAE;AAEzE,OAAK,IAAI,QAAQ,GAAG,QAAQ,UAAU,QAAQ,SAAS;GACrD,MAAM,QAAQ,UAAU;GACxB,MAAM,cAAc,aAAa;AAEjC,OAAI;AACF,UAAM,QAAQ,MAAM;AACpB,oBAAgB,KAAK;KAAE;KAAO;KAAa,CAAC;YACrC,OAAO;IACd,MAAM,aAAa,YAAY,cAAc;AAC7C,qBAAiB,KAAK,OAAO,SAAS,OAAO,OAAO,YAAY,KAAK,OAAO,WAAW;IAEvF,MAAM,QAAQ,KAAK,OAAO,iBAAiB,WAAW;AAEtD,SAAK,GACF,QAAQ;mBACA,KAAK,OAAO,UAAU;0BACf,YAAY,OAAO;;;;;UAKnC,CACC,IACC,YACA,mBAAmB,MAAM,EACzB,IAAI,KAAK,QAAQ,MAAM,CAAC,aAAa,EACrC,YAAY,GACb;;;AAIP,MAAI,gBAAgB,SAAS,EAC3B,MAAK,GAAG,kBAAkB;GACxB,MAAM,gBAAgB,KAAK,GAAG,QAAQ;wBACtB,KAAK,OAAO,iBAAiB;;mCAElB,YAAY,UAAU;UAC/C;GACF,MAAM,cAAc,KAAK,GAAG,QAAQ,eAAe,KAAK,OAAO,UAAU,eAAe;GAExF,MAAM,kCAAiB,IAAI,MAAM,EAAC,aAAa;AAC/C,QAAK,MAAM,EAAE,iBAAiB,iBAAiB;AAC7C,kBAAc,IACZ,YAAY,IACZ,YAAY,MACZ,YAAY,SACZ,YAAY,aACZ,YAAY,aACZ,YAAY,YACZ,YAAY,YACZ,KACA,eACD;AACD,gBAAY,IAAI,YAAY,GAAG;;IAEjC,EAAE;;;;;;AC1RV,MAAaC,kCACX,IAAI,mBAA6B;AAEnC,eAAsB,6BACpB,IACA,IACY;AACZ,QAAO,gCAAgC,IAAI,IAAI,YAAY;AACzD,MAAI,GAAG,eAAe;GACpB,MAAM,gBAAgB,MAAM,KAAK,KAAK,CAAC,GAAG,KAAK,QAAQ,CAAC,SAAS,GAAG,CAAC,MAAM,EAAE;AAC7E,MAAG,QAAQ,aAAa,gBAAgB,CAAC,KAAK;AAC9C,OAAI;IACF,MAAM,SAAS,MAAM,GAAG,GAAG;AAC3B,OAAG,QAAQ,WAAW,gBAAgB,CAAC,KAAK;AAC5C,WAAO;YACA,OAAO;AACd,OAAG,QAAQ,eAAe,gBAAgB,CAAC,KAAK;AAChD,OAAG,QAAQ,WAAW,gBAAgB,CAAC,KAAK;AAC5C,UAAM;;SAEH;AACL,MAAG,QAAQ,QAAQ,CAAC,KAAK;AACzB,OAAI;IACF,MAAM,SAAS,MAAM,GAAG,GAAG;AAC3B,OAAG,QAAQ,SAAS,CAAC,KAAK;AAC1B,WAAO;YACA,OAAO;AACd,OAAG,QAAQ,WAAW,CAAC,KAAK;AAC5B,UAAM;;;GAGV;;AAGJ,SAAgB,8BAA0D;AACxE,cAAa,gCAAgC,UAAU"}
|
package/package.json
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@outbox-event-bus/sqlite-better-sqlite3-outbox",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"private": false,
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "https://github.com/dunika/outbox-event-bus.git",
|
|
9
|
+
"directory": "adapters/sqlite-better-sqlite3"
|
|
10
|
+
},
|
|
11
|
+
"homepage": "https://github.com/dunika/outbox-event-bus/tree/main/adapters/sqlite-better-sqlite3#readme",
|
|
12
|
+
"type": "module",
|
|
13
|
+
"main": "./dist/index.cjs",
|
|
14
|
+
"module": "./dist/index.mjs",
|
|
15
|
+
"types": "./dist/index.d.mts",
|
|
16
|
+
"exports": {
|
|
17
|
+
".": {
|
|
18
|
+
"import": {
|
|
19
|
+
"types": "./dist/index.d.mts",
|
|
20
|
+
"default": "./dist/index.mjs"
|
|
21
|
+
},
|
|
22
|
+
"require": {
|
|
23
|
+
"types": "./dist/index.d.cts",
|
|
24
|
+
"default": "./dist/index.cjs"
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"files": [
|
|
29
|
+
"dist",
|
|
30
|
+
"src",
|
|
31
|
+
"README.md",
|
|
32
|
+
"LICENSE"
|
|
33
|
+
],
|
|
34
|
+
"scripts": {
|
|
35
|
+
"build": "tsdown",
|
|
36
|
+
"test": "vitest run",
|
|
37
|
+
"test:e2e": "vitest run -c vitest.e2e.config.ts"
|
|
38
|
+
},
|
|
39
|
+
"dependencies": {
|
|
40
|
+
"outbox-event-bus": "workspace:*"
|
|
41
|
+
},
|
|
42
|
+
"peerDependencies": {
|
|
43
|
+
"better-sqlite3": "^12.5.0"
|
|
44
|
+
},
|
|
45
|
+
"devDependencies": {
|
|
46
|
+
"@outbox-event-bus/config": "workspace:*",
|
|
47
|
+
"@types/better-sqlite3": "^7.6.13",
|
|
48
|
+
"@types/node": "catalog:",
|
|
49
|
+
"better-sqlite3": "^12.5.0",
|
|
50
|
+
"tsdown": "catalog:",
|
|
51
|
+
"typescript": "catalog:",
|
|
52
|
+
"vitest": "catalog:"
|
|
53
|
+
}
|
|
54
|
+
}
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
import Database from "better-sqlite3"
|
|
2
|
+
import { HandlerError, MaxRetriesExceededError } from "outbox-event-bus"
|
|
3
|
+
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"
|
|
4
|
+
import { OutboxEventBus } from "../../../core/src/bus/outbox-event-bus"
|
|
5
|
+
import { SqliteBetterSqlite3Outbox } from "./sqlite-better-sqlite3-outbox"
|
|
6
|
+
|
|
7
|
+
describe("Error Handling", () => {
|
|
8
|
+
let db: Database.Database
|
|
9
|
+
let outbox: SqliteBetterSqlite3Outbox
|
|
10
|
+
let bus: OutboxEventBus<any>
|
|
11
|
+
|
|
12
|
+
beforeEach(() => {
|
|
13
|
+
db = new Database(":memory:")
|
|
14
|
+
|
|
15
|
+
outbox = new SqliteBetterSqlite3Outbox({
|
|
16
|
+
db,
|
|
17
|
+
pollIntervalMs: 10,
|
|
18
|
+
maxRetries: 3,
|
|
19
|
+
})
|
|
20
|
+
})
|
|
21
|
+
|
|
22
|
+
afterEach(async () => {
|
|
23
|
+
await bus?.stop()
|
|
24
|
+
db.close()
|
|
25
|
+
})
|
|
26
|
+
|
|
27
|
+
it("should call onError with event and retry count when handler fails", async () => {
|
|
28
|
+
const onError = vi.fn()
|
|
29
|
+
bus = new OutboxEventBus(outbox, onError)
|
|
30
|
+
bus.start()
|
|
31
|
+
|
|
32
|
+
const eventType = "test-event"
|
|
33
|
+
const error = new Error("Handler failed")
|
|
34
|
+
|
|
35
|
+
// Register a handler that fails
|
|
36
|
+
bus.on(eventType, async () => {
|
|
37
|
+
throw error
|
|
38
|
+
})
|
|
39
|
+
|
|
40
|
+
await bus.emit({
|
|
41
|
+
type: eventType,
|
|
42
|
+
payload: { data: "test" },
|
|
43
|
+
})
|
|
44
|
+
|
|
45
|
+
await new Promise((resolve) => setTimeout(resolve, 100))
|
|
46
|
+
|
|
47
|
+
expect(onError).toHaveBeenCalled()
|
|
48
|
+
const call = onError.mock.calls[0]
|
|
49
|
+
expect(call).toBeDefined()
|
|
50
|
+
if (call) {
|
|
51
|
+
const calledError = call[0]
|
|
52
|
+
|
|
53
|
+
// Verify it's a HandlerError instance
|
|
54
|
+
expect(calledError).toBeInstanceOf(HandlerError)
|
|
55
|
+
expect(calledError.name).toBe("HandlerError")
|
|
56
|
+
expect(calledError.message).toContain("Handler failed")
|
|
57
|
+
|
|
58
|
+
// Verify cause is preserved
|
|
59
|
+
expect((calledError as HandlerError).cause).toEqual(error)
|
|
60
|
+
|
|
61
|
+
// Verify event is bundled in error.context.event
|
|
62
|
+
const calledEvent = (calledError as HandlerError).context?.event as any
|
|
63
|
+
expect(calledEvent).toBeDefined()
|
|
64
|
+
expect(calledEvent.type).toBe(eventType)
|
|
65
|
+
expect(calledEvent.id).toBeDefined()
|
|
66
|
+
}
|
|
67
|
+
})
|
|
68
|
+
|
|
69
|
+
it("should increment retry count on subsequent failures", async () => {
|
|
70
|
+
const onError = vi.fn()
|
|
71
|
+
bus = new OutboxEventBus(outbox, onError)
|
|
72
|
+
bus.start()
|
|
73
|
+
|
|
74
|
+
const eventType = "test-event-retry"
|
|
75
|
+
|
|
76
|
+
bus.on(eventType, async () => {
|
|
77
|
+
throw new Error("Fail again")
|
|
78
|
+
})
|
|
79
|
+
|
|
80
|
+
await bus.emit({
|
|
81
|
+
type: eventType,
|
|
82
|
+
payload: { data: "test" },
|
|
83
|
+
})
|
|
84
|
+
console.log("Events after emit:", db.prepare("SELECT * FROM outbox_events").all())
|
|
85
|
+
|
|
86
|
+
await new Promise((resolve) => setTimeout(resolve, 100))
|
|
87
|
+
|
|
88
|
+
expect(onError).toHaveBeenCalledTimes(1)
|
|
89
|
+
|
|
90
|
+
// Manually reset next_retry_at so it picks it up immediately (simulating time passing)
|
|
91
|
+
db.prepare("UPDATE outbox_events SET next_retry_at = '1970-01-01'").run()
|
|
92
|
+
console.log("Events after update:", db.prepare("SELECT * FROM outbox_events").all())
|
|
93
|
+
console.log("Archive after update:", db.prepare("SELECT * FROM outbox_events_archive").all())
|
|
94
|
+
|
|
95
|
+
await new Promise((resolve) => setTimeout(resolve, 100))
|
|
96
|
+
|
|
97
|
+
expect(onError).toHaveBeenCalledTimes(2)
|
|
98
|
+
const secondCall = onError.mock.calls[1]
|
|
99
|
+
if (secondCall) {
|
|
100
|
+
const secondCallEvent = (secondCall[0] as any).context?.event
|
|
101
|
+
expect(secondCallEvent).toBeDefined()
|
|
102
|
+
expect(secondCallEvent.type).toBe(eventType)
|
|
103
|
+
}
|
|
104
|
+
})
|
|
105
|
+
|
|
106
|
+
it("should call onError with MaxRetriesExceededError when max retries is reached", async () => {
|
|
107
|
+
const onError = vi.fn()
|
|
108
|
+
// Set maxRetries to 1 for quick test
|
|
109
|
+
outbox = new SqliteBetterSqlite3Outbox({
|
|
110
|
+
db,
|
|
111
|
+
pollIntervalMs: 10,
|
|
112
|
+
maxRetries: 0,
|
|
113
|
+
})
|
|
114
|
+
bus = new OutboxEventBus(outbox, onError)
|
|
115
|
+
bus.start()
|
|
116
|
+
|
|
117
|
+
const eventType = "test-event-max-retries"
|
|
118
|
+
bus.on(eventType, async () => {
|
|
119
|
+
throw new Error("Fatal")
|
|
120
|
+
})
|
|
121
|
+
|
|
122
|
+
await bus.emit({
|
|
123
|
+
type: eventType,
|
|
124
|
+
payload: { data: "test" },
|
|
125
|
+
})
|
|
126
|
+
|
|
127
|
+
await new Promise((resolve) => setTimeout(resolve, 100))
|
|
128
|
+
|
|
129
|
+
expect(onError).toHaveBeenCalled()
|
|
130
|
+
const error = onError.mock.calls[0]?.[0]
|
|
131
|
+
|
|
132
|
+
// Verify it's a MaxRetriesExceededError instance
|
|
133
|
+
expect(error).toBeInstanceOf(MaxRetriesExceededError)
|
|
134
|
+
expect(error.name).toBe("MaxRetriesExceededError")
|
|
135
|
+
expect(error.message).toContain("exceeded")
|
|
136
|
+
|
|
137
|
+
// Verify retryCount property (maxRetries is 0, so this should be 1)
|
|
138
|
+
expect((error as MaxRetriesExceededError).retryCount).toBe(1)
|
|
139
|
+
|
|
140
|
+
// Verify event is bundled in error.context.event
|
|
141
|
+
const event = (error as MaxRetriesExceededError).context?.event
|
|
142
|
+
expect(event).toBeDefined()
|
|
143
|
+
expect(event?.type).toBe(eventType)
|
|
144
|
+
})
|
|
145
|
+
})
|
package/src/index.ts
ADDED