valkyr/event-store
1
0
Fork 0
Code Issues Actions Wiki Activity

feat: add transaction support to postgres provider

Browse Source
This commit is contained in:
kodemon
2025-10-05 21:51:04 +00:00
parent d55573b2db
commit 737d22ecf5
6 changed files with 97 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
adapters/postgres/database.ts
View File

@@ -1,4 +1,4 @@
import postgres, { type Sql } from "postgres";
import postgres, { type Sql, TransactionSql } from "postgres";
import { PostgresConnection } from "./connection.ts";
@@ -34,3 +34,7 @@ export class PostgresDatabase {
export type DatabaseAccessor = {
sql: Sql;
};
export type Options = {
tx?: TransactionSql;
};

32
adapters/postgres/providers/event.ts
View File

@@ -3,7 +3,7 @@ import type { Helper } from "postgres";
import type { EventRecord } from "../../../libraries/event.ts";
import type { EventsProvider } from "../../../types/adapter.ts";
import type { EventReadOptions } from "../../../types/query.ts";
import type { PostgresDatabase } from "../database.ts";
import type { Options, PostgresDatabase } from "../database.ts";
type PGEventRecord = Omit<EventRecord, "data" | "meta"> & { data: string; meta: string };
@@ -25,8 +25,8 @@ export class PostgresEventsProvider implements EventsProvider {
*
* @param record - Event record to insert.
*/
async insert(record: EventRecord): Promise<void> {
await this.db.sql`INSERT INTO ${this.table} ${this.db.sql(this.#toDriver(record))}`.catch((error) => {
async insert(record: EventRecord, { tx }: Options = {}): Promise<void> {
await (tx ?? this.db.sql)`INSERT INTO ${this.table} ${this.db.sql(this.#toDriver(record))}`.catch((error) => {
throw new Error(`EventStore > 'events.insert' failed with postgres error: ${error.message}`);
});
}
@@ -37,7 +37,12 @@ export class PostgresEventsProvider implements EventsProvider {
* @param records - Event records to insert.
* @param batchSize - Batch size for the insert loop.
*/
async insertMany(records: EventRecord[], batchSize: number = 1_000): Promise<void> {
async insertMany(records: EventRecord[], batchSize: number = 1_000, { tx }: Options = {}): Promise<void> {
if (tx !== undefined) {
for (let i = 0; i < records.length; i += batchSize) {
await tx`INSERT INTO ${this.table} ${this.db.sql(records.slice(i, i + batchSize).map(this.#toDriver))}`;
}
} else {
await this.db.sql
.begin(async (sql) => {
for (let i = 0; i < records.length; i += batchSize) {
@@ -48,6 +53,7 @@ export class PostgresEventsProvider implements EventsProvider {
throw new Error(`EventStore > 'events.insertMany' failed with postgres error: ${error.message}`);
});
}
}
/**
* Retrieve all the events in the events table. Optionally a cursor and direction
@@ -55,10 +61,10 @@ export class PostgresEventsProvider implements EventsProvider {
*
* @param options - Find options.
*/
async get(options: EventReadOptions): Promise<EventRecord[]> {
async get(options: EventReadOptions, { tx }: Options = {}): Promise<EventRecord[]> {
if (options !== undefined) {
const { filter, cursor, direction, limit } = options;
return this.db.sql<PGEventRecord[]>`
return (tx ?? this.db.sql)<PGEventRecord[]>`
SELECT * FROM ${this.table}
WHERE
${filter?.types ? this.#withTypes(filter.types) : this.db.sql``}
@@ -79,8 +85,9 @@ export class PostgresEventsProvider implements EventsProvider {
async getByStream(
stream: string,
{ filter, cursor, direction, limit }: EventReadOptions = {},
{ tx }: Options = {},
): Promise<EventRecord[]> {
return this.db.sql<PGEventRecord[]>`
return (tx ?? this.db.sql)<PGEventRecord[]>`
SELECT * FROM ${this.table}
WHERE
stream = ${stream}
@@ -100,8 +107,9 @@ export class PostgresEventsProvider implements EventsProvider {
async getByStreams(
streams: string[],
{ filter, cursor, direction, limit }: EventReadOptions = {},
{ tx }: Options = {},
): Promise<EventRecord[]> {
return this.db.sql<PGEventRecord[]>`
return (tx ?? this.db.sql)<PGEventRecord[]>`
SELECT * FROM ${this.table}
WHERE
stream IN ${this.db.sql(streams)}
@@ -117,8 +125,8 @@ export class PostgresEventsProvider implements EventsProvider {
*
* @param id - Event id.
*/
async getById(id: string): Promise<EventRecord | undefined> {
return this.db.sql<PGEventRecord[]>`SELECT * FROM ${this.table} WHERE id = ${id}`
async getById(id: string, { tx }: Options = {}): Promise<EventRecord | undefined> {
return (tx ?? this.db.sql)<PGEventRecord[]>`SELECT * FROM ${this.table} WHERE id = ${id}`
.then(this.#fromDriver)
.then(([record]) => record);
}
@@ -126,8 +134,8 @@ export class PostgresEventsProvider implements EventsProvider {
/**
* Check if the given event is outdated in relation to the local event data.
*/
async checkOutdated({ stream, type, created }: EventRecord): Promise<boolean> {
const count = await await this.db.sql`
async checkOutdated({ stream, type, created }: EventRecord, { tx }: Options = {}): Promise<boolean> {
const count = await (tx ?? this.db.sql)`
SELECT COUNT(*) AS count
FROM ${this.table}
WHERE

47
adapters/postgres/providers/relations.ts
View File

@@ -1,7 +1,7 @@
import type { Helper } from "postgres";
import type { Relation, RelationPayload, RelationsProvider } from "../../../types/adapter.ts";
import type { PostgresDatabase } from "../database.ts";
import type { Options, PostgresDatabase } from "../database.ts";
export class PostgresRelationsProvider implements RelationsProvider {
constructor(
@@ -34,8 +34,9 @@ export class PostgresRelationsProvider implements RelationsProvider {
* @param key - Relational key to add stream to.
* @param stream - Stream to add to the key.
*/
async insert(key: string, stream: string): Promise<void> {
await this.db.sql`INSERT INTO ${this.table} (key, stream) VALUES (${key}, ${stream}) ON CONFLICT DO NOTHING`.catch(
async insert(key: string, stream: string, { tx }: Options = {}): Promise<void> {
await (tx ??
this.db.sql)`INSERT INTO ${this.table} (key, stream) VALUES (${key}, ${stream}) ON CONFLICT DO NOTHING`.catch(
(error) => {
throw new Error(`EventStore > 'relations.insert' failed with postgres error: ${error.message}`);
},
@@ -48,7 +49,13 @@ export class PostgresRelationsProvider implements RelationsProvider {
* @param relations - Relations to insert.
* @param batchSize - Batch size for the insert loop.
*/
async insertMany(relations: RelationPayload[], batchSize: number = 1_000): Promise<void> {
async insertMany(relations: RelationPayload[], batchSize: number = 1_000, { tx }: Options = {}): Promise<void> {
if (tx !== undefined) {
for (let i = 0; i < relations.length; i += batchSize) {
const values = relations.slice(i, i + batchSize).map(({ key, stream }) => [key, stream]);
await tx`INSERT INTO ${this.table} (key, stream) VALUES ${this.db.sql(values)} ON CONFLICT DO NOTHING`;
}
} else {
await this.db.sql
.begin(async (sql) => {
for (let i = 0; i < relations.length; i += batchSize) {
@@ -60,14 +67,15 @@ export class PostgresRelationsProvider implements RelationsProvider {
throw new Error(`EventStore > 'relations.insertMany' failed with postgres error: ${error.message}`);
});
}
}
/**
* Get a list of event streams registered under the given relational key.
*
* @param key - Relational key to get event streams for.
*/
async getByKey(key: string): Promise<string[]> {
return this.db.sql`SELECT stream FROM ${this.table} WHERE key = ${key}`
async getByKey(key: string, { tx }: Options = {}): Promise<string[]> {
return (tx ?? this.db.sql)`SELECT stream FROM ${this.table} WHERE key = ${key}`
.then((rows) => rows.map(({ stream }) => stream))
.catch((error) => {
throw new Error(`EventStore > 'relations.getByKey' failed with postgres error: ${error.message}`);
@@ -79,8 +87,8 @@ export class PostgresRelationsProvider implements RelationsProvider {
*
* @param keys - Relational keys to get event streams for.
*/
async getByKeys(keys: string[]): Promise<string[]> {
return this.db.sql`SELECT DISTINCT stream FROM ${this.table} WHERE key IN ${this.db.sql(keys)}`
async getByKeys(keys: string[], { tx }: Options = {}): Promise<string[]> {
return (tx ?? this.db.sql)`SELECT DISTINCT stream FROM ${this.table} WHERE key IN ${this.db.sql(keys)}`
.then((rows) => rows.map(({ stream }) => stream))
.catch((error) => {
throw new Error(`EventStore > 'relations.getByKeys' failed with postgres error: ${error.message}`);
@@ -93,8 +101,8 @@ export class PostgresRelationsProvider implements RelationsProvider {
* @param key - Relational key to remove stream from.
* @param stream - Stream to remove from relation.
*/
async remove(key: string, stream: string): Promise<void> {
await this.db.sql`DELETE FROM ${this.table} WHERE key = ${key} AND stream = ${stream}`.catch((error) => {
async remove(key: string, stream: string, { tx }: Options = {}): Promise<void> {
await (tx ?? this.db.sql)`DELETE FROM ${this.table} WHERE key = ${key} AND stream = ${stream}`.catch((error) => {
throw new Error(`EventStore > 'relations.remove' failed with postgres error: ${error.message}`);
});
}
@@ -105,7 +113,15 @@ export class PostgresRelationsProvider implements RelationsProvider {
* @param relations - Relations to remove stream from.
* @param batchSize - Batch size for the insert loop.
*/
async removeMany(relations: RelationPayload[], batchSize: number = 1_000): Promise<void> {
async removeMany(relations: RelationPayload[], batchSize: number = 1_000, { tx }: Options = {}): Promise<void> {
if (tx !== undefined) {
for (let i = 0; i < relations.length; i += batchSize) {
const conditions = relations
.slice(i, i + batchSize)
.map(({ key, stream }) => `(key = '${key}' AND stream = '${stream}')`);
await tx`DELETE FROM ${this.table} WHERE ${this.db.sql.unsafe(conditions.join(" OR "))}`;
}
} else {
await this.db.sql
.begin(async (sql) => {
for (let i = 0; i < relations.length; i += batchSize) {
@@ -119,14 +135,15 @@ export class PostgresRelationsProvider implements RelationsProvider {
throw new Error(`EventStore > 'relations.removeMany' failed with postgres error: ${error.message}`);
});
}
}
/**
* Remove all relations bound to the given relational keys.
*
* @param keys - Relational keys to remove from the relational table.
*/
async removeByKeys(keys: string[]): Promise<void> {
await this.db.sql`DELETE FROM ${this.table} WHERE key IN ${this.db.sql(keys)}`.catch((error) => {
async removeByKeys(keys: string[], { tx }: Options = {}): Promise<void> {
await (tx ?? this.db.sql)`DELETE FROM ${this.table} WHERE key IN ${this.db.sql(keys)}`.catch((error) => {
throw new Error(`EventStore > 'relations.removeByKeys' failed with postgres error: ${error.message}`);
});
}
@@ -136,8 +153,8 @@ export class PostgresRelationsProvider implements RelationsProvider {
*
* @param streams - Streams to remove from the relational table.
*/
async removeByStreams(streams: string[]): Promise<void> {
await this.db.sql`DELETE FROM ${this.table} WHERE stream IN ${this.db.sql(streams)}`.catch((error) => {
async removeByStreams(streams: string[], { tx }: Options = {}): Promise<void> {
await (tx ?? this.db.sql)`DELETE FROM ${this.table} WHERE stream IN ${this.db.sql(streams)}`.catch((error) => {
throw new Error(`EventStore > 'relations.removeByStreams' failed with postgres error: ${error.message}`);
});
}

14
adapters/postgres/providers/snapshot.ts
View File

@@ -1,7 +1,7 @@
import type { Helper } from "postgres";
import type { Snapshot, SnapshotsProvider } from "../../../types/adapter.ts";
import type { PostgresDatabase } from "../database.ts";
import type { Options, PostgresDatabase } from "../database.ts";
type PGSnapshot = Omit<Snapshot, "state"> & { state: string };
@@ -26,8 +26,8 @@ export class PostgresSnapshotsProvider implements SnapshotsProvider {
* @param cursor - Cursor timestamp for the last event used in the snapshot.
* @param state - State of the reduced events.
*/
async insert(name: string, stream: string, cursor: string, state: any): Promise<void> {
await this.db.sql`
async insert(name: string, stream: string, cursor: string, state: any, { tx }: Options = {}): Promise<void> {
await (tx ?? this.db.sql)`
INSERT INTO ${this.table} ${this.db.sql(this.#toDriver({ name, stream, cursor, state }))}`.catch((error) => {
throw new Error(`EventStore > 'snapshots.insert' failed with postgres error: ${error.message}`);
});
@@ -39,8 +39,8 @@ export class PostgresSnapshotsProvider implements SnapshotsProvider {
* @param name - Name of the reducer which the state was created.
* @param stream - Stream the state was reduced for.
*/
async getByStream(name: string, stream: string): Promise<Snapshot | undefined> {
return this.db.sql<PGSnapshot[]>`SELECT * FROM ${this.table} WHERE name = ${name} AND stream = ${stream}`
async getByStream(name: string, stream: string, { tx }: Options = {}): Promise<Snapshot | undefined> {
return (tx ?? this.db.sql)<PGSnapshot[]>`SELECT * FROM ${this.table} WHERE name = ${name} AND stream = ${stream}`
.then(this.#fromDriver)
.then(([snapshot]) => snapshot)
.catch((error) => {
@@ -54,8 +54,8 @@ export class PostgresSnapshotsProvider implements SnapshotsProvider {
* @param name - Name of the reducer the snapshot is attached to.
* @param stream - Stream to remove from snapshots.
*/
async remove(name: string, stream: string): Promise<void> {
await this.db.sql`DELETE FROM ${this.table} WHERE name = ${name} AND stream = ${stream}`.catch((error) => {
async remove(name: string, stream: string, { tx }: Options = {}): Promise<void> {
await (tx ?? this.db.sql)`DELETE FROM ${this.table} WHERE name = ${name} AND stream = ${stream}`.catch((error) => {
throw new Error(`EventStore > 'snapshots.remove' failed with postgres error: ${error.message}`);
});
}

2
deno.json
View File

@@ -1,6 +1,6 @@
{
"name": "@valkyr/event-store",
"version": "2.0.1",
"version": "2.0.2",
"exports": {
".": "./mod.ts",
"./browser": "./adapters/browser/adapter.ts",

2
libraries/event-store.ts
View File

@@ -559,7 +559,7 @@ type EventStoreConfig<TEventFactory extends EventFactory, TEventStoreAdapter ext
hooks?: EventStoreHooks<TEventFactory>;
};
export type EventsInsertSettings = {
export interface EventsInsertSettings {
/**
* Should the event store emit events after successfull insertion.
* This only takes false as value and by default events are always