Add CodSpeed performance benchmarks#13
Merged
Merged
Conversation
Author
Congrats! CodSpeed is installed 🎉
You will start to see performance impacts in the reports once the benchmarks are run from your default branch.
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #13 +/- ##
==========================================
- Coverage 95.82% 95.48% -0.34%
==========================================
Files 6 6
Lines 1414 1419 +5
Branches 140 140
==========================================
Hits 1355 1355
- Misses 58 63 +5
Partials 1 1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR sets up continuous performance testing with CodSpeed for the uutils/grep project, providing automated detection of performance regressions on every pull request.
Changes
Benchmark suite (
benches/grep_bench.rs)15 benchmarks covering the core performance-critical paths:
Pattern compilation (5 benchmarks) -- measures regex compilation cost across all supported modes:
Line matching (8 benchmarks) -- exercises the main matching hot path with different configurations:
Throughput scanning (2 benchmarks) -- simulates realistic log file searching over 1000 lines:
CI workflow (
.github/workflows/codspeed.yml)A GitHub Actions workflow that runs benchmarks on every push to
mainand on pull requests, using CodSpeed's CPU simulation instrument for deterministic, low-variance measurements.Visibility changes (
src/lib.rs)Internal types (
Config,Matcher,RegexMode, etc.) are markedpubwith#[doc(hidden)]so they can be accessed from the benchmark harness without polluting the public API documentation. AGlobSet::new()constructor was added for the same purpose.README badge
Added a CodSpeed performance badge alongside the existing badges.
Next steps
main.benches/grep_bench.rsas needed (e.g., file I/O throughput, recursive directory scanning).