fix: breaker should emit a shutdown event when it is shutdown (nodesh…

…ift#625) * fix: breaker should emit a shutdown event when it is shutdown fixes nodeshift#620 * chore: Update README.md Co-authored-by: Lance Ball <[email protected]> Co-authored-by: Lance Ball <[email protected]>
hongbo-miao · Jan 7, 2022 · ea4d058 · ea4d058
1 parent 42f21ed
commit ea4d058
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -259,6 +259,7 @@ Here are the events you can listen for.
   * `fallback` - emitted when the breaker has a fallback function and executes it
   * `semaphoreLocked` - emitted when the breaker is at capacity and cannot execute the request
   * `healthCheckFailed` - emitted when a user-supplied health check function returns a rejected promise
+  * `shutdown` - emitted when the breaker shuts down
 
 Handling events gives a greater level of control over your application behavior.
 

diff --git a/lib/circuit.js b/lib/circuit.js
@@ -323,6 +323,12 @@ class CircuitBreaker extends EventEmitter {
    * @returns {void}
    */
   shutdown () {
+    /**
+     * Emitted when the circuit breaker has been shut down.
+     * @event CircuitBreaker#shutdown
+     */
+    this.emit('shutdown');
+
     this.disable();
     this.removeAllListeners();
     if (this[RESET_TIMEOUT]) {
@@ -333,11 +339,6 @@ class CircuitBreaker extends EventEmitter {
     }
     this.status.shutdown();
     this[STATE] = SHUTDOWN;
-    /**
-     * Emitted when the circuit breaker has been shut down.
-     * @event CircuitBreaker#shutdown
-     */
-    this.emit('shutdown');
   }
 
   /**

diff --git a/test/circuit-shutdown-test.js b/test/circuit-shutdown-test.js
@@ -17,8 +17,11 @@ test('EventEmitter max listeners', t => {
 });
 
 test('Circuit shuts down properly', t => {
-  t.plan(6);
+  t.plan(7);
   const breaker = new CircuitBreaker(passFail);
+  breaker.on('shutdown', _ => {
+    t.pass('Breaker emits Shutdown');
+  });
   t.ok(breaker.fire(1), 'breaker is active');
   breaker.shutdown();
   t.ok(breaker.isShutdown, 'breaker is shutdown');