@mui/internal-benchmark 0.0.3-canary.1 → 0.0.3-canary.3

package/README.md

@@ -114,7 +114,8 @@ vitest run
 
 `createBenchmarkVitestConfig` accepts:
 
-- `outputPath` — path for JSON results (default: `benchmarks/results.json`)
+- `outputPath` — path for JSON results (default: `benchmarks/results.json`). Also settable via `BENCHMARK_OUTPUT_PATH`.
+- `baselinePath` — path to a prior results JSON file to inline as the comparison base (see [Baseline comparisons](#baseline-comparisons)). Also settable via `BENCHMARK_BASELINE_PATH`.
 - `launchArgs` — additional browser launch arguments
 
 To override standard Vitest options (e.g. `include`, `testTimeout`, `headless`), use `mergeConfig`:
@@ -130,6 +131,19 @@ export default mergeConfig(createBenchmarkVitestConfig(), {
 });
 ```
 
+### Baseline comparisons
+
+Benchmark runs are noisy across machines. To get a clean comparison in a PR, run the baseline benchmark in the _same_ CI job as the head: the results are inlined into the head upload as a `base` field, and the dashboard / PR comment render the comparison without fetching a separate base artifact from S3.
+
+```bash
+# in a PR CI job
+git worktree add /tmp/base $BASE_SHA
+(cd /tmp/base && pnpm install && BENCHMARK_OUTPUT_PATH=/tmp/base-bench.json pnpm test:bench)
+BENCHMARK_BASELINE_PATH=/tmp/base-bench.json pnpm test:bench   # head run, inlines base
+```
+
+The feature is opt-in — without `BENCHMARK_BASELINE_PATH` (or the `baselinePath` config option), the dashboard falls back to fetching the base from S3 by merge-base SHA as before.
+
 ## API
 
 - `benchmark` — define a benchmark test case

package/ciReport.d.mts

@@ -58,6 +58,16 @@ declare const benchmarkReportSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     outliers: z.ZodNumber;
   }, z.core.$strip>>;
 }, z.core.$strip>>;
+declare const benchmarkBaseUploadSchema: z.ZodObject<{
+  version: z.ZodLiteral<number>;
+  timestamp: z.ZodNumber;
+  commitSha: z.ZodString;
+  repo: z.ZodString;
+  reportType: z.ZodLiteral<string>;
+  prNumber: z.ZodOptional<z.ZodNumber>;
+  branch: z.ZodString;
+  report: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+}, z.core.$strip>;
 export declare const benchmarkUploadSchema: z.ZodObject<{
   version: z.ZodLiteral<number>;
   timestamp: z.ZodNumber;
@@ -67,17 +77,28 @@ export declare const benchmarkUploadSchema: z.ZodObject<{
   prNumber: z.ZodOptional<z.ZodNumber>;
   branch: z.ZodString;
   report: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+  base: z.ZodOptional<z.ZodObject<{
+    version: z.ZodLiteral<number>;
+    timestamp: z.ZodNumber;
+    commitSha: z.ZodString;
+    repo: z.ZodString;
+    reportType: z.ZodLiteral<string>;
+    prNumber: z.ZodOptional<z.ZodNumber>;
+    branch: z.ZodString;
+    report: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+  }, z.core.$strip>>;
 }, z.core.$strip>;
 export type RenderStats = z.infer<typeof renderStatsSchema>;
 export type MetricStats = z.infer<typeof metricStatsSchema>;
 export type BenchmarkReportEntry = z.infer<typeof benchmarkReportEntrySchema>;
 export type BenchmarkReport = z.infer<typeof benchmarkReportSchema>;
+export type BenchmarkBaseUpload = z.infer<typeof benchmarkBaseUploadSchema>;
 export type BenchmarkUpload = z.infer<typeof benchmarkUploadSchema>;
 export declare function getCiMetadata(): Promise<{
   timestamp: number;
   repo: string;
-  branch: string;
   prNumber: number | undefined;
+  branch: string;
   commitSha: string;
 }>;
 export {};

package/ciReport.mjs

@@ -1,15 +1,12 @@
 import { execa } from 'execa';
 import { z } from 'zod/v4';
 import envCi from 'env-ci';
-async function getCommitSha() {
-  try {
-    const {
-      stdout
-    } = await execa('git', ['rev-parse', 'HEAD']);
-    return stdout.trim();
-  } catch {
-    return null;
-  }
+async function getGitInfo() {
+  const [commit, branch] = await Promise.all([execa('git', ['rev-parse', 'HEAD']), execa('git', ['branch', '--show-current'])]);
+  return {
+    commitSha: commit.stdout,
+    branch: branch.stdout
+  };
 }
 
 /**
@@ -48,14 +45,18 @@ const benchmarkReportEntrySchema = z.object({
   metrics: z.record(z.string(), metricStatsSchema)
 });
 const benchmarkReportSchema = z.record(z.string(), benchmarkReportEntrySchema);
-export const benchmarkUploadSchema = ciReportUploadSchema('benchmark', 1, benchmarkReportSchema);
+const benchmarkBaseUploadSchema = ciReportUploadSchema('benchmark', 1, benchmarkReportSchema);
+export const benchmarkUploadSchema = benchmarkBaseUploadSchema.extend({
+  base: benchmarkBaseUploadSchema.optional()
+});
 export async function getCiMetadata() {
   const ciInfo = envCi();
+  const gitInfo = await getGitInfo();
   return {
     timestamp: Date.now(),
     repo: ciInfo.slug ?? '',
-    branch: ciInfo.isPr ? ciInfo.prBranch ?? '' : ciInfo.branch ?? '',
     prNumber: ciInfo.pr ? Number(ciInfo.pr) : undefined,
-    commitSha: ciInfo.commit ?? (await getCommitSha()) ?? ''
+    branch: gitInfo.branch || process.env.BENCHMARK_BRANCH || (ciInfo.isPr ? ciInfo.prBranch : ciInfo.branch) || '',
+    commitSha: gitInfo.commitSha
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-benchmark",
-  "version": "0.0.3-canary.1",
+  "version": "0.0.3-canary.3",
   "author": "MUI Team",
   "description": "Benchmark utilities for MUI projects. Internal package.",
   "repository": {
@@ -68,5 +68,5 @@
       }
     }
   },
-  "gitSha": "a24bc8adf051b6b19ebdae8a80aaa2650d9b2ae7"
+  "gitSha": "b5ecb08ed447855ed858e123d924a08949b6ad6d"
 }

package/reporter.d.mts

@@ -6,11 +6,13 @@ declare function generateReportFromIterations(iterations: IterationData[]): Benc
 export interface BenchmarkReporterOptions {
   outputPath?: string;
   upload?: boolean;
+  baselinePath?: string;
 }
 declare class BenchmarkReporter implements Reporter {
   private benchmarks;
   private outputPath;
   private upload;
+  private baselinePath;
   private hasFailures;
   constructor(options?: BenchmarkReporterOptions);
   onTestCaseResult(testCase: TestCase): void;

package/reporter.mjs

@@ -1,6 +1,6 @@
 import * as path from 'node:path';
 import * as fs from 'node:fs/promises';
-import { getCiMetadata } from "./ciReport.mjs";
+import { benchmarkUploadSchema, getCiMetadata } from "./ciReport.mjs";
 import { calculateMean, calculateStdDev, quantile, isOutlier } from "./stats.mjs";
 import { dim, red, green, yellow, cyan, printTable, fileUrl } from "./format.mjs";
 import { uploadCiReport } from "./upload.mjs";
@@ -191,12 +191,24 @@ function printMetricsTable(name, metrics, iterationCount) {
     width: 4
   }], rows, dim(`${iterationCount} iterations`), `${name} — Metrics`);
 }
+async function loadBaselineReport(baselinePath) {
+  const raw = await fs.readFile(baselinePath, 'utf8');
+  const parsed = benchmarkUploadSchema.parse(JSON.parse(raw));
+  // Strip any nested `.base` field to keep the inlined data single-level.
+  const {
+    base,
+    ...single
+  } = parsed;
+  void base;
+  return single;
+}
 class BenchmarkReporter {
   benchmarks = {};
   hasFailures = false;
   constructor(options) {
-    this.outputPath = options?.outputPath ?? path.resolve(process.cwd(), 'benchmarks', 'results.json');
+    this.outputPath = options?.outputPath ?? process.env.BENCHMARK_OUTPUT_PATH ?? path.resolve(process.cwd(), 'benchmarks', 'results.json');
     this.upload = options?.upload ?? process.env.BENCHMARK_UPLOAD === 'true';
+    this.baselinePath = options?.baselinePath ?? process.env.BENCHMARK_BASELINE_PATH;
   }
   onTestCaseResult(testCase) {
     if (testCase.result().state === 'failed') {
@@ -224,11 +236,15 @@ class BenchmarkReporter {
       // eslint-disable-next-line no-console
       console.log(`  ${name}: ${result.totalDuration.toFixed(2)}ms ${dim(`(${result.renders.length} renders, ${result.iterations} iterations)`)}`);
     }
+    const baseline = this.baselinePath ? await loadBaselineReport(this.baselinePath) : undefined;
     const results = {
       version: 1,
       reportType: 'benchmark',
       ...(await getCiMetadata()),
-      report: this.benchmarks
+      report: this.benchmarks,
+      ...(baseline ? {
+        base: baseline
+      } : {})
     };
     const outputDir = path.dirname(this.outputPath);
     await fs.mkdir(outputDir, {

package/vitest.d.mts

@@ -1,9 +1,16 @@
-import { ViteUserConfig } from 'vitest/config';
+import { type ViteUserConfig } from 'vitest/config';
 export interface CreateBenchmarkVitestConfigOptions {
   /**
    * Path to save benchmark results JSON file. If not provided, results will not be saved to disk.
    */
   outputPath?: string;
+  /**
+   * Path to a prior benchmark results JSON file. When set, its contents are
+   * inlined as the `base` field of the head upload so the dashboard and PR
+   * comment can render a comparison without fetching a separate base
+   * artifact from S3. Also settable via the `BENCHMARK_BASELINE_PATH` env var.
+   */
+  baselinePath?: string;
   /**
    * Additional Chromium launch arguments.
    */

package/vitest.mjs

@@ -3,6 +3,7 @@ import { playwright } from '@vitest/browser-playwright';
 export function createBenchmarkVitestConfig(options) {
   const {
     outputPath,
+    baselinePath,
     launchArgs = []
   } = options ?? {};
   return {
@@ -43,7 +44,8 @@ export function createBenchmarkVitestConfig(options) {
       },
       fileParallelism: false,
       reporters: ['default', ['@mui/internal-benchmark/reporter', {
-        outputPath
+        outputPath,
+        baselinePath
       }]],
       include: ['**/*.bench.tsx']
     }