backward compatibility with the existing "Personalization" method

Author: haoAddsearch

README.md

@@ -335,13 +335,47 @@ client.setAnalyticsTag('Navigation search');
 
 ### Personalization
 
+#### Enable personalization tracking
+Enable personalization tracking, personalization token will be included in every stat events as "session ID". <br/>
+
+Set stats session ID if personalization token is generated by your site.
+```js
+client.setStatsSessionId(id);
+```
+
+If session ID is not set, a UUID is generated and stored in AddSearch's cookie. Cookie's name: addsearchPersonalizationToken
+Specify how many days personalization token stay in cookie. By default, it's 180 days.
+```js
+// Defaults - isEnabled: false, expirationDays: 180
+client.enablePersonalizationTracking(isEnabled, expirationDays);
+```
+
+
+#### Allow storing personalization token in cookie
+By default, the value is true. Set it to false when users disallow usage of functional/analytics cookie. <br/>
+This method is used when you have a cookie consent popup, and a function handler in case users rejects usage of personalization cookie.
+```js
+// Default: true
+client.consentAddSearchCookie(false);
+```
+
+
 #### Set user token (for personalized search results)
 ```js
 // Add a user token to the search request (if personalization in use)
-client.setUserToken('uuid');
+client.setUserToken('Personalization token');
 ```
 
-#### Send personalization events with search query
+
+#### Get personalization token from AddSearch cookie
+Get the personalization token which is stored in AddSearch cookie (if available).
+```js
+// Get a personalization token
+client.getPersonalizationToken();
+```
+
+
+#### Send personalization events with search query - deprecated
 In personalized search, user events are typically sent to AddSearch via API and a user token
 is passed with the search query (see setUserToken function). 
 An alternative way is to send user events needed for personalization with the search query.
@@ -359,40 +393,6 @@ client.setPersonalizationEvents(events);
 ```
 
 
-### Advanced Personalization
-
-#### Set personalization token
-Set personalization token (for personalized search results). <br/>
-Use this method when personalization token is generated by your website.
-```js
-// Add a personalization token to the search/click event (if personalization in use)
-client.setPersonalizationToken('personalization_token');
-```
-
-#### Get personalization token from AddSearch cookie
-Get the personalization token which is stored in AddSearch cookie (if available).
-```js
-// Add a personalization token to the stat events
-client.getPersonalizationTokenInCookie();
-```
-
-#### Enable personalization tracking
-Enable personalization tracking, personalization token will be included in every stat events. <br/>
-If personalization token is not set, a UUID is generated and will be sent to AddSearch's cookie.
-Specify how many days personalization token stay in cookie. By default, it's 180 days.
-```js
-// Defaults - isEnabled: false, expirationDays: 180
-client.enablePersonalizationTracking(isEnabled, expirationDays);
-```
-
-#### Enable AddSearch cookie
-Set it to false when users disallow usage of cookie. <br/>
-This method is used when you have a cookie consent popup, and a function handler in case users disallow usage of personalization cookie.
-```js
-// Default: true
-client.enableAddSearchCookie(isAllowedToSendCookie);
-```
-
 
 ### Other
 

src/index.js

@@ -17,8 +17,7 @@ var client = function(sitekey, privatekey) {
   this.apiHostname = API_HOSTNAME;
   this.settings = new Settings();
   this.sessionId = ('a-' + (Math.random() * 100000000)).substring(0, 10);
-  this.personalizationToken = null;
-  var personalizationToken = undefined;
+  this.personalizationToken = cookie.getCookie(PERSONALIZATION_TOKEN_COOKIE_NAME) || util.generateUUID();
 
   /**
    * Fetch search results
@@ -204,28 +203,25 @@ var client = function(sitekey, privatekey) {
   this.setCollectAnalytics = function(collectAnalytics) {this.settings.setCollectAnalytics(collectAnalytics);}
   this.setAnalyticsTag = function(tagName) {this.settings.setAnalyticsTag(tagName)}
   this.setThrottleTime = function(delay) {this.settings.setThrottleTime(delay);}
-  this.setStatsSessionId = function(id) {this.sessionId = id;}
+  this.setStatsSessionId = function(id) {
+    this.sessionId = id;
+    this.personalizationToken = id;
+  }
   this.getStatsSessionId = function() {return this.sessionId;}
   this.enableLogicalOperators = function(enableLogicalOperators) {this.settings.enableLogicalOperators(enableLogicalOperators)};
   this.setSearchOperator = function(operator) {this.settings.setSearchOperator(operator)};
 
   this.sendStatsEvent = function(type, keyword, data) {
 
-
-    if (!personalizationToken && isAddSearchCookieEnabled) {
-      personalizationToken = cookie.getCookie(PERSONALIZATION_TOKEN_COOKIE_NAME);
-
-      if (!personalizationToken) {
-        personalizationToken = util.generateUUID();
-        cookie.setCookie(PERSONALIZATION_TOKEN_COOKIE_NAME, personalizationToken, personalizationCookieExpireDays);
-      }
+    var usePersonalizationToken = isPersonalizationTrackingEnabled && isAddSearchCookieConsented;
+    if (usePersonalizationToken && !cookie.getCookie(PERSONALIZATION_TOKEN_COOKIE_NAME)) {
+      cookie.setCookie(PERSONALIZATION_TOKEN_COOKIE_NAME, this.personalizationToken, personalizationCookieExpireDays);
     }
 
     if (type === 'search') {
       let payload = {
         action: 'search',
-        session: this.sessionId,
-        userToken: isPersonalizationTrackingEnabled ? personalizationToken : undefined,
+        session: usePersonalizationToken ? this.personalizationToken : this.sessionId,
         keyword: keyword,
         numberOfResults: data.numberOfResults,
         analyticsTag: this.getSettings().analyticsTag
@@ -236,8 +232,7 @@ var client = function(sitekey, privatekey) {
     else if (type === 'click') {
       let payload = {
         action: 'click',
-        session: this.sessionId,
-        userToken: isPersonalizationTrackingEnabled ? personalizationToken : undefined,
+        session: usePersonalizationToken ? this.personalizationToken : this.sessionId,
         keyword: keyword,
         docid: data.documentId,
         position: data.position,
@@ -255,13 +250,11 @@ var client = function(sitekey, privatekey) {
    * Personalization
    */
   var isPersonalizationTrackingEnabled = false;
-  var isAddSearchCookieEnabled = true;
+  var isAddSearchCookieConsented = true;
   var personalizationCookieExpireDays = 180;
 
-  this.setPersonalizationToken = function(userToken) { personalizationToken = userToken };
-
-  this.getPersonalizationTokenInCookie = function() {
-    return cookie.getCookie(PERSONALIZATION_TOKEN_COOKIE_NAME);
+  this.getPersonalizationToken = function() {
+    return this.personalizationToken;
   };
 
   this.enablePersonalizationTracking = function(isEnabled, cookieExpireDays) {
@@ -271,8 +264,8 @@ var client = function(sitekey, privatekey) {
     }
   };
 
-  this.enableAddSearchCookie = function(isEnabled) {
-    isAddSearchCookieEnabled = !!isEnabled;
+  this.consentAddSearchCookie = function(isEnabled) {
+    isAddSearchCookieConsented = !!isEnabled;
   };
 
 

src/util.js

@@ -41,7 +41,7 @@ const validateSetPagingParams = function(page, pageSize, sortBy, sortOrder) {
 }
 
 const generateUUID = function() {
-  return uuidv4();
+  return uuidv4().replace(/-/g, '');
 };
 
 module.exports = {