Add ab testing support (#55)

uc-diogo · Noé Fernández · web-flow · commit 2835cb671403 · 2022-11-17T10:48:40.000Z
* Add ab testing support

* Fix ios tests

* Fix fakeusercentricsmanager

* Feedback

* delete example

* Add example for ab testing in example app

* Empty-Commit

Co-authored-by: Noé Fernández &lt;noe.fernandez@usercentrics.com&gt;
diff --git a/android/src/androidTest/java/com/usercentrics/reactnativemodule/RNUsercentricsModuleTest.kt b/android/src/androidTest/java/com/usercentrics/reactnativemodule/RNUsercentricsModuleTest.kt
@@ -210,6 +210,21 @@ class RNUsercentricsModuleTest {
         assertEquals("abc", promise.resolveValue)
     }
 
+    @Test
+    fun testGetABTestingVariant() {
+        val usercentricsSDK = mockk<UsercentricsSDK>()
+        every { usercentricsSDK.getABTestingVariant() }.returns("variantA")
+        val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
+        val contextMock = mockk<ReactApplicationContext>(relaxed = true)
+        val module = RNUsercentricsModule(contextMock, usercentricsProxy)
+        val promise = FakePromise()
+
+        module.getABTestingVariant(promise)
+
+        verify(exactly = 1) { usercentricsSDK.getABTestingVariant() }
+        assertEquals("variantA", promise.resolveValue)
+    }
+
     @Test
     fun testGetConsents() {
         val usercentricsSDK = mockk<UsercentricsSDK>()
@@ -294,6 +309,20 @@ class RNUsercentricsModuleTest {
         verify(exactly = 1) { usercentricsSDK.setCMPId(123) }
     }
 
+    @Test
+    fun testSetABTestingVariant() {
+        val usercentricsSDK = mockk<UsercentricsSDK>()
+        every { usercentricsSDK.setABTestingVariant("variantA") }.returns(Unit)
+
+        val usercentricsProxy = FakeUsercentricsProxy(usercentricsSDK)
+        val contextMock = mockk<ReactApplicationContext>(relaxed = true)
+        val module = RNUsercentricsModule(contextMock, usercentricsProxy)
+
+        module.setABTestingVariant("variantA")
+
+        verify(exactly = 1) { usercentricsSDK.setABTestingVariant("variantA") }
+    }
+
     @Test
     fun testGetTCFData() {
         val usercentricsSDK = mockk<UsercentricsSDK>()
diff --git a/android/src/main/java/com/usercentrics/reactnativeusercentrics/RNUsercentricsModule.kt b/android/src/main/java/com/usercentrics/reactnativeusercentrics/RNUsercentricsModule.kt
@@ -36,7 +36,8 @@ internal class RNUsercentricsModule(
                 val assetManager = currentActivity!!.assets
 
                 val layout = options.getString("layout")!!.usercentricsLayoutFromEnumString()
-                val bannerSettings = options.getMap("bannerSettings")?.bannerSettingsFromMap(assetManager)
+                val bannerSettings =
+                    options.getMap("bannerSettings")?.bannerSettingsFromMap(assetManager)
                 usercentricsProxy.showFirstLayer(currentActivity!!, layout, bannerSettings, promise)
 
             } catch (e: Exception) {
@@ -51,7 +52,8 @@ internal class RNUsercentricsModule(
             try {
                 val assetManager = currentActivity!!.assets
 
-                val bannerSettings = options.getMap("bannerSettings")?.bannerSettingsFromMap(assetManager)
+                val bannerSettings =
+                    options.getMap("bannerSettings")?.bannerSettingsFromMap(assetManager)
                 usercentricsProxy.showSecondLayer(currentActivity!!, bannerSettings, promise)
             } catch (e: Exception) {
                 promise.reject(e)
@@ -73,6 +75,11 @@ internal class RNUsercentricsModule(
         promise.resolve(usercentricsProxy.instance.getControllerId())
     }
 
+    @ReactMethod
+    fun getABTestingVariant(promise: Promise) {
+        promise.resolve(usercentricsProxy.instance.getABTestingVariant())
+    }
+
     @ReactMethod
     fun getConsents(promise: Promise) {
         promise.resolve(usercentricsProxy.instance.getConsents().toWritableArray())
@@ -88,6 +95,11 @@ internal class RNUsercentricsModule(
         usercentricsProxy.instance.setCMPId(id)
     }
 
+    @ReactMethod
+    fun setABTestingVariant(variant: String) {
+        usercentricsProxy.instance.setABTestingVariant(variant)
+    }
+
     @ReactMethod
     fun getTCFData(promise: Promise) {
         usercentricsProxy.instance.getTCFData {
diff --git a/example/ios/exampleTests/Fake/FakeUsercentricsManager.swift b/example/ios/exampleTests/Fake/FakeUsercentricsManager.swift
@@ -17,6 +17,7 @@ final class FakeUsercentricsManager: UsercentricsManager {
 
   var getTCStringValue: String?
   var getControllerIdValue: String?
+  var getABTestingVariantValue: String?
 
   var configureOptions: UsercentricsOptions?
   var isReadySuccessCompletion: UsercentricsReadyStatus?
@@ -67,6 +68,10 @@ final class FakeUsercentricsManager: UsercentricsManager {
     return getControllerIdValue!
   }
 
+  func getABTestingVariant() -> String? {
+    return getABTestingVariantValue!
+  }
+
   var getConsentsResponse: [UsercentricsServiceConsent]?
   func getConsents() -> [UsercentricsServiceConsent] {
     return getConsentsResponse!
@@ -163,6 +168,11 @@ final class FakeUsercentricsManager: UsercentricsManager {
     self.cmpId = id
   }
 
+  var variant: String?
+  func setABTestingVariant(variant: String) {
+    self.variant = variant
+  }
+
   var showFirstLayerBannerSettings: BannerSettings?
   var layoutSettings: FirstLayerStyleSettings?
   var layout: UsercentricsLayout?
diff --git a/example/ios/exampleTests/RNUsercentricsModuleTests.swift b/example/ios/exampleTests/RNUsercentricsModuleTests.swift
@@ -121,6 +121,15 @@ class RNUsercentricsModuleTests: XCTestCase {
     }
   }
 
+  func testGetABTestingVariantId() {
+    fakeUsercentrics.getABTestingVariantValue = "variantA"
+    module.getABTestingVariant { response in
+      XCTAssertEqual("variantA", response as? String)
+    } reject: { _, _, _ in
+      XCTFail("Should not go here")
+    }
+  }
+
   func testReset() {
     module.reset()
     XCTAssertEqual(1, fakeUsercentrics.resetCount)
@@ -453,6 +462,11 @@ class RNUsercentricsModuleTests: XCTestCase {
     XCTAssertEqual(Int32(123), fakeUsercentrics.cmpId)
   }
 
+  func testSetABTestingVariant() {
+    module.setABTestingVariant("variantA")
+    XCTAssertEqual(String("variantA"), fakeUsercentrics.variant)
+  }
+
   func testShowFirstLayer() {
     let dict: NSDictionary = ["layout": "POPUP_CENTER"]
     module.showFirstLayer(dict) { result in
diff --git a/example/src/screens/Home.tsx b/example/src/screens/Home.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 import { Button, StyleSheet, View } from 'react-native';
 import {
     BannerSettings, FirstLayerOptions, SecondLayerOptions, Usercentrics,
-    UsercentricsLayout
+    UsercentricsLayout, UsercentricsReadyStatus
 } from '../../../src/index';
 import {
     customizationExampleOne,
@@ -11,6 +11,8 @@ import {
 
 export const HomeScreen = ({ navigation }: { navigation: any }) => {
     async function showFirstLayer(options: FirstLayerOptions = defaultOptions) {
+        // const bannerSettings = await getBannerSettings()
+        // const options = new FirstLayerOptions(UsercentriwcsLayout.popupBottom, bannerSettings)
         const response = await Usercentrics.showFirstLayer(options);
         console.log("Consents -> ${response.consents}", response.consents);
         console.log("User Interaction -> ${response.userInteraction}", response.userInteraction);
@@ -23,6 +25,7 @@ export const HomeScreen = ({ navigation }: { navigation: any }) => {
                 showCloseButton: true
             }
         };
+
         const options = new SecondLayerOptions(bannerSettings);
 
         const response = await Usercentrics.showSecondLayer(options);
@@ -31,6 +34,43 @@ export const HomeScreen = ({ navigation }: { navigation: any }) => {
         console.log("Controller Id -> ${response.controllerId}", response.controllerId);
     }
 
+    async function getBannerSettings(){
+        const variant = await Usercentrics.getABTestingVariant()
+        let bannerSettings: BannerSettings;
+
+        switch (variant){
+            case "variantA":
+                return bannerSettings = {/* settings for the banner with variantA */};
+            case "variantB":
+                return bannerSettings = {/* settings for the banner with variantB */};
+            default:
+                return bannerSettings = {/* default banner settings*/};
+       }
+    }
+
+    //'Activate with third-party tool' option
+    async function getBannerSettingsThirdPartyTool(){
+        const variant = ThirdPartyTool.getABTestingVariant()
+        let bannerSettings: BannerSettings;
+
+        switch (variant){
+            case "variantA":
+                return bannerSettings = {/* settings for the banner with variantA */ variant: "variantA"};
+            case "variantB":
+                return bannerSettings = {/* settings for the banner with variantB */ variant: "variantB"};
+            default:
+                return bannerSettings = {/* default banner settings*/variant: "variantC"};
+        }
+    }
+
+    const ThirdPartyTool = {
+        getABTestingVariant: (): String | null => {
+            const variants = ["variantA", "variantB"]
+            const random = Math.floor(Math.random() * variants.length );
+            return variants[random];
+        }
+    }
+
     const styles = StyleSheet.create({
         container: {
             flex: 1,
diff --git a/ios/Manager/UsercentricsManager.swift b/ios/Manager/UsercentricsManager.swift
@@ -21,6 +21,7 @@ public protocol UsercentricsManager {
     func getUserSessionData() -> String
     func getUSPData() -> CCPAData
     func getTCFData(callback: @escaping (TCFData) -> Void)
+    func getABTestingVariant() -> String?
 
     func changeLanguage(language: String, onSuccess: @escaping (() -> Void), onFailure: @escaping ((Error) -> Void))
 
@@ -37,6 +38,7 @@ public protocol UsercentricsManager {
     func saveDecisions(decisions: [UserDecision], consentType: UsercentricsConsentType) -> [UsercentricsServiceConsent]
     func saveOptOutForCCPA(isOptedOut: Bool, consentType: UsercentricsConsentType) -> [UsercentricsServiceConsent]
     func setCMPId(id: Int32)
+    func setABTestingVariant(variant: String)
 
     func reset()
 }
@@ -75,6 +77,10 @@ final class UsercentricsManagerImplementation: UsercentricsManager {
         return UsercentricsCore.shared.getControllerId()
     }
 
+    func getABTestingVariant() -> String? {
+        return UsercentricsCore.shared.getABTestingVariant()
+    }
+
     func getConsents() -> [UsercentricsServiceConsent] {
         return UsercentricsCore.shared.getConsents()
     }
@@ -130,4 +136,8 @@ final class UsercentricsManagerImplementation: UsercentricsManager {
     func setCMPId(id: Int32) {
         UsercentricsCore.shared.setCMPId(id: id)
     }
+
+    func setABTestingVariant(variant: String) {
+        UsercentricsCore.shared.setABTestingVariant(variant: variant)
+    }
 }
diff --git a/ios/RNUsercentricsModule.m b/ios/RNUsercentricsModule.m
@@ -35,6 +35,9 @@ @interface RCT_EXTERN_MODULE(RNUsercentricsModule, NSObject)
 RCT_EXTERN_METHOD(getControllerId:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
 
+RCT_EXTERN_METHOD(getABTestingVariant:(RCTPromiseResolveBlock)resolve
+                reject:(RCTPromiseRejectBlock)reject)
+
 RCT_EXTERN_METHOD(getConsents:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject)
 
@@ -91,5 +94,7 @@ @interface RCT_EXTERN_MODULE(RNUsercentricsModule, NSObject)
 
 RCT_EXTERN_METHOD(setCMPId:(NSInteger *)id)
 
+RCT_EXTERN_METHOD(setABTestingVariant:(NSString *)variant)
+
 RCT_EXTERN_METHOD(reset)
 @end
diff --git a/ios/RNUsercentricsModule.swift b/ios/RNUsercentricsModule.swift
@@ -78,7 +78,11 @@ class RNUsercentricsModule: NSObject, RCTBridgeModule {
     @objc func setCMPId(_ id: Int) -> Void {
         usercentricsManager.setCMPId(id: Int32(id))
     }
-    
+
+    @objc func setABTestingVariant(_ variant: String) -> Void {
+        usercentricsManager.setABTestingVariant(variant: String(variant))
+    }
+
     @objc func restoreUserSession(_ controllerId: String, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) -> Void {
         usercentricsManager.restoreUserSession(controllerId: controllerId) { status in
             resolve(status.toDictionary())
@@ -112,6 +116,10 @@ class RNUsercentricsModule: NSObject, RCTBridgeModule {
     @objc func getUSPData(_ resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) -> Void {
         resolve(usercentricsManager.getUSPData().toDictionary())
     }
+
+    @objc func getABTestingVariant(_ resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) -> Void {
+            resolve(usercentricsManager.getABTestingVariant())
+        }
     
     @objc func changeLanguage(_ language: String, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) -> Void {
         usercentricsManager.changeLanguage(language: language) {
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/Usercentrics.tsx b/src/Usercentrics.tsx
@@ -35,6 +35,11 @@ export const Usercentrics = {
         return RNUsercentricsModule.getControllerId();
     },
 
+    getABTestingVariant: async (): Promise<string | null> => {
+        await RNUsercentricsModule.isReady();
+        return RNUsercentricsModule.getABTestingVariant();
+    },
+
     getConsents: async (): Promise<[UsercentricsServiceConsent]> => {
         await RNUsercentricsModule.isReady();
         return RNUsercentricsModule.getConsents();
@@ -104,6 +109,10 @@ export const Usercentrics = {
         RNUsercentricsModule.setCMPId(id);
     },
 
+    setABTestingVariant: (variant: string) => {
+        RNUsercentricsModule.setABTestingVariant(variant);
+    },
+
     reset: () => {
         RNUsercentricsModule.reset()
     }
diff --git a/src/__tests__/index.test.ts b/src/__tests__/index.test.ts
@@ -39,6 +39,7 @@ jest.mock("react-native", () => {
     showFirstLayer: jest.fn(),
     restoreUserSession: jest.fn(),
     getControllerId: jest.fn(),
+    getABTestingVariant: jest.fn(),
     getConsents: jest.fn(),
     getCMPData: jest.fn(),
     getUserSessionData: jest.fn(),
@@ -201,11 +202,28 @@ describe('Test Usercentrics Module', () => {
       (): Promise<string> => Promise.resolve("abc")
     )
 
-
     const data = await Usercentrics.getControllerId();
     expect(data).toBe("abc");
   })
 
+  test('testGetABTestingVariant', async () => {
+    RNUsercentricsModule.getABTestingVariant.mockImplementationOnce(
+      (): Promise<string> => Promise.resolve("variantA")
+    )
+
+    const data = await Usercentrics.getABTestingVariant();
+    expect(data).toBe("variantA");
+  })
+
+  test('testGetABTestingVariant_WhenNull', async () => {
+    RNUsercentricsModule.getABTestingVariant.mockImplementationOnce(
+      (): Promise<string | null> => Promise.resolve(null)
+    )
+
+    const data = await Usercentrics.getABTestingVariant();
+    expect(data).toBe(null);
+  })
+
   test('testChangeLanguage', async () => {
     RNUsercentricsModule.changeLanguage.mockImplementationOnce(
       (): Promise<any> => Promise.resolve()
@@ -348,4 +366,4 @@ describe('Test Usercentrics Module', () => {
     let spy = jest.spyOn(RNUsercentricsModule, "reset")
     expect(spy).toHaveBeenCalledTimes(1)
   })
-})
+})
diff --git a/src/models/BannerSettings.tsx b/src/models/BannerSettings.tsx
@@ -97,10 +97,12 @@ export class BannerSettings {
     firstLayerStyleSettings?: FirstLayerStyleSettings;
     secondLayerStyleSettings?: SecondLayerStyleSettings;
     generalStyleSettings?: GeneralStyleSettings;
+    variant?: String
 
-    constructor(firstLayerStyleSettings?: FirstLayerStyleSettings, secondLayerStyleSettings?: SecondLayerStyleSettings, generalStyleSettings?: GeneralStyleSettings) {
+    constructor(firstLayerStyleSettings?: FirstLayerStyleSettings, secondLayerStyleSettings?: SecondLayerStyleSettings, generalStyleSettings?: GeneralStyleSettings, variant?: String) {
         this.firstLayerStyleSettings = firstLayerStyleSettings;
         this.secondLayerStyleSettings = secondLayerStyleSettings;
         this.generalStyleSettings = generalStyleSettings;
+        this.variant = variant
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ public protocol UsercentricsManager {`
`21`	`21`	`func getUserSessionData() -> String`
`22`	`22`	`func getUSPData() -> CCPAData`
`23`	`23`	`func getTCFData(callback: @escaping (TCFData) -> Void)`
	`24`	`+ func getABTestingVariant() -> String?`
`24`	`25`
`25`	`26`	`func changeLanguage(language: String, onSuccess: @escaping (() -> Void), onFailure: @escaping ((Error) -> Void))`
`26`	`27`
`@@ -37,6 +38,7 @@ public protocol UsercentricsManager {`
`37`	`38`	`func saveDecisions(decisions: [UserDecision], consentType: UsercentricsConsentType) -> [UsercentricsServiceConsent]`
`38`	`39`	`func saveOptOutForCCPA(isOptedOut: Bool, consentType: UsercentricsConsentType) -> [UsercentricsServiceConsent]`
`39`	`40`	`func setCMPId(id: Int32)`
	`41`	`+ func setABTestingVariant(variant: String)`
`40`	`42`
`41`	`43`	`func reset()`
`42`	`44`	`}`
`@@ -75,6 +77,10 @@ final class UsercentricsManagerImplementation: UsercentricsManager {`
`75`	`77`	`return UsercentricsCore.shared.getControllerId()`
`76`	`78`	`}`
`77`	`79`
	`80`	`+ func getABTestingVariant() -> String? {`
	`81`	`+ return UsercentricsCore.shared.getABTestingVariant()`
	`82`	`+ }`
	`83`	`+`
`78`	`84`	`func getConsents() -> [UsercentricsServiceConsent] {`
`79`	`85`	`return UsercentricsCore.shared.getConsents()`
`80`	`86`	`}`
`@@ -130,4 +136,8 @@ final class UsercentricsManagerImplementation: UsercentricsManager {`
`130`	`136`	`func setCMPId(id: Int32) {`
`131`	`137`	`UsercentricsCore.shared.setCMPId(id: id)`
`132`	`138`	`}`
	`139`	`+`
	`140`	`+ func setABTestingVariant(variant: String) {`
	`141`	`+ UsercentricsCore.shared.setABTestingVariant(variant: variant)`
	`142`	`+ }`
`133`	`143`	`}`