Bundle Analysis V1

[codecovdesign]

Problem to Solve

The current MVP of our bundle analysis tool includes configuration guides in the UI and provides commit/PR reports within the app, as well as directly in GitHub pull request comments.

As we look to build upon this foundation, our next iterations shift to address a part of the developer workflow not covered by the MVP: repo-level reporting. This feature aims to provide a helpful view of bundle trends and compositions over time, which is a key area for further exploration in this discovery.

When I'm managing or contributing to a project, I want to easily understand how our bundles are trending over time in terms of size and composition, so that I can make informed decisions about optimizations, refactoring, or the necessity of adding/removing dependencies.

related: #1115 (comment)

We also want to provide teams with the ability to gate Pull Requests based on configurable bundle size thresholds.

Q2 quarterly items focus:

1. Bundle gate & report segmenting
   • [Bundle Analysis] FEATURE: gate configuration option for PR based on bundle size and/or changes #1491
   • DISCOVERY: file filtering for more accurate analysis #1562
2. Repo-level data visual trends: show how bundle sizes change over time due to code updates
   • ISSUE: user wants to see change trends and delta #1413 (by asset)

Non Q2 Items

Polish

Preview Give feedback

1. Improve indentation and alignment in rollup rows #1781
   Pavilion-sub-issue Polish +2
2. Standardize row colors in subrows #1782
   Pavilion-sub-issue Polish in discovery +3
3. Set a default bundle selection in bundle analysis tab #1783
   Dev-Ready Polish +2
   
4. On repo > settings update repo token copy #1785
   +0
5. bug: module mismatch #1856
   bug +1
   
6. [Bundle] Enhance the change unit for easier comparison #1917
   enhancement in discovery +2

Carryover Under Review Issues - TBD

• INSIGHT: interest in graphical representations (e.g., diff view graphs) of bundle changes, segments, and bloat #1423 (by bundle)

Filtering and grouping of assets

• DISCOVERY: sorting / tree of assets and filtering toward actionable tasks #1422
• ISSUE: user expecting HTML index to appear (ordering confusion) #1421

Configuration

• ISSUE: user expectation in 1st PR comment #1412 (onboarding)
• Config option to show/hide a "bundle analysis is working message" when no bundle changes occur. #1485 (user preference)

Docs improvement

• INSIGHT: users navigated to docs upon prompt #1386

Actionable insights

• DISCOVERY: Identifying and Managing Unnecessary or Duplicated Dependencies #1420

[codecovdesign]

next steps:

• front-end solution at the repo
  • do developers really want this?
  • configurability is missing and we need to hear that feedback
    • add feedback solicitation issue
  • explore asset viewer

get MVP out and review adoption in late q1

ideation on next iterations from existing display with 1) branch context selector, 2) bundle selector, 3) trends, 4) bundle gate?

[codecovdesign]

from slack 2/13 focus on version 2:

• branch selection
• bundle selector
• high level summary information
• bundle assets

[aj-codecov]

Coming out of quarterly planning - gates based on bundle size or change are a necessary part of V2

[nicholas-codecov]

One thing that is not noted in here, is the introduction of "Bundle Caching" (which is similar to carry-forward for coverage)

[codecovdesign]

"Bundle Caching"

@nicholas-codecov is there an issue for this already?

[nicholas-codecov]

Not that I know of, I poked @aj-codecov and he's not aware of one either

[aj-codecov]

@codecovdesign I added this in under item #2 at the top - it was discussed a couple places but never made it in to an issue, that's remedied now. It'll be a crucial step to enabling reliable bundle size over time reporting.

[codecovdesign]

got it, will check it out - thanks!

[trent-codecov]

Attaching

@adrian-codecov for general advice/expertise/assistance on the platform side
@giovanni-guidini to do some/most of the implementation