modestbench 0.0.1

package/dist/reporters/csv.js

@@ -0,0 +1,246 @@
+/**
+ * ModestBench CSV Reporter
+ *
+ * Outputs benchmark results in CSV format for data analysis and visualization.
+ * Provides structured tabular data suitable for spreadsheets and statistical
+ * tools.
+ */
+import { mkdirSync, writeFileSync } from 'node:fs';
+import { dirname } from 'node:path';
+import { BaseReporter } from "./registry.js";
+/**
+ * CSV reporter for structured tabular output
+ */
+export class CsvReporter extends BaseReporter {
+    currentFile = '';
+    currentRun;
+    currentSuite = '';
+    delimiter;
+    includeHeaders;
+    includeMetadata;
+    outputPath;
+    quiet;
+    quote;
+    rows = [];
+    constructor(options = {}) {
+        super('csv', options);
+        this.outputPath = options.outputPath;
+        this.includeHeaders = options.includeHeaders ?? true;
+        this.includeMetadata = options.includeMetadata ?? true;
+        this.delimiter = options.delimiter ?? ',';
+        this.quote = options.quote ?? '"';
+        this.quiet = options.quiet ?? false;
+    }
+    /**
+     * Check if headers are included
+     */
+    areHeadersIncluded() {
+        return this.includeHeaders;
+    }
+    /**
+     * Get the delimiter character
+     */
+    getDelimiter() {
+        return this.delimiter;
+    }
+    /**
+     * Get the output path (if configured)
+     */
+    getOutputPath() {
+        return this.outputPath;
+    }
+    /**
+     * Get the quote character
+     */
+    getQuote() {
+        return this.quote;
+    }
+    /**
+     * Get the number of rows collected
+     */
+    getRowCount() {
+        return this.rows.length;
+    }
+    /**
+     * Check if metadata is included
+     */
+    isMetadataIncluded() {
+        return this.includeMetadata;
+    }
+    async onEnd(_run) {
+        const csvContent = this.generateCsv();
+        if (this.outputPath) {
+            await this.writeToFile(csvContent);
+        }
+        else {
+            this.writeToStdout(csvContent);
+        }
+    }
+    onError(error) {
+        console.error('CSV Reporter Error:', error.message);
+    }
+    onFileEnd(_result) {
+        // No-op for CSV reporter
+    }
+    onFileStart(file) {
+        this.currentFile = file;
+    }
+    onProgress(_state) {
+        // No-op for CSV reporter
+    }
+    onStart(run) {
+        this.currentRun = run;
+        this.rows = [];
+    }
+    onSuiteEnd(_result) {
+        // No-op for CSV reporter
+    }
+    onSuiteStart(suite) {
+        this.currentSuite = suite;
+    }
+    onTaskResult(result) {
+        if (!this.currentRun) {
+            return;
+        }
+        const row = {
+            arch: this.currentRun.environment.arch,
+            ciProvider: this.currentRun.ci?.provider,
+            cpuCores: this.currentRun.environment.cpu.cores,
+            cpuModel: this.currentRun.environment.cpu.model,
+            error: result.error?.message,
+            file: this.currentFile,
+            gitBranch: this.currentRun.git?.branch,
+            gitCommit: this.currentRun.git?.commit,
+            iterations: result.iterations,
+            marginOfError: result.marginOfError,
+            max: result.max,
+            mean: result.mean,
+            min: result.min,
+            nodeVersion: this.currentRun.environment.nodeVersion,
+            opsPerSecond: result.opsPerSecond,
+            p95: result.p95,
+            p99: result.p99,
+            platform: this.currentRun.environment.platform,
+            stdDev: result.stdDev,
+            suite: this.currentSuite,
+            task: result.name,
+            timestamp: new Date().toISOString(),
+            totalMemory: this.currentRun.environment.memory.total,
+            variance: result.variance,
+        };
+        this.rows.push(row);
+    }
+    onTaskStart(_task) {
+        // No-op for CSV reporter
+    }
+    /**
+     * Escape a field value for CSV format
+     */
+    escapeField(value) {
+        // If value contains delimiter, quote, or newline, wrap in quotes
+        if (value.includes(this.delimiter) ||
+            value.includes(this.quote) ||
+            value.includes('\n') ||
+            value.includes('\r')) {
+            // Escape any existing quotes by doubling them
+            const escaped = value.replace(new RegExp(this.quote, 'g'), this.quote + this.quote);
+            return this.quote + escaped + this.quote;
+        }
+        return value;
+    }
+    /**
+     * Generate CSV content from collected rows
+     */
+    generateCsv() {
+        if (this.rows.length === 0) {
+            return this.includeHeaders ? this.generateHeaders() : '';
+        }
+        const lines = [];
+        if (this.includeHeaders) {
+            lines.push(this.generateHeaders());
+        }
+        for (const row of this.rows) {
+            lines.push(this.generateRow(row));
+        }
+        return lines.join('\n') + '\n';
+    }
+    /**
+     * Generate CSV headers
+     */
+    generateHeaders() {
+        const headers = [
+            'file',
+            'suite',
+            'task',
+            'mean',
+            'stdDev',
+            'min',
+            'max',
+            'iterations',
+            'opsPerSecond',
+            'marginOfError',
+            'variance',
+            'p95',
+            'p99',
+            'error',
+            'timestamp',
+        ];
+        if (this.includeMetadata) {
+            headers.push('nodeVersion', 'platform', 'arch', 'cpuModel', 'cpuCores', 'totalMemory', 'gitCommit', 'gitBranch', 'ciProvider');
+        }
+        return headers.map((h) => this.escapeField(h)).join(this.delimiter);
+    }
+    /**
+     * Generate a CSV row from a data row
+     */
+    generateRow(row) {
+        const values = [
+            row.file || '',
+            row.suite || '',
+            row.task || '',
+            (row.mean ?? 0).toString(),
+            (row.stdDev ?? 0).toString(),
+            (row.min ?? 0).toString(),
+            (row.max ?? 0).toString(),
+            (row.iterations ?? 0).toString(),
+            (row.opsPerSecond ?? 0).toString(),
+            (row.marginOfError ?? 0).toString(),
+            (row.variance ?? 0).toString(),
+            (row.p95 ?? 0).toString(),
+            (row.p99 ?? 0).toString(),
+            row.error || '',
+            row.timestamp || '',
+        ];
+        if (this.includeMetadata) {
+            values.push(row.nodeVersion || '', row.platform || '', row.arch || '', row.cpuModel || '', (row.cpuCores ?? 0).toString(), (row.totalMemory ?? 0).toString(), row.gitCommit || '', row.gitBranch || '', row.ciProvider || '');
+        }
+        return values.map((v) => this.escapeField(v)).join(this.delimiter);
+    }
+    /**
+     * Write CSV content to file
+     */
+    async writeToFile(csvContent) {
+        if (!this.outputPath) {
+            throw new Error('Output path not specified');
+        }
+        try {
+            // Ensure directory exists
+            const dir = dirname(this.outputPath);
+            mkdirSync(dir, { recursive: true });
+            // Write CSV file
+            writeFileSync(this.outputPath, csvContent, 'utf8');
+        }
+        catch (error) {
+            throw new Error(`Failed to write CSV output to ${this.outputPath}: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    /**
+     * Write CSV content to stdout
+     */
+    writeToStdout(csvContent) {
+        // Always write to stdout when no output path is specified
+        // The quiet flag only affects progress messages (stderr), not data output
+        console.log(csvContent);
+    }
+}
+//# sourceMappingURL=csv.js.map

package/dist/reporters/csv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"csv.js","sourceRoot":"","sources":["../../src/reporters/csv.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAUpC,OAAO,EAAE,YAAY,EAAE,sBAAsB;AAgC7C;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,YAAY;IACnC,WAAW,GAAG,EAAE,CAAC;IAEjB,UAAU,CAAgB;IAE1B,YAAY,GAAG,EAAE,CAAC;IAET,SAAS,CAAS;IAElB,cAAc,CAAU;IAExB,eAAe,CAAU;IAEzB,UAAU,CAAsB;IAEhC,KAAK,CAAU;IAEf,KAAK,CAAS;IAEvB,IAAI,GAAa,EAAE,CAAC;IAE5B,YACE,UAQI,EAAE;QAEN,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAEtB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,IAAI,CAAC;QACrD,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,IAAI,CAAC;QACvD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,GAAG,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAkB;QAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAEtC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO,CAAC,KAAY;QAClB,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAED,SAAS,CAAC,OAAmB;QAC3B,yBAAyB;IAC3B,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,UAAU,CAAC,MAAqB;QAC9B,yBAAyB;IAC3B,CAAC;IAED,OAAO,CAAC,GAAiB;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;IACjB,CAAC;IAED,UAAU,CAAC,OAAoB;QAC7B,yBAAyB;IAC3B,CAAC;IAED,YAAY,CAAC,KAAa;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED,YAAY,CAAC,MAAkB;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,MAAM,GAAG,GAAW;YAClB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI;YACtC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,QAAQ;YACxC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK;YAC/C,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK;YAC/C,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO;YAC5B,IAAI,EAAE,IAAI,CAAC,WAAW;YACtB,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM;YACtC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM;YACtC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW;YACpD,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ;YAC9C,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,KAAK,EAAE,IAAI,CAAC,YAAY;YACxB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK;YACrD,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,KAAa;QACvB,yBAAyB;IAC3B,CAAC;IAED;;OAEG;IACK,WAAW,CAAC,KAAa;QAC/B,iEAAiE;QACjE,IACE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;YAC9B,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;YACpB,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EACpB,CAAC;YACD,8CAA8C;YAC9C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAC3B,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,EAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CACxB,CAAC;YACF,OAAO,IAAI,CAAC,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;QAC3C,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACK,WAAW;QACjB,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;QACrC,CAAC;QAED,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACjC,CAAC;IAED;;OAEG;IACK,eAAe;QACrB,MAAM,OAAO,GAAG;YACd,MAAM;YACN,OAAO;YACP,MAAM;YACN,MAAM;YACN,QAAQ;YACR,KAAK;YACL,KAAK;YACL,YAAY;YACZ,cAAc;YACd,eAAe;YACf,UAAU;YACV,KAAK;YACL,KAAK;YACL,OAAO;YACP,WAAW;SACZ,CAAC;QAEF,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CACV,aAAa,EACb,UAAU,EACV,MAAM,EACN,UAAU,EACV,UAAU,EACV,aAAa,EACb,WAAW,EACX,WAAW,EACX,YAAY,CACb,CAAC;QACJ,CAAC;QAED,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACK,WAAW,CAAC,GAAW;QAC7B,MAAM,MAAM,GAAG;YACb,GAAG,CAAC,IAAI,IAAI,EAAE;YACd,GAAG,CAAC,KAAK,IAAI,EAAE;YACf,GAAG,CAAC,IAAI,IAAI,EAAE;YACd,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YAC1B,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YAC5B,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACzB,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACzB,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YAChC,CAAC,GAAG,CAAC,YAAY,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YAClC,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACnC,CAAC,GAAG,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YAC9B,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACzB,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACzB,GAAG,CAAC,KAAK,IAAI,EAAE;YACf,GAAG,CAAC,SAAS,IAAI,EAAE;SACpB,CAAC;QAEF,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CACT,GAAG,CAAC,WAAW,IAAI,EAAE,EACrB,GAAG,CAAC,QAAQ,IAAI,EAAE,EAClB,GAAG,CAAC,IAAI,IAAI,EAAE,EACd,GAAG,CAAC,QAAQ,IAAI,EAAE,EAClB,CAAC,GAAG,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,EAC9B,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,EACjC,GAAG,CAAC,SAAS,IAAI,EAAE,EACnB,GAAG,CAAC,SAAS,IAAI,EAAE,EACnB,GAAG,CAAC,UAAU,IAAI,EAAE,CACrB,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,WAAW,CAAC,UAAkB;QAC1C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,CAAC;YACH,0BAA0B;YAC1B,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACrC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAEpC,iBAAiB;YACjB,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,iCAAiC,IAAI,CAAC,UAAU,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAC9G,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,UAAkB;QACtC,0DAA0D;QAC1D,0EAA0E;QAC1E,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1B,CAAC;CACF"}