[code-infra] vitest browser & jsdom modes
#14508
+4,020
−2,547
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| name: Vitest | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - 'master' | ||
| - 'next' | ||
| pull_request: | ||
| branches: | ||
| - 'master' | ||
| - 'next' | ||
|
|
||
| permissions: {} | ||
|
|
||
| jobs: | ||
| vitest-jsdom: | ||
| name: Vitest Tests (jsdom) | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | ||
| - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 | ||
| with: | ||
| run_install: false | ||
| - name: Use Node.js 20.x | ||
| uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3 | ||
| with: | ||
| node-version: 20 | ||
| cache: 'pnpm' # https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#caching-packages-dependencies | ||
| - run: pnpm install --frozen-lockfile | ||
| - name: Install Playwright Browsers | ||
| run: pnpm playwright install --with-deps | ||
| - name: Run Tests | ||
| run: pnpm vitest --project "jsdom/*" | ||
| vitest-browser: | ||
| name: Vitest Tests (browser) | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | ||
| - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 | ||
| with: | ||
| run_install: false | ||
| - name: Use Node.js 20.x | ||
| uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3 | ||
| with: | ||
| node-version: 20 | ||
| cache: 'pnpm' # https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#caching-packages-dependencies | ||
| - run: pnpm install --frozen-lockfile | ||
| - name: Install Playwright Browsers | ||
| run: pnpm playwright install --with-deps | ||
| - name: Run Tests | ||
| run: pnpm vitest --project "browser/*" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,7 +65,8 @@ | |
| "release:publish:dry-run": "pnpm publish --recursive --tag latest --registry=\"http://localhost:4873/\"", | ||
| "release:tag": "node scripts/releaseTag.mjs", | ||
| "validate": "concurrently \"pnpm prettier && pnpm eslint\" \"pnpm proptypes\" \"pnpm docs:typescript:formatted\" \"pnpm docs:api\"", | ||
| "clean:node_modules": "rimraf --glob \"**/node_modules\"", | ||
| "vitest": "cross-env TZ=UTC vitest" | ||
| }, | ||
| "devDependencies": { | ||
| "@actions/core": "^1.10.1", | ||
|
|
@@ -100,6 +101,7 @@ | |
| "@octokit/plugin-retry": "^7.1.1", | ||
| "@octokit/rest": "^21.0.2", | ||
| "@playwright/test": "^1.44.1", | ||
| "@testing-library/react": "^16.0.1", | ||
| "@types/babel__core": "^7.20.5", | ||
| "@types/babel__traverse": "^7.20.6", | ||
| "@types/chai": "^4.3.19", | ||
|
|
@@ -117,6 +119,8 @@ | |
| "@types/yargs": "^17.0.33", | ||
| "@typescript-eslint/eslint-plugin": "^7.18.0", | ||
| "@typescript-eslint/parser": "^7.18.0", | ||
| "@vitejs/plugin-react": "^4.3.1", | ||
| "@vitest/browser": "^2.0.5", | ||
| "autoprefixer": "^10.4.20", | ||
| "axe-core": "4.10.0", | ||
| "babel-loader": "^9.1.3", | ||
|
|
@@ -191,14 +195,18 @@ | |
| "typescript": "^5.5.4", | ||
| "unist-util-visit": "^5.0.0", | ||
| "util": "^0.12.5", | ||
| "vitest": "2.0.5", | ||
| "webpack": "^5.94.0", | ||
| "webpack-bundle-analyzer": "^4.10.2", | ||
| "webpack-cli": "^5.1.4", | ||
| "yargs": "^17.7.2" | ||
| }, | ||
| "resolutions": { | ||
| "react-is": "^18.3.1", | ||
| "@types/node": "^20.16.5", | ||
| "@playwright/test": "1.44.1", | ||
| "playwright": "1.44.1", | ||
JCQuintas marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "@mui/internal-test-utils": "https://pkg.csb.dev/mui/material-ui/commit/ae23bac4/@mui/internal-test-utils" | ||
| }, | ||
| "packageManager": "[email protected]", | ||
| "engines": { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,17 +28,30 @@ const isJSDOM = /jsdom/.test(window.navigator.userAgent); | |
| describe('BarChart - click event', () => { | ||
| const { render } = createRenderer(); | ||
|
|
||
| beforeEach(() => { | ||
| if (window?.document?.body?.style) { | ||
| window.document.body.style.margin = '0'; | ||
| } | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| if (window?.document?.body?.style) { | ||
| window.document.body.style.margin = '8px'; | ||
| } | ||
| }); | ||
|
Comment on lines
+30
to
+40
There was a problem hiding this comment. Some charts tests are reliant screen position, and margins are different for karma and vitest, so we force one. 🙃 |
||
|
|
||
| describe('onAxisClick', () => { | ||
| it('should provide the right context as second argument', function test(t = {}) { | ||
| if (isJSDOM) { | ||
| // can't do Pointer event with JSDom https://github.com/jsdom/jsdom/issues/2527 | ||
| // @ts-expect-error to support mocha and vitest | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-expressions | ||
| this?.skip?.() || t?.skip(); | ||
|
There was a problem hiding this comment. You will see this pattern across multiple files, Without this mocha will fail because it waits for the This can then be migrated to just a .skip, but vitest offers many ways of skipping test. function test(t) {
if (isJSDOM) {
t.skip();
}
}There was a problem hiding this comment. I added a shim in The same couldn't be done for Don't necessarily have to use it, but it can keep the amount of code changes in tests down. |
||
| } | ||
| const onAxisClick = spy(); | ||
| render( | ||
| <div | ||
| style={{ | ||
| width: 400, | ||
| height: 400, | ||
| }} | ||
|
|
@@ -81,16 +94,17 @@ describe('BarChart - click event', () => { | |
| }); | ||
| }); | ||
|
|
||
| it('should provide the right context as second argument with layout="horizontal"', function test(t = {}) { | ||
| if (isJSDOM) { | ||
| // can't do Pointer event with JSDom https://github.com/jsdom/jsdom/issues/2527 | ||
| // @ts-expect-error to support mocha and vitest | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-expressions | ||
| this?.skip?.() || t?.skip(); | ||
| } | ||
| const onAxisClick = spy(); | ||
| render( | ||
| <div | ||
| style={{ | ||
| width: 400, | ||
| height: 400, | ||
| }} | ||
|
|
@@ -155,16 +169,17 @@ describe('BarChart - click event', () => { | |
| ).to.deep.equal(['pointer', 'pointer', 'pointer', 'pointer']); | ||
| }); | ||
|
|
||
| it('should provide the right context as second argument', function test(t = {}) { | ||
| if (isJSDOM) { | ||
| // can't do Pointer event with JSDom https://github.com/jsdom/jsdom/issues/2527 | ||
| // @ts-expect-error to support mocha and vitest | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-expressions | ||
| this?.skip?.() || t?.skip(); | ||
| } | ||
| const onItemClick = spy(); | ||
| render( | ||
| <div | ||
| style={{ | ||
| width: 400, | ||
| height: 400, | ||
| }} | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CircleCI please: https://www.notion.so/mui-org/code-infra-Migrate-out-of-CircleCI-42350363b7344380a9961cf9731aae31 for the final version of this effort.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this is just for ensuring the changes work while working on them
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we remove the GH workflow given that CircleCI is already setup? 🤔