add requested changes

Author: shdq

packages/logger/src/Logger.ts

@@ -172,16 +172,16 @@ class Logger extends Utility implements LoggerInterface {
    * Standard attributes managed by Powertools that will be logged in all log items.
    */
   private powertoolsLogData: PowertoolsLogData = <PowertoolsLogData>{};
+  /**
+   * Temporary log attributes that can be appended with `appendKeys()` method.
+   */
+  private temporaryLogAttributes: LogAttributes = {};
   /**
    * Buffer used to store logs until the logger is initialized.
    *
    * Sometimes we need to log warnings before the logger is fully initialized, however we can't log them
    * immediately because the logger is not ready yet. This buffer stores those logs until the logger is ready.
    */
-  /**
-   * Temporary log attributes that can be appended with `appendKeys()` method.
-   */
-  private temporaryLogAttributes: LogAttributes = {};
   #buffer: [number, Parameters<Logger['createAndPopulateLogItem']>][] = [];
   /**
    * Flag used to determine if the logger is initialized.
@@ -257,15 +257,6 @@ class Logger extends Utility implements LoggerInterface {
     merge(this.temporaryLogAttributes, attributes);
   }
 
-  /**
-   * It clears temporary log attributes.
-   *
-   * @returns {void}
-   */
-  public clearState(): void {
-    this.temporaryLogAttributes = {};
-  }
-
   /**
    * It creates a separate Logger instance, identical to the current one
    * It's possible to overwrite the new instance options by passing them.
@@ -368,16 +359,6 @@ class Logger extends Utility implements LoggerInterface {
     return this.persistentLogAttributes;
   }
 
-  /**
-   * It returns the temporary log attributes, added with `appendKeys()` method.
-   *
-   * @private
-   * @returns {LogAttributes}
-   */
-  public getTemporaryLogAttributes(): LogAttributes {
-    return this.temporaryLogAttributes;
-  }
-
   /**
    * It prints a log item with level INFO.
    *
@@ -449,26 +430,24 @@ class Logger extends Utility implements LoggerInterface {
         } catch (error) {
           throw error;
         } finally {
-          Logger.injectLambdaContextAfterOrOnError(
-            loggerRef,
-            loggerRef.getPersistentLogAttributes(),
-            options
-          );
+          Logger.injectLambdaContextAfterOrOnError(loggerRef, {}, options);
         }
 
         return result;
       };
     };
   }
 
+  /**
+   * @deprecated This method is deprecated and will be removed in the future major versions.
+   */
   public static injectLambdaContextAfterOrOnError(
     logger: Logger,
-    persistentAttributes: LogAttributes,
+    _persistentAttributes: LogAttributes,
     options?: InjectLambdaContextOptions
   ): void {
     if (options && options.clearState === true) {
-      logger.clearState();
-      logger.addPersistentLogAttributes(persistentAttributes);
+      logger.resetState();
     }
   }
 
@@ -511,31 +490,40 @@ class Logger extends Utility implements LoggerInterface {
   }
 
   /**
-   * It removes attributes based on provided keys to all log items generated by this Logger instance.
+   * It removes temporary attributes based on provided keys to all log items generated by this Logger instance.
    *
    * @param {string[]} keys
    * @returns {void}
    */
   public removeKeys(keys: string[]): void {
-    const removeKey = (attributes: LogAttributes, key: string): void => {
-      if (attributes && key in attributes) {
-        delete attributes[key];
-      }
-    };
     for (const key of keys) {
-      removeKey(this.persistentLogAttributes, key);
-      removeKey(this.temporaryLogAttributes, key);
+      if (this.temporaryLogAttributes && key in this.temporaryLogAttributes) {
+        delete this.temporaryLogAttributes[key];
+      }
     }
   }
 
   /**
-   * Alias for removeKeys().
+   * It removes persistent attributes based on provided keys to all log items generated by this Logger instance.
    *
    * @param {string[]} keys
    * @returns {void}
    */
   public removePersistentLogAttributes(keys: string[]): void {
-    this.removeKeys(keys);
+    for (const key of keys) {
+      if (this.persistentLogAttributes && key in this.persistentLogAttributes) {
+        delete this.persistentLogAttributes[key];
+      }
+    }
+  }
+
+  /**
+   * It resets the state, by removing all temporary log attributes added with `appendKeys()` method.
+   *
+   * @returns {void}
+   */
+  public resetState(): void {
+    this.temporaryLogAttributes = {};
   }
 
   /**
@@ -692,7 +680,7 @@ class Logger extends Utility implements LoggerInterface {
     // gradually merge additional attributes starting from customer-provided persistent & temporary attributes
     let additionalLogAttributes = {
       ...this.getPersistentLogAttributes(),
-      ...this.getTemporaryLogAttributes(),
+      ...this.temporaryLogAttributes,
     };
     // if the main input is not a string, then it's an object with additional attributes, so we merge it
     additionalLogAttributes = merge(additionalLogAttributes, otherInput);

packages/logger/src/middleware/middy.ts

@@ -69,7 +69,7 @@ const injectLambdaContext = (
   const injectLambdaContextAfterOrOnError = async (): Promise<void> => {
     if (isClearState) {
       loggers.forEach((logger: Logger) => {
-        logger.clearState();
+        logger.resetState();
       });
     }
   };