fix(typo): circuit breaker “function” input (#372)

americanexpress · Nov 6, 2020 · e1e74b9 · e1e74b9
1 parent 0faa0bf
commit e1e74b9
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/__tests__/server/middleware/createRequestHtmlFragment.spec.js b/__tests__/server/middleware/createRequestHtmlFragment.spec.js
@@ -37,9 +37,9 @@ jest.mock('holocron', () => ({
 
 jest.mock('../../../src/server/utils/createCircuitBreaker', () => {
   const breaker = jest.fn();
-  const mockCreateCircuitBreaker = (asyncFuntionThatMightFail) => {
+  const mockCreateCircuitBreaker = (asyncFunctionThatMightFail) => {
     breaker.fire = jest.fn((...args) => {
-      asyncFuntionThatMightFail(...args);
+      asyncFunctionThatMightFail(...args);
       return false;
     });
     return breaker;

diff --git a/__tests__/server/utils/createCircuitBreaker.spec.js b/__tests__/server/utils/createCircuitBreaker.spec.js
@@ -23,8 +23,8 @@ import createCircuitBreaker, {
 
 jest.useFakeTimers();
 
-const asyncFuntionThatMightFail = jest.fn(async () => false);
-const mockCircuitBreaker = createCircuitBreaker(asyncFuntionThatMightFail);
+const asyncFunctionThatMightFail = jest.fn(async () => false);
+const mockCircuitBreaker = createCircuitBreaker(asyncFunctionThatMightFail);
 
 jest.mock('holocron', () => ({
   getModule: jest.fn(() => true),
@@ -49,7 +49,7 @@ describe('Circuit breaker', () => {
     expect.assertions(2);
     const input = 'hello, world';
     const value = await mockCircuitBreaker.fire(input);
-    expect(asyncFuntionThatMightFail).toHaveBeenCalledWith(input);
+    expect(asyncFunctionThatMightFail).toHaveBeenCalledWith(input);
     expect(value).toBe(false);
   });
 
@@ -61,7 +61,7 @@ describe('Circuit breaker', () => {
     await mockCircuitBreaker.fire('hola, mundo');
     jest.clearAllMocks();
     const value = await mockCircuitBreaker.fire('hola, mundo');
-    expect(asyncFuntionThatMightFail).not.toHaveBeenCalled();
+    expect(asyncFunctionThatMightFail).not.toHaveBeenCalled();
     expect(value).toBe(true);
   });
 
@@ -74,7 +74,7 @@ describe('Circuit breaker', () => {
     await mockCircuitBreaker.fire('hola, mundo');
     jest.clearAllMocks();
     const value = await mockCircuitBreaker.fire('hola, mundo');
-    expect(asyncFuntionThatMightFail).toHaveBeenCalled();
+    expect(asyncFunctionThatMightFail).toHaveBeenCalled();
     expect(value).toBe(false);
   });
 
@@ -86,7 +86,7 @@ describe('Circuit breaker', () => {
     await mockCircuitBreaker.fire('hola, mundo');
     jest.clearAllMocks();
     const value = await mockCircuitBreaker.fire('hola, mundo');
-    expect(asyncFuntionThatMightFail).toHaveBeenCalled();
+    expect(asyncFunctionThatMightFail).toHaveBeenCalled();
     expect(value).toBe(false);
   });
 
@@ -99,7 +99,7 @@ describe('Circuit breaker', () => {
     await mockCircuitBreaker.fire('hola, mundo');
     jest.clearAllMocks();
     const value = await mockCircuitBreaker.fire('hola, mundo');
-    expect(asyncFuntionThatMightFail).toHaveBeenCalled();
+    expect(asyncFunctionThatMightFail).toHaveBeenCalled();
     expect(value).toBe(false);
   });
 

diff --git a/src/server/utils/createCircuitBreaker.js b/src/server/utils/createCircuitBreaker.js
@@ -54,16 +54,16 @@ const checkMaxEventLoopDelay = async () => {
   }
 };
 
-const createCircuitBreaker = (asyncFuntionThatMightFail) => {
-  // asyncFuntionThatMightFail should return false to indicate fallback is not needed
-  const breaker = new CircuitBreaker(asyncFuntionThatMightFail, options);
+const createCircuitBreaker = (asyncFunctionThatMightFail) => {
+  // asyncFunctionThatMightFail should return false to indicate fallback is not needed
+  const breaker = new CircuitBreaker(asyncFunctionThatMightFail, options);
   // Fallback returns true to indicate fallback behavior is needed
   breaker.fallback(() => true);
   // Check the max event loop delay every 500ms
   breaker.healthCheck(checkMaxEventLoopDelay, 500);
   // Log when circuit breaker opens and closes
-  breaker.on('open', () => console.log(`Circuit breaker [${asyncFuntionThatMightFail.name}] opened`));
-  breaker.on('close', () => console.log(`Circuit breaker [${asyncFuntionThatMightFail.name}] closed`));
+  breaker.on('open', () => console.log(`Circuit breaker [${asyncFunctionThatMightFail.name}] opened`));
+  breaker.on('close', () => console.log(`Circuit breaker [${asyncFunctionThatMightFail.name}] closed`));
   breaker.on('healthCheckFailed', (error) => console.error(error));
   // Track circuit breaker metrics
   registerCircuitBreaker(breaker);