@daiso-tech/core 0.22.2 → 0.24.0

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

@@ -0,0 +1,302 @@
+/**
+ * @module Cache
+ */
+import {} from "vitest";
+import { TypeCacheError, } from "../../../cache/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>cacheAdapterTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link ICacheAdapter}</i> with <i>vitest</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/implementations/test-utilities"```
+ * @group Test utilities
+ * @example
+ * ```ts
+ * import { afterEach, beforeEach, describe, expect, test } from "vitest";
+ * import { cacheAdapterTestSuite } from "@daiso-tech/core/cache/implementations/test-utilities";
+ * import { RedisCacheAdapter } from "@daiso-tech/core/cache/implementations/adapters";
+ * import { Redis } from "ioredis";
+ * import {
+ *     RedisContainer,
+ *     type StartedRedisContainer,
+ * } from "@testcontainers/redis";
+ * import { TimeSpan } from "@daiso-tech/core/utilities";
+ * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+ * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+ *
+ * const timeout = TimeSpan.fromMinutes(2);
+ * describe("class: RedisCacheAdapter", () => {
+ *     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());
+ *     cacheAdapterTestSuite({
+ *         createAdapter: () =>
+ *             new RedisCacheAdapter({
+ *                 database: client,
+ *                 serde: new Serde(new SuperJsonSerdeAdapter()),
+ *                 rootGroup: "@a",
+ *             }),
+ *         test,
+ *         beforeEach,
+ *         expect,
+ *         describe,
+ *     });
+ * });
+ *
+ * ```
+ */
+export function cacheAdapterTestSuite(settings) {
+    const { expect, test, createAdapter, describe, beforeEach } = settings;
+    let cacheAdapterA;
+    let cacheAdapterB;
+    beforeEach(async () => {
+        cacheAdapterA = await createAdapter();
+        cacheAdapterB = cacheAdapterA.withGroup("b");
+    });
+    describe("Api tests:", () => {
+        const TTL = TimeSpan.fromMilliseconds(50);
+        describe("method: get", () => {
+            test("Should return the value when key exists", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                expect(await cacheAdapterA.get("a")).toBe(1);
+            });
+            test("Should return null when keys doesnt exists", async () => {
+                expect(await cacheAdapterA.get("a")).toBeNull();
+            });
+            test("Should return null when key is experied", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                expect(await cacheAdapterA.get("a")).toBeNull();
+            });
+        });
+        describe("method: add", () => {
+            test("Should return true when key doesnt exists", async () => {
+                expect(await cacheAdapterA.add("a", 1, null)).toBe(true);
+            });
+            test("Should return true when key is expired", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                expect(await cacheAdapterA.add("a", 1, null)).toBe(true);
+            });
+            test("Should persist values when key doesnt exist", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                expect(await cacheAdapterA.get("a")).toBe(1);
+            });
+            test("Should persist values when key is expired", async () => {
+                await cacheAdapterA.add("a", -1, TTL);
+                await delay(TTL);
+                await cacheAdapterA.add("a", 1, null);
+                expect(await cacheAdapterA.get("a")).toBe(1);
+            });
+            test("Should return false when key exists", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                expect(await cacheAdapterA.add("a", 1, null)).toBe(false);
+            });
+            test("Should not persist value when key exist", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                await cacheAdapterA.add("a", 2, null);
+                expect(await cacheAdapterA.get("a")).toBe(1);
+            });
+        });
+        describe("method: update", () => {
+            test("Should return true when key exists", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                expect(await cacheAdapterA.update("a", -1)).toBe(true);
+            });
+            test("Should persist value when key exist", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                await cacheAdapterA.update("a", -1);
+                expect(await cacheAdapterA.get("a")).toBe(-1);
+            });
+            test("Should return false when key doesnt exists", async () => {
+                expect(await cacheAdapterA.update("a", -1)).toBe(false);
+            });
+            test("Should return false when key is expired", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                expect(await cacheAdapterA.update("a", -1)).toBe(false);
+            });
+            test("Should not persist value when key doesnt exist", async () => {
+                await cacheAdapterA.update("a", -1);
+                expect(await cacheAdapterA.get("a")).toBeNull();
+            });
+            test("Should not persist value when key is expired", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                await cacheAdapterA.update("a", -1);
+                expect(await cacheAdapterA.get("a")).toBeNull();
+            });
+        });
+        describe("method: put", () => {
+            test("Should return only true when key exists", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                expect(await cacheAdapterA.put("a", -1, null)).toBe(true);
+            });
+            test("Should persist value when key exist", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                await cacheAdapterA.put("a", -1, null);
+                expect(await cacheAdapterA.get("a")).toBe(-1);
+            });
+            test("Should return false when key doesnt exists", async () => {
+                expect(await cacheAdapterA.put("a", -1, null)).toBe(false);
+            });
+            test("Should return false when key is expired", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                expect(await cacheAdapterA.put("a", -1, null)).toBe(false);
+            });
+            test("Should persist values when key doesnt exist", async () => {
+                await cacheAdapterA.put("a", -1, null);
+                expect(await cacheAdapterA.get("a")).toBe(-1);
+            });
+            test("Should persist values when key is expired", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                await cacheAdapterA.put("a", -1, null);
+                expect(await cacheAdapterA.get("a")).toBe(-1);
+            });
+            test("Should replace the ttl value", async () => {
+                const ttlA = TimeSpan.fromMilliseconds(100);
+                await cacheAdapterA.add("a", 1, ttlA);
+                const ttlB = TimeSpan.fromMilliseconds(50);
+                await cacheAdapterA.put("a", -1, ttlB);
+                await delay(ttlB);
+                expect(await cacheAdapterA.get("a")).toBeNull();
+            });
+        });
+        describe("method: remove", () => {
+            test("Should return only true when key exists", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                expect(await cacheAdapterA.remove("a")).toBe(true);
+            });
+            test("Should persist removal when key exist", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                await cacheAdapterA.remove("a");
+                expect(await cacheAdapterA.get("a")).toBeNull();
+            });
+            test("Should persist removal when key is expired", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                await cacheAdapterA.remove("a");
+                expect(await cacheAdapterA.get("a")).toBeNull();
+            });
+            test("Should return false when key doesnt exists", async () => {
+                expect(await cacheAdapterA.remove("a")).toBe(false);
+            });
+            test("Should return false when key is expired", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                expect(await cacheAdapterA.remove("a")).toBe(false);
+            });
+        });
+        describe("method: increment", () => {
+            test("Should return true when key exists", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                expect(await cacheAdapterA.increment("a", 1)).toBe(true);
+            });
+            test("Should persist increment when key exists", async () => {
+                await cacheAdapterA.add("a", 1, null);
+                await cacheAdapterA.increment("a", 1);
+                expect(await cacheAdapterA.get("a")).toBe(2);
+            });
+            test("Should return false when key doesnt exists", async () => {
+                expect(await cacheAdapterA.increment("a", 1)).toBe(false);
+            });
+            test("Should return false when key is expired", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                expect(await cacheAdapterA.increment("a", 1)).toBe(false);
+            });
+            test("Should not persist increment when key doesnt exists", async () => {
+                await cacheAdapterA.increment("a", 1);
+                expect(await cacheAdapterA.get("a")).toBeNull();
+            });
+            test("Should not persist increment when key is expired", async () => {
+                await cacheAdapterA.add("a", 1, TTL);
+                await delay(TTL);
+                await cacheAdapterA.increment("a", 1);
+                expect(await cacheAdapterA.get("a")).toBeNull();
+            });
+            test("Should throw TypeCacheError key value is not number type", async () => {
+                await cacheAdapterA.add("a", "str", null);
+                await expect(cacheAdapterA.increment("a", 1)).rejects.toBeInstanceOf(TypeCacheError);
+            });
+        });
+        describe("method: clear", () => {
+            test(`Should remove all keys`, async () => {
+                await cacheAdapterA.add("a", 1, null);
+                await cacheAdapterA.add("b", 2, null);
+                await cacheAdapterA.add("c", 3, null);
+                await cacheAdapterA.clear();
+                expect([
+                    await cacheAdapterA.get("a"),
+                    await cacheAdapterA.get("b"),
+                    await cacheAdapterA.get("c"),
+                ]).toEqual([null, null, null]);
+            });
+        });
+    });
+    describe("Group tests:", () => {
+        test("method: get", async () => {
+            await cacheAdapterA.put("a", 1, null);
+            expect(await cacheAdapterA.get("a")).toBe(1);
+            expect(await cacheAdapterB.get("a")).toBeNull();
+        });
+        test("method: add", async () => {
+            await cacheAdapterA.add("a", 1, null);
+            await cacheAdapterB.add("a", 2, null);
+            expect(await cacheAdapterA.get("a")).toBe(1);
+            expect(await cacheAdapterB.get("a")).toBe(2);
+        });
+        test("method: update", async () => {
+            await cacheAdapterA.add("a", 1, null);
+            await cacheAdapterB.add("a", 1, null);
+            await cacheAdapterA.update("a", 2);
+            await cacheAdapterB.update("a", 3);
+            expect(await cacheAdapterA.get("a")).toBe(2);
+            expect(await cacheAdapterB.get("a")).toBe(3);
+        });
+        test("method: put", async () => {
+            await cacheAdapterA.put("a", 2, null);
+            await cacheAdapterB.put("a", 3, null);
+            expect(await cacheAdapterA.get("a")).toBe(2);
+            expect(await cacheAdapterB.get("a")).toBe(3);
+        });
+        test("method: remove", async () => {
+            await cacheAdapterA.add("a", 1, null);
+            await cacheAdapterB.add("a", 1, null);
+            await cacheAdapterA.remove("a");
+            expect(await cacheAdapterA.get("a")).toBeNull();
+            expect(await cacheAdapterB.get("a")).toBe(1);
+        });
+        test("method: increment", async () => {
+            await cacheAdapterA.add("a", 1, null);
+            await cacheAdapterB.add("a", 1, null);
+            await cacheAdapterA.increment("a", 1);
+            expect(await cacheAdapterA.get("a")).toBe(2);
+            expect(await cacheAdapterB.get("a")).toBe(1);
+        });
+        test("method: clear", async () => {
+            await cacheAdapterA.add("a", 1, null);
+            await cacheAdapterA.add("b", 2, null);
+            await cacheAdapterB.add("a", 1, null);
+            await cacheAdapterB.add("b", 2, null);
+            await cacheAdapterA.clear();
+            expect([
+                await cacheAdapterA.get("a"),
+                await cacheAdapterA.get("b"),
+                await cacheAdapterB.get("a"),
+                await cacheAdapterB.get("b"),
+            ]).toEqual([null, null, 1, 2]);
+        });
+    });
+}
+//# sourceMappingURL=cache-adapter.test-suite.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cache-adapter.test-suite.js","sourceRoot":"","sources":["../../../../src/cache/implementations/test-utilities/cache-adapter.test-suite.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAKN,MAAM,QAAQ,CAAC;AAChB,OAAO,EACH,cAAc,GAEjB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAmB,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAenD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,UAAU,qBAAqB,CACjC,QAAuC;IAEvC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;IACvE,IAAI,aAAiC,CAAC;IACtC,IAAI,aAAiC,CAAC;IACtC,UAAU,CAAC,KAAK,IAAI,EAAE;QAClB,aAAa,GAAG,MAAM,aAAa,EAAE,CAAC;QACtC,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QACxB,MAAM,GAAG,GAAG,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC1C,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;YACzB,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;YACzB,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;gBACzD,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;gBACtD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;gBAC3D,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;gBACzD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;gBACtC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;gBACnD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAC5B,IAAI,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;gBAClD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;gBACnD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;gBACpC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;gBAC9D,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;gBACpC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;gBAC5D,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;gBACpC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;YACzB,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;gBACnD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBACvC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;gBAC3D,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBACvC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;gBACzD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBACvC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;gBAC5C,MAAM,IAAI,GAAG,QAAQ,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;gBAC5C,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,IAAI,GAAG,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;gBAC3C,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBACvC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClB,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAC5B,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;gBACrD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAChC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAChC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC/B,IAAI,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;gBAClD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;gBACxD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,aAAa,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,CAAC,MAAM,aAAa,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;gBACvD,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,aAAa,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;gBACnE,MAAM,aAAa,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;gBAChE,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,aAAa,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;gBACxE,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC1C,MAAM,MAAM,CACR,aAAa,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAClC,CAAC,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;YAC3B,IAAI,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;gBACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACtC,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC;gBAC5B,MAAM,CAAC;oBACH,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC;oBAC5B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC;oBAC5B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC;iBAC/B,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YACnC,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC1B,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACnC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAChC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YAChD,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;YACjC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;YAC7B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC;YAE5B,MAAM,CAAC;gBACH,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC;gBAC5B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC;gBAC5B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC;gBAC5B,MAAM,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC;aAC/B,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/cache/implementations/test-utilities/cache.test-suite.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @module Cache
+ */
+import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
+import { type IGroupableCache } from "../../../cache/contracts/_module-exports.js";
+import { type Promisable } from "../../../utilities/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/implementations/test-utilities"```
+ * @group Test utilities
+ */
+export type CacheTestSuiteSettings = {
+    expect: ExpectStatic;
+    test: TestAPI;
+    describe: SuiteAPI;
+    beforeEach: typeof beforeEach;
+    createCache: () => Promisable<IGroupableCache>;
+};
+/**
+ * The <i>cacheTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link ICache}</i> with <i>vitest</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/implementations/test-utilities"```
+ * @group Test utilities
+ * @example
+ * ```ts
+ * import { beforeEach, describe, expect, test } from "vitest";
+ * import { MemoryCacheAdapter } from "@daiso-tech/core/cache/implementations/adapters";
+ * import { Cache } from "@daiso-tech/core/cache/implementations/derivables";
+ * import { EventBus } from "@daiso-tech/core/event-bus/implementations/derivables";
+ * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/implementations/adapters";
+ * import { cacheTestSuite } from "@daiso-tech/core/cache/implementations/test-utilities";
+ *
+ * describe("class: Cache", () => {
+ *     const eventBus = new EventBus<any>({
+ *         adapter: new MemoryEventBusAdapter({
+ *             rootGroup: "@global",
+ *         }),
+ *     });
+ *     let map: Map<string, unknown>;
+ *     beforeEach(() => {
+ *         map = new Map();
+ *     });
+ *     cacheTestSuite({
+ *         createCache: () =>
+ *             new Cache({
+ *                 adapter: new MemoryCacheAdapter({
+ *                     rootGroup: "@a",
+ *                     map,
+ *                 }),
+ *                 eventBus,
+ *             }),
+ *         beforeEach,
+ *         describe,
+ *         expect,
+ *         test,
+ *     });
+ * });
+ *
+ * ```
+ */
+export declare function cacheTestSuite(settings: CacheTestSuiteSettings): void;