Skip to content

feat(diag-logger): introduce a new global level api.diag for internal diagnostic logging #1880

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.

Sign up for GitHub

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

Merged
dyladan merged 6 commits into from
Feb 10, 2021
Merged

feat(diag-logger): introduce a new global level api.diag for internal diagnostic logging #1880

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
692e582
feat(diag-logger): introduce a new global level api.diag for internal…
MSNev Jan 27, 2021
f26614e
fix(test): ci environment doesn't handle replacing console with a mock
MSNev Jan 28, 2021
7c834ef
fix: address review comments
MSNev Feb 3, 2021
fc00e10
fix: correct the usage of default logger for level and update test
MSNev Feb 4, 2021
a4cb4ba
fix: address additional review comments
MSNev Feb 9, 2021
de8f8ee
Merge branch 'main' into MSNev/AddDiagLogger
dyladan Feb 10, 2021
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
Prev Previous commit
Next Next commit
fix(test): ci environment doesn't handle replacing console with a mock
  • Loading branch information
@MSNev
MSNev committed Feb 9, 2021
commit f26614ed530f4b637be4e3e551dea0b715eb9271
224 changes: 122 additions & 102 deletions packages/opentelemetry-api/test/diag/consoleLogger.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,16 @@ describe('DiagConsoleLogger', () => {
let errorCalledArgs: unknown;
let logCalledArgs: unknown;

let canMockConsole = true;

try {
// eslint-disable-next-line no-global-assign
console = origConsole;
} catch (ex) {
// Not supported on CI pipeline (works locally)
canMockConsole = false;
}

beforeEach(() => {
// mock
console.debug = (...args: unknown[]) => {
Expand Down Expand Up @@ -62,8 +72,16 @@ describe('DiagConsoleLogger', () => {
errorCalledArgs = null;
logCalledArgs = null;
traceCalledArgs = null;
// eslint-disable-next-line no-global-assign
console = origConsole;

if (canMockConsole) {
try {
// eslint-disable-next-line no-global-assign
console = origConsole;
} catch (ex) {
// Not supported on CI pipeline
canMockConsole = false;
}
}
console.debug = origDebug;
console.info = origInfo;
console.warn = origWarn;
Expand Down Expand Up @@ -221,110 +239,112 @@ describe('DiagConsoleLogger', () => {
]);
});

it('should not throw even when console is not supported', () => {
(console as any) = undefined;
const consoleLogger = new DiagConsoleLogger();
consoleLogger.terminal('terminal called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.critical('critical called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.error('error called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.warn('warn called %s', 'param1');
assert.deepStrictEqual(warnCalledArgs, null);
consoleLogger.info('info called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
consoleLogger.debug('debug called %s', 'param1');
assert.deepStrictEqual(debugCalledArgs, null);
consoleLogger.trace('trace called %s', 'param1');
assert.deepStrictEqual(traceCalledArgs, null);
assert.deepStrictEqual(logCalledArgs, null);
consoleLogger.forcedInfo('forcedInfo called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
});
if (canMockConsole) {
it('should not throw even when console is not supported', () => {
(console as any) = undefined;
const consoleLogger = new DiagConsoleLogger();
consoleLogger.terminal('terminal called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.critical('critical called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.error('error called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.warn('warn called %s', 'param1');
assert.deepStrictEqual(warnCalledArgs, null);
consoleLogger.info('info called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
consoleLogger.debug('debug called %s', 'param1');
assert.deepStrictEqual(debugCalledArgs, null);
consoleLogger.trace('trace called %s', 'param1');
assert.deepStrictEqual(traceCalledArgs, null);
assert.deepStrictEqual(logCalledArgs, null);
consoleLogger.forcedInfo('forcedInfo called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
});

it('should not throw even when console is disabled after construction', () => {
const consoleLogger = new DiagConsoleLogger();
(console as any) = undefined;
consoleLogger.terminal('terminal called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.critical('critical called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.error('error called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.warn('warn called %s', 'param1');
assert.deepStrictEqual(warnCalledArgs, null);
consoleLogger.info('info called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
consoleLogger.debug('debug called %s', 'param1');
assert.deepStrictEqual(debugCalledArgs, null);
consoleLogger.trace('trace called %s', 'param1');
assert.deepStrictEqual(traceCalledArgs, null);
assert.deepStrictEqual(logCalledArgs, null);
consoleLogger.forcedInfo('forcedInfo called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
});
it('should not throw even when console is disabled after construction', () => {
const consoleLogger = new DiagConsoleLogger();
(console as any) = undefined;
consoleLogger.terminal('terminal called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.critical('critical called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.error('error called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.warn('warn called %s', 'param1');
assert.deepStrictEqual(warnCalledArgs, null);
consoleLogger.info('info called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
consoleLogger.debug('debug called %s', 'param1');
assert.deepStrictEqual(debugCalledArgs, null);
consoleLogger.trace('trace called %s', 'param1');
assert.deepStrictEqual(traceCalledArgs, null);
assert.deepStrictEqual(logCalledArgs, null);
consoleLogger.forcedInfo('forcedInfo called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
});

it('should not throw even when console is invalid after construction', () => {
const invalidConsole = {
debug: 1,
warn: 2,
error: 3,
trace: 4,
info: 5,
log: 6,
};
it('should not throw even when console is invalid after construction', () => {
const invalidConsole = {
debug: 1,
warn: 2,
error: 3,
trace: 4,
info: 5,
log: 6,
};

const consoleLogger = new DiagConsoleLogger();
(console as any) = invalidConsole;
consoleLogger.terminal('terminal called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.critical('critical called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.error('error called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.warn('warn called %s', 'param1');
assert.deepStrictEqual(warnCalledArgs, null);
consoleLogger.info('info called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
consoleLogger.debug('debug called %s', 'param1');
assert.deepStrictEqual(debugCalledArgs, null);
consoleLogger.trace('trace called %s', 'param1');
assert.deepStrictEqual(traceCalledArgs, null);
assert.deepStrictEqual(logCalledArgs, null);
consoleLogger.forcedInfo('forcedInfo called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
});
const consoleLogger = new DiagConsoleLogger();
(console as any) = invalidConsole;
consoleLogger.terminal('terminal called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.critical('critical called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.error('error called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.warn('warn called %s', 'param1');
assert.deepStrictEqual(warnCalledArgs, null);
consoleLogger.info('info called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
consoleLogger.debug('debug called %s', 'param1');
assert.deepStrictEqual(debugCalledArgs, null);
consoleLogger.trace('trace called %s', 'param1');
assert.deepStrictEqual(traceCalledArgs, null);
assert.deepStrictEqual(logCalledArgs, null);
consoleLogger.forcedInfo('forcedInfo called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
});

it('should not throw even when console is invalid before construction', () => {
const invalidConsole = {
debug: 1,
warn: 2,
error: 3,
trace: 4,
info: 5,
log: 6,
};
it('should not throw even when console is invalid before construction', () => {
const invalidConsole = {
debug: 1,
warn: 2,
error: 3,
trace: 4,
info: 5,
log: 6,
};

(console as any) = invalidConsole;
const consoleLogger = new DiagConsoleLogger();
consoleLogger.terminal('terminal called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.critical('critical called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.error('error called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.warn('warn called %s', 'param1');
assert.deepStrictEqual(warnCalledArgs, null);
consoleLogger.info('info called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
consoleLogger.debug('debug called %s', 'param1');
assert.deepStrictEqual(debugCalledArgs, null);
consoleLogger.trace('trace called %s', 'param1');
assert.deepStrictEqual(traceCalledArgs, null);
assert.deepStrictEqual(logCalledArgs, null);
consoleLogger.forcedInfo('forcedInfo called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
});
(console as any) = invalidConsole;
const consoleLogger = new DiagConsoleLogger();
consoleLogger.terminal('terminal called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.critical('critical called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.error('error called %s', 'param1');
assert.deepStrictEqual(errorCalledArgs, null);
consoleLogger.warn('warn called %s', 'param1');
assert.deepStrictEqual(warnCalledArgs, null);
consoleLogger.info('info called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
consoleLogger.debug('debug called %s', 'param1');
assert.deepStrictEqual(debugCalledArgs, null);
consoleLogger.trace('trace called %s', 'param1');
assert.deepStrictEqual(traceCalledArgs, null);
assert.deepStrictEqual(logCalledArgs, null);
consoleLogger.forcedInfo('forcedInfo called %s', 'param1');
assert.deepStrictEqual(infoCalledArgs, null);
});
}
});
});