Future: Drop Node 18

.github/workflows/minor.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - uses: fregante/setup-git-user@v2
       - run: |
           yarn install

.github/workflows/node.js.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [18.18.0, 18.x, 20.9.0, 20.x, 22.0.0, 22.x]
+        node-version: [20.9.0, 20.x, 22.0.0, 22.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
     steps:
     - name: Get yarn cache dir

.github/workflows/npm-publish.yml

@@ -23,7 +23,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           registry-url: https://registry.npmjs.org/
       - run: yarn install
       - run: npm publish --provenance --tag ${{ inputs.tag }}

.github/workflows/patch.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - uses: fregante/setup-git-user@v2
       - run: |
           yarn install

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Version 21
+
+### v21.0.0
+
+- **Breaking changes**:
+  - Supported Node versions: ^20.9.0, ^22.0.0
+  - `BuiltinLogger::profile()` behavior changed for picoseconds: expressing them through nanoseconds.
+
 ## Version 20
 
 ### v20.14.2

package.json

@@ -73,7 +73,7 @@
     "*.md"
   ],
   "engines": {
-    "node": "^18.18.0 || ^20.9.0 || ^22.0.0"
+    "node": "^20.9.0 || ^22.0.0"
   },
   "dependencies": {
     "ansis": "^3.2.0",
@@ -116,7 +116,7 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.16.2",
     "@eslint/eslintrc": "^3",
-    "@tsconfig/node18": "^18.2.1",
+    "@tsconfig/node20": "^20.1.4",
     "@types/compression": "^1.7.5",
     "@types/cors": "^2.8.14",
     "@types/depd": "^1.1.36",

src/builtin-logger.ts

@@ -4,8 +4,8 @@ import { performance } from "node:perf_hooks";
 import type { FlatObject } from "./common-helpers";
 import {
   AbstractLogger,
-  formatDuration,
   isHidden,
+  makeNumberFormat,
   Severity,
 } from "./logger-helpers";
 
@@ -49,6 +49,12 @@ interface ProfilerOptions {
 /** @desc Built-in console logger with optional colorful inspections */
 export class BuiltinLogger implements AbstractLogger {
   protected hasColor: boolean;
+  protected picoFormat = makeNumberFormat("nanosecond", 3);
+  protected nanoFormat = makeNumberFormat("nanosecond");
+  protected microFormat = makeNumberFormat("microsecond");
+  protected milliFormat = makeNumberFormat("millisecond");
+  protected secondsFormat = makeNumberFormat("second", 2);
+  protected minutesFormat = makeNumberFormat("minute", 2);
   protected readonly styles: Record<Severity, Ansis> = {
     debug: blue,
     info: green,
@@ -114,6 +120,15 @@ export class BuiltinLogger implements AbstractLogger {
     return new BuiltinLogger({ ...this.config, ctx });
   }
 
+  protected formatDuration = (ms: number) => {
+    if (ms < 1e-6) return this.picoFormat.format(ms / 1e-6);
+    if (ms < 1e-3) return this.nanoFormat.format(ms / 1e-6);
+    if (ms < 1) return this.microFormat.format(ms / 1e-3);
+    if (ms < 1e3) return this.milliFormat.format(ms);
+    if (ms < 6e4) return this.secondsFormat.format(ms / 1e3);
+    return this.minutesFormat.format(ms / 6e4);
+  };
+
   /** @desc Measures the duration until you invoke the returned callback */
   public profile(message: string): () => void;
   public profile(options: ProfilerOptions): () => void;
@@ -124,7 +139,7 @@ export class BuiltinLogger implements AbstractLogger {
       const {
         message,
         severity = "debug",
-        formatter = formatDuration,
+        formatter = this.formatDuration.bind(this),
       } = typeof subject === "object" ? subject : { message: subject };
       this.print(
         typeof severity === "function" ? severity(duration) : severity,

src/logger-helpers.ts

@@ -34,32 +34,20 @@ export const isSeverity = (subject: PropertyKey): subject is Severity =>
 export const isHidden = (subject: Severity, gate: Severity) =>
   severity[subject] < severity[gate];
 
-/**
- * @todo consider Intl units when Node 18 dropped (microsecond unit is missing, picosecond is not in list)
- * @link https://tc39.es/ecma402/#table-sanctioned-single-unit-identifiers
- * */
-const makeNumberFormat = (fraction = 0) =>
+/** @link https://tc39.es/ecma402/#table-sanctioned-single-unit-identifiers */
+type TimeUnit =
+  | "nanosecond"
+  | "microsecond"
+  | "millisecond"
+  | "second"
+  | "minute";
+
+export const makeNumberFormat = (unit: TimeUnit, fraction = 0) =>
   Intl.NumberFormat(undefined, {
     useGrouping: false,
     minimumFractionDigits: 0,
     maximumFractionDigits: fraction,
+    style: "unit",
+    unitDisplay: "long",
+    unit,
   });
-
-// creating them once increases the performance significantly
-const intFormat = makeNumberFormat();
-const floatFormat = makeNumberFormat(2);
-
-// not using R.cond for performance optimization
-const pickTimeUnit = (ms: number): [string, number, Intl.NumberFormat] => {
-  if (ms < 1e-6) return ["picosecond", ms / 1e-9, intFormat];
-  if (ms < 1e-3) return ["nanosecond", ms / 1e-6, intFormat];
-  if (ms < 1) return ["microsecond", ms / 1e-3, intFormat];
-  if (ms < 1e3) return ["millisecond", ms, intFormat];
-  if (ms < 6e4) return ["second", ms / 1e3, floatFormat];
-  return ["minute", ms / 6e4, floatFormat];
-};
-
-export const formatDuration = (durationMs: number) => {
-  const [unit, converted, formatter] = pickTimeUnit(durationMs);
-  return `${formatter.format(converted)} ${unit}${converted > 1 ? "s" : ""}`;
-};

tests/system/__snapshots__/system.spec.ts.snap

@@ -27,7 +27,7 @@ exports[`App > Protocol > Should fail on invalid method 1`] = `
 exports[`App > Protocol > Should fail on malformed body 1`] = `
 {
   "error": {
-    "message": StringMatching /\\(Unexpected end of JSON input\\|Unterminated string in JSON at position 25\\)/,
+    "message": StringMatching /Unterminated string in JSON at position 25/,
   },
   "status": "error",
 }

tests/system/system.spec.ts

@@ -357,9 +357,7 @@ describe("App", async () => {
       expect(json).toMatchSnapshot({
         error: {
           message: expect.stringMatching(
-            // @todo revisit when Node 18 dropped
-            // the 2nd option is for Node 20+
-            /(Unexpected end of JSON input|Unterminated string in JSON at position 25)/,
+            /Unterminated string in JSON at position 25/,
           ),
         },
       });

tests/unit/__snapshots__/builtin-logger.spec.ts.snap

@@ -138,3 +138,43 @@ exports[`BuiltinLogger > constructor() > Should handle non-object meta 1 1`] = `
   ],
 ]
 `;
+
+exports[`BuiltinLogger > formatDuration() > 0 should format 1e-9 ms 1`] = `"0.001 nanoseconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 1 should format 1e-8 ms 1`] = `"0.01 nanoseconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 2 should format 1e-7 ms 1`] = `"0.1 nanoseconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 3 should format 0.000001 ms 1`] = `"1 nanosecond"`;
+
+exports[`BuiltinLogger > formatDuration() > 4 should format 0.00001 ms 1`] = `"10 nanoseconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 5 should format 0.0001 ms 1`] = `"100 nanoseconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 6 should format 0.001 ms 1`] = `"1 microsecond"`;
+
+exports[`BuiltinLogger > formatDuration() > 7 should format 0.01 ms 1`] = `"10 microseconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 8 should format 0.1 ms 1`] = `"100 microseconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 9 should format 1 ms 1`] = `"1 millisecond"`;
+
+exports[`BuiltinLogger > formatDuration() > 10 should format 10 ms 1`] = `"10 milliseconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 11 should format 100 ms 1`] = `"100 milliseconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 12 should format 1000 ms 1`] = `"1 second"`;
+
+exports[`BuiltinLogger > formatDuration() > 13 should format 1500 ms 1`] = `"1.5 seconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 14 should format 10000 ms 1`] = `"10 seconds"`;
+
+exports[`BuiltinLogger > formatDuration() > 15 should format 100000 ms 1`] = `"1.67 minutes"`;
+
+exports[`BuiltinLogger > formatDuration() > 16 should format 1000000 ms 1`] = `"16.67 minutes"`;
+
+exports[`BuiltinLogger > formatDuration() > 17 should format 10000000 ms 1`] = `"166.67 minutes"`;
+
+exports[`BuiltinLogger > formatDuration() > 18 should format 100000000 ms 1`] = `"1666.67 minutes"`;
+
+exports[`BuiltinLogger > formatDuration() > 19 should format 1000000000 ms 1`] = `"16666.67 minutes"`;

tests/unit/builtin-logger.spec.ts

@@ -106,6 +106,16 @@ describe("BuiltinLogger", () => {
     });
   });
 
+  describe("formatDuration()", () => {
+    test.each([
+      1e-9, 1e-8, 1e-7, 1e-6, 1e-5, 1e-4, 1e-3, 1e-2, 1e-1, 1, 1e1, 1e2, 1e3,
+      15e2, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
+    ])("%# should format %s ms", (duration) => {
+      const { logger } = makeLogger({ level: "debug", color: false });
+      expect(logger["formatDuration"](duration)).toMatchSnapshot();
+    });
+  });
+
   describe("profile()", () => {
     test.each([1e-3, 1e-2, 1e-1, 1, 1e1, 1e2, 1e3])(
       "should measure %s ms",
@@ -117,7 +127,7 @@ describe("BuiltinLogger", () => {
         stop();
         expect(logSpy).toHaveBeenCalledWith(
           expect.stringMatching(
-            /2022-01-01T00:00:00.000Z debug: test '[\d.]+ (pico|micro|milli)?second(s)?'/,
+            /2022-01-01T00:00:00.000Z debug: test '[\d.]+ (micro|milli)?second(s)?'/,
           ),
         );
       },

tests/unit/logger-helpers.spec.ts

@@ -2,10 +2,10 @@ import { BuiltinLogger } from "../../src";
 import { BuiltinLoggerConfig } from "../../src/builtin-logger";
 import {
   AbstractLogger,
-  formatDuration,
   isLoggerInstance,
   isSeverity,
   isHidden,
+  makeNumberFormat,
 } from "../../src/logger-helpers";
 
 describe("Logger helpers", () => {
@@ -78,12 +78,37 @@ describe("Logger helpers", () => {
     });
   });
 
-  describe("formatDuration()", () => {
-    test.each([
-      1e-9, 1e-8, 1e-7, 1e-6, 1e-5, 1e-4, 1e-3, 1e-2, 1e-1, 1, 1e1, 1e2, 1e3,
-      15e2, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
-    ])("%# should format %s ms", (duration) =>
-      expect(formatDuration(duration)).toMatchSnapshot(),
-    );
-  });
+  describe.each([undefined, 0, 2])(
+    "makeNumberFormat() with %s fraction",
+    (fraction) => {
+      const defaultLocale = new Intl.NumberFormat().resolvedOptions().locale;
+      test.each([
+        "nanosecond",
+        "microsecond",
+        "millisecond",
+        "second",
+        "minute",
+      ] as const)("should return Intl instance for %s unit", (unit) => {
+        const instance = makeNumberFormat(unit, fraction);
+        expect(instance).toBeInstanceOf(Intl.NumberFormat);
+        expect(instance.resolvedOptions()).toEqual({
+          unit,
+          maximumFractionDigits: fraction || 0,
+          locale: defaultLocale,
+          minimumFractionDigits: 0,
+          minimumIntegerDigits: 1,
+          notation: "standard",
+          numberingSystem: "latn",
+          roundingIncrement: 1,
+          roundingMode: "halfExpand",
+          roundingPriority: "auto",
+          signDisplay: "auto",
+          style: "unit",
+          trailingZeroDisplay: "auto",
+          unitDisplay: "long",
+          useGrouping: false,
+        });
+      });
+    },
+  );
 });

tsconfig.base.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@tsconfig/node18/tsconfig.json",
+  "extends": "@tsconfig/node20/tsconfig.json",
   "compilerOptions": {
     "noImplicitAny": true,
     "noImplicitOverride": true,

yarn.lock

@@ -679,10 +679,10 @@
   resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-4.6.0.tgz#3c7c9c46e678feefe7a2e5bb609d3dbd665ffb3f"
   integrity sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==
 
-"@tsconfig/node18@^18.2.1":
-  version "18.2.4"
-  resolved "https://registry.yarnpkg.com/@tsconfig/node18/-/node18-18.2.4.tgz#094efbdd70f697d37c09f34067bf41bc4a828ae3"
-  integrity sha512-5xxU8vVs9/FNcvm3gE07fPbn9tl6tqGGWA9tSlwsUEkBxtRnTsNmwrV8gasZ9F/EobaSv9+nu8AxUKccw77JpQ==
+"@tsconfig/node20@^20.1.4":
+  version "20.1.4"
+  resolved "https://registry.yarnpkg.com/@tsconfig/node20/-/node20-20.1.4.tgz#3457d42eddf12d3bde3976186ab0cd22b85df928"
+  integrity sha512-sqgsT69YFeLWf5NtJ4Xq/xAF8p4ZQHlmGW74Nu2tD4+g5fAsposc4ZfaaPixVu4y01BEiDCWLRDCvDM5JOsRxg==
 
 "@types/body-parser@*":
   version "1.19.5"