fix(golang): use GOTOOLCHAIN=local when probing system go#1797
fix(golang): use GOTOOLCHAIN=local when probing system go#1797j178 merged 1 commit intoj178:masterfrom
GOTOOLCHAIN=local when probing system go#1797Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1797 +/- ##
==========================================
- Coverage 91.72% 91.71% -0.01%
==========================================
Files 98 98
Lines 20039 20055 +16
==========================================
+ Hits 18380 18393 +13
- Misses 1659 1662 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR fixes a mismatch between Go version detection and Go hook execution. When probing the system go binary for its version, go version could auto-download and report a newer toolchain, while actual hook install/run already used GOTOOLCHAIN=local. This caused version requirement checks to pass during detection but fail during execution.
Changes:
- Add
GOTOOLCHAIN=localenvironment variable to thefill_version()method so version detection matches the effective toolchain used during hook install and run. - Add a regression test with a fake
gobinary that reports different versions depending onGOTOOLCHAIN, verifying the local version is detected.
📦 Cargo Bloat ComparisonBinary size change: +0.00% (24.8 MiB → 24.8 MiB) Expand for cargo-bloat outputHead Branch ResultsBase Branch Results |
⚡️ Hyperfine BenchmarksSummary: 0 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 |
1.7 ± 0.1 | 1.6 | 2.0 | 1.00 |
prek-head --version |
1.7 ± 0.1 | 1.6 | 2.1 | 1.00 ± 0.06 |
prek list
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base list |
7.3 ± 0.1 | 7.0 | 7.6 | 1.00 ± 0.02 |
prek-head list |
7.3 ± 0.1 | 7.0 | 7.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 |
2.4 ± 0.1 | 2.3 | 2.6 | 1.00 |
prek-head validate-config .pre-commit-config.yaml |
2.4 ± 0.0 | 2.3 | 2.6 | 1.01 ± 0.03 |
prek sample-config
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base sample-config |
2.0 ± 0.1 | 1.9 | 2.4 | 1.02 ± 0.04 |
prek-head sample-config |
2.0 ± 0.0 | 1.9 | 2.1 | 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 |
98.3 ± 1.2 | 96.6 | 100.4 | 1.00 |
prek-head run --all-files |
99.1 ± 1.4 | 96.6 | 100.9 | 1.01 ± 0.02 |
prek run --all-files (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --all-files |
99.1 ± 1.3 | 97.1 | 102.2 | 1.00 |
prek-head run --all-files |
100.0 ± 3.0 | 97.2 | 110.6 | 1.01 ± 0.03 |
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 |
99.4 ± 1.6 | 95.8 | 102.8 | 1.00 ± 0.02 |
prek-head run --all-files |
99.3 ± 1.7 | 95.8 | 103.0 | 1.00 |
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 |
14.6 ± 0.3 | 13.9 | 15.2 | 1.03 ± 0.03 |
prek-head run trailing-whitespace --all-files |
14.2 ± 0.3 | 13.7 | 15.0 | 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 |
19.1 ± 1.0 | 17.2 | 21.0 | 1.01 ± 0.07 |
prek-head run end-of-file-fixer --all-files |
18.9 ± 0.9 | 17.4 | 20.8 | 1.00 |
prek run check-json --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-json --all-files |
8.8 ± 0.2 | 8.4 | 9.1 | 1.00 ± 0.03 |
prek-head run check-json --all-files |
8.8 ± 0.2 | 8.5 | 9.2 | 1.00 |
prek run check-yaml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-yaml --all-files |
8.4 ± 0.3 | 8.1 | 9.5 | 1.02 ± 0.04 |
prek-head run check-yaml --all-files |
8.2 ± 0.1 | 8.0 | 8.6 | 1.00 |
prek run check-toml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-toml --all-files |
8.4 ± 0.2 | 8.1 | 8.7 | 1.00 ± 0.03 |
prek-head run check-toml --all-files |
8.3 ± 0.2 | 8.0 | 8.6 | 1.00 |
prek run check-xml --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-xml --all-files |
8.6 ± 0.3 | 7.9 | 9.1 | 1.04 ± 0.04 |
prek-head run check-xml --all-files |
8.2 ± 0.2 | 7.9 | 8.6 | 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 |
12.6 ± 0.6 | 11.5 | 13.9 | 1.00 |
prek-head run detect-private-key --all-files |
12.7 ± 0.8 | 11.6 | 14.8 | 1.01 ± 0.08 |
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 |
16.4 ± 1.0 | 15.1 | 18.6 | 1.02 ± 0.08 |
prek-head run fix-byte-order-marker --all-files |
16.1 ± 0.8 | 14.8 | 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 |
3.6 ± 0.1 | 3.5 | 3.8 | 1.00 |
prek-head install-hooks |
3.6 ± 0.0 | 3.6 | 3.7 | 1.01 ± 0.04 |
prek install-hooks (warm - with cache)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base install-hooks |
3.6 ± 0.1 | 3.5 | 3.6 | 1.00 |
prek-head install-hooks |
3.6 ± 0.0 | 3.5 | 3.7 | 1.02 ± 0.03 |
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 |
35.2 ± 0.9 | 34.2 | 37.5 | 1.01 ± 0.03 |
prek-head run |
34.9 ± 0.6 | 34.1 | 36.1 | 1.00 |
prek run --files '*.json' (specific file type)
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run --files '*.json' |
6.4 ± 0.1 | 6.2 | 6.7 | 1.00 |
prek-head run --files '*.json' |
21.6 ± 52.6 | 6.1 | 240.7 | 3.36 ± 8.18 |
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 |
9.4 ± 0.1 | 9.2 | 9.6 | 1.00 ± 0.02 |
prek-head run --dry-run --all-files |
9.4 ± 0.1 | 9.2 | 9.8 | 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 |
9.6 ± 0.1 | 9.4 | 9.9 | 1.00 |
prek-head run check-hooks-apply --all-files |
9.7 ± 0.1 | 9.5 | 9.9 | 1.00 ± 0.02 |
prek run check-useless-excludes --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run check-useless-excludes --all-files |
9.4 ± 0.1 | 9.3 | 9.5 | 1.00 |
prek-head run check-useless-excludes --all-files |
9.5 ± 0.3 | 8.8 | 10.1 | 1.01 ± 0.03 |
prek run identity --all-files
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
prek-base run identity --all-files |
7.8 ± 0.2 | 7.6 | 8.3 | 1.02 ± 0.04 |
prek-head run identity --all-files |
7.7 ± 0.1 | 7.5 | 8.0 | 1.00 |
|
Thank you! |
Fixes #1796.
Align Go version detection with the effective toolchain used for Go hook install/run. Without this,
go versioncould auto-download and report a newer toolchain version, causing a mismatch with the actual local Go used during hook execution.Add a regression test for a system
gobinary that reports different versions depending onGOTOOLCHAIN.Verified: CI now passes on a previously failing repo — deadnews-template-go#167.