Add console.timeLog function

Provide timeLog to be compatible with node. Signed-off-by: Chris. Webster <chris@webstech.net>
jestjs · Jun 28, 2020 · ddb6203 · ddb6203
1 parent a8129a7
commit ddb6203
Show file tree

Hide file tree

Showing 6 changed files with 98 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ### Features
 
 ### Fixes
+- `[jest-console]` Add missing console.timeLog for compatability with Node ([#10209](https://github.com/facebook/jest/pull/10209))
 
 ### Chore & Maintenance
 

diff --git a/packages/jest-console/src/BufferedConsole.ts b/packages/jest-console/src/BufferedConsole.ts
@@ -159,6 +159,16 @@ export default class BufferedConsole extends Console {
     }
   }
 
+  timeLog(label = 'default', ...data: Array<unknown>): void {
+    const startTime = this._timers[label];
+
+    if (startTime) {
+      const endTime = new Date();
+      const time = endTime.getTime() - startTime.getTime();
+      this._log('time', format(`${label}: ${formatTime(time)}`, ...data));
+    }
+  }
+
   warn(firstArg: unknown, ...rest: Array<unknown>): void {
     this._log('warn', format(firstArg, ...rest));
   }

diff --git a/packages/jest-console/src/CustomConsole.ts b/packages/jest-console/src/CustomConsole.ts
@@ -136,6 +136,16 @@ export default class CustomConsole extends Console {
     }
   }
 
+  timeLog(label = 'default', ...data: Array<unknown>): void {
+    const startTime = this._timers[label];
+
+    if (startTime) {
+      const endTime = new Date();
+      const time = endTime.getTime() - startTime.getTime();
+      this._log('time', format(`${label}: ${formatTime(time)}`, ...data));
+    }
+  }
+
   warn(firstArg: unknown, ...args: Array<unknown>): void {
     this._logError('warn', format(firstArg, ...args));
   }

diff --git a/packages/jest-console/src/NullConsole.ts b/packages/jest-console/src/NullConsole.ts
@@ -16,6 +16,7 @@ export default class NullConsole extends CustomConsole {
   log(): void {}
   time(): void {}
   timeEnd(): void {}
+  timeLog(): void {}
   trace(): void {}
   warn(): void {}
   group(): void {}

diff --git a/packages/jest-console/src/__tests__/CustomConsole.test.ts b/packages/jest-console/src/__tests__/CustomConsole.test.ts
@@ -186,4 +186,42 @@ describe('CustomConsole', () => {
       expect(_stdout).toMatch('ms');
     });
   });
+
+  describe('timeLog', () => {
+    test('should return the time between time() and timeEnd() on default timer', () => {
+      _console.time();
+      _console.timeLog();
+
+      expect(_stdout).toMatch('default: ');
+      expect(_stdout).toMatch('ms');
+      _console.timeEnd();
+    });
+
+    test('should return the time between time() and timeEnd() on custom timer', () => {
+      _console.time('custom');
+      _console.timeLog('custom');
+
+      expect(_stdout).toMatch('custom: ');
+      expect(_stdout).toMatch('ms');
+      _console.timeEnd('custom');
+    });
+
+    test('default timer with data', () => {
+      _console.time();
+      _console.timeLog(undefined, 'foo', 5);
+
+      expect(_stdout).toMatch('default: ');
+      expect(_stdout).toMatch('ms foo 5');
+      _console.timeEnd();
+    });
+
+    test('custom timer with data', () => {
+      _console.time('custom');
+      _console.timeLog('custom', 'foo', 5);
+
+      expect(_stdout).toMatch('custom: ');
+      expect(_stdout).toMatch('ms foo 5');
+      _console.timeEnd('custom');
+    });
+  });
 });
diff --git a/packages/jest-console/src/__tests__/bufferedConsole.test.ts b/packages/jest-console/src/__tests__/bufferedConsole.test.ts
@@ -146,4 +146,42 @@ describe('CustomConsole', () => {
       expect(stdout()).toMatch('ms');
     });
   });
+
+  describe('timeLog', () => {
+    test('should return the time between time() and timeEnd() on default timer', () => {
+      _console.time();
+      _console.timeLog();
+
+      expect(stdout()).toMatch('default: ');
+      expect(stdout()).toMatch('ms');
+      _console.timeEnd();
+    });
+
+    test('should return the time between time() and timeEnd() on custom timer', () => {
+      _console.time('custom');
+      _console.timeLog('custom');
+
+      expect(stdout()).toMatch('custom: ');
+      expect(stdout()).toMatch('ms');
+      _console.timeEnd('custom');
+    });
+
+    test('default timer with data', () => {
+      _console.time();
+      _console.timeLog(undefined, 'foo', 5);
+
+      expect(stdout()).toMatch('default: ');
+      expect(stdout()).toMatch('ms foo 5');
+      _console.timeEnd();
+    });
+
+    test('custom timer with data', () => {
+      _console.time('custom');
+      _console.timeLog('custom', 'foo', 5);
+
+      expect(stdout()).toMatch('custom: ');
+      expect(stdout()).toMatch('ms foo 5');
+      _console.timeEnd('custom');
+    });
+  });
 });