add reserved key filter logic to setPersistentLogAttributes

Author: svozza

packages/logger/src/Logger.ts

@@ -656,7 +656,8 @@ class Logger extends Utility implements LoggerInterface {
    * @deprecated This method is deprecated and will be removed in the future major versions, please use {@link appendPersistentKeys() `appendPersistentKeys()`} instead.
    */
   public setPersistentLogAttributes(attributes: LogKeys): void {
-    this.#attributesStore.setPersistentAttributes(attributes);
+    const filtered = this.#filterReservedAttributeKeys(attributes);
+    this.#attributesStore.setPersistentAttributes(filtered);
   }
 
   /**
@@ -779,19 +780,24 @@ class Logger extends Utility implements LoggerInterface {
     merge(this.powertoolsLogData, attributes);
   }
 
+  #filterReservedAttributeKeys(attributes: LogKeys) {
+    const filtered: LogKeys = {};
+    for (const [key, value] of Object.entries(attributes)) {
+      if (!this.#checkReservedKeyAndWarn(key)) {
+        filtered[key] = value;
+      }
+    }
+    return filtered;
+  }
+
   /**
    * Shared logic for adding keys to the logger instance.
    *
    * @param attributes - The attributes to add to the log item.
    * @param type - The type of the attributes to add.
    */
   #appendKeys(attributes: LogKeys, type: 'temp' | 'persistent'): void {
-    const filtered: LogKeys = {};
-    for (const [key, value] of Object.entries(attributes)) {
-      if (!this.#checkReservedKeyAndWarn(key)) {
-        filtered[key] = value;
-      }
-    }
+    const filtered = this.#filterReservedAttributeKeys(attributes);
     if (type === 'temp') {
       this.#attributesStore.appendTemporaryKeys(filtered);
     } else {
@@ -834,7 +840,7 @@ class Logger extends Utility implements LoggerInterface {
       ...this.getPowertoolsLogData(),
       message: '',
     };
-    const additionalAttributes = this.#createAdditionalAttributes();
+    const additionalAttributes = this.#attributesStore.getAllAttributes();
 
     this.#processMainInput(
       input,
@@ -849,13 +855,6 @@ class Logger extends Utility implements LoggerInterface {
     );
   }
 
-  /**
-   * Create additional attributes from persistent and temporary keys
-   */
-  #createAdditionalAttributes(): LogAttributes {
-    return this.#attributesStore.getAllAttributes();
-  }
-
   /**
    * Process the main input message and add it to the attributes
    */

packages/logger/tests/unit/workingWithkeys.test.ts

@@ -619,6 +619,34 @@ describe('Working with keys', () => {
     );
   });
 
+  it('does not allow reserved keys with the deprecated setPersistentLogAttributes() method', () => {
+    // Prepare
+    const logger = new Logger();
+
+    // Act
+    logger.setPersistentLogAttributes({
+      // @ts-expect-error - testing invalid key at runtime
+      level: 'bar',
+    });
+
+    logger.info('test');
+
+    expect(console.info).toHaveLoggedNth(
+      1,
+      expect.objectContaining({
+        level: 'INFO',
+      })
+    );
+
+    // Assess
+    expect(console.warn).toHaveLoggedNth(
+      1,
+      expect.objectContaining({
+        message: 'The key "level" is a reserved key and will be dropped.',
+      })
+    );
+  });
+
   it('logs a warning when using both the deprecated persistentLogAttributes and persistentKeys options', () => {
     // Prepare
     new Logger({