Skip to content

Clean stale patch files in cache gc#1877

Merged
j178 merged 1 commit intomasterfrom
gc-patches
Apr 1, 2026
Merged

Clean stale patch files in cache gc#1877
j178 merged 1 commit intomasterfrom
gc-patches

Conversation

@j178
Copy link
Copy Markdown
Owner

@j178 j178 commented Apr 1, 2026

Clean stale *.patch files during prek cache gc

Closes #1635

@j178 j178 changed the title [codex] Clean stale patch files in cache gc [codex] Clean stale patch files in cache gc Apr 1, 2026
@j178 j178 changed the title [codex] Clean stale patch files in cache gc Clean stale patch files in cache gc Apr 1, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 1, 2026

Codecov Report

❌ Patch coverage is 80.00000% with 12 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.11%. Comparing base (47b371f) to head (e6a4902).
⚠️ Report is 2 commits behind head on master.

Files with missing lines Patch % Lines
crates/prek/src/cli/cache_gc.rs 80.00% 12 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1877      +/-   ##
==========================================
- Coverage   92.16%   92.11%   -0.05%     
==========================================
  Files         112      112              
  Lines       22457    22522      +65     
==========================================
+ Hits        20698    20747      +49     
- Misses       1759     1775      +16     

☔ View full report in Codecov by Sentry.
📢 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.

@j178 j178 added the enhancement New feature or request label Apr 1, 2026
@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot bot commented Apr 1, 2026

📦 Cargo Bloat Comparison

Binary size change: +0.00% (25.5 MiB → 25.5 MiB)

Expand for cargo-bloat output

Head Branch Results

 File  .text     Size             Crate Name
 1.3%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_39_0_aes_gcm_encrypt_avx512
 1.3%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_39_0_aes_gcm_decrypt_avx512
 0.3%   0.7%  86.3KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  80.7KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.5%  69.1KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.5%  57.0KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.4%  51.0KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  47.4KiB              prek prek::run::{{closure}}
 0.2%   0.3%  42.3KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  33.3KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_39_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.8KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_39_0_edwards25519_scalarmuldouble
 0.1%   0.2%  27.1KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  26.6KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{closure}}>
 0.1%   0.2%  25.8KiB             prek? <prek::config::_::<impl serde_core::de::Deserialize for prek::config::Config>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map
 0.1%   0.2%  22.6KiB              prek prek::hooks::meta_hooks::MetaHooks::run::{{closure}}
 0.1%   0.2%  22.4KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  22.3KiB         [Unknown] Lp384_montjscalarmul_alt_p384_montjadd
 0.1%   0.2%  21.5KiB              prek prek::workspace::Project::init_hooks::{{closure}}
41.6%  86.2%  10.6MiB                   And 23964 smaller methods. Use -n N to show more.
48.2% 100.0%  12.3MiB                   .text section size, the file size is 25.5MiB

Base Branch Results

 File  .text     Size             Crate Name
 1.3%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_39_0_aes_gcm_encrypt_avx512
 1.3%   2.6% 332.0KiB        aws_lc_sys aws_lc_0_39_0_aes_gcm_decrypt_avx512
 0.3%   0.7%  86.6KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  79.7KiB              prek prek::languages::<impl prek::config::Language>::run::{{closure}}::{{closure}}
 0.3%   0.6%  69.2KiB             prek? <prek::cli::Command as clap_builder::derive::Subcommand>::augment_subcommands
 0.2%   0.5%  57.0KiB              prek prek::languages::<impl prek::config::Language>::install::{{closure}}
 0.2%   0.4%  51.0KiB annotate_snippets annotate_snippets::renderer::render::render
 0.2%   0.4%  47.7KiB              prek prek::run::{{closure}}
 0.2%   0.3%  42.3KiB              prek prek::cli::run::run::run::{{closure}}
 0.1%   0.3%  33.3KiB             prek? <prek::cli::RunArgs as clap_builder::derive::Args>::augment_args
 0.1%   0.2%  28.0KiB        aws_lc_sys aws_lc_0_39_0_edwards25519_scalarmuldouble_alt
 0.1%   0.2%  27.8KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  27.5KiB        aws_lc_sys aws_lc_0_39_0_edwards25519_scalarmuldouble
 0.1%   0.2%  26.6KiB              prek prek::cli::try_repo::try_repo::{{closure}}
 0.1%   0.2%  26.6KiB               std core::ptr::drop_in_place<prek::languages::<impl prek::config::Language>::install::{{closure}}>
 0.1%   0.2%  23.9KiB             prek? <prek::config::_::<impl serde_core::de::Deserialize for prek::config::Config>::deserialize::__Visitor as serde_core::de::Visitor>::visit_map
 0.1%   0.2%  22.4KiB      serde_saphyr saphyr_parser_bw::scanner::Scanner<T>::fetch_more_tokens
 0.1%   0.2%  22.3KiB         [Unknown] Lp384_montjscalarmul_alt_p384_montjadd
 0.1%   0.2%  21.5KiB              prek prek::workspace::Project::init_hooks::{{closure}}
 0.1%   0.2%  21.5KiB      clap_builder clap_builder::parser::parser::Parser::get_matches_with
41.5%  86.2%  10.6MiB                   And 23956 smaller methods. Use -n N to show more.
48.2% 100.0%  12.3MiB                   .text section size, the file size is 25.5MiB

@prek-ci-bot
Copy link
Copy Markdown

prek-ci-bot bot commented Apr 1, 2026

⚡️ Hyperfine Benchmarks

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

Environment
  • OS: Linux 6.17.0-1008-azure
  • CPU: 4 cores
  • prek version: prek 0.3.8+12 (24d692a 2026-04-01)
  • Rust version: rustc 1.94.1 (e408947bf 2026-03-25)
  • 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.2 ± 0.1 2.1 2.8 1.02 ± 0.05
prek-head --version 2.1 ± 0.1 2.0 2.4 1.00

prek list

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base list 9.2 ± 2.0 8.4 25.0 1.03 ± 0.26
prek-head list 8.9 ± 1.0 8.4 17.2 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.0 ± 0.0 2.8 3.1 1.00
prek-head validate-config .pre-commit-config.yaml 3.0 ± 0.0 2.9 3.1 1.00 ± 0.02

prek sample-config

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base sample-config 2.4 ± 0.1 2.4 2.6 1.00
prek-head sample-config 2.5 ± 0.0 2.4 2.7 1.01 ± 0.03
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 141.5 ± 3.5 136.3 147.3 1.00
prek-head run --all-files 144.8 ± 3.8 138.6 153.2 1.02 ± 0.04

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

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --all-files 146.7 ± 4.2 139.1 152.9 1.00 ± 0.04
prek-head run --all-files 146.0 ± 4.4 139.7 156.1 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 147.8 ± 2.9 140.9 152.8 1.01 ± 0.10
prek-head run --all-files 146.5 ± 13.8 135.2 234.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 21.2 ± 1.8 19.5 26.1 1.01 ± 0.10
prek-head run trailing-whitespace --all-files 21.0 ± 1.0 19.3 22.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 27.6 ± 2.4 24.0 33.9 1.00
prek-head run end-of-file-fixer --all-files 28.9 ± 2.2 24.7 32.5 1.05 ± 0.12

prek run check-json --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-json --all-files 11.4 ± 0.4 11.0 12.5 1.00
prek-head run check-json --all-files 11.4 ± 0.3 11.0 12.6 1.00 ± 0.04

prek run check-yaml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-yaml --all-files 11.5 ± 0.2 11.1 11.8 1.02 ± 0.04
prek-head run check-yaml --all-files 11.2 ± 0.4 10.7 12.5 1.00

prek run check-toml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-toml --all-files 11.2 ± 0.3 10.7 11.9 1.02 ± 0.04
prek-head run check-toml --all-files 11.0 ± 0.3 10.5 11.5 1.00

prek run check-xml --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run check-xml --all-files 11.3 ± 0.3 10.7 12.0 1.02 ± 0.04
prek-head run check-xml --all-files 11.1 ± 0.3 10.5 11.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 17.8 ± 1.5 15.0 21.1 1.02 ± 0.11
prek-head run detect-private-key --all-files 17.4 ± 1.2 15.7 20.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 23.5 ± 2.0 20.1 29.4 1.01 ± 0.19
prek-head run fix-byte-order-marker --all-files 23.3 ± 4.0 20.0 42.4 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.5 ± 0.1 4.4 4.6 1.02 ± 0.02
prek-head install-hooks 4.4 ± 0.0 4.4 4.5 1.00

prek install-hooks (warm - with cache)

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base install-hooks 4.4 ± 0.1 4.4 4.5 1.00 ± 0.02
prek-head install-hooks 4.4 ± 0.1 4.4 4.6 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 49.2 ± 1.0 47.7 51.6 1.01 ± 0.03
prek-head run 48.5 ± 1.0 46.6 50.2 1.00

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

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run --files '*.json' 8.7 ± 0.3 8.3 9.5 1.07 ± 0.04
prek-head run --files '*.json' 8.2 ± 0.1 8.0 8.4 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 12.9 ± 0.6 12.2 15.2 1.00
prek-head run --dry-run --all-files 13.1 ± 0.3 12.6 13.6 1.02 ± 0.06
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 13.5 ± 0.2 13.2 14.0 1.03 ± 0.03
prek-head run check-hooks-apply --all-files 13.1 ± 0.3 12.8 13.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 11.7 ± 0.3 11.4 12.4 1.03 ± 0.03
prek-head run check-useless-excludes --all-files 11.4 ± 0.1 11.1 11.6 1.00

prek run identity --all-files

Command Mean [ms] Min [ms] Max [ms] Relative
prek-base run identity --all-files 10.0 ± 0.1 9.9 10.1 1.01 ± 0.02
prek-head run identity --all-files 9.8 ± 0.2 9.6 10.4 1.00

@j178 j178 marked this pull request as ready for review April 1, 2026 08:17
Copilot AI review requested due to automatic review settings April 1, 2026 08:17
Copy link
Copy Markdown

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

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: e6a4902f70

ℹ️ 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".

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

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 enhances prek cache gc to clean up stale recovery *.patch files under the cache’s patches/ directory, addressing long-term accumulation concerns raised in #1635.

Changes:

  • Add a retention-based sweep that deletes patch files older than a fixed cutoff during prek cache gc.
  • Include patch-file removals in cache gc summaries and verbose removal details output.
  • Add an integration test validating dry-run and real removal behavior for stale patch files.

Reviewed changes

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

File Description
crates/prek/src/cli/cache_gc.rs Adds PatchFiles to GC removal reporting and implements sweeping stale *.patch files by mtime.
crates/prek/tests/cache.rs Adds coverage ensuring stale patch files are reported/removed while recent ones remain.

@j178 j178 merged commit 0b6df1f into master Apr 1, 2026
60 checks passed
@j178 j178 deleted the gc-patches branch April 1, 2026 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request: Patch Storage Management and Cleanup

2 participants