@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
156 lines • 6.01 kB
JavaScript
/**
* @module RateLimiter
*/
import {} from "../../../../backoff-policies/_module.js";
import {} from "../../../../event-bus/contracts/_module.js";
import {} from "../../../../namespace/_module.js";
import {} from "../../../../rate-limiter/contracts/_module.js";
import { DatabaseRateLimiterAdapter } from "../../../../rate-limiter/implementations/adapters/database-rate-limiter-adapter/_module.js";
import { RateLimiterProvider, DEFAULT_CIRCUIT_BREAKER_PROVIDER_NAMESPACE, } from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider/_module.js";
import {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
UnregisteredAdapterError,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
DefaultAdapterNotDefinedError, } from "../../../../utilities/_module.js";
/**
* The `DatabaseRateLimiterProviderFactory` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
* @group Derivables
*/
export class DatabaseRateLimiterProviderFactory {
settings;
/**
* @example
* ```ts
* import { RateLimiterProviderFactory } from "@daiso-tech/core/rate-limiter";
* import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter";
* import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storate-adapter";
* import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
* import Sqlite from "better-sqlite3";
* import { Kysely, SqliteDialect } from "kysely";
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const rateLimiterProviderFactory = new RateLimiterProviderFactory({
* serde,
* adapters: {
* memory: new MemoryRateLimiterStorageAdapter(),
* sqlite: new KyselyRateLimiterStorageAdapter({
* kysely: new Kysely({
* dialect: new SqliteDialect({
* database: new Sqlite("local.db"),
* }),
* }),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
* ```
*/
constructor(settings) {
this.settings = settings;
}
setNamespace(namespace) {
return new DatabaseRateLimiterProviderFactory({
...this.settings,
namespace,
});
}
setEventBus(eventBus) {
return new DatabaseRateLimiterProviderFactory({
...this.settings,
eventBus,
});
}
setOnlyError(onlyError) {
return new DatabaseRateLimiterProviderFactory({
...this.settings,
onlyError,
});
}
setErrorPolicy(errorPolicy) {
return new DatabaseRateLimiterProviderFactory({
...this.settings,
errorPolicy,
});
}
setBackoffPolicy(backoffPolicy) {
return new DatabaseRateLimiterProviderFactory({
...this.settings,
backoffPolicy,
});
}
setRateLimiterPolicy(rateLimiterPolicy) {
return new DatabaseRateLimiterProviderFactory({
...this.settings,
rateLimiterPolicy,
});
}
/**
* @example
* ```ts
* import { RateLimiterProviderFactory } from "@daiso-tech/core/rate-limiter";
* import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter";
* import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storate-adapter";
* import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
* import Sqlite from "better-sqlite3";
* import { Kysely, SqliteDialect } from "kysely";
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const rateLimiterProviderFactory = new RateLimiterProviderFactory({
* serde,
* adapters: {
* memory: new MemoryRateLimiterStorageAdapter(),
* sqlite: new KyselyRateLimiterStorageAdapter({
* kysely: new Kysely({
* dialect: new SqliteDialect({
* database: new Sqlite("local.db"),
* }),
* }),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
*
* // Will apply rate limiter logic the default adapter which is MemoryRateLimiterStorageAdapter
* await rateLimiterProviderFactory
* .use()
* .create("a")
* .runOrFail(async () => {
* // ... code to apply rate limiter logic
* });
*
* // Will apply rate limiter logic the default adapter which is KyselyRateLimiterStorageAdapter
* await rateLimiterProviderFactory
* .use("sqlite")
* .create("a")
* .runOrFail(async () => {
* // ... code to apply rate limiter logic
* });
* ```
*/
use(adapterName = this.settings.defaultAdapter) {
if (adapterName === undefined) {
throw new DefaultAdapterNotDefinedError(DatabaseRateLimiterProviderFactory.name);
}
const adapter = this.settings.adapters[adapterName];
if (adapter === undefined) {
throw new UnregisteredAdapterError(adapterName);
}
const { namespace = DEFAULT_CIRCUIT_BREAKER_PROVIDER_NAMESPACE } = this.settings;
return new RateLimiterProvider({
...this.settings,
adapter: new DatabaseRateLimiterAdapter({
adapter,
}),
namespace: namespace.appendRoot(adapterName),
});
}
}
//# sourceMappingURL=database-rate-limiter-provider-factory.js.map