Feature/jest to vitest migration

[Abhishek-17h]

• I signed and returned the Plone Contributor Agreement, and received and accepted an invitation to join a team in the Plone GitHub organization.
• I verified there aren't other open pull requests for the same change.
• I followed the guidelines in Contributing to Volto.
• I succesfully ran code linting checks on my changes locally.
• I succesfully ran unit tests on my changes locally.
• I succesfully ran acceptance tests on my changes locally.
• If needed, I added new tests for my changes.
• If needed, I added documentation for my changes, either in the Storybook or narrative documentation.
• I included a change log entry in my commits.

---

If your pull request closes an open issue, include the exact text below, immediately followed by the issue number. When your pull request gets merged, then that issue will close automatically.

Closes #6326

[netlify]

✅ Deploy Preview for plone-components canceled.

Name	Link
🔨 Latest commit	8a10bf6
🔍 Latest deploy log	https://app.netlify.com/sites/plone-components/deploys/67b1c07a2413980008b89f62

[Abhishek-17h]

I’ve created this draft PR to get feedback on my current progress for this issue. Here’s what I’ve completed so far and what remains to be done:

Remaining Work:
Configure Vitest to make it the default unit test runner for Volto.
Write documentation on how to migrate projects and add-ons to use Vitest.
Create general documentation about Vitest for new users.
Migrate the remaining test files to Vitest.
I’d like to confirm that I’m heading in the right direction with my work so far. If someone could guide me on configuring Vitest as Volto’s unit test runner, it would be really helpful, as I want to ensure there are no mistakes in the configuration files.

Looking forward to your feedback!

[Abhishek-17h]

@tisto @sneridagh

[sneridagh]

I added some preliminary comments, please take a look at them. I know it's a WIP still, but I hope they help.
I haven't gone through all the changes, but the few I went look good.
It's an humongous work, so thank you for taking care of it!

You already changed the scripts commands, so it should work, CI points at them:
pnpm --filter @plone/volto test

CI is RED because you need to update the lockfile (pnpm install).

[sneridagh]

We should include some docs about how mocks work, and the recommended way in usual cases, like this one.

[Abhishek-17h]

I'll add documentation about how mocks work and the recommended approach for common cases like this. That will make it easier for others to follow.

[Abhishek-17h]

@sneridagh Thank you for the helpful review! I’ll implement the suggestions.

[Abhishek-17h]

Hey @sneridagh, I’m in the final phase of this work and need your help with an issue I’ve been stuck on for the past few days.

In this file https://github.com/plone/volto/blob/main/packages/volto/__tests__/create-addons-loader.test.js, perticuarly in makeAddonLoader function, CommonJS syntax require is used, which is not compatible with Vitest. I replaced it with async/await'and import, but it’s still not working.

Could you help me out with this?

[Abhishek-17h]

Only two files are remaining to migrate to vitest
1)https://github.com/plone/volto/blob/main/packages/volto/__tests__/create-addons-loader.test.js
2)https://github.com/plone/volto/blob/main/packages/volto/__tests__/volto-slate/deserialize.test.js
All other test files works well with vitest and migrated to use vitest

[sneridagh]

@Abhishek-17h This is amazing!
I know that these two tests are quite complex. 1) is not that important, we have other means of testing it, 2) definetely is important. Although having both, of course would be desirable. Go for 2) if possible, you can leave the other.

PD: I don't know if using jiti would be useful (a code file loader and parser in runtime) for 1) never tried.

[Abhishek-17h]

@sneridagh Thanks for your suggestion! Jiti worked perfectly and solved the problem that had me stuck for a week.

[Abhishek-17h]

@sneridagh Code is ready for review! All tests are passing successfully with Vitest, including the previously mentioned ones. The documentation is still pending, but it’s not a significant task. While the review is in progress, I will work on completing the documentation, as the review process will take considerable time.

[stevepiercy]

@Abhishek-17h thank you for this massive effort. Two things:

• Please resolve merge conflicts.
• Let me know if you need assitance with writing narrative documentation. I'm happy to help!

[Abhishek-17h]

@stevepiercy I will resolve merge conflicts and I will reach out if I need any assistance for documentation