Merge branch 'y-nk-julien/log-level-filtering'

Author: kamilmysliwiec

packages/common/services/console-logger.service.ts

@@ -8,7 +8,7 @@ import {
   isUndefined,
 } from '../utils/shared.utils';
 import { LoggerService, LogLevel } from './logger.service';
-import { isLogLevelEnabled } from './utils';
+import { isLogLevelEnabled } from './utils/is-log-level-enabled.util';
 
 const DEFAULT_DEPTH = 5;
 

packages/common/services/index.ts

@@ -1,2 +1,3 @@
 export * from './console-logger.service';
 export * from './logger.service';
+export * from './utils/filter-log-levels.util';

packages/common/services/logger.service.ts

@@ -3,10 +3,19 @@ import { isObject } from '../utils/shared.utils';
 import { ConsoleLogger } from './console-logger.service';
 import { isLogLevelEnabled } from './utils';
 
+export const LOG_LEVELS = [
+  'verbose',
+  'debug',
+  'log',
+  'warn',
+  'error',
+  'fatal',
+] as const satisfies string[];
+
 /**
  * @publicApi
  */
-export type LogLevel = 'log' | 'error' | 'warn' | 'debug' | 'verbose' | 'fatal';
+export type LogLevel = (typeof LOG_LEVELS)[number];
 
 /**
  * @publicApi

packages/common/services/utils/filter-log-levels.util.ts

@@ -0,0 +1,27 @@
+import { LOG_LEVELS, LogLevel } from '../logger.service';
+import { isLogLevel } from './is-log-level.util';
+
+/**
+ * @publicApi
+ */
+export function filterLogLevels(parseableString = ''): LogLevel[] {
+  const sanitizedSring = parseableString.replaceAll(' ', '').toLowerCase();
+
+  if (sanitizedSring[0] === '>') {
+    const orEqual = sanitizedSring[1] === '=';
+
+    const logLevelIndex = (LOG_LEVELS as string[]).indexOf(
+      sanitizedSring.substring(orEqual ? 2 : 1),
+    );
+
+    if (logLevelIndex === -1) {
+      throw new Error(`parse error (unknown log level): ${sanitizedSring}`);
+    }
+
+    return LOG_LEVELS.slice(orEqual ? logLevelIndex : logLevelIndex + 1);
+  } else if (sanitizedSring.includes(',')) {
+    return sanitizedSring.split(',').filter(isLogLevel);
+  }
+
+  return isLogLevel(sanitizedSring) ? [sanitizedSring] : LOG_LEVELS;
+}

packages/common/services/utils/index.ts

@@ -1 +1,3 @@
+export * from './filter-log-levels.util';
 export * from './is-log-level-enabled.util';
+export * from './is-log-level.util';

packages/common/services/utils/is-log-level.util.ts

@@ -0,0 +1,8 @@
+import { LOG_LEVELS, LogLevel } from '../logger.service';
+
+/**
+ * @publicApi
+ */
+export function isLogLevel(maybeLogLevel: any): maybeLogLevel is LogLevel {
+  return LOG_LEVELS.includes(maybeLogLevel);
+}

packages/common/test/services/utils/filter-log-levels.util.spec.ts

@@ -0,0 +1,36 @@
+import { expect } from 'chai';
+import { filterLogLevels } from '../../../services/utils/filter-log-levels.util';
+
+describe('filterLogLevels', () => {
+  it('should correctly parse an exclusive range', () => {
+    const returned = filterLogLevels('>warn');
+    expect(returned).to.deep.equal(['error', 'fatal']);
+  });
+
+  it('should correctly parse an inclusive range', () => {
+    const returned = filterLogLevels('>=warn');
+    expect(returned).to.deep.equal(['warn', 'error', 'fatal']);
+  });
+
+  it('should correctly parse a string list', () => {
+    const returned = filterLogLevels('verbose,warn,fatal');
+    expect(returned).to.deep.equal(['verbose', 'warn', 'fatal']);
+  });
+
+  it('should correctly parse a single log level', () => {
+    const returned = filterLogLevels('debug');
+    expect(returned).to.deep.equal(['debug']);
+  });
+
+  it('should return all otherwise', () => {
+    const returned = filterLogLevels();
+    expect(returned).to.deep.equal([
+      'verbose',
+      'debug',
+      'log',
+      'warn',
+      'error',
+      'fatal',
+    ]);
+  });
+});