@daiso-tech/core 0.42.0 → 0.44.0

package/dist/rate-limiter/implementations/policies/types.js

@@ -0,0 +1,14 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "../../../rate-limiter/implementations/policies/fixed-window-limiter/_module.js";
+import {} from "../../../rate-limiter/implementations/policies/sliding-window-limiter/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/policies"`
+ * @group Policies
+ */
+export const LIMITER_POLICIES = {
+    FIXED_WINDOW: "FIXED_WINDOW",
+    SLIDING_WINDOW: "SLIDING_WINDOW",
+};
+//# sourceMappingURL=types.js.map

package/dist/rate-limiter/implementations/policies/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/policies/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAGN,MAAM,yEAAyE,CAAC;AACjF,OAAO,EAGN,MAAM,2EAA2E,CAAC;AAEnF;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,YAAY,EAAE,cAAc;IAC5B,cAAc,EAAE,gBAAgB;CAC1B,CAAC"}

package/dist/rate-limiter/implementations/test-utilities/_module-exports.d.ts

@@ -0,0 +1,3 @@
+export * from "../../../rate-limiter/implementations/test-utilities/fixed-window-limiter.test-suite.js";
+export * from "../../../rate-limiter/implementations/test-utilities/rate-limiter-storage-adapter.test-suite.js";
+export * from "../../../rate-limiter/implementations/test-utilities/sliding-window-limiter.test-suite.js";

package/dist/rate-limiter/implementations/test-utilities/_module-exports.js

@@ -0,0 +1,4 @@
+export * from "../../../rate-limiter/implementations/test-utilities/fixed-window-limiter.test-suite.js";
+export * from "../../../rate-limiter/implementations/test-utilities/rate-limiter-storage-adapter.test-suite.js";
+export * from "../../../rate-limiter/implementations/test-utilities/sliding-window-limiter.test-suite.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/rate-limiter/implementations/test-utilities/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/test-utilities/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,kFAAkF,CAAC;AACjG,cAAc,0FAA0F,CAAC;AACzG,cAAc,oFAAoF,CAAC"}

package/dist/rate-limiter/implementations/test-utilities/_module.d.ts

@@ -0,0 +1,3 @@
+export * from "../../../rate-limiter/implementations/test-utilities/fixed-window-limiter.test-suite.js";
+export * from "../../../rate-limiter/implementations/test-utilities/rate-limiter-storage-adapter.test-suite.js";
+export * from "../../../rate-limiter/implementations/test-utilities/sliding-window-limiter.test-suite.js";

package/dist/rate-limiter/implementations/test-utilities/_module.js

@@ -0,0 +1,4 @@
+export * from "../../../rate-limiter/implementations/test-utilities/fixed-window-limiter.test-suite.js";
+export * from "../../../rate-limiter/implementations/test-utilities/rate-limiter-storage-adapter.test-suite.js";
+export * from "../../../rate-limiter/implementations/test-utilities/sliding-window-limiter.test-suite.js";
+//# sourceMappingURL=_module.js.map

package/dist/rate-limiter/implementations/test-utilities/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/test-utilities/_module.ts"],"names":[],"mappings":"AAAA,cAAc,kFAAkF,CAAC;AACjG,cAAc,0FAA0F,CAAC;AACzG,cAAc,oFAAoF,CAAC"}

package/dist/rate-limiter/implementations/test-utilities/fixed-window-limiter.test-suite.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @module RateLimiter
+ */
+import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
+import { type ConstantBackoffSettingsEnum } from "../../../backoff-policies/_module.js";
+import { type IRateLimiterAdapter } from "../../../rate-limiter/contracts/_module.js";
+import { type FixedWindowLimiterSettingsEnum } from "../../../rate-limiter/implementations/policies/_module.js";
+import { type Promisable } from "../../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
+ * @group TestUtilities
+ */
+export type FixedWindowLimiterTestSuiteSettings = {
+    expect: ExpectStatic;
+    test: TestAPI;
+    describe: SuiteAPI;
+    beforeEach: typeof beforeEach;
+    createAdapter: () => Promisable<IRateLimiterAdapter>;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
+ * @group TestUtilities
+ *
+ * @example
+ * ```ts
+ * import { beforeEach, describe, expect, test } from "vitest";
+ * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
+ * import { FixedWindowLimiter } from "@daiso-tech/core/rate-limiter/policies";
+ * import { fixedWindowLimiterTestSuite } from "@daiso-tech/core/rate-limiter/test-utilities";
+ * import { constantBackoff } from "@daiso-tech/core/backoff-policies";
+ * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";
+ *
+ * describe("fixed-window-limiter class: DatabaseRateLimiterAdapter", () => {
+ *     fixedWindowLimiterTestSuite({
+ *         createAdapter: () => {
+ *             const adapter = new DatabaseRateLimiterAdapter({
+ *                 adapter: new MemoryRateLimiterStorageAdapter(),
+ *                 backoffPolicy: constantBackoff(
+ *                     fixedWindowLimiterTestSuite.backoffPolicySettings,
+ *                 ),
+ *                 rateLimiterPolicy: new FixedWindowLimiter(
+ *                     fixedWindowLimiterTestSuite.rateLimiterPolicySettings,
+ *                 ),
+ *             });
+ *             return adapter;
+ *         },
+ *         beforeEach,
+ *         describe,
+ *         expect,
+ *         test,
+ *     });
+ * });
+ * ```
+ */
+export declare function fixedWindowLimiterTestSuite(settings: FixedWindowLimiterTestSuiteSettings): void;
+export declare namespace fixedWindowLimiterTestSuite {
+    var rateLimiterPolicySettings: Required<FixedWindowLimiterSettingsEnum>;
+    var backoffPolicySettings: Required<ConstantBackoffSettingsEnum>;
+}

package/dist/rate-limiter/implementations/test-utilities/fixed-window-limiter.test-suite.js

@@ -0,0 +1,250 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "vitest";
+import { BACKOFFS, } from "../../../backoff-policies/_module.js";
+import {} from "../../../rate-limiter/contracts/_module.js";
+import { LIMITER_POLICIES, } from "../../../rate-limiter/implementations/policies/_module.js";
+import { Task } from "../../../task/implementations/_module.js";
+import { TimeSpan } from "../../../time-span/implementations/_module.js";
+import {} from "../../../utilities/_module.js";
+/**
+ * @group TestUtilities
+ */
+const rateLimiterPolicySettings = {
+    type: LIMITER_POLICIES.FIXED_WINDOW,
+    window: TimeSpan.fromMilliseconds(100),
+};
+/**
+ * @group TestUtilities
+ */
+const backoffPolicySettings = {
+    type: BACKOFFS.CONSTANT,
+    delay: TimeSpan.fromMilliseconds(50),
+    jitter: null,
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
+ * @group TestUtilities
+ *
+ * @example
+ * ```ts
+ * import { beforeEach, describe, expect, test } from "vitest";
+ * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
+ * import { FixedWindowLimiter } from "@daiso-tech/core/rate-limiter/policies";
+ * import { fixedWindowLimiterTestSuite } from "@daiso-tech/core/rate-limiter/test-utilities";
+ * import { constantBackoff } from "@daiso-tech/core/backoff-policies";
+ * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";
+ *
+ * describe("fixed-window-limiter class: DatabaseRateLimiterAdapter", () => {
+ *     fixedWindowLimiterTestSuite({
+ *         createAdapter: () => {
+ *             const adapter = new DatabaseRateLimiterAdapter({
+ *                 adapter: new MemoryRateLimiterStorageAdapter(),
+ *                 backoffPolicy: constantBackoff(
+ *                     fixedWindowLimiterTestSuite.backoffPolicySettings,
+ *                 ),
+ *                 rateLimiterPolicy: new FixedWindowLimiter(
+ *                     fixedWindowLimiterTestSuite.rateLimiterPolicySettings,
+ *                 ),
+ *             });
+ *             return adapter;
+ *         },
+ *         beforeEach,
+ *         describe,
+ *         expect,
+ *         test,
+ *     });
+ * });
+ * ```
+ */
+export function fixedWindowLimiterTestSuite(settings) {
+    const { expect, test, createAdapter, describe, beforeEach } = settings;
+    let adapter;
+    describe("Reusable tests:", () => {
+        beforeEach(async () => {
+            adapter = await createAdapter();
+        });
+        const KEY = "a";
+        const LIMIT = 4;
+        async function delay(timeSpan) {
+            await Task.delay(timeSpan);
+        }
+        describe("method: getState", () => {
+            test("Should return null when updateState method have not been called", async () => {
+                const state = await adapter.getState(KEY);
+                expect(state).toBeNull();
+            });
+            test("Should return AllowedState attempt when 3 attempts occurs during window time", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state = await adapter.getState(KEY);
+                expect(state).toEqual({
+                    success: true,
+                    attempt: 3,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+            test("Should return AllowedState attempt when 4 attempts occurs during window time", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state = await adapter.getState(KEY);
+                expect(state).toEqual({
+                    success: true,
+                    attempt: 4,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+            test("Should return null when 4 attempts occurs during window time and resetTime is awaited", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state1 = await adapter.updateState(KEY, LIMIT);
+                await delay(state1.resetTime.addMilliseconds(10));
+                const state2 = await adapter.getState(KEY);
+                expect(state2).toBeNull();
+            });
+            test("Should return BlockedState when 5 attempts occurs during window time", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state = await adapter.getState(KEY);
+                expect(state).toEqual({
+                    success: false,
+                    attempt: 1,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+            test("Should return BlockedState attempt when 6 attempts occurs during window time", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state = await adapter.getState(KEY);
+                expect(state).toEqual({
+                    success: false,
+                    attempt: 2,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+            test("Should return null when 6 attempts occurs during window time and resetTime is awaited", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state1 = await adapter.updateState(KEY, LIMIT);
+                await delay(state1.resetTime.addMilliseconds(10));
+                const state2 = await adapter.getState(KEY);
+                expect(state2).toBeNull();
+            });
+        });
+        describe("method: updateState", () => {
+            test("Should return AllowedState with incremented attempt when 3 attempts occurs during window time", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state = await adapter.updateState(KEY, LIMIT);
+                expect(state).toEqual({
+                    success: true,
+                    attempt: 3,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+            test("Should return AllowedState with incremented attempt when 4 attempts occurs during window time", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state = await adapter.updateState(KEY, LIMIT);
+                expect(state).toEqual({
+                    success: true,
+                    attempt: 4,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+            test("Should return reseted AllowedState when 4 attempts occurs during window time and resetTime is awaited", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state1 = await adapter.updateState(KEY, LIMIT);
+                await delay(state1.resetTime.addMilliseconds(10));
+                const state2 = await adapter.updateState(KEY, LIMIT);
+                expect(state2).toEqual({
+                    success: true,
+                    attempt: 1,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+            test("Should return BlockedState when 5 attempts occurs during window time", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state = await adapter.updateState(KEY, LIMIT);
+                expect(state).toEqual({
+                    success: false,
+                    attempt: 1,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+            test("Should return BlockedState with incremented attempt when 6 attempts occurs during window time", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state = await adapter.updateState(KEY, LIMIT);
+                expect(state).toEqual({
+                    success: false,
+                    attempt: 2,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+            test("Should return reseted AllowedState when 6 attempts occurs during window time and resetTime is awaited", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                const state1 = await adapter.updateState(KEY, LIMIT);
+                await delay(state1.resetTime.addMilliseconds(10));
+                const state2 = await adapter.updateState(KEY, LIMIT);
+                expect(state2).toEqual({
+                    success: true,
+                    attempt: 1,
+                    resetTime: expect.any(TimeSpan),
+                });
+            });
+        });
+        describe("method: reset", () => {
+            test("Should return null when reseted in AllowedState", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.reset(KEY);
+                const state = await adapter.getState(KEY);
+                expect(state).toBeNull();
+            });
+            test("Should return null when reseted in BlockedState", async () => {
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.updateState(KEY, LIMIT);
+                await adapter.reset(KEY);
+                const state = await adapter.getState(KEY);
+                expect(state).toBeNull();
+            });
+        });
+    });
+}
+fixedWindowLimiterTestSuite.rateLimiterPolicySettings =
+    rateLimiterPolicySettings;
+fixedWindowLimiterTestSuite.backoffPolicySettings = backoffPolicySettings;
+//# sourceMappingURL=fixed-window-limiter.test-suite.js.map

package/dist/rate-limiter/implementations/test-utilities/fixed-window-limiter.test-suite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixed-window-limiter.test-suite.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/test-utilities/fixed-window-limiter.test-suite.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAKN,MAAM,QAAQ,CAAC;AAEhB,OAAO,EACH,QAAQ,GAEX,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAGN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACH,gBAAgB,GAEnB,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAClE,OAAO,EAAmB,MAAM,wBAAwB,CAAC;AAezD;;GAEG;AACH,MAAM,yBAAyB,GAA6C;IACxE,IAAI,EAAE,gBAAgB,CAAC,YAAY;IACnC,MAAM,EAAE,QAAQ,CAAC,gBAAgB,CAAC,GAAG,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAA0C;IACjE,IAAI,EAAE,QAAQ,CAAC,QAAQ;IACvB,KAAK,EAAE,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;IACpC,MAAM,EAAE,IAAI;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,UAAU,2BAA2B,CACvC,QAA6C;IAE7C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;IACvE,IAAI,OAA4B,CAAC;IACjC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC7B,UAAU,CAAC,KAAK,IAAI,EAAE;YAClB,OAAO,GAAG,MAAM,aAAa,EAAE,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,GAAG,CAAC;QAChB,MAAM,KAAK,GAAG,CAAC,CAAC;QAChB,KAAK,UAAU,KAAK,CAAC,QAAkB;YACnC,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/B,CAAC;QAED,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;YAC9B,IAAI,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;gBAC/E,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAE1C,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC7B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,8EAA8E,EAAE,KAAK,IAAI,EAAE;gBAC5F,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAE1C,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;oBAClB,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,8EAA8E,EAAE,KAAK,IAAI,EAAE;gBAC5F,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAE1C,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;oBAClB,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;gBACrG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACrD,MAAM,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;gBAElD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;gBACpF,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAE1C,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;oBAClB,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,8EAA8E,EAAE,KAAK,IAAI,EAAE;gBAC5F,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAE1C,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;oBAClB,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;gBACrG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACrD,MAAM,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;gBAElD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;YACjC,IAAI,CAAC,+FAA+F,EAAE,KAAK,IAAI,EAAE;gBAC7G,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEpD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;oBAClB,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,+FAA+F,EAAE,KAAK,IAAI,EAAE;gBAC7G,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEpD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;oBAClB,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,uGAAuG,EAAE,KAAK,IAAI,EAAE;gBACrH,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACrD,MAAM,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;gBAElD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACrD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;gBACpF,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEpD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;oBAClB,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,+FAA+F,EAAE,KAAK,IAAI,EAAE;gBAC7G,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEpD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;oBAClB,OAAO,EAAE,KAAK;oBACd,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,uGAAuG,EAAE,KAAK,IAAI,EAAE;gBACrH,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACrD,MAAM,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;gBAElD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACrD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;oBACnB,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAa;iBACX,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;YAC3B,IAAI,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;gBAC/D,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACzB,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAE1C,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC7B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;gBAC/D,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACtC,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAEtC,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACzB,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAE1C,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC7B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC;AAED,2BAA2B,CAAC,yBAAyB;IACjD,yBAAyB,CAAC;AAC9B,2BAA2B,CAAC,qBAAqB,GAAG,qBAAqB,CAAC"}

package/dist/rate-limiter/implementations/test-utilities/rate-limiter-storage-adapter.test-suite.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @module RateLimiter
+ */
+import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
+import { type IRateLimiterStorageAdapter } from "../../../rate-limiter/contracts/_module.js";
+import { type Promisable } from "../../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
+ * @group TestUtilities
+ */
+export type RateLimiterStorageAdapterTestSuiteSettings = {
+    expect: ExpectStatic;
+    test: TestAPI;
+    describe: SuiteAPI;
+    beforeEach: typeof beforeEach;
+    createAdapter: () => Promisable<IRateLimiterStorageAdapter>;
+};
+/**
+ * The `rateLimiterStorageAdapterTestSuite` function simplifies the process of testing your custom implementation of {@link IRateLimiterStorageAdapter | `IRateLimiterStorageAdapter`} with `vitest`.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
+ * @group TestUtilities
+ * @example
+ * ```ts
+ * import { afterEach, beforeEach, describe, expect, test } from "vitest";
+ * import { rateLimiterStorageAdapterTestSuite } from "@daiso-tech/core/rate-limiter/test-utilities";
+ * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";
+ * import { TimeSpan } from "@daiso-tech/core/time-span" from "@daiso-tech/core/time-span";
+ * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
+ * import { Serde } from "@daiso-tech/core/serde";
+ *
+ * describe("class: MemoryRateLimiterStorageAdapter", () => {
+ *     rateLimiterStorageAdapterTestSuite({
+ *         createAdapter: () =>
+ *             new MemoryRateLimiterStorageAdapter(),
+ *         test,
+ *         beforeEach,
+ *         expect,
+ *         describe,
+ *     });
+ * });
+ * ```
+ */
+export declare function rateLimiterStorageAdapterTestSuite(settings: RateLimiterStorageAdapterTestSuiteSettings): void;

package/dist/rate-limiter/implementations/test-utilities/rate-limiter-storage-adapter.test-suite.js

@@ -0,0 +1,102 @@
+/**
+ * @module RateLimiter
+ */
+import {} from "vitest";
+import {} from "../../../rate-limiter/contracts/_module.js";
+import { TimeSpan } from "../../../time-span/implementations/time-span.js";
+import {} from "../../../utilities/_module.js";
+/**
+ * The `rateLimiterStorageAdapterTestSuite` function simplifies the process of testing your custom implementation of {@link IRateLimiterStorageAdapter | `IRateLimiterStorageAdapter`} with `vitest`.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
+ * @group TestUtilities
+ * @example
+ * ```ts
+ * import { afterEach, beforeEach, describe, expect, test } from "vitest";
+ * import { rateLimiterStorageAdapterTestSuite } from "@daiso-tech/core/rate-limiter/test-utilities";
+ * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";
+ * import { TimeSpan } from "@daiso-tech/core/time-span" from "@daiso-tech/core/time-span";
+ * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
+ * import { Serde } from "@daiso-tech/core/serde";
+ *
+ * describe("class: MemoryRateLimiterStorageAdapter", () => {
+ *     rateLimiterStorageAdapterTestSuite({
+ *         createAdapter: () =>
+ *             new MemoryRateLimiterStorageAdapter(),
+ *         test,
+ *         beforeEach,
+ *         expect,
+ *         describe,
+ *     });
+ * });
+ * ```
+ */
+export function rateLimiterStorageAdapterTestSuite(settings) {
+    const { expect, test, createAdapter, describe, beforeEach } = settings;
+    let adapter;
+    describe("Reusable tests:", () => {
+        beforeEach(async () => {
+            adapter =
+                (await createAdapter());
+        });
+        describe("method: transaction upsert / find", () => {
+            test("Should insert item when key doesnt exists", async () => {
+                const key = "a";
+                const value = "b";
+                const expiration = TimeSpan.fromMinutes(5).toEndDate(new Date("2026-01-01"));
+                const data = await adapter.transaction(async (trx) => {
+                    await trx.upsert(key, value, expiration);
+                    return await trx.find(key);
+                });
+                expect(data).toEqual({
+                    state: value,
+                    expiration,
+                });
+            });
+            test("Should update item when key exists", async () => {
+                const key = "d";
+                const value = "f";
+                const expiration = TimeSpan.fromHours(5).toEndDate(new Date("2026-01-01"));
+                const data = await adapter.transaction(async (trx) => {
+                    await trx.upsert("a", "b", TimeSpan.fromMinutes(5).toEndDate(new Date("2026-01-01")));
+                    await trx.upsert(key, value, expiration);
+                    return await trx.find(key);
+                });
+                expect(data).toEqual({
+                    state: value,
+                    expiration,
+                });
+            });
+        });
+        describe("method: transaction find", () => {
+            test("Should return null when key doesnt exists", async () => {
+                const noneExistingKey = "a";
+                const data = await adapter.transaction(async (trx) => {
+                    return await trx.find(noneExistingKey);
+                });
+                expect(data).toBeNull();
+            });
+        });
+        describe("method: find", () => {
+            test("Should return null when key doesnt exists", async () => {
+                const noneExistingKey = "a";
+                const data = await adapter.find(noneExistingKey);
+                expect(data).toBeNull();
+            });
+        });
+        describe("method: remove", () => {
+            test("Should remove item when key exists", async () => {
+                const key = "a";
+                const value = "b";
+                const expiration = TimeSpan.fromMinutes(5).toEndDate(new Date("2026-01-01"));
+                await adapter.transaction(async (trx) => {
+                    await trx.upsert(key, value, expiration);
+                });
+                await adapter.remove(key);
+                const item = await adapter.find(key);
+                expect(item).toBeNull();
+            });
+        });
+    });
+}
+//# sourceMappingURL=rate-limiter-storage-adapter.test-suite.js.map

package/dist/rate-limiter/implementations/test-utilities/rate-limiter-storage-adapter.test-suite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limiter-storage-adapter.test-suite.js","sourceRoot":"","sources":["../../../../src/rate-limiter/implementations/test-utilities/rate-limiter-storage-adapter.test-suite.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAKN,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAGN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,0CAA0C,CAAC;AACpE,OAAO,EAAmB,MAAM,wBAAwB,CAAC;AAezD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,kCAAkC,CAC9C,QAAoD;IAEpD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;IACvE,IAAI,OAA2C,CAAC;IAEhD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC7B,UAAU,CAAC,KAAK,IAAI,EAAE;YAClB,OAAO;gBACH,CAAC,MAAM,aAAa,EAAE,CAAuC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC/C,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;gBACzD,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAChD,IAAI,IAAI,CAAC,YAAY,CAAC,CACzB,CAAC;gBAEF,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;oBACjD,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;oBACzC,OAAO,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC/B,CAAC,CAAC,CAAC;gBAEH,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;oBACjB,KAAK,EAAE,KAAK;oBACZ,UAAU;iBACsB,CAAC,CAAC;YAC1C,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,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAC9C,IAAI,IAAI,CAAC,YAAY,CAAC,CACzB,CAAC;gBAEF,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;oBACjD,MAAM,GAAG,CAAC,MAAM,CACZ,GAAG,EACH,GAAG,EACH,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAC7B,IAAI,IAAI,CAAC,YAAY,CAAC,CACzB,CACJ,CAAC;oBACF,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;oBACzC,OAAO,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC/B,CAAC,CAAC,CAAC;gBAEH,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;oBACjB,KAAK,EAAE,KAAK;oBACZ,UAAU;iBACsB,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;YACtC,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;gBACzD,MAAM,eAAe,GAAG,GAAG,CAAC;gBAE5B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;oBACjD,OAAO,MAAM,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC3C,CAAC,CAAC,CAAC;gBAEH,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC5B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;YAC1B,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;gBACzD,MAAM,eAAe,GAAG,GAAG,CAAC;gBAE5B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAEjD,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC5B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAC5B,IAAI,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;gBAClD,MAAM,GAAG,GAAG,GAAG,CAAC;gBAChB,MAAM,KAAK,GAAG,GAAG,CAAC;gBAClB,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAChD,IAAI,IAAI,CAAC,YAAY,CAAC,CACzB,CAAC;gBAEF,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;oBACpC,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;gBAC7C,CAAC,CAAC,CAAC;gBACH,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC1B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAErC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC5B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/rate-limiter/implementations/test-utilities/sliding-window-limiter.test-suite.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @module RateLimiter
+ */
+import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
+import { type ConstantBackoffSettingsEnum } from "../../../backoff-policies/_module.js";
+import { type IRateLimiterAdapter } from "../../../rate-limiter/contracts/_module.js";
+import { type SlidingWindowLimiterSettings } from "../../../rate-limiter/implementations/policies/_module.js";
+import { type Promisable } from "../../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
+ * @group TestUtilities
+ */
+export type SlidingWindowLimiterTestSuiteSettings = {
+    expect: ExpectStatic;
+    test: TestAPI;
+    describe: SuiteAPI;
+    beforeEach: typeof beforeEach;
+    createAdapter: () => Promisable<IRateLimiterAdapter>;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/rate-limiter/test-utilities"`
+ * @group TestUtilities
+ *
+ * @example
+ * ```ts
+ * import { beforeEach, describe, expect, test } from "vitest";
+ * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
+ * import { SlidingWindowLimiter } from "@daiso-tech/core/rate-limiter/policies";
+ * import { slidingWindowLimiterTestSuite } from "@daiso-tech/core/rate-limiter/test-utilities";
+ * import { constantBackoff } from "@daiso-tech/core/backoff-policies";
+ * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storage-adapter";
+ *
+ * describe("sliding-window-limiter class: DatabaseRateLimiterAdapter", () => {
+ *     slidingWindowLimiterTestSuite({
+ *         createAdapter: () => {
+ *             const adapter = new DatabaseRateLimiterAdapter({
+ *                 adapter: new MemoryRateLimiterStorageAdapter(),
+ *                 backoffPolicy: constantBackoff(
+ *                     slidingWindowLimiterTestSuite.backoffPolicySettings,
+ *                 ),
+ *                 rateLimiterPolicy: new SlidingWindowLimiter(
+ *                     slidingWindowLimiterTestSuite.rateLimiterPolicySettings,
+ *                 ),
+ *             });
+ *             return adapter;
+ *         },
+ *         beforeEach,
+ *         describe,
+ *         expect,
+ *         test,
+ *     });
+ * });
+ * ```
+ */
+export declare function slidingWindowLimiterTestSuite(settings: SlidingWindowLimiterTestSuiteSettings): void;
+export declare namespace slidingWindowLimiterTestSuite {
+    var rateLimiterPolicySettings: Required<SlidingWindowLimiterSettings>;
+    var backoffPolicySettings: Required<ConstantBackoffSettingsEnum>;
+}