prebid.js 9.1.0 → 9.3.0

package/test/spec/modules/emtvBidAdapter_spec.js

@@ -8,6 +8,16 @@ const adUrl = 'https://us-east-ep.engagemedia.tv/pbjs';
 const syncUrl = 'https://cs.engagemedia.tv';
 
 describe('EMTVBidAdapter', function () {
+  const userIdAsEids = [{
+    source: 'test.org',
+    uids: [{
+      id: '01**********',
+      atype: 1,
+      ext: {
+        third: '01***********'
+      }
+    }]
+  }];
   const bids = [
     {
       bidId: getUniqueIdentifierStr(),
@@ -18,8 +28,9 @@ describe('EMTVBidAdapter', function () {
         }
       },
       params: {
-        placementId: 'testBanner',
-      }
+        placementId: 'testBanner'
+      },
+      userIdAsEids
     },
     {
       bidId: getUniqueIdentifierStr(),
@@ -32,8 +43,9 @@ describe('EMTVBidAdapter', function () {
         }
       },
       params: {
-        placementId: 'testVideo',
-      }
+        placementId: 'testVideo'
+      },
+      userIdAsEids
     },
     {
       bidId: getUniqueIdentifierStr(),
@@ -55,8 +67,9 @@ describe('EMTVBidAdapter', function () {
         }
       },
       params: {
-        placementId: 'testNative',
-      }
+        placementId: 'testNative'
+      },
+      userIdAsEids
     }
   ];
 
@@ -75,10 +88,22 @@ describe('EMTVBidAdapter', function () {
 
   const bidderRequest = {
     uspConsent: '1---',
-    gdprConsent: 'COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA.IFoEUQQgAIQwgIwQABAEAAAAOIAACAIAAAAQAIAgEAACEAAAAAgAQBAAAAAAAGBAAgAAAAAAAFAAECAAAgAAQARAEQAAAAAJAAIAAgAAAYQEAAAQmAgBC3ZAYzUw',
+    gdprConsent: {
+      consentString: 'COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA.IFoEUQQgAIQwgIwQABAEAAAAOIAACAIAAAAQAIAgEAACEAAAAAgAQBAAAAAAAGBAAgAAAAAAAFAAECAAAgAAQARAEQAAAAAJAAIAAgAAAYQEAAAQmAgBC3ZAYzUw',
+      vendorData: {}
+    },
     refererInfo: {
-      referer: 'https://test.com'
-    }
+      referer: 'https://test.com',
+      page: 'https://test.com'
+    },
+    ortb2: {
+      device: {
+        w: 1512,
+        h: 982,
+        language: 'en-UK'
+      }
+    },
+    timeout: 500
   };
 
   describe('isBidRequestValid', function () {
@@ -130,7 +155,7 @@ describe('EMTVBidAdapter', function () {
       expect(data.host).to.be.a('string');
       expect(data.page).to.be.a('string');
       expect(data.coppa).to.be.a('number');
-      expect(data.gdpr).to.be.a('string');
+      expect(data.gdpr).to.be.a('object');
       expect(data.ccpa).to.be.a('string');
       expect(data.tmax).to.be.a('number');
       expect(data.placements).to.have.lengthOf(3);
@@ -146,6 +171,56 @@ describe('EMTVBidAdapter', function () {
         expect(placement.schain).to.be.an('object');
         expect(placement.bidfloor).to.exist.and.to.equal(0);
         expect(placement.type).to.exist.and.to.equal('publisher');
+        expect(placement.eids).to.exist.and.to.be.deep.equal(userIdAsEids);
+
+        if (placement.adFormat === BANNER) {
+          expect(placement.sizes).to.be.an('array');
+        }
+        switch (placement.adFormat) {
+          case BANNER:
+            expect(placement.sizes).to.be.an('array');
+            break;
+          case VIDEO:
+            expect(placement.playerSize).to.be.an('array');
+            expect(placement.minduration).to.be.an('number');
+            expect(placement.maxduration).to.be.an('number');
+            break;
+          case NATIVE:
+            expect(placement.native).to.be.an('object');
+            break;
+        }
+      }
+    });
+
+    it('Returns valid endpoints', function () {
+      const bids = [
+        {
+          bidId: getUniqueIdentifierStr(),
+          bidder: bidder,
+          mediaTypes: {
+            [BANNER]: {
+              sizes: [[300, 250]]
+            }
+          },
+          params: {
+            endpointId: 'testBanner',
+          },
+          userIdAsEids
+        }
+      ];
+
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
+
+      const { placements } = serverRequest.data;
+      for (let i = 0, len = placements.length; i < len; i++) {
+        const placement = placements[i];
+        expect(placement.endpointId).to.be.oneOf(['testBanner', 'testVideo', 'testNative']);
+        expect(placement.adFormat).to.be.oneOf([BANNER, VIDEO, NATIVE]);
+        expect(placement.bidId).to.be.a('string');
+        expect(placement.schain).to.be.an('object');
+        expect(placement.bidfloor).to.exist.and.to.equal(0);
+        expect(placement.type).to.exist.and.to.equal('network');
+        expect(placement.eids).to.exist.and.to.be.deep.equal(userIdAsEids);
 
         if (placement.adFormat === BANNER) {
           expect(placement.sizes).to.be.an('array');
@@ -171,8 +246,10 @@ describe('EMTVBidAdapter', function () {
       serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
       expect(data.gdpr).to.exist;
-      expect(data.gdpr).to.be.a('string');
-      expect(data.gdpr).to.equal(bidderRequest.gdprConsent);
+      expect(data.gdpr).to.be.a('object');
+      expect(data.gdpr).to.have.property('consentString');
+      expect(data.gdpr).to.not.have.property('vendorData');
+      expect(data.gdpr.consentString).to.equal(bidderRequest.gdprConsent.consentString);
       expect(data.ccpa).to.not.exist;
       delete bidderRequest.gdprConsent;
     });
@@ -187,12 +264,38 @@ describe('EMTVBidAdapter', function () {
       expect(data.ccpa).to.equal(bidderRequest.uspConsent);
       expect(data.gdpr).to.not.exist;
     });
+  });
+
+  describe('gpp consent', function () {
+    it('bidderRequest.gppConsent', () => {
+      bidderRequest.gppConsent = {
+        gppString: 'abc123',
+        applicableSections: [8]
+      };
 
-    it('Returns empty data if no valid requests are passed', function () {
-      serverRequest = spec.buildRequests([], bidderRequest);
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
-      expect(data.placements).to.be.an('array').that.is.empty;
-    });
+      expect(data).to.be.an('object');
+      expect(data).to.have.property('gpp');
+      expect(data).to.have.property('gpp_sid');
+
+      delete bidderRequest.gppConsent;
+    })
+
+    it('bidderRequest.ortb2.regs.gpp', () => {
+      bidderRequest.ortb2 = bidderRequest.ortb2 || {};
+      bidderRequest.ortb2.regs = bidderRequest.ortb2.regs || {};
+      bidderRequest.ortb2.regs.gpp = 'abc123';
+      bidderRequest.ortb2.regs.gpp_sid = [8];
+
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
+      let data = serverRequest.data;
+      expect(data).to.be.an('object');
+      expect(data).to.have.property('gpp');
+      expect(data).to.have.property('gpp_sid');
+
+      bidderRequest.ortb2;
+    })
   });
 
   describe('interpretResponse', function () {
@@ -396,5 +499,17 @@ describe('EMTVBidAdapter', function () {
       expect(syncData[0].url).to.be.a('string')
       expect(syncData[0].url).to.equal(`${syncUrl}/image?pbjs=1&ccpa_consent=1---&coppa=0`)
     });
+    it('Should return array of objects with proper sync config , include GPP', function() {
+      const syncData = spec.getUserSyncs({}, {}, {}, {}, {
+        gppString: 'abc123',
+        applicableSections: [8]
+      });
+      expect(syncData).to.be.an('array').which.is.not.empty;
+      expect(syncData[0]).to.be.an('object')
+      expect(syncData[0].type).to.be.a('string')
+      expect(syncData[0].type).to.equal('image')
+      expect(syncData[0].url).to.be.a('string')
+      expect(syncData[0].url).to.equal(`${syncUrl}/image?pbjs=1&gpp=abc123&gpp_sid=8&coppa=0`)
+    });
   });
 });

package/test/spec/modules/globalsunBidAdapter_spec.js

@@ -3,9 +3,19 @@ import { spec } from '../../../modules/globalsunBidAdapter.js';
 import { BANNER, VIDEO, NATIVE } from '../../../src/mediaTypes.js';
 import { getUniqueIdentifierStr } from '../../../src/utils.js';
 
-const bidder = 'globalsun'
+const bidder = 'globalsun';
 
 describe('GlobalsunBidAdapter', function () {
+  const userIdAsEids = [{
+    source: 'test.org',
+    uids: [{
+      id: '01**********',
+      atype: 1,
+      ext: {
+        third: '01***********'
+      }
+    }]
+  }];
   const bids = [
     {
       bidId: getUniqueIdentifierStr(),
@@ -16,8 +26,9 @@ describe('GlobalsunBidAdapter', function () {
         }
       },
       params: {
-        placementId: 'testBanner',
-      }
+        placementId: 'testBanner'
+      },
+      userIdAsEids
     },
     {
       bidId: getUniqueIdentifierStr(),
@@ -30,8 +41,9 @@ describe('GlobalsunBidAdapter', function () {
         }
       },
       params: {
-        placementId: 'testVideo',
-      }
+        placementId: 'testVideo'
+      },
+      userIdAsEids
     },
     {
       bidId: getUniqueIdentifierStr(),
@@ -53,8 +65,9 @@ describe('GlobalsunBidAdapter', function () {
         }
       },
       params: {
-        placementId: 'testNative',
-      }
+        placementId: 'testNative'
+      },
+      userIdAsEids
     }
   ];
 
@@ -73,9 +86,20 @@ describe('GlobalsunBidAdapter', function () {
 
   const bidderRequest = {
     uspConsent: '1---',
-    gdprConsent: 'COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA.IFoEUQQgAIQwgIwQABAEAAAAOIAACAIAAAAQAIAgEAACEAAAAAgAQBAAAAAAAGBAAgAAAAAAAFAAECAAAgAAQARAEQAAAAAJAAIAAgAAAYQEAAAQmAgBC3ZAYzUw',
+    gdprConsent: {
+      consentString: 'COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA.IFoEUQQgAIQwgIwQABAEAAAAOIAACAIAAAAQAIAgEAACEAAAAAgAQBAAAAAAAGBAAgAAAAAAAFAAECAAAgAAQARAEQAAAAAJAAIAAgAAAYQEAAAQmAgBC3ZAYzUw',
+      vendorData: {}
+    },
     refererInfo: {
-      referer: 'https://test.com'
+      referer: 'https://test.com',
+      page: 'https://test.com'
+    },
+    ortb2: {
+      device: {
+        w: 1512,
+        h: 982,
+        language: 'en-UK'
+      }
     },
     timeout: 500
   };
@@ -129,7 +153,7 @@ describe('GlobalsunBidAdapter', function () {
       expect(data.host).to.be.a('string');
       expect(data.page).to.be.a('string');
       expect(data.coppa).to.be.a('number');
-      expect(data.gdpr).to.be.a('string');
+      expect(data.gdpr).to.be.a('object');
       expect(data.ccpa).to.be.a('string');
       expect(data.tmax).to.be.a('number');
       expect(data.placements).to.have.lengthOf(3);
@@ -145,6 +169,56 @@ describe('GlobalsunBidAdapter', function () {
         expect(placement.schain).to.be.an('object');
         expect(placement.bidfloor).to.exist.and.to.equal(0);
         expect(placement.type).to.exist.and.to.equal('publisher');
+        expect(placement.eids).to.exist.and.to.be.deep.equal(userIdAsEids);
+
+        if (placement.adFormat === BANNER) {
+          expect(placement.sizes).to.be.an('array');
+        }
+        switch (placement.adFormat) {
+          case BANNER:
+            expect(placement.sizes).to.be.an('array');
+            break;
+          case VIDEO:
+            expect(placement.playerSize).to.be.an('array');
+            expect(placement.minduration).to.be.an('number');
+            expect(placement.maxduration).to.be.an('number');
+            break;
+          case NATIVE:
+            expect(placement.native).to.be.an('object');
+            break;
+        }
+      }
+    });
+
+    it('Returns valid endpoints', function () {
+      const bids = [
+        {
+          bidId: getUniqueIdentifierStr(),
+          bidder: bidder,
+          mediaTypes: {
+            [BANNER]: {
+              sizes: [[300, 250]]
+            }
+          },
+          params: {
+            endpointId: 'testBanner',
+          },
+          userIdAsEids
+        }
+      ];
+
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
+
+      const { placements } = serverRequest.data;
+      for (let i = 0, len = placements.length; i < len; i++) {
+        const placement = placements[i];
+        expect(placement.endpointId).to.be.oneOf(['testBanner', 'testVideo', 'testNative']);
+        expect(placement.adFormat).to.be.oneOf([BANNER, VIDEO, NATIVE]);
+        expect(placement.bidId).to.be.a('string');
+        expect(placement.schain).to.be.an('object');
+        expect(placement.bidfloor).to.exist.and.to.equal(0);
+        expect(placement.type).to.exist.and.to.equal('network');
+        expect(placement.eids).to.exist.and.to.be.deep.equal(userIdAsEids);
 
         if (placement.adFormat === BANNER) {
           expect(placement.sizes).to.be.an('array');
@@ -170,8 +244,10 @@ describe('GlobalsunBidAdapter', function () {
       serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
       expect(data.gdpr).to.exist;
-      expect(data.gdpr).to.be.a('string');
-      expect(data.gdpr).to.equal(bidderRequest.gdprConsent);
+      expect(data.gdpr).to.be.a('object');
+      expect(data.gdpr).to.have.property('consentString');
+      expect(data.gdpr).to.not.have.property('vendorData');
+      expect(data.gdpr.consentString).to.equal(bidderRequest.gdprConsent.consentString);
       expect(data.ccpa).to.not.exist;
       delete bidderRequest.gdprConsent;
     });
@@ -186,12 +262,38 @@ describe('GlobalsunBidAdapter', function () {
       expect(data.ccpa).to.equal(bidderRequest.uspConsent);
       expect(data.gdpr).to.not.exist;
     });
+  });
+
+  describe('gpp consent', function () {
+    it('bidderRequest.gppConsent', () => {
+      bidderRequest.gppConsent = {
+        gppString: 'abc123',
+        applicableSections: [8]
+      };
 
-    it('Returns empty data if no valid requests are passed', function () {
-      serverRequest = spec.buildRequests([], bidderRequest);
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
-      expect(data.placements).to.be.an('array').that.is.empty;
-    });
+      expect(data).to.be.an('object');
+      expect(data).to.have.property('gpp');
+      expect(data).to.have.property('gpp_sid');
+
+      delete bidderRequest.gppConsent;
+    })
+
+    it('bidderRequest.ortb2.regs.gpp', () => {
+      bidderRequest.ortb2 = bidderRequest.ortb2 || {};
+      bidderRequest.ortb2.regs = bidderRequest.ortb2.regs || {};
+      bidderRequest.ortb2.regs.gpp = 'abc123';
+      bidderRequest.ortb2.regs.gpp_sid = [8];
+
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
+      let data = serverRequest.data;
+      expect(data).to.be.an('object');
+      expect(data).to.have.property('gpp');
+      expect(data).to.have.property('gpp_sid');
+
+      bidderRequest.ortb2;
+    })
   });
 
   describe('interpretResponse', function () {
@@ -395,5 +497,17 @@ describe('GlobalsunBidAdapter', function () {
       expect(syncData[0].url).to.be.a('string')
       expect(syncData[0].url).to.equal('https://cs.globalsun.io/image?pbjs=1&ccpa_consent=1---&coppa=0')
     });
+    it('Should return array of objects with proper sync config , include GPP', function() {
+      const syncData = spec.getUserSyncs({}, {}, {}, {}, {
+        gppString: 'abc123',
+        applicableSections: [8]
+      });
+      expect(syncData).to.be.an('array').which.is.not.empty;
+      expect(syncData[0]).to.be.an('object')
+      expect(syncData[0].type).to.be.a('string')
+      expect(syncData[0].type).to.equal('image')
+      expect(syncData[0].url).to.be.a('string')
+      expect(syncData[0].url).to.equal('https://cs.globalsun.io/image?pbjs=1&gpp=abc123&gpp_sid=8&coppa=0')
+    });
   });
 });

package/test/spec/modules/id5IdSystem_spec.js

@@ -26,6 +26,7 @@ describe('ID5 ID System', function () {
   const ID5_MODULE_NAME = 'id5Id';
   const ID5_EIDS_NAME = ID5_MODULE_NAME.toLowerCase();
   const ID5_SOURCE = 'id5-sync.com';
+  const TRUE_LINK_SOURCE = 'true-link-id5-sync.com';
   const ID5_TEST_PARTNER_ID = 173;
   const ID5_ENDPOINT = `https://id5-sync.com/g/v2/${ID5_TEST_PARTNER_ID}.json`;
   const ID5_API_CONFIG_URL = `https://id5-sync.com/api/config/prebid`;
@@ -48,10 +49,8 @@ describe('ID5 ID System', function () {
   const EUID_STORED_ID = 'EUID_1';
   const EUID_SOURCE = 'uidapi.com';
   const ID5_STORED_OBJ_WITH_EUID = {
-    'universal_uid': ID5_STORED_ID,
-    'signature': ID5_STORED_SIGNATURE,
+    ...ID5_STORED_OBJ,
     'ext': {
-      'linkType': ID5_STORED_LINK_TYPE,
       'euid': {
         'source': EUID_SOURCE,
         'uids': [{
@@ -61,6 +60,11 @@ describe('ID5 ID System', function () {
       }
     }
   };
+  const TRUE_LINK_STORED_ID = 'TRUE_LINK_1';
+  const ID5_STORED_OBJ_WITH_TRUE_LINK = {
+    ...ID5_STORED_OBJ,
+    publisherTrueLinkId: TRUE_LINK_STORED_ID
+  };
   const ID5_RESPONSE_ID = 'newid5id';
   const ID5_RESPONSE_SIGNATURE = 'abcdef';
   const ID5_RESPONSE_LINK_TYPE = 2;
@@ -148,6 +152,16 @@ describe('ID5 ID System', function () {
     });
   }
 
+  function wrapAsyncExpects(done, expectsFn) {
+    return function () {
+      try {
+        expectsFn();
+      } catch (err) {
+        done(err);
+      }
+    }
+  }
+
   class XhrServerMock {
     currentRequestIdx = 0;
     server;
@@ -837,6 +851,38 @@ describe('ID5 ID System', function () {
         id5System.id5IdSubmodule.getId(getId5FetchConfig());
       });
     });
+
+    it('should pass true link info to ID5 server even when true link is not booted', function () {
+      let xhrServerMock = new XhrServerMock(server);
+      let submoduleResponse = callSubmoduleGetId(getId5FetchConfig(), undefined, ID5_STORED_OBJ);
+
+      return xhrServerMock.expectFetchRequest()
+        .then(fetchRequest => {
+          let requestBody = JSON.parse(fetchRequest.requestBody);
+          expect(requestBody.true_link).is.deep.equal({booted: false});
+          fetchRequest.respond(200, responseHeader, JSON.stringify(ID5_JSON_RESPONSE));
+          return submoduleResponse;
+        });
+    });
+
+    it('should pass full true link info to ID5 server when true link is booted', function () {
+      let xhrServerMock = new XhrServerMock(server);
+      let trueLinkResponse = {booted: true, redirected: true, id: 'TRUE_LINK_ID'};
+      window.id5Bootstrap = {
+        getTrueLinkInfo: function () {
+          return trueLinkResponse;
+        }
+      };
+      let submoduleResponse = callSubmoduleGetId(getId5FetchConfig(), undefined, ID5_STORED_OBJ);
+
+      return xhrServerMock.expectFetchRequest()
+        .then(fetchRequest => {
+          let requestBody = JSON.parse(fetchRequest.requestBody);
+          expect(requestBody.true_link).is.deep.equal(trueLinkResponse);
+          fetchRequest.respond(200, responseHeader, JSON.stringify(ID5_JSON_RESPONSE));
+          return submoduleResponse;
+        });
+    });
   });
 
   describe('Local storage', () => {
@@ -950,6 +996,31 @@ describe('ID5 ID System', function () {
       }, {adUnits});
     });
 
+    it('should add stored TRUE_LINK_ID from cache to bids', function (done) {
+      id5System.storeInLocalStorage(id5System.ID5_STORAGE_NAME, JSON.stringify(ID5_STORED_OBJ_WITH_TRUE_LINK), 1);
+
+      init(config);
+      setSubmoduleRegistry([id5System.id5IdSubmodule]);
+      config.setConfig(getFetchLocalStorageConfig());
+
+      requestBidsHook(wrapAsyncExpects(done, function () {
+        adUnits.forEach(unit => {
+          unit.bids.forEach(bid => {
+            expect(bid).to.have.deep.nested.property(`userId.trueLinkId`);
+            expect(bid.userId.trueLinkId.uid).is.equal(TRUE_LINK_STORED_ID);
+            expect(bid.userIdAsEids[1]).is.deep.equal({
+              source: TRUE_LINK_SOURCE,
+              uids: [{
+                id: TRUE_LINK_STORED_ID,
+                atype: 1,
+              }]
+            });
+          });
+        });
+        done();
+      }), {adUnits});
+    });
+
     it('should add config value ID to bids', function (done) {
       init(config);
       setSubmoduleRegistry([id5System.id5IdSubmodule]);
@@ -1056,6 +1127,11 @@ describe('ID5 ID System', function () {
         'ext': {'provider': ID5_SOURCE}
       });
     });
+    it('should decode trueLinkId from a stored object with trueLinkId', function () {
+      expect(id5System.id5IdSubmodule.decode(ID5_STORED_OBJ_WITH_TRUE_LINK, getId5FetchConfig()).trueLinkId).is.deep.equal({
+        'uid': TRUE_LINK_STORED_ID
+      });
+    });
   });
 
   describe('A/B Testing', function () {