@ocoda/event-sourcing-mariadb 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @ocoda/event-sourcing-mariadb
 
+## 1.0.2
+
+### Patch Changes
+
+- [#361](https://github.com/ocoda/event-sourcing/pull/361) [`5be1d42`](https://github.com/ocoda/event-sourcing/commit/5be1d42d1eb0a19a252d2127b72a756b3cd701f6) Thanks [@renovate](https://github.com/apps/renovate)! - Dependency updates
+
+- Updated dependencies [[`5be1d42`](https://github.com/ocoda/event-sourcing/commit/5be1d42d1eb0a19a252d2127b72a756b3cd701f6)]:
+  - @ocoda/event-sourcing@1.0.2
+
+## 1.0.1
+
+### Patch Changes
+
+- [#362](https://github.com/ocoda/event-sourcing/pull/362) [`8081e16`](https://github.com/ocoda/event-sourcing/commit/8081e16d3edcab21efa301a7e1261cfd062ab4e7) Thanks [@drieshooghe](https://github.com/drieshooghe)! - Introduce ULID based event-ids and make sure these are persisted/retrieved correctly within the integrations
+
+- [#362](https://github.com/ocoda/event-sourcing/pull/362) [`94e41eb`](https://github.com/ocoda/event-sourcing/commit/94e41ebea9a5d3762d39db0a3afb664bc0d78010) Thanks [@drieshooghe](https://github.com/drieshooghe)! - Adds a `listCollections` method to all integrations
+
+- Updated dependencies [[`8081e16`](https://github.com/ocoda/event-sourcing/commit/8081e16d3edcab21efa301a7e1261cfd062ab4e7), [`94e41eb`](https://github.com/ocoda/event-sourcing/commit/94e41ebea9a5d3762d39db0a3afb664bc0d78010)]:
+  - @ocoda/event-sourcing@1.0.1
+
 ## 1.0.0
 
 ### Major Changes

package/README.md

@@ -0,0 +1,36 @@
+<p align="center">
+  <a href="http://ocoda.io/" target="blank"><img src="https://github.com/ocoda/.github/raw/master/assets/ocoda_logo_full_gradient.svg" width="600" alt="Ocoda Logo" /></a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/ocoda/event-sourcing/actions/workflows/ci-libraries.yml">
+    <img src="https://github.com/ocoda/event-sourcing/actions/workflows/ci-libraries.yml/badge.svg">
+  </a>
+  <a href="https://codecov.io/gh/ocoda/event-sourcing">
+    <img src="https://codecov.io/gh/ocoda/event-sourcing/branch/master/graph/badge.svg?token=D6BRXUY0J8">
+  </a>
+  <a href="https://github.com/ocoda/event-sourcing/blob/master/LICENSE.md">
+    <img src="https://img.shields.io/badge/License-MIT-green.svg">
+  </a>
+</p>
+<p align="center">
+    <a href="https://github.com/ocoda/event-sourcing/issues/new?labels=bug&template=bug_report.md">Report a bug</a>
+    &nbsp;|&nbsp;
+    <a href="https://github.com/ocoda/event-sourcing/issues/new?labels=enhancement&template=feature_request.md">Request a feature</a>
+</p>
+
+## About this library
+
+This is a complementing module for `@ocoda/event-sourcing`, a powerful library designed to simplify the implementation of advanced architectural patterns in your [**NestJS**](https://nestjs.com/) application. It provides essential building blocks to help you implement Domain-Driven Design (DDD), CQRS and leverage Event Sourcing to tackle the complexities of modern systems.
+
+This store-driver library uses [MariaDB](https://mariadb.com/) as an underlying driver for event- and snapshot-stores, and needs to be installed together with the core module `@ocoda/event-sourcing` in order to get started.
+
+## Documentation 📗
+Ready to dive right in? Visit [the documentation](https://ocoda.github.io/event-sourcing) to find out how to get started.
+
+## Contact
+dries@drieshooghe.com
+&nbsp;
+
+## Acknowledgments
+This library is inspired by [@nestjs/cqrs](https://github.com/nestjs/cqrs)

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { IEventPayload, IEvent, EventStore, IEventPool, IEventCollection, EventStream, IEventFilter, EventEnvelope, EventStoreConfig, AggregateRoot, ISnapshot, SnapshotStore, ISnapshotPool, ISnapshotCollection, SnapshotStream, ISnapshotFilter, SnapshotEnvelope, ILatestSnapshotFilter, SnapshotStoreConfig } from '@ocoda/event-sourcing';
+import { IEventPayload, IEvent, EventStore, IEventPool, IEventCollection, IEventCollectionFilter, EventStream, IEventFilter, EventEnvelope, EventStoreConfig, AggregateRoot, ISnapshot, SnapshotStore, ISnapshotPool, ISnapshotCollection, ISnapshotCollectionFilter, SnapshotStream, ISnapshotFilter, SnapshotEnvelope, ILatestSnapshotFilter, SnapshotStoreConfig } from '@ocoda/event-sourcing';
 import { Type } from '@nestjs/common';
 import { PoolConfig } from 'mariadb';
 
@@ -19,9 +19,10 @@ declare class MariaDBEventStore extends EventStore<MariaDBEventStoreConfig> {
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     ensureCollection(pool?: IEventPool): Promise<IEventCollection>;
+    listCollections(filter?: IEventCollectionFilter): AsyncGenerator<IEventCollection[]>;
     getEvents({ streamId }: EventStream, filter?: IEventFilter): AsyncGenerator<IEvent[]>;
     getEvent({ streamId }: EventStream, version: number, pool?: IEventPool): Promise<IEvent>;
-    appendEvents(stream: EventStream, aggregateVersion: number, events: IEvent[], pool?: IEventPool): Promise<EventEnvelope[]>;
+    appendEvents(stream: EventStream, aggregateVersion: number, events: IEvent[] | EventEnvelope[], pool?: IEventPool): Promise<EventEnvelope[]>;
     getEnvelopes({ streamId }: EventStream, filter?: IEventFilter): AsyncGenerator<EventEnvelope[]>;
     getEnvelope({ streamId }: EventStream, version: number, pool?: IEventPool): Promise<EventEnvelope>;
 }
@@ -46,7 +47,7 @@ declare class MariaDBSnapshotStore extends SnapshotStore<MariaDBSnapshotStoreCon
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     ensureCollection(pool?: ISnapshotPool): Promise<ISnapshotCollection>;
-    stop(): Promise<void>;
+    listCollections(filter?: ISnapshotCollectionFilter): AsyncGenerator<ISnapshotCollection[]>;
     getSnapshots<A extends AggregateRoot>({ streamId }: SnapshotStream, filter?: ISnapshotFilter): AsyncGenerator<ISnapshot<A>[]>;
     getSnapshot<A extends AggregateRoot>({ streamId }: SnapshotStream, version: number, pool?: ISnapshotPool): Promise<ISnapshot<A>>;
     appendSnapshot<A extends AggregateRoot>(stream: SnapshotStream, aggregateVersion: number, snapshot: ISnapshot<A>, pool?: ISnapshotPool): Promise<SnapshotEnvelope<A>>;

package/dist/index.js

@@ -98,7 +98,8 @@ var _MariaDBEventStore = class _MariaDBEventStore extends import_event_sourcing.
                     occurred_on TIMESTAMP NOT NULL,
                     correlation_id VARCHAR(255),
                     causation_id VARCHAR(255),
-                    PRIMARY KEY (stream_id, version)
+                    PRIMARY KEY (stream_id, version),
+					INDEX idx_event_id (event_id)
                 )`);
         return collection;
       } catch (error) {
@@ -106,6 +107,44 @@ var _MariaDBEventStore = class _MariaDBEventStore extends import_event_sourcing.
       }
     });
   }
+  listCollections(filter) {
+    return __asyncGenerator(this, null, function* () {
+      const connection = this.pool.getConnection();
+      const batch = (filter == null ? void 0 : filter.batch) || import_event_sourcing.DEFAULT_BATCH_SIZE;
+      const query = "SELECT TABLE_NAME FROM information_schema.tables WHERE BINARY table_name LIKE '%events'";
+      const client = yield new __await(connection);
+      const stream = client.queryStream(query);
+      try {
+        let batchedCollections = [];
+        try {
+          for (var iter = __forAwait(stream), more, temp, error; more = !(temp = yield new __await(iter.next())).done; more = false) {
+            const { TABLE_NAME } = temp.value;
+            batchedCollections.push(TABLE_NAME);
+            if (batchedCollections.length === batch) {
+              yield batchedCollections;
+              batchedCollections = [];
+            }
+          }
+        } catch (temp) {
+          error = [temp];
+        } finally {
+          try {
+            more && (temp = iter.return) && (yield new __await(temp.call(iter)));
+          } finally {
+            if (error)
+              throw error[0];
+          }
+        }
+        if (batchedCollections.length > 0) {
+          yield batchedCollections;
+        }
+      } catch (e) {
+        stream.destroy();
+      } finally {
+        yield new __await(client.release());
+      }
+    });
+  }
   getEvents(_0, _1) {
     return __asyncGenerator(this, arguments, function* ({ streamId }, filter) {
       const connection = this.pool.getConnection();
@@ -190,11 +229,17 @@ var _MariaDBEventStore = class _MariaDBEventStore extends import_event_sourcing.
         }
         let version = aggregateVersion - events.length + 1;
         const envelopes = [];
+        const eventIdFactory = import_event_sourcing.EventId.factory();
         for (const event of events) {
+          if (event instanceof import_event_sourcing.EventEnvelope) {
+            envelopes.push(event);
+            continue;
+          }
           const name = this.eventMap.getName(event);
           const payload = this.eventMap.serializeEvent(event);
           const envelope = import_event_sourcing.EventEnvelope.create(name, payload, {
             aggregateId: stream.aggregateId,
+            eventId: eventIdFactory(),
             version: version++
           });
           envelopes.push(envelope);
@@ -207,7 +252,7 @@ var _MariaDBEventStore = class _MariaDBEventStore extends import_event_sourcing.
             metadata.version,
             event,
             JSON.stringify(payload),
-            metadata.eventId,
+            metadata.eventId.value,
             metadata.aggregateId,
             metadata.occurredOn,
             (_a = metadata.correlationId) != null ? _a : null,
@@ -261,7 +306,7 @@ var _MariaDBEventStore = class _MariaDBEventStore extends import_event_sourcing.
           for (var iter = __forAwait(stream), more, temp, error; more = !(temp = yield new __await(iter.next())).done; more = false) {
             const { event, payload, event_id, aggregate_id, version, occurred_on, correlation_id, causation_id } = temp.value;
             batchedEvents.push(import_event_sourcing.EventEnvelope.from(event, payload, {
-              eventId: event_id,
+              eventId: import_event_sourcing.EventId.from(event_id),
               aggregateId: aggregate_id,
               version,
               occurredOn: occurred_on,
@@ -304,7 +349,7 @@ var _MariaDBEventStore = class _MariaDBEventStore extends import_event_sourcing.
         throw new import_event_sourcing.EventNotFoundException(streamId, version);
       }
       return import_event_sourcing.EventEnvelope.from(entity.event, entity.payload, {
-        eventId: entity.event_id,
+        eventId: import_event_sourcing.EventId.from(entity.event_id),
         aggregateId: entity.aggregate_id,
         version: entity.version,
         occurredOn: entity.occurred_on,
@@ -359,10 +404,42 @@ var _MariaDBSnapshotStore = class _MariaDBSnapshotStore extends import_event_sou
       }
     });
   }
-  stop() {
-    return __async(this, null, function* () {
-      this.logger.log("Stopping store");
-      yield this.pool.end();
+  listCollections(filter) {
+    return __asyncGenerator(this, null, function* () {
+      const connection = this.pool.getConnection();
+      const batch = (filter == null ? void 0 : filter.batch) || import_event_sourcing2.DEFAULT_BATCH_SIZE;
+      const query = "SELECT TABLE_NAME FROM information_schema.tables WHERE BINARY table_name LIKE '%snapshots'";
+      const client = yield new __await(connection);
+      const stream = client.queryStream(query);
+      try {
+        let batchedCollections = [];
+        try {
+          for (var iter = __forAwait(stream), more, temp, error; more = !(temp = yield new __await(iter.next())).done; more = false) {
+            const { TABLE_NAME } = temp.value;
+            batchedCollections.push(TABLE_NAME);
+            if (batchedCollections.length === batch) {
+              yield batchedCollections;
+              batchedCollections = [];
+            }
+          }
+        } catch (temp) {
+          error = [temp];
+        } finally {
+          try {
+            more && (temp = iter.return) && (yield new __await(temp.call(iter)));
+          } finally {
+            if (error)
+              throw error[0];
+          }
+        }
+        if (batchedCollections.length > 0) {
+          yield batchedCollections;
+        }
+      } catch (e) {
+        stream.destroy();
+      } finally {
+        yield new __await(client.release());
+      }
     });
   }
   getSnapshots(_0, _1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocoda/event-sourcing-mariadb",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "NestJS Event Sourcing Library (@mariadb)",
   "author": "Dries Hooghe <dries@drieshooghe.com>",
   "license": "MIT",
@@ -10,35 +10,35 @@
     "url": "https://github.com/ocoda/event-sourcing/issues"
   },
   "engines": {
-    "node": ">= 18.0.0"
+    "node": ">= 18.20.4"
   },
   "dependencies": {
-    "mariadb": "^3.3.1"
+    "mariadb": "^3.3.2"
   },
   "peerDependencies": {
     "@nestjs/core": "^10.0.0",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.2.0",
-    "@ocoda/event-sourcing": "1.0.0"
+    "@ocoda/event-sourcing": "1.0.2"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.3",
-    "@faker-js/faker": "^9.0.0",
+    "@faker-js/faker": "^9.0.3",
     "@nestjs/common": "10.4.4",
     "@nestjs/core": "10.4.4",
     "@nestjs/platform-express": "10.4.4",
     "@nestjs/testing": "10.4.4",
-    "@swc-node/register": "^1.5.2",
-    "@swc/core": "1.7.26",
+    "@swc-node/register": "^1.10.9",
+    "@swc/core": "1.7.35",
     "@swc/jest": "0.2.36",
     "@types/jest": "29.5.13",
-    "@types/node": "20.16.10",
+    "@types/node": "20.16.11",
     "jest": "29.7.0",
     "jest-mock": "29.7.0",
     "reflect-metadata": "0.2.2",
     "rxjs": "7.8.1",
     "tsup": "^8.3.0",
-    "typescript": "5.6.2",
+    "typescript": "5.6.3",
     "@ocoda/event-sourcing-config": "1.0.0",
     "@ocoda/event-sourcing-testing": "1.0.0"
   },
@@ -50,7 +50,7 @@
   "scripts": {
     "build": "rm -rf dist && tsup lib/index.ts --format cjs --dts",
     "test": "jest --config jest.config.js",
-    "test:ci": "jest --config jest.config.js --runInBand --coverage",
+    "test:cov": "jest --config jest.config.js --coverage --collectCoverageFrom=lib/**/*.ts",
     "ci": "biome ci",
     "format": "biome format --write",
     "lint": "biome check --write"