@buoy-gg/benchmark 2.1.4-beta.2 → 2.1.4

package/lib/commonjs/benchmarking/BenchmarkComparator.js

@@ -1,221 +1 @@
-/**
- * BenchmarkComparator
- *
- * Compares two benchmark reports and generates a detailed comparison result.
- * Calculates improvements/regressions across all metrics and provides
- * human-readable summaries.
- *
- * Usage:
- *   const comparison = BenchmarkComparator.compare(baselineReport, comparisonReport);
- *   console.log(comparison.summary);
- *   console.log(`Overall improvement: ${comparison.overallImprovement.toFixed(1)}%`);
- *
- * @packageDocumentation
- */
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.BenchmarkComparator = void 0;
-/**
- * Calculate percentage improvement (positive = better)
- * @param baseline - The baseline value
- * @param comparison - The comparison value
- * @returns Percentage improvement (positive = faster/better, negative = slower/worse)
- */
-function calculateImprovement(baseline, comparison) {
-  if (baseline === 0) return 0;
-  return (baseline - comparison) / baseline * 100;
-}
-
-/**
- * Format a percentage with sign
- */
-function formatPercent(value) {
-  const sign = value >= 0 ? "+" : "";
-  return `${sign}${value.toFixed(1)}%`;
-}
-
-/**
- * Format milliseconds
- */
-function formatMs(value) {
-  return `${value.toFixed(1)}ms`;
-}
-
-/**
- * Format bytes as MB
- */
-function formatBytes(bytes) {
-  const mb = bytes / 1024 / 1024;
-  const sign = mb >= 0 ? "+" : "";
-  return `${sign}${mb.toFixed(2)}MB`;
-}
-
-/**
- * Get an emoji indicator for improvement
- */
-function getIndicator(improvement, threshold = 5) {
-  if (improvement > threshold) return "✅";
-  if (improvement < -threshold) return "❌";
-  return "➖";
-}
-
-/**
- * BenchmarkComparator - Compares two benchmark reports
- */
-class BenchmarkComparator {
-  /**
-   * Compare two benchmark reports
-   * @param baseline - The baseline (before) report
-   * @param comparison - The comparison (after) report
-   * @returns Detailed comparison result
-   */
-  static compare(baseline, comparison) {
-    const baselineStats = baseline.stats;
-    const comparisonStats = comparison.stats;
-
-    // Duration changes
-    const durationDelta = comparison.duration - baseline.duration;
-    const durationImprovement = calculateImprovement(baseline.duration, comparison.duration);
-
-    // Pipeline timing improvements
-    const filterTimeImprovement = calculateImprovement(baselineStats.avgFilterTime, comparisonStats.avgFilterTime);
-    const measureTimeImprovement = calculateImprovement(baselineStats.avgMeasureTime, comparisonStats.avgMeasureTime);
-    const trackTimeImprovement = calculateImprovement(baselineStats.avgTrackTime, comparisonStats.avgTrackTime);
-    const pipelineTimeImprovement = calculateImprovement(baselineStats.avgTotalTime, comparisonStats.avgTotalTime);
-
-    // Overlay render improvement
-    const overlayRenderImprovement = calculateImprovement(baselineStats.avgOverlayRenderTime, comparisonStats.avgOverlayRenderTime);
-
-    // Memory changes
-    let memoryDeltaChange = null;
-    if (baseline.memoryDelta != null && comparison.memoryDelta != null) {
-      memoryDeltaChange = comparison.memoryDelta - baseline.memoryDelta;
-    }
-
-    // Overall improvement (weighted average of key metrics)
-    // Weights: measurement time (40%), pipeline time (30%), overlay render (20%), memory (10%)
-    const weights = {
-      measure: 0.4,
-      pipeline: 0.3,
-      overlay: 0.2,
-      memory: 0.1
-    };
-    let overallImprovement = measureTimeImprovement * weights.measure + pipelineTimeImprovement * weights.pipeline + overlayRenderImprovement * weights.overlay;
-
-    // Add memory improvement if available
-    if (baseline.memoryDelta != null && comparison.memoryDelta != null && baseline.memoryDelta !== 0) {
-      const memoryImprovement = calculateImprovement(baseline.memoryDelta, comparison.memoryDelta);
-      overallImprovement += memoryImprovement * weights.memory;
-    }
-    const isImproved = overallImprovement > 0;
-
-    // Generate summary
-    const summary = this.generateSummary({
-      baseline,
-      comparison,
-      durationDelta,
-      durationImprovement,
-      measureTimeImprovement,
-      pipelineTimeImprovement,
-      overlayRenderImprovement,
-      memoryDeltaChange,
-      overallImprovement,
-      isImproved
-    });
-    return {
-      baselineId: baseline.id,
-      baselineName: baseline.name,
-      comparisonId: comparison.id,
-      comparisonName: comparison.name,
-      comparedAt: Date.now(),
-      durationDelta,
-      durationImprovement,
-      filterTimeImprovement,
-      measureTimeImprovement,
-      trackTimeImprovement,
-      pipelineTimeImprovement,
-      overlayRenderImprovement,
-      memoryDeltaChange,
-      overallImprovement,
-      isImproved,
-      summary
-    };
-  }
-
-  /**
-   * Generate a human-readable summary
-   */
-  static generateSummary(data) {
-    const {
-      baseline,
-      comparison,
-      measureTimeImprovement,
-      pipelineTimeImprovement,
-      overlayRenderImprovement,
-      memoryDeltaChange,
-      overallImprovement,
-      isImproved
-    } = data;
-    const lines = [];
-    lines.push("╔══════════════════════════════════════════════════════════════╗");
-    lines.push("║               BENCHMARK COMPARISON                           ║");
-    lines.push("╠══════════════════════════════════════════════════════════════╣");
-    lines.push(`║ Baseline: ${baseline.name.substring(0, 50).padEnd(50)} ║`);
-    lines.push(`║   ${new Date(baseline.createdAt).toLocaleString().substring(0, 58).padEnd(58)} ║`);
-    lines.push(`║ Comparison: ${comparison.name.substring(0, 48).padEnd(48)} ║`);
-    lines.push(`║   ${new Date(comparison.createdAt).toLocaleString().substring(0, 58).padEnd(58)} ║`);
-    lines.push("╠══════════════════════════════════════════════════════════════╣");
-    lines.push("║ TIMING COMPARISON                                            ║");
-    lines.push("║                         Baseline    After     Change         ║");
-    lines.push(`║ Measurement Time:    ${formatMs(baseline.stats.avgMeasureTime).padStart(8)} → ` + `${formatMs(comparison.stats.avgMeasureTime).padStart(8)}  ` + `${formatPercent(measureTimeImprovement).padStart(7)} ${getIndicator(measureTimeImprovement)}  ║`);
-    lines.push(`║ Pipeline Time:       ${formatMs(baseline.stats.avgTotalTime).padStart(8)} → ` + `${formatMs(comparison.stats.avgTotalTime).padStart(8)}  ` + `${formatPercent(pipelineTimeImprovement).padStart(7)} ${getIndicator(pipelineTimeImprovement)}  ║`);
-    lines.push(`║ Overlay Render:      ${formatMs(baseline.stats.avgOverlayRenderTime).padStart(8)} → ` + `${formatMs(comparison.stats.avgOverlayRenderTime).padStart(8)}  ` + `${formatPercent(overlayRenderImprovement).padStart(7)} ${getIndicator(overlayRenderImprovement)}  ║`);
-    if (memoryDeltaChange != null && baseline.memoryDelta != null && comparison.memoryDelta != null) {
-      const memoryImprovement = calculateImprovement(baseline.memoryDelta, comparison.memoryDelta);
-      lines.push("╠══════════════════════════════════════════════════════════════╣");
-      lines.push("║ MEMORY                                                       ║");
-      lines.push(`║ Delta:               ${formatBytes(baseline.memoryDelta).padStart(8)} → ` + `${formatBytes(comparison.memoryDelta).padStart(8)}  ` + `${formatPercent(memoryImprovement).padStart(7)} ${getIndicator(memoryImprovement)}  ║`);
-    }
-    lines.push("╠══════════════════════════════════════════════════════════════╣");
-    lines.push("║ PERCENTILES (P95)                                            ║");
-    const p95Improvement = calculateImprovement(baseline.stats.p95TotalTime, comparison.stats.p95TotalTime);
-    lines.push(`║ P95 Pipeline:        ${formatMs(baseline.stats.p95TotalTime).padStart(8)} → ` + `${formatMs(comparison.stats.p95TotalTime).padStart(8)}  ` + `${formatPercent(p95Improvement).padStart(7)} ${getIndicator(p95Improvement)}  ║`);
-    lines.push("╠══════════════════════════════════════════════════════════════╣");
-    const resultEmoji = isImproved ? "🎉" : "⚠️";
-    const resultText = isImproved ? "IMPROVED" : "REGRESSED";
-    lines.push(`║ ${resultEmoji} OVERALL: ${formatPercent(overallImprovement).padStart(7)} ${resultText.padEnd(40)} ║`);
-    lines.push("╚══════════════════════════════════════════════════════════════╝");
-    return lines.join("\n");
-  }
-
-  /**
-   * Log a comparison to the console
-   */
-  static logComparison(comparison) {
-    console.log("\n" + comparison.summary + "\n");
-  }
-
-  /**
-   * Quick compare: compare baseline vs comparison and log results
-   */
-  static quickCompare(baseline, comparison) {
-    const result = this.compare(baseline, comparison);
-    this.logComparison(result);
-    return result;
-  }
-
-  /**
-   * Generate a brief one-line summary
-   */
-  static getBriefSummary(comparison) {
-    const direction = comparison.isImproved ? "faster" : "slower";
-    const emoji = comparison.isImproved ? "✅" : "❌";
-    return `${emoji} ${Math.abs(comparison.overallImprovement).toFixed(1)}% ${direction} (measurement: ${formatPercent(comparison.measureTimeImprovement)}, pipeline: ${formatPercent(comparison.pipelineTimeImprovement)})`;
-  }
-}
-exports.BenchmarkComparator = BenchmarkComparator;
-var _default = exports.default = BenchmarkComparator;
+"use strict";function calculateImprovement(e,t){return 0===e?0:(e-t)/e*100}function formatPercent(e){return`${e>=0?"+":""}${e.toFixed(1)}%`}function formatMs(e){return`${e.toFixed(1)}ms`}function formatBytes(e){const t=e/1024/1024;return`${t>=0?"+":""}${t.toFixed(2)}MB`}function getIndicator(e,t=5){return e>t?"✅":e<-t?"❌":"➖"}Object.defineProperty(exports,"__esModule",{value:!0}),exports.default=exports.BenchmarkComparator=void 0;class BenchmarkComparator{static compare(e,t){const a=e.stats,r=t.stats,m=t.duration-e.duration,o=calculateImprovement(e.duration,t.duration),n=calculateImprovement(a.avgFilterTime,r.avgFilterTime),s=calculateImprovement(a.avgMeasureTime,r.avgMeasureTime),p=calculateImprovement(a.avgTrackTime,r.avgTrackTime),i=calculateImprovement(a.avgTotalTime,r.avgTotalTime),l=calculateImprovement(a.avgOverlayRenderTime,r.avgOverlayRenderTime);let u=null;null!=e.memoryDelta&&null!=t.memoryDelta&&(u=t.memoryDelta-e.memoryDelta);let c=.4*s+.3*i+.2*l;null!=e.memoryDelta&&null!=t.memoryDelta&&0!==e.memoryDelta&&(c+=.1*calculateImprovement(e.memoryDelta,t.memoryDelta));const d=c>0,v=this.generateSummary({baseline:e,comparison:t,durationDelta:m,durationImprovement:o,measureTimeImprovement:s,pipelineTimeImprovement:i,overlayRenderImprovement:l,memoryDeltaChange:u,overallImprovement:c,isImproved:d});return{baselineId:e.id,baselineName:e.name,comparisonId:t.id,comparisonName:t.name,comparedAt:Date.now(),durationDelta:m,durationImprovement:o,filterTimeImprovement:n,measureTimeImprovement:s,trackTimeImprovement:p,pipelineTimeImprovement:i,overlayRenderImprovement:l,memoryDeltaChange:u,overallImprovement:c,isImproved:d,summary:v}}static generateSummary(e){const{baseline:t,comparison:a,measureTimeImprovement:r,pipelineTimeImprovement:m,overlayRenderImprovement:o,memoryDeltaChange:n,overallImprovement:s,isImproved:p}=e,i=[];if(i.push("╔══════════════════════════════════════════════════════════════╗"),i.push("║               BENCHMARK COMPARISON                           ║"),i.push("╠══════════════════════════════════════════════════════════════╣"),i.push(`║ Baseline: ${t.name.substring(0,50).padEnd(50)} ║`),i.push(`║   ${new Date(t.createdAt).toLocaleString().substring(0,58).padEnd(58)} ║`),i.push(`║ Comparison: ${a.name.substring(0,48).padEnd(48)} ║`),i.push(`║   ${new Date(a.createdAt).toLocaleString().substring(0,58).padEnd(58)} ║`),i.push("╠══════════════════════════════════════════════════════════════╣"),i.push("║ TIMING COMPARISON                                            ║"),i.push("║                         Baseline    After     Change         ║"),i.push(`║ Measurement Time:    ${formatMs(t.stats.avgMeasureTime).padStart(8)} → ${formatMs(a.stats.avgMeasureTime).padStart(8)}  ${formatPercent(r).padStart(7)} ${getIndicator(r)}  ║`),i.push(`║ Pipeline Time:       ${formatMs(t.stats.avgTotalTime).padStart(8)} → ${formatMs(a.stats.avgTotalTime).padStart(8)}  ${formatPercent(m).padStart(7)} ${getIndicator(m)}  ║`),i.push(`║ Overlay Render:      ${formatMs(t.stats.avgOverlayRenderTime).padStart(8)} → ${formatMs(a.stats.avgOverlayRenderTime).padStart(8)}  ${formatPercent(o).padStart(7)} ${getIndicator(o)}  ║`),null!=n&&null!=t.memoryDelta&&null!=a.memoryDelta){const e=calculateImprovement(t.memoryDelta,a.memoryDelta);i.push("╠══════════════════════════════════════════════════════════════╣"),i.push("║ MEMORY                                                       ║"),i.push(`║ Delta:               ${formatBytes(t.memoryDelta).padStart(8)} → ${formatBytes(a.memoryDelta).padStart(8)}  ${formatPercent(e).padStart(7)} ${getIndicator(e)}  ║`)}i.push("╠══════════════════════════════════════════════════════════════╣"),i.push("║ PERCENTILES (P95)                                            ║");const l=calculateImprovement(t.stats.p95TotalTime,a.stats.p95TotalTime);i.push(`║ P95 Pipeline:        ${formatMs(t.stats.p95TotalTime).padStart(8)} → ${formatMs(a.stats.p95TotalTime).padStart(8)}  ${formatPercent(l).padStart(7)} ${getIndicator(l)}  ║`),i.push("╠══════════════════════════════════════════════════════════════╣");const u=p?"🎉":"⚠️",c=p?"IMPROVED":"REGRESSED";return i.push(`║ ${u} OVERALL: ${formatPercent(s).padStart(7)} ${c.padEnd(40)} ║`),i.push("╚══════════════════════════════════════════════════════════════╝"),i.join("\n")}static logComparison(e){console.log("\n"+e.summary+"\n")}static quickCompare(e,t){const a=this.compare(e,t);return this.logComparison(a),a}static getBriefSummary(e){const t=e.isImproved?"faster":"slower";return`${e.isImproved?"✅":"❌"} ${Math.abs(e.overallImprovement).toFixed(1)}% ${t} (measurement: ${formatPercent(e.measureTimeImprovement)}, pipeline: ${formatPercent(e.pipelineTimeImprovement)})`}}exports.BenchmarkComparator=BenchmarkComparator;var _default=exports.default=BenchmarkComparator;