test(logger): improve readability of injectLambdaContextBefore & injectLambdaContextAfterOrOnError function behaviour - separation of concerns

Author: saragerion

Diff for: packages/logger/src/Logger.ts

@@ -284,7 +284,12 @@ class Logger extends Utility implements ClassThatLogs {
 
       descriptor.value = (event, context, callback) => {
 
-        const initialPersistentAttributes = Logger.injectLambdaContextBefore(this, event, context, options);
+        let initialPersistentAttributes = {};
+        if (options && options.clearState === true) {
+          initialPersistentAttributes = { ...this.getPersistentLogAttributes() };
+        }
+
+        Logger.injectLambdaContextBefore(this, event, context, options);
 
         /* eslint-disable  @typescript-eslint/no-non-null-assertion */
         let result: unknown;
@@ -301,24 +306,20 @@ class Logger extends Utility implements ClassThatLogs {
     };
   }
 
-  public static injectLambdaContextAfterOrOnError(logger: Logger, initialPersistentAttributes: LogAttributes = {}, options?: HandlerOptions): void {
+  public static injectLambdaContextAfterOrOnError(logger: Logger, initialPersistentAttributes: LogAttributes, options?: HandlerOptions): void {
     if (options && options.clearState === true) {
       logger.setPersistentLogAttributes(initialPersistentAttributes);
     }
   }
 
-  public static injectLambdaContextBefore(logger: Logger, event: unknown, context: Context, options?: HandlerOptions): LogAttributes | undefined {
+  public static injectLambdaContextBefore(logger: Logger, event: unknown, context: Context, options?: HandlerOptions): void {
     logger.addContext(context);
 
     let shouldLogEvent = undefined;
     if (options && options.hasOwnProperty('logEvent')) {
       shouldLogEvent = options.logEvent;
     }
     logger.logEventIfEnabled(event, shouldLogEvent);
-
-    if (options && options.clearState === true) {
-      return { ...logger.getPersistentLogAttributes() };
-    }
   }
 
   /**

Diff for: packages/logger/src/middleware/middy.ts

@@ -30,14 +30,14 @@ import { HandlerOptions, LogAttributes } from '../types';
 const injectLambdaContext = (target: Logger | Logger[], options?: HandlerOptions): middy.MiddlewareObj => {
 
   const loggers = target instanceof Array ? target : [target];
-  const persistentAttributes: (LogAttributes | undefined)[] = [];
+  const persistentAttributes: LogAttributes[] = [];
 
   const injectLambdaContextBefore = async (request: middy.Request): Promise<void> => {
     loggers.forEach((logger: Logger) => {
-      const initialPersistentAttributes = Logger.injectLambdaContextBefore(logger, request.event, request.context, options);
       if (options && options.clearState === true) {
-        persistentAttributes.push(initialPersistentAttributes);
+        persistentAttributes.push({ ...logger.getPersistentLogAttributes() });
       }
+      Logger.injectLambdaContextBefore(logger, request.event, request.context, options);
     });
   };