Preserve hook output order with a shared pipe - #2385
Conversation
📦 Cargo Bloat ComparisonBinary size change: -0.34% (29.2 MiB → 29.1 MiB) Expand for cargo-bloat outputHead Branch ResultsBase Branch Results |
⚡️ Hyperfine BenchmarksSummary: 0 regressions, 1 improvements above the 10% threshold. Environment
CLI CommandsBenchmarking basic commands in the main repo:
|
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base --version |
2.3 ± 0.1 | 2.2 | 2.6 | 1.08 ± 0.04 |
prek-head --version |
2.1 ± 0.1 | 2.0 | 2.5 | 1.00 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
9.3 ± 0.1 | 9.1 | 9.8 | 1.03 ± 0.02 |
prek-head list |
9.1 ± 0.1 | 8.9 | 9.5 | 1.00 |
prek validate-config .pre-commit-config.yaml
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base validate-config .pre-commit-config.yaml |
3.3 ± 0.1 | 3.2 | 3.5 | 1.09 ± 0.03 |
prek-head validate-config .pre-commit-config.yaml |
3.0 ± 0.1 | 2.9 | 3.2 | 1.00 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.6 ± 0.1 | 2.5 | 2.7 | 1.05 ± 0.03 |
prek-head sample-config |
2.5 ± 0.1 | 2.3 | 2.6 | 1.00 |
Cold vs Warm Runs
Comparing first run (cold) vs subsequent runs (warm cache):
prek run --all-files (cold - no cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
74.7 ± 2.6 | 71.0 | 79.3 | 1.03 ± 0.04 |
prek-head run --all-files |
72.5 ± 1.9 | 70.1 | 74.8 | 1.00 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
72.9 ± 2.5 | 69.3 | 76.6 | 1.02 ± 0.05 |
prek-head run --all-files |
71.9 ± 2.3 | 68.7 | 76.3 | 1.00 |
Full Hook Suite
Running the builtin hook suite on the benchmark workspace:
prek run --all-files (full builtin hook suite)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
72.7 ± 2.4 | 67.7 | 79.4 | 1.00 |
prek-head run --all-files |
73.4 ± 6.3 | 68.6 | 114.3 | 1.01 ± 0.09 |
Individual Hook Performance
Benchmarking each hook individually on the test repo:
prek run trailing-whitespace --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run trailing-whitespace --all-files |
19.4 ± 0.5 | 18.8 | 20.6 | 1.00 ± 0.04 |
prek-head run trailing-whitespace --all-files |
19.3 ± 0.5 | 18.5 | 20.8 | 1.00 |
prek run end-of-file-fixer --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run end-of-file-fixer --all-files |
24.9 ± 1.6 | 22.9 | 28.0 | 1.01 ± 0.09 |
prek-head run end-of-file-fixer --all-files |
24.6 ± 1.7 | 22.8 | 28.2 | 1.00 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
7.8 ± 0.3 | 7.2 | 8.5 | 1.03 ± 0.06 |
prek-head run check-json --all-files |
7.6 ± 0.3 | 7.0 | 8.2 | 1.00 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
7.6 ± 0.1 | 7.4 | 7.9 | 1.02 ± 0.03 |
prek-head run check-yaml --all-files |
7.4 ± 0.2 | 7.2 | 7.9 | 1.00 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
7.7 ± 0.3 | 7.4 | 8.5 | 1.02 ± 0.05 |
prek-head run check-toml --all-files |
7.6 ± 0.3 | 7.1 | 8.3 | 1.00 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
7.6 ± 0.4 | 7.2 | 8.8 | 1.02 ± 0.08 |
prek-head run check-xml --all-files |
7.4 ± 0.4 | 7.0 | 8.5 | 1.00 |
prek run detect-private-key --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run detect-private-key --all-files |
13.4 ± 1.0 | 11.7 | 15.3 | 1.03 ± 0.11 |
prek-head run detect-private-key --all-files |
13.1 ± 1.0 | 12.0 | 15.7 | 1.00 |
prek run fix-byte-order-marker --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run fix-byte-order-marker --all-files |
17.5 ± 0.7 | 16.6 | 19.2 | 1.01 ± 0.06 |
prek-head run fix-byte-order-marker --all-files |
17.3 ± 0.7 | 16.0 | 18.6 | 1.00 |
Installation Performance
Benchmarking hook installation (fast path hooks skip Python setup):
prek install-hooks (cold - no cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
4.6 ± 0.2 | 4.5 | 5.0 | 1.06 ± 0.05 |
prek-head install-hooks |
4.4 ± 0.0 | 4.3 | 4.4 | 1.00 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
4.6 ± 0.0 | 4.6 | 4.6 | 1.05 ± 0.01 |
prek-head install-hooks |
4.4 ± 0.1 | 4.3 | 4.5 | 1.00 |
File Filtering/Scoping Performance
Testing different file selection modes:
prek run (staged files only)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run |
36.6 ± 0.7 | 35.4 | 38.0 | 1.00 |
prek-head run |
37.1 ± 1.1 | 35.5 | 38.7 | 1.01 ± 0.04 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
8.0 ± 0.1 | 7.8 | 8.2 | 1.02 ± 0.02 |
prek-head run --files '*.json' |
7.8 ± 0.1 | 7.6 | 8.1 | 1.00 |
Workspace Discovery & Initialization
Benchmarking hook discovery and initialization overhead:
prek run --dry-run --all-files (measures init overhead)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --dry-run --all-files |
7.2 ± 0.2 | 6.8 | 7.7 | 1.08 ± 0.04 |
prek-head run --dry-run --all-files |
6.7 ± 0.1 | 6.5 | 7.0 | 1.00 |
Meta Hooks Performance
Benchmarking meta hooks separately:
prek run check-hooks-apply --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-hooks-apply --all-files |
12.0 ± 0.2 | 11.8 | 12.4 | 1.08 ± 0.08 |
prek-head run check-hooks-apply --all-files |
11.1 ± 0.8 | 10.2 | 12.2 | 1.00 |
prek run check-useless-excludes --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-useless-excludes --all-files |
10.7 ± 0.1 | 10.6 | 10.9 | 1.02 ± 0.02 |
prek-head run check-useless-excludes --all-files |
10.5 ± 0.1 | 10.3 | 10.7 | 1.00 |
prek run identity --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run identity --all-files |
38.2 ± 90.5 | 9.9 | 358.9 | 3.81 ± 9.03 |
prek-head run identity --all-files |
10.0 ± 0.5 | 9.6 | 11.1 | 1.00 |
✅ Performance improvement for prek run identity --all-files: 73.7900% faster
Suppress Gitleaks banner and status logs in the Docker image test so Docker's stdout/stderr interleaving cannot make the snapshot flaky after #2385.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2385 +/- ##
=========================================
Coverage ? 93.37%
=========================================
Files ? 129
Lines ? 27513
Branches ? 0
=========================================
Hits ? 25689
Misses ? 1824
Partials ? 0 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Fix hook output ordering by capturing stdout and stderr through a shared pipe before spawning the process. Centralize merged batch output handling across language backends.
Closes #2382