@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.
138 lines (137 loc) • 6.26 kB
TypeScript
/**
* @module CircuitBreaker
*/
import { type BackoffPolicy } from "../../../../backoff-policies/_module.js";
import { type ICircuitBreakerProviderFactory, type CircuitBreakerTrigger, type ICircuitBreakerProvider, type ICircuitBreakerStorageAdapter, type ICircuitBreakerPolicy } from "../../../../circuit-breaker/contracts/_module.js";
import { type CircuitBreakerProviderSettingsBase } from "../../../../circuit-breaker/implementations/derivables/circuit-breaker-provider/_module.js";
import { type IEventBus } from "../../../../event-bus/contracts/_module.js";
import { type Namespace } from "../../../../namespace/_module.js";
import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
import { type ErrorPolicy } from "../../../../utilities/_module.js";
/**
*
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker"`
* @group Derivables
*/
export type DatabaseCircuitBreakerAdapters<TAdapters extends string> = Partial<Record<TAdapters, ICircuitBreakerStorageAdapter>>;
/**
*
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker"`
* @group Derivables
*/
export type DatabaseCircuitBreakerProviderFactorySettings<TAdapters extends string> = CircuitBreakerProviderSettingsBase & {
adapters: DatabaseCircuitBreakerAdapters<TAdapters>;
defaultAdapter?: NoInfer<TAdapters>;
/**
* @default
* ```ts
* import { exponentialBackoff } from "@daiso-tech/core/backoff-policies";
*
* exponentialBackoff();
* ```
*/
backoffPolicy?: BackoffPolicy;
/**
* @default
* ```ts
* import { ConsecutiveBreaker } from "@daiso-tech/core/circuit-breaker/policies";
*
* new ConsecutiveBreaker();
* ```
*/
circuitBreakerPolicy?: ICircuitBreakerPolicy;
};
/**
* The `DatabaseCircuitBreakerProviderFactory` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker"`
* @group Derivables
*/
export declare class DatabaseCircuitBreakerProviderFactory<TAdapters extends string> implements ICircuitBreakerProviderFactory<TAdapters> {
private readonly settings;
/**
* @example
* ```ts
* import { DatabaseCircuitBreakerProviderFactory } from "@daiso-tech/core/circuit-breaker";
* import { MemoryCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/memory-circuit-breaker-storate-adapter";
* import { KyselyCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/kysely-circuit-breaker-storate-adapter";
* import { DatabaseCircuitBreakerAdapter } from "@daiso-tech/core/circuit-breaker/database-circuit-breaker-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 circuitBreakerProviderFactory = new DatabaseCircuitBreakerProviderFactory({
* serde,
* adapters: {
* memory: new MemoryCircuitBreakerStorageAdapter(),
* sqlite: new KyselyCircuitBreakerStorageAdapter({
* kysely: new Kysely({
* dialect: new SqliteDialect({
* database: new Sqlite("local.db"),
* }),
* }),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
* ```
*/
constructor(settings: DatabaseCircuitBreakerProviderFactorySettings<TAdapters>);
setNamespace(namespace: Namespace): DatabaseCircuitBreakerProviderFactory<TAdapters>;
setEventBus(eventBus: IEventBus): DatabaseCircuitBreakerProviderFactory<TAdapters>;
setSlowCallTime(slowCallTime?: ITimeSpan): DatabaseCircuitBreakerProviderFactory<TAdapters>;
setTrigger(trigger?: CircuitBreakerTrigger): DatabaseCircuitBreakerProviderFactory<TAdapters>;
setDefaultErrorPolicy(defaultErrorPolicy: ErrorPolicy): DatabaseCircuitBreakerProviderFactory<TAdapters>;
setDefaultBackoffPolicy(backoffPolicy?: BackoffPolicy): DatabaseCircuitBreakerProviderFactory<TAdapters>;
setDefaultCircuitBreakerPolicy(circuitBreakerPolicy?: ICircuitBreakerPolicy): DatabaseCircuitBreakerProviderFactory<TAdapters>;
/**
* @example
* ```ts
* import { DatabaseCircuitBreakerProviderFactory } from "@daiso-tech/core/circuit-breaker";
* import { MemoryCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/memory-circuit-breaker-storate-adapter";
* import { KyselyCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/kysely-circuit-breaker-storate-adapter";
* import { DatabaseCircuitBreakerAdapter } from "@daiso-tech/core/circuit-breaker/database-circuit-breaker-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 circuitBreakerProviderFactory = new DatabaseCircuitBreakerProviderFactory({
* serde,
* adapters: {
* memory: new MemoryCircuitBreakerStorageAdapter(),
* sqlite: new KyselyCircuitBreakerStorageAdapter({
* kysely: new Kysely({
* dialect: new SqliteDialect({
* database: new Sqlite("local.db"),
* }),
* }),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
*
* // Will apply circuit breaker logic the default adapter which is MemoryCircuitBreakerStorageAdapter
* await circuitBreakerProviderFactory
* .use()
* .create("a")
* .runOrFail(async () => {
* // ... code to apply circuit breaker logic
* });
*
* // Will apply circuit breaker logic using the KyselyCircuitBreakerStorageAdapter
* await circuitBreakerProviderFactory
* .use("sqlite")
* .create("a")
* .runOrFail(async () => {
* // ... code to apply circuit breaker logic
* });
* ```
*/
use(adapterName?: TAdapters | undefined): ICircuitBreakerProvider;
}