Merge pull request #1572 from session-foundation/fix-timed-log-unit-tests

chore: fix timed log unreliable with Date.now() calls

Author: Bilb

ts/test/session/unit/utils/loggerTimed_test.ts

@@ -1,4 +1,6 @@
 import { assert } from 'chai';
+import Sinon from 'sinon';
+
 import { TimedLog } from '../../../../util/loggerTimed';
 
 const second = 's';
@@ -20,6 +22,16 @@ function testPairFuzzy({ offset, output }: TimePair) {
 }
 
 describe('TimedLog', () => {
+  const mockNow = 1000000; // arbitrary timestamp
+
+  beforeEach(() => {
+    Sinon.stub(Date, 'now').returns(mockNow);
+  });
+
+  afterEach(() => {
+    Sinon.restore();
+  });
+
   describe('formatDistanceToNow', () => {
     it('should return exact milliseconds when the time difference is less than 1 second', () => {
       (
@@ -82,11 +94,11 @@ describe('TimedLog', () => {
       // Millisecond values should be whole numbers but we should still handle non-regular values as its theoretically possible for the time to be a float
       (
         [
-          { offset: 1.11112123213, output: `2${ms}` },
+          { offset: 1.11112123213, output: `1${ms}` },
           { offset: 1.567, output: `2${ms}` },
           { offset: 1.867, output: `2${ms}` },
           { offset: 1001.567, output: `1.002${second}` },
-          { offset: 2002.1, output: `2.003${second}` },
+          { offset: 2002.1, output: `2.002${second}` },
           { offset: 10000.0000001, output: `10${second}` },
         ] satisfies TimePairs
       ).forEach(testPair);

ts/util/loggerTimed.ts

@@ -50,7 +50,7 @@ export class TimedLog {
     this.start = Date.now();
   }
 
-  private static formatMillisecondsToSeconds(milliseconds: number): string {
+  private static formatMsToSeconds(milliseconds: number): string {
     const seconds = milliseconds / 1000;
     return seconds.toFixed(3).replace(/\.?0+$/, '');
   }
@@ -61,17 +61,18 @@ export class TimedLog {
    * @returns The formatted time.
    */
   public static formatDistanceToNow(time: number) {
-    const ms = Date.now() - Math.floor(time);
+    const ms = Math.round(Date.now() - time);
     const s = Math.floor(ms / 1000);
-    if (s === 0) {
+
+    if (ms < 1000) {
       return `${ms}${TimedLog.millisecondSuffix}`;
     }
 
-    if (ms === 0) {
+    if (ms % 1000 === 0) {
       return `${s}${TimedLog.secondSuffix}`;
     }
 
-    return `${this.formatMillisecondsToSeconds(ms)}${TimedLog.secondSuffix}`;
+    return `${TimedLog.formatMsToSeconds(ms)}${TimedLog.secondSuffix}`;
   }
 
   /**