Skip to content

Conversation

@bradenmacdonald
Copy link
Contributor

@bradenmacdonald bradenmacdonald commented Dec 16, 2025

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:

Time with coverage Time (no cov)
node:test 4.76s 3.29s
Vitest 5.48s 4.16s
Jest 41.80s 10.40s

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

Thanks for the pull request, @bradenmacdonald!

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

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.

Details
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 core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Dec 16, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Dec 16, 2025
@netlify
Copy link

netlify bot commented Dec 16, 2025

Deploy Preview for paragon-openedx-v23 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e7315b7
🔍 Latest deploy log https://app.netlify.com/projects/paragon-openedx-v23/deploys/6940aa57dea3440008214b3b
😎 Deploy Preview https://deploy-preview-4043--paragon-openedx-v23.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@holaontiveros
Copy link

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?

@bradenmacdonald
Copy link
Contributor Author

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.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Dec 18, 2025
@bradenmacdonald
Copy link
Contributor Author

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.

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: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants