fix(core): fix issue with user_data getting overriden when DMA params are added (#995)

- fix issue with user_data getting overriden when DMA params are added
for v2/event APIs when user_data is already present
- adds an error callback for setDMAParamsForEEA method

Author: JagadeeshKaricherla-branch

.jshintrc

@@ -28,5 +28,6 @@
 	"undef": true,
 	"unused": true,
 	"esversion": 6,
-	"-W138": true
+	"-W138": true,
+	"-W073": true
 }

example.html

@@ -82,7 +82,7 @@ <h4>QR Code</h4>
 	<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
 	<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
 	<script type="text/javascript">
-		(function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="https://cdn.branch.io/branch-latest.min.js";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setAPIUrl getAPIUrl setDMAParamsForEEA".split(" "), 0);
+		(function(b,r,a,n,c,h,_,s,d,k){if(!b[n]||!b[n]._q){for(;s<_.length;)c(h,_[s++]);d=r.createElement(a);d.async=1;d.src="https://cdn.branch.io/branch-latest.min.js";k=r.getElementsByTagName(a)[0];k.parentNode.insertBefore(d,k);b[n]=h}})(window,document,"script","branch",function(b,r){b[r]=function(){b._q.push([r,arguments])}},{_q:[],_v:1},"addListener banner closeBanner closeJourney data deepview deepviewCta first init link logout removeListener setBranchViewData setIdentity track trackCommerceEvent logEvent disableTracking getBrowserFingerprintId crossPlatformIds lastAttributedTouchData setAPIResponseCallback qrCode setRequestMetaData setDMAParamsForEEA setAPIUrl getAPIUrl".split(" "), 0);
 
 		branch.setAPIResponseCallback(function(url, method, requestBody, error, status, responseBody) {
 			console.log('Request: ' + method + ' ' + url + ' body=' + JSON.stringify(requestBody));

src/1_utils.js

@@ -32,7 +32,8 @@ utils.currentRequestBrttTag = "";
 utils.allowDMAParamURLMap = {
 	"/v1/open": "",
 	"/v1/pageview": "",
-	"/v2/event": "user_data"
+	"/v2/event/standard": "user_data",
+	"/v2/event/custom": "user_data"
 };
 utils.calculateBrtt = function(startTime) {
 	if (!startTime || typeof startTime !== "number") {
@@ -1344,19 +1345,39 @@ utils.setDMAParams = function(data, dmaObj = {}, endPoint) {
 		[DMA_Ad_User_Data]: dmaObj.adUserDataUsageConsent || false
 	};
 
-	for (const [key, value] of Object.entries(utils.allowDMAParamURLMap)) {
+	const allowDMAParamURLMap = utils.allowDMAParamURLMap;
+
+	for (const [key, value] of Object.entries(allowDMAParamURLMap)) {
 		if (endPoint.includes(key)) {
+
 			if (value === '') {
 				Object.assign(data, dmaParams);
 			}
 			else {
-				data[value] = Object.assign({}, data[value], dmaParams);
+				let updatedValue;
+				const valueExists = value in data;
+				if (!valueExists || data[value] === '') {
+					updatedValue = JSON.stringify(dmaParams);
+				}
+				else {
+					try {
+						const innerJSONObject = JSON.parse(data[value]);
+						const mergedObject = Object.assign({}, innerJSONObject, dmaParams);
+						updatedValue = JSON.stringify(mergedObject);
+					} catch (error) {
+						console.error(`setDMAParams:: ${value} is not a valid JSON string`);
+					}
+				}
+				if (updatedValue) {
+					data[value] = updatedValue;
+				}
 			}
 			break;
 		}
 	}
 };
 
+
 /**
  * @param {String} url
  * A utility function to validate url

src/6_branch.js

@@ -1955,7 +1955,7 @@ Branch.prototype['setAPIResponseCallback'] = wrap(callback_params.NO_CALLBACK, f
  * @param {Boolean} adUserDataUsageConsent - If User has granted/denied consent for 3P transmission of user level data for ads.
  * Sets the value of parameters required by Google Conversion APIs for DMA Compliance in EEA region.
  */
-Branch.prototype['setDMAParamsForEEA'] = function(eeaRegion, adPersonalizationConsent, adUserDataUsageConsent) {
+Branch.prototype['setDMAParamsForEEA'] = wrap(callback_params.CALLBACK_ERR, function(done, eeaRegion, adPersonalizationConsent, adUserDataUsageConsent) {
 	try {
 		var dmaObj = {};
 		dmaObj.eeaRegion = eeaRegion || false;
@@ -1966,7 +1966,8 @@ Branch.prototype['setDMAParamsForEEA'] = function(eeaRegion, adPersonalizationCo
 	catch (e) {
 		console.error("setDMAParamsForEEA::An error occured while setting DMA parameters for EEA", e);
 	}
-};
+	done();
+}, true);
 
 /***
  * @function Branch.setRequestMetaData

test/1_utils.js

@@ -1329,7 +1329,8 @@ describe('utils', function() {
 		it('should return true for valid endpoints', function() {
 			assert.equal(utils.shouldAddDMAParams('/v1/open'), true);
 			assert.equal(utils.shouldAddDMAParams('/v1/pageview'), true);
-			assert.equal(utils.shouldAddDMAParams('/v2/event'), true);
+			assert.equal(utils.shouldAddDMAParams('/v2/event/standard'), true);
+			assert.equal(utils.shouldAddDMAParams('/v2/event/custom'), true);
 		});
 
 		it('should return false for invalid endpoints', function() {
@@ -1349,16 +1350,27 @@ describe('utils', function() {
 			utils.setDMAParams(data, dmaObj, '/v1/open');
 			assert.deepEqual(data, { dma_eea: true, dma_ad_personalization: true, dma_ad_user_data: false });
 		});
-		it('should add DMA parameters for valid endpoints: v2/event', () => {
+		it('should add DMA parameters for valid endpoints: v2/event/standard', () => {
 			const dmaObj = {
 				eeaRegion: true,
 				adPersonalizationConsent: true,
 				adUserDataUsageConsent: false
 			};
 
 			const data2 = {};
-			utils.setDMAParams(data2, dmaObj, '/v2/event');
-			assert.deepEqual(data2, { "user_data": { dma_eea: true, dma_ad_personalization: true, dma_ad_user_data: false } });
+			utils.setDMAParams(data2, dmaObj, '/v2/event/standard');
+			assert.deepEqual(data2, { "user_data":"{\"dma_eea\":true,\"dma_ad_personalization\":true,\"dma_ad_user_data\":false}" });
+		});
+		it('should add DMA parameters for valid endpoints: v2/event/custom', () => {
+			const dmaObj = {
+				eeaRegion: true,
+				adPersonalizationConsent: true,
+				adUserDataUsageConsent: false
+			};
+
+			const data2 = {};
+			utils.setDMAParams(data2, dmaObj, '/v2/event/custom');
+			assert.deepEqual(data2, { "user_data":"{\"dma_eea\":true,\"dma_ad_personalization\":true,\"dma_ad_user_data\":false}" });
 		});
 		it('should add DMA parameters for valid endpoints: v1/pageview', () => {
 			const dmaObj = {

test/6_branch_new.js

@@ -5,11 +5,14 @@ var sinon = require('sinon');
 
 goog.require('Branch');
 goog.require('utils');
+goog.require('task_queue');
 
 describe('Branch - new', function() {
-	var branch_instance = new Branch();
-	var assert = testUtils.unplanned();
+	const sandbox = sinon.createSandbox();
+	const branch_instance = new Branch();
+	const assert = testUtils.unplanned();
 	afterEach(function() {
+		sandbox.restore();
 		sinon.restore();
 	});
 	describe('referringLink', function() {
@@ -56,21 +59,15 @@ describe('Branch - new', function() {
 		});
 	});
 	describe('setDMAParamsForEEA', function() {
-		let sandbox;
-		beforeEach(() => {
-			sandbox = sinon.createSandbox();
-		});
-		afterEach(() => {
-			sandbox.restore();
-		});
 		it('test method exists', function() {
 			sinon.assert.match(typeof branch_instance.setDMAParamsForEEA, "function");
 		});
 		it('should store dma params inside branch_dma_data of storage', function() {
 			const thisObj = {
 				_storage: {
 					set: () => {}
-				}
+				},
+				_queue: task_queue()
 			};
 			const storageSetStub = sandbox.stub(thisObj._storage, 'set');
 			const dmaObj = {};
@@ -85,7 +82,8 @@ describe('Branch - new', function() {
 			const thisObj = {
 				_storage: {
 					set: () => {}
-				}
+				},
+				_queue: task_queue()
 			};
 			const storageSetStub = sandbox.stub(thisObj._storage, 'set');
 			const dmaObj = {};
@@ -100,7 +98,8 @@ describe('Branch - new', function() {
 			const thisObj = {
 				_storage: {
 					set: () => {}
-				}
+				},
+				_queue: task_queue()
 			};
 			sandbox.stub(thisObj._storage, 'set').throws(new Error('Mock error'));
 			const consoleErrorStub = sandbox.stub(console, 'error');

test/branch-deps.js

@@ -22,7 +22,7 @@ goog.addDependency('../../../../test/1_utils.js', [], ['utils'], {'lang': 'es6'}
 goog.addDependency('../../../../test/2_storage.js', [], ['storage']);
 goog.addDependency('../../../../test/3_api.js', [], ['Server', 'config', 'resources', 'safejson', 'storage', 'utils']);
 goog.addDependency('../../../../test/6_branch.js', [], ['Branch', 'banner_html', 'banner_utils', 'config', 'goog.json', 'resources', 'safejson', 'session', 'storage', 'utils']);
-goog.addDependency('../../../../test/6_branch_new.js', [], ['Branch', 'utils']);
+goog.addDependency('../../../../test/6_branch_new.js', [], ['Branch', 'task_queue', 'utils'], {'lang': 'es6'});
 goog.addDependency('../../../../test/7_integration.js', [], ['config', 'goog.json']);
 goog.addDependency('../../../../test/blob-banner.js', [], []);
 goog.addDependency('../../../../test/blob-interstitial.js', [], []);