code cleanup

genesys · Dec 15, 2020 · 3eec0dc · 3eec0dc
1 parent 30e485d
commit 3eec0dc
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 13 deletions.
diff --git a/docs/content/api/module/breaker/sliding/count.md b/docs/content/api/module/breaker/sliding/count.md
@@ -40,3 +40,4 @@ For example, if the count window size is 10, the circular array has always 10 me
 | Name       | Description                          | Params                         |
 |:-----------|:-------------------------------------|:--------------- ---------------|
 | `execute`  | Called when the module is executed.  | `Mollitia.Circuit` **circuit** |
+| `state-changed`  | Called when the breaker state changes.  | `Mollitia.BreakerState` **state** |
diff --git a/docs/content/api/module/breaker/sliding/time.md b/docs/content/api/module/breaker/sliding/time.md
@@ -42,3 +42,4 @@ For example, if the count window size is 10000, the circular array stores the re
 | Name       | Description                          | Params                         |
 |:-----------|:-------------------------------------|:--------------- ---------------|
 | `execute`  | Called when the module is executed.  | `Mollitia.Circuit` **circuit** |
+| `state-changed`  | Called when the breaker state changes.  | `Mollitia.BreakerState` **state** |
diff --git a/src/circuit.ts b/src/circuit.ts
@@ -109,7 +109,7 @@ export class Circuit extends EventEmitter {
    */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public async execute<T> (...params: any[]): Promise<T> {
-    let _exec;
+    let _exec: Promise<T>;
     if (this.modules.length) {
       if (this.modules.length > 1) {
         const args = [];

diff --git a/src/module/breaker/index.ts b/src/module/breaker/index.ts
@@ -146,11 +146,11 @@ export abstract class SlidingWindowBreaker<T> extends Module {
     } else if (this.state === BreakerState.HALF_OPENED) {
       this.setOpenDelay();
     }
-    this.slidingWindowSize                    = options?.slidingWindowSize ? options?.slidingWindowSize : 10;
-    this.minimumNumberOfCalls                 = options?.minimumNumberOfCalls ? options?.minimumNumberOfCalls : 10;
-    this.failureRateThreshold                 = (options?.failureRateThreshold ? options?.failureRateThreshold : 50);
-    this.slowCallDurationThreshold            = options?.slowCallDurationThreshold ? options?.slowCallDurationThreshold : 60000;
-    this.slowCallRateThreshold                = (options?.slowCallRateThreshold ? options?.slowCallRateThreshold : 100);
+    this.slidingWindowSize = options?.slidingWindowSize ? options?.slidingWindowSize : 10;
+    this.minimumNumberOfCalls = options?.minimumNumberOfCalls ? options?.minimumNumberOfCalls : 10;
+    this.failureRateThreshold = (options?.failureRateThreshold ? options?.failureRateThreshold : 50);
+    this.slowCallDurationThreshold = options?.slowCallDurationThreshold ? options?.slowCallDurationThreshold : 60000;
+    this.slowCallRateThreshold = (options?.slowCallRateThreshold ? options?.slowCallRateThreshold : 100);
     this.permittedNumberOfCallsInHalfOpenState = options?.permittedNumberOfCallsInHalfOpenState ? options?.permittedNumberOfCallsInHalfOpenState : 2;
     this.nbCallsInHalfOpenedState = 0;
     this.callsInHalfOpenedState = [];
@@ -290,7 +290,7 @@ export abstract class SlidingWindowBreaker<T> extends Module {
       this.state = BreakerState.OPENED;
       this.setHalfDelay();
       this.onOpened();
-      this.emit('stateChanged');
+      this.emit('state-changed', this.state);
     }
   }
   public halfOpen (): void {
@@ -299,15 +299,15 @@ export abstract class SlidingWindowBreaker<T> extends Module {
       this.state = BreakerState.HALF_OPENED;
       this.setOpenDelay();
       this.onHalfOpened();
-      this.emit('stateChanged');
+      this.emit('state-changed', this.state);
     }
   }
   public close (): void {
     if (this.state !== BreakerState.CLOSED) {
       this.clearHalfOpenTimeout();
       this.state = BreakerState.CLOSED;
       this.onClosed();
-      this.emit('stateChanged');
+      this.emit('state-changed', this.state);
     }
   }
   private setHalfDelay (): void {

diff --git a/test/unit/module/breaker/sliding-count-breaker.spec.ts b/test/unit/module/breaker/sliding-count-breaker.spec.ts
@@ -203,12 +203,12 @@ describe('Sliding Count Breaker', () => {
         ]
       }
     });
-    await circuit.fn(failureAsync).execute('credentials-issue').catch(()=>{ });
-    await circuit.fn(failureAsync).execute('credentials-issue').catch(()=>{ });
+    await circuit.fn(failureAsync).execute('credentials-issue').catch(()=>{ return; });
+    await circuit.fn(failureAsync).execute('credentials-issue').catch(()=>{ return; });
     expect(slidingCountBreaker.state).toEqual(Mollitia.BreakerState.CLOSED);
-    await circuit.fn(failureAsync).execute('real-issue').catch(()=>{ });
+    await circuit.fn(failureAsync).execute('real-issue').catch(()=>{ return; });
     expect(slidingCountBreaker.state).toEqual(Mollitia.BreakerState.CLOSED);
-    await circuit.fn(failureAsync).execute('real-issue').catch(()=>{ });
+    await circuit.fn(failureAsync).execute('real-issue').catch(()=>{ return; });
     expect(slidingCountBreaker.state).toEqual(Mollitia.BreakerState.OPENED);
   });
 });