@daiso-tech/core 0.22.2 → 0.24.0

package/dist/lock/implementations/test-utilities/database-lock-adapter.test-suite.js

@@ -0,0 +1,329 @@
+/**
+ * @module Lock
+ */
+import { vi, } from "vitest";
+import {} from "../../../lock/contracts/_module-exports.js";
+import {} from "../../../utilities/_module-exports.js";
+import { TimeSpan } from "../../../utilities/_module-exports.js";
+/**
+ * The <i>databaseLockAdapterTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link IDatabaseLockAdapter}</i> with <i>vitest</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/implementations/test-utilities"```
+ * @group Utilities
+ * @example
+ * ```ts
+ * import { afterEach, beforeEach, describe, expect, test } from "vitest";
+ * import { databaseLockAdapterTestSuite } from "@@daiso-tech/core/lock/implementations/test-utilities";
+ * import { LibsqlLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+ * import { type Client, createClient } from "@libsql/client";
+ *
+ * describe("class: LibsqlLockAdapter", () => {
+ *     let client: Client;
+ *     beforeEach(() => {
+ *         client = createClient({
+ *             url: ":memory:",
+ *         });
+ *     });
+ *     afterEach(() => {
+ *         client.close();
+ *     });
+ *     databaseLockAdapterTestSuite({
+ *         createAdapter: async () => {
+ *             const lockAdapter = new LibsqlLockAdapter({
+ *                database: client,
+ *                 tableName: "custom_table",
+ *                 shouldRemoveExpiredKeys: false,
+ *                 rootGroup: "@a",
+ *             });
+ *             await lockAdapter.init();
+ *             return lockAdapter;
+ *         },
+ *         test,
+ *         beforeEach,
+ *         expect,
+ *         describe,
+ *     });
+ * });
+ *
+ * ```
+ */
+export function databaseLockAdapterTestSuite(settings) {
+    const { expect, test, createAdapter, describe, beforeEach } = settings;
+    let databaseLockAdapterA;
+    let databaseLockAdapterB;
+    beforeEach(async () => {
+        databaseLockAdapterA = await createAdapter();
+        databaseLockAdapterB = databaseLockAdapterA.withGroup("b");
+    });
+    const ttl = TimeSpan.fromMilliseconds(50);
+    describe("Api tests:", () => {
+        describe("method: insert", () => {
+            test("Should insert lock when not existing", async () => {
+                const key = "a";
+                const owner = "b";
+                const expiration = null;
+                await databaseLockAdapterA.insert(key, owner, expiration);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toEqual({
+                    owner,
+                    expiration,
+                });
+            });
+            test("Should insert lock with expiration when not existing", async () => {
+                const key = "a";
+                const owner = "b";
+                const expiration = ttl.toEndDate();
+                await databaseLockAdapterA.insert(key, owner, expiration);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toEqual({
+                    owner,
+                    expiration,
+                });
+            });
+            test("Should throw error when lock already existing", async () => {
+                const key = "a";
+                const owner = "b";
+                const expiration = null;
+                await databaseLockAdapterA.insert(key, owner, expiration);
+                const result = databaseLockAdapterA.insert(key, owner, expiration);
+                await expect(result).rejects.toBeDefined();
+            });
+        });
+        describe("method: update", () => {
+            test("Should return false when lock has no expiration", async () => {
+                const key = "a";
+                const owner1 = "b";
+                const expiration = null;
+                await databaseLockAdapterA.insert(key, owner1, expiration);
+                const owner2 = "c";
+                const result = await databaseLockAdapterA.update(key, owner2, expiration);
+                expect(result).toBe(0);
+            });
+            test("Should not update when lock has no expiration", async () => {
+                const key = "a";
+                const owner1 = "b";
+                const expiration = null;
+                await databaseLockAdapterA.insert(key, owner1, expiration);
+                const owner2 = "c";
+                await databaseLockAdapterA.update(key, owner2, expiration);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toEqual({
+                    owner: owner1,
+                    expiration,
+                });
+            });
+            test("Should return false when lock has not expired", async () => {
+                vi.useFakeTimers();
+                const key = "a";
+                const owner1 = "b";
+                const expiration1 = ttl.toEndDate();
+                await databaseLockAdapterA.insert(key, owner1, expiration1);
+                vi.advanceTimersByTime(ttl.divide(2).toMilliseconds());
+                const owner2 = "c";
+                const expiration2 = ttl.addMilliseconds(25).toEndDate();
+                const result = await databaseLockAdapterA.update(key, owner2, expiration2);
+                expect(result).toBe(0);
+                vi.useRealTimers();
+            });
+            test("Should not update when lock has not expired", async () => {
+                vi.useFakeTimers();
+                const key = "a";
+                const owner1 = "b";
+                const expiration1 = ttl.toEndDate();
+                await databaseLockAdapterA.insert(key, owner1, expiration1);
+                vi.advanceTimersByTime(ttl.divide(2).toMilliseconds());
+                const owner2 = "c";
+                const expiration2 = ttl.addMilliseconds(25).toEndDate();
+                await databaseLockAdapterA.update(key, owner2, expiration2);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toEqual({
+                    owner: owner1,
+                    expiration: expiration1,
+                });
+                vi.useRealTimers();
+            });
+            test("Should return true when lock has expired", async () => {
+                vi.useFakeTimers();
+                const key = "a";
+                const owner1 = "b";
+                const expiration1 = ttl.toEndDate();
+                await databaseLockAdapterA.insert(key, owner1, expiration1);
+                vi.advanceTimersByTime(ttl.addMilliseconds(1).toMilliseconds());
+                const owner2 = "c";
+                const expiration2 = ttl.addMilliseconds(25).toEndDate();
+                const result = await databaseLockAdapterA.update(key, owner2, expiration2);
+                expect(result).toBe(1);
+                vi.useRealTimers();
+            });
+            test("Should update when lock has expired", async () => {
+                vi.useFakeTimers();
+                const key = "a";
+                const owner1 = "b";
+                const expiration1 = ttl.toEndDate();
+                await databaseLockAdapterA.insert(key, owner1, expiration1);
+                vi.advanceTimersByTime(ttl.addMilliseconds(1).toMilliseconds());
+                const owner2 = "c";
+                const expiration2 = ttl.addMilliseconds(25).toEndDate();
+                await databaseLockAdapterA.update(key, owner2, expiration2);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toEqual({
+                    owner: owner2,
+                    expiration: expiration2,
+                });
+                vi.useRealTimers();
+            });
+        });
+        describe("method: remove", () => {
+            test("Should not remove lock when not same owner", async () => {
+                const key = "a";
+                const owner1 = "b";
+                const expiration = null;
+                await databaseLockAdapterA.insert(key, owner1, expiration);
+                const owner2 = "c";
+                await databaseLockAdapterA.remove(key, owner2);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toEqual({
+                    owner: owner1,
+                    expiration,
+                });
+            });
+            test("Should remove lock when same owner", async () => {
+                const key = "a";
+                const owner = "b";
+                const expiration = null;
+                await databaseLockAdapterA.insert(key, owner, expiration);
+                await databaseLockAdapterA.remove(key, owner);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toBeNull();
+            });
+            test("Should remove lock when given null as owner", async () => {
+                const key = "a";
+                const owner = "b";
+                const expiration = null;
+                await databaseLockAdapterA.insert(key, owner, expiration);
+                await databaseLockAdapterA.remove(key, null);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toBeNull();
+            });
+        });
+        describe("method: refresh", () => {
+            test("Should return false when not same owner", async () => {
+                const key = "a";
+                const owner1 = "b";
+                const expiration1 = ttl.toEndDate();
+                await databaseLockAdapterA.insert(key, owner1, expiration1);
+                const expiration2 = ttl.multiply(2).toEndDate();
+                const owner2 = "c";
+                const result = await databaseLockAdapterA.refresh(key, owner2, expiration2);
+                expect(result).toBe(0);
+            });
+            test("Should not update lock when not same owner", async () => {
+                const key = "a";
+                const owner1 = "b";
+                const expiration1 = ttl.toEndDate();
+                await databaseLockAdapterA.insert(key, owner1, expiration1);
+                const expiration2 = ttl.multiply(2).toEndDate();
+                const owner2 = "c";
+                await databaseLockAdapterA.refresh(key, owner2, expiration2);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toEqual({
+                    owner: owner1,
+                    expiration: expiration1,
+                });
+            });
+            test("Should return true when same owner", async () => {
+                const key = "a";
+                const owner = "b";
+                const expiration1 = ttl.toEndDate();
+                await databaseLockAdapterA.insert(key, owner, expiration1);
+                const expiration2 = ttl.multiply(2).toEndDate();
+                const result = await databaseLockAdapterA.refresh(key, owner, expiration2);
+                expect(result).toBe(1);
+            });
+            test("Should update lock when same owner", async () => {
+                const key = "a";
+                const owner = "b";
+                const expiration1 = ttl.toEndDate();
+                await databaseLockAdapterA.insert(key, owner, expiration1);
+                const expiration2 = ttl.multiply(2).toEndDate();
+                await databaseLockAdapterA.refresh(key, owner, expiration2);
+                const result = await databaseLockAdapterA.find(key);
+                expect(result).toEqual({
+                    owner,
+                    expiration: expiration2,
+                });
+            });
+        });
+    });
+    describe("Group tests:", () => {
+        test("method: insert", async () => {
+            const key = "a";
+            const owner = "b";
+            const expiration = ttl.toEndDate();
+            const result1 = databaseLockAdapterA.insert(key, owner, expiration);
+            const result2 = databaseLockAdapterB.insert(key, owner, expiration);
+            await expect(result1).resolves.toBeUndefined();
+            await expect(result2).resolves.toBeUndefined();
+        });
+        test("method: update", async () => {
+            vi.useFakeTimers();
+            const key = "a";
+            const owner1 = "b";
+            const expiration = ttl.toEndDate();
+            await databaseLockAdapterA.insert(key, owner1, expiration);
+            await databaseLockAdapterB.insert(key, owner1, expiration);
+            vi.advanceTimersByTime(ttl.toMilliseconds());
+            const owner2 = "c";
+            await databaseLockAdapterA.update(key, owner2, null);
+            const result1 = await databaseLockAdapterA.find(key);
+            expect(result1).toEqual({
+                owner: owner2,
+                expiration: null,
+            });
+            const result2 = await databaseLockAdapterB.find(key);
+            expect(result2).toEqual({
+                owner: owner1,
+                expiration,
+            });
+            vi.useRealTimers();
+        });
+        test("method: remove", async () => {
+            const key = "a";
+            const owner = "b";
+            const expiration = ttl.toEndDate();
+            await databaseLockAdapterA.insert(key, owner, expiration);
+            await databaseLockAdapterB.insert(key, owner, expiration);
+            await databaseLockAdapterA.remove(key, owner);
+            const result1 = await databaseLockAdapterA.find(key);
+            expect(result1).toBeNull();
+            const result2 = await databaseLockAdapterB.find(key);
+            expect(result2).toEqual({
+                owner,
+                expiration,
+            });
+        });
+        test("method: refresh", async () => {
+            vi.useFakeTimers();
+            const key = "a";
+            const owner = "b";
+            const expiration = ttl.toEndDate();
+            await databaseLockAdapterA.insert(key, owner, expiration);
+            await databaseLockAdapterB.insert(key, owner, expiration);
+            vi.advanceTimersByTime(ttl.toMilliseconds());
+            const newExpiration = ttl.multiply(2).toEndDate();
+            await databaseLockAdapterA.refresh(key, owner, newExpiration);
+            const result1 = await databaseLockAdapterA.find(key);
+            expect(result1).toEqual({
+                owner,
+                expiration: newExpiration,
+            });
+            const result2 = await databaseLockAdapterB.find(key);
+            expect(result2).toEqual({
+                owner,
+                expiration,
+            });
+            vi.useRealTimers();
+        });
+    });
+}
+//# sourceMappingURL=database-lock-adapter.test-suite.js.map

package/dist/lock/implementations/test-utilities/database-lock-adapter.test-suite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database-lock-adapter.test-suite.js","sourceRoot":"","sources":["../../../../src/lock/implementations/test-utilities/database-lock-adapter.test-suite.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAKH,EAAE,GACL,MAAM,QAAQ,CAAC;AAChB,OAAO,EAA6B,MAAM,qCAAqC,CAAC;AAChF,OAAO,EAAmB,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAe1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,UAAU,4BAA4B,CACxC,QAA8C;IAE9C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;IACvE,IAAI,oBAA0C,CAAC;IAC/C,IAAI,oBAA0C,CAAC;IAC/C,UAAU,CAAC,KAAK,IAAI,EAAE;QAClB,oBAAoB,GAAG,MAAM,aAAa,EAAE,CAAC;QAC7C,oBAAoB,GAAG,oBAAoB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC1C,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QACxB,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAC5B,IAAI,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;gBACpD,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,UAAU,GAAG,IAAI,CAAC;gBAExB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;gBAE1D,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,KAAK;oBACL,UAAU;iBACb,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;gBACpE,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,UAAU,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBAEnC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;gBAE1D,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,KAAK;oBACL,UAAU;iBACb,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;gBAC7D,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,UAAU,GAAG,IAAI,CAAC;gBAExB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;gBAE1D,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,CACtC,GAAG,EACH,KAAK,EACL,UAAU,CACb,CAAC;gBACF,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YAC/C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAC5B,IAAI,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;gBAC/D,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,UAAU,GAAG,IAAI,CAAC;gBACxB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;gBAE3D,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAC5C,GAAG,EACH,MAAM,EACN,UAAU,CACb,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;gBAC7D,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,UAAU,GAAG,IAAI,CAAC;gBACxB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;gBAE3D,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;gBAE3D,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,KAAK,EAAE,MAAM;oBACb,UAAU;iBACb,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;gBAC7D,EAAE,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;gBAC5D,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC;gBAEvD,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC;gBACxD,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAC5C,GAAG,EACH,MAAM,EACN,WAAW,CACd,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACvB,EAAE,CAAC,aAAa,EAAE,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;gBAC3D,EAAE,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;gBAC5D,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC;gBAEvD,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC;gBACxD,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;gBAE5D,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,KAAK,EAAE,MAAM;oBACb,UAAU,EAAE,WAAW;iBAC1B,CAAC,CAAC;gBACH,EAAE,CAAC,aAAa,EAAE,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;gBACxD,EAAE,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;gBAC5D,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC;gBAEhE,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC;gBACxD,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAC5C,GAAG,EACH,MAAM,EACN,WAAW,CACd,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACvB,EAAE,CAAC,aAAa,EAAE,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;gBACnD,EAAE,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;gBAC5D,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC;gBAEhE,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC;gBACxD,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;gBAE5D,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,KAAK,EAAE,MAAM;oBACb,UAAU,EAAE,WAAW;iBAC1B,CAAC,CAAC;gBACH,EAAE,CAAC,aAAa,EAAE,CAAC;YACvB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAC5B,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,UAAU,GAAG,IAAI,CAAC;gBACxB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;gBAE3D,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBAE/C,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,KAAK,EAAE,MAAM;oBACb,UAAU;iBACb,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;gBAClD,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,UAAU,GAAG,IAAI,CAAC;gBACxB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;gBAE1D,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAE9C,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;gBAC3D,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,UAAU,GAAG,IAAI,CAAC;gBACxB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;gBAE1D,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBAE7C,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;YAC7B,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;gBAE5D,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAChD,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAC7C,GAAG,EACH,MAAM,EACN,WAAW,CACd,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;gBAE5D,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAChD,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;gBAE7D,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,KAAK,EAAE,MAAM;oBACb,UAAU,EAAE,WAAW;iBAC1B,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;gBAClD,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;gBAE3D,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAChD,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAC7C,GAAG,EACH,KAAK,EACL,WAAW,CACd,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;gBAClD,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;gBAE3D,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAChD,MAAM,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;gBAE5D,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,KAAK;oBACL,UAAU,EAAE,WAAW;iBAC1B,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC1B,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,GAAG,GAAG,GAAG,CAAC;YAChB,MAAM,KAAK,GAAG,GAAG,CAAC;YAClB,MAAM,UAAU,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;YAEnC,MAAM,OAAO,GAAG,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;YACpE,MAAM,OAAO,GAAG,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;YAEpE,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;YAC/C,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;YAC9B,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,GAAG,GAAG,GAAG,CAAC;YAChB,MAAM,MAAM,GAAG,GAAG,CAAC;YACnB,MAAM,UAAU,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;YAEnC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;YAC3D,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;YAC3D,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC;YAE7C,MAAM,MAAM,GAAG,GAAG,CAAC;YACnB,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YAErD,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE,MAAM;gBACb,UAAU,EAAE,IAAI;aACnB,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE,MAAM;gBACb,UAAU;aACb,CAAC,CAAC;YACH,EAAE,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,GAAG,GAAG,GAAG,CAAC;YAChB,MAAM,KAAK,GAAG,GAAG,CAAC;YAClB,MAAM,UAAU,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;YAEnC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;YAC1D,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;YAC1D,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAE9C,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC3B,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK;gBACL,UAAU;aACb,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;YAC/B,EAAE,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,GAAG,GAAG,GAAG,CAAC;YAChB,MAAM,KAAK,GAAG,GAAG,CAAC;YAClB,MAAM,UAAU,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;YAEnC,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;YAC1D,MAAM,oBAAoB,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;YAC1D,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC;YAE7C,MAAM,aAAa,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;YAClD,MAAM,oBAAoB,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;YAE9D,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK;gBACL,UAAU,EAAE,aAAa;aAC5B,CAAC,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrD,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK;gBACL,UAAU;aACb,CAAC,CAAC;YACH,EAAE,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC"}

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

@@ -0,0 +1,63 @@
+/**
+ * @module Lock
+ */
+import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
+import { type ILockAdapter } from "../../../lock/contracts/_module-exports.js";
+import { type Promisable } from "../../../utilities/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/implementations/test-utilities"```
+ * @group Utilities
+ */
+export type LockAdapterTestSuiteSettings = {
+    expect: ExpectStatic;
+    test: TestAPI;
+    describe: SuiteAPI;
+    beforeEach: typeof beforeEach;
+    createAdapter: () => Promisable<ILockAdapter>;
+};
+/**
+ * The <i>lockAdapterTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link ILockAdapter}</i> with <i>vitest</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/implementations/test-utilities"```
+ * @group Utilities
+ * @example
+ * ```ts
+ * import { afterEach, beforeEach, describe, expect, test } from "vitest";
+ * import { lockAdapterTestSuite } from "@daiso-tech/core/lock/implementations/test-utilities";
+ * import { RedisLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+ * import { Redis } from "ioredis";
+ * import {
+ *     RedisContainer,
+ *     type StartedRedisContainer,
+ * } from "@testcontainers/redis";
+ * import { TimeSpan } from "@daiso-tech/core/utilities";
+ *
+ * const timeout = TimeSpan.fromMinutes(2);
+ * describe("class: RedisLockAdapter", () => {
+ *     let client: Redis;
+ *     let startedContainer: StartedRedisContainer;
+ *     beforeEach(async () => {
+ *         startedContainer = await new RedisContainer("redis:7.4.2").start();
+ *         client = new Redis(startedContainer.getConnectionUrl());
+ *     }, timeout.toMilliseconds());
+ *     afterEach(async () => {
+ *         await client.quit();
+ *         await startedContainer.stop();
+ *     }, timeout.toMilliseconds());
+ *     lockAdapterTestSuite({
+ *         createAdapter: () =>
+ *             new RedisLockAdapter({
+ *                 database: client,
+ *                 rootGroup: "@a",
+ *             }),
+ *         test,
+ *         beforeEach,
+ *         expect,
+ *         describe,
+ *     });
+ * });
+ *
+ * ```
+ */
+export declare function lockAdapterTestSuite(settings: LockAdapterTestSuiteSettings): void;

package/dist/lock/implementations/test-utilities/lock-adapter.test-suite.js

@@ -0,0 +1,156 @@
+/**
+ * @module Lock
+ */
+import {} from "vitest";
+import {} from "../../../lock/contracts/_module-exports.js";
+import {} from "../../../utilities/_module-exports.js";
+import { TimeSpan } from "../../../utilities/_module-exports.js";
+import { delay } from "../../../async/_module-exports.js";
+/**
+ * The <i>lockAdapterTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link ILockAdapter}</i> with <i>vitest</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/implementations/test-utilities"```
+ * @group Utilities
+ * @example
+ * ```ts
+ * import { afterEach, beforeEach, describe, expect, test } from "vitest";
+ * import { lockAdapterTestSuite } from "@daiso-tech/core/lock/implementations/test-utilities";
+ * import { RedisLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+ * import { Redis } from "ioredis";
+ * import {
+ *     RedisContainer,
+ *     type StartedRedisContainer,
+ * } from "@testcontainers/redis";
+ * import { TimeSpan } from "@daiso-tech/core/utilities";
+ *
+ * const timeout = TimeSpan.fromMinutes(2);
+ * describe("class: RedisLockAdapter", () => {
+ *     let client: Redis;
+ *     let startedContainer: StartedRedisContainer;
+ *     beforeEach(async () => {
+ *         startedContainer = await new RedisContainer("redis:7.4.2").start();
+ *         client = new Redis(startedContainer.getConnectionUrl());
+ *     }, timeout.toMilliseconds());
+ *     afterEach(async () => {
+ *         await client.quit();
+ *         await startedContainer.stop();
+ *     }, timeout.toMilliseconds());
+ *     lockAdapterTestSuite({
+ *         createAdapter: () =>
+ *             new RedisLockAdapter({
+ *                 database: client,
+ *                 rootGroup: "@a",
+ *             }),
+ *         test,
+ *         beforeEach,
+ *         expect,
+ *         describe,
+ *     });
+ * });
+ *
+ * ```
+ */
+export function lockAdapterTestSuite(settings) {
+    const { expect, test, createAdapter, describe, beforeEach } = settings;
+    let lockAdapterA;
+    beforeEach(async () => {
+        lockAdapterA = await createAdapter();
+    });
+    const ttl = TimeSpan.fromMilliseconds(50);
+    describe("Api tests:", () => {
+        describe("method: acquire", () => {
+            test("Should return true when key is not acquired", async () => {
+                const key = "a";
+                const owner = "b";
+                const result = await lockAdapterA.acquire(key, owner, null);
+                expect(result).toBe(true);
+            });
+            test("Should return true when key is expired", async () => {
+                const key = "a";
+                const owner = "b";
+                await lockAdapterA.acquire(key, owner, ttl);
+                await delay(ttl);
+                const result = await lockAdapterA.acquire(key, owner, null);
+                expect(result).toBe(true);
+            });
+            test("Should return false when key is already acquired by same owner", async () => {
+                const key = "a";
+                const owner = "b";
+                await lockAdapterA.acquire(key, owner, null);
+                const result = await lockAdapterA.acquire(key, owner, null);
+                expect(result).toBe(false);
+            });
+            test("Should return false when key is already acquired by different owner", async () => {
+                const key = "a";
+                const owner1 = "b";
+                await lockAdapterA.acquire(key, owner1, null);
+                const owner2 = "c";
+                const result = await lockAdapterA.acquire(key, owner2, null);
+                expect(result).toBe(false);
+            });
+            test("Should return false when key is already acquired and not expired", async () => {
+                const key = "a";
+                const owner = "b";
+                await lockAdapterA.acquire(key, owner, ttl);
+                await delay(ttl.divide(2));
+                const result = await lockAdapterA.acquire(key, owner, null);
+                expect(result).toBe(false);
+            });
+        });
+        describe("method: release", () => {
+            test("Should return true when key is released by same owner", async () => {
+                const key = "a";
+                const owner = "b";
+                await lockAdapterA.acquire(key, owner, null);
+                const result = await lockAdapterA.release(key, owner);
+                expect(result).toBe(true);
+            });
+            test("Should return false when key is tried to be released by different owner", async () => {
+                const key = "a";
+                const owner1 = "b";
+                await lockAdapterA.acquire(key, owner1, null);
+                const owner2 = "c";
+                const result = await lockAdapterA.release(key, owner2);
+                expect(result).toBe(false);
+            });
+            test("Should be reacquirable by new owner after release", async () => {
+                const key = "a";
+                const owner1 = "b";
+                await lockAdapterA.acquire(key, owner1, null);
+                await lockAdapterA.release(key, owner1);
+                const owner2 = "c";
+                const result = await lockAdapterA.acquire(key, owner2, null);
+                expect(result).toBe(true);
+            });
+        });
+        describe("method: forceRelease", () => {
+            test("Should be reacquirable by new owner after release", async () => {
+                const key = "a";
+                const owner1 = "b";
+                await lockAdapterA.acquire(key, owner1, null);
+                await lockAdapterA.forceRelease(key);
+                const owner2 = "c";
+                const result = await lockAdapterA.acquire(key, owner2, null);
+                expect(result).toBe(true);
+            });
+        });
+        describe("method: refresh", () => {
+            test("Should return true when extended by same owner", async () => {
+                const key = "a";
+                const owner = "b";
+                await lockAdapterA.acquire(key, owner, ttl);
+                const result = await lockAdapterA.refresh(key, owner, ttl.multiply(2));
+                expect(result).toBe(true);
+            });
+            test("Should return false when extended by different owner", async () => {
+                const key = "a";
+                const owner1 = "b";
+                await lockAdapterA.acquire(key, owner1, ttl);
+                const owner2 = "c";
+                const result = await lockAdapterA.refresh(key, owner2, ttl.multiply(2));
+                expect(result).toBe(false);
+            });
+        });
+    });
+}
+//# sourceMappingURL=lock-adapter.test-suite.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lock-adapter.test-suite.js","sourceRoot":"","sources":["../../../../src/lock/implementations/test-utilities/lock-adapter.test-suite.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAKN,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAqB,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAmB,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAenD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,UAAU,oBAAoB,CAChC,QAAsC;IAEtC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;IACvE,IAAI,YAA0B,CAAC;IAC/B,UAAU,CAAC,KAAK,IAAI,EAAE;QAClB,YAAY,GAAG,MAAM,aAAa,EAAE,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC1C,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QACxB,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;YAC7B,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;gBAC3D,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC5D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;gBACtD,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;gBAC5C,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC5D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;gBAC9E,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC7C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC5D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;gBACnF,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC9C,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC7D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;gBAChF,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;gBAC5C,MAAM,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC3B,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC5D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;YAC7B,IAAI,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;gBACrE,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC7C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;gBACvF,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC9C,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBACvD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;gBACjE,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC9C,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBACxC,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC7D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;YAClC,IAAI,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;gBACjE,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC9C,MAAM,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBACrC,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC7D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;YAC7B,IAAI,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;gBAC9D,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAElB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;gBAC5C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CACrC,GAAG,EACH,KAAK,EACL,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAClB,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;gBACpE,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,MAAM,GAAG,GAAG,CAAC;gBAEnB,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;gBAC7C,MAAM,MAAM,GAAG,GAAG,CAAC;gBACnB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CACrC,GAAG,EACH,MAAM,EACN,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAClB,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/lock/implementations/test-utilities/lock-provider.test-suite.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @module Lock
+ */
+import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
+import type { IGroupableLockProvider } from "../../../lock/contracts/_module-exports.js";
+import { type Promisable } from "../../../utilities/_module-exports.js";
+import type { ISerde } from "../../../serde/contracts/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/implementations/test-utilities"```
+ * @group Utilities
+ */
+export type LockProviderTestSuiteSettings = {
+    expect: ExpectStatic;
+    test: TestAPI;
+    describe: SuiteAPI;
+    beforeEach: typeof beforeEach;
+    createLockProvider: () => Promisable<IGroupableLockProvider>;
+    serde?: ISerde;
+};
+/**
+ * The <i>lockProviderTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link ILock}</i> with <i>vitest</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/implementations/test-utilities"```
+ * @group Utilities
+ * ```ts
+ * import { beforeEach, describe, expect, test } from "vitest";
+ * import { MemoryLockAdapter } from "@daiso-tech/core/lock/implementations/adapters";
+ * import { LockProvider } from "@daiso-tech/core/lock/implementations/derivables";
+ * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+ * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+ * import { lockProviderTestSuite } from "@daiso-tech/core/lock/implementations/test-utilities";
+ * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+ * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+ * import type { ILockData } from "@daiso-tech/core/lock/contracts";
+ *
+ * describe("class: LockProvider", () => {
+ *     const eventBus = new EventBus({
+ *         adapter: new MemoryEventBusAdapter({
+ *             rootGroup: "@global",
+ *         }),
+ *     });
+ *     const serde = new Serde(new SuperJsonSerdeAdapter());
+ *     let map: Map<string, ILockData>;
+ *     beforeEach(() => {
+ *         map = new Map();
+ *     });
+ *     lockProviderTestSuite({
+ *         createLockProvider: () => {
+ *             const lockProvider = new LockProvider({
+ *                 serde,
+ *                 adapter: new MemoryLockAdapter({
+ *                     rootGroup: "@a",
+ *                     map,
+ *                 }),
+ *                 eventBus,
+ *             });
+ *             return lockProvider;
+ *         },
+ *         beforeEach,
+ *         describe,
+ *         expect,
+ *         test,
+ *         serde,
+ *     });
+ * });
+ * ```
+ */
+export declare function lockProviderTestSuite(settings: LockProviderTestSuiteSettings): void;