snigel Bid Adapter : pass more information to backend (#10987)

* snigelBidAdapter: pass more information to backend

* snigelBidAdapter: add unit tests for the new functionality

Author: snigelweb

modules/snigelBidAdapter.js

@@ -1,19 +1,25 @@
 import {config} from '../src/config.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
-import {deepAccess, isArray, isFn, isPlainObject, inIframe, getDNT} from '../src/utils.js';
+import {deepAccess, isArray, isFn, isPlainObject, inIframe, getDNT, generateUUID} from '../src/utils.js';
 import {hasPurpose1Consent} from '../src/utils/gpdr.js';
 import {getGlobal} from '../src/prebidGlobal.js';
+import {getStorageManager} from '../src/storageManager.js';
 
 const BIDDER_CODE = 'snigel';
 const GVLID = 1076;
 const DEFAULT_URL = 'https://adserv.snigelweb.com/bp/v1/prebid';
 const DEFAULT_TTL = 60;
 const DEFAULT_CURRENCIES = ['USD'];
 const FLOOR_MATCH_ALL_SIZES = '*';
+const SESSION_ID_KEY = '_sn_session_pba';
 
 const getConfig = config.getConfig;
+const storageManager = getStorageManager({bidderCode: BIDDER_CODE});
 const refreshes = {};
+const pageViewId = generateUUID();
+const pageViewStart = new Date().getTime();
+let auctionCounter = 0;
 
 export const spec = {
   code: BIDDER_CODE,
@@ -33,6 +39,11 @@ export const spec = {
         id: bidderRequest.auctionId,
         accountId: deepAccess(bidRequests, '0.params.accountId'),
         site: deepAccess(bidRequests, '0.params.site'),
+        sessionId: getSessionId(),
+        counter: auctionCounter++,
+        pageViewId: pageViewId,
+        pageViewStart: pageViewStart,
+        gdprConsent: gdprApplies === true ? hasFullGdprConsent(deepAccess(bidderRequest, 'gdprConsent')) : false,
         cur: getCurrencies(),
         test: getTestFlag(),
         version: getGlobal().version,
@@ -104,9 +115,7 @@ export const spec = {
 registerBidder(spec);
 
 function getPage(bidderRequest) {
-  return (
-    getConfig(`${BIDDER_CODE}.page`) || deepAccess(bidderRequest, 'refererInfo.page') || window.location.href
-  );
+  return getConfig(`${BIDDER_CODE}.page`) || deepAccess(bidderRequest, 'refererInfo.page') || window.location.href;
 }
 
 function getEndpoint() {
@@ -193,6 +202,19 @@ function hasSyncConsent(gdprConsent, uspConsent, gppConsent) {
   return hasPurpose1Consent(gdprConsent) && hasUspConsent(uspConsent) && hasGppConsent(gppConsent);
 }
 
+function hasFullGdprConsent(gdprConsent) {
+  try {
+    const purposeConsents = Object.values(gdprConsent.vendorData.purpose.consents);
+    return (
+      purposeConsents.length > 0 &&
+      purposeConsents.every((value) => value === true) &&
+      gdprConsent.vendorData.vendor.consents[GVLID] === true
+    );
+  } catch (e) {
+    return false;
+  }
+}
+
 function getSyncUrl(responses) {
   return getConfig(`${BIDDER_CODE}.syncUrl`) || deepAccess(responses[0], 'body.syncUrl');
 }
@@ -202,3 +224,20 @@ function getSyncEndpoint(url, gdprConsent) {
     gdprConsent?.consentString || ''
   )}`;
 }
+
+function getSessionId() {
+  try {
+    if (storageManager.localStorageIsEnabled()) {
+      let sessionId = storageManager.getDataFromLocalStorage(SESSION_ID_KEY);
+      if (sessionId == null) {
+        sessionId = generateUUID();
+        storageManager.setDataInLocalStorage(SESSION_ID_KEY, sessionId);
+      }
+      return sessionId;
+    } else {
+      return undefined;
+    }
+  } catch (e) {
+    return undefined;
+  }
+}

test/spec/modules/snigelBidAdapter_spec.js

@@ -2,6 +2,8 @@ import {expect} from 'chai';
 import {spec} from 'modules/snigelBidAdapter.js';
 import {config} from 'src/config.js';
 import {isValid} from 'src/adapters/bidderFactory.js';
+import {registerActivityControl} from 'src/activities/rules.js';
+import {ACTIVITY_ACCESS_DEVICE} from 'src/activities/activities.js';
 
 const BASE_BID_REQUEST = {
   adUnitCode: 'top_leaderboard',
@@ -344,5 +346,67 @@ describe('snigelBidAdapter', function () {
       expect(sync).to.have.property('url');
       expect(sync.url).to.equal(`https://somesyncurl?gdpr=1&gdpr_consent=${DUMMY_GDPR_CONSENT_STRING}`);
     });
+
+    it('should omit session ID if no device access', function() {
+      const bidderRequest = makeBidderRequest();
+      const unregisterRule = registerActivityControl(ACTIVITY_ACCESS_DEVICE, 'denyAccess', () => {
+        return {allow: false, reason: 'no consent'};
+      });
+
+      try {
+        const request = spec.buildRequests([], bidderRequest);
+        expect(request).to.have.property('data');
+        const data = JSON.parse(request.data);
+        expect(data.sessionId).to.be.undefined;
+      } finally {
+        unregisterRule();
+      }
+    });
+
+    it('should determine full GDPR consent correctly', function () {
+      const baseBidderRequest = makeBidderRequest({
+        gdprConsent: {
+          gdprApplies: true,
+          vendorData: {
+            purpose: {
+              consents: {1: true, 2: true, 3: true, 4: true, 5: true},
+            },
+            vendor: {
+              consents: {[spec.gvlid]: true},
+            }
+          },
+        }
+      });
+      let request = spec.buildRequests([], baseBidderRequest);
+      expect(request).to.have.property('data');
+      let data = JSON.parse(request.data);
+      expect(data.gdprConsent).to.be.true;
+
+      let bidderRequest = {...baseBidderRequest, ...{gdprConsent: {vendorData: {purpose: {consents: {1: false}}}}}};
+      request = spec.buildRequests([], bidderRequest);
+      expect(request).to.have.property('data');
+      data = JSON.parse(request.data);
+      expect(data.gdprConsent).to.be.false;
+
+      bidderRequest = {...baseBidderRequest, ...{gdprConsent: {vendorData: {vendor: {consents: {[spec.gvlid]: false}}}}}};
+      request = spec.buildRequests([], bidderRequest);
+      expect(request).to.have.property('data');
+      data = JSON.parse(request.data);
+      expect(data.gdprConsent).to.be.false;
+    });
+
+    it('should increment auction counter upon every request', function() {
+      const bidderRequest = makeBidderRequest({});
+
+      let request = spec.buildRequests([], bidderRequest);
+      expect(request).to.have.property('data');
+      let data = JSON.parse(request.data);
+      const previousCounter = data.counter;
+
+      request = spec.buildRequests([], bidderRequest);
+      expect(request).to.have.property('data');
+      data = JSON.parse(request.data);
+      expect(data.counter).to.equal(previousCounter + 1);
+    });
   });
 });