Skip to content

Commit 0d1e09a

Browse files
authored
Revert @testing-library/jest-dom v6 upgrade (#9713)
This reverts #9673 and #9711. With v6 of `@testing-library/jest-dom`, `yarn rw type-check` fails in Redwood projects because it can't locate the types for `@testing-libary/jest-dom`. They absorbed the definitely types package (`@types/testing-library__jest-dom`) in this PR: testing-library/jest-dom#511. Here's an example of a failing run: https://github.com/redwoodjs/redwood/actions/runs/7213177056/job/19668365614?pr=9708. The logical thing to do is remove `@testing-libary/jest-dom` from the `types` array in `web/tsconfig.json`, but when we do that we get a different failure from TS saying that it doesn't understand the extended matchers provided by `testing-library/jest-dom` like `toBeInTheDocument`. @Tobbe filed an issue in their repo here testing-library/jest-dom#559. In the PR I linked to, the maintainer notes that... > But in my local testing with the changes in this PR, following the Readme was sufficient to get full auto-complete support even for JS-only users. As long as they have a jest-setup file that imports the bare export and add a dependency on @types/jest, recent versions of VS Code will figure it out. Users don't have jest setup files in their project (we just point to a jest preset) or `@types/jest` as an explicit dev dependency. I took a look at it but couldn't crack it today. Instead of holding up other PRs in CI, better to revert it for now and come back to later when we have more leads.
1 parent 08aae1f commit 0d1e09a

21 files changed

+58
-48
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
"@faker-js/faker": "8.0.2",
6767
"@npmcli/arborist": "7.2.2",
6868
"@playwright/test": "1.40.1",
69-
"@testing-library/jest-dom": "6.1.5",
69+
"@testing-library/jest-dom": "5.17.0",
7070
"@testing-library/react": "14.1.2",
7171
"@testing-library/user-event": "14.5.1",
7272
"@types/babel__generator": "7.6.7",

packages/auth/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"devDependencies": {
3030
"@babel/cli": "7.23.4",
3131
"@babel/core": "^7.22.20",
32-
"@testing-library/jest-dom": "6.1.5",
32+
"@testing-library/jest-dom": "5.17.0",
3333
"@testing-library/react": "14.1.2",
3434
"jest": "29.7.0",
3535
"msw": "1.3.2",

packages/auth/src/__tests__/AuthProvider.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
configure,
1111
} from '@testing-library/react'
1212
import { renderHook, act } from '@testing-library/react'
13-
import '@testing-library/jest-dom/jest-globals'
13+
import '@testing-library/jest-dom/extend-expect'
1414
import { graphql } from 'msw'
1515
import { setupServer } from 'msw/node'
1616

packages/forms/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,13 @@
3131
"@babel/cli": "7.23.4",
3232
"@babel/core": "^7.22.20",
3333
"@testing-library/dom": "9.3.3",
34-
"@testing-library/jest-dom": "6.1.5",
34+
"@testing-library/jest-dom": "5.17.0",
3535
"@testing-library/react": "14.1.2",
3636
"@testing-library/user-event": "14.5.1",
3737
"@types/pascalcase": "1.0.3",
3838
"@types/react": "18.2.37",
3939
"@types/react-dom": "18.2.15",
40+
"@types/testing-library__jest-dom": "5.14.9",
4041
"graphql": "16.8.1",
4142
"jest": "29.7.0",
4243
"nodemon": "3.0.2",

packages/router/src/__tests__/location.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { render } from '@testing-library/react'
2-
import '@testing-library/jest-dom/jest-globals'
2+
import '@testing-library/jest-dom/extend-expect'
33

44
import { LocationProvider, useLocation } from '../location'
55

packages/router/src/__tests__/nestedSets.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from 'react'
22
import type { ReactNode } from 'react'
33

4-
import '@testing-library/jest-dom/jest-globals'
4+
import '@testing-library/jest-dom/extend-expect'
55
import { act, render } from '@testing-library/react'
66

77
import { navigate, Route, Router } from '../'

packages/router/src/__tests__/route-announcer.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React from 'react'
22

33
import { render, waitFor, act } from '@testing-library/react'
4-
import '@testing-library/jest-dom/jest-globals'
4+
import '@testing-library/jest-dom/extend-expect'
55

66
import { getAnnouncement } from '../a11yUtils'
77
import { navigate } from '../history'

packages/router/src/__tests__/route-focus.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { render, waitFor } from '@testing-library/react'
2-
import '@testing-library/jest-dom/jest-globals'
2+
import '@testing-library/jest-dom/extend-expect'
33

44
import { getFocus } from '../a11yUtils'
55
import RouteFocus from '../route-focus'

packages/router/src/__tests__/routeScrollReset.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react'
22

3-
import '@testing-library/jest-dom/jest-globals'
3+
import '@testing-library/jest-dom/extend-expect'
44
import { act, cleanup, render, screen } from '@testing-library/react'
55

66
import { navigate } from '../history'

packages/router/src/__tests__/router.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jest.mock('../util', () => {
2020

2121
import React, { useEffect, useState } from 'react'
2222

23-
import '@testing-library/jest-dom/jest-globals'
23+
import '@testing-library/jest-dom/extend-expect'
2424
import {
2525
act,
2626
configure,

packages/router/src/__tests__/set.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import * as React from 'react'
22
import type { ReactNode } from 'react'
33

44
import { act, render, waitFor } from '@testing-library/react'
5-
import '@testing-library/jest-dom/jest-globals'
5+
import '@testing-library/jest-dom/extend-expect'
66

77
import { navigate } from '../history'
88
import { Route, Router } from '../router'

packages/router/src/__tests__/setContextReuse.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { act, render, waitFor } from '@testing-library/react'
55
import { Route, Router, navigate } from '../'
66
import { Set } from '../Set'
77

8-
import '@testing-library/jest-dom/jest-globals'
8+
import '@testing-library/jest-dom/extend-expect'
99

1010
const HomePage = () => {
1111
return <p>Home Page</p>

packages/testing/jest.setup.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import '@testing-library/jest-dom/jest-globals'
1+
import '@testing-library/jest-dom/extend-expect'
22
import '@testing-library/jest-dom'
33

44
import { startMSW } from './src/web/mockRequests'

packages/testing/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"@redwoodjs/project-config": "6.0.7",
3535
"@redwoodjs/router": "6.0.7",
3636
"@redwoodjs/web": "6.0.7",
37-
"@testing-library/jest-dom": "6.1.5",
37+
"@testing-library/jest-dom": "5.17.0",
3838
"@testing-library/react": "14.1.2",
3939
"@testing-library/user-event": "14.5.1",
4040
"@types/aws-lambda": "8.10.126",

packages/web/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,11 @@
5252
"@apollo/experimental-nextjs-app-support": "0.5.1",
5353
"@babel/cli": "7.23.4",
5454
"@babel/core": "^7.22.20",
55-
"@testing-library/jest-dom": "6.1.5",
55+
"@testing-library/jest-dom": "5.17.0",
5656
"@testing-library/react": "14.1.2",
5757
"@types/react": "18.2.37",
5858
"@types/react-dom": "18.2.15",
59+
"@types/testing-library__jest-dom": "5.14.9",
5960
"jest": "29.7.0",
6061
"nodemon": "3.0.2",
6162
"react": "0.0.0-experimental-e5205658f-20230913",

packages/web/src/components/FetchConfigProvider.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import React from 'react'
77
import { render, screen, waitFor } from '@testing-library/react'
88

99
import type { AuthContextInterface } from '@redwoodjs/auth'
10-
import '@testing-library/jest-dom/jest-globals'
10+
import '@testing-library/jest-dom/extend-expect'
1111

1212
globalThis.RWJS_API_GRAPHQL_URL = 'https://api.example.com/graphql'
1313

packages/web/src/components/GraphQLHooksProvider.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*/
44

55
import { render, screen, waitFor } from '@testing-library/react'
6-
import '@testing-library/jest-dom/jest-globals'
6+
import '@testing-library/jest-dom/extend-expect'
77

88
import {
99
GraphQLHooksProvider,

packages/web/src/components/cell/createCell.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*/
44

55
import { render, screen } from '@testing-library/react'
6-
import '@testing-library/jest-dom/jest-globals'
6+
import '@testing-library/jest-dom/extend-expect'
77

88
import { GraphQLHooksProvider } from '../GraphQLHooksProvider'
99

packages/web/src/components/cell/createSuspendingCell.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import type { useReadQuery, useBackgroundQuery } from '@apollo/client'
55
import { loadErrorMessages, loadDevMessages } from '@apollo/client/dev'
66
import { render, screen } from '@testing-library/react'
7-
import '@testing-library/jest-dom/jest-globals'
7+
import '@testing-library/jest-dom/extend-expect'
88

99
import { GraphQLHooksProvider } from '../GraphQLHooksProvider'
1010

packages/web/src/components/portalHead.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react'
22

3-
import '@testing-library/jest-dom/jest-globals'
3+
import '@testing-library/jest-dom/extend-expect'
44
import { render } from '@testing-library/react'
55

66
import PortalHead from './PortalHead'

yarn.lock

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@ __metadata:
8686
languageName: node
8787
linkType: hard
8888

89-
"@adobe/css-tools@npm:^4.3.1":
90-
version: 4.3.2
91-
resolution: "@adobe/css-tools@npm:4.3.2"
92-
checksum: 296a03dd29f227c60500d2da8c7f64991fecf1d8b456ce2b4adb8cec7363d9c08b5b03f1463673fc8cbfe54b538745588e7a13c736d2dd14a80c01a20f127f39
89+
"@adobe/css-tools@npm:^4.0.1":
90+
version: 4.3.1
91+
resolution: "@adobe/css-tools@npm:4.3.1"
92+
checksum: 05672719b544cc0c21ae3ed0eb6349bf458e9d09457578eeeb07cf0f696469ac6417e9c9be1b129e5d6a18098a061c1db55b2275591760ef30a79822436fcbfa
9393
languageName: node
9494
linkType: hard
9595

@@ -8668,7 +8668,7 @@ __metadata:
86688668
"@babel/cli": 7.23.4
86698669
"@babel/core": ^7.22.20
86708670
"@babel/runtime-corejs3": 7.23.5
8671-
"@testing-library/jest-dom": 6.1.5
8671+
"@testing-library/jest-dom": 5.17.0
86728672
"@testing-library/react": 14.1.2
86738673
core-js: 3.34.0
86748674
jest: 29.7.0
@@ -9037,12 +9037,13 @@ __metadata:
90379037
"@babel/core": ^7.22.20
90389038
"@babel/runtime-corejs3": 7.23.5
90399039
"@testing-library/dom": 9.3.3
9040-
"@testing-library/jest-dom": 6.1.5
9040+
"@testing-library/jest-dom": 5.17.0
90419041
"@testing-library/react": 14.1.2
90429042
"@testing-library/user-event": 14.5.1
90439043
"@types/pascalcase": 1.0.3
90449044
"@types/react": 18.2.37
90459045
"@types/react-dom": 18.2.15
9046+
"@types/testing-library__jest-dom": 5.14.9
90469047
core-js: 3.34.0
90479048
graphql: 16.8.1
90489049
jest: 29.7.0
@@ -9509,7 +9510,7 @@ __metadata:
95099510
"@redwoodjs/project-config": 6.0.7
95109511
"@redwoodjs/router": 6.0.7
95119512
"@redwoodjs/web": 6.0.7
9512-
"@testing-library/jest-dom": 6.1.5
9513+
"@testing-library/jest-dom": 5.17.0
95139514
"@testing-library/react": 14.1.2
95149515
"@testing-library/user-event": 14.5.1
95159516
"@types/aws-lambda": 8.10.126
@@ -9618,10 +9619,11 @@ __metadata:
96189619
"@babel/core": ^7.22.20
96199620
"@babel/runtime-corejs3": 7.23.5
96209621
"@redwoodjs/auth": 6.0.7
9621-
"@testing-library/jest-dom": 6.1.5
9622+
"@testing-library/jest-dom": 5.17.0
96229623
"@testing-library/react": 14.1.2
96239624
"@types/react": 18.2.37
96249625
"@types/react-dom": 18.2.15
9626+
"@types/testing-library__jest-dom": 5.14.9
96259627
core-js: 3.34.0
96269628
graphql: 16.8.1
96279629
graphql-sse: 2.4.0
@@ -11170,33 +11172,20 @@ __metadata:
1117011172
languageName: node
1117111173
linkType: hard
1117211174

11173-
"@testing-library/jest-dom@npm:6.1.5":
11174-
version: 6.1.5
11175-
resolution: "@testing-library/jest-dom@npm:6.1.5"
11175+
"@testing-library/jest-dom@npm:5.17.0":
11176+
version: 5.17.0
11177+
resolution: "@testing-library/jest-dom@npm:5.17.0"
1117611178
dependencies:
11177-
"@adobe/css-tools": ^4.3.1
11179+
"@adobe/css-tools": ^4.0.1
1117811180
"@babel/runtime": ^7.9.2
11181+
"@types/testing-library__jest-dom": ^5.9.1
1117911182
aria-query: ^5.0.0
1118011183
chalk: ^3.0.0
1118111184
css.escape: ^1.5.1
1118211185
dom-accessibility-api: ^0.5.6
1118311186
lodash: ^4.17.15
1118411187
redent: ^3.0.0
11185-
peerDependencies:
11186-
"@jest/globals": ">= 28"
11187-
"@types/jest": ">= 28"
11188-
jest: ">= 28"
11189-
vitest: ">= 0.32"
11190-
peerDependenciesMeta:
11191-
"@jest/globals":
11192-
optional: true
11193-
"@types/jest":
11194-
optional: true
11195-
jest:
11196-
optional: true
11197-
vitest:
11198-
optional: true
11199-
checksum: f3643a56fcd970b5c7e8fd10faf3c4817d8ab0e74fb1198d726643bdc5ac675ceaac3b0068c5b4fbad254470e8f98ed50028741de875a29ceaa2f854570979c9
11188+
checksum: 24e09c5779ea44644945ec26f2e4e5f48aecfe57d469decf2317a3253a5db28d865c55ad0ea4818d8d1df7572a6486c45daa06fa09644a833a7dd84563881939
1120011189
languageName: node
1120111190
linkType: hard
1120211191

@@ -11981,6 +11970,16 @@ __metadata:
1198111970
languageName: node
1198211971
linkType: hard
1198311972

11973+
"@types/jest@npm:*":
11974+
version: 29.5.11
11975+
resolution: "@types/jest@npm:29.5.11"
11976+
dependencies:
11977+
expect: ^29.0.0
11978+
pretty-format: ^29.0.0
11979+
checksum: 524a3394845214581278bf4d75055927261fbeac7e1a89cd621bd0636da37d265fe0a85eac58b5778758faad1cbd7c7c361dfc190c78ebde03a91cce33463261
11980+
languageName: node
11981+
linkType: hard
11982+
1198411983
"@types/jest@npm:29.5.8":
1198511984
version: 29.5.8
1198611985
resolution: "@types/jest@npm:29.5.8"
@@ -12579,6 +12578,15 @@ __metadata:
1257912578
languageName: node
1258012579
linkType: hard
1258112580

12581+
"@types/testing-library__jest-dom@npm:5.14.9, @types/testing-library__jest-dom@npm:^5.9.1":
12582+
version: 5.14.9
12583+
resolution: "@types/testing-library__jest-dom@npm:5.14.9"
12584+
dependencies:
12585+
"@types/jest": "*"
12586+
checksum: 91f7b15e8813b515912c54da44464fb60ecf21162b7cae2272fcb3918074f4e1387dc2beca1f5041667e77b76b34253c39675ea4e0b3f28f102d8cc87fdba9fa
12587+
languageName: node
12588+
linkType: hard
12589+
1258212590
"@types/tough-cookie@npm:*":
1258312591
version: 4.0.2
1258412592
resolution: "@types/tough-cookie@npm:4.0.2"
@@ -31800,7 +31808,7 @@ __metadata:
3180031808
"@faker-js/faker": 8.0.2
3180131809
"@npmcli/arborist": 7.2.2
3180231810
"@playwright/test": 1.40.1
31803-
"@testing-library/jest-dom": 6.1.5
31811+
"@testing-library/jest-dom": 5.17.0
3180431812
"@testing-library/react": 14.1.2
3180531813
"@testing-library/user-event": 14.5.1
3180631814
"@types/babel__generator": 7.6.7

0 commit comments

Comments
 (0)