feat(core): developers can suppress ionic warnings and errors

Author: sean-perkins

core/src/utils/config.ts

@@ -220,6 +220,16 @@ export interface IonicConfig {
    */
   experimentalCloseWatcher?: boolean;
 
+  /**
+   * Developers may configure the logging level for Ionic Framework.
+   * This will log all logs at the specified level and above.
+   *
+   * - `OFF` will not log any logs.
+   * - `ERROR` will log all errors.
+   * - `WARN` will log all errors and warnings.
+   */
+  logLevel?: 'OFF' | 'ERROR' | 'WARN';
+
   // PRIVATE configs
   keyboardHeight?: number;
   inputShims?: boolean;

core/src/utils/logging/index.ts

@@ -1,11 +1,16 @@
+import { config } from '@global/config';
+
 /**
  * Logs a warning to the console with an Ionic prefix
  * to indicate the library that is warning the developer.
  *
  * @param message - The string message to be logged to the console.
  */
 export const printIonWarning = (message: string, ...params: any[]) => {
-  return console.warn(`[Ionic Warning]: ${message}`, ...params);
+  const logLevel = config.get('logLevel', 'WARN');
+  if (logLevel === 'WARN' || logLevel === 'ERROR') {
+    return console.warn(`[Ionic Warn]: ${message}`, ...params);
+  }
 };
 
 /*
@@ -16,7 +21,10 @@ export const printIonWarning = (message: string, ...params: any[]) => {
  * @param params - Additional arguments to supply to the console.error.
  */
 export const printIonError = (message: string, ...params: any) => {
-  return console.error(`[Ionic Error]: ${message}`, ...params);
+  const logLevel = config.get('logLevel', 'ERROR');
+  if (logLevel === 'ERROR') {
+    return console.error(`[Ionic Error]: ${message}`, ...params);
+  }
 };
 
 /**

core/src/utils/logging/test/logging.spec.ts

@@ -0,0 +1,113 @@
+import { config } from '@global/config';
+
+import { printIonError, printIonWarning } from '../index';
+
+describe('Logging', () => {
+  describe('#printIonWarning', () => {
+    let consoleWarnSpy: jest.SpyInstance;
+
+    beforeEach(() => {
+      consoleWarnSpy = jest.spyOn(console, 'warn');
+      // Suppress console.warn output from polluting the test output
+      consoleWarnSpy.mockImplementation(() => {});
+    });
+
+    afterEach(() => {
+      consoleWarnSpy.mockRestore();
+    });
+
+    describe('when the logLevel configuration is not set', () => {
+      it('logs a warning to the console', () => {
+        config.set('logLevel', undefined);
+
+        printIonWarning('This is a warning message');
+
+        expect(consoleWarnSpy).toHaveBeenCalledWith('[Ionic Warn]: This is a warning message');
+      });
+    });
+
+    describe("when the logLevel configuration is set to 'ERROR'", () => {
+      it('logs a warning to the console', () => {
+        config.set('logLevel', 'ERROR');
+
+        printIonWarning('This is a warning message');
+
+        expect(consoleWarnSpy).toHaveBeenCalledWith('[Ionic Warn]: This is a warning message');
+      });
+    });
+
+    describe("when the logLevel configuration is set to 'WARN'", () => {
+      it('logs a warning to the console', () => {
+        config.set('logLevel', 'WARN');
+
+        printIonWarning('This is a warning message');
+
+        expect(consoleWarnSpy).toHaveBeenCalledWith('[Ionic Warn]: This is a warning message');
+      });
+    });
+
+    describe("when the logLevel configuration is set to 'OFF'", () => {
+      it('does not log a warning to the console', () => {
+        config.set('logLevel', 'OFF');
+
+        printIonWarning('This is a warning message');
+
+        expect(consoleWarnSpy).not.toHaveBeenCalled();
+      });
+    });
+  });
+
+  describe('#printIonError', () => {
+    let consoleErrorSpy: jest.SpyInstance;
+
+    beforeEach(() => {
+      consoleErrorSpy = jest.spyOn(console, 'error');
+      // Suppress console.error output from polluting the test output
+      consoleErrorSpy.mockImplementation(() => {});
+    });
+
+    afterEach(() => {
+      consoleErrorSpy.mockRestore();
+    });
+
+    describe('when the logLevel configuration is not set', () => {
+      it('logs an error to the console', () => {
+        config.set('logLevel', undefined);
+
+        printIonError('This is an error message');
+
+        expect(consoleErrorSpy).toHaveBeenCalledWith('[Ionic Error]: This is an error message');
+      });
+    });
+
+    describe("when the logLevel configuration is set to 'ERROR'", () => {
+      it('logs an error to the console', () => {
+        config.set('logLevel', 'ERROR');
+
+        printIonError('This is an error message');
+
+        expect(consoleErrorSpy).toHaveBeenCalledWith('[Ionic Error]: This is an error message');
+      });
+    });
+
+    describe("when the logLevel configuration is set to 'WARN'", () => {
+      it('does not log an error to the console', () => {
+        config.set('logLevel', 'WARN');
+
+        printIonError('This is an error message');
+
+        expect(consoleErrorSpy).not.toHaveBeenCalled();
+      });
+    });
+
+    describe("when the logLevel configuration is set to 'OFF'", () => {
+      it('does not log an error to the console', () => {
+        config.set('logLevel', 'OFF');
+
+        printIonError('This is an error message');
+
+        expect(consoleErrorSpy).not.toHaveBeenCalled();
+      });
+    });
+  });
+});