refactor: only add suppression in beforeEach block and move restoration to afterEach

Author: mpeyper

src/core/console.ts

@@ -1,24 +1,27 @@
 import filterConsole from 'filter-console'
 
 function enableErrorOutputSuppression() {
-  if (!process.env.RHTL_DISABLE_ERROR_FILTERING) {
-    const restoreConsole = filterConsole(
-      [
-        /^The above error occurred in the <TestComponent> component:/, // error boundary output
-        /^Error: Uncaught .+/ // jsdom output
-      ],
-      {
-        methods: ['error']
-      }
-    )
+  // Automatically registers console error suppression and restoration in supported testing frameworks
+  if (
+    typeof beforeEach === 'function' &&
+    typeof afterEach === 'function' &&
+    !process.env.RHTL_DISABLE_ERROR_FILTERING
+  ) {
+    let restoreConsole: (() => void) | null = null
 
-    // Automatically registers restoration in supported testing frameworks
-    if (typeof afterAll === 'function') {
-      afterAll(async () => {
-        await new Promise((resolve) => setTimeout(resolve, 100))
-        restoreConsole()
-      })
-    }
+    beforeEach(() => {
+      restoreConsole = filterConsole(
+        [
+          /^The above error occurred in the <TestComponent> component:/, // error boundary output
+          /^Error: Uncaught .+/ // jsdom output
+        ],
+        {
+          methods: ['error']
+        }
+      )
+    })
+
+    afterEach(() => restoreConsole?.())
   }
 }
 

src/dom/__tests__/autoCleanup.disabled.test.ts

@@ -10,7 +10,6 @@ describe('skip auto cleanup (disabled) tests', () => {
 
   beforeAll(() => {
     process.env.RHTL_SKIP_AUTO_CLEANUP = 'true'
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     renderHook = (require('..') as ReactHooksRenderer).renderHook
   })
 

src/dom/__tests__/autoCleanup.noAfterEach.test.ts

@@ -2,17 +2,15 @@ import { useEffect } from 'react'
 
 import { ReactHooksRenderer } from '../../types/react'
 
-// This verifies that if RHTL_SKIP_AUTO_CLEANUP is set
+// This verifies that if afterEach is unavailable
 // then we DON'T auto-wire up the afterEach for folks
 describe('skip auto cleanup (no afterEach) tests', () => {
   let cleanupCalled = false
   let renderHook: (arg0: () => void) => void
 
   beforeAll(() => {
     // @ts-expect-error Turning off AfterEach -- ignore Jest LifeCycle Type
-    // eslint-disable-next-line no-global-assign
     afterEach = false
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     renderHook = (require('..') as ReactHooksRenderer).renderHook
   })
 

src/dom/__tests__/errorSuppression.disabled.test.ts

@@ -1,3 +1,5 @@
+// This verifies that if RHTL_DISABLE_ERROR_FILTERING is set
+// then we DON'T auto-wire up the afterEach for folks
 describe('error output suppression (disabled) tests', () => {
   const originalConsoleError = console.error
 

src/dom/__tests__/errorSuppression.noAfterAll.test.ts

@@ -0,0 +1,19 @@
+// This verifies that if afterEach is unavailable
+// then we DON'T auto-wire up the afterEach for folks
+describe('error output suppression (noAfterEach) tests', () => {
+  const originalConsoleError = console.error
+
+  beforeAll(() => {
+    // @ts-expect-error Turning off AfterEach -- ignore Jest LifeCycle Type
+    afterEach = false
+  })
+
+  describe('first', () => {
+    test('should not patch console.error', () => {
+      require('..')
+      expect(console.error).toBe(originalConsoleError)
+    })
+  })
+})
+
+export {}

src/dom/__tests__/errorSuppression.noAfterEach.test.ts

@@ -0,0 +1,19 @@
+// This verifies that if afterEach is unavailable
+// then we DON'T auto-wire up the afterEach for folks
+describe('error output suppression (noBeforeEach) tests', () => {
+  const originalConsoleError = console.error
+
+  beforeAll(() => {
+    // @ts-expect-error Turning off BeforeEach -- ignore Jest LifeCycle Type
+    beforeEach = false
+  })
+
+  describe('first', () => {
+    test('should not patch console.error', () => {
+      require('..')
+      expect(console.error).toBe(originalConsoleError)
+    })
+  })
+})
+
+export {}

src/dom/__tests__/errorSuppression.noBeforeEach.test.ts

@@ -10,7 +10,6 @@ describe('skip auto cleanup (disabled) tests', () => {
 
   beforeAll(() => {
     process.env.RHTL_SKIP_AUTO_CLEANUP = 'true'
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     renderHook = (require('..') as ReactHooksRenderer).renderHook
   })
 

src/native/__tests__/autoCleanup.disabled.test.ts

@@ -2,17 +2,15 @@ import { useEffect } from 'react'
 
 import { ReactHooksRenderer } from '../../types/react'
 
-// This verifies that if RHTL_SKIP_AUTO_CLEANUP is set
+// This verifies that if afterEach is unavailable
 // then we DON'T auto-wire up the afterEach for folks
 describe('skip auto cleanup (no afterEach) tests', () => {
   let cleanupCalled = false
   let renderHook: (arg0: () => void) => void
 
   beforeAll(() => {
     // @ts-expect-error Turning off AfterEach -- ignore Jest LifeCycle Type
-    // eslint-disable-next-line no-global-assign
     afterEach = false
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     renderHook = (require('..') as ReactHooksRenderer).renderHook
   })
 

src/native/__tests__/autoCleanup.noAfterEach.test.ts

@@ -1,3 +1,5 @@
+// This verifies that if RHTL_DISABLE_ERROR_FILTERING is set
+// then we DON'T auto-wire up the afterEach for folks
 describe('error output suppression (disabled) tests', () => {
   const originalConsoleError = console.error
 

src/native/__tests__/errorSuppression.disabled.test.ts

@@ -0,0 +1,19 @@
+// This verifies that if afterEach is unavailable
+// then we DON'T auto-wire up the afterEach for folks
+describe('error output suppression (noAfterEach) tests', () => {
+  const originalConsoleError = console.error
+
+  beforeAll(() => {
+    // @ts-expect-error Turning off AfterEach -- ignore Jest LifeCycle Type
+    afterEach = false
+  })
+
+  describe('first', () => {
+    test('should not patch console.error', () => {
+      require('..')
+      expect(console.error).toBe(originalConsoleError)
+    })
+  })
+})
+
+export {}

src/native/__tests__/errorSuppression.noAfterAll.test.ts

@@ -0,0 +1,19 @@
+// This verifies that if afterEach is unavailable
+// then we DON'T auto-wire up the afterEach for folks
+describe('error output suppression (noBeforeEach) tests', () => {
+  const originalConsoleError = console.error
+
+  beforeAll(() => {
+    // @ts-expect-error Turning off BeforeEach -- ignore Jest LifeCycle Type
+    beforeEach = false
+  })
+
+  describe('first', () => {
+    test('should not patch console.error', () => {
+      require('..')
+      expect(console.error).toBe(originalConsoleError)
+    })
+  })
+})
+
+export {}

src/native/__tests__/errorSuppression.noAfterEach.test.ts

@@ -10,7 +10,6 @@ describe('skip auto cleanup (disabled) tests', () => {
 
   beforeAll(() => {
     process.env.RHTL_SKIP_AUTO_CLEANUP = 'true'
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     renderHook = (require('..') as ReactHooksRenderer).renderHook
   })
 

src/native/__tests__/errorSuppression.noBeforeEach.test.ts

@@ -2,17 +2,15 @@ import { useEffect } from 'react'
 
 import { ReactHooksRenderer } from '../../types/react'
 
-// This verifies that if RHTL_SKIP_AUTO_CLEANUP is set
+// This verifies that if afterEach is unavailable
 // then we DON'T auto-wire up the afterEach for folks
 describe('skip auto cleanup (no afterEach) tests', () => {
   let cleanupCalled = false
   let renderHook: (arg0: () => void) => void
 
   beforeAll(() => {
     // @ts-expect-error Turning off AfterEach -- ignore Jest LifeCycle Type
-    // eslint-disable-next-line no-global-assign
     afterEach = false
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     renderHook = (require('..') as ReactHooksRenderer).renderHook
   })
 

src/server/__tests__/autoCleanup.disabled.test.ts

@@ -1,3 +1,5 @@
+// This verifies that if RHTL_DISABLE_ERROR_FILTERING is set
+// then we DON'T auto-wire up the afterEach for folks
 describe('error output suppression (disabled) tests', () => {
   const originalConsoleError = console.error
 

src/server/__tests__/autoCleanup.noAfterEach.test.ts

@@ -0,0 +1,19 @@
+// This verifies that if afterEach is unavailable
+// then we DON'T auto-wire up the afterEach for folks
+describe('error output suppression (noAfterEach) tests', () => {
+  const originalConsoleError = console.error
+
+  beforeAll(() => {
+    // @ts-expect-error Turning off AfterEach -- ignore Jest LifeCycle Type
+    afterEach = false
+  })
+
+  describe('first', () => {
+    test('should not patch console.error', () => {
+      require('..')
+      expect(console.error).toBe(originalConsoleError)
+    })
+  })
+})
+
+export {}

src/server/__tests__/errorSuppression.disabled.test.ts

@@ -0,0 +1,19 @@
+// This verifies that if afterEach is unavailable
+// then we DON'T auto-wire up the afterEach for folks
+describe('error output suppression (noBeforeEach) tests', () => {
+  const originalConsoleError = console.error
+
+  beforeAll(() => {
+    // @ts-expect-error Turning off BeforeEach -- ignore Jest LifeCycle Type
+    beforeEach = false
+  })
+
+  describe('first', () => {
+    test('should not patch console.error', () => {
+      require('..')
+      expect(console.error).toBe(originalConsoleError)
+    })
+  })
+})
+
+export {}