Reduce hook dispatch await points#2360
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2360 +/- ##
=======================================
Coverage 93.35% 93.35%
=======================================
Files 129 129
Lines 27402 27408 +6
=======================================
+ Hits 25582 25588 +6
Misses 1820 1820 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
📦 Cargo Bloat ComparisonBinary size change: +0.00% (29.1 MiB → 29.1 MiB) Expand for cargo-bloat outputHead Branch ResultsBase Branch Results |
⚡️ Hyperfine BenchmarksSummary: 1 regressions, 0 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.2 ± 0.1 | 2.1 | 2.4 | 1.00 ± 0.06 |
prek-head --version |
2.2 ± 0.1 | 2.0 | 2.6 | 1.00 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
9.2 ± 0.1 | 9.0 | 9.4 | 1.00 |
prek-head list |
9.3 ± 0.1 | 9.1 | 10.2 | 1.00 ± 0.02 |
prek validate-config .pre-commit-config.yaml
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base validate-config .pre-commit-config.yaml |
3.1 ± 0.1 | 3.0 | 3.3 | 1.00 |
prek-head validate-config .pre-commit-config.yaml |
3.1 ± 0.0 | 3.0 | 3.2 | 1.01 ± 0.02 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.4 ± 0.0 | 2.3 | 2.5 | 1.00 |
prek-head sample-config |
2.4 ± 0.0 | 2.3 | 2.5 | 1.02 ± 0.02 |
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 |
75.4 ± 1.8 | 72.9 | 77.8 | 1.00 |
prek-head run --all-files |
75.7 ± 2.1 | 73.3 | 79.6 | 1.00 ± 0.04 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
75.2 ± 2.6 | 71.0 | 80.1 | 1.00 |
prek-head run --all-files |
76.4 ± 2.4 | 72.6 | 81.1 | 1.02 ± 0.05 |
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 |
75.6 ± 2.4 | 71.2 | 80.2 | 1.00 |
prek-head run --all-files |
76.2 ± 2.8 | 71.5 | 86.4 | 1.01 ± 0.05 |
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 |
20.0 ± 0.3 | 19.5 | 21.1 | 1.01 ± 0.02 |
prek-head run trailing-whitespace --all-files |
19.7 ± 0.3 | 19.4 | 20.7 | 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 |
26.6 ± 2.1 | 23.6 | 30.3 | 1.04 ± 0.11 |
prek-head run end-of-file-fixer --all-files |
25.4 ± 1.8 | 23.6 | 30.3 | 1.00 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
7.6 ± 0.3 | 7.2 | 8.2 | 1.00 ± 0.05 |
prek-head run check-json --all-files |
7.6 ± 0.3 | 7.0 | 8.4 | 1.00 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
7.4 ± 0.1 | 7.3 | 7.7 | 1.00 ± 0.02 |
prek-head run check-yaml --all-files |
7.4 ± 0.1 | 7.1 | 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.6 ± 0.3 | 7.2 | 8.4 | 1.00 ± 0.06 |
prek-head run check-toml --all-files |
7.6 ± 0.3 | 7.1 | 8.1 | 1.00 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
7.3 ± 0.2 | 7.0 | 7.9 | 1.00 |
prek-head run check-xml --all-files |
7.3 ± 0.4 | 6.8 | 8.4 | 1.01 ± 0.06 |
prek run detect-private-key --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run detect-private-key --all-files |
13.1 ± 1.1 | 11.7 | 15.6 | 1.00 |
prek-head run detect-private-key --all-files |
13.9 ± 1.3 | 12.2 | 16.8 | 1.07 ± 0.13 |
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.9 ± 0.9 | 16.7 | 20.2 | 1.00 |
prek-head run fix-byte-order-marker --all-files |
18.2 ± 0.8 | 17.0 | 20.0 | 1.02 ± 0.07 |
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.4 ± 0.1 | 4.3 | 4.5 | 1.00 |
prek-head install-hooks |
4.4 ± 0.0 | 4.4 | 4.4 | 1.00 ± 0.01 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
4.4 ± 0.0 | 4.3 | 4.4 | 1.00 |
prek-head install-hooks |
4.4 ± 0.1 | 4.3 | 4.6 | 1.01 ± 0.02 |
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 |
37.0 ± 1.0 | 35.7 | 39.2 | 1.00 |
prek-head run |
46.5 ± 27.9 | 35.4 | 135.3 | 1.26 ± 0.75 |
prek run (staged files only): 25.7200% slower
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
7.9 ± 0.1 | 7.7 | 8.1 | 1.00 |
prek-head run --files '*.json' |
7.9 ± 0.1 | 7.7 | 8.1 | 1.00 ± 0.02 |
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 |
6.8 ± 0.1 | 6.7 | 6.9 | 1.00 |
prek-head run --dry-run --all-files |
6.9 ± 0.1 | 6.8 | 7.0 | 1.01 ± 0.02 |
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 |
11.2 ± 0.8 | 10.3 | 12.1 | 1.03 ± 0.11 |
prek-head run check-hooks-apply --all-files |
10.8 ± 0.8 | 10.3 | 12.9 | 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.6 ± 0.5 | 10.3 | 12.4 | 1.01 ± 0.05 |
prek-head run check-useless-excludes --all-files |
10.5 ± 0.1 | 10.4 | 10.6 | 1.00 |
prek run identity --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run identity --all-files |
9.7 ± 0.1 | 9.6 | 9.9 | 1.00 |
prek-head run identity --all-files |
9.8 ± 0.1 | 9.6 | 10.2 | 1.01 ± 0.02 |
Box hook implementation futures so BuiltinHooks::run and PreCommitHooks::run each have a single suspension point, reducing their generated state-machine size.