Website: Implement a check for differing benchmark results and metadata (#144)

Co-authored-by: Siddharth Krishna <siddharth-krishna@users.noreply.github.com>

Author: jacek-oet

results/benchmark_results.csv

@@ -11,6 +11,11 @@ const compat = new FlatCompat({
 
 const eslintConfig = [
   ...compat.extends("next/core-web-vitals", "next/typescript"),
+  {
+    rules: {
+      "react-hooks/exhaustive-deps": "off",
+    },
+  },
 ];
 
 export default eslintConfig;

results/benchmark_results_mean_stddev.csv

@@ -1,8 +1,12 @@
+import { validateData } from "@/scripts/validateData";
 import type { NextConfig } from "next";
 
 const nextConfig: NextConfig = {
   reactStrictMode: true,
   webpack(config) {
+    // Validate the benchmark data before proceeding with the build.
+    validateData();
+
     // Grab the existing rule that handles SVG imports
     const fileLoaderRule = config.module.rules.find(
       (rule: { test: { test: (arg0: string) => unknown } }) =>

website-nextjs/eslint.config.mjs

@@ -16,6 +16,7 @@
     "compare-versions": "^6.1.1",
     "d3": "^7.9.0",
     "i": "^0.3.7",
+    "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "lodash.camelcase": "^4.3.0",
     "next": "15.2.0",
@@ -34,6 +35,7 @@
   "devDependencies": {
     "@eslint/eslintrc": "^3",
     "@types/d3": "^7.4.3",
+    "@types/js-yaml": "^4.0.9",
     "@types/lodash.camelcase": "^4.3.9",
     "@types/node": "^20",
     "@types/papaparse": "^5.3.15",

website-nextjs/next.config.ts

@@ -0,0 +1,98 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import fs from "fs/promises";
+import path from "path";
+import Papa from "papaparse";
+import yaml from "js-yaml";
+
+// Type definitions
+interface MetaData {
+  [key: string]: any;
+}
+
+interface BenchmarkResult {
+  Benchmark: string;
+  Size: string;
+  benchmarkId: string;
+  [key: string]: any;
+}
+
+interface Size {
+  size: string;
+  [key: string]: any;
+}
+
+// Path constants
+const RESULTS_DIR = path.resolve(process.cwd(), "../results");
+const METADATA_PATH = path.join(RESULTS_DIR, "metadata.yaml");
+const RESULTS_PATH = path.join(RESULTS_DIR, "benchmark_results.csv");
+
+/**
+ * Reads and parses the metadata YAML file
+ * @returns The parsed metadata or null on error
+ */
+const getMetaData = async (): Promise<{ benchmarks: MetaData } | null> => {
+  try {
+    const yamlText = await fs.readFile(METADATA_PATH, "utf-8");
+    const rawData = yaml.load(yamlText) as { benchmarks: MetaData };
+    return rawData;
+  } catch (error) {
+    console.error("Error reading metadata:", error);
+    return null;
+  }
+};
+
+/**
+ * Reads and parses the benchmark results CSV file
+ * @returns Array of benchmark results
+ */
+async function getBenchmarkResults(): Promise<BenchmarkResult[]> {
+  try {
+    const fileContent = await fs.readFile(RESULTS_PATH, "utf-8");
+    const parsedResults = Papa.parse<BenchmarkResult>(fileContent, {
+      header: true,
+      skipEmptyLines: true,
+      dynamicTyping: true,
+    });
+    return parsedResults.data;
+  } catch (error) {
+    console.error("Error reading benchmark results:", error);
+    throw error;
+  }
+}
+
+/**
+ * Validates that all benchmark results have corresponding metadata entries
+ */
+export async function validateData(): Promise<void> {
+  try {
+    const [results, metaData] = await Promise.all([
+      getBenchmarkResults(),
+      getMetaData(),
+    ]);
+
+    if (!metaData) {
+      throw new Error("Failed to load metadata");
+    }
+    const invalidResults = results.filter((result) => {
+      const benchmark = metaData.benchmarks[result.Benchmark];
+      return (
+        !benchmark ||
+        !benchmark.Sizes?.some((s: Size) => s.Name === result.Size)
+      );
+    });
+
+    if (invalidResults.length > 0) {
+      invalidResults.forEach((result) => {
+        console.error(
+          `Validation failed for benchmark: ${result.Benchmark} with size: ${result.Size}`,
+        );
+      });
+      throw new Error(
+        `${invalidResults.length} benchmark results failed validation`,
+      );
+    }
+  } catch (error) {
+    console.error("Error validating data:", error);
+    throw error;
+  }
+}