canonicalize units

Author: ktrz

src/canonicalizeUnit.ts

@@ -0,0 +1,3 @@
+export function canonicalizeUnit(u: string): string {
+    return u.trim().toLowerCase().replace(/µs|μs/g, 'us');
+}

src/normalizeBenchmarkResult.ts

@@ -4,19 +4,19 @@ import { extractRangeInfo } from './extractRangeInfo';
 
 export function normalizeBenchmarkResult(
     prevBenchResult: BenchmarkResult | undefined | null,
-    currentBenchResult: BenchmarkResult,
+    currenBenchResult: BenchmarkResult,
 ): BenchmarkResult {
     if (!prevBenchResult) {
-        return currentBenchResult;
+        return currenBenchResult;
     }
 
     const prevUnit = prevBenchResult.unit;
-    const currentUnit = currentBenchResult.unit;
-    const currentRange = currentBenchResult.range;
+    const currentUnit = currenBenchResult.unit;
+    const currentRange = currenBenchResult.range;
     const currentRangeInfo = extractRangeInfo(currentRange);
 
-    const normalizedValue = normalizeValueByUnit(prevUnit, currentUnit, currentBenchResult.value);
-    const normalizedUnit = currentBenchResult.value !== normalizedValue ? prevUnit : currentUnit;
+    const normalizedValue = normalizeValueByUnit(prevUnit, currentUnit, currenBenchResult.value);
+    const normalizedUnit = currenBenchResult.value !== normalizedValue ? prevUnit : currentUnit;
     const normalizedRangeInfo = currentRangeInfo
         ? {
               prefix: currentRangeInfo.prefix,
@@ -25,7 +25,7 @@ export function normalizeBenchmarkResult(
         : undefined;
 
     return {
-        ...currentBenchResult,
+        ...currenBenchResult,
         value: normalizedValue,
         unit: normalizedUnit,
         range: normalizedRangeInfo ? `${normalizedRangeInfo.prefix}${normalizedRangeInfo.value}` : currentRange,

src/normalizeValueByUnit.ts

@@ -1,7 +1,11 @@
+import { canonicalizeUnit } from './canonicalizeUnit';
+
 export function normalizeValueByUnit(prevUnit: string, currentUnit: string, value: number): number {
     for (const units of SUPPORTED_UNITS) {
-        const prevUnitIndex = units.indexOf(prevUnit);
-        const currentUnitIndex = units.indexOf(currentUnit);
+        const prev = canonicalizeUnit(prevUnit);
+        const current = canonicalizeUnit(currentUnit);
+        const prevUnitIndex = units.indexOf(prev);
+        const currentUnitIndex = units.indexOf(current);
 
         if (prevUnitIndex >= 0 && currentUnitIndex >= 0) {
             const unitDiff = prevUnitIndex - currentUnitIndex;

test/normalizeValueByUnit.spec.ts

@@ -37,6 +37,18 @@ describe('normalizeValueByUnit', () => {
         expect(normalizeValueByUnit('ops/s', 'ops/ns', 12)).toBe(12_000_000_000);
     });
 
+    it('handles microsecond symbol variants', () => {
+        expect(normalizeValueByUnit('ms', 'µs', 12)).toBe(0.012);
+        expect(normalizeValueByUnit('ms', 'μs', 12)).toBe(0.012);
+        expect(normalizeValueByUnit('us', 'µs', 12)).toBe(12);
+        expect(normalizeValueByUnit('us', 'μs', 12)).toBe(12);
+        expect(normalizeValueByUnit('µs', 'μs', 12)).toBe(12);
+        expect(normalizeValueByUnit('ops/µs', 'ops/s', 12_000_000)).toBe(12);
+    });
+    it('tolerates surrounding whitespace and case', () => {
+        expect(normalizeValueByUnit(' S ', ' MS ', 12)).toBe(0.012);
+    });
+
     it('NOT normalize when new unit is not supported', () => {
         expect(normalizeValueByUnit('unknown1', 'unknown2', 12)).toBe(12);
     });