feat: add auto track events

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

Author: zhu-xiaowei

.gitignore

@@ -18,5 +18,6 @@ yarn-error.log
 yarn.lock
 *.tsbuildinfo
 *.tgz
+/src/config.ts
 
 build

LICENSE.txt

@@ -19,7 +19,7 @@ npm install @awslabs/clickstream-web
 For GitHub repository:
 
 ```bash
-npm install github:awslabs/clickstream-web
+npm install github:awslabs/clickstream-web#0.1.0
 ```
 
 Note: for beta version we use GitHub repository to distribute our SDK.
@@ -33,27 +33,10 @@ import { ClickstreamAnalytics, EventMode, PageType } from 'clickstream-web';
 ClickstreamAnalytics.configure({
    appId: "your appId",
    endpoint: "https://example.com/collect",
-   sendMode: EventMode.Batch,
-   sendEventsInterval: 5000,
-   isTrackPageViewEvents: true,
-   pageType: PageType.SPA,
-   isLogEvents: false,
-   authCookie: "your auth cookie",
-   sessionTimeoutDuration: 1800000
-)}
+)};
 ```
 
-Your `appId` and `endpoint` are already set up in it, here's an explanation of each property:
-
-- **appId (Required)**: the app id of your project in control plane. 
-- **endpoint (Required)**: the endpoint path you will upload the event to AWS server.
-- **sendMode**: EventMode.Immediate, EventMode.Batch, default is Immediate mode.
-- **sendEventsInterval**: event sending interval millisecond, works only bath send mode, the default value is `5000`
-- **isTrackPageViewEvents**: whether auto page view events in browser, default is `true`
-- **pageType**: the website type, `SPA` for single page application, `multiPageApp` for multipule page application, default is `SPA`. This attribute works only when the attribute `isTrackPageViewEvents`'s value ' is `true`.
-- **isLogEvents**: whether log events json, default is false.
-- **authCookie**: your auth cookie for AWS application load balancer auth cookie.
-- **sessionTimeoutDuration**: the duration for session timeout millisecond, default is 1800000
+Your `appId` and `endpoint` are already set up in it.
 
 ### Start using
 
@@ -94,6 +77,60 @@ ClickstreamAnalytics.setUserAttribute({
 
 Current login user‘s attributes will be cached in localStorage, so the next time browser open you don't need to set all user's attribute again, of course you can update the current user's attribute when it changes.
 
+#### Other configuration
+In addition to the required `appId` and `endpoint`, you can configure other information to get more customized usage:
+
+```typescript
+import { ClickstreamAnalytics, EventMode, PageType } from 'clickstream-web';
+
+ClickstreamAnalytics.configure({
+   appId: "your appId",
+   endpoint: "https://example.com/collect",
+   sendMode: EventMode.Batch,
+   sendEventsInterval: 5000,
+   isTrackPageViewEvents: true,
+   isTrackClickEvents: true,
+   isTrackSearchEvents: true,
+   isTrackScrollEvents: true,
+   pageType: PageType.SPA,
+   isLogEvents: false,
+   authCookie: "your auth cookie",
+   sessionTimeoutDuration: 1800000,
+)};
+```
+
+Here is an explanation of each property:
+
+- **appId (Required)**: the app id of your project in control plane.
+- **endpoint (Required)**: the endpoint path you will upload the event to AWS server.
+- **sendMode**: EventMode.Immediate, EventMode.Batch, default is Immediate mode.
+- **sendEventsInterval**: event sending interval millisecond, works only bath send mode, the default value is `5000`
+- **isTrackPageViewEvents**: whether auto record page view events in browser, default is `true`
+- **isTrackClickEvents**: whether auto record link click events in browser, default is `true`
+- **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`
+- **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 log events json, default is false.
+- **authCookie**: your auth cookie for AWS application load balancer auth cookie.
+- **sessionTimeoutDuration**: the duration for session timeout millisecond, default is 1800000
+
+#### Configuration update
+You can update the default configuration after initializing the SDK. We now support updating the following parameters:
+
+```typescript
+import { ClickstreamAnalytics } from 'clickstream-web';
+
+ClickstreamAnalytics.updateConfigure({
+  isLogEvents: true,
+  authCookie: 'your auth cookie',
+  isTrackPageViewEvents: false,
+  isTrackClickEvents: false,
+  isTrackScrollEvents: false,
+  isTrackSearchEvents: false,
+  searchKeyWords: ['product', 'class'],
+});
+```
+
 ## How to build&test locally
 
 **Build**

README.md

@@ -10,15 +10,16 @@
     "access": "public"
   },
   "scripts": {
-    "build": "npm run clean && npm run build:esm && npm run build:cjs",
+    "prebuild": "ts-node scripts/GenerateConfig.ts",
+    "build": "npm run prebuild && npm run clean && npm run build:esm && npm run build:cjs",
     "build-dev": "npm run clean && npx tsc && npx webpack --config webpack.config.dev.js",
     "build:cjs": "npx tsc --module commonjs && webpack && webpack --config webpack.config.dev.js",
     "build:esm": "npx tsc --module esnext --outDir lib-esm",
     "format": "npx prettier --check 'src/**/*.{js,ts}'",
     "lint": "npx eslint src",
-    "test": "npx jest -w 1 --coverage",
+    "test": "npm run prebuild && npx jest -w 1 --coverage",
     "clean": "rimraf lib-esm lib dist",
-    "pack": "npm pack"
+    "pack": "npm run prebuild && npm pack"
   },
   "dependencies": {
     "@aws-amplify/core": "^5.5.1",

package.json

@@ -0,0 +1,21 @@
+/**
+ *  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
+ *  with the License. A copy of the License is located at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
+ *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
+ *  and limitations under the License.
+ */
+import fs from 'fs';
+import { version } from '../package.json';
+
+const config = `{
+	sdkVersion: '${version}',
+};
+`;
+fs.writeFileSync('./src/config.ts', `export default ${config}`);
+console.log(`Version ${version} written to .env file.`);

scripts/GenerateConfig.ts

@@ -16,6 +16,7 @@ import {
 	ClickstreamAttribute,
 	ClickstreamConfiguration,
 	ClickstreamEvent,
+	Configuration,
 } from './types';
 
 export class ClickstreamAnalytics {
@@ -48,4 +49,8 @@ export class ClickstreamAnalytics {
 	public static setUserAttributes(attributes: ClickstreamAttribute) {
 		this.provider.setUserAttributes(attributes);
 	}
+
+	public static updateConfigure(configure: Configuration) {
+		this.provider.updateConfigure(configure);
+	}
 }

src/ClickstreamAnalytics.ts

@@ -16,7 +16,7 @@ import { ClickstreamContext } from '../provider';
 const logger = new Logger('NetRequest');
 
 export class NetRequest {
-	static readonly REQUEST_TIMEOUT = 3000;
+	static readonly REQUEST_TIMEOUT = 10000;
 	static readonly BATCH_REQUEST_TIMEOUT = 15000;
 	static readonly REQUEST_RETRY_TIMES = 3;
 	static readonly BATCH_REQUEST_RETRY_TIMES = 1;

src/network/NetRequest.ts

@@ -14,6 +14,7 @@ import { v4 as uuidV4 } from 'uuid';
 import { ClickstreamContext } from './ClickstreamContext';
 import { Event } from './Event';
 import { BrowserInfo } from '../browser';
+import config from '../config';
 import { Session } from '../tracker';
 import {
 	AnalyticsEvent,
@@ -24,6 +25,8 @@ import {
 import { HashUtil } from '../util/HashUtil';
 import { StorageUtil } from '../util/StorageUtil';
 
+const sdkVersion = config.sdkVersion;
+
 export class AnalyticsEventBuilder {
 	static async createEvent(
 		context: ClickstreamContext,
@@ -64,7 +67,7 @@ export class AnalyticsEventBuilder {
 			screen_height: window.innerHeight,
 			screen_width: window.innerWidth,
 			sdk_name: 'aws-solution-clickstream-sdk',
-			sdk_version: process.env.VERSION ?? '',
+			sdk_version: sdkVersion,
 			user: userAttributes ?? {},
 			attributes: attributes ?? {},
 		};