feat: add hash code to request query parameter (#25)

Co-authored-by: xiaoweii <xiaoweii@amazom.com>

Author: zhu-xiaowei

src/network/NetRequest.ts

@@ -12,6 +12,7 @@
  */
 import { ConsoleLogger as Logger } from '@aws-amplify/core';
 import { ClickstreamContext } from '../provider';
+import { HashUtil } from '../util/HashUtil';
 
 const logger = new Logger('NetRequest');
 
@@ -30,10 +31,12 @@ export class NetRequest {
 		timeout = NetRequest.REQUEST_TIMEOUT
 	): Promise<boolean> {
 		const { configuration, browserInfo } = context;
+		const eventsHash = await HashUtil.getHashCode(eventsJson);
 		const queryParams = new URLSearchParams({
 			platform: 'Web',
 			appId: configuration.appId,
 			event_bundle_sequence_id: bundleSequenceId.toString(),
+			hashCode: eventsHash,
 		});
 		const url = `${configuration.endpoint}?${queryParams.toString()}`;
 

src/provider/AnalyticsEventBuilder.ts

@@ -60,7 +60,6 @@ export class AnalyticsEventBuilder {
 
 		const items = this.getEventItemsWithCheck(event.items, attributes);
 		return {
-			hashCode: '',
 			event_type: event.name,
 			event_id: uuidV4(),
 			device_id: StorageUtil.getDeviceId(),

src/provider/ClickstreamProvider.ts

@@ -33,7 +33,6 @@ import {
 	SendMode,
 	UserAttribute,
 } from '../types';
-import { HashUtil } from '../util/HashUtil';
 import { StorageUtil } from '../util/StorageUtil';
 
 const logger = new Logger('ClickstreamProvider');
@@ -140,14 +139,7 @@ export class ClickstreamProvider implements AnalyticsProvider {
 	}
 
 	recordEvent(event: AnalyticsEvent, isImmediate = false) {
-		HashUtil.getHashCode(JSON.stringify(event))
-			.then(hashCode => {
-				event.hashCode = hashCode;
-				this.eventRecorder.record(event, isImmediate);
-			})
-			.catch(error => {
-				logger.error(`Create hash code failed with ${error}`);
-			});
+		this.eventRecorder.record(event, isImmediate);
 	}
 
 	setUserId(userId: string | null) {

src/provider/Event.ts

@@ -85,7 +85,7 @@ export class Event {
 	static readonly Constants = {
 		PREFIX: '[',
 		SUFFIX: ']',
-		LAST_EVENT_IDENTIFIER: '},{"hashCode":',
+		LAST_EVENT_IDENTIFIER: '},{"event_type":',
 		KEYWORDS: ['q', 's', 'search', 'query', 'keyword'],
 	};
 }

src/types/Analytics.ts

@@ -80,7 +80,6 @@ export interface ClickstreamEvent {
 }
 
 export interface AnalyticsEvent {
-	hashCode?: string;
 	unique_id: string;
 	event_type: string;
 	event_id: string;

test/ClickstreamAnalytics.test.ts

@@ -17,18 +17,18 @@ import { Event } from '../src/provider';
 import { StorageUtil } from '../src/util/StorageUtil';
 
 describe('ClickstreamAnalytics test', () => {
-	const mockSendRequestSuccess = jest.fn().mockResolvedValue(true);
-
 	beforeEach(() => {
 		localStorage.clear();
+		const mockSendRequestSuccess = jest.fn().mockResolvedValue(true);
 		jest
 			.spyOn(NetRequest, 'sendRequest')
 			.mockImplementation(mockSendRequestSuccess);
 	});
 
 	afterEach(() => {
 		ClickstreamAnalytics['provider'] = undefined;
-		jest.resetAllMocks();
+		jest.restoreAllMocks();
+		jest.clearAllMocks();
 	});
 
 	test('test init sdk', () => {

test/network/NetRequest.test.ts

@@ -16,6 +16,7 @@ import { BrowserInfo } from '../../src/browser';
 import { NetRequest } from '../../src/network/NetRequest';
 import { AnalyticsEventBuilder, ClickstreamContext } from '../../src/provider';
 import { Session } from '../../src/tracker';
+import { HashUtil } from '../../src/util/HashUtil';
 
 describe('ClickstreamAnalytics test', () => {
 	let context: ClickstreamContext;
@@ -85,4 +86,22 @@ describe('ClickstreamAnalytics test', () => {
 		const result = await NetRequest.sendRequest(eventJson, context, 1, 1, 200);
 		expect(result).toBeFalsy();
 	});
+
+	test('test request success with hash code', async () => {
+		fetchMock.post('begin:https://localhost:8080/collect', {
+			status: 200,
+			body: [],
+		});
+		const mockFetch = jest.spyOn(global, 'fetch');
+
+		const eventJsonHashCode = await HashUtil.getHashCode(eventJson);
+		const result = await NetRequest.sendRequest(eventJson, context, 1);
+		expect(result).toBeTruthy();
+
+		const [requestUrl] = mockFetch.mock.calls[0];
+		const requestHashCode = new URL(requestUrl.toString()).searchParams.get(
+			'hashCode'
+		);
+		expect(eventJsonHashCode).toBe(requestHashCode);
+	});
 });

test/provider/AnalyticsEventBuilder.test.ts

@@ -46,7 +46,7 @@ describe('AnalyticsEventBuilder test', () => {
 			{},
 			Session.getCurrentSession(context)
 		);
-		expect(event.hashCode.length).toBe(0);
+		expect((event as any).hashCode).toBeUndefined();
 		expect(event.event_type).toBe('testEvent');
 		expect(event.event_id.length > 0).toBeTruthy();
 		expect(event.device_id.length > 0).toBeTruthy();

test/provider/BatchModeTimer.test.ts

@@ -10,16 +10,16 @@
  *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
  *  and limitations under the License.
  */
+import { SendMode } from '../../src';
 import { NetRequest } from '../../src/network/NetRequest';
 import { ClickstreamProvider } from '../../src/provider';
-import { SendMode } from '../../src/types';
 
 describe('ClickstreamProvider timer test', () => {
 	let provider: ClickstreamProvider;
-	const mockSendRequest = jest.fn().mockResolvedValue(true);
 	beforeEach(() => {
 		localStorage.clear();
 		provider = new ClickstreamProvider();
+		const mockSendRequest = jest.fn().mockResolvedValue(true);
 		jest.spyOn(NetRequest, 'sendRequest').mockImplementation(mockSendRequest);
 	});
 

test/provider/ClickstreamProvider.test.ts

@@ -29,9 +29,11 @@ describe('ClickstreamProvider test', () => {
 	let mockProviderCreateEvent: any;
 	let mockCreateEvent: any;
 	let mockRecordProfileSet: any;
-	const mockSendRequest = jest.fn().mockResolvedValue(true);
-	beforeEach(() => {
+
+	beforeEach(async () => {
 		localStorage.clear();
+		const mockSendRequest = jest.fn().mockResolvedValue(true);
+		jest.spyOn(NetRequest, 'sendRequest').mockImplementation(mockSendRequest);
 		provider = new ClickstreamProvider();
 		provider.configure({
 			appId: 'testAppId',
@@ -40,7 +42,6 @@ describe('ClickstreamProvider test', () => {
 		mockProviderCreateEvent = jest.spyOn(provider, 'createEvent');
 		mockCreateEvent = jest.spyOn(AnalyticsEventBuilder, 'createEvent');
 		mockRecordProfileSet = jest.spyOn(provider, 'recordProfileSet');
-		jest.spyOn(NetRequest, 'sendRequest').mockImplementation(mockSendRequest);
 	});
 
 	afterEach(() => {
@@ -49,7 +50,8 @@ describe('ClickstreamProvider test', () => {
 		jest.clearAllMocks();
 	});
 
-	test('test default value', () => {
+	test('test default value', async () => {
+		await sleep(100);
 		expect(provider.configuration.appId).toBe('testAppId');
 		expect(provider.configuration.endpoint).toBe('https://example.com/collect');
 		expect(provider.configuration.sendMode).toBe(SendMode.Immediate);
@@ -296,4 +298,8 @@ describe('ClickstreamProvider test', () => {
 		});
 		expect(provider.globalAttributes['_channel']).toBeUndefined();
 	});
+
+	function sleep(ms: number): Promise<void> {
+		return new Promise(resolve => setTimeout(resolve, ms));
+	}
 });