Fix console spy related issues in devWarnings.test.tsx

Author: aryaemami59

packages/toolkit/src/query/tests/devWarnings.test.tsx

@@ -1,24 +1,9 @@
+import { noop } from '@internal/listenerMiddleware/utils'
 import { configureStore } from '@reduxjs/toolkit'
-import {
-  mockConsole,
-  createConsole,
-  getLog,
-} from 'console-testing-library/pure'
 import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query'
 
-let restore: () => void = () => {}
-let nodeEnv: string
-
-beforeEach(() => {
-  restore = mockConsole(createConsole())
-  nodeEnv = process.env.NODE_ENV!
-  ;(process.env as any).NODE_ENV = 'development'
-})
-
-afterEach(() => {
-  ;(process.env as any).NODE_ENV = nodeEnv
-  restore()
-})
+const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(noop)
+const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(noop)
 
 const baseUrl = 'https://example.com'
 
@@ -49,9 +34,21 @@ function createApis() {
 
 let [api1, api1_2, api2] = createApis()
 beforeEach(() => {
+  vi.stubEnv('NODE_ENV', 'development')
   ;[api1, api1_2, api2] = createApis()
 })
 
+afterEach(() => {
+  consoleWarnSpy.mockClear()
+  consoleErrorSpy.mockClear()
+})
+
+afterAll(() => {
+  consoleWarnSpy.mockRestore()
+  consoleErrorSpy.mockRestore()
+  vi.unstubAllEnvs()
+})
+
 const reMatchMissingMiddlewareError =
   /Warning: Middleware for RTK-Query API at reducerPath "api" has not been added to the store/
 
@@ -60,6 +57,10 @@ describe('missing middleware', () => {
     ['development', true],
     ['production', false],
   ])('%s warns if middleware is missing: %s', (env, shouldWarn) => {
+    vi.stubEnv('NODE_ENV', env)
+
+    expect(process.env.NODE_ENV).toBe(env)
+
     const store = configureStore({
       reducer: { [api1.reducerPath]: api1.reducer },
     })
@@ -79,7 +80,10 @@ describe('missing middleware', () => {
       middleware: (gdm) => gdm().concat(api1.middleware),
     })
     store.dispatch(api1.endpoints.q1.initiate(undefined))
-    expect(getLog().log).toBe(``)
+
+    expect(consoleErrorSpy).not.toHaveBeenCalled()
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
   })
 
   test('warns only once per api', () => {
@@ -119,13 +123,21 @@ describe('missing reducer', () => {
     ['development', true],
     ['production', false],
   ])('%s warns if reducer is missing: %s', (env, shouldWarn) => {
+    beforeEach(() => {
+      vi.stubEnv('NODE_ENV', env)
+
+      return vi.unstubAllEnvs
+    })
+
     test('middleware not crashing if reducer is missing', async () => {
       const store = configureStore({
         reducer: { x: () => 0 },
         // @ts-expect-error
         middleware: (gdm) => gdm().concat(api1.middleware),
       })
       await store.dispatch(api1.endpoints.q1.initiate(undefined))
+
+      expect(process.env.NODE_ENV).toBe(env)
     })
 
     test(`warning behavior`, () => {
@@ -136,11 +148,21 @@ describe('missing reducer', () => {
       })
       // @ts-expect-error
       api1.endpoints.q1.select(undefined)(store.getState())
-      expect(getLog().log).toBe(
-        shouldWarn
-          ? 'Error: No data found at `state.api`. Did you forget to add the reducer to the store?'
-          : '',
-      )
+
+      expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+      expect(process.env.NODE_ENV).toBe(env)
+
+      if (shouldWarn) {
+        expect(consoleErrorSpy).toHaveBeenCalledOnce()
+
+        expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+          1,
+          'Error: No data found at `state.api`. Did you forget to add the reducer to the store?',
+        )
+      } else {
+        expect(consoleErrorSpy).not.toHaveBeenCalled()
+      }
     })
   })
 
@@ -150,7 +172,10 @@ describe('missing reducer', () => {
       middleware: (gdm) => gdm().concat(api1.middleware),
     })
     api1.endpoints.q1.select(undefined)(store.getState())
-    expect(getLog().log).toBe(``)
+
+    expect(consoleErrorSpy).not.toHaveBeenCalled()
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
   })
 
   test('warns only once per api', () => {
@@ -163,7 +188,13 @@ describe('missing reducer', () => {
     api1.endpoints.q1.select(undefined)(store.getState())
     // @ts-expect-error
     api1.endpoints.q1.select(undefined)(store.getState())
-    expect(getLog().log).toBe(
+
+    expect(consoleErrorSpy).toHaveBeenCalledOnce()
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+    expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+      1,
       'Error: No data found at `state.api`. Did you forget to add the reducer to the store?',
     )
   })
@@ -178,8 +209,19 @@ describe('missing reducer', () => {
     api1.endpoints.q1.select(undefined)(store.getState())
     // @ts-expect-error
     api2.endpoints.q1.select(undefined)(store.getState())
-    expect(getLog().log).toBe(
-      'Error: No data found at `state.api`. Did you forget to add the reducer to the store?\nError: No data found at `state.api2`. Did you forget to add the reducer to the store?',
+
+    expect(consoleErrorSpy).toHaveBeenCalledTimes(2)
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+    expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+      1,
+      'Error: No data found at `state.api`. Did you forget to add the reducer to the store?',
+    )
+
+    expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+      2,
+      'Error: No data found at `state.api2`. Did you forget to add the reducer to the store?',
     )
   })
 })
@@ -194,12 +236,24 @@ test('warns for reducer and also throws error if everything is missing', async (
     store.dispatch(api1.endpoints.q1.initiate(undefined))
   }
   expect(doDispatch).toThrowError(reMatchMissingMiddlewareError)
-  expect(getLog().log).toBe(
+
+  expect(consoleErrorSpy).toHaveBeenCalledOnce()
+
+  expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+  expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+    1,
     'Error: No data found at `state.api`. Did you forget to add the reducer to the store?',
   )
 })
 
 describe('warns on multiple apis using the same `reducerPath`', () => {
+  beforeEach(() => {
+    vi.stubEnv('NODE_ENV', 'development')
+
+    return vi.unstubAllEnvs
+  })
+
   test('common: two apis, same order', async () => {
     const store = configureStore({
       reducer: {
@@ -212,8 +266,14 @@ describe('warns on multiple apis using the same `reducerPath`', () => {
       middleware: (gDM) => gDM().concat(api1.middleware, api1_2.middleware),
     })
     await store.dispatch(api1.endpoints.q1.initiate(undefined))
+
+    expect(consoleErrorSpy).not.toHaveBeenCalled()
+
+    expect(consoleWarnSpy).toHaveBeenCalledOnce()
+
     // only second api prints
-    expect(getLog().log).toBe(
+    expect(consoleWarnSpy).toHaveBeenNthCalledWith(
+      1,
       `There is a mismatch between slice and middleware for the reducerPath "api".
 You can only have one api per reducer path, this will lead to crashes in various situations!
 If you have multiple apis, you *have* to specify the reducerPath option when using createApi!`,
@@ -231,13 +291,16 @@ If you have multiple apis, you *have* to specify the reducerPath option when usi
       middleware: (gDM) => gDM().concat(api1_2.middleware, api1.middleware),
     })
     await store.dispatch(api1.endpoints.q1.initiate(undefined))
+
+    expect(consoleErrorSpy).not.toHaveBeenCalled()
+
+    expect(consoleWarnSpy).toHaveBeenCalledTimes(2)
+
     // both apis print
-    expect(getLog().log).toBe(
+    expect(consoleWarnSpy).toHaveBeenNthCalledWith(
+      1,
       `There is a mismatch between slice and middleware for the reducerPath "api".
 You can only have one api per reducer path, this will lead to crashes in various situations!
-If you have multiple apis, you *have* to specify the reducerPath option when using createApi!
-There is a mismatch between slice and middleware for the reducerPath "api".
-You can only have one api per reducer path, this will lead to crashes in various situations!
 If you have multiple apis, you *have* to specify the reducerPath option when using createApi!`,
     )
   })
@@ -254,7 +317,14 @@ If you have multiple apis, you *have* to specify the reducerPath option when usi
     })
     await store.dispatch(api1.endpoints.q1.initiate(undefined))
 
-    expect(getLog().log).toBe(
+    expect(process.env.NODE_ENV).toBe('development')
+
+    expect(consoleErrorSpy).not.toHaveBeenCalled()
+
+    expect(consoleWarnSpy).toHaveBeenCalledOnce()
+
+    expect(consoleWarnSpy).toHaveBeenNthCalledWith(
+      1,
       `There is a mismatch between slice and middleware for the reducerPath "api".
 You can only have one api per reducer path, this will lead to crashes in various situations!
 If you have multiple apis, you *have* to specify the reducerPath option when using createApi!`,
@@ -280,7 +350,12 @@ If you have multiple apis, you *have* to specify the reducerPath option when usi
     })
     await store.dispatch(api1.endpoints.q1.initiate(undefined))
 
-    expect(getLog().log).toBe(
+    expect(consoleErrorSpy).not.toHaveBeenCalled()
+
+    expect(consoleWarnSpy).toHaveBeenCalledOnce()
+
+    expect(consoleWarnSpy).toHaveBeenNthCalledWith(
+      1,
       `There is a mismatch between slice and middleware for the reducerPath "api".
 You can only have one api per reducer path, this will lead to crashes in various situations!
 If you have multiple apis, you *have* to specify the reducerPath option when using createApi!`,
@@ -304,9 +379,16 @@ describe('`console.error` on unhandled errors during `initiate`', () => {
     })
     await store.dispatch(api.endpoints.baseQuery.initiate())
 
-    expect(getLog().log)
-      .toBe(`An unhandled error occurred processing a request for the endpoint "baseQuery".
-In the case of an unhandled error, no tags will be "provided" or "invalidated". [Error: this was kinda expected]`)
+    expect(consoleErrorSpy).toHaveBeenCalledOnce()
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+    expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+      1,
+      `An unhandled error occurred processing a request for the endpoint "baseQuery".
+In the case of an unhandled error, no tags will be "provided" or "invalidated".`,
+      Error('this was kinda expected'),
+    )
   })
 
   test('error thrown in `queryFn`', async () => {
@@ -328,9 +410,16 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".
     })
     await store.dispatch(api.endpoints.queryFn.initiate())
 
-    expect(getLog().log)
-      .toBe(`An unhandled error occurred processing a request for the endpoint "queryFn".
-In the case of an unhandled error, no tags will be "provided" or "invalidated". [Error: this was kinda expected]`)
+    expect(consoleErrorSpy).toHaveBeenCalledOnce()
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+    expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+      1,
+      `An unhandled error occurred processing a request for the endpoint "queryFn".
+In the case of an unhandled error, no tags will be "provided" or "invalidated".`,
+      Error('this was kinda expected'),
+    )
   })
 
   test('error thrown in `transformResponse`', async () => {
@@ -353,9 +442,16 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".
     })
     await store.dispatch(api.endpoints.transformRspn.initiate())
 
-    expect(getLog().log)
-      .toBe(`An unhandled error occurred processing a request for the endpoint "transformRspn".
-In the case of an unhandled error, no tags will be "provided" or "invalidated". [Error: this was kinda expected]`)
+    expect(consoleErrorSpy).toHaveBeenCalledOnce()
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+    expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+      1,
+      `An unhandled error occurred processing a request for the endpoint "transformRspn".
+In the case of an unhandled error, no tags will be "provided" or "invalidated".`,
+      Error('this was kinda expected'),
+    )
   })
 
   test('error thrown in `transformErrorResponse`', async () => {
@@ -381,9 +477,16 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".
     })
     await store.dispatch(api.endpoints.transformErRspn.initiate())
 
-    expect(getLog().log)
-      .toBe(`An unhandled error occurred processing a request for the endpoint "transformErRspn".
-In the case of an unhandled error, no tags will be "provided" or "invalidated". [Error: this was kinda expected]`)
+    expect(consoleErrorSpy).toHaveBeenCalledOnce()
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+    expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+      1,
+      `An unhandled error occurred processing a request for the endpoint "transformErRspn".
+In the case of an unhandled error, no tags will be "provided" or "invalidated".`,
+      Error('this was kinda expected'),
+    )
   })
 
   test('`fetchBaseQuery`: error thrown in `prepareHeaders`', async () => {
@@ -408,9 +511,16 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".
     })
     await store.dispatch(api.endpoints.prep.initiate())
 
-    expect(getLog().log)
-      .toBe(`An unhandled error occurred processing a request for the endpoint "prep".
-In the case of an unhandled error, no tags will be "provided" or "invalidated". [Error: this was kinda expected]`)
+    expect(consoleErrorSpy).toHaveBeenCalledOnce()
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+    expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+      1,
+      `An unhandled error occurred processing a request for the endpoint "prep".
+In the case of an unhandled error, no tags will be "provided" or "invalidated".`,
+      Error('this was kinda expected'),
+    )
   })
 
   test('`fetchBaseQuery`: error thrown in `validateStatus`', async () => {
@@ -438,8 +548,15 @@ In the case of an unhandled error, no tags will be "provided" or "invalidated".
     })
     await store.dispatch(api.endpoints.val.initiate())
 
-    expect(getLog().log)
-      .toBe(`An unhandled error occurred processing a request for the endpoint "val".
-In the case of an unhandled error, no tags will be "provided" or "invalidated". [Error: this was kinda expected]`)
+    expect(consoleErrorSpy).toHaveBeenCalledOnce()
+
+    expect(consoleWarnSpy).not.toHaveBeenCalled()
+
+    expect(consoleErrorSpy).toHaveBeenNthCalledWith(
+      1,
+      `An unhandled error occurred processing a request for the endpoint "val".
+In the case of an unhandled error, no tags will be "provided" or "invalidated".`,
+      Error('this was kinda expected'),
+    )
   })
 })