feat(analytics): Use custom user agent in all Analytics providers (#1…

…1410)
aws-amplify · May 27, 2023 · 9fe4a5e · 9fe4a5e
1 parent 9f290d5
commit 9fe4a5e
Show file tree

Hide file tree

Showing 8 changed files with 98 additions and 10 deletions.
diff --git a/packages/analytics/__tests__/Providers/CustomUserAgent.test.ts b/packages/analytics/__tests__/Providers/CustomUserAgent.test.ts
@@ -0,0 +1,70 @@
+import {
+	AmazonPersonalizeProvider,
+	AWSKinesisFirehoseProvider,
+	AWSKinesisProvider,
+	AWSPinpointProvider,
+} from '../../src/Providers';
+
+describe('Each provider client is configured with the custom user client', () => {
+	describe('AmazonPersonalizeProvider', () => {
+		test('received the custom user client', () => {
+			const provider = new AmazonPersonalizeProvider();
+			// Run init to setup the client
+			provider['_init']({ region: 'us-east-1' }, {});
+
+			expect(
+				provider['_personalize']['config']['customUserAgent']
+			).toMatchObject([
+				['aws-amplify', expect.any(String)],
+				['analytics', '1'],
+				['framework', '0'],
+			]);
+		});
+	});
+
+	describe('AWSKinesisFirehoseProvider', () => {
+		test('received the custom user client', () => {
+			const provider = new AWSKinesisFirehoseProvider();
+			// Run init to setup the client
+			provider['_init']({ region: 'us-east-1' }, {});
+
+			expect(
+				provider['_kinesisFirehose']['config']['customUserAgent']
+			).toMatchObject([
+				['aws-amplify', expect.any(String)],
+				['analytics', '1'],
+				['framework', '0'],
+			]);
+		});
+	});
+
+	describe('AWSKinesisProvider', () => {
+		test('received the custom user client', () => {
+			const provider = new AWSKinesisProvider();
+			// Run init to setup the client
+			provider['_init']({ region: 'us-east-1' }, {});
+
+			expect(provider['_kinesis']['config']['customUserAgent']).toMatchObject([
+				['aws-amplify', expect.any(String)],
+				['analytics', '1'],
+				['framework', '0'],
+			]);
+		});
+	});
+
+	describe('AWSPinpointProvider', () => {
+		test('received the custom user client', () => {
+			const provider = new AWSPinpointProvider({ region: 'us-east-1' });
+			// Run init to setup the client
+			provider['_initClients']({});
+
+			expect(
+				provider['pinpointClient']['config']['customUserAgent']
+			).toMatchObject([
+				['aws-amplify', expect.any(String)],
+				['analytics', '1'],
+				['framework', '0'],
+			]);
+		});
+	});
+});
diff --git a/packages/analytics/src/Providers/AWSKinesisFirehoseProvider.ts b/packages/analytics/src/Providers/AWSKinesisFirehoseProvider.ts
@@ -8,6 +8,7 @@ import {
 	FirehoseClient,
 } from '@aws-sdk/client-firehose';
 import { fromUtf8 } from '@aws-sdk/util-utf8-browser';
+import { getAnalyticsUserAgent } from '../utils/UserAgent';
 
 const logger = new Logger('AWSKineisFirehoseProvider');
 
@@ -97,6 +98,7 @@ export class AWSKinesisFirehoseProvider extends AWSKinesisProvider {
 			apiVersion: '2015-08-04',
 			region,
 			credentials,
+			customUserAgent: getAnalyticsUserAgent(),
 		});
 		return true;
 	}

diff --git a/packages/analytics/src/Providers/AWSKinesisProvider.ts b/packages/analytics/src/Providers/AWSKinesisProvider.ts
@@ -1,14 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import {
-	ConsoleLogger as Logger,
-	Credentials,
-	getAmplifyUserAgent,
-} from '@aws-amplify/core';
+import { ConsoleLogger as Logger, Credentials } from '@aws-amplify/core';
 import { KinesisClient, PutRecordsCommand } from '@aws-sdk/client-kinesis';
 import { AnalyticsProvider } from '../types';
 import { fromUtf8 } from '@aws-sdk/util-utf8-browser';
+import { getAnalyticsUserAgent } from '../utils/UserAgent';
 
 const logger = new Logger('AWSKinesisProvider');
 
@@ -224,7 +221,7 @@ export class AWSKinesisProvider implements AnalyticsProvider {
 		this._kinesis = new KinesisClient({
 			region,
 			credentials,
-			customUserAgent: getAmplifyUserAgent(),
+			customUserAgent: getAnalyticsUserAgent(),
 			endpoint,
 		});
 		return true;

diff --git a/packages/analytics/src/Providers/AWSPinpointProvider.ts b/packages/analytics/src/Providers/AWSPinpointProvider.ts
@@ -7,7 +7,6 @@ import {
 	Credentials,
 	Signer,
 	Hub,
-	getAmplifyUserAgent,
 	transferKeyToLowerCase,
 	transferKeyToUpperCase,
 } from '@aws-amplify/core';
@@ -30,6 +29,7 @@ import {
 } from '../types';
 import { v1 as uuid } from 'uuid';
 import EventsBuffer from './EventBuffer';
+import { getAnalyticsUserAgent } from '../utils/UserAgent';
 
 const AMPLIFY_SYMBOL = (
 	typeof Symbol !== 'undefined' && typeof Symbol.for === 'function'
@@ -517,7 +517,7 @@ export class AWSPinpointProvider implements AnalyticsProvider {
 		this.pinpointClient = new PinpointClient({
 			region,
 			credentials,
-			customUserAgent: getAmplifyUserAgent(),
+			customUserAgent: getAnalyticsUserAgent(),
 		});
 
 		// TODO: remove this middleware once a long term fix is implemented by aws-sdk-js team.

diff --git a/packages/analytics/src/Providers/AmazonPersonalizeProvider.ts b/packages/analytics/src/Providers/AmazonPersonalizeProvider.ts
@@ -4,7 +4,6 @@
 import {
 	ConsoleLogger as Logger,
 	Credentials,
-	getAmplifyUserAgent,
 	browserOrNode,
 } from '@aws-amplify/core';
 import {
@@ -23,6 +22,7 @@ import get from 'lodash/get';
 import isEmpty from 'lodash/isEmpty';
 import isEqual from 'lodash/isEqual';
 import { AnalyticsProvider } from '../types';
+import { getAnalyticsUserAgent } from '../utils/UserAgent';
 
 const logger = new Logger('AmazonPersonalizeProvider');
 
@@ -372,7 +372,7 @@ export class AmazonPersonalizeProvider implements AnalyticsProvider {
 		this._personalize = new PersonalizeEventsClient({
 			region,
 			credentials,
-			customUserAgent: getAmplifyUserAgent(),
+			customUserAgent: getAnalyticsUserAgent(),
 		});
 		return true;
 	}

diff --git a/packages/analytics/src/utils/UserAgent.ts b/packages/analytics/src/utils/UserAgent.ts
@@ -0,0 +1,12 @@
+import {
+	AnalyticsAction,
+	Category,
+	getAmplifyUserAgent,
+} from '@aws-amplify/core';
+
+export function getAnalyticsUserAgent() {
+	return getAmplifyUserAgent({
+		category: Category.Analytics,
+		action: AnalyticsAction.Record,
+	});
+}
diff --git a/packages/core/src/Platform/types.ts b/packages/core/src/Platform/types.ts
@@ -28,6 +28,7 @@ export enum Framework {
 export enum Category {
 	API = 'api',
 	Auth = 'auth',
+	Analytics = 'analytics',
 	DataStore = 'datastore',
 	Geo = 'geo',
 	Interactions = 'interactions',
@@ -40,6 +41,9 @@ export enum Category {
 
 // Actions
 /* TODO: Replace 'None' with all expected Actions */
+export enum AnalyticsAction {
+	Record = '1',
+}
 export enum ApiAction {
 	None = '0',
 }
@@ -74,6 +78,7 @@ export enum StorageAction {
 type ActionMap = {
 	[Category.Auth]: AuthAction;
 	[Category.API]: ApiAction;
+	[Category.Analytics]: AnalyticsAction;
 	[Category.DataStore]: DataStoreAction;
 	[Category.Geo]: GeoAction;
 	[Category.Interactions]: InteractionsAction;
@@ -98,6 +103,7 @@ export type CustomUserAgentDetails =
 	| (CustomUserAgentDetailsBase & { category?: never; action?: never })
 	| UserAgentDetailsWithCategory<Category.API>
 	| UserAgentDetailsWithCategory<Category.Auth>
+	| UserAgentDetailsWithCategory<Category.Analytics>
 	| UserAgentDetailsWithCategory<Category.DataStore>
 	| UserAgentDetailsWithCategory<Category.Geo>
 	| UserAgentDetailsWithCategory<Category.Interactions>

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -43,6 +43,7 @@ export {
 export {
 	ApiAction,
 	AuthAction,
+	AnalyticsAction,
 	Category,
 	CustomUserAgentDetails,
 	DataStoreAction,