CircuitBreaker provider resolver classes

pro

The CircuitBreakerFactoryResolver class provides a flexible way to configure and switch between different circuit-breaker adapters at runtime.

Initial configuration

To begin using the CircuitBreakerFactoryResolver, You will need to register all required adapters during initialization.

./samples/circuit-breaker-factory-resolver-initial-config.ts

import { CircuitBreakerFactoryResolver } from "eridu-tech/circuit-breaker";
import { MemoryCircuitBreakerStorageAdapter } from "eridu-tech/circuit-breaker/memory-circuit-breaker-storage-adapter";
import { DatabaseCircuitBreakerAdapter } from "eridu-tech/circuit-breaker/database-circuit-breaker-adapter";
import { RedisCircuitBreakerAdapter } from "eridu-tech/circuit-breaker/redis-circuit-breaker-adapter";
import { Serde } from "eridu-tech/serde";
import { SuperJsonSerdeAdapter } from "eridu-tech/serde/super-json-serde-adapter";
import { Redis } from "ioredis";

const serde = new Serde(new SuperJsonSerdeAdapter());
export const circuitBreakerFactoryResolver = new CircuitBreakerFactoryResolver({
    serde,
    adapters: {
        memory: new DatabaseCircuitBreakerAdapter({
            adapter: new MemoryCircuitBreakerStorageAdapter(),
        }),
        redis: new RedisCircuitBreakerAdapter({
            database: new Redis("YOUR_REDIS_CONNECTION"),
        }),
    },
    defaultAdapter: "memory",
});

Usage

1. Using the default adapter

./samples/circuit-breaker-factory-resolver-default-adapter.ts

import { circuitBreakerFactoryResolver } from "./circuit-breaker-factory-resolver-initial-config.js";

// Will apply circuit-breaker logic the default adapter which is MemoryCircuitBreakerStorageAdapter
await circuitBreakerFactoryResolver
    .use()
    .create("a")
    .runOrFail(async () => {
        // ... code to apply circuit-breaker logic
    });

danger

Note that if you dont set a default adapter, an error will be thrown.

2. Specifying an adapter explicitly

./samples/circuit-breaker-factory-resolver-specific-adapter.ts

import { circuitBreakerFactoryResolver } from "./circuit-breaker-factory-resolver-initial-config.js";

// Will apply circuit-breaker logic using the redis adapter
await circuitBreakerFactoryResolver
    .use("redis")
    .create("a")
    .runOrFail(async () => {
        // ... code to apply circuit-breaker logic
    });

danger

Note that if you specify a non-existent adapter, an error will be thrown.

3. Overriding default settings

./samples/circuit-breaker-factory-resolver-override-settings.ts

import { circuitBreakerFactoryResolver } from "./circuit-breaker-factory-resolver-initial-config.js";
import { CIRCUIT_BREAKER_TRIGGER } from "eridu-tech/circuit-breaker/contracts";

await circuitBreakerFactoryResolver
    .setDefaultTrigger(CIRCUIT_BREAKER_TRIGGER.ONLY_ERROR)
    .use("redis")
    .create("a")
    .runOrFail(async () => {
        // ... code to apply circuit-breaker logic
    });

info

Note that the CircuitBreakerFactoryResolver is immutable, meaning any configuration override returns a new instance rather than modifying the existing one.

DatabaseCircuitBreakerFactoryResolver

The DatabaseCircuitBreakerFactoryResolver class provides a flexible way to configure and switch between different circuit-breaker-storage adapters at runtime.

Initial configuration

To begin using the DatabaseCircuitBreakerFactoryResolver, You will need to register all required adapters during initialization.

./samples/database-circuit-breaker-factory-resolver-initial-config.ts

import { DatabaseCircuitBreakerFactoryResolver } from "eridu-tech/circuit-breaker";
import { MemoryCircuitBreakerStorageAdapter } from "eridu-tech/circuit-breaker/memory-circuit-breaker-storage-adapter";
import { KyselyCircuitBreakerStorageAdapter } from "eridu-tech/circuit-breaker/kysely-circuit-breaker-storage-adapter";
import { Serde } from "eridu-tech/serde";
import { SuperJsonSerdeAdapter } from "eridu-tech/serde/super-json-serde-adapter";
import Sqlite from "better-sqlite3";
import { Kysely, SqliteDialect } from "kysely";
import { TransactionContext } from "eridu-tech/transaction-context";
import { contextToken } from "eridu-tech/execution-context/contracts";
import { ExecutionContext } from "eridu-tech/execution-context";
import { AlsExecutionContextAdapter } from "eridu-tech/execution-context/als-execution-context-adapter";
import { KyselyTransactionAdapter } from "eridu-tech/transaction-context/kysely-transaction-adapter";

const serde = new Serde(new SuperJsonSerdeAdapter());
const kysely = new Kysely<any>({
    dialect: new SqliteDialect({
        database: new Sqlite("local.db"),
    }),
});
const kyselyTransactionAdapter = new KyselyTransactionAdapter({
    database: kysely,
});
const executionContext = new ExecutionContext(new AlsExecutionContextAdapter());
const transactionContext = new TransactionContext<Kysely<any>>({
    token: contextToken("kysely"),
    executionContext,
    adapter: kyselyTransactionAdapter,
});

export const circuitBreakerFactoryResolver =
    new DatabaseCircuitBreakerFactoryResolver({
        serde,
        adapters: {
            memory: new MemoryCircuitBreakerStorageAdapter(),
            sqlite: new KyselyCircuitBreakerStorageAdapter({
                transactionContext,
                serde,
            }),
        },
        defaultAdapter: "memory",
    });

Usage

1. Using the default adapter

./samples/database-circuit-breaker-factory-resolver-default-adapter.ts

import { circuitBreakerFactoryResolver } from "./database-circuit-breaker-factory-resolver-initial-config.js";

// Will apply circuit-breaker logic the default adapter which is MemoryCircuitBreakerStorageAdapter
await circuitBreakerFactoryResolver
    .use()
    .create("a")
    .runOrFail(async () => {
        // ... code to apply circuit-breaker logic
    });

danger

Note that if you dont set a default adapter, an error will be thrown.

2. Specifying an adapter explicitly

./samples/database-circuit-breaker-factory-resolver-specific-adapter.ts

import { circuitBreakerFactoryResolver } from "./database-circuit-breaker-factory-resolver-initial-config.js";

// Will apply circuit-breaker logic using the sqlite adapter
await circuitBreakerFactoryResolver
    .use("sqlite")
    .create("a")
    .runOrFail(async () => {
        // ... code to apply circuit-breaker logic
    });

danger

Note that if you specify a non-existent adapter, an error will be thrown.

3. Overriding default settings

./samples/database-circuit-breaker-factory-resolver-override-settings.ts

import { CountBreaker } from "eridu-tech/circuit-breaker/policies";
import { constantBackoff } from "eridu-tech/backoff-policies";
import { circuitBreakerFactoryResolver } from "./database-circuit-breaker-factory-resolver-initial-config.js";

await circuitBreakerFactoryResolver
    .setDefaultBackoffPolicy(constantBackoff())
    .setDefaultCircuitBreakerPolicy(new CountBreaker())
    .use("sqlite")
    .create("a")
    .runOrFail(async () => {
        // ... code to apply circuit-breaker logic
    });

info

Note that the DatabaseCircuitBreakerFactoryResolver is immutable, meaning any configuration override returns a new instance rather than modifying the existing one.

Further information

For further information refer to eridu-tech/circuit-breaker API docs.