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

Incrementally upgrade edx-platform NPM dependencies #105

Closed
1 task done
Tracked by #31937
jmbowman opened this issue May 27, 2022 · 3 comments
Closed
1 task done
Tracked by #31937

Incrementally upgrade edx-platform NPM dependencies #105

jmbowman opened this issue May 27, 2022 · 3 comments
Assignees
Labels
epic Large unit of work, consisting of multiple tasks

Comments

@jmbowman
Copy link

jmbowman commented May 27, 2022

Many of the NPM packages used in edx-platform are very stale, and attempts to upgrade many of them at once have generally failed. Pick a tool(s) and process of incrementally upgrading subsets of the dependencies a little at a time, to see if we can gradually make the situation better. The general process should look something like:

  1. Upgrade a bunch of packages to new versions that should be mostly harmless upgrades.
  2. Test and deploy.
  3. Do one major upgrade after reading the changelog and making any minor upgrades and code changes strictly necessary to make it work.
  4. Test (maybe more carefully) and deploy.
  5. Go back to step 1.

One tool that attempts to make such a project easier is npm-check-updates:

npm-check is another option, there may be others as well. It's probably worth spending a few hours researching and comparing the options here.

Once a tool and process are finalized, start using it in edx-platform to update the package*.json files. Don't try to change too many things in one deployment, we don't want to make it too hard to track down what may have caused a bug that slips past tests to affect stage or prod.

If all goes reasonably well, document the process so we can repeat it in other repositories which are falling a little behind in their NPM package updates.

Related tasks

@jmbowman
Copy link
Author

This is listed as Blocked on the FED-BOM board; @ishahroz , what is it currently waiting on?

@abdullahwaheed
Copy link

we are trying to upgrade webpack from v2 to v4. Facing issues in underscore configs with this upgrade.
we are also trying to upgrade edx-ui-toolkit, which would result in a lot of security and linting issues resolution but faced some issues with this upgrade. Fixing those as well.
Also tried to upgrade karma, but its dependency is on webpack.
Some other package upgrades were also planned but majorly webpack becomes a blocker

@feanil
Copy link
Contributor

feanil commented Jun 14, 2024

Many major package updates were done as a part of the Node 18 upgrade and the package.json now compiles properly without issues thanks to some cleanup in the proctoring dependencies which were previously using npm shrinkwrap further updates will be coordinated via openedx/edx-platform#34900

See openedx/edx-platform#34873 and https://github.com/openedx/edx-platform/pulls?q=is%3Apr+author%3Aapp%2Frenovate+is%3Aclosed for some recent evidence of this.

image

@feanil feanil closed this as completed Jun 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic Large unit of work, consisting of multiple tasks
Projects
Status: Closed
Development

No branches or pull requests

6 participants