cronometro/dist/print.js

Simple benchmarking suite powered by HDR histograms.

import { clean, colorize } from 'acquerello';
import { table } from 'table';
const styles = ['red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'gray'];
let currentLogger = console.log;
export function setLogger(logger) {
    currentLogger = logger;
}
export function printResults(results, colors, compare, mode) {
    const styler = colors ? colorize : clean;
    // Sort results by least performant first, then compare relative performances and also printing padding
    let last = 0;
    let compared = '';
    let standardErrorPadding = 0;
    const entries = Object.entries(results)
        .sort((a, b) => (!a[1].success ? -1 : b[1].mean - a[1].mean))
        .map(([name, result]) => {
        if (!result.success) {
            return {
                name,
                size: 0,
                error: result.error,
                throughput: '',
                standardError: '',
                relative: '',
                compared: ''
            };
        }
        const { size, mean, standardError } = result;
        const relative = last !== 0 ? (last / mean - 1) * 100 : 0;
        if (mode === 'base') {
            if (last === 0) {
                last = mean;
                compared = name;
            }
        }
        else {
            last = mean;
            compared = name;
        }
        const standardErrorString = ((standardError / mean) * 100).toFixed(2);
        standardErrorPadding = Math.max(standardErrorPadding, standardErrorString.length);
        return {
            name,
            size,
            error: null,
            throughput: (1e9 / mean).toFixed(2),
            standardError: standardErrorString,
            relative: relative.toFixed(2),
            compared
        };
    });
    let currentColor = 0;
    const rows = entries.map(entry => {
        if (entry.error) {
            const row = [
                styler(`{{gray}}${entry.name}{{-}}`),
                styler(`{{gray}}${entry.size}{{-}}`),
                styler('{{gray}}Errored{{-}}'),
                styler('{{gray}}N/A{{-}}')
            ];
            if (compare) {
                row.push(styler('{{gray}}N/A{{-}}'));
            }
            return row;
        }
        const { name, size, throughput, standardError, relative } = entry;
        const color = styles[currentColor++ % styles.length];
        const row = [
            styler(`{{${color}}}${name}{{-}}`),
            styler(`{{${color}}}${size}{{-}}`),
            styler(`{{${color}}}${throughput} op/sec{{-}}`),
            styler(`{{gray}}± ${standardError.padStart(standardErrorPadding, ' ')} %{{-}}`)
        ];
        if (compare) {
            if (/^[\s.0]+$/.test(relative)) {
                row.push('');
            }
            else {
                row.push(styler(`{{${color}}}+ ${relative} %{{-}}`));
            }
        }
        return row;
    });
    const compareHeader = `Difference with ${mode === 'base' ? 'slowest' : 'previous'}`;
    rows.unshift([
        styler('{{bold white}}Slower tests{{-}}'),
        styler('{{bold white}}Samples{{-}}'),
        styler('{{bold white}}Result{{-}}'),
        styler('{{bold white}}Tolerance{{-}}')
    ]);
    rows.splice(-1, 0, [
        styler('{{bold white}}Fastest test{{-}}'),
        styler('{{bold white}}Samples{{-}}'),
        styler('{{bold white}}Result{{-}}'),
        styler('{{bold white}}Tolerance{{-}}')
    ]);
    if (compare) {
        rows[0].push(styler(`{{bold white}}${compareHeader}{{-}}`));
        rows.at(-2).push(styler(`{{bold white}}${compareHeader}{{-}}`));
    }
    currentLogger(table(rows, {
        columns: {
            0: {
                alignment: 'left'
            },
            1: {
                alignment: 'right'
            },
            2: {
                alignment: 'right'
            },
            3: {
                alignment: 'right'
            }
        },
        drawHorizontalLine(index, size) {
            return index < 2 || index > size - 3;
        }
    }));
}