-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: remove faker from application code #1194
base: master
Are you sure you want to change the base?
fix: remove faker from application code #1194
Conversation
The faker.js library intended for testing and development has been used in one of the application files causing the entire library to be bundled in the final output. This commit replaces it's usage with uuid library.
Thanks for the pull request, @tecoholic! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently unmaintained. To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:
Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1194 +/- ##
=======================================
Coverage 85.46% 85.46%
=======================================
Files 508 508
Lines 11074 11074
Branches 2329 2329
=======================================
Hits 9464 9464
Misses 1566 1566
Partials 44 44 ☔ View full report in Codecov by Sentry. |
While testing the admin-portal, I noticed that the bundle size was huge and discovered that a lot of bloat is coming from the usage of faker.js in the application code. Faker.js should be limited to development and testing, as it has many definitions and seed data that can cause unnecessary bloat.
Here are some screenshots comparing the changes in bundle sizes before and after the change.
Before
Impact of Faker.js in the size
After
The Parsed bundle size fell from 5.84MB to 3.14MB as 46% reduction.
Caveat
I didn't particularly test the impact of this change on the functionality. I don't think there should be any. Mentioning it, just in case.
For all changes
Only if submitting a visual change