Skip to content
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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

tecoholic
Copy link

@tecoholic tecoholic commented Apr 2, 2024

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

with_faker

Impact of Faker.js in the size

faker_stats

After

without_faker

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

  • Ensure adequate tests are in place (or reviewed existing tests cover changes)

Only if submitting a visual change

  • Ensure to attach screenshots
  • Ensure to have UX team confirm screenshots

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.
@openedx-webhooks
Copy link

openedx-webhooks commented Apr 2, 2024

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If 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:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 2, 2024
Copy link

codecov bot commented Apr 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.46%. Comparing base (a19fe04) to head (7c347e7).
Report is 87 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs reviewer assigned PR needs to be (re-)assigned a new reviewer open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

3 participants