From 3e84c890de95f09c86eca461b521fff5d7e0a9a8 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Wed, 18 Oct 2023 13:49:49 +0200 Subject: [PATCH 1/2] chore(tracer): update warning in Tracer to better format segment name --- packages/tracer/src/Tracer.ts | 6 ++++-- packages/tracer/src/middleware/middy.ts | 3 ++- packages/tracer/tests/unit/Tracer.test.ts | 8 +++++--- packages/tracer/tests/unit/middy.test.ts | 3 ++- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/packages/tracer/src/Tracer.ts b/packages/tracer/src/Tracer.ts index adb4f3b92d..434c0d0f2c 100644 --- 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 ); } @@ -499,7 +500,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 index cc0477f01f..547561500f 100644 --- 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 index df6838ad13..870bc6bd09 100644 --- a/packages/tracer/tests/unit/Tracer.test.ts +++ b/packages/tracer/tests/unit/Tracer.test.ts @@ -22,7 +22,7 @@ type CaptureAsyncFuncMock = jest.SpyInstance< [ name: string, fcn: (subsegment?: Subsegment) => unknown, - parent?: Segment | Subsegment + parent?: Segment | Subsegment, ] >; const createCaptureAsyncFuncMock = function ( @@ -953,7 +953,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') ); }); @@ -1414,7 +1415,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 index dc7af9d553..c470b1d25a 100644 --- a/packages/tracer/tests/unit/middy.test.ts +++ b/packages/tracer/tests/unit/middy.test.ts @@ -405,7 +405,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 From c179f2542d58b55922747fa65dea8c76098774b4 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Wed, 18 Oct 2023 14:39:26 +0200 Subject: [PATCH 2/2] chore: linting --- packages/tracer/tests/unit/Tracer.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/tracer/tests/unit/Tracer.test.ts b/packages/tracer/tests/unit/Tracer.test.ts index 870bc6bd09..18eb37d24a 100644 --- a/packages/tracer/tests/unit/Tracer.test.ts +++ b/packages/tracer/tests/unit/Tracer.test.ts @@ -22,7 +22,7 @@ type CaptureAsyncFuncMock = jest.SpyInstance< [ name: string, fcn: (subsegment?: Subsegment) => unknown, - parent?: Segment | Subsegment, + parent?: Segment | Subsegment ] >; const createCaptureAsyncFuncMock = function (