Merge pull request #25 from LibreSign/chore/remove-unused-quality-gate-script

chore: migrate benchmarks to PHPBench with performance regression guards

Author: vitormattos

.github/copilot-instructions.md

@@ -9,6 +9,36 @@
 2. Run focused tests first, then full checks.
 3. Ensure performance-sensitive paths stay within benchmark thresholds.
 
+### Running benchmarks
+
+Benchmarks use **PHPBench** for rigorous performance testing with statistical analysis.
+
+```bash
+# Run all benchmarks with aggregate statistics
+composer benchmark:run
+
+# Run with stricter settings (multiple revisions)
+composer benchmark:run:ci
+
+# Update baseline after accepted performance changes
+composer benchmark:baseline:update
+
+# Check PR against baseline (native phpbench --ref + --assert)
+composer benchmark:baseline:check
+
+# Direct PHPBench invocation with custom options
+vendor-bin/phpbench/vendor/phpbench/phpbench/bin/phpbench run --bootstrap=vendor/autoload.php --report=aggregate benchmarks
+```
+
+PHPBench automatically:
+- Runs warmup iterations (eliminates JIT/opcache startup noise)
+- Executes multiple revisions for statistical confidence
+- Reports mean, min, max, stdev, variance per benchmark (CI dump file: `build/benchmark-results.xml`)
+
+Baseline persistence policy:
+- Regression gate compares PR results against stored `baseline` tag in `.github/.performance/.phpbench`.
+- Baseline updates are made via pull request (no direct commit to protected `main`) using `composer benchmark:baseline:update`.
+
 ## Compliance and contribution
 
 - DCO sign-off is mandatory for every commit.

.github/workflows/performance.yml

@@ -5,16 +5,17 @@ name: performance
 
 on:
   pull_request:
+  push:
+    branches:
+      - main
 
 jobs:
   performance:
     runs-on: ubuntu-latest
-    env:
-      BENCH_ITERATIONS: 250
-      BENCH_MAX_AVG_MS: 4.0
-      BENCH_MAX_MEM_KB: 2048
     steps:
       - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
       - name: Detect minimum PHP from composer.json
         id: php_min
         run: |
@@ -24,5 +25,33 @@ jobs:
       - uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ steps.php_min.outputs.version }}
+          coverage: none
       - run: composer install --no-interaction --prefer-dist
-      - run: php benchmarks/compiler-benchmark.php
+      - run: composer bin all install --no-interaction --prefer-dist
+      
+      - name: Run benchmarks (strict CI mode with verbose output)
+        run: |
+          composer benchmark:run:ci
+          
+          echo "✓ Benchmarks completed"
+          echo ""
+          echo "Results saved to build/benchmark-results.xml"
+          echo "Review: Ensure no individual benchmark takes >10ms average"
+
+      - name: Validate regression against baseline
+        if: github.event_name == 'pull_request'
+        run: |
+          if composer benchmark:baseline:exists; then
+            composer benchmark:baseline:check
+          else
+            echo "No 'baseline' tag found in phpbench storage. Skipping baseline comparison."
+            echo "Run 'composer benchmark:baseline:update' and commit .github/.performance/.phpbench to enable regression gate."
+          fi
+      
+      - name: Save benchmark results as artifact
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: benchmark-results
+          path: build/benchmark-results.xml
+          retention-days: 90

benchmarks/CompilerBench.php

@@ -0,0 +1,48 @@
+<?php
+
+// SPDX-FileCopyrightText: 2026 LibreSign
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+declare(strict_types=1);
+
+namespace LibreSign\XObjectTemplate\Benchmarks;
+
+use LibreSign\XObjectTemplate\Dto\CompileRequest;
+use LibreSign\XObjectTemplate\XObjectTemplateCompiler;
+
+class CompilerBench
+{
+  private ?XObjectTemplateCompiler $compiler = null;
+
+  private function compiler(): XObjectTemplateCompiler
+    {
+    $this->compiler ??= new XObjectTemplateCompiler();
+
+    return $this->compiler;
+    }
+
+    public function benchSimpleHtml(): void
+    {
+        $html = '<div style="font-size:10;color:#000">Signed by Demo User</div><p style="font-size:9">Document approved</p>';
+      $this->compiler()->compile(new CompileRequest(html: $html, width: 240, height: 84));
+    }
+
+    public function benchComplexHtml(): void
+    {
+        $html = <<<'HTML'
+<div style="font-size:12;font-weight:bold;color:#003366;margin-bottom:10px">
+  Certificate of Approval
+</div>
+<p style="font-size:10;line-height:1.5">
+  This document has been signed by:<br/>
+  <span style="font-weight:bold">John Doe</span><br/>
+  Date: 2026-06-01<br/>
+  Status: <span style="color:green">Verified</span>
+</p>
+<div style="border:1px solid #ccc;padding:8px;margin-top:10px;font-size:9;background:#f9f9f9">
+  <p>Signature validated and timestamp recorded.</p>
+</div>
+HTML;
+  $this->compiler()->compile(new CompileRequest(html: $html, width: 280, height: 120));
+    }
+}

benchmarks/compiler-benchmark.php

@@ -34,7 +34,8 @@
     "process-timeout": 600,
     "allow-plugins": {
       "bamarni/composer-bin-plugin": true,
-      "infection/extension-installer": true
+      "infection/extension-installer": true,
+      "phpbench/extension-installer": true
     }
   },
   "extra": {
@@ -70,12 +71,15 @@
     "docker:lint": "docker run --rm -i hadolint/hadolint < .docker/Dockerfile",
     "sh:lint": "shfmt -d scripts",
     "sh:security": "shellcheck scripts/*.sh",
-    "profile:xdebug": "XDEBUG_MODE=profile php benchmarks/profile.php",
     "test:unit": "vendor-bin/phpunit/vendor/phpunit/phpunit/phpunit --testsuite unit",
     "test:integration": "vendor-bin/phpunit/vendor/phpunit/phpunit/phpunit --testsuite integration",
     "test:coverage": "XDEBUG_MODE=coverage vendor-bin/phpunit/vendor/phpunit/phpunit/phpunit --coverage-text --coverage-clover=build/coverage/clover.xml",
     "mutation:test": "vendor-bin/mutation/vendor/infection/infection/bin/infection --threads=max",
-    "performance:check": "php benchmarks/compiler-benchmark.php",
+    "benchmark:run": "vendor-bin/phpbench/vendor/phpbench/phpbench/bin/phpbench run --config=phpbench.json --report=aggregate",
+    "benchmark:run:ci": "mkdir -p build && vendor-bin/phpbench/vendor/phpbench/phpbench/bin/phpbench run --config=phpbench.json --iterations=20 --revs=10 --warmup=2 --progress=plain --report=aggregate --dump-file=build/benchmark-results.xml",
+    "benchmark:baseline:update": "mkdir -p build && vendor-bin/phpbench/vendor/phpbench/phpbench/bin/phpbench run --config=phpbench.json --iterations=20 --revs=10 --warmup=2 --progress=plain --report=aggregate --dump-file=build/benchmark-results.xml --store --tag=baseline",
+    "benchmark:baseline:check": "vendor-bin/phpbench/vendor/phpbench/phpbench/bin/phpbench run --config=phpbench.json --iterations=20 --revs=10 --warmup=2 --progress=plain --report=aggregate --ref=baseline --assert=\"mode(variant.time.avg) <= mode(baseline.time.avg) +/- 25%\"",
+    "benchmark:baseline:exists": "vendor-bin/phpbench/vendor/phpbench/phpbench/bin/phpbench log --config=phpbench.json | grep -q 'Tag: baseline'",
     "bin": [
       "composer bin all list"
     ]

benchmarks/profile.php

@@ -0,0 +1,5 @@
+{
+  "runner.bootstrap": "vendor/autoload.php",
+  "runner.path": "benchmarks",
+  "storage.xml_storage_path": ".github/.performance/.phpbench"
+}

composer.json

@@ -0,0 +1,5 @@
+{
+  "require": {
+    "phpbench/phpbench": "^1.6"
+  }
+}