test: [M3-6428] - Migrate from Jest to Vitest by jdamore-linode · Pull Request #9817 · linode/manager

jdamore-linode · 2023-10-19T14:11:56Z

Description 📝

Replaces Jest with Vitest and attempts to get all of our tests passing. See also PR #8951 -- a lot of the test changes in this PR stem from that.

Trouble tests and other things to call attention to:

Made a change to confirmObjectStorage() in ObjectStorage/utilities.ts to convert the function to async/await syntax, but have not tested the change in Cloud
- I think this is only called when enabling Object Storage by creating an access key
RescueDialog.test.tsx, SearchLanding.test.tsx, CreateAPITokenDrawer.test.tsx are each failing intermittently, but seem to pass when run by themselves
We get a lot of failures when running single threaded

I've kept pretty good documentation on each of the significant changes made to the tests, and plan to follow up with a self review that describes each significant change.

Changes 🔄

The majority of our tests pass by replacing jest with vi
Others required some minor refactoring, mostly involving module mocking and other calls to vi.mock, moving component rendering to inside of tests, and making changes involving async operations

How to test 🧪

yarn test

As an Author I have considered 🤔

Check all that apply

…test configuration

…P requests

dwiley-akamai

Going to circle back to review this more in-depth in the coming days, but this was my initial look at it. I ran yarn test and didn't get any failures 🎉 and it seems to run the test suite quite quickly

dwiley-akamai · 2023-10-27T16:09:17Z

package.json

    "start:manager:ci": "yarn workspace linode-manager start:ci",
    "clean": "rm -rf node_modules && rm -rf packages/@linode/api-v4/node_modules && rm -rf packages/manager/node_modules && rm -rf packages/@linode/validation/node_modules",
-    "test": "yarn workspace linode-manager test --maxWorkers=4",
+    "test": "yarn workspace linode-manager test",


Would we no longer have multiple workers running with the switch to Vitest?

@dwiley-akamai Nope! This just removes the upper limit of having 4 workers. If I remember correctly, Vitest (and maybe Jest too) will default to the number of available cores minus 1, but we added this argument to work around an issue we were having in CI, I believe.

I originally removed it to see if CI would pass without it, but I may restore it to see if having it improves performance at all. And if it doesn't, I'll remove it again 😅

jdamore-linode · 2023-11-01T16:41:01Z

packages/manager/src/features/Account/AutoBackups.test.tsx

There is no Vitest equivalent to jest.setTimeout, so in this case we just pass the desired timeout to the test as the third parameter when calling it(...).

jdamore-linode · 2023-11-01T16:43:49Z

packages/manager/src/features/Billing/BillingPanels/BillingSummary/BillingSummary.test.tsx

Unlike Jest, when mocking modules, Vitest expects the entire module to be mocked. We accomplish this by importing the actual module and using it for the mock, overriding only the exports that we wish to mock.

Similar changes have been made throughout the codebase:

- src/features/Billing/BillingPanels/PaymentInfoPanel/PaymentInformation.test.tsx - src/features/Billing/BillingPanels/BillingActivityPanel/BillingActivityPanel.test.tsx - src/features/ObjectStorage/BucketDetail/ObjectDetailsDrawer.test.tsx - src/features/Domains/DownloadDNSZoneFileButton.test.tsx - src/components/PaymentMethodRow/PaymentMethodRow.test.tsx - src/features/TopMenu/AddNewMenu/AddNewMenu.test.tsx - src/features/Kubernetes/ClusterList/ClusterActionMenu.test.tsx - src/features/StackScripts/StackScriptsLanding.test.tsx - src/features/Linodes/LinodesDetail/LinodeBackup/LinodeBackups.test.tsx - src/hooks/useOrder.test.tsx

jdamore-linode · 2023-11-01T16:55:49Z

packages/manager/src/features/TopMenu/AddNewMenu/AddNewMenu.test.tsx

Calls to jest.mock() and vi.mock() get hoisted to the top of the file during test transformation, so calling it inside of a test doesn't always result in the behavior we expect.

In some cases we want the mocked value to differ between tests in the same test file. Unlike Jest, Vitest offers a way for us to modify the mocked value using the vi.hoisted utility. We use this in SelectRegionPanel.test.tsx and RescueDialog.test.tsx.

bnussman-akamai

🚀

packages/manager/package.json

packages/api-v4/vitest.config.ts

Co-authored-by: Banks Nussman <115251059+bnussman-akamai@users.noreply.github.com>

coliu-akamai · 2023-11-02T18:55:36Z

Coming over from frontend cafe 😆 -- will take a look tomorrow! 👀

coliu-akamai

Looks good, thanks Joe!! 🎉 Appreciate the explanations on this and the previous pr, was helpful for understanding the changes made

I did get the intermittent test failures you mentioned for SearchLanding.test.tsx and CreateAPITokenDrawer.test.tsx when running yarn test - any chance you know why they happen?

coliu-akamai · 2023-11-03T14:40:57Z

packages/api-v4/package.json

    "build": "concurrently --raw \"tsc\" \"tsup\"",
-    "test": "jest",
-    "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
+    "test": "yarn vitest run",


Do we no longer need a test:debug script for vitest? 👀 (or was this script just unnecessary in the first place?)

dwiley-akamai

I need to finish looking through the diff but I ran the tests a couple more times and got a handful of failures each time:

Joe D'Amore added 23 commits October 18, 2023 14:06

Replace Jest with Vitest for APIv4 package

3ba4e22

Remove Jest, add Vitest and related dependencies, add bare minimum Vi…

13e2844

…test configuration

Find and replace "jest" to "vi"

70e7e1e

Update snapshot

e0b7baa

Stop using deprecated 'done()' callback

22215b1

Restore jest-axe package, fix import typo from find+replace

695db65

Remove jest.setTimeout call and pass timeout to it(...)

0dc0c2d

Fix failures stemming from module import mocking

dab5903

Refactor tests to account for Vitest hoisting rules

cc8803a

Replace xit with it.skip

b1822c5

Refactor pricing util and query param mocks to account for hoisting

138dbdf

Fix test by wrapping assertions in it(() => {...})

815053a

Fix test by moving component rendering inside test

28679b7

Remove mock for decode function in he module

c957b5b

Remove --maxWorkers=4 CLI parameter

22756d7

Refactor storage util tests, update for changes in logic

acccbe1

Fix failure by importing cached kernel data dynamically

d8b9f12

Wrap test in describe block, replace 'red' with 'rgb(...)'

021c622

Refactor test to focus on results over implementation

bea02e8

Fix Algolia module mock

4d682fc

Fix test by converting utility function to async/await syntax

0471ae5

Fix API tokens secrets drawer test by tweaking user interactions

db12c44

Add vitest UI, update lockfile

e7474b8

jdamore-linode added the Work in Progress label Oct 19, 2023

jdamore-linode requested a review from bnussman-akamai October 19, 2023 14:11

jdamore-linode self-assigned this Oct 19, 2023

jdamore-linode requested a review from a team as a code owner October 19, 2023 14:11

jdamore-linode requested review from cliu-akamai and dwiley-akamai and removed request for a team October 19, 2023 14:11

Joe D'Amore added 4 commits October 25, 2023 10:55

Merge branch 'develop' into M3-6428-jest-to-vitest

be2b880

Improve Rescue Dialog test stability by mocking hooks rather than HTT…

7ac7d4c

…P requests

Merge branch 'develop' into M3-6428-jest-to-vitest

d860b35

Update snapshot

ea7af2c

dwiley-akamai reviewed Oct 27, 2023

View reviewed changes

Joe D'Amore added 4 commits October 30, 2023 09:41

Merge branch 'develop' into M3-6428-jest-to-vitest

9216ab2

Merge branch 'develop' into M3-6428-jest-to-vitest

fcad236

Merge branch 'develop' into M3-6428-jest-to-vitest

a067673

Replace call to jest.fn() with vi.fn()

f8b8af2

jdamore-linode commented Nov 1, 2023

View reviewed changes

jdamore-linode added Ready for Review and removed Work in Progress labels Nov 1, 2023

bnussman-akamai approved these changes Nov 1, 2023

View reviewed changes

packages/manager/package.json Outdated Show resolved Hide resolved

packages/manager/package.json Show resolved Hide resolved

packages/api-v4/vitest.config.ts Show resolved Hide resolved

Joe D'Amore and others added 2 commits November 2, 2023 14:14

Merge branch 'develop' into M3-6428-jest-to-vitest

b7eff0b

Simplify test command

1cc8ea0

Co-authored-by: Banks Nussman <115251059+bnussman-akamai@users.noreply.github.com>

coliu-akamai self-requested a review November 2, 2023 18:54

Merge branch 'develop' into M3-6428-jest-to-vitest

89fae59

coliu-akamai approved these changes Nov 3, 2023

View reviewed changes

Merge branch 'develop' into M3-6428-jest-to-vitest

ed7d7a9

dwiley-akamai reviewed Nov 6, 2023

View reviewed changes

dwiley-akamai approved these changes Nov 7, 2023

View reviewed changes

Joe D'Amore added 4 commits November 8, 2023 17:27

Merge branch 'develop' into M3-6428-jest-to-vitest

3b4d0e8

Merge branch 'develop' into M3-6428-jest-to-vitest

5cbd307

Merge branch 'develop' into M3-6428-jest-to-vitest

2c53f0c

Merge branch 'develop' into M3-6428-jest-to-vitest

d2dbb21

bnussman-akamai mentioned this pull request Nov 16, 2023

change: [M3-7396] - Update axios to 1.6.1 #9911

Merged

12 tasks

jdamore-linode merged commit 94f82bd into linode:develop Nov 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: [M3-6428] - Migrate from Jest to Vitest#9817

test: [M3-6428] - Migrate from Jest to Vitest#9817
jdamore-linode merged 44 commits intolinode:developfrom
jdamore-linode:M3-6428-jest-to-vitest

jdamore-linode commented Oct 19, 2023 •

edited

Loading

Uh oh!

dwiley-akamai left a comment

Uh oh!

dwiley-akamai Oct 27, 2023

Uh oh!

jdamore-linode Oct 30, 2023

Uh oh!

jdamore-linode Nov 1, 2023

Uh oh!

jdamore-linode Nov 1, 2023

Uh oh!

jdamore-linode Nov 1, 2023

Uh oh!

bnussman-akamai left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coliu-akamai commented Nov 2, 2023

Uh oh!

coliu-akamai left a comment

Uh oh!

coliu-akamai Nov 3, 2023

Uh oh!

dwiley-akamai left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

jdamore-linode commented Oct 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description 📝

Changes 🔄

How to test 🧪

As an Author I have considered 🤔

Uh oh!

dwiley-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

dwiley-akamai Oct 27, 2023

Choose a reason for hiding this comment

Uh oh!

jdamore-linode Oct 30, 2023

Choose a reason for hiding this comment

Uh oh!

jdamore-linode Nov 1, 2023

Choose a reason for hiding this comment

Uh oh!

jdamore-linode Nov 1, 2023

Choose a reason for hiding this comment

Uh oh!

jdamore-linode Nov 1, 2023

Choose a reason for hiding this comment

Uh oh!

bnussman-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coliu-akamai commented Nov 2, 2023

Uh oh!

coliu-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

coliu-akamai Nov 3, 2023

Choose a reason for hiding this comment

Uh oh!

dwiley-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jdamore-linode commented Oct 19, 2023 •

edited

Loading