feat: support configure tracking _app_start and _app_end events (#42)

Co-authored-by: xiaoweii <[email protected]>

Author: zhu-xiaowei

README.md

@@ -157,6 +157,8 @@ ClickstreamAnalytics.init({
    isTrackSearchEvents: true,
    isTrackScrollEvents: true,
    isTrackPageLoadEvents: true,
+   isTrackAppStartEvents: true,
+   isTrackAppEndEvents: true,
    pageType: PageType.SPA,
    isLogEvents: false,
    authCookie: "your auth cookie",
@@ -178,6 +180,8 @@ Here is an explanation of each property:
 - **isTrackSearchEvents**: whether auto record search result page events in browser, default is `true`
 - **isTrackScrollEvents**: whether auto record page scroll events in browser, default is `true`
 - **isTrackPageLoadEvents**: whether auto record page load performance events in browser, default is `false`
+- **isTrackAppStartEvents**: whether auto record app start events in browser when pages becomes visible, default is `false`
+- **isTrackAppEndEvents**: whether auto record app end events in browser when pages becomes invisible, default is `false`
 - **pageType**: the website type, `SPA` for single page application, `multiPageApp` for multiple page application, default is `SPA`. This attribute works only when the attribute `isTrackPageViewEvents`'s value is `true`
 - **isLogEvents**: whether to print out event json for debugging, default is false.
 - **authCookie**: your auth cookie for AWS application load balancer auth cookie.
@@ -200,6 +204,8 @@ ClickstreamAnalytics.updateConfigure({
   isTrackScrollEvents: false,
   isTrackSearchEvents: false,
   isTrackPageLoadEvents: false,
+  isTrackAppStartEvents: true,
+  isTrackAppStartEvents: true,
 });
 ```
 

src/provider/ClickstreamProvider.ts

@@ -62,6 +62,8 @@ export class ClickstreamProvider implements AnalyticsProvider {
 			isTrackSearchEvents: true,
 			isTrackScrollEvents: true,
 			isTrackPageLoadEvents: false,
+			isTrackAppStartEvents: false,
+			isTrackAppEndEvents: false,
 			pageType: PageType.SPA,
 			isLogEvents: false,
 			sessionTimeoutDuration: 1800000,

src/tracker/SessionTracker.ts

@@ -71,6 +71,7 @@ export class SessionTracker extends BaseTracker {
 			pageViewTracker.setIsEntrances();
 			this.provider.record({ name: Event.PresetEvent.SESSION_START });
 		}
+		if (!this.provider.configuration.isTrackAppStartEvents) return;
 		if (isFirstTime && this.isFromCurrentHost()) return;
 		if (isFirstTime && BrowserInfo.isFromReload()) return;
 		this.provider.record({
@@ -99,6 +100,7 @@ export class SessionTracker extends BaseTracker {
 	}
 
 	recordAppEnd(isImmediate: boolean) {
+		if (!this.provider.configuration.isTrackAppEndEvents) return;
 		this.provider.record({
 			name: Event.PresetEvent.APP_END,
 			isImmediate: isImmediate,

src/types/Analytics.ts

@@ -32,6 +32,8 @@ export interface Configuration {
 	isTrackScrollEvents?: boolean;
 	isTrackSearchEvents?: boolean;
 	isTrackPageLoadEvents?: boolean;
+	isTrackAppStartEvents?: boolean;
+	isTrackAppEndEvents?: boolean;
 }
 
 export enum SendMode {

test/provider/ImmediateModeCache.test.ts

@@ -44,7 +44,7 @@ describe('ImmediateModeCache test', () => {
 		const failedEvents = JSON.parse(
 			StorageUtil.getFailedEvents() + Event.Constants.SUFFIX
 		);
-		expect(failedEvents.length).toBeGreaterThan(4);
+		expect(failedEvents.length).toBeGreaterThan(3);
 		const mockSendRequestSuccess = jest.fn().mockResolvedValue(true);
 		jest
 			.spyOn(NetRequest, 'sendRequest')

test/tracker/SessionTracker.test.ts

@@ -71,6 +71,8 @@ describe('SessionTracker test', () => {
 	test('test initial state for setUp', () => {
 		const pageAppearMock = jest.spyOn(sessionTracker, 'onPageAppear');
 		sessionTracker.setUp();
+		expect(provider.configuration.isTrackAppStartEvents).toBe(false);
+		expect(provider.configuration.isTrackAppEndEvents).toBe(false);
 		expect(StorageUtil.getIsFirstOpen()).toBe(false);
 
 		expect(recordMethodMock).toBeCalledWith({
@@ -80,7 +82,7 @@ describe('SessionTracker test', () => {
 		expect(recordMethodMock).toBeCalledWith({
 			name: Event.PresetEvent.SESSION_START,
 		});
-		expect(recordMethodMock).toBeCalledWith({
+		expect(recordMethodMock).not.toBeCalledWith({
 			name: Event.PresetEvent.APP_START,
 			attributes: {
 				[Event.ReservedAttribute.IS_FIRST_TIME]: true,
@@ -93,7 +95,19 @@ describe('SessionTracker test', () => {
 		expect(session.isNewSession()).toBeTruthy();
 	});
 
+	test('test enable app start', () => {
+		provider.configuration.isTrackAppStartEvents = true;
+		sessionTracker.setUp();
+		expect(recordMethodMock).toBeCalledWith({
+			name: Event.PresetEvent.APP_START,
+			attributes: {
+				[Event.ReservedAttribute.IS_FIRST_TIME]: true,
+			},
+		});
+	});
+
 	test('test multi page mode record app start when setUp', () => {
+		provider.configuration.isTrackAppStartEvents = true;
 		Object.assign(provider.configuration, {
 			pageType: PageType.multiPageApp,
 		});
@@ -107,6 +121,7 @@ describe('SessionTracker test', () => {
 	});
 
 	test('test multi page mode not record app start when come from the same host name', () => {
+		provider.configuration.isTrackAppStartEvents = true;
 		Object.assign(provider.configuration, {
 			pageType: PageType.multiPageApp,
 		});
@@ -220,6 +235,7 @@ describe('SessionTracker test', () => {
 	});
 
 	test('test send event in batch mode when close window', async () => {
+		provider.configuration.isTrackAppEndEvents = true;
 		const sendEventBackgroundMock = jest.spyOn(
 			eventRecorder,
 			'sendEventsInBackground'
@@ -229,7 +245,6 @@ describe('SessionTracker test', () => {
 			sessionTracker,
 			'recordUserEngagement'
 		);
-		const recordAppEndMock = jest.spyOn(sessionTracker, 'recordAppEnd');
 		sessionTracker.setUp();
 		provider.record({ name: 'testEvent' });
 		await sleep(100);
@@ -238,7 +253,10 @@ describe('SessionTracker test', () => {
 		expect(sendEventBackgroundMock).toBeCalledWith(true);
 		expect(clearAllEventsMock).toBeCalled();
 		expect(recordUserEngagementMock).toBeCalledWith(true);
-		expect(recordAppEndMock).toBeCalledWith(true);
+		expect(recordMethodMock).toBeCalledWith({
+			name: Event.PresetEvent.APP_END,
+			isImmediate: true,
+		});
 	});
 
 	test('test send event in batch mode when hide window in firefox', async () => {
@@ -267,6 +285,7 @@ describe('SessionTracker test', () => {
 	});
 
 	test('test send event in batch mode when close window in firefox', async () => {
+		provider.configuration.isTrackAppEndEvents = true;
 		const sendEventBackgroundMock = jest.spyOn(
 			eventRecorder,
 			'sendEventsInBackground'
@@ -275,7 +294,6 @@ describe('SessionTracker test', () => {
 			sessionTracker,
 			'recordUserEngagement'
 		);
-		const recordAppEndMock = jest.spyOn(sessionTracker, 'recordAppEnd');
 		Object.defineProperty(navigator, 'userAgent', {
 			writable: true,
 			value: 'firefox',
@@ -287,7 +305,10 @@ describe('SessionTracker test', () => {
 		hidePage();
 		expect(sendEventBackgroundMock).not.toBeCalled();
 		expect(recordUserEngagementMock).toBeCalledWith(false);
-		expect(recordAppEndMock).toBeCalledWith(false);
+		expect(recordMethodMock).not.toBeCalledWith({
+			name: Event.PresetEvent.APP_END,
+			isImmediate: true,
+		});
 	});
 
 	test('test send failed event in immediate mode when hide page', async () => {