test: hideConsoleMessages

HCRC-178

Author: nikomakela

jest-setup.ts

@@ -2,60 +2,14 @@ import '@testing-library/jest-dom';
 import { toHaveNoViolations } from 'jest-axe';
 import fetchMock from 'jest-fetch-mock';
 import { loadErrorMessages, loadDevMessages } from '@apollo/client/dev';
-
-function ignoreConsoleWarnings() {
-  // Store the original console.warn
-  const originalWarn = console.warn;
-
-  // A list of warning messages to completely ignore
-  const warningsToIgnore = [
-    '[%s]: `%s` is deprecated and will be removed in Apollo Client 4.0. %s cache.diff canonizeResults Please remove this option.',
-  ];
-
-  // Override console.warn
-  console.warn = (...args) => {
-    // Check if the warning message includes any of our ignored strings
-    const shouldIgnore = warningsToIgnore.some((ignoredMsg) =>
-      args.join(' ').includes(ignoredMsg),
-    );
-
-    // If it's one we want to ignore, do nothing (return early)
-    if (shouldIgnore) {
-      return;
-    }
-
-    // For all other warnings, call the original console.warn
-    originalWarn.apply(console, args);
-  };
-}
-
-function ignoreConsoleErrors() {
-  // Store the original console.error
-  const originalError = console.error;
-
-  // A list of error messages to completely ignore
-  const errorsToIgnore = [
-    'Error: Could not parse CSS stylesheet', // JSDOM cannot understand stylesheets generated by HDS-React.
-  ];
-
-  // Override console.warn
-  console.error = (...args) => {
-    // Check if the error message includes any of our ignored strings
-    const shouldIgnore = errorsToIgnore.some((ignoredMsg) =>
-      args.join(' ').includes(ignoredMsg),
-    );
-
-    // If it's one we want to ignore, do nothing (return early)
-    if (shouldIgnore) {
-      return;
-    }
-    // For all other warnings, call the original console.warn
-    originalError.apply(console, args);
-  };
-}
-
-ignoreConsoleWarnings();
-ignoreConsoleErrors();
+import { hideConsoleMessages } from './src/tests/hideConsoleMessages';
+
+hideConsoleMessages({
+  warn: [
+    /`canonizeResults` is deprecated and will be removed in Apollo Client 4.0. Please remove this option./,
+  ],
+  error: [/Could not parse CSS stylesheet/],
+});
 
 fetchMock.enableMocks();
 

src/tests/hideConsoleMessages.ts

@@ -0,0 +1,39 @@
+import util from 'node:util';
+
+export const consoleLevels = ['debug', 'info', 'log', 'warn', 'error'] as const;
+export type ConsoleLevel = (typeof consoleLevels)[number];
+
+/**
+ * Set up console method overrides to hide the given console messages.
+ * @param consoleMessagesToHide - An object mapping console levels to arrays of RegExp patterns or strings.
+ * Each pattern or strings represents a message to be hidden for that console level.
+ * If a string is given, any message that includes that string will be hidden.
+ * If a RegExp is given, any message that matches that RegExp will be hidden.
+ * If no patterns are provided for a level, no messages will be hidden for that level.
+ */
+export const hideConsoleMessages = (
+  consoleMessagesToHide: Partial<Record<ConsoleLevel, (RegExp | string)[]>>,
+) => {
+  // eslint-disable-next-line no-restricted-syntax
+  for (const consoleLevel of consoleLevels) {
+    const hidablePatterns = consoleMessagesToHide[consoleLevel];
+    if (hidablePatterns && hidablePatterns.length > 0) {
+      // eslint-disable-next-line no-console
+      const originalConsoleMethod = console[consoleLevel];
+      // eslint-disable-next-line no-console, func-names
+      console[consoleLevel] = function (msg, ...optionalParams) {
+        const formattedMsg = util.format(msg, ...optionalParams);
+        const shouldHide = hidablePatterns.some((pattern) =>
+          typeof pattern === 'string'
+            ? formattedMsg.includes(pattern)
+            : pattern.test(formattedMsg),
+        );
+        if (shouldHide) {
+          return;
+        }
+        // eslint-disable-next-line consistent-return
+        return originalConsoleMethod(msg, ...optionalParams);
+      };
+    }
+  }
+};