Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions core/src/utils/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,15 @@ export interface IonicConfig {
*/
experimentalCloseWatcher?: boolean;

/**
* Developers may configure the logging level for Ionic Framework.
*
* - `OFF` will not log any errors or warnings.
* - `WARN` will log all errors and warnings.
* - `ERROR` will log only errors.
*/
logLevel?: 'OFF' | 'ERROR' | 'WARN';

// PRIVATE configs
keyboardHeight?: number;
inputShims?: boolean;
Expand Down
14 changes: 11 additions & 3 deletions core/src/utils/logging/index.ts
Original file line number Diff line number Diff line change
@@ -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 (['WARN'].includes(logLevel)) {
return console.warn(`[Ionic Warn]: ${message}`, ...params);
sean-perkins marked this conversation as resolved.
Show resolved Hide resolved
}
};

/*
Expand All @@ -15,8 +20,11 @@ export const printIonWarning = (message: string, ...params: any[]) => {
* @param message - The string message to be logged to the console.
* @param params - Additional arguments to supply to the console.error.
*/
export const printIonError = (message: string, ...params: any) => {
return console.error(`[Ionic Error]: ${message}`, ...params);
export const printIonError = (message: string, ...params: any[]) => {
const logLevel = config.get('logLevel', 'ERROR');
if (['ERROR', 'WARN'].includes(logLevel)) {
return console.error(`[Ionic Error]: ${message}`, ...params);
}
};

/**
Expand Down
113 changes: 113 additions & 0 deletions core/src/utils/logging/test/logging.spec.ts
Original file line number Diff line number Diff line change
@@ -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 '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 'ERROR'", () => {
it('does not log a warning to the console', () => {
config.set('logLevel', 'ERROR');

printIonWarning('This is a warning message');

expect(consoleWarnSpy).not.toHaveBeenCalled();
});
});

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('logs an error to the console', () => {
config.set('logLevel', 'WARN');

printIonError('This is an error message');

expect(consoleErrorSpy).toHaveBeenCalledWith('[Ionic Error]: This is an error message');
});
});

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();
});
});
});
});
Loading