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..ac6ce9f7ae 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/${version}`); + }); + describe('Function: customUserAgentMiddleware', () => { it('returns a middleware function', () => { // Prepare