@daiso-tech/core 0.22.2 → 0.24.0

package/dist/event-bus/implementations/test-utilities/_module-exports.d.ts

@@ -0,0 +1,2 @@
+export * from "../../../event-bus/implementations/test-utilities/event-bus-adapter.test-suite.js";
+export * from "../../../event-bus/implementations/test-utilities/event-bus.test-suite.js";

package/dist/event-bus/implementations/test-utilities/_module-exports.js

@@ -0,0 +1,3 @@
+export * from "../../../event-bus/implementations/test-utilities/event-bus-adapter.test-suite.js";
+export * from "../../../event-bus/implementations/test-utilities/event-bus.test-suite.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/event-bus/implementations/test-utilities/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/event-bus/implementations/test-utilities/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,4EAA4E,CAAC;AAC3F,cAAc,oEAAoE,CAAC"}

package/dist/event-bus/implementations/test-utilities/event-bus-adapter.test-suite.d.ts

@@ -0,0 +1,73 @@
+/**
+ * @module EventBus
+ */
+import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
+import type { IEventBusAdapter } from "../../../event-bus/contracts/_module-exports.js";
+import { type Promisable } from "../../../utilities/_module-exports.js";
+import type { IFlexibleSerde } from "../../../serde/contracts/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/event-bus/implementations/test-utilities"```
+ * @group Test utilities
+ */
+export type EventBusAdapterTestSuiteSettings = {
+    expect: ExpectStatic;
+    serde?: IFlexibleSerde;
+    test: TestAPI;
+    describe: SuiteAPI;
+    beforeEach: typeof beforeEach;
+    createAdapter: () => Promisable<IEventBusAdapter>;
+};
+/**
+ * The <i>eventBusAdapterTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link IEventBusAdapter}</i> with vitest.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/event-bus/implementations/test-utilities"```
+ * @group Test utilities
+ * @example
+ * ```ts
+ * import { describe, test, beforeEach, expect, afterEach } from "vitest";
+ * import type { StartedRedisContainer } from "@testcontainers/redis";
+ * import { RedisContainer } from "@testcontainers/redis";
+ * import Redis from "ioredis";
+ * import { RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/adapters";
+ * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+ * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+ * import { eventBusAdapterTestSuite } from "@daiso-tech/core/event-bus/implementations/test-utilities";
+ *
+ * const TIMEOUT = TimeSpan.fromMinutes(2);
+ * describe("class: RedisPubSubEventBusAdapter", () => {
+ *   let dispatcherClient: Redis;
+ *   let listenerClient: Redis;
+ *   let startedContainer: StartedRedisContainer;
+ *   const serde = new Serde(new SuperJsonSerdeAdapter());
+ *
+ *   beforeEach(async () => {
+ *     startedContainer = await new RedisContainer().start();
+ *     dispatcherClient = new Redis(startedContainer.getConnectionUrl());
+ *     listenerClient = new Redis(startedContainer.getConnectionUrl());
+ *   }, TIMEOUT.toMilliseconds());
+ *
+ *   afterEach(async () => {
+ *     await dispatcherClient.quit();
+ *     await listenerClient.quit();
+ *     await startedContainer.stop();
+ *   }, TIMEOUT.toMilliseconds());
+ *
+ *   eventBusAdapterTestSuite({
+ *     createAdapter: () =>
+ *       new RedisPubSubEventBusAdapter({
+ *         dispatcherClient,
+ *         listenerClient,
+ *         serde,
+ *         rootGroup: "@global"
+ *       }),
+ *     serde,
+ *     test,
+ *     beforeEach,
+ *     expect,
+ *     describe,
+ *   });
+ * });
+ * ```
+ */
+export declare function eventBusAdapterTestSuite(settings: EventBusAdapterTestSuiteSettings): void;

package/dist/event-bus/implementations/test-utilities/event-bus-adapter.test-suite.js

@@ -0,0 +1,155 @@
+/**
+ * @module EventBus
+ */
+import { describe, } from "vitest";
+import { BaseEvent } from "../../../event-bus/contracts/_module-exports.js";
+import {} from "../../../utilities/_module-exports.js";
+import { TimeSpan } from "../../../utilities/_module-exports.js";
+import { delay } from "../../../async/_module-exports.js";
+import { Serde } from "../../../serde/implementations/derivables/_module-exports.js";
+import { NoOpSerdeAdapter } from "../../../serde/implementations/adapters/_module-exports.js";
+/**
+ * The <i>eventBusAdapterTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link IEventBusAdapter}</i> with vitest.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/event-bus/implementations/test-utilities"```
+ * @group Test utilities
+ * @example
+ * ```ts
+ * import { describe, test, beforeEach, expect, afterEach } from "vitest";
+ * import type { StartedRedisContainer } from "@testcontainers/redis";
+ * import { RedisContainer } from "@testcontainers/redis";
+ * import Redis from "ioredis";
+ * import { RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/adapters";
+ * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+ * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+ * import { eventBusAdapterTestSuite } from "@daiso-tech/core/event-bus/implementations/test-utilities";
+ *
+ * const TIMEOUT = TimeSpan.fromMinutes(2);
+ * describe("class: RedisPubSubEventBusAdapter", () => {
+ *   let dispatcherClient: Redis;
+ *   let listenerClient: Redis;
+ *   let startedContainer: StartedRedisContainer;
+ *   const serde = new Serde(new SuperJsonSerdeAdapter());
+ *
+ *   beforeEach(async () => {
+ *     startedContainer = await new RedisContainer().start();
+ *     dispatcherClient = new Redis(startedContainer.getConnectionUrl());
+ *     listenerClient = new Redis(startedContainer.getConnectionUrl());
+ *   }, TIMEOUT.toMilliseconds());
+ *
+ *   afterEach(async () => {
+ *     await dispatcherClient.quit();
+ *     await listenerClient.quit();
+ *     await startedContainer.stop();
+ *   }, TIMEOUT.toMilliseconds());
+ *
+ *   eventBusAdapterTestSuite({
+ *     createAdapter: () =>
+ *       new RedisPubSubEventBusAdapter({
+ *         dispatcherClient,
+ *         listenerClient,
+ *         serde,
+ *         rootGroup: "@global"
+ *       }),
+ *     serde,
+ *     test,
+ *     beforeEach,
+ *     expect,
+ *     describe,
+ *   });
+ * });
+ * ```
+ */
+export function eventBusAdapterTestSuite(settings) {
+    const { expect, test, createAdapter, beforeEach, serde = new Serde(new NoOpSerdeAdapter()), } = settings;
+    let eventBusAdapterA;
+    let eventBusAdapterB;
+    beforeEach(async () => {
+        eventBusAdapterA = await createAdapter();
+        eventBusAdapterB = eventBusAdapterA.withGroup("b");
+    });
+    const TTL = TimeSpan.fromMilliseconds(50);
+    class TestEvent extends BaseEvent {
+    }
+    serde.registerEvent(TestEvent);
+    describe("Api tests:", () => {
+        describe("method: addListener, removeListener, dispatch", () => {
+            test("Should be null when listener added and event is not triggered", async () => {
+                let result = null;
+                await eventBusAdapterA.addListener(TestEvent.name, (event) => {
+                    result = event;
+                });
+                expect(result).toBeNull();
+            });
+            test("Should be TestEvent when listener added and event is triggered", async () => {
+                let result = null;
+                await eventBusAdapterA.addListener(TestEvent.name, (event) => {
+                    result = event;
+                });
+                const event = new TestEvent({
+                    type: BaseEvent.name,
+                });
+                await eventBusAdapterA.dispatch(TestEvent.name, event);
+                await delay(TTL);
+                expect(result).toEqual(event);
+                expect(result).toBeInstanceOf(TestEvent);
+            });
+            test("Should be null when listener removed and event is triggered", async () => {
+                let result = null;
+                const listener = (event) => {
+                    result = event;
+                };
+                await eventBusAdapterA.addListener(TestEvent.name, listener);
+                await eventBusAdapterA.removeListener(TestEvent.name, listener);
+                const event = new TestEvent({
+                    type: BaseEvent.name,
+                });
+                await eventBusAdapterA.dispatch(TestEvent.name, event);
+                await delay(TTL);
+                expect(result).toBeNull();
+            });
+        });
+    });
+    describe("Group tests:", () => {
+        test("method: addListener / dispatch", async () => {
+            const event = new TestEvent({
+                type: "type",
+            });
+            let result_a = null;
+            await eventBusAdapterA.addListener(TestEvent.name, (event) => {
+                result_a = event;
+            });
+            let result_b = null;
+            await eventBusAdapterB.addListener(TestEvent.name, (event) => {
+                result_b = event;
+            });
+            await eventBusAdapterA.dispatch(TestEvent.name, event);
+            await delay(TTL);
+            expect(result_a).toEqual(event);
+            expect(result_a).toBeInstanceOf(TestEvent);
+            expect(result_b).toBeNull();
+        });
+        test("method: removeListener / addListener / dispatch", async () => {
+            const event = new TestEvent({
+                type: "type",
+            });
+            let result_a = null;
+            await eventBusAdapterA.addListener(TestEvent.name, (event) => {
+                result_a = event;
+            });
+            let result_b = null;
+            const listenerB = (event) => {
+                result_b = event;
+            };
+            await eventBusAdapterB.addListener(TestEvent.name, listenerB);
+            await eventBusAdapterB.removeListener(TestEvent.name, listenerB);
+            await eventBusAdapterA.dispatch(TestEvent.name, event);
+            await eventBusAdapterB.dispatch(TestEvent.name, event);
+            await delay(TTL);
+            expect(result_a).toEqual(event);
+            expect(result_a).toBeInstanceOf(TestEvent);
+            expect(result_b).toBeNull();
+        });
+    });
+}
+//# sourceMappingURL=event-bus-adapter.test-suite.js.map

package/dist/event-bus/implementations/test-utilities/event-bus-adapter.test-suite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-bus-adapter.test-suite.js","sourceRoot":"","sources":["../../../../src/event-bus/implementations/test-utilities/event-bus-adapter.test-suite.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAKH,QAAQ,GACX,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,SAAS,EAAE,MAAM,0CAA0C,CAAC;AACrE,OAAO,EAAmB,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAEnD,OAAO,EAAE,KAAK,EAAE,MAAM,uDAAuD,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,qDAAqD,CAAC;AAgBvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,UAAU,wBAAwB,CACpC,QAA0C;IAE1C,MAAM,EACF,MAAM,EACN,IAAI,EACJ,aAAa,EACb,UAAU,EACV,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,gBAAgB,EAAE,CAAC,GAC5C,GAAG,QAAQ,CAAC;IAEb,IAAI,gBAAkC,CAAC;IACvC,IAAI,gBAAkC,CAAC;IACvC,UAAU,CAAC,KAAK,IAAI,EAAE;QAClB,gBAAgB,GAAG,MAAM,aAAa,EAAE,CAAC;QACzC,gBAAgB,GAAG,gBAAgB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC1C,MAAM,SAAU,SAAQ,SAAS;KAAG;IACpC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAE/B,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QACxB,QAAQ,CAAC,+CAA+C,EAAE,GAAG,EAAE;YAC3D,IAAI,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;gBAC7E,IAAI,MAAM,GAAqB,IAAI,CAAC;gBACpC,MAAM,gBAAgB,CAAC,WAAW,CAC9B,SAAS,CAAC,IAAI,EACd,CAAC,KAAgB,EAAE,EAAE;oBACjB,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CACJ,CAAC;gBACF,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;gBAC9E,IAAI,MAAM,GAAqB,IAAI,CAAC;gBACpC,MAAM,gBAAgB,CAAC,WAAW,CAC9B,SAAS,CAAC,IAAI,EACd,CAAC,KAAgB,EAAE,EAAE;oBACjB,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CACJ,CAAC;gBACF,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC;oBACxB,IAAI,EAAE,SAAS,CAAC,IAAI;iBACvB,CAAC,CAAC;gBACH,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACvD,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC9B,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;gBAC3E,IAAI,MAAM,GAAqB,IAAI,CAAC;gBACpC,MAAM,QAAQ,GAAG,CAAC,KAAgB,EAAE,EAAE;oBAClC,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC;gBACF,MAAM,gBAAgB,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAC7D,MAAM,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAChE,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC;oBACxB,IAAI,EAAE,SAAS,CAAC,IAAI;iBACvB,CAAC,CAAC;gBACH,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACvD,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC1B,IAAI,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC;gBACxB,IAAI,EAAE,MAAM;aACf,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAqB,IAAI,CAAC;YACtC,MAAM,gBAAgB,CAAC,WAAW,CAC9B,SAAS,CAAC,IAAI,EACd,CAAC,KAAgB,EAAE,EAAE;gBACjB,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CACJ,CAAC;YAEF,IAAI,QAAQ,GAAqB,IAAI,CAAC;YACtC,MAAM,gBAAgB,CAAC,WAAW,CAC9B,SAAS,CAAC,IAAI,EACd,CAAC,KAAgB,EAAE,EAAE;gBACjB,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CACJ,CAAC;YAEF,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACvD,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;YAEjB,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC3C,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;YAC/D,MAAM,KAAK,GAAG,IAAI,SAAS,CAAC;gBACxB,IAAI,EAAE,MAAM;aACf,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAqB,IAAI,CAAC;YACtC,MAAM,gBAAgB,CAAC,WAAW,CAC9B,SAAS,CAAC,IAAI,EACd,CAAC,KAAgB,EAAE,EAAE;gBACjB,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CACJ,CAAC;YAEF,IAAI,QAAQ,GAAqB,IAAI,CAAC;YACtC,MAAM,SAAS,GAAG,CAAC,KAAgB,EAAE,EAAE;gBACnC,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC;YACF,MAAM,gBAAgB,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAC9D,MAAM,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAEjE,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACvD,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACvD,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;YAEjB,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC3C,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/event-bus/implementations/test-utilities/event-bus.test-suite.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @module EventBus
+ */
+import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
+import { type IGroupableEventBus } from "../../../event-bus/contracts/_module-exports.js";
+import { type Promisable } from "../../../utilities/_module-exports.js";
+import type { IFlexibleSerde } from "../../../serde/contracts/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/event-bus/implementations/test-utilities"```
+ * @group Test utilities
+ */
+export type EventBusTestSuiteSettings = {
+    expect: ExpectStatic;
+    serde?: IFlexibleSerde;
+    test: TestAPI;
+    describe: SuiteAPI;
+    beforeEach: typeof beforeEach;
+    createEventBus: () => Promisable<IGroupableEventBus>;
+};
+/**
+ * The <i>eventBusTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link IEventBus}</i> with vitest.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/event-bus/implementations/test-utilities"```
+ * @group Test utilities
+ * @example
+ * ```ts
+ * import { describe, test, beforeEach, expect, afterEach } from "vitest";
+ * import type { StartedRedisContainer } from "@testcontainers/redis";
+ * import { RedisContainer } from "@testcontainers/redis";
+ * import Redis from "ioredis";
+ * import { RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/adapters";
+ * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+ * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+ * import { eventBusTestSuite } from "@daiso-tech/core/event-bus/implementations/test-utilities";
+ *
+ * const TIMEOUT = TimeSpan.fromMinutes(2);
+ * describe("class: EventBus", () => {
+ *   let dispatcherClient: Redis;
+ *   let listenerClient: Redis;
+ *   let startedContainer: StartedRedisContainer;
+ *   const serde = new Serde(new SuperJsonSerdeAdapter());
+ *
+ *   beforeEach(async () => {
+ *     startedContainer = await new RedisContainer().start();
+ *     dispatcherClient = new Redis(startedContainer.getConnectionUrl());
+ *     listenerClient = new Redis(startedContainer.getConnectionUrl());
+ *   }, TIMEOUT.toMilliseconds());
+ *
+ *   afterEach(async () => {
+ *     await dispatcherClient.quit();
+ *     await listenerClient.quit();
+ *     await startedContainer.stop();
+ *   }, TIMEOUT.toMilliseconds());
+ *
+ *   eventBusTestSuite({
+ *     createEventBus: () =>
+ *       new EventBus(
+ *         new RedisPubSubEventBusAdapter({
+ *           dispatcherClient,
+ *           listenerClient,
+ *           serde,
+ *           rootGroup: "@global"
+ *         })
+ *       ),
+ *     serde,
+ *     test,
+ *     beforeEach,
+ *     expect,
+ *     describe,
+ *   });
+ * });
+ * ```
+ */
+export declare function eventBusTestSuite(settings: EventBusTestSuiteSettings): void;