fix(logger): not passing persistentKeys to child

Author: iamgerg

packages/logger/src/Logger.ts

@@ -335,8 +335,7 @@ class Logger extends Utility implements LoggerInterface {
           logFormatter: this.getLogFormatter(),
           customConfigService: this.getCustomConfigService(),
           environment: this.powertoolsLogData.environment,
-          persistentLogAttributes:
-            this.#attributesStore.getPersistentAttributes(),
+          persistentKeys: this.#attributesStore.getPersistentAttributes(),
           jsonReplacerFn: this.#jsonReplacerFn,
           correlationIdSearchFn: this.#correlationIdSearchFn,
           ...(this.#bufferConfig.enabled && {

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

@@ -110,6 +110,88 @@ describe('Log levels', () => {
     );
   });
 
+  it('overrides the service name when creating a child logger', () => {
+    // Prepare
+    vi.stubEnv('POWERTOOLS_SERVICE_NAME', 'hello-world');
+    const logger = new Logger();
+    const childLogger = logger.createChild({ serviceName: 'child-service' });
+
+    // Act
+    childLogger.info('Hello, world!');
+
+    // Assess
+    expect(console.info).toHaveBeenCalledTimes(1);
+    expect(console.info).toHaveLoggedNth(
+      1,
+      expect.objectContaining({ service: 'child-service' })
+    );
+  });
+
+  it('maintains persistentKeys when creating a child logger', () => {
+    // Prepare
+    const mockDate = new Date(1466424490000);
+    vi.useFakeTimers().setSystemTime(mockDate);
+    const logger = new Logger({
+      persistentKeys: {
+        foo: 'hello',
+        overridable: 1,
+      },
+    });
+
+    logger.appendKeys({
+      resettableKey: 'some-id',
+    });
+
+    logger.appendPersistentKeys({
+      dynamic: 'stays',
+    });
+
+    const childLogger = logger.createChild({
+      serviceName: 'child-service',
+      persistentKeys: {
+        bar: 'world',
+        overridable: 2,
+      },
+    });
+
+    // Act
+    childLogger.info('Hello, world!');
+    childLogger.resetKeys();
+    childLogger.info('Hello again!');
+
+    // Assess
+    expect(console.info).toHaveBeenCalledTimes(2);
+    expect(console.info).toHaveLoggedNth(
+      1,
+      expect.objectContaining({
+        service: 'child-service',
+        foo: 'hello',
+        bar: 'world',
+        dynamic: 'stays',
+        message: 'Hello, world!',
+        overridable: 2,
+        resettableKey: 'some-id',
+      })
+    );
+
+    expect(console.info).toHaveLoggedNth(
+      2,
+      // using direct match here to ensure removal of resetKeys
+      {
+        service: 'child-service',
+        foo: 'hello',
+        bar: 'world',
+        dynamic: 'stays',
+        message: 'Hello again!',
+        overridable: 2,
+        level: 'INFO',
+        sampling_rate: 0,
+        timestamp: '2016-06-20T12:08:10.000Z',
+        xray_trace_id: '1-abcdef12-3456abcdef123456abcdef12',
+      }
+    );
+  });
+
   it('`logRecordOrder` should be passed down to child logger', () => {
     // Prepare
     const expectedKeys = [

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

@@ -519,11 +519,16 @@ describe('Working with keys', () => {
     });
 
     // Act
-    const childLogger = logger.createChild();
+    const childLogger = logger.createChild({
+      persistentKeys: {
+        bar: 'foo',
+      },
+    });
 
     // Assess
     expect(childLogger.getPersistentLogAttributes()).toEqual({
       foo: 'bar',
+      bar: 'foo',
     });
   });
 
@@ -671,7 +676,11 @@ describe('Working with keys', () => {
 
   it('should pass persistentKeys to child with no warning', () => {
     // Prepare
-    const logger = new Logger();
+    const logger = new Logger({
+      persistentKeys: {
+        foo: 'bar',
+      },
+    });
     logger.createChild({ persistentKeys: { abc: 'xyz' } });
 
     // Assess