chore(tracer): update warning to better format segment name (#1750)

* chore(tracer): update warning in Tracer to better format segment name * chore: linting
aws-powertools · Oct 18, 2023 · 9e7458d · 9e7458d
1 parent d20269d
commit 9e7458d
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/packages/tracer/src/Tracer.ts b/packages/tracer/src/Tracer.ts
@@ -410,7 +410,8 @@ class Tracer extends Utility implements TracerInterface {
                 subsegment?.close();
               } catch (error) {
                 console.warn(
-                  `Failed to close or serialize segment, ${subsegment?.name}. We are catching the error but data might be lost.`,
+                  `Failed to close or serialize segment %s. We are catching the error but data might be lost.`,
+                  subsegment?.name,
                   error
                 );
               }
@@ -501,7 +502,8 @@ class Tracer extends Utility implements TracerInterface {
                 subsegment?.close();
               } catch (error) {
                 console.warn(
-                  `Failed to close or serialize segment, ${subsegment?.name}. We are catching the error but data might be lost.`,
+                  `Failed to close or serialize segment %s. We are catching the error but data might be lost.`,
+                  subsegment?.name,
                   error
                 );
               }

diff --git a/packages/tracer/src/middleware/middy.ts b/packages/tracer/src/middleware/middy.ts
@@ -74,7 +74,8 @@ const captureLambdaHandler = (
       handlerSegment.close();
     } catch (error) {
       console.warn(
-        `Failed to close or serialize segment, ${handlerSegment.name}. We are catching the error but data might be lost.`,
+        `Failed to close or serialize segment %s. We are catching the error but data might be lost.`,
+        handlerSegment.name,
         error
       );
     }

diff --git a/packages/tracer/tests/unit/Tracer.test.ts b/packages/tracer/tests/unit/Tracer.test.ts
@@ -1253,7 +1253,8 @@ describe('Class: Tracer', () => {
       expect(closeSpy).toHaveBeenCalledTimes(1);
       expect(logWarningSpy).toHaveBeenNthCalledWith(
         1,
-        `Failed to close or serialize segment, ${handlerSubsegment.name}. We are catching the error but data might be lost.`,
+        `Failed to close or serialize segment %s. We are catching the error but data might be lost.`,
+        handlerSubsegment.name,
         new Error('dummy error')
       );
     });
@@ -1714,7 +1715,8 @@ describe('Class: Tracer', () => {
       expect(closeSpy).toHaveBeenCalledTimes(1);
       expect(logWarningSpy).toHaveBeenNthCalledWith(
         1,
-        `Failed to close or serialize segment, ${handlerSubsegment.name}. We are catching the error but data might be lost.`,
+        `Failed to close or serialize segment %s. We are catching the error but data might be lost.`,
+        handlerSubsegment.name,
         new Error('dummy error')
       );
     });

diff --git a/packages/tracer/tests/unit/middy.test.ts b/packages/tracer/tests/unit/middy.test.ts
@@ -391,7 +391,8 @@ describe('Middy middleware', () => {
     expect(closeSpy).toHaveBeenCalledTimes(1);
     expect(logWarningSpy).toHaveBeenNthCalledWith(
       1,
-      `Failed to close or serialize segment, ${handlerSubsegment.name}. We are catching the error but data might be lost.`,
+      `Failed to close or serialize segment %s. We are catching the error but data might be lost.`,
+      handlerSubsegment.name,
       new Error('dummy error')
     );
     // Check that the segments are restored