Skip to content

chore: always append PTEnv to UA string #4522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 22, 2025
Merged

chore: always append PTEnv to UA string #4522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e23d224
chore: always append env to UA
dreamorosi Sep 22, 2025
bb02a5d
test: update unit tests
dreamorosi Sep 22, 2025
7aa6f56
Merge branch 'main' into chore/ua_env
dreamorosi Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/commons/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { PT_VERSION } from './version.js';

const env = process.env.AWS_EXECUTION_ENV || 'NA';
if (!process.env.AWS_SDK_UA_APP_ID) {
process.env.AWS_SDK_UA_APP_ID = `PT/TEST/${PT_VERSION}`;
process.env.AWS_SDK_UA_APP_ID = `PT/NO-OP/${PT_VERSION}/PTEnv/${env}`;
} else {
process.env.AWS_SDK_UA_APP_ID = `${process.env.AWS_SDK_UA_APP_ID}/PT/TEST/${PT_VERSION}`;
process.env.AWS_SDK_UA_APP_ID = `${process.env.AWS_SDK_UA_APP_ID}/PT/NO-OP/${PT_VERSION}/PTEnv/${env}`;
}

export { addUserAgentMiddleware, isSdkClient } from './awsSdkUtils.js';
Expand Down
4 changes: 3 additions & 1 deletion packages/commons/tests/unit/awsSdkUtils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ 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}`);
expect(process.env.AWS_SDK_UA_APP_ID).toEqual(
`test/PT/NO-OP/${version}/PTEnv/NA`
);
});

describe('Function: customUserAgentMiddleware', () => {
Expand Down