[heft] Add auditing in rushstack CI/CD to catch performance regressions
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- node.js, typescript
- Domain
- ci-cd, performance, tooling
Research direction
Review issue #5691 for the related benchmarking approach, then examine the @rushstack/heft scenarios named here: heft --help, build runs, and test runs in demo projects using published rigs. Determine how V8 code coverage and timing or CPU profiles can provide the listed metrics. Done means benchmarks generate a baseline for main and PR CI compares results for regressions or improvements.
Written by the indexing model from the issue text.
Description
Summary
We should add a benchmark test project that runs various common scenarios for Heft, leveraging V8 code coverage to collect information on:
| item | unit | source |
|---|---|---|
| Executed Code | KiB | V8 Code Coverage |
| Unused Code | KiB | V8 Code Coverage |
| Loaded Code | KiB | V8 Code Coverage |
| Loaded Files | # | V8 Code Coverage |
| Duration | ms | time / cpuprofile |
Once we have this data being generated, we should have a baseline CI pipeline that calculates a new reference value for every commit into main, and then have the PR CI job do performance comparisons and look for regressions/improvements. This will help us catch performance regressions and give us a standard for evaluating impact of optimizations.
This is the same concept as #5691 , but targeting @rushstack/heft
Candidates for benchmarking
heft --helpheft run --only buildin demo projects using our published rigs.heft run --only testin demo projects using our published rigs.
- Dominant language
- TypeScript
- Stars
- 6.5k
- Forks
- 708
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 44
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/rushstack
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
All issues in microsoft/rushstack
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
ontola/atomic-server#1625 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
melgarafael/DeskcommCRM#1451 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
bug via-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bot:ai-assisted component:compact-js status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
midnightntwrk/midnight-sdk#403 ·