use commit date in chart data points

Author: willcl-ark

.github/workflows/nightly-benchmark.yml

@@ -26,8 +26,13 @@ jobs:
           BITCOIN_SHA=$(git merge-base HEAD upstream/master)
           echo "BITCOIN_SHA=$BITCOIN_SHA" >> "$GITHUB_ENV"
 
+          # Get commit date for the Bitcoin commit (for chart X-axis)
+          COMMIT_DATE=$(git log -1 --format=%cd --date=short "$BITCOIN_SHA")
+          echo "COMMIT_DATE=$COMMIT_DATE" >> "$GITHUB_ENV"
+
           echo "Benchcoin: $(git rev-parse HEAD)"
           echo "Bitcoin merge-base: $BITCOIN_SHA"
+          echo "Commit date: $COMMIT_DATE"
 
       - name: Build master binary
         run: |
@@ -44,10 +49,13 @@ jobs:
       - name: Upload commit info
         run: |
           echo "$BITCOIN_SHA" > ${{ runner.temp }}/commit.txt
+          echo "$COMMIT_DATE" > ${{ runner.temp }}/commit-date.txt
       - uses: actions/upload-artifact@v4
         with:
           name: commit-info
-          path: ${{ runner.temp }}/commit.txt
+          path: |
+            ${{ runner.temp }}/commit.txt
+            ${{ runner.temp }}/commit-date.txt
 
       - name: Capture machine specs
         run: |
@@ -151,9 +159,13 @@ jobs:
         with:
           python-version: '3.12'
 
-      - name: Get current date
+      - name: Get dates
         run: |
-          echo "DATE=$(date -u +%Y-%m-%d)" >> "$GITHUB_ENV"
+          # Commit date (for chart X-axis)
+          COMMIT_DATE=$(cat ./commit-info/commit-date.txt)
+          echo "COMMIT_DATE=$COMMIT_DATE" >> "$GITHUB_ENV"
+          # Run date (for reference)
+          echo "RUN_DATE=$(date -u +%Y-%m-%d)" >> "$GITHUB_ENV"
 
       - name: Append results to history
         run: |
@@ -167,7 +179,8 @@ jobs:
             ../nightly-450-results/results.json \
             "$COMMIT" \
             450 \
-            --date "$DATE" \
+            --date "$COMMIT_DATE" \
+            --run-date "$RUN_DATE" \
             --benchmark-config bench/configs/nightly.toml \
             --machine-specs ../machine-specs/machine-specs.json
 
@@ -178,7 +191,8 @@ jobs:
             ../nightly-32000-results/results.json \
             "$COMMIT" \
             32000 \
-            --date "$DATE" \
+            --date "$COMMIT_DATE" \
+            --run-date "$RUN_DATE" \
             --benchmark-config bench/configs/nightly.toml \
             --machine-specs ../machine-specs/machine-specs.json
 
@@ -195,5 +209,5 @@ jobs:
           git config --global user.name "github-actions[bot]"
           git config --global user.email "github-actions[bot]@users.noreply.github.com"
           git add nightly-history.json index.html
-          git commit -m "Update nightly benchmark results for $DATE" || echo "No changes to commit"
+          git commit -m "Update nightly benchmark results for $COMMIT_DATE" || echo "No changes to commit"
           git push origin gh-pages

bench.py

@@ -323,6 +323,7 @@ def cmd_nightly(args: argparse.Namespace) -> int:
                 benchmark_config_file=benchmark_config_file,
                 instrumentation=args.instrumentation,
                 machine_specs_file=machine_specs_file,
+                run_date=args.run_date or "",
             )
             logger.info(f"Appended result to {history_file}")
         elif args.nightly_command == "chart":
@@ -566,6 +567,11 @@ def main() -> int:
         metavar="PATH",
         help="Path to pre-captured machine specs JSON (default: detect current machine)",
     )
+    nightly_append.add_argument(
+        "--run-date",
+        metavar="YYYY-MM-DD",
+        help="Date when benchmark was executed (default: today). Stored for reference.",
+    )
 
     # nightly chart
     nightly_chart = nightly_subparsers.add_parser(

bench/nightly.py

@@ -138,7 +138,7 @@ def series_label(result: "NightlyResult") -> str:
 class NightlyResult:
     """A single nightly benchmark result with embedded config and machine info."""
 
-    date: str
+    date: str  # Commit date (YYYY-MM-DD) - displayed on chart X-axis
     commit: str
     mean: float
     stddev: float
@@ -147,6 +147,7 @@ class NightlyResult:
         str, Any
     ]  # Full benchmark config (dbcache inside config.bitcoind.dbcache)
     machine: dict[str, Any]  # Full machine specs
+    run_date: str = ""  # When benchmark was executed (reference only)
 
     @property
     def dbcache(self) -> int:
@@ -168,7 +169,7 @@ def instrumentation(self) -> str:
 
     def to_dict(self) -> dict[str, Any]:
         """Convert to dictionary for JSON serialization."""
-        return {
+        result = {
             "date": self.date,
             "commit": self.commit,
             "mean": self.mean,
@@ -177,6 +178,9 @@ def to_dict(self) -> dict[str, Any]:
             "config": self.config,
             "machine": self.machine,
         }
+        if self.run_date:
+            result["run_date"] = self.run_date
+        return result
 
     @classmethod
     def from_dict(cls, data: dict[str, Any]) -> NightlyResult:
@@ -194,6 +198,7 @@ def from_dict(cls, data: dict[str, Any]) -> NightlyResult:
                 runs=data["runs"],
                 config=data["config"],
                 machine=data.get("machine", {}),
+                run_date=data.get("run_date", ""),
             )
 
         # Legacy format - convert to new format
@@ -209,6 +214,7 @@ def from_dict(cls, data: dict[str, Any]) -> NightlyResult:
                 "instrumentation": "uninstrumented",
             },
             machine={},
+            run_date=data.get("run_date", ""),
         )
 
 
@@ -316,6 +322,7 @@ def append_from_results_json(
         benchmark_config: dict[str, Any],
         machine_specs: dict[str, Any],
         date_str: str | None = None,
+        run_date: str = "",
     ) -> None:
         """Append result from a hyperfine results.json file.
 
@@ -324,7 +331,8 @@ def append_from_results_json(
             commit: Git commit hash
             benchmark_config: Full benchmark config dict (includes bitcoind.dbcache)
             machine_specs: Machine specs dict
-            date_str: Date string (YYYY-MM-DD), defaults to today
+            date_str: Commit date string (YYYY-MM-DD), defaults to today
+            run_date: When the benchmark was executed (YYYY-MM-DD), for reference
         """
         if not results_file.exists():
             raise FileNotFoundError(f"Results file not found: {results_file}")
@@ -355,6 +363,7 @@ def append_from_results_json(
             runs=runs,
             config=benchmark_config,
             machine=machine_specs,
+            run_date=run_date,
         )
         self.append(result)
 
@@ -391,17 +400,19 @@ def append(
         benchmark_config_file: Path | None = None,
         instrumentation: str = "uninstrumented",
         machine_specs_file: Path | None = None,
+        run_date: str = "",
     ) -> None:
         """Append a result from hyperfine results.json to history.
 
         Args:
             results_file: Path to hyperfine results.json
             commit: Git commit hash
             dbcache: DB cache size in MB
-            date_str: Date string (YYYY-MM-DD), defaults to today
+            date_str: Commit date string (YYYY-MM-DD), defaults to today
             benchmark_config_file: Path to benchmark config TOML
             instrumentation: Instrumentation mode ('uninstrumented' or 'instrumented')
             machine_specs_file: Path to pre-captured machine specs JSON (optional)
+            run_date: When the benchmark was executed (YYYY-MM-DD), for reference
         """
         from bench.benchmark_config import BenchmarkConfig
 
@@ -435,6 +446,7 @@ def append(
             benchmark_config=config_dict,
             machine_specs=machine_specs,
             date_str=date_str,
+            run_date=run_date,
         )
         history.save()