fix(logger): invalid time zone environment variables leads to error (#…

…2865) Co-authored-by: Andrea Amorosi <dreamorosi@gmail.com>
aws-powertools · Aug 1, 2024 · d55465f · d55465f
1 parent 08a1d4d
commit d55465f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 5 deletions.
diff --git a/packages/logger/src/formatter/LogFormatter.ts b/packages/logger/src/formatter/LogFormatter.ts
@@ -111,6 +111,9 @@ abstract class LogFormatter implements LogFormatterInterface {
    */
   #getDateFormatter = (timeZone: string): Intl.DateTimeFormat => {
     const twoDigitFormatOption = '2-digit';
+    const validTimeZone = Intl.supportedValuesOf('timeZone').includes(timeZone)
+      ? timeZone
+      : 'UTC';
 
     return new Intl.DateTimeFormat('en', {
       year: 'numeric',
@@ -120,7 +123,7 @@ abstract class LogFormatter implements LogFormatterInterface {
       minute: twoDigitFormatOption,
       second: twoDigitFormatOption,
       hour12: false,
-      timeZone,
+      timeZone: validTimeZone,
     });
   };
 

diff --git a/packages/logger/tests/unit/formatter/PowertoolsLogFormatter.test.ts b/packages/logger/tests/unit/formatter/PowertoolsLogFormatter.test.ts
@@ -320,7 +320,7 @@ describe('Class: PowertoolsLogFormatter', () => {
     test('it formats the timestamp to ISO 8601, accounting for the `America/New_York` timezone offset', () => {
       // Prepare
       process.env.TZ = 'America/New_York';
-      /* 
+      /*
         Difference between UTC and `America/New_York`(GMT -04.00) is 240 minutes.
         The positive value indicates that `America/New_York` is behind UTC.
       */
@@ -341,7 +341,7 @@ describe('Class: PowertoolsLogFormatter', () => {
       process.env.TZ = 'America/New_York';
       const mockDate = new Date('2016-06-20T12:08:10.910Z');
       jest.useFakeTimers().setSystemTime(mockDate);
-      /* 
+      /*
         Difference between UTC and `America/New_York`(GMT -04.00) is 240 minutes.
         The positive value indicates that `America/New_York` is behind UTC.
       */
@@ -362,7 +362,7 @@ describe('Class: PowertoolsLogFormatter', () => {
       process.env.TZ = 'America/New_York';
       const mockDate = new Date('2016-06-20T00:08:10.910Z');
       jest.useFakeTimers().setSystemTime(mockDate);
-      /* 
+      /*
         Difference between UTC and `America/New_York`(GMT -04.00) is 240 minutes.
         The positive value indicates that `America/New_York` is behind UTC.
       */
@@ -381,7 +381,7 @@ describe('Class: PowertoolsLogFormatter', () => {
     test('if `envVarsService` is not set, ensures timestamp is formatted to `UTC` even with `America/New_York` timezone', () => {
       // Prepare
       process.env.TZ = 'America/New_York';
-      /* 
+      /*
         Difference between UTC and `America/New_York`(GMT -04.00) is 240 minutes.
         The positive value indicates that `America/New_York` is behind UTC.
       */
@@ -471,6 +471,22 @@ describe('Class: PowertoolsLogFormatter', () => {
       // Assess
       expect(timestamp).toEqual('2016-06-20T12:08:10.000Z');
     });
+
+    test('it is using UTC timezone when env var is set to :/etc/localtime', () => {
+      // Prepare
+      process.env.TZ = ':/etc/localtime';
+
+      jest.spyOn(Date.prototype, 'getTimezoneOffset').mockReturnValue(0);
+      const formatter = new PowertoolsLogFormatter({
+        envVarsService: new EnvironmentVariablesService(),
+      });
+
+      // Act
+      const timestamp = formatter.formatTimestamp(new Date());
+
+      // Assess
+      expect(timestamp).toEqual('2016-06-20T12:08:10.000+00:00');
+    });
   });
 
   describe('Method: getCodeLocation', () => {