Add lint check for reasonable asset bundle sizes #9353

aduth · 2023-10-11T13:50:23Z

🛠 Summary of changes

Adds a check in continuous integration that production-compiled JavaScript and CSS sizes are within a reasonable size constraint.

This is a follow-up to #9217, specifically implementing the suggestion made by @allthesignals at #9217 (comment) .

Currently, limits are set to:

application.css must be less than 350kb (currently 299kb)
application.js must be less than 8kb (currently 4kb)

📜 Testing Plan

Observe CI build results for commit history. I'll push a temporary commit shortly to test a revert of #9217, which should fail the check.

changelog: Internal, Automated Testing, Add test for reasonable asset bundle size

This reverts commit 0fcc3a7.

aduth · 2023-10-11T14:50:45Z

Confirmed that the revert in af166f2 causes the build to fail, as expected:

https://gitlab.login.gov/lg/identity-idp/-/jobs/782327

$ make lint_asset_bundle_size
find app/assets/builds/application.css -size -350000c | grep .
app/assets/builds/application.css
find public/packs/js/application-*.digested.js -size -8000c | grep .
make: *** [Makefile:119: lint_asset_bundle_size] Error 1

…"" This reverts commit af166f2.

allthesignals · 2023-10-11T17:22:07Z

Awesome, this is so simple. Are the sizes there meant to be adjusted later? I'm not familiar with the syntax/units (-size -8000c)

aduth · 2023-10-11T17:54:35Z

Awesome, this is so simple. Are the sizes there meant to be adjusted later? I'm not familiar with the syntax/units (-size -8000c)

Yeah, we can adjust as needed. I was even thinking we could adjust smaller if we find some significant wins in the size (looking at you, 299kb application.css!).

In trying to find a better resource to explain the find command, I stumbled upon this wonderfully useful site:

https://explainshell.com/explain?cmd=find+public%2Fpacks%2Fjs%2Fapplication-*.digested.js+-size+-8000c

Essentially the idea is the command will produce an output so long as the file exists and is less than 8000 bytes, and the piped grep will exit with 1 if there are no results for the find command (i.e. if the file does not exist, or if it's greater than 8000 bytes).

* LG-11082 Add Conditional Text To FullAddressSearch Component (#9331) * Add conditional text to view * add new tests * Add period to display text * package version increase from 3.1.0 to 3.1.1 * fix linter errors * changelog: Upcoming feature, USPS Full Address Search, Added conditional logic to display/hide text on the Find a participating Post Office view that will display in Help Center only * Integrate personal key feature specs into end_to_end_idv feature specs (#9336) Since feature specs run slowly, it's better to check assertions as part of a single longer spec rather than restart identity verification over and over. This removes several long-running feature specs from the test suite. [skip changelog] * Update specs to initialize session as HashWithIndifferentAccess (#9347) changelog: Internal, Automated Testing, Improve accuracy of session stubbing in tests * Change `<b>` tags to `<strong>` for better accessibility and code consistency (#9349) * Change `<b>` tags to `<strong>` for better accessibility and code consistency changelog: User-facing Improvements, Accessibility, Use strong html tag instead of b for emphasis * Enable RSpec/LeakyConstantDeclaration rubocop (#9348) * Enable RSpec/LeakyConstantDeclaration rubocop changelog: Internal, Source code, Enable RSpec rubocop * Use let instead of defining new class --------- Co-authored-by: Mitchell Henke <mitchell.henke@gsa.gov> * Sync TypeScript-ESLint versions (#9352) changelog: Internal, Dependencies, Update dependencies to their latest versions * LG-10037: display warning banner on gpo welcome back page if number of gpo letter requests exceeded (#9303) * display warning banner on gpo welcome back page if gpo letter requests are spammed changelog: User-Facing Improvements, Identity Verification, display warning banner if user has sent max letter requests within a time window * handle if user has no gpo confirmatio codes * Update app/views/idv/by_mail/enter_code/index.html.erb Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov> * tests for alert banner for spammed gpo requesets * happy linting * fix extra space in alert_spam_warning_html i18n * happy linting * lintfix i18n * lint line too long * js tag removal from alert gpo spam banner spec * integrate warning alert banner for spammed gpo letter requests into existing tests * refactor test for gpo spam warning banner * happy linting * create before action to remove test order dependency * happy linting * define gpo_verification_enabled in review app * define gpo_verification_enabled in review app --------- Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov> * Upgrade to Rails 7.1 (#9333) * fix otp missing translations * rails 7.1 changelog: Internal, Dependencies, Upgrade to Rails 7.1 * fix untranslated webauthn verification * LG-10837: Add New Piv Cac Logging for login visited (#9294) * changelog: Internal Fixes, Authentication LG-10837: Piv Cac Logging fixes * changelog: Internal, Authentication, Add Login visited for pivcac/change logging names to be uniform * uniform spec test * fix naming convention for piv cac * update rspec * add previous name * Add lint check for reasonable asset bundle sizes (#9353) * Add lint check for reasonable asset bundle sizes changelog: Internal, Automated Testing, Add test for reasonable asset bundle size * TEMPORARY: Revert "Fix JavaScript dead code elimination (#9217)" This reverts commit 0fcc3a7. * Revert "TEMPORARY: Revert "Fix JavaScript dead code elimination (#9217)"" This reverts commit af166f2. * Update changelog script to reflect non-security Dependabot usage (#9354) changelog: Internal, Changelog, Update changelog script to reflect non-security Dependabot usage * Revert "Upgrade to Rails 7.1 (#9333)" (#9356) This reverts commit f9a0cd0. * LG-10812 | Report on all-time user count (#9350) changelog: Internal, Reporting, Monthly report includes all-time user count * Reorganize combined invoice report for easier manual runs (#9358) changelog: Internal, Reporting, Reorganize combined-invoice-supplement-report * Exclude 'IRS Attempt API: Event metadata' events from log results (#9360) changelog: Internal, Data Requests, Exclude 'IRS Attempt API: Event metadata' events from log results * Remove Guardfile, guard dependencies (#9364) changelog: Internal, Dependencies, Remove unused testing dependencies * LG-11066 Do not redirect users at the phone step unless they are phone and address rate limited (#9345) Users are being rate limited and encounting the phone error screen even if they can still verify by mail. This commit changes the rate limit logic to allow users to proceed to the phone step if they can still verify their phone or complete verification by mail. A side-effect of this change is a bug is fixed where the following situation would exist: 1. A user proofed by mail after exhausting phone attempts 2. The user goes to GPO entry and chooses to cancel and start over 3. The user is redirected to the welcome step to start over 4. The welcome step before action observes the user is phone rate limited and sends the user to the phone errors controller 5. The phone errors controller has a before action to confirm the user has completed the phone errors step; the user has not since in this session so they are redirected to the welcome step 6. Steps 4 and 5 complete until there are too many redirects [skip changelog] Co-authored-by: Sonia Connolly <sonia.connolly@gsa.gov> --------- Co-authored-by: gina-yamada <125507397+gina-yamada@users.noreply.github.com> Co-authored-by: Sonia Connolly <sonia.connolly@gsa.gov> Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov> Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com> Co-authored-by: Mitchell Henke <mitchell.henke@gsa.gov> Co-authored-by: Amir Reavis-Bey <amir.reavis-bey@gsa.gov> Co-authored-by: Malick Diarra <malick.diarra@gsa.gov> Co-authored-by: Matt Wagner <mattwagner@navapbc.com> Co-authored-by: Jonathan Hooper <jonathan.hooper@gsa.gov>

Add lint check for reasonable asset bundle sizes

bd37209

changelog: Internal, Automated Testing, Add test for reasonable asset bundle size

aduth requested a review from allthesignals October 11, 2023 13:50

mitchellhenke approved these changes Oct 11, 2023

View reviewed changes

TEMPORARY: Revert "Fix JavaScript dead code elimination (#9217)"

af166f2

This reverts commit 0fcc3a7.

Revert "TEMPORARY: Revert "Fix JavaScript dead code elimination (#9217)…

ff0f16b

…"" This reverts commit af166f2.

aduth marked this pull request as ready for review October 11, 2023 15:03

aduth merged commit b12f724 into main Oct 11, 2023
2 checks passed

aduth deleted the aduth-lint-compiled-asset-bundle-size branch October 11, 2023 15:04

aduth mentioned this pull request Oct 11, 2023

Fix JavaScript Webpack tree-shaking #9217

Merged

jmdembe mentioned this pull request Oct 12, 2023

Deploy RC 322 to Prod #9369

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add lint check for reasonable asset bundle sizes #9353

Add lint check for reasonable asset bundle sizes #9353

aduth commented Oct 11, 2023

aduth commented Oct 11, 2023 •

edited

Loading

allthesignals commented Oct 11, 2023

aduth commented Oct 11, 2023

Add lint check for reasonable asset bundle sizes #9353

Add lint check for reasonable asset bundle sizes #9353

Conversation

aduth commented Oct 11, 2023

🛠 Summary of changes

📜 Testing Plan

aduth commented Oct 11, 2023 • edited Loading

allthesignals commented Oct 11, 2023

aduth commented Oct 11, 2023

aduth commented Oct 11, 2023 •

edited

Loading