From 4827813cb29baadd5ed804a2c8c231f4cfb378ad Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Fri, 22 Aug 2025 15:06:17 +0200 Subject: [PATCH 1/2] chore(commons): concatenate PT UA to AWS_SDK_UA_APP_ID when one is set --- packages/commons/src/index.ts | 4 +++- packages/commons/tests/unit/awsSdkUtils.test.ts | 17 ++++++++--------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/packages/commons/src/index.ts b/packages/commons/src/index.ts index be11255615..44cbb30afd 100644 --- a/packages/commons/src/index.ts +++ b/packages/commons/src/index.ts @@ -1,7 +1,9 @@ import { PT_VERSION } from './version.js'; if (!process.env.AWS_SDK_UA_APP_ID) { - process.env.AWS_SDK_UA_APP_ID = `PT/NO-OP/${PT_VERSION}`; + process.env.AWS_SDK_UA_APP_ID = `PT/TEST/${PT_VERSION}`; +} else { + process.env.AWS_SDK_UA_APP_ID = `${process.env.AWS_SDK_UA_APP_ID}/PT/TEST/${PT_VERSION}`; } export { addUserAgentMiddleware, isSdkClient } from './awsSdkUtils.js'; diff --git a/packages/commons/tests/unit/awsSdkUtils.test.ts b/packages/commons/tests/unit/awsSdkUtils.test.ts index 7af7af9d3a..1d7c080a50 100644 --- a/packages/commons/tests/unit/awsSdkUtils.test.ts +++ b/packages/commons/tests/unit/awsSdkUtils.test.ts @@ -1,4 +1,4 @@ -import { beforeAll, describe, expect, it, vi } from 'vitest'; +import { describe, expect, it, vi } from 'vitest'; import { customUserAgentMiddleware } from '../../src/awsSdkUtils.js'; import { addUserAgentMiddleware, @@ -8,14 +8,11 @@ import { vi.hoisted(() => { process.env.AWS_EXECUTION_ENV = ''; + process.env.AWS_SDK_UA_APP_ID = 'test'; }); describe('Helpers: awsSdk', () => { describe('Function: userAgentMiddleware', () => { - beforeAll(() => { - vi.spyOn(console, 'warn').mockImplementation(() => ({})); - }); - it('handles gracefully failures in adding a middleware and only log a warning', () => { // Prepare const client = { @@ -25,13 +22,10 @@ describe('Helpers: awsSdk', () => { }, }, }; - const warningSpy = vi - .spyOn(console, 'warn') - .mockImplementation(() => ({})); // Act & Assess expect(() => addUserAgentMiddleware(client, 'my-feature')).not.toThrow(); - expect(warningSpy).toHaveBeenCalledTimes(1); + expect(console.warn).toHaveBeenCalledTimes(1); }); it('should return and do nothing if the client already has a Powertools UA middleware', async () => { @@ -88,6 +82,11 @@ describe('Helpers: awsSdk', () => { }); }); + it('concatenates the PT AWS_SDK_UA_APP_ID when one is already set', () => { + // Assess + expect(process.env.AWS_SDK_UA_APP_ID).toEqual('test/PT/TEST/2.25.1'); + }); + describe('Function: customUserAgentMiddleware', () => { it('returns a middleware function', () => { // Prepare From 2af6ba27b810597206f70e5c4f5dbdc16450204d Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Fri, 22 Aug 2025 17:43:52 +0200 Subject: [PATCH 2/2] Update awsSdkUtils.test.ts Co-authored-by: Swopnil Dangol --- packages/commons/tests/unit/awsSdkUtils.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/commons/tests/unit/awsSdkUtils.test.ts b/packages/commons/tests/unit/awsSdkUtils.test.ts index 1d7c080a50..ac6ce9f7ae 100644 --- a/packages/commons/tests/unit/awsSdkUtils.test.ts +++ b/packages/commons/tests/unit/awsSdkUtils.test.ts @@ -84,7 +84,7 @@ describe('Helpers: awsSdk', () => { it('concatenates the PT AWS_SDK_UA_APP_ID when one is already set', () => { // Assess - expect(process.env.AWS_SDK_UA_APP_ID).toEqual('test/PT/TEST/2.25.1'); + expect(process.env.AWS_SDK_UA_APP_ID).toEqual(`test/PT/TEST/${version}`); }); describe('Function: customUserAgentMiddleware', () => {