Skip to content

chore: lighter prod dependencies #649

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

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

Conversation

regisb
Copy link
Contributor

@regisb regisb commented Apr 2, 2025

We move development dependencies to devDependencies, such that npm install --omit=dev becomes faster and more lightweight. In the case of frontend-app-profile, this changes shaves off a few hundred MB of disk space.

Note the move of @babel/preset-typescript from devDependencies to
dependencies: this fixes MFE build with yarn, which was previously
failing:

git clone https://github.com/openedx/frontend-app-profile/
cd frontend-app-profile
yarn install
npm run build

Was resulting in the following error:

    ERROR in ./src/index.jsx
    Module build failed (from ./node_modules/babel-loader/lib/index.js):
    Error: Cannot find package '@babel/preset-typescript' imported from node_modules/@openedx/frontend-build/config/babel-virtual-resolve-base.js

This is because yarn does not install devDependencies of package
dependencies, as opposed to npm.

@openedx-webhooks
Copy link

Thanks for the pull request, @regisb!

This repository is currently maintained by @openedx/committers-frontend-build.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.


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, 2025
@regisb regisb changed the title chore: ligter prod dependencies chore: lighter prod dependencies Apr 2, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Apr 2, 2025
@regisb regisb force-pushed the regisb/dev-deps branch from 93630c0 to 0f25ad4 Compare April 2, 2025 10:08
@regisb
Copy link
Contributor Author

regisb commented Apr 2, 2025

This is ready for review.

FYI @bradenmacdonald This builds on another pull request you opened some time ago: #566

We move development dependencies to devDependencies, such that `npm
install --omit=dev` becomes faster and more lightweight. In the case of
frontend-app-profile, this changes shaves off a few hundred MB of disk
space.

Note the move of @babel/preset-typescript from devDependencies to
dependencies: this fixes MFE build with yarn, which was previously
failing:

    git clone https://github.com/openedx/frontend-app-profile/
    cd frontend-app-profile
    yarn install
    npm run build

Was resulting in the following error:

	ERROR in ./src/index.jsx
	Module build failed (from ./node_modules/babel-loader/lib/index.js):
	Error: Cannot find package '@babel/preset-typescript' imported from node_modules/@openedx/frontend-build/config/babel-virtual-resolve-base.js

This is because yarn does not install devDependencies of package
dependencies, as opposed to npm.
@regisb regisb force-pushed the regisb/dev-deps branch from 8bb8441 to 2120161 Compare April 2, 2025 13:53
@bradenmacdonald
Copy link
Contributor

@regisb Awesome :)

@bradenmacdonald
Copy link
Contributor

Note: apparently this is more contentious than I thought - see the discussion at openedx/frontend-platform#787

@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Apr 10, 2025
Copy link

codecov bot commented Apr 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (7f26332) to head (2120161).

Additional details and impacted files
@@      Coverage Diff      @@
##   master   #649   +/-   ##
=============================
=============================

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@itsjeyd itsjeyd moved this from Needs Triage to Ready for Review in Contributions Apr 10, 2025
@itsjeyd itsjeyd added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Apr 10, 2025
@itsjeyd itsjeyd requested a review from a team April 10, 2025 08:46
@itsjeyd itsjeyd moved this from Ready for Review to Ready to Merge in Contributions Apr 24, 2025
@itsjeyd itsjeyd removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Apr 24, 2025
@itsjeyd
Copy link

itsjeyd commented Apr 24, 2025

Thanks for reviewing @UsamaSadiq! It looks like this PR is ready to be merged?

@UsamaSadiq
Copy link
Member

Yes, this should be good to merge.

@regisb
Copy link
Contributor Author

regisb commented Apr 24, 2025

I'd like to bring in @brian-smith-tcril and @adamstankiewicz in the conversation here to get their approval, and confirm that the changes here match the decision that was made in this other PR.

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we go down this path it would need to land as a breaking change. MFEs currently rely on frontend-build having these direct dependencies.

The pattern proposed in openedx/frontend-platform#790 makes more sense to me. With that we can keep frontend-build's dependencies as-is, but treat frontend-build itself as a dev dependency.

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marking this as "change requested" until we decide if we want to go the "frontend-build as dev dependency route" or this route (and the commit message is updated so semantic release knows it is a breaking change)

@regisb
Copy link
Contributor Author

regisb commented Apr 24, 2025

Sounds good, just let me know what you decide and I'll update the PR accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready to Merge
Development

Successfully merging this pull request may close these issues.

6 participants