Move custom matchers into vitest.setup.ts

  - This was done so that we won't have to import `helpers.tsx` anywhere we use `toHaveConsoleOutput`

Author: aryaemami59

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

@@ -1,6 +1,5 @@
 import { configureStore } from '@reduxjs/toolkit'
 import { createApi, fakeBaseQuery } from '@reduxjs/toolkit/query'
-import '../../tests/utils/helpers'
 
 type CustomErrorType = { type: 'Custom' }
 

packages/toolkit/src/tests/utils/helpers.tsx

@@ -8,11 +8,6 @@ import type {
 import { configureStore } from '@reduxjs/toolkit'
 import { setupListeners } from '@reduxjs/toolkit/query'
 import { act, cleanup } from '@testing-library/react'
-import {
-  createConsole,
-  getLog,
-  mockConsole,
-} from 'console-testing-library/pure'
 import { useCallback, useEffect, useRef } from 'react'
 import { Provider } from 'react-redux'
 import type { AnyObject } from '../../tsHelpers'
@@ -97,80 +92,13 @@ export const useRenderCounter = () => {
   return useCallback(() => countRef.current, [])
 }
 
-expect.extend({
-  toMatchSequence(
-    _actions: UnknownAction[],
-    ...matchers: Array<(arg: any) => boolean>
-  ) {
-    const actions = _actions.concat()
-    actions.shift() // remove INIT
-
-    for (let i = 0; i < matchers.length; i++) {
-      if (!matchers[i](actions[i])) {
-        return {
-          message: () =>
-            `Action ${actions[i].type} does not match sequence at position ${i}.
-All actions:
-${actions.map((a) => a.type).join('\n')}`,
-          pass: false,
-        }
-      }
-    }
-    return {
-      message: () => `All actions match the sequence.`,
-      pass: true,
-    }
-  },
-})
-
-declare global {
-  namespace jest {
-    interface Matchers<R> {
-      toHaveConsoleOutput(expectedOutput: string): Promise<R>
-    }
-  }
-}
-
-function normalize(str: string) {
+export function normalize(str: string) {
   return str
     .normalize()
     .replace(/\s*\r?\n\r?\s*/g, '')
     .trim()
 }
 
-expect.extend({
-  async toHaveConsoleOutput(
-    fn: () => void | Promise<void>,
-    expectedOutput: string,
-  ) {
-    const restore = mockConsole(createConsole())
-    await fn()
-    const { log } = getLog()
-    restore()
-
-    if (normalize(log) === normalize(expectedOutput))
-      return {
-        message: () => `Console output matches
-===
-${expectedOutput}
-===`,
-        pass: true,
-      }
-    else
-      return {
-        message: () => `Console output
-===
-${log}
-===
-does not match
-===
-${expectedOutput}
-===`,
-        pass: false,
-      }
-  },
-})
-
 export const actionsReducer = {
   actions: (state: UnknownAction[] = [], action: UnknownAction) => {
     // As of 2.0-beta.4, we are going to ignore all `subscriptionsUpdated` actions in tests

packages/toolkit/vitest.setup.ts

@@ -1,5 +1,12 @@
+import type { UnknownAction } from '@reduxjs/toolkit'
+import {
+  createConsole,
+  getLog,
+  mockConsole,
+} from 'console-testing-library/pure'
 import nodeFetch, { Headers, Request } from 'node-fetch'
 import { server } from './src/query/tests/mocks/server'
+import { normalize } from './src/tests/utils/helpers'
 
 vi.stubGlobal('fetch', nodeFetch)
 vi.stubGlobal('Request', Request)
@@ -16,3 +23,69 @@ afterEach(() => {
 afterAll(() => {
   server.close()
 })
+
+declare global {
+  namespace jest {
+    interface Matchers<R> {
+      toHaveConsoleOutput(expectedOutput: string): Promise<R>
+      toMatchSequence(...matchers: Array<(arg: any) => boolean>): R
+    }
+  }
+}
+
+expect.extend({
+  async toHaveConsoleOutput(
+    fn: () => void | Promise<void>,
+    expectedOutput: string,
+  ) {
+    const restore = mockConsole(createConsole())
+    await fn()
+    const { log } = getLog()
+    restore()
+
+    if (normalize(log) === normalize(expectedOutput))
+      return {
+        message: () => `Console output matches
+===
+${expectedOutput}
+===`,
+        pass: true,
+      }
+    else
+      return {
+        message: () => `Console output
+===
+${log}
+===
+does not match
+===
+${expectedOutput}
+===`,
+        pass: false,
+      }
+  },
+
+  toMatchSequence(
+    _actions: UnknownAction[],
+    ...matchers: Array<(arg: any) => boolean>
+  ) {
+    const actions = _actions.concat()
+    actions.shift() // remove INIT
+
+    for (let i = 0; i < matchers.length; i++) {
+      if (!matchers[i](actions[i])) {
+        return {
+          message: () =>
+            `Action ${actions[i].type} does not match sequence at position ${i}.
+All actions:
+${actions.map((a) => a.type).join('\n')}`,
+          pass: false,
+        }
+      }
+    }
+    return {
+      message: () => `All actions match the sequence.`,
+      pass: true,
+    }
+  },
+})