Skip to content

chore(commons): update Powertools UA middleware detection #1762

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 2 commits into from
Oct 21, 2023
Merged

chore(commons): update Powertools UA middleware detection #1762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23fc049
chore(commons): fix double ua detection
dreamorosi Oct 21, 2023
48caaa9
chore(commons): fix unit test
dreamorosi Oct 21, 2023
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
25 changes: 18 additions & 7 deletions packages/commons/src/awsSdk/userAgentMiddleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,25 @@ const customUserAgentMiddleware = (feature: string) => {
};
};

/**
* @internal
* Checks if the middleware stack already has the Powertools UA middleware
*/
const hasPowertools = (middlewareStack: string[]): boolean => {
let found = false;
for (const middleware of middlewareStack) {
if (middleware.includes('addPowertoolsToUserAgent')) {
found = true;
}
}

return found;
};

const addUserAgentMiddleware = (client: unknown, feature: string): void => {
try {
if (isSdkClient(client)) {
if (
client.middlewareStack
.identify()
.includes('addPowertoolsToUserAgent: POWERTOOLS,USER_AGENT')
) {
if (hasPowertools(client.middlewareStack.identify())) {
return;
}
client.middlewareStack.addRelativeTo(
Expand All @@ -49,8 +60,8 @@ const addUserAgentMiddleware = (client: unknown, feature: string): void => {
`The client provided does not match the expected interface`
);
}
} catch (e) {
console.warn('Failed to add user agent middleware', e);
} catch (error) {
console.warn('Failed to add user agent middleware', error);
}
};

Expand Down
4 changes: 3 additions & 1 deletion packages/commons/tests/unit/awsSdk.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ describe('Helpers: awsSdk', () => {
// Prepare
const client = {
middlewareStack: {
identify: () => 'addPowertoolsToUserAgent: POWERTOOLS,USER_AGENT',
identify: () => [
'addPowertoolsToUserAgent: after getUserAgentMiddleware',
],
addRelativeTo: jest.fn(),
},
send: jest.fn(),
Expand Down