logLevel.test.ts

/*
 * Copyright The OpenTelemetry Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import * as assert from 'assert';
import { diag } from '../../src';
import { createLogLevelDiagLogger } from '../../src/diag/internal/logLevelLogger';
import { createNoopDiagLogger } from '../../src/diag/internal/noopLogger';
import { DiagLogger, DiagLogLevel } from '../../src/diag/types';

// Matches the previous Logger definition
const incompleteLoggerFuncs = ['debug', 'info', 'warn', 'error'] as const;

export const diagLoggerFunctions = [
  'verbose',
  'debug',
  'info',
  'warn',
  'error',
] as const;

describe('LogLevelFilter DiagLogger', () => {
  const calledArgs: any = {
    error: null,
    warn: null,
    info: null,
    debug: null,
    verbose: null,
  };

  let dummyLogger: DiagLogger;

  /** Simulated Legacy logger */
  let incompleteLogger: DiagLogger;

  const restoreCallHistory = () => {
    diagLoggerFunctions.forEach(fName => {
      calledArgs[fName] = null;
    });
  };

  beforeEach(() => {
    // Set no logger so that sinon doesn't complain about TypeError: Attempted to wrap xxxx which is already wrapped
    diag.disable();

    // mock
    dummyLogger = {} as DiagLogger;
    diagLoggerFunctions.forEach(fName => {
      dummyLogger[fName] = (...args: unknown[]) => {
        calledArgs[fName] = args;
      };
    });

    incompleteLogger = {} as DiagLogger;
    incompleteLoggerFuncs.forEach(fName => {
      incompleteLogger[fName] = (...args: unknown[]) => {
        calledArgs[fName] = args;
      };
    });
  });

  afterEach(() => {
    restoreCallHistory();
  });

  const levelMap: Array<{
    message: string;
    level: DiagLogLevel;
    ignoreFuncs: Array<keyof DiagLogger>;
  }> = [
    { message: 'ALL', level: DiagLogLevel.ALL, ignoreFuncs: [] },
    { message: 'greater than ALL', level: 32768, ignoreFuncs: [] },
    { message: 'VERBOSE', level: DiagLogLevel.VERBOSE, ignoreFuncs: [] },
    { message: 'DEBUG', level: DiagLogLevel.DEBUG, ignoreFuncs: ['verbose'] },
    {
      message: 'INFO',
      level: DiagLogLevel.INFO,
      ignoreFuncs: ['verbose', 'debug'],
    },
    {
      message: 'WARN',
      level: DiagLogLevel.WARN,
      ignoreFuncs: ['verbose', 'debug', 'info'],
    },
    {
      message: 'ERROR',
      level: DiagLogLevel.ERROR,
      ignoreFuncs: ['verbose', 'debug', 'info', 'warn'],
    },
    {
      message: 'between ERROR and NONE',
      level: 1,
      ignoreFuncs: ['verbose', 'debug', 'info', 'warn', 'error'],
    },
    {
      message: 'NONE',
      level: DiagLogLevel.NONE,
      ignoreFuncs: ['verbose', 'debug', 'info', 'warn', 'error'],
    },
    {
      message: 'less than NONE',
      level: -1000,
      ignoreFuncs: ['verbose', 'debug', 'info', 'warn', 'error'],
    },
  ];

  levelMap.forEach(map => {
    describe(`with ${map.message} log level`, () => {
      diagLoggerFunctions.forEach(fName => {
        describe(`calling ${fName} message`, () => {
          it('should log', () => {
            const testLogger = createLogLevelDiagLogger(map.level, dummyLogger);
            testLogger[fName](`${fName} called %s`, 'param1');
            diagLoggerFunctions.forEach(lName => {
              if (fName === lName && map.ignoreFuncs.indexOf(lName) === -1) {
                assert.deepStrictEqual(calledArgs[lName], [
                  `${fName} called %s`,
                  'param1',
                ]);
              } else {
                assert.strictEqual(calledArgs[lName], null);
              }
            });
          });

          it('should be noop for null with explicit noop Logger log', () => {
            const testLogger = createLogLevelDiagLogger(
              map.level,
              createNoopDiagLogger()
            );
            testLogger[fName](`${fName} called %s`, 'param1');
            diagLoggerFunctions.forEach(lName => {
              assert.strictEqual(calledArgs[lName], null);
            });
          });

          it('should be noop and not throw for null and no default Logger log', () => {
            // @ts-expect-error null logger is not allowed
            const testLogger = createLogLevelDiagLogger(map.level, null);
            testLogger[fName](`${fName} called %s`, 'param1');
            diagLoggerFunctions.forEach(lName => {
              assert.strictEqual(calledArgs[lName], null);
            });
          });

          it('should be noop and not throw for undefined and no default Logger log', () => {
            // @ts-expect-error undefined logger is not allowed
            const testLogger = createLogLevelDiagLogger(map.level, undefined);
            testLogger[fName](`${fName} called %s`, 'param1');
            diagLoggerFunctions.forEach(lName => {
              assert.strictEqual(calledArgs[lName], null);
            });
          });

          it('diag.setLogger level is ignored when appropriate', () => {
            levelMap.forEach(masterLevelMap => {
              diag.setLogger(dummyLogger, masterLevelMap.level);

              const testLogger = createLogLevelDiagLogger(
                map.level,
                dummyLogger
              );
              restoreCallHistory();
              testLogger[fName](`${fName} called %s`, 'param1');
              diagLoggerFunctions.forEach(lName => {
                if (fName === lName && map.ignoreFuncs.indexOf(lName) === -1) {
                  assert.deepStrictEqual(
                    calledArgs[lName],
                    [`${fName} called %s`, 'param1'],
                    `expected to see messages when diag logger is set to ${masterLevelMap.message}`
                  );
                } else {
                  assert.strictEqual(
                    calledArgs[lName],
                    null,
                    `did not expect to see messages when diag logger is set to ${masterLevelMap.message}`
                  );
                }
              });
            });
          });

          it('diag.setLogger level and logger should log', () => {
            diag.setLogger(dummyLogger, map.level);
            restoreCallHistory();
            diag[fName](`${fName} called %s`, 'param1');
            diagLoggerFunctions.forEach(lName => {
              if (fName === lName && map.ignoreFuncs.indexOf(lName) === -1) {
                assert.deepStrictEqual(calledArgs[lName], [
                  `${fName} called %s`,
                  'param1',
                ]);
              } else {
                assert.strictEqual(calledArgs[lName], null);
              }
            });
          });

          it('should not throw with an invalid DiagLogger', () => {
            const invalidLogger = {
              debug: 1,
              warn: 2,
              error: 3,
              trace: 4,
              info: 5,
              log: 6,
            };

            const testLogger = createLogLevelDiagLogger(
              map.level,
              invalidLogger as any
            );
            restoreCallHistory();

            testLogger[fName](`${fName} called %s`, 'param1');
            diagLoggerFunctions.forEach(lName => {
              assert.strictEqual(calledArgs[lName], null);
            });
          });
        });
      });
    });
  });
});