breaker-box 1.0.0

package/README.md

@@ -0,0 +1,125 @@
+![](./.readme/breaker-box.jpg)
+
+# Breaker Box
+
+A zero-dependency [circuit breaker][0] implementation for Node.js.
+
+[0]: https://martinfowler.com/bliki/CircuitBreaker.html
+
+## Installation
+
+```bash
+npm install breaker-box
+```
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { createCircuitBreaker } from "breaker-box"
+
+// Wrap an unreliable async function
+async function unreliableApiCall(data: string) {
+	const response = await fetch(`https://api.example.com/data/${data}`)
+	if (!response.ok) throw new Error("API call failed")
+	return response.json()
+}
+
+const protectedApiCall = createCircuitBreaker(unreliableApiCall, {
+	failureThreshold: 1, // Open circuit after first failure
+	resetAfter: 30_000, // Try again after 30 seconds
+	errorIsFailure: (error) => true,
+})
+
+try {
+	const result = await protectedApiCall("user-123")
+	console.log("Success:", result)
+} catch (error) {
+	console.error("Circuit breaker error:", error.message)
+}
+```
+
+### Event Monitoring
+
+```typescript
+const protectedFunction = createCircuitBreaker(unreliableApiCall)
+
+protectedFunction.on("open", (cause) => {
+	console.log("Circuit opened due to:", cause.message)
+})
+
+protectedFunction.on("close", () => {
+	console.log("Circuit closed - normal operation resumed")
+})
+
+protectedFunction.on("reject", (error) => {
+	console.log("Function call rejected:", error.message)
+})
+
+protectedFunction.on("resolve", () => {
+	console.log("Function call succeeded")
+})
+
+// Check current state
+console.log("Current state:", protectedFunction.getState())
+// Possible states: 'closed', 'open', 'halfOpen', 'disposed'
+```
+
+### Cleanup
+
+```typescript
+// Clean up resources when done
+protectedFunction.dispose()
+```
+
+## API
+
+### `createCircuitBreaker(fn, options?)`
+
+Creates a circuit breaker around the provided async function.
+
+#### Parameters
+
+- `fn`: The async function to protect
+- `options`: Configuration object (optional)
+    - `failureThreshold`: Number of failures before opening circuit (default: 1)
+    - `resetAfter`: Milliseconds to wait before trying again (default: 30000)
+    - `errorIsFailure`: Function to determine if an error counts as failure (default: all errors)
+    - `fallback`: Function to call when circuit is open (default: throws CircuitOpenError)
+
+#### Returns
+
+A function with the same signature as `fn` and additional methods:
+
+- `.getState()`: Returns current circuit state
+- `.on(event, listener)`: Add event listener
+- `.off(event, listener)`: Remove event listener
+- `.dispose()`: Clean up resources
+
+#### Events
+
+- `open`: Circuit opened due to failures
+- `close`: Circuit closed and resumed normal operation
+- `reject`: Function call was rejected
+- `resolve`: Function call succeeded
+
+### Development
+
+### Building the Project
+
+```sh
+npm run build
+```
+
+### Running Tests
+
+```sh
+npm test # once
+
+npm run dev # run and watch for file changes
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.

package/dist/index.cjs

@@ -0,0 +1,90 @@
+'use strict';
+
+var EventEmitter = require('node:events');
+
+const assertNever = (value, message = "Unexpected value") => (
+  /* v8 ignore next */
+  new TypeError(`${message}: ${value}`)
+);
+
+function createCircuitBreaker(main, options = {}) {
+  const events = new EventEmitter();
+  const {
+    errorIsFailure = () => true,
+    failureThreshold = 1,
+    fallback = () => {
+      const cause = failureCause;
+      const msg = cause instanceof Error ? cause.message : "Unknown";
+      throw new Error(`CircuitOpenError: ${msg}`, { cause });
+    },
+    resetAfter = 3e4
+  } = options;
+  let state = "closed";
+  let failureCause = void 0;
+  let failureCount = 0;
+  let resetTimer = void 0;
+  function openCircuit(cause) {
+    if (state === "disposed") return;
+    state = "open";
+    events.emit("open", cause);
+    failureCause = cause;
+    clearTimeout(resetTimer);
+    resetTimer = setTimeout(() => state = "halfOpen", resetAfter);
+  }
+  function closeCircuit() {
+    if (state === "disposed") return;
+    if (state === "halfOpen") events.emit("close");
+    state = "closed";
+    failureCause = void 0;
+    failureCount = 0;
+    clearTimeout(resetTimer);
+  }
+  const mainWithEmit = async (...args) => {
+    try {
+      const result = await main(...args);
+      events.emit("resolve");
+      closeCircuit();
+      return result;
+    } catch (cause) {
+      events.emit("reject", cause);
+      throw cause;
+    }
+  };
+  async function protectedFunction(...args) {
+    if (state === "open") {
+      return fallback(...args);
+    } else if (state === "halfOpen") {
+      return mainWithEmit(...args).catch((cause) => {
+        openCircuit(cause);
+        return fallback(...args);
+      });
+    } else if (state === "closed") {
+      return mainWithEmit(...args).catch((cause) => {
+        failureCause = cause;
+        failureCount += errorIsFailure(cause) ? 1 : 0;
+        if (failureCount >= failureThreshold) openCircuit(cause);
+        return fallback(...args);
+      });
+    } else if (state === "disposed")
+      throw new Error("Circuit breaker has been disposed");
+    else throw assertNever(state);
+  }
+  protectedFunction.dispose = () => {
+    events.removeAllListeners();
+    closeCircuit();
+    state = "disposed";
+  };
+  protectedFunction.getState = () => state;
+  protectedFunction.off = (event, listener) => {
+    events.removeListener(event, listener);
+    return protectedFunction;
+  };
+  protectedFunction.on = (event, listener) => {
+    events.addListener(event, listener);
+    return protectedFunction;
+  };
+  return protectedFunction;
+}
+
+exports.createCircuitBreaker = createCircuitBreaker;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../lib/util.ts","../lib/index.ts"],"sourcesContent":["export type AnyFn = (...args: any[]) => any\n\n/**\n * `[TypeScript]` For exhaustive checks in switch statements or if/else. Add\n * this check to `default` case or final `else` to ensure all possible values\n * have been handled. If a new value is added to the type, TypeScript will\n * throw an error and the editor will underline the `value`.\n */\nexport const assertNever = (value: never, message = \"Unexpected value\") =>\n\t/* v8 ignore next */\n\tnew TypeError(`${message}: ${value}`)\n","import { type AnyFn, assertNever } from \"./util.js\"\nimport EventEmitter from \"node:events\"\n\nexport type CircuitState = \"closed\" | \"disposed\" | \"halfOpen\" | \"open\"\n\nexport interface CircuitBreakerOptions<Args extends unknown[], Ret> {\n\t/**\n\t * Whether an error should be considered a failure that could trigger\n\t * the circuit breaker. Use this to prevent certain errors from\n\t * incrementing the failure count.\n\t * \n\t * @default () => true // Every error is considered a failure\n\t */\n\terrorIsFailure?: (error: unknown) => boolean\n\n\t/**\n\t * The number of failures before the circuit breaker opens.\n\t * \n\t * @default 1 // The first error opens the circuit\n\t */\n\tfailureThreshold?: number\n\n\t/**\n\t * If provided, then all rejected calls to `main` will be forwarded to\n\t * this function instead.\n\t * \n\t * @default undefined // No fallback, throws `CircuitOpenError`\n\t */\n\tfallback?: (...args: Args) => Promise<Ret>\n\n\t/**\n\t * The amount of time to wait before allowing a half-open state.\n\t * \n\t * @default 30_000 // 30 seconds\n\t */\n\tresetAfter?: number\n}\n\nexport interface EventMap {\n\tclose: []\n\topen: [cause: unknown]\n\treject: [cause: unknown]\n\tresolve: []\n}\n\nexport interface ProtectedFunction<Args extends unknown[], Ret> {\n\t(...args: Args): Promise<Ret>\n\n\t/** Free memory and stop timers */\n\tdispose(): void\n\n\t/** Get the current state of the circuit breaker */\n\tgetState(): CircuitState\n\n\t/** Remove a listener from the circuit breaker */\n\toff<T extends keyof EventMap>(\n\t\tevent: T,\n\t\tlistener: (...args: EventMap[T]) => void\n\t): this\n\n\t/** Add a listener to the circuit breaker */\n\ton<T extends keyof EventMap>(\n\t\tevent: T,\n\t\tlistener: (...args: EventMap[T]) => void\n\t): this\n}\n\nexport function createCircuitBreaker<Args extends unknown[], Ret>(\n\tmain: (...args: Args) => Promise<Ret>,\n\toptions: CircuitBreakerOptions<Args, Ret> = {}\n): ProtectedFunction<Args, Ret> {\n\tconst events = new EventEmitter<EventMap>()\n\tconst {\n\t\terrorIsFailure = () => true,\n\t\tfailureThreshold = 1,\n\t\tfallback = () => {\n\t\t\tconst cause = failureCause\n\t\t\tconst msg = cause instanceof Error ? cause.message : \"Unknown\"\n\t\t\tthrow new Error(`CircuitOpenError: ${msg}`, { cause })\n\t\t},\n\t\tresetAfter = 30_000,\n\t} = options\n\tlet state: CircuitState = \"closed\"\n\tlet failureCause: unknown | undefined = undefined\n\tlet failureCount = 0\n\tlet resetTimer: NodeJS.Timeout | undefined = undefined\n\n\t/**\n\t * Break the circuit and wait for a reset\n\t */\n\tfunction openCircuit(cause: unknown) {\n\t\tif (state === \"disposed\") return\n\t\tstate = \"open\"\n\t\tevents.emit(\"open\", cause)\n\t\tfailureCause = cause\n\t\tclearTimeout(resetTimer)\n\t\tresetTimer = setTimeout(() => (state = \"halfOpen\"), resetAfter)\n\t}\n\n\t/**\n\t * Restart the circuit and resume normal operation\n\t */\n\tfunction closeCircuit() {\n\t\tif (state === \"disposed\") return\n\t\tif (state === \"halfOpen\") events.emit(\"close\")\n\t\tstate = \"closed\"\n\t\tfailureCause = undefined\n\t\tfailureCount = 0\n\t\tclearTimeout(resetTimer)\n\t}\n\n\tconst mainWithEmit = async (...args: Args) => {\n\t\ttry {\n\t\t\tconst result = await main(...args)\n\t\t\tevents.emit(\"resolve\")\n\t\t\tcloseCircuit()\n\t\t\treturn result\n\t\t} catch (cause) {\n\t\t\tevents.emit(\"reject\", cause)\n\t\t\tthrow cause\n\t\t}\n\t}\n\n\t/**\n\t * Wrap calls to `main` with circuit breaker logic\n\t */\n\tasync function protectedFunction(...args: Args): Promise<Ret> {\n\t\t// Use the fallback while the circuit is open\n\t\tif (state === \"open\") {\n\t\t\treturn fallback(...args)\n\t\t}\n\n\t\t// While the circuit is half-open, try the main function once. If it\n\t\t// success, close the circuit and resume normal operation. If it fails,\n\t\t// re-open the circuit and run the fallback instead.\n\t\telse if (state === \"halfOpen\") {\n\t\t\treturn mainWithEmit(...args).catch((cause) => {\n\t\t\t\topenCircuit(cause)\n\t\t\t\treturn fallback(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Normal operation when circuit is closed. If an error occurs, keep track\n\t\t// of the failure count and open the circuit if it exceeds the threshold.\n\t\telse if (state === \"closed\") {\n\t\t\treturn mainWithEmit(...args).catch((cause) => {\n\t\t\t\tfailureCause = cause\n\t\t\t\tfailureCount += errorIsFailure(cause) ? 1 : 0\n\t\t\t\tif (failureCount >= failureThreshold) openCircuit(cause)\n\t\t\t\treturn fallback(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Shutting down...\n\t\telse if (state === \"disposed\")\n\t\t\tthrow new Error(\"Circuit breaker has been disposed\")\n\t\telse throw assertNever(state)\n\t}\n\n\tprotectedFunction.dispose = () => {\n\t\tevents.removeAllListeners()\n\t\tcloseCircuit()\n\t\tstate = \"disposed\"\n\t}\n\n\tprotectedFunction.getState = () => state\n\n\tprotectedFunction.off = (event: keyof EventMap, listener: AnyFn) => {\n\t\tevents.removeListener(event, listener)\n\t\treturn protectedFunction\n\t}\n\n\tprotectedFunction.on = (event: keyof EventMap, listener: AnyFn) => {\n\t\tevents.addListener(event, listener)\n\t\treturn protectedFunction\n\t}\n\n\treturn protectedFunction\n}\n"],"names":[],"mappings":";;;;AACO,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,OAAO,GAAG,kBAAkB;AAC/D;AACA,EAAE,IAAI,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACtC,CAAC;;ACDM,SAAS,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE;AACzD,EAAE,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE;AACnC,EAAE,MAAM;AACR,IAAI,cAAc,GAAG,MAAM,IAAI;AAC/B,IAAI,gBAAgB,GAAG,CAAC;AACxB,IAAI,QAAQ,GAAG,MAAM;AACrB,MAAM,MAAM,KAAK,GAAG,YAAY;AAChC,MAAM,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,GAAG,KAAK,CAAC,OAAO,GAAG,SAAS;AACpE,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC;AAC5D,IAAI,CAAC;AACL,IAAI,UAAU,GAAG;AACjB,GAAG,GAAG,OAAO;AACb,EAAE,IAAI,KAAK,GAAG,QAAQ;AACtB,EAAE,IAAI,YAAY,GAAG,MAAM;AAC3B,EAAE,IAAI,YAAY,GAAG,CAAC;AACtB,EAAE,IAAI,UAAU,GAAG,MAAM;AACzB,EAAE,SAAS,WAAW,CAAC,KAAK,EAAE;AAC9B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE;AAC9B,IAAI,KAAK,GAAG,MAAM;AAClB,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC;AAC9B,IAAI,YAAY,GAAG,KAAK;AACxB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,IAAI,UAAU,GAAG,UAAU,CAAC,MAAM,KAAK,GAAG,UAAU,EAAE,UAAU,CAAC;AACjE,EAAE;AACF,EAAE,SAAS,YAAY,GAAG;AAC1B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE;AAC9B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AAClD,IAAI,KAAK,GAAG,QAAQ;AACpB,IAAI,YAAY,GAAG,MAAM;AACzB,IAAI,YAAY,GAAG,CAAC;AACpB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,EAAE;AACF,EAAE,MAAM,YAAY,GAAG,OAAO,GAAG,IAAI,KAAK;AAC1C,IAAI,IAAI;AACR,MAAM,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC;AACxC,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;AAC5B,MAAM,YAAY,EAAE;AACpB,MAAM,OAAO,MAAM;AACnB,IAAI,CAAC,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;AAClC,MAAM,MAAM,KAAK;AACjB,IAAI;AACJ,EAAE,CAAC;AACH,EAAE,eAAe,iBAAiB,CAAC,GAAG,IAAI,EAAE;AAC5C,IAAI,IAAI,KAAK,KAAK,MAAM,EAAE;AAC1B,MAAM,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAC9B,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU,EAAE;AACrC,MAAM,OAAO,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACpD,QAAQ,WAAW,CAAC,KAAK,CAAC;AAC1B,QAAQ,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAChC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,QAAQ,EAAE;AACnC,MAAM,OAAO,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACpD,QAAQ,YAAY,GAAG,KAAK;AAC5B,QAAQ,YAAY,IAAI,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AACrD,QAAQ,IAAI,YAAY,IAAI,gBAAgB,EAAE,WAAW,CAAC,KAAK,CAAC;AAChE,QAAQ,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAChC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU;AACnC,MAAM,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC;AAC1D,SAAS,MAAM,WAAW,CAAC,KAAK,CAAC;AACjC,EAAE;AACF,EAAE,iBAAiB,CAAC,OAAO,GAAG,MAAM;AACpC,IAAI,MAAM,CAAC,kBAAkB,EAAE;AAC/B,IAAI,YAAY,EAAE;AAClB,IAAI,KAAK,GAAG,UAAU;AACtB,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,QAAQ,GAAG,MAAM,KAAK;AAC1C,EAAE,iBAAiB,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK;AAC/C,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC;AAC1C,IAAI,OAAO,iBAAiB;AAC5B,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK;AAC9C,IAAI,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC;AACvC,IAAI,OAAO,iBAAiB;AAC5B,EAAE,CAAC;AACH,EAAE,OAAO,iBAAiB;AAC1B;;;;"}

package/dist/index.d.cts

@@ -0,0 +1,51 @@
+type CircuitState = "closed" | "disposed" | "halfOpen" | "open";
+interface CircuitBreakerOptions<Args extends unknown[], Ret> {
+    /**
+     * Whether an error should be considered a failure that could trigger
+     * the circuit breaker. Use this to prevent certain errors from
+     * incrementing the failure count.
+     *
+     * @default () => true // Every error is considered a failure
+     */
+    errorIsFailure?: (error: unknown) => boolean;
+    /**
+     * The number of failures before the circuit breaker opens.
+     *
+     * @default 1 // The first error opens the circuit
+     */
+    failureThreshold?: number;
+    /**
+     * If provided, then all rejected calls to `main` will be forwarded to
+     * this function instead.
+     *
+     * @default undefined // No fallback, throws `CircuitOpenError`
+     */
+    fallback?: (...args: Args) => Promise<Ret>;
+    /**
+     * The amount of time to wait before allowing a half-open state.
+     *
+     * @default 30_000 // 30 seconds
+     */
+    resetAfter?: number;
+}
+interface EventMap {
+    close: [];
+    open: [cause: unknown];
+    reject: [cause: unknown];
+    resolve: [];
+}
+interface ProtectedFunction<Args extends unknown[], Ret> {
+    (...args: Args): Promise<Ret>;
+    /** Free memory and stop timers */
+    dispose(): void;
+    /** Get the current state of the circuit breaker */
+    getState(): CircuitState;
+    /** Remove a listener from the circuit breaker */
+    off<T extends keyof EventMap>(event: T, listener: (...args: EventMap[T]) => void): this;
+    /** Add a listener to the circuit breaker */
+    on<T extends keyof EventMap>(event: T, listener: (...args: EventMap[T]) => void): this;
+}
+declare function createCircuitBreaker<Args extends unknown[], Ret>(main: (...args: Args) => Promise<Ret>, options?: CircuitBreakerOptions<Args, Ret>): ProtectedFunction<Args, Ret>;
+
+export { createCircuitBreaker };
+export type { CircuitBreakerOptions, CircuitState, EventMap, ProtectedFunction };

package/dist/index.d.mts

@@ -0,0 +1,51 @@
+type CircuitState = "closed" | "disposed" | "halfOpen" | "open";
+interface CircuitBreakerOptions<Args extends unknown[], Ret> {
+    /**
+     * Whether an error should be considered a failure that could trigger
+     * the circuit breaker. Use this to prevent certain errors from
+     * incrementing the failure count.
+     *
+     * @default () => true // Every error is considered a failure
+     */
+    errorIsFailure?: (error: unknown) => boolean;
+    /**
+     * The number of failures before the circuit breaker opens.
+     *
+     * @default 1 // The first error opens the circuit
+     */
+    failureThreshold?: number;
+    /**
+     * If provided, then all rejected calls to `main` will be forwarded to
+     * this function instead.
+     *
+     * @default undefined // No fallback, throws `CircuitOpenError`
+     */
+    fallback?: (...args: Args) => Promise<Ret>;
+    /**
+     * The amount of time to wait before allowing a half-open state.
+     *
+     * @default 30_000 // 30 seconds
+     */
+    resetAfter?: number;
+}
+interface EventMap {
+    close: [];
+    open: [cause: unknown];
+    reject: [cause: unknown];
+    resolve: [];
+}
+interface ProtectedFunction<Args extends unknown[], Ret> {
+    (...args: Args): Promise<Ret>;
+    /** Free memory and stop timers */
+    dispose(): void;
+    /** Get the current state of the circuit breaker */
+    getState(): CircuitState;
+    /** Remove a listener from the circuit breaker */
+    off<T extends keyof EventMap>(event: T, listener: (...args: EventMap[T]) => void): this;
+    /** Add a listener to the circuit breaker */
+    on<T extends keyof EventMap>(event: T, listener: (...args: EventMap[T]) => void): this;
+}
+declare function createCircuitBreaker<Args extends unknown[], Ret>(main: (...args: Args) => Promise<Ret>, options?: CircuitBreakerOptions<Args, Ret>): ProtectedFunction<Args, Ret>;
+
+export { createCircuitBreaker };
+export type { CircuitBreakerOptions, CircuitState, EventMap, ProtectedFunction };

package/dist/index.mjs

@@ -0,0 +1,88 @@
+import EventEmitter from 'node:events';
+
+const assertNever = (value, message = "Unexpected value") => (
+  /* v8 ignore next */
+  new TypeError(`${message}: ${value}`)
+);
+
+function createCircuitBreaker(main, options = {}) {
+  const events = new EventEmitter();
+  const {
+    errorIsFailure = () => true,
+    failureThreshold = 1,
+    fallback = () => {
+      const cause = failureCause;
+      const msg = cause instanceof Error ? cause.message : "Unknown";
+      throw new Error(`CircuitOpenError: ${msg}`, { cause });
+    },
+    resetAfter = 3e4
+  } = options;
+  let state = "closed";
+  let failureCause = void 0;
+  let failureCount = 0;
+  let resetTimer = void 0;
+  function openCircuit(cause) {
+    if (state === "disposed") return;
+    state = "open";
+    events.emit("open", cause);
+    failureCause = cause;
+    clearTimeout(resetTimer);
+    resetTimer = setTimeout(() => state = "halfOpen", resetAfter);
+  }
+  function closeCircuit() {
+    if (state === "disposed") return;
+    if (state === "halfOpen") events.emit("close");
+    state = "closed";
+    failureCause = void 0;
+    failureCount = 0;
+    clearTimeout(resetTimer);
+  }
+  const mainWithEmit = async (...args) => {
+    try {
+      const result = await main(...args);
+      events.emit("resolve");
+      closeCircuit();
+      return result;
+    } catch (cause) {
+      events.emit("reject", cause);
+      throw cause;
+    }
+  };
+  async function protectedFunction(...args) {
+    if (state === "open") {
+      return fallback(...args);
+    } else if (state === "halfOpen") {
+      return mainWithEmit(...args).catch((cause) => {
+        openCircuit(cause);
+        return fallback(...args);
+      });
+    } else if (state === "closed") {
+      return mainWithEmit(...args).catch((cause) => {
+        failureCause = cause;
+        failureCount += errorIsFailure(cause) ? 1 : 0;
+        if (failureCount >= failureThreshold) openCircuit(cause);
+        return fallback(...args);
+      });
+    } else if (state === "disposed")
+      throw new Error("Circuit breaker has been disposed");
+    else throw assertNever(state);
+  }
+  protectedFunction.dispose = () => {
+    events.removeAllListeners();
+    closeCircuit();
+    state = "disposed";
+  };
+  protectedFunction.getState = () => state;
+  protectedFunction.off = (event, listener) => {
+    events.removeListener(event, listener);
+    return protectedFunction;
+  };
+  protectedFunction.on = (event, listener) => {
+    events.addListener(event, listener);
+    return protectedFunction;
+  };
+  return protectedFunction;
+}
+
+export { createCircuitBreaker };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../lib/util.ts","../lib/index.ts"],"sourcesContent":["export type AnyFn = (...args: any[]) => any\n\n/**\n * `[TypeScript]` For exhaustive checks in switch statements or if/else. Add\n * this check to `default` case or final `else` to ensure all possible values\n * have been handled. If a new value is added to the type, TypeScript will\n * throw an error and the editor will underline the `value`.\n */\nexport const assertNever = (value: never, message = \"Unexpected value\") =>\n\t/* v8 ignore next */\n\tnew TypeError(`${message}: ${value}`)\n","import { type AnyFn, assertNever } from \"./util.js\"\nimport EventEmitter from \"node:events\"\n\nexport type CircuitState = \"closed\" | \"disposed\" | \"halfOpen\" | \"open\"\n\nexport interface CircuitBreakerOptions<Args extends unknown[], Ret> {\n\t/**\n\t * Whether an error should be considered a failure that could trigger\n\t * the circuit breaker. Use this to prevent certain errors from\n\t * incrementing the failure count.\n\t * \n\t * @default () => true // Every error is considered a failure\n\t */\n\terrorIsFailure?: (error: unknown) => boolean\n\n\t/**\n\t * The number of failures before the circuit breaker opens.\n\t * \n\t * @default 1 // The first error opens the circuit\n\t */\n\tfailureThreshold?: number\n\n\t/**\n\t * If provided, then all rejected calls to `main` will be forwarded to\n\t * this function instead.\n\t * \n\t * @default undefined // No fallback, throws `CircuitOpenError`\n\t */\n\tfallback?: (...args: Args) => Promise<Ret>\n\n\t/**\n\t * The amount of time to wait before allowing a half-open state.\n\t * \n\t * @default 30_000 // 30 seconds\n\t */\n\tresetAfter?: number\n}\n\nexport interface EventMap {\n\tclose: []\n\topen: [cause: unknown]\n\treject: [cause: unknown]\n\tresolve: []\n}\n\nexport interface ProtectedFunction<Args extends unknown[], Ret> {\n\t(...args: Args): Promise<Ret>\n\n\t/** Free memory and stop timers */\n\tdispose(): void\n\n\t/** Get the current state of the circuit breaker */\n\tgetState(): CircuitState\n\n\t/** Remove a listener from the circuit breaker */\n\toff<T extends keyof EventMap>(\n\t\tevent: T,\n\t\tlistener: (...args: EventMap[T]) => void\n\t): this\n\n\t/** Add a listener to the circuit breaker */\n\ton<T extends keyof EventMap>(\n\t\tevent: T,\n\t\tlistener: (...args: EventMap[T]) => void\n\t): this\n}\n\nexport function createCircuitBreaker<Args extends unknown[], Ret>(\n\tmain: (...args: Args) => Promise<Ret>,\n\toptions: CircuitBreakerOptions<Args, Ret> = {}\n): ProtectedFunction<Args, Ret> {\n\tconst events = new EventEmitter<EventMap>()\n\tconst {\n\t\terrorIsFailure = () => true,\n\t\tfailureThreshold = 1,\n\t\tfallback = () => {\n\t\t\tconst cause = failureCause\n\t\t\tconst msg = cause instanceof Error ? cause.message : \"Unknown\"\n\t\t\tthrow new Error(`CircuitOpenError: ${msg}`, { cause })\n\t\t},\n\t\tresetAfter = 30_000,\n\t} = options\n\tlet state: CircuitState = \"closed\"\n\tlet failureCause: unknown | undefined = undefined\n\tlet failureCount = 0\n\tlet resetTimer: NodeJS.Timeout | undefined = undefined\n\n\t/**\n\t * Break the circuit and wait for a reset\n\t */\n\tfunction openCircuit(cause: unknown) {\n\t\tif (state === \"disposed\") return\n\t\tstate = \"open\"\n\t\tevents.emit(\"open\", cause)\n\t\tfailureCause = cause\n\t\tclearTimeout(resetTimer)\n\t\tresetTimer = setTimeout(() => (state = \"halfOpen\"), resetAfter)\n\t}\n\n\t/**\n\t * Restart the circuit and resume normal operation\n\t */\n\tfunction closeCircuit() {\n\t\tif (state === \"disposed\") return\n\t\tif (state === \"halfOpen\") events.emit(\"close\")\n\t\tstate = \"closed\"\n\t\tfailureCause = undefined\n\t\tfailureCount = 0\n\t\tclearTimeout(resetTimer)\n\t}\n\n\tconst mainWithEmit = async (...args: Args) => {\n\t\ttry {\n\t\t\tconst result = await main(...args)\n\t\t\tevents.emit(\"resolve\")\n\t\t\tcloseCircuit()\n\t\t\treturn result\n\t\t} catch (cause) {\n\t\t\tevents.emit(\"reject\", cause)\n\t\t\tthrow cause\n\t\t}\n\t}\n\n\t/**\n\t * Wrap calls to `main` with circuit breaker logic\n\t */\n\tasync function protectedFunction(...args: Args): Promise<Ret> {\n\t\t// Use the fallback while the circuit is open\n\t\tif (state === \"open\") {\n\t\t\treturn fallback(...args)\n\t\t}\n\n\t\t// While the circuit is half-open, try the main function once. If it\n\t\t// success, close the circuit and resume normal operation. If it fails,\n\t\t// re-open the circuit and run the fallback instead.\n\t\telse if (state === \"halfOpen\") {\n\t\t\treturn mainWithEmit(...args).catch((cause) => {\n\t\t\t\topenCircuit(cause)\n\t\t\t\treturn fallback(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Normal operation when circuit is closed. If an error occurs, keep track\n\t\t// of the failure count and open the circuit if it exceeds the threshold.\n\t\telse if (state === \"closed\") {\n\t\t\treturn mainWithEmit(...args).catch((cause) => {\n\t\t\t\tfailureCause = cause\n\t\t\t\tfailureCount += errorIsFailure(cause) ? 1 : 0\n\t\t\t\tif (failureCount >= failureThreshold) openCircuit(cause)\n\t\t\t\treturn fallback(...args)\n\t\t\t})\n\t\t}\n\n\t\t// Shutting down...\n\t\telse if (state === \"disposed\")\n\t\t\tthrow new Error(\"Circuit breaker has been disposed\")\n\t\telse throw assertNever(state)\n\t}\n\n\tprotectedFunction.dispose = () => {\n\t\tevents.removeAllListeners()\n\t\tcloseCircuit()\n\t\tstate = \"disposed\"\n\t}\n\n\tprotectedFunction.getState = () => state\n\n\tprotectedFunction.off = (event: keyof EventMap, listener: AnyFn) => {\n\t\tevents.removeListener(event, listener)\n\t\treturn protectedFunction\n\t}\n\n\tprotectedFunction.on = (event: keyof EventMap, listener: AnyFn) => {\n\t\tevents.addListener(event, listener)\n\t\treturn protectedFunction\n\t}\n\n\treturn protectedFunction\n}\n"],"names":[],"mappings":";;AACO,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,OAAO,GAAG,kBAAkB;AAC/D;AACA,EAAE,IAAI,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACtC,CAAC;;ACDM,SAAS,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,EAAE,EAAE;AACzD,EAAE,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE;AACnC,EAAE,MAAM;AACR,IAAI,cAAc,GAAG,MAAM,IAAI;AAC/B,IAAI,gBAAgB,GAAG,CAAC;AACxB,IAAI,QAAQ,GAAG,MAAM;AACrB,MAAM,MAAM,KAAK,GAAG,YAAY;AAChC,MAAM,MAAM,GAAG,GAAG,KAAK,YAAY,KAAK,GAAG,KAAK,CAAC,OAAO,GAAG,SAAS;AACpE,MAAM,MAAM,IAAI,KAAK,CAAC,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC;AAC5D,IAAI,CAAC;AACL,IAAI,UAAU,GAAG;AACjB,GAAG,GAAG,OAAO;AACb,EAAE,IAAI,KAAK,GAAG,QAAQ;AACtB,EAAE,IAAI,YAAY,GAAG,MAAM;AAC3B,EAAE,IAAI,YAAY,GAAG,CAAC;AACtB,EAAE,IAAI,UAAU,GAAG,MAAM;AACzB,EAAE,SAAS,WAAW,CAAC,KAAK,EAAE;AAC9B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE;AAC9B,IAAI,KAAK,GAAG,MAAM;AAClB,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC;AAC9B,IAAI,YAAY,GAAG,KAAK;AACxB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,IAAI,UAAU,GAAG,UAAU,CAAC,MAAM,KAAK,GAAG,UAAU,EAAE,UAAU,CAAC;AACjE,EAAE;AACF,EAAE,SAAS,YAAY,GAAG;AAC1B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE;AAC9B,IAAI,IAAI,KAAK,KAAK,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AAClD,IAAI,KAAK,GAAG,QAAQ;AACpB,IAAI,YAAY,GAAG,MAAM;AACzB,IAAI,YAAY,GAAG,CAAC;AACpB,IAAI,YAAY,CAAC,UAAU,CAAC;AAC5B,EAAE;AACF,EAAE,MAAM,YAAY,GAAG,OAAO,GAAG,IAAI,KAAK;AAC1C,IAAI,IAAI;AACR,MAAM,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC;AACxC,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;AAC5B,MAAM,YAAY,EAAE;AACpB,MAAM,OAAO,MAAM;AACnB,IAAI,CAAC,CAAC,OAAO,KAAK,EAAE;AACpB,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;AAClC,MAAM,MAAM,KAAK;AACjB,IAAI;AACJ,EAAE,CAAC;AACH,EAAE,eAAe,iBAAiB,CAAC,GAAG,IAAI,EAAE;AAC5C,IAAI,IAAI,KAAK,KAAK,MAAM,EAAE;AAC1B,MAAM,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAC9B,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU,EAAE;AACrC,MAAM,OAAO,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACpD,QAAQ,WAAW,CAAC,KAAK,CAAC;AAC1B,QAAQ,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAChC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,QAAQ,EAAE;AACnC,MAAM,OAAO,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,KAAK;AACpD,QAAQ,YAAY,GAAG,KAAK;AAC5B,QAAQ,YAAY,IAAI,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AACrD,QAAQ,IAAI,YAAY,IAAI,gBAAgB,EAAE,WAAW,CAAC,KAAK,CAAC;AAChE,QAAQ,OAAO,QAAQ,CAAC,GAAG,IAAI,CAAC;AAChC,MAAM,CAAC,CAAC;AACR,IAAI,CAAC,MAAM,IAAI,KAAK,KAAK,UAAU;AACnC,MAAM,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC;AAC1D,SAAS,MAAM,WAAW,CAAC,KAAK,CAAC;AACjC,EAAE;AACF,EAAE,iBAAiB,CAAC,OAAO,GAAG,MAAM;AACpC,IAAI,MAAM,CAAC,kBAAkB,EAAE;AAC/B,IAAI,YAAY,EAAE;AAClB,IAAI,KAAK,GAAG,UAAU;AACtB,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,QAAQ,GAAG,MAAM,KAAK;AAC1C,EAAE,iBAAiB,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK;AAC/C,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC;AAC1C,IAAI,OAAO,iBAAiB;AAC5B,EAAE,CAAC;AACH,EAAE,iBAAiB,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,KAAK;AAC9C,IAAI,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC;AACvC,IAAI,OAAO,iBAAiB;AAC5B,EAAE,CAAC;AACH,EAAE,OAAO,iBAAiB;AAC1B;;;;"}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "breaker-box",
+	"version": "1.0.0",
+	"description": "A zero-dependency circuit breaker implementation for Node.js",
+	"repository": "github:sirlancelot/breaker-box",
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.cts",
+	"exports": {
+		"require": {
+			"default": "./dist/index.cjs",
+			"types": "./dist/index.d.cts"
+		},
+		"import": {
+			"default": "./dist/index.mjs",
+			"types": "./dist/index.d.mts"
+		}
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "pkgroll --clean-dist --src lib --target=node18 --sourcemap",
+		"dev": "vitest",
+		"prepublishOnly": "npm run build",
+		"test": "vitest --run"
+	},
+	"keywords": [
+		"circuit-breaker",
+		"breaker-box"
+	],
+	"author": "Matthew Pietz <sirlancelot@gmail.com>",
+	"license": "ISC",
+	"devDependencies": {
+		"@types/node": "24.3.1",
+		"@vitest/coverage-v8": "3.2.4",
+		"pkgroll": "2.15.4",
+		"tsx": "4.20.5",
+		"typescript": "5.9.2",
+		"vitest": "3.2.4",
+		"vitest-when": "0.8.0"
+	}
+}