fix: identity management, web push migration

Author: gyoshev

package.json

@@ -19,6 +19,7 @@
     "@types/jest": "^25.2.1",
     "@types/jquery": "^3.3.38",
     "@types/node": "^13.13.4",
+    "@types/sha.js": "^2.4.0",
     "@types/webpack": "^5",
     "@typescript-eslint/eslint-plugin": "^2.29.0",
     "@typescript-eslint/parser": "^2.29.0",
@@ -108,6 +109,7 @@
   "homepage": "https://github.com/Leanplum/Leanplum-JavaScript-SDK#readme",
   "dependencies": {
     "@qiwi/semrel-metabranch": "^3.1.2",
-    "clevertap-web-sdk": "^1.3.3"
+    "clevertap-web-sdk": "^1.3.3",
+    "sha.js": "2.4.9"
   }
 }

src/LeanplumInternal.ts

@@ -49,7 +49,6 @@ export default class LeanplumInternal {
     this._events
   )
   private _pushManager: PushManager = new PushManager(
-    this._events,
     this.createRequest.bind(this)
   )
   private _webPushOptions: WebPushOptions
@@ -86,19 +85,6 @@ export default class LeanplumInternal {
       (host: string) => this.setSocketHost(host))
     this._events.on('migrateStateReceived',
       (sha: string) => this._migration.verifyState(sha))
-
-    this._events.on('webPushSubscribed',
-      () => {
-        const serviceWorkerPath = this._webPushOptions?.serviceWorkerUrl
-        const path = serviceWorkerPath ? { serviceWorkerPath } : {}
-        this._ct && this._ct.notifications.push({
-          titleText: '',
-          bodyText: '',
-          okButtonText: '',
-          rejectButtonText: '',
-          ...path,
-        })
-      })
   }
 
   setApiPath(apiPath: string): void {
@@ -302,15 +288,25 @@ export default class LeanplumInternal {
     this._migration.getState((state: MigrationState) => {
       if (state === MigrationState.DUPLICATE) {
         this._ct = this._migration.initCleverTap()
+      } else if (state === MigrationState.CLEVERTAP) {
+        this._ct = this._migration.initCleverTap()
 
-        // silently register subscription in CT
+        // move subscription in CT
         this.isWebPushSubscribed().then((isSubscribed) => {
           if (isSubscribed) {
-            this._events.emit('webPushSubscribed')
+            this._pushManager.unsubscribeUser()
+
+            const serviceWorkerPath = this._webPushOptions?.serviceWorkerUrl
+            const path = serviceWorkerPath ? { serviceWorkerPath } : {}
+            this._ct && this._ct.notifications.push({
+              titleText: '',
+              bodyText: '',
+              okButtonText: '',
+              rejectButtonText: '',
+              ...path,
+            })
           }
         })
-      } else if (state === MigrationState.CLEVERTAP) {
-        this._ct = this._migration.initCleverTap()
 
         Object.values(Constants.DEFAULT_KEYS)
           .filter(key => ![

src/MigrationManager.ts

@@ -3,6 +3,7 @@ import { CreateRequestFunction, MigrationState } from './types/internal'
 import StorageManager from './StorageManager'
 import Constants from './Constants'
 import ArgsBuilder from './ArgsBuilder'
+import shajs from 'sha.js'
 
 type Region = 'eu1' | 'in1' | 'sg1' | 'us1' | 'sk1';
 
@@ -107,6 +108,11 @@ export default class MigrationManager {
 
     const argsDict = args?.buildDict() || {}
 
+    const userId = argsDict[Constants.PARAMS.USER_ID]
+    if (userId) {
+      this.identity.setUserId(userId)
+    }
+
     switch (action) {
       case Constants.METHODS.START:
         if (!this.identity.isAnonymous) {
@@ -143,7 +149,8 @@ export default class MigrationManager {
       )
 
     if (userId) {
-      Object.assign(attrs, { Identity: userId })
+      this.identity.setUserId(userId)
+      Object.assign(attrs, this.identity.profile)
       clevertap.onUserLogin.push({ Site: attrs })
     } else {
       clevertap.profile.push({ Site: attrs })
@@ -271,7 +278,9 @@ export class IdentityManager {
 
   public get cleverTapID(): string {
     if (this.userId !== this.anonymousLoginUserId && !this.isAnonymous) {
-      return `${this.deviceId}_${this.userId}`
+      const sha = this.sha256(this.userId)
+
+      return `${this.deviceId}_${sha}`
     }
 
     return this.deviceId
@@ -284,4 +293,10 @@ export class IdentityManager {
   public get isAnonymous(): boolean {
     return this.userId === this.deviceId
   }
+
+  private sha256(s: string): string {
+    const sha = new shajs.sha256().update(s).digest('hex')
+
+    return sha.substring(0, 10)
+  }
 }

src/PushManager.ts

@@ -16,7 +16,6 @@
  */
 
 import ArgsBuilder from './ArgsBuilder'
-import EventEmitter from './EventEmitter'
 import Constants from './Constants'
 import StorageManager from './StorageManager'
 import { CreateRequestFunction } from './types/internal'
@@ -35,7 +34,6 @@ export default class PushManager {
   }
 
   public constructor(
-    private events: EventEmitter,
     private createRequest: CreateRequestFunction
   ) { }
 
@@ -200,8 +198,6 @@ export default class PushManager {
       ) as string
 
       if (existingSubscriptionString !== preparedSubscriptionString) {
-        this.events.emit('webPushSubscribed')
-
         StorageManager.save(
           Constants.DEFAULT_KEYS.PUSH_SUBSCRIPTION,
           preparedSubscriptionString

test/specs/LeanplumIntegration.test.ts

@@ -94,20 +94,6 @@ describe('Integration Tests', () => {
     })
   })
 
-  it('pushes notification token when registering with LP', (done) => {
-    mockNextResponse(migrationResponses.DUPLICATE)
-    mockNextResponse(startResponse)
-
-    lp.start(async () => {
-      await lp.registerForWebPush('/sw.test.js')
-
-      // expect ct push to be registered, too
-      expect(clevertap.notifications.push).toHaveBeenCalled()
-
-      done()
-    })
-  })
-
   it('pushes previously registered notification token', (done) => {
     mockNextResponse(migrationResponses.LP)
     mockNextResponse(startResponse)
@@ -129,7 +115,7 @@ describe('Integration Tests', () => {
           sha256: 'changed-sha' // triggers config refresh
         }
       })
-      mockNextResponse(migrationResponses.DUPLICATE)
+      mockNextResponse(migrationResponses.CLEVERTAP)
       mockNextResponse(startResponse)
       lp.track('some-event')
       lpRequestMock.events.emit('migrateStateReceived', 'changed-sha');

test/specs/MigrationManager.test.ts

@@ -351,6 +351,29 @@ describe(MigrationManager, () => {
         }
       })
     })
+
+    it(`sends onUserLogin on start with userId parameter`, () => {
+      localStorage.setItem('__leanplum_device_id', 'anon1')
+      localStorage.setItem('__leanplum_user_id', 'anon1')
+      manager = new MigrationManager(createRequest)
+
+      setMigrationState(DUPLICATE)
+
+      jest.spyOn(clevertap.onUserLogin, 'push')
+
+      const args = new ArgsBuilder()
+      args.add('userId', 'john')
+
+      manager.duplicateRequest('start', args, {})
+
+      expect(clevertap.onUserLogin.push).toHaveBeenCalledTimes(1)
+      expect(clevertap.onUserLogin.push).toHaveBeenCalledWith({
+        Site: {
+          'Identity': 'john',
+          'tz': expect.any(String)
+        }
+      })
+    })
   })
 
   function setMigrationState(state: Object): void {

test/specs/PushManager.test.ts

@@ -1,5 +1,4 @@
 import Constants from '../../src/Constants'
-import EventEmitter from '../../src/EventEmitter'
 import PushManager from '../../src/PushManager'
 
 describe(PushManager, () => {
@@ -8,8 +7,7 @@ describe(PushManager, () => {
   const createRequestSpy: jest.Mock<() => void> = jest.fn()
 
   beforeEach(() => {
-    const events = new EventEmitter()
-    pushManager = new PushManager(events, createRequestSpy)
+    pushManager = new PushManager(createRequestSpy)
     windowMock = jest.spyOn(globalThis, 'window', 'get')
   })
 

yarn.lock

@@ -1389,6 +1389,13 @@
   dependencies:
     "@types/node" "*"
 
+"@types/sha.js@^2.4.0":
+  version "2.4.0"
+  resolved "https://registry.yarnpkg.com/@types/sha.js/-/sha.js-2.4.0.tgz#bce682ef860b40f419d024fa08600c3b8d24bb01"
+  integrity sha512-amxKgPy6WJTKuw8mpUwjX2BSxuBtBmZfRwIUDIuPJKNwGN8CWDli8JTg5ONTWOtcTkHIstvT7oAhhYXqEjStHQ==
+  dependencies:
+    "@types/node" "*"
+
 "@types/sizzle@*":
   version "2.3.2"
   resolved "https://registry.yarnpkg.com/@types/sizzle/-/sizzle-2.3.2.tgz#a811b8c18e2babab7d542b3365887ae2e4d9de47"
@@ -6568,7 +6575,7 @@ rxjs@^6.5.3:
   dependencies:
     tslib "^1.9.0"
 
-safe-buffer@^5.1.0:
+safe-buffer@^5.0.1, safe-buffer@^5.1.0:
   version "5.2.1"
   resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6"
   integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==
@@ -6721,6 +6728,14 @@ set-value@^2.0.0, set-value@^2.0.1:
     is-plain-object "^2.0.3"
     split-string "^3.0.1"
 
+[email protected]:
+  version "2.4.9"
+  resolved "https://registry.yarnpkg.com/sha.js/-/sha.js-2.4.9.tgz#98f64880474b74f4a38b8da9d3c0f2d104633e7d"
+  integrity sha512-G8zektVqbiPHrylgew9Zg1VRB1L/DtXNUVAM6q4QLy8NE3qtHlFXTf8VLL4k1Yl6c7NMjtZUTdXV+X44nFaT6A==
+  dependencies:
+    inherits "^2.0.1"
+    safe-buffer "^5.0.1"
+
 shallow-clone@^3.0.0:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/shallow-clone/-/shallow-clone-3.0.1.tgz#8f2981ad92531f55035b01fb230769a40e02efa3"