Skip to content

Preserve hook config deserialization error locations - #2573

Merged
j178 merged 1 commit into
masterfrom
config-errors
Aug 17, 2026
Merged

j178 merged 1 commit into
masterfrom
config-errors

Conversation

@j178

@j178 j178 commented Aug 17, 2026

Copy link
Copy Markdown
Owner

Nested flattened hook options lost source spans during deserialization, causing errors to point at a parent hook or repository. Deserialize hook fields through a flat wire representation so YAML and TOML errors identify the invalid value.

Copilot AI lite review requested due to automatic review settings August 17, 2026 08:57
@j178 j178 added the bug Something isn't working label Aug 17, 2026
@codecov

codecov Bot commented Aug 17, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 99.36306% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 93.77%. Comparing base (8f3ff02) to head (9fa3bb8).

Files with missing lines Patch % Lines
crates/prek/src/config.rs 99.36% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2573      +/-   ##
==========================================
+ Coverage   93.71%   93.77%   +0.06%     
==========================================
  Files         135      135              
  Lines       28939    29048     +109     
==========================================
+ Hits        27121    27241     +120     
+ Misses       1818     1807      -11     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adjusts hook deserialization to preserve precise source locations for nested/flattened hook option errors, so YAML/TOML diagnostics point at the invalid value rather than a parent object.

Changes:

  • Introduces a flat HookWire serde representation and converts it into RemoteHook/LocalHook/ManifestHook via From/TryFrom to avoid span loss from nested flatten.
  • Moves option-field deserialization/validation (e.g., minimum_prek_version, groups) onto the wire representation and reconstructs HookOptions explicitly.
  • Updates and adds snapshot tests to assert improved error locations for invalid/missing hook fields and invalid option values.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread crates/prek/src/config.rs Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: cb4dd728a2

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread crates/prek/src/config.rs
Copilot AI review requested due to automatic review settings August 17, 2026 09:03
@prek-ci-bot

prek-ci-bot Bot commented Aug 17, 2026

Copy link
Copy Markdown

📦 Cargo Bloat Comparison

Binary size change: -0.66% (30.5 MiB → 30.3 MiB)

Expand for cargo-bloat output

Head Branch Results

 File  .text     Size             Crate Name
 1.1%   2.2% 332.0KiB        aws_lc_sys aws_lc_0_44_0_aes_gcm_encrypt_avx512
 1.1%   2.2% 332.0KiB        aws_lc_sys aws_lc_0_44_0_aes_gcm_decrypt_avx512
 0.2%   0.5%  71.8KiB              prek <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.4%  65.4KiB              prek prek::run::{closure#0}
 0.2%   0.4%  53.5KiB              prek <<prek::config::HookWire as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.2%   0.3%  49.4KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.3%  48.3KiB              prek <<prek::config::Config as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.2%   0.3%  46.7KiB              prek <prek::languages::ruby::installer::RubyInstaller>::install::{closure#0}
 0.1%   0.3%  43.0KiB              prek prek::cli::run::run::run::{closure#0}
 0.1%   0.2%  34.9KiB              prek <prek::languages::node::installer::NodeInstaller>::install::{closure#0}
 0.1%   0.2%  34.3KiB              prek <prek::cli::RunOptions as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  32.6KiB              prek <prek::languages::bun::installer::BunInstaller>::install::{closure#0}
 0.1%   0.2%  32.6KiB              prek <prek::languages::golang::installer::GoInstaller>::install::{closure#0}
 0.1%   0.2%  29.4KiB     granit_parser <granit_parser::scanner::Scanner<granit_parser::input::str::StrInput>>::fetch_more_tokens
 0.1%   0.2%  29.3KiB              prek <prek::languages::deno::installer::DenoInstaller>::download::{closure#0}
 0.1%   0.2%  28.8KiB     granit_parser <granit_parser::scanner::Scanner<granit_parser::input::str::StrInput>>::fetch_more_tokens
 0.1%   0.2%  28.6KiB    cargo_metadata <&mut serde_json::de::Deserializer<serde_json::read::StrRead> as serde_core::de::Deserializer>::deserialize_struct::<<cargo_metadata::Package as serde_core::de::Deserialize>::deserialize::__Visitor>
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_44_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_44_0_edwards25519_scalarmuldouble
 0.1%   0.2%  27.0KiB              prek <prek::languages::mise::installer::MiseInstaller>::download::{closure#0}
42.6%  88.1%  12.9MiB                   And 26755 smaller methods. Use -n N to show more.
48.4% 100.0%  14.7MiB                   .text section size, the file size is 30.3MiB

Base Branch Results

 File  .text     Size             Crate Name
 1.1%   2.2% 332.0KiB        aws_lc_sys aws_lc_0_44_0_aes_gcm_encrypt_avx512
 1.1%   2.2% 332.0KiB        aws_lc_sys aws_lc_0_44_0_aes_gcm_decrypt_avx512
 0.3%   0.6%  86.4KiB              prek <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.4%  57.1KiB              prek prek::run::{closure#0}
 0.2%   0.4%  54.9KiB              prek <<prek::config::Config as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.2%   0.3%  49.4KiB annotate_snippets annotate_snippets::renderer::render::render
 0.1%   0.3%  38.9KiB              prek prek::cli::run::run::run::{closure#0}
 0.1%   0.2%  34.4KiB              prek <prek::cli::RunOptions as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  33.2KiB              prek <prek::languages::ruby::installer::RubyInstaller>::install::{closure#0}
 0.1%   0.2%  29.4KiB     granit_parser <granit_parser::scanner::Scanner<granit_parser::input::str::StrInput>>::fetch_more_tokens
 0.1%   0.2%  28.8KiB     granit_parser <granit_parser::scanner::Scanner<granit_parser::input::str::StrInput>>::fetch_more_tokens
 0.1%   0.2%  28.6KiB    cargo_metadata <&mut serde_json::de::Deserializer<serde_json::read::StrRead> as serde_core::de::Deserializer>::deserialize_struct::<<cargo_metadata::Package as serde_core::de::Deserialize>::deserialize::__Visitor>
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_44_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_44_0_edwards25519_scalarmuldouble
 0.1%   0.2%  27.1KiB              prek <<prek::config::RemoteHook as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.1%   0.2%  27.0KiB              prek <prek::languages::mise::installer::MiseInstaller>::download::{closure#0}
 0.1%   0.2%  25.7KiB              prek prek::cli::try_repo::try_repo::{closure#0}
 0.1%   0.2%  23.9KiB              prek <<prek::config::LocalHook as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.1%   0.2%  23.7KiB              prek <<prek::config::UpdateOptions as serde_core::de::Deserialize>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map::<<serde_saphyr::de::deserializer::YamlDeserializer as serde_core::de::Deserializer>::deserialize_map::MA>
 0.1%   0.2%  23.2KiB               xml <xml::reader::parser::PullParser>::dispatch_token
43.1%  88.6%  13.1MiB                   And 26833 smaller methods. Use -n N to show more.
48.6% 100.0%  14.8MiB                   .text section size, the file size is 30.5MiB

@prek-ci-bot

prek-ci-bot Bot commented Aug 17, 2026 •

Copy link
Copy Markdown

⚡️ Hyperfine Benchmarks

Summary: 0 regressions, 0 improvements above the 10% threshold.

Environment
  • OS: Linux 6.17.0-1022-azure
  • CPU: 4 cores
  • prek version: prek 0.4.14+4 (7fad048 2026-08-17)
  • Rust version: rustc 1.97.1 (8bab26f4f 2026-07-14)
  • Hyperfine version: hyperfine 1.20.0
CLI Commands

Benchmarking basic commands in the main repo:

prek --version

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base --version 2.6 ± 0.1 2.4 2.7 1.07 ± 0.05
prek-head --version 2.4 ± 0.1 2.2 2.9 1.00

prek list

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base list 10.3 ± 0.2 10.0 10.8 1.03 ± 0.04
prek-head list 10.0 ± 0.3 9.4 10.9 1.00

prek validate-config .pre-commit-config.yaml

⏭️ Skipped: .pre-commit-config.yaml not found

prek sample-config

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base sample-config 3.0 ± 0.1 2.9 3.1 1.08 ± 0.03
prek-head sample-config 2.8 ± 0.1 2.6 2.9 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 39.2 ± 1.3 37.7 42.1 1.00
prek-head run --all-files 39.8 ± 0.7 39.0 41.1 1.02 ± 0.04

prek run --all-files (warm - with cache)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --all-files 40.2 ± 0.8 38.9 41.3 1.00
prek-head run --all-files 40.3 ± 1.0 38.4 42.0 1.00 ± 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 39.5 ± 1.0 36.9 41.5 1.01 ± 0.04
prek-head run --all-files 39.1 ± 1.2 36.6 41.5 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 13.7 ± 0.6 12.8 15.8 1.01 ± 0.06
prek-head run trailing-whitespace --all-files 13.5 ± 0.4 12.5 14.3 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 12.3 ± 0.5 11.5 13.4 1.05 ± 0.05
prek-head run end-of-file-fixer --all-files 11.7 ± 0.3 11.2 12.4 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.3 8.3 9.3 1.04 ± 0.04
prek-head run check-json --all-files 8.5 ± 0.2 8.1 9.1 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.2 8.2 9.3 1.03 ± 0.04
prek-head run check-yaml --all-files 8.2 ± 0.2 7.8 8.7 1.00

prek run check-toml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-toml --all-files 8.9 ± 0.2 8.5 9.5 1.05 ± 0.04
prek-head run check-toml --all-files 8.5 ± 0.3 7.9 9.1 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 8.2 9.3 1.04 ± 0.05
prek-head run check-xml --all-files 8.3 ± 0.3 7.9 9.0 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.1 ± 0.3 11.5 13.1 1.01 ± 0.05
prek-head run detect-private-key --all-files 12.0 ± 0.5 11.0 13.0 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 14.0 ± 0.9 12.9 15.9 1.02 ± 0.10
prek-head run fix-byte-order-marker --all-files 13.8 ± 0.9 12.5 16.2 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 5.2 ± 0.1 5.1 5.3 1.06 ± 0.04
prek-head install-hooks 4.9 ± 0.2 4.7 5.1 1.00

prek install-hooks (warm - with cache)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base install-hooks 5.2 ± 0.1 5.1 5.3 1.04 ± 0.02
prek-head install-hooks 5.0 ± 0.1 4.9 5.1 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 26.7 ± 0.4 26.1 27.5 1.00
prek-head run 26.8 ± 2.0 25.7 33.4 1.01 ± 0.08

prek run --files '*.json' (specific file type)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --files '*.json' 5.9 ± 0.1 5.8 6.1 1.06 ± 0.02
prek-head run --files '*.json' 5.6 ± 0.1 5.5 5.7 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.8 ± 0.1 7.6 8.0 1.03 ± 0.02
prek-head run --dry-run --all-files 7.5 ± 0.1 7.4 7.6 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.1 ± 0.1 8.9 9.4 1.04 ± 0.02
prek-head run check-hooks-apply --all-files 8.7 ± 0.1 8.6 8.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 9.1 ± 0.1 8.9 9.3 1.03 ± 0.02
prek-head run check-useless-excludes --all-files 8.8 ± 0.1 8.7 9.0 1.00

prek run identity --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run identity --all-files 8.2 ± 0.1 8.1 8.4 1.03 ± 0.02
prek-head run identity --all-files 8.0 ± 0.1 7.9 8.2 1.00

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings August 17, 2026 09:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings August 17, 2026 09:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

@j178
j178 merged commit c69d524 into master Aug 17, 2026
69 of 71 checks passed
@j178
j178 deleted the config-errors branch August 17, 2026 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants