-
Notifications
You must be signed in to change notification settings - Fork 91
refactor: run tests with vitest #4043
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
base: release-23.x
Are you sure you want to change the base?
refactor: run tests with vitest #4043
Conversation
|
Thanks for the pull request, @bradenmacdonald! This repository is currently maintained by 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 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. DetailsWhere 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. |
✅ Deploy Preview for paragon-openedx-v23 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
this one looks awesome! the node test definitely it's faster but talking more holistically if we had to apply it everywhere and take decisions and handle all the edge cases that node test doesn't manage by default it would be a huge pain. are we looking to take a decision on which path is better? |
|
Yes, because we're relying on a lot of webpack magic that Vite[test] knows how to handle, converting everything to node:test is going to be a pain, even though it's in many ways cleaner and faster. But Vitetest is basically a drop-in replacement for Jest, so I'm proposing that we just switch to Vitest in this and other repos. Currently there isn't much advantage in installation time because this repo depends on frontend-build which depends on Jest, but if we can separate those out and remove Jest as a depenency altogether it will really decrease the installation size I think. |
|
Personally, I think that Vitest makes more sense for any existing repos that have large test suites using Jest, because it's so easy to replace Jest with Vitest. But for new repos or MFEs that are easier to convert, I'd prefer to use node:test which has all the features we need but is faster and has fewer dependencies. I'm fine with just using Vitest everywhere though if that simplicity is preferred. |
This PR demonstrates changing a few tests to run using Vitest instead of jest. Vitest is largely Jest-compatible and it can also handle all the non-standard imports (of e.g. SVG and SCSS files) we have in this repo.
Running the tests with Vitest is much faster than running them with Jest, though not as fast as using Node's simple built-in test runner.
Time taken to run
npm test -- src/Button/Button*.test.tsx:node:test