chore(maintenance): migrate logger utility to biome (#2813)

Author: daschaa

packages/logger/package.json

@@ -20,8 +20,8 @@
     "build:cjs": "tsc --build tsconfig.json && echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json",
     "build:esm": "tsc --build tsconfig.esm.json && echo '{ \"type\": \"module\" }' > lib/esm/package.json",
     "build": "npm run build:esm & npm run build:cjs",
-    "lint": "eslint --ext .ts,.js --no-error-on-unmatched-pattern .",
-    "lint-fix": "eslint --fix --ext .ts,.js --no-error-on-unmatched-pattern .",
+    "lint": "biome lint .",
+    "lint:fix": "biome check --write .",
     "prepack": "node ../../.github/scripts/release_patch_package_json.js ."
   },
   "homepage": "https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/packages/logger#readme",
@@ -53,10 +53,7 @@
         "lib/cjs/middleware/middy.d.ts",
         "lib/esm/middleware/middy.d.ts"
       ],
-      "types": [
-        "lib/cjs/types/index.d.ts",
-        "lib/esm/types/index.d.ts"
-      ]
+      "types": ["lib/cjs/types/index.d.ts", "lib/esm/types/index.d.ts"]
     }
   },
   "types": "./lib/cjs/index.d.ts",
@@ -73,9 +70,7 @@
       "optional": true
     }
   },
-  "files": [
-    "lib"
-  ],
+  "files": ["lib"],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/aws-powertools/powertools-lambda-typescript.git"

packages/logger/src/Logger.ts

@@ -1,30 +1,30 @@
+import { Console } from 'node:console';
+import { randomInt } from 'node:crypto';
 import { Utility } from '@aws-lambda-powertools/commons';
 import type { HandlerMethodDecorator } from '@aws-lambda-powertools/commons/types';
 import type { Context, Handler } from 'aws-lambda';
 import merge from 'lodash.merge';
-import { Console } from 'node:console';
-import { randomInt } from 'node:crypto';
 import { EnvironmentVariablesService } from './config/EnvironmentVariablesService.js';
 import { LogJsonIndent } from './constants.js';
-import { LogItem } from './formatter/LogItem.js';
+import type { LogItem } from './formatter/LogItem.js';
 import { PowertoolsLogFormatter } from './formatter/PowertoolsLogFormatter.js';
 import type { ConfigServiceInterface } from './types/ConfigServiceInterface.js';
 import type {
   Environment,
   LogAttributes,
+  LogFormatterInterface,
   LogLevel,
   LogLevelThresholds,
-  LogFormatterInterface,
 } from './types/Log.js';
 import type {
-  LogFunction,
   ConstructorOptions,
+  CustomJsonReplacerFn,
   InjectLambdaContextOptions,
+  LogFunction,
   LogItemExtraInput,
   LogItemMessage,
   LoggerInterface,
   PowertoolsLogData,
-  CustomJsonReplacerFn,
 } from './types/Logger.js';
 
 /**
@@ -442,10 +442,7 @@ class Logger extends Utility implements LoggerInterface {
     options?: InjectLambdaContextOptions
   ): HandlerMethodDecorator {
     return (_target, _propertyKey, descriptor) => {
-      /**
-       * The descriptor.value is the method this decorator decorates, it cannot be undefined.
-       */
-      /* eslint-disable  @typescript-eslint/no-non-null-assertion */
+      // biome-ignore lint/style/noNonNullAssertion: The descriptor.value is the method this decorator decorates, it cannot be undefined.
       const originalMethod = descriptor.value!;
 
       // eslint-disable-next-line @typescript-eslint/no-this-alias
@@ -463,8 +460,6 @@ class Logger extends Utility implements LoggerInterface {
         let result: unknown;
         try {
           result = await originalMethod.apply(this, [event, context, callback]);
-        } catch (error) {
-          throw error;
         } finally {
           if (options?.clearState || options?.resetKeys) loggerRef.resetKeys();
         }
@@ -697,22 +692,24 @@ class Logger extends Utility implements LoggerInterface {
     const references = new WeakSet();
 
     return (key, value) => {
-      if (this.#jsonReplacerFn) value = this.#jsonReplacerFn?.(key, value);
+      let replacedValue = value;
+      if (this.#jsonReplacerFn)
+        replacedValue = this.#jsonReplacerFn?.(key, replacedValue);
 
-      if (value instanceof Error) {
-        value = this.getLogFormatter().formatError(value);
+      if (replacedValue instanceof Error) {
+        replacedValue = this.getLogFormatter().formatError(replacedValue);
       }
-      if (typeof value === 'bigint') {
-        return value.toString();
+      if (typeof replacedValue === 'bigint') {
+        return replacedValue.toString();
       }
-      if (typeof value === 'object' && value !== null) {
-        if (references.has(value)) {
+      if (typeof replacedValue === 'object' && replacedValue !== null) {
+        if (references.has(replacedValue)) {
           return;
         }
-        references.add(value);
+        references.add(replacedValue);
       }
 
-      return value;
+      return replacedValue;
     };
   }
 
@@ -855,10 +852,10 @@ class Logger extends Utility implements LoggerInterface {
    * @returns - The name of the log level
    */
   private getLogLevelNameFromNumber(logLevel: number): Uppercase<LogLevel> {
-    let found;
+    let found: Uppercase<LogLevel> | undefined;
     for (const [key, value] of Object.entries(this.logLevelThresholds)) {
       if (value === logLevel) {
-        found = key;
+        found = key as Uppercase<LogLevel>;
         break;
       }
     }

packages/logger/src/config/EnvironmentVariablesService.ts

@@ -1,5 +1,5 @@
-import { ConfigServiceInterface } from '../types/ConfigServiceInterface.js';
 import { EnvironmentVariablesService as CommonEnvironmentVariablesService } from '@aws-lambda-powertools/commons';
+import type { ConfigServiceInterface } from '../types/ConfigServiceInterface.js';
 
 /**
  * Class EnvironmentVariablesService

packages/logger/src/formatter/LogFormatter.ts

@@ -5,7 +5,7 @@ import type {
   LogFormatterOptions,
 } from '../types/Log.js';
 import type { UnformattedAttributes } from '../types/Logger.js';
-import { LogItem } from './LogItem.js';
+import type { LogItem } from './LogItem.js';
 
 /**
  * This class defines and implements common methods for the formatting of log attributes.
@@ -92,9 +92,8 @@ abstract class LogFormatter implements LogFormatterInterface {
     const stackLines = stack.split('\n');
     const regex = /\(([^)]*?):(\d+?):(\d+?)\)\\?$/;
 
-    let i;
-    for (i = 0; i < stackLines.length; i++) {
-      const match = regex.exec(stackLines[i]);
+    for (const item of stackLines) {
+      const match = regex.exec(item);
 
       if (Array.isArray(match)) {
         return `${match[1]}:${Number(match[2])}`;

packages/logger/src/middleware/middy.ts

@@ -1,10 +1,10 @@
-import { Logger } from '../Logger.js';
-import type { InjectLambdaContextOptions } from '../types/Logger.js';
 import { LOGGER_KEY } from '@aws-lambda-powertools/commons';
 import type {
   MiddlewareLikeObj,
   MiddyLikeRequest,
 } from '@aws-lambda-powertools/commons/types';
+import { Logger } from '../Logger.js';
+import type { InjectLambdaContextOptions } from '../types/Logger.js';
 
 /**
  * A middy middleware that helps emitting CloudWatch EMF metrics in your logs.
@@ -35,7 +35,7 @@ const injectLambdaContext = (
   target: Logger | Logger[],
   options?: InjectLambdaContextOptions
 ): MiddlewareLikeObj => {
-  const loggers = target instanceof Array ? target : [target];
+  const loggers = Array.isArray(target) ? target : [target];
   const isResetStateEnabled =
     options && (options.clearState || options.resetKeys);
 
@@ -54,7 +54,7 @@ const injectLambdaContext = (
   const injectLambdaContextBefore = async (
     request: MiddyLikeRequest
   ): Promise<void> => {
-    loggers.forEach((logger: Logger) => {
+    for (const logger of loggers) {
       if (isResetStateEnabled) {
         setCleanupFunction(request);
       }
@@ -64,14 +64,14 @@ const injectLambdaContext = (
         request.context,
         options
       );
-    });
+    }
   };
 
   const injectLambdaContextAfterOrOnError = async (): Promise<void> => {
     if (isResetStateEnabled) {
-      loggers.forEach((logger: Logger) => {
+      for (const logger of loggers) {
         logger.resetKeys();
-      });
+      }
     }
   };
 

packages/logger/src/types/Log.ts

@@ -1,11 +1,11 @@
 import type { EnvironmentVariablesService } from '../config/EnvironmentVariablesService.js';
+import type { LogLevel as LogLevelList } from '../constants.js';
 import type { LogItem } from '../formatter/LogItem.js';
 import type { UnformattedAttributes } from './Logger.js';
-import { LogLevel } from '../constants.js';
 
 type LogLevel =
-  | (typeof LogLevel)[keyof typeof LogLevel]
-  | Lowercase<(typeof LogLevel)[keyof typeof LogLevel]>;
+  | (typeof LogLevelList)[keyof typeof LogLevelList]
+  | Lowercase<(typeof LogLevelList)[keyof typeof LogLevelList]>;
 
 type LogLevelThresholds = {
   [key in Uppercase<LogLevel>]: number;

packages/logger/src/types/Logger.ts

@@ -1,13 +1,13 @@
 import type { HandlerMethodDecorator } from '@aws-lambda-powertools/commons/types';
+import type { Context } from 'aws-lambda';
 import type { ConfigServiceInterface } from './ConfigServiceInterface.js';
 import type {
   Environment,
   LogAttributes,
   LogAttributesWithMessage,
-  LogLevel,
   LogFormatterInterface,
+  LogLevel,
 } from './Log.js';
-import type { Context } from 'aws-lambda';
 
 type LogFunction = {
   [key in Exclude<Lowercase<LogLevel>, 'silent'>]: (

packages/logger/tests/e2e/basicFeatures.middy.test.FunctionCode.ts

@@ -1,8 +1,8 @@
+import type { APIGatewayAuthorizerResult, Context } from 'aws-lambda';
+import middy from 'middy5';
 import { Logger } from '../../src/index.js';
 import { injectLambdaContext } from '../../src/middleware/middy.js';
-import type { Context, APIGatewayAuthorizerResult } from 'aws-lambda';
 import type { TestEvent, TestOutput } from '../helpers/types.js';
-import middy from 'middy5';
 
 const PERSISTENT_KEY = process.env.PERSISTENT_KEY || 'persistentKey';
 const PERSISTENT_VALUE = process.env.PERSISTENT_VALUE || 'persistentValue';

packages/logger/tests/e2e/basicFeatures.middy.test.ts

@@ -3,13 +3,13 @@
  *
  * @group e2e/logger/basicFeatures
  */
+import { join } from 'node:path';
 import {
-  invokeFunction,
   TestInvocationLogs,
   TestStack,
+  invokeFunction,
 } from '@aws-lambda-powertools/testing-utils';
 import type { APIGatewayAuthorizerResult } from 'aws-lambda';
-import { join } from 'node:path';
 import { LoggerTestNodejsFunction } from '../helpers/resources.js';
 import {
   RESOURCE_NAME_PREFIX,
@@ -21,7 +21,7 @@ import {
   commonEnvironmentVars,
 } from './constants.js';
 
-describe(`Logger E2E tests, basic functionalities middy usage`, () => {
+describe('Logger E2E tests, basic functionalities middy usage', () => {
   const testStack = new TestStack({
     stackNameProps: {
       stackNamePrefix: RESOURCE_NAME_PREFIX,

packages/logger/tests/e2e/childLogger.manual.test.FunctionCode.ts

@@ -1,7 +1,7 @@
-import { Logger } from '../../src/index.js';
 import type { Context } from 'aws-lambda';
+import { Logger } from '../../src/index.js';
 import type { LogLevel } from '../../src/types/index.js';
-import { TestEvent, TestOutput } from '../helpers/types.js';
+import type { TestEvent, TestOutput } from '../helpers/types.js';
 
 const PERSISTENT_KEY = process.env.PERSISTENT_KEY || 'persistentKey';
 const PERSISTENT_VALUE = process.env.ERSISTENT_VALUE || 'persistentValue';

packages/logger/tests/e2e/childLogger.manual.test.ts

@@ -3,23 +3,23 @@
  *
  * @group e2e/logger/childLogger
  */
+import { join } from 'node:path';
 import {
-  invokeFunction,
   TestInvocationLogs,
   TestStack,
+  invokeFunction,
 } from '@aws-lambda-powertools/testing-utils';
-import { join } from 'node:path';
 import { LoggerTestNodejsFunction } from '../helpers/resources.js';
 import {
-  commonEnvironmentVars,
   RESOURCE_NAME_PREFIX,
   SETUP_TIMEOUT,
   STACK_OUTPUT_LOG_GROUP,
   TEARDOWN_TIMEOUT,
   TEST_CASE_TIMEOUT,
+  commonEnvironmentVars,
 } from './constants.js';
 
-describe(`Logger E2E tests, child logger`, () => {
+describe('Logger E2E tests, child logger', () => {
   const testStack = new TestStack({
     stackNameProps: {
       stackNamePrefix: RESOURCE_NAME_PREFIX,

packages/logger/tests/e2e/logEventEnvVarSetting.middy.test.FunctionCode.ts

@@ -1,8 +1,8 @@
+import type { Context } from 'aws-lambda';
+import middy from 'middy4';
 import { Logger } from '../../src/index.js';
 import { injectLambdaContext } from '../../src/middleware/middy.js';
 import type { TestEvent, TestOutput } from '../helpers/types.js';
-import type { Context } from 'aws-lambda';
-import middy from 'middy4';
 
 const logger = new Logger();
 

packages/logger/tests/e2e/logEventEnvVarSetting.middy.test.ts

@@ -3,12 +3,12 @@
  *
  * @group e2e/logger/logEventEnvVarSetting
  */
+import { join } from 'node:path';
 import {
-  invokeFunction,
   TestInvocationLogs,
   TestStack,
+  invokeFunction,
 } from '@aws-lambda-powertools/testing-utils';
-import { join } from 'node:path';
 import { LoggerTestNodejsFunction } from '../helpers/resources.js';
 import {
   RESOURCE_NAME_PREFIX,
@@ -18,7 +18,7 @@ import {
   TEST_CASE_TIMEOUT,
 } from './constants.js';
 
-describe(`Logger E2E tests, log event via env var setting with middy`, () => {
+describe('Logger E2E tests, log event via env var setting with middy', () => {
   const testStack = new TestStack({
     stackNameProps: {
       stackNamePrefix: RESOURCE_NAME_PREFIX,

packages/logger/tests/e2e/sampleRate.decorator.test.FunctionCode.ts

@@ -1,9 +1,9 @@
+import type { LambdaInterface } from '@aws-lambda-powertools/commons/types';
+import type { Context } from 'aws-lambda';
 import { Logger } from '../../src/index.js';
 import type { TestEvent, TestOutput } from '../helpers/types.js';
-import type { Context } from 'aws-lambda';
-import type { LambdaInterface } from '@aws-lambda-powertools/commons/types';
 
-const SAMPLE_RATE = parseFloat(process.env.SAMPLE_RATE || '0.1');
+const SAMPLE_RATE = Number.parseFloat(process.env.SAMPLE_RATE || '0.1');
 const LOG_MSG = process.env.LOG_MSG || 'Hello World';
 
 const logger = new Logger({

packages/logger/tests/e2e/sampleRate.decorator.test.ts

@@ -3,13 +3,13 @@
  *
  * @group e2e/logger/sampleRate
  */
+import { randomUUID } from 'node:crypto';
+import { join } from 'node:path';
 import {
-  invokeFunction,
   TestInvocationLogs,
   TestStack,
+  invokeFunction,
 } from '@aws-lambda-powertools/testing-utils';
-import { randomUUID } from 'node:crypto';
-import { join } from 'node:path';
 import { LoggerTestNodejsFunction } from '../helpers/resources.js';
 import {
   RESOURCE_NAME_PREFIX,
@@ -19,7 +19,7 @@ import {
   TEST_CASE_TIMEOUT,
 } from './constants.js';
 
-describe(`Logger E2E tests, sample rate and injectLambdaContext()`, () => {
+describe('Logger E2E tests, sample rate and injectLambdaContext()', () => {
   const testStack = new TestStack({
     stackNameProps: {
       stackNamePrefix: RESOURCE_NAME_PREFIX,