@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.
70 lines (69 loc) • 2.83 kB
TypeScript
/**
* @module CircuitBreaker
*/
import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
import { type ConstantBackoffSettingsEnum } from "../../../backoff-policies/implementations/_module.js";
import { type ICircuitBreakerAdapter } from "../../../circuit-breaker/contracts/_module.js";
import { type SamplingBreakerSettingsEnum } from "../../../circuit-breaker/implementations/policies/_module.js";
import { type ITimeSpan } from "../../../time-span/contracts/_module.js";
import { type Promisable } from "../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/test-utilities"`
* @group TestUtilities
*/
export type SamplingBreakerTestSuiteSettings = {
expect: ExpectStatic;
test: TestAPI;
describe: SuiteAPI;
beforeEach: typeof beforeEach;
createAdapter: () => Promisable<ICircuitBreakerAdapter>;
/**
* @default
* ```ts
* import { TimeSpan } from "@daiso-tech/core/time-span";
*
* TimeSpan.fromMilliseconds(10)
* ```
*/
delayBuffer?: ITimeSpan;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/test-utilities"`
* @group TestUtilities
*
* @example
* ```ts
* import { beforeEach, describe, expect, test } from "vitest";
* import { DatabaseCircuitBreakerAdapter } from "@daiso-tech/core/circuit-breaker/database-circuit-breaker-adapter";
* import { SamplingBreaker } from "@daiso-tech/core/circuit-breaker/policies";
* import { samplingBreakerTestSuite } from "@daiso-tech/core/circuit-breaker/test-utilities";
* import { constantBackoff } from "@daiso-tech/core/backoff-policies";
* import { MemoryCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/memory-circuit-breaker-storage-adapter";
*
* describe("sampling-breaker class: DatabaseCircuitBreakerAdapter", () => {
* samplingBreakerTestSuite({
* createAdapter: () => {
* const adapter = new DatabaseCircuitBreakerAdapter({
* adapter: new MemoryCircuitBreakerStorageAdapter(),
* backoffPolicy: constantBackoff(
* samplingBreakerTestSuite.backoffPolicySettings,
* ),
* circuitBreakerPolicy: new SamplingBreaker(
* samplingBreakerTestSuite.circuitBreakerPolicySettings,
* ),
* });
* return adapter;
* },
* beforeEach,
* describe,
* expect,
* test,
* });
* });
* ```
*/
export declare function samplingBreakerTestSuite(settings: SamplingBreakerTestSuiteSettings): void;
export declare namespace samplingBreakerTestSuite {
var circuitBreakerPolicySettings: Required<SamplingBreakerSettingsEnum>;
var backoffPolicySettings: Required<ConstantBackoffSettingsEnum>;
}