Remove `console-testing-library` #4603

aryaemami59 · 2024-09-04T02:13:42Z

This PR:

Removes console-testing-library (part of Centralize tooling configs in monorepo #4138).
Removes jest-snapshot from resolutions field of root package.json.

codesandbox · 2024-09-04T02:13:45Z

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

codesandbox-ci · 2024-09-04T02:16:00Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit f96ba63:

Sandbox	Source
@examples-query-react/basic	Configuration
@examples-query-react/advanced	Configuration
@examples-action-listener/counter	Configuration
rtk-esm-cra	Configuration

netlify · 2024-09-04T02:18:50Z

✅ Deploy Preview for redux-starter-kit-docs ready!

Name	Link
🔨 Latest commit	`9a8f521`
🔍 Latest deploy log	https://app.netlify.com/sites/redux-starter-kit-docs/deploys/66d7c2599451250008dd3ae4
😎 Deploy Preview	https://deploy-preview-4603--redux-starter-kit-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

netlify · 2024-09-04T02:23:47Z

✅ Deploy Preview for redux-starter-kit-docs ready!

Name	Link
🔨 Latest commit	`4beb3f6`
🔍 Latest deploy log	https://app.netlify.com/sites/redux-starter-kit-docs/deploys/66d7c36b86ba26000842448c
😎 Deploy Preview	https://deploy-preview-4603--redux-starter-kit-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

netlify · 2024-09-04T02:25:49Z

✅ Deploy Preview for redux-starter-kit-docs ready!

Name	Link
🔨 Latest commit	`a083371`
🔍 Latest deploy log	https://app.netlify.com/sites/redux-starter-kit-docs/deploys/66d7c3c2f1744800087cd52c
😎 Deploy Preview	https://deploy-preview-4603--redux-starter-kit-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

netlify · 2024-09-04T02:27:44Z

✅ Deploy Preview for redux-starter-kit-docs ready!

Name	Link
🔨 Latest commit	`f96ba63`
🔍 Latest deploy log	https://app.netlify.com/sites/redux-starter-kit-docs/deploys/6732919e915248000826066f
😎 Deploy Preview	https://deploy-preview-4603--redux-starter-kit-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

EskiMojo14 · 2024-09-13T10:27:36Z

hmm, what's the benefit of switching away from console-testing-library?

phryneas · 2024-09-13T19:15:07Z

It seemed to be a good idea back then but I think at this point it's more tech debt. I do have a request here though, will add something.

phryneas · 2024-09-13T19:17:52Z

packages/toolkit/src/listenerMiddleware/tests/effectScenarios.test.ts

-    const noop = () => {}
-    vi.spyOn(console, 'error').mockImplementation(noop)
-  })
+  const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(noop)


I just wanted to suggest that we do

Suggested change

const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(noop)

using consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(noop)

inside the tests that actually need this, and skip the mockClear and mockRestore calls, but I'm not sure if vitest actually returns a Disposable here. I know jest does (because I added the functionality there) - could you check if vitest has that now, too?

Sure I can try it. The type tests will probably fail, so I'll probably exclude the runtime tests from the type tests.

Looks like vitest doesn't return a Disposable, though I might try to submit a PR to add that functionality for vitest.

Will definitely be a win in the long run, even if it's not applicable to this PR in the end :)

aryaemami59 · 2024-09-13T22:54:04Z

@EskiMojo14 There is multiple reasons:

like @phryneas mentioned, it's tech debt.
The inline snapshots caused some issues with Prettier and ESLint in Centralize tooling configs in monorepo #4138.
It caused some issues in Migrate to React 19 #4409 with React 19.
It's also somewhat of an old library that hasn't been maintained in years which is why we had to patch it several times.
We also had to override the version of jest-snapshot in the root package.json because of it which in turn causes the tests for all the example apps to fail locally.
We can also replace what it does by spying on the console object itself easily.

…iddleware.test.ts`

…leware.test.ts`

- `.mockReset()` should not be called in spies since it calls `.mockClear()` and returns the implementation to its **initial** form. In this case it was silencing some of the `act` related warnings emitted by `@testing-library/react` which needed to be resolved since they were calling issues. So `.mockReset()` calls on spies need to be changed to `.mockRestore()` calls since `.mockRestore()` restores the implementation to its **original** form.

aryaemami59 force-pushed the remove-console-testing-library branch from e787d07 to 4a5972b Compare September 4, 2024 02:28

aryaemami59 force-pushed the remove-console-testing-library branch 2 times, most recently from 8a2b7fd to e65a623 Compare September 12, 2024 09:39

phryneas reviewed Sep 13, 2024

View reviewed changes

aryaemami59 force-pushed the remove-console-testing-library branch from e65a623 to 9d1ebb7 Compare September 13, 2024 22:56

aryaemami59 force-pushed the remove-console-testing-library branch 3 times, most recently from 10738c3 to bdf6dcc Compare September 24, 2024 12:54

aryaemami59 force-pushed the remove-console-testing-library branch 4 times, most recently from 6e6368f to c23567d Compare October 14, 2024 22:57

aryaemami59 force-pushed the remove-console-testing-library branch 2 times, most recently from 72056e5 to 967bc39 Compare October 22, 2024 04:11

aryaemami59 force-pushed the remove-console-testing-library branch from 967bc39 to 34f4e24 Compare October 26, 2024 17:10

aryaemami59 mentioned this pull request Nov 2, 2024

Update @testing-library/react from 13.3.0 to 16.0.1; Fixes #4685 #4686

Open

aryaemami59 force-pushed the remove-console-testing-library branch from 34f4e24 to 5ceef38 Compare November 6, 2024 15:50

aryaemami59 added 4 commits November 11, 2024 17:16

Fix console spy related issues in devWarnings.test.tsx

e034d5b

Fix console spy related issues in createApi.test.ts

858047d

Fix console spy related issues in injectEndpoints.test.tsx

db2380a

Fix issues related to console spies in createSlice.test.ts

bfaa88d

aryaemami59 added 17 commits November 11, 2024 17:16

Fix issues related to console spies in `serializableStateInvariantM…

df18c84

…iddleware.test.ts`

Fix issues related to console spies in `immutableStateInvariantMidd…

dd325c6

…leware.test.ts`

Fix console spy related issues in fakeBaseQuery.test.tsx

c14f407

Fix issues related to console spies in createAsyncThunk.test.ts

fe04ad6

Fix issues related to console spies in createReducer.test.ts

6729bda

Fix console spy related issues in queryFn.test.tsx

3818755

Remove vi.resetAllMocks() call from utils.spec.ts

90c2d01

Fix console spy related issues in effectScenarios.test.ts

15a0718

Fix console spy related issues in listenerMiddleware.test.ts

ef44b7f

Fix issues related to spies and stubbing environments in utils.spec.ts

36e5e74

Fix issues related to stubbing envs in createReducer.test.ts

ff7a3b9

Fix issues related to stubbing envs in createSlice.test.ts

2a738d9

Fix issues related to stubbing envs in createAsyncThunk.test.ts

0ad3729

Fix issues related to stubbing envs in getDefaultMiddleware.test.ts

e773192

Remove satisfies operators in queryFn.test.tsx

da9ae2f

Remove console-testing-library as it is no longer needed

bd04abd

aryaemami59 force-pushed the remove-console-testing-library branch from 5ceef38 to fede3e6 Compare November 11, 2024 23:16

Remove jest-snapshot from resolutions field of root package.json

f96ba63

aryaemami59 force-pushed the remove-console-testing-library branch from fede3e6 to f96ba63 Compare November 11, 2024 23:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove `console-testing-library` #4603

Remove `console-testing-library` #4603

aryaemami59 commented Sep 4, 2024

codesandbox bot commented Sep 4, 2024

codesandbox-ci bot commented Sep 4, 2024 •

edited

Loading

netlify bot commented Sep 4, 2024

netlify bot commented Sep 4, 2024

netlify bot commented Sep 4, 2024

netlify bot commented Sep 4, 2024 •

edited

Loading

EskiMojo14 commented Sep 13, 2024

phryneas commented Sep 13, 2024

phryneas Sep 13, 2024

aryaemami59 Sep 13, 2024

aryaemami59 Sep 13, 2024

phryneas Sep 14, 2024

aryaemami59 commented Sep 13, 2024

	const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(noop)
	using consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(noop)

Remove console-testing-library #4603

Are you sure you want to change the base?

Remove console-testing-library #4603

Conversation

aryaemami59 commented Sep 4, 2024

This PR:

codesandbox bot commented Sep 4, 2024

Review or Edit in CodeSandbox

codesandbox-ci bot commented Sep 4, 2024 • edited Loading

netlify bot commented Sep 4, 2024

✅ Deploy Preview for redux-starter-kit-docs ready!

netlify bot commented Sep 4, 2024

✅ Deploy Preview for redux-starter-kit-docs ready!

netlify bot commented Sep 4, 2024

✅ Deploy Preview for redux-starter-kit-docs ready!

netlify bot commented Sep 4, 2024 • edited Loading

✅ Deploy Preview for redux-starter-kit-docs ready!

EskiMojo14 commented Sep 13, 2024

phryneas commented Sep 13, 2024

phryneas Sep 13, 2024

Choose a reason for hiding this comment

aryaemami59 Sep 13, 2024

Choose a reason for hiding this comment

aryaemami59 Sep 13, 2024

Choose a reason for hiding this comment

phryneas Sep 14, 2024

Choose a reason for hiding this comment

aryaemami59 commented Sep 13, 2024

Remove `console-testing-library` #4603

Remove `console-testing-library` #4603

codesandbox-ci bot commented Sep 4, 2024 •

edited

Loading

netlify bot commented Sep 4, 2024 •

edited

Loading