prebid.js 7.31.0 → 7.32.0

package/test/spec/modules/appushBidAdapter_spec.js

@@ -0,0 +1,372 @@
+import { expect } from 'chai';
+import { spec } from '../../../modules/appushBidAdapter.js';
+import { BANNER, VIDEO, NATIVE } from '../../../src/mediaTypes.js';
+import { getUniqueIdentifierStr } from '../../../src/utils.js';
+
+const bidder = 'appush'
+
+describe('AppushBidAdapter', function () {
+  const bids = [
+    {
+      bidId: getUniqueIdentifierStr(),
+      bidder: bidder,
+      mediaTypes: {
+        [BANNER]: {
+          sizes: [[300, 250]]
+        }
+      },
+      params: {
+        placementId: 'testBanner',
+      }
+    },
+    {
+      bidId: getUniqueIdentifierStr(),
+      bidder: bidder,
+      mediaTypes: {
+        [VIDEO]: {
+          playerSize: [[300, 300]],
+          minduration: 5,
+          maxduration: 60
+        }
+      },
+      params: {
+        placementId: 'testVideo',
+      }
+    },
+    {
+      bidId: getUniqueIdentifierStr(),
+      bidder: bidder,
+      mediaTypes: {
+        [NATIVE]: {
+          native: {
+            title: {
+              required: true
+            },
+            body: {
+              required: true
+            },
+            icon: {
+              required: true,
+              size: [64, 64]
+            }
+          }
+        }
+      },
+      params: {
+        placementId: 'testNative',
+      }
+    }
+  ];
+
+  const invalidBid = {
+    bidId: getUniqueIdentifierStr(),
+    bidder: bidder,
+    mediaTypes: {
+      [BANNER]: {
+        sizes: [[300, 250]]
+      }
+    },
+    params: {
+
+    }
+  }
+
+  const bidderRequest = {
+    uspConsent: '1---',
+    gdprConsent: 'COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA.IFoEUQQgAIQwgIwQABAEAAAAOIAACAIAAAAQAIAgEAACEAAAAAgAQBAAAAAAAGBAAgAAAAAAAFAAECAAAgAAQARAEQAAAAAJAAIAAgAAAYQEAAAQmAgBC3ZAYzUw',
+    refererInfo: {
+      referer: 'https://test.com'
+    }
+  };
+
+  describe('isBidRequestValid', function () {
+    it('Should return true if there are bidId, params and key parameters present', function () {
+      expect(spec.isBidRequestValid(bids[0])).to.be.true;
+    });
+    it('Should return false if at least one of parameters is not present', function () {
+      expect(spec.isBidRequestValid(invalidBid)).to.be.false;
+    });
+  });
+
+  describe('buildRequests', function () {
+    let serverRequest = spec.buildRequests(bids, bidderRequest);
+
+    it('Creates a ServerRequest object with method, URL and data', function () {
+      expect(serverRequest).to.exist;
+      expect(serverRequest.method).to.exist;
+      expect(serverRequest.url).to.exist;
+      expect(serverRequest.data).to.exist;
+    });
+
+    it('Returns POST method', function () {
+      expect(serverRequest.method).to.equal('POST');
+    });
+
+    it('Returns valid URL', function () {
+      expect(serverRequest.url).to.equal('https://hb.appush.com/pbjs');
+    });
+
+    it('Returns general data valid', function () {
+      let data = serverRequest.data;
+      expect(data).to.be.an('object');
+      expect(data).to.have.all.keys('deviceWidth',
+        'deviceHeight',
+        'language',
+        'secure',
+        'host',
+        'page',
+        'placements',
+        'coppa',
+        'ccpa',
+        'gdpr',
+        'tmax'
+      );
+      expect(data.deviceWidth).to.be.a('number');
+      expect(data.deviceHeight).to.be.a('number');
+      expect(data.language).to.be.a('string');
+      expect(data.secure).to.be.within(0, 1);
+      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.ccpa).to.be.a('string');
+      expect(data.tmax).to.be.a('number');
+      expect(data.placements).to.have.lengthOf(3);
+    });
+
+    it('Returns valid placements', function () {
+      const { placements } = serverRequest.data;
+      for (let i = 0, len = placements.length; i < len; i++) {
+        const placement = placements[i];
+        expect(placement.placementId).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('publisher');
+
+        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 data with gdprConsent and without uspConsent', function () {
+      delete bidderRequest.uspConsent;
+      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.ccpa).to.not.exist;
+      delete bidderRequest.gdprConsent;
+    });
+
+    it('Returns data with uspConsent and without gdprConsent', function () {
+      bidderRequest.uspConsent = '1---';
+      delete bidderRequest.gdprConsent;
+      serverRequest = spec.buildRequests(bids, bidderRequest);
+      let data = serverRequest.data;
+      expect(data.ccpa).to.exist;
+      expect(data.ccpa).to.be.a('string');
+      expect(data.ccpa).to.equal(bidderRequest.uspConsent);
+      expect(data.gdpr).to.not.exist;
+    });
+
+    it('Returns empty data if no valid requests are passed', function () {
+      serverRequest = spec.buildRequests([], bidderRequest);
+      let data = serverRequest.data;
+      expect(data.placements).to.be.an('array').that.is.empty;
+    });
+  });
+
+  describe('interpretResponse', function () {
+    it('Should interpret banner response', function () {
+      const banner = {
+        body: [{
+          mediaType: 'banner',
+          width: 300,
+          height: 250,
+          cpm: 0.4,
+          ad: 'Test',
+          requestId: '23fhj33i987f',
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1',
+          meta: {
+            advertiserDomains: ['google.com'],
+            advertiserId: 1234
+          }
+        }]
+      };
+      let bannerResponses = spec.interpretResponse(banner);
+      expect(bannerResponses).to.be.an('array').that.is.not.empty;
+      let dataItem = bannerResponses[0];
+      expect(dataItem).to.have.all.keys('requestId', 'cpm', 'width', 'height', 'ad', 'ttl', 'creativeId',
+        'netRevenue', 'currency', 'dealId', 'mediaType', 'meta');
+      expect(dataItem.requestId).to.equal(banner.body[0].requestId);
+      expect(dataItem.cpm).to.equal(banner.body[0].cpm);
+      expect(dataItem.width).to.equal(banner.body[0].width);
+      expect(dataItem.height).to.equal(banner.body[0].height);
+      expect(dataItem.ad).to.equal(banner.body[0].ad);
+      expect(dataItem.ttl).to.equal(banner.body[0].ttl);
+      expect(dataItem.creativeId).to.equal(banner.body[0].creativeId);
+      expect(dataItem.netRevenue).to.be.true;
+      expect(dataItem.currency).to.equal(banner.body[0].currency);
+      expect(dataItem.meta).to.be.an('object').that.has.any.key('advertiserDomains');
+    });
+    it('Should interpret video response', function () {
+      const video = {
+        body: [{
+          vastUrl: 'test.com',
+          mediaType: 'video',
+          cpm: 0.5,
+          requestId: '23fhj33i987f',
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1',
+          meta: {
+            advertiserDomains: ['google.com'],
+            advertiserId: 1234
+          }
+        }]
+      };
+      let videoResponses = spec.interpretResponse(video);
+      expect(videoResponses).to.be.an('array').that.is.not.empty;
+
+      let dataItem = videoResponses[0];
+      expect(dataItem).to.have.all.keys('requestId', 'cpm', 'vastUrl', 'ttl', 'creativeId',
+        'netRevenue', 'currency', 'dealId', 'mediaType', 'meta');
+      expect(dataItem.requestId).to.equal('23fhj33i987f');
+      expect(dataItem.cpm).to.equal(0.5);
+      expect(dataItem.vastUrl).to.equal('test.com');
+      expect(dataItem.ttl).to.equal(120);
+      expect(dataItem.creativeId).to.equal('2');
+      expect(dataItem.netRevenue).to.be.true;
+      expect(dataItem.currency).to.equal('USD');
+      expect(dataItem.meta).to.be.an('object').that.has.any.key('advertiserDomains');
+    });
+    it('Should interpret native response', function () {
+      const native = {
+        body: [{
+          mediaType: 'native',
+          native: {
+            clickUrl: 'test.com',
+            title: 'Test',
+            image: 'test.com',
+            impressionTrackers: ['test.com'],
+          },
+          ttl: 120,
+          cpm: 0.4,
+          requestId: '23fhj33i987f',
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          meta: {
+            advertiserDomains: ['google.com'],
+            advertiserId: 1234
+          }
+        }]
+      };
+      let nativeResponses = spec.interpretResponse(native);
+      expect(nativeResponses).to.be.an('array').that.is.not.empty;
+
+      let dataItem = nativeResponses[0];
+      expect(dataItem).to.have.keys('requestId', 'cpm', 'ttl', 'creativeId', 'netRevenue', 'currency', 'mediaType', 'native', 'meta');
+      expect(dataItem.native).to.have.keys('clickUrl', 'impressionTrackers', 'title', 'image')
+      expect(dataItem.requestId).to.equal('23fhj33i987f');
+      expect(dataItem.cpm).to.equal(0.4);
+      expect(dataItem.native.clickUrl).to.equal('test.com');
+      expect(dataItem.native.title).to.equal('Test');
+      expect(dataItem.native.image).to.equal('test.com');
+      expect(dataItem.native.impressionTrackers).to.be.an('array').that.is.not.empty;
+      expect(dataItem.native.impressionTrackers[0]).to.equal('test.com');
+      expect(dataItem.ttl).to.equal(120);
+      expect(dataItem.creativeId).to.equal('2');
+      expect(dataItem.netRevenue).to.be.true;
+      expect(dataItem.currency).to.equal('USD');
+      expect(dataItem.meta).to.be.an('object').that.has.any.key('advertiserDomains');
+    });
+    it('Should return an empty array if invalid banner response is passed', function () {
+      const invBanner = {
+        body: [{
+          width: 300,
+          cpm: 0.4,
+          ad: 'Test',
+          requestId: '23fhj33i987f',
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1'
+        }]
+      };
+
+      let serverResponses = spec.interpretResponse(invBanner);
+      expect(serverResponses).to.be.an('array').that.is.empty;
+    });
+    it('Should return an empty array if invalid video response is passed', function () {
+      const invVideo = {
+        body: [{
+          mediaType: 'video',
+          cpm: 0.5,
+          requestId: '23fhj33i987f',
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1'
+        }]
+      };
+      let serverResponses = spec.interpretResponse(invVideo);
+      expect(serverResponses).to.be.an('array').that.is.empty;
+    });
+    it('Should return an empty array if invalid native response is passed', function () {
+      const invNative = {
+        body: [{
+          mediaType: 'native',
+          clickUrl: 'test.com',
+          title: 'Test',
+          impressionTrackers: ['test.com'],
+          ttl: 120,
+          requestId: '23fhj33i987f',
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+        }]
+      };
+      let serverResponses = spec.interpretResponse(invNative);
+      expect(serverResponses).to.be.an('array').that.is.empty;
+    });
+    it('Should return an empty array if invalid response is passed', function () {
+      const invalid = {
+        body: [{
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1'
+        }]
+      };
+      let serverResponses = spec.interpretResponse(invalid);
+      expect(serverResponses).to.be.an('array').that.is.empty;
+    });
+  });
+});

package/test/spec/modules/connectIdSystem_spec.js

@@ -31,7 +31,11 @@ describe('Yahoo ConnectID Submodule', () => {
           gdprApplies: 1,
           consentString: 'GDPR_CONSENT_STRING'
         },
-        uspConsent: 'USP_CONSENT_STRING'
+        uspConsent: 'USP_CONSENT_STRING',
+        gppConsent: {
+          gppString: 'header~section6~section7',
+          applicableSections: [6, 7]
+        }
       };
     });
 
@@ -157,7 +161,9 @@ describe('Yahoo ConnectID Submodule', () => {
         '1p': '0',
         gdpr: '1',
         gdpr_consent: consentData.gdpr.consentString,
-        us_privacy: consentData.uspConsent
+        us_privacy: consentData.uspConsent,
+        gpp: consentData.gppConsent.gppString,
+        gpp_sid: '6%2C7'
       };
       const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
 
@@ -178,7 +184,9 @@ describe('Yahoo ConnectID Submodule', () => {
         '1p': '0',
         gdpr: '1',
         gdpr_consent: consentData.gdpr.consentString,
-        us_privacy: consentData.uspConsent
+        us_privacy: consentData.uspConsent,
+        gpp: consentData.gppConsent.gppString,
+        gpp_sid: '6%2C7'
       };
       const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
 
@@ -201,7 +209,9 @@ describe('Yahoo ConnectID Submodule', () => {
         '1p': '0',
         gdpr: '1',
         gdpr_consent: consentData.gdpr.consentString,
-        us_privacy: consentData.uspConsent
+        us_privacy: consentData.uspConsent,
+        gpp: consentData.gppConsent.gppString,
+        gpp_sid: '6%2C7'
       };
       const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
 
@@ -221,7 +231,9 @@ describe('Yahoo ConnectID Submodule', () => {
         '1p': '0',
         gdpr: '1',
         gdpr_consent: consentData.gdpr.consentString,
-        us_privacy: consentData.uspConsent
+        us_privacy: consentData.uspConsent,
+        gpp: consentData.gppConsent.gppString,
+        gpp_sid: '6%2C7'
       };
       const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
 

package/test/spec/modules/feedadBidAdapter_spec.js

@@ -4,6 +4,7 @@ import {BANNER, NATIVE, VIDEO} from '../../../src/mediaTypes.js';
 import {server} from 'test/mocks/xhr.js';
 
 const CODE = 'feedad';
+const EXPECTED_ADAPTER_VERSION = '1.0.5';
 
 describe('FeedAdAdapter', function () {
   describe('Public API', function () {
@@ -300,6 +301,20 @@ describe('FeedAdAdapter', function () {
       expect(result.data.gdprApplies).to.equal(request.gdprConsent.gdprApplies);
       expect(result.data.consentIabTcf).to.equal(request.gdprConsent.consentString);
     });
+    it('should include adapter and prebid version', function () {
+      let bid = {
+        code: 'feedad',
+        mediaTypes: {
+          banner: {
+            sizes: [[320, 250]]
+          }
+        },
+        params: {clientToken: 'clientToken', placementId: 'placement-id'}
+      };
+      let result = spec.buildRequests([bid], bidderRequest);
+      expect(result.data.bids[0].params.prebid_adapter_version).to.equal(EXPECTED_ADAPTER_VERSION);
+      expect(result.data.bids[0].params.prebid_sdk_version).to.equal('$prebid.version$');
+    });
   });
 
   describe('interpretResponse', function () {
@@ -482,6 +497,12 @@ describe('FeedAdAdapter', function () {
         expect(() => spec.getUserSyncs({iframeEnabled: true, pixelEnabled: true}, it)).not.to.throw;
       });
     });
+
+    it('should return empty array if the body extension is null', function () {
+      const response = mockServerResponse({ext: null});
+      const result = spec.getUserSyncs({iframeEnabled: true, pixelEnabled: true}, response);
+      expect(result).to.deep.equal([]);
+    });
   });
 
   describe('event tracking calls', function () {
@@ -617,7 +638,8 @@ describe('FeedAdAdapter', function () {
             prebid_bid_id: bidId,
             prebid_transaction_id: transactionId,
             referer,
-            sdk_version: '1.0.4'
+            prebid_adapter_version: EXPECTED_ADAPTER_VERSION,
+            prebid_sdk_version: '$prebid.version$',
           };
           subject(data);
           expect(server.requests.length).to.equal(1);

package/test/spec/modules/holidBidAdapter_spec.js

@@ -0,0 +1,165 @@
+import { expect } from 'chai'
+import { spec } from 'modules/holidBidAdapter.js'
+
+describe('holidBidAdapterTests', () => {
+  const bidRequestData = {
+    bidder: 'holid',
+    adUnitCode: 'test-div',
+    bidId: 'bid-id',
+    auctionId: 'test-id',
+    params: { adUnitID: '12345' },
+    mediaTypes: { banner: {} },
+    sizes: [[300, 250]],
+    ortb2: {
+      site: {
+        publisher: {
+          domain: 'https://foo.bar',
+        }
+      },
+      regs: {
+        gdpr: 1,
+      },
+      user: {
+        ext: {
+          consent: 'G4ll0p1ng_Un1c0rn5',
+        }
+      },
+      device: {
+        h: 410,
+        w: 1860,
+      }
+    }
+  }
+
+  describe('isBidRequestValid', () => {
+    const bid = JSON.parse(JSON.stringify(bidRequestData))
+
+    it('should return true', () => {
+      expect(spec.isBidRequestValid(bid)).to.equal(true)
+    })
+
+    it('should return false when required params are not passed', () => {
+      const bid = JSON.parse(JSON.stringify(bidRequestData))
+      delete bid.params.adUnitID
+
+      expect(spec.isBidRequestValid(bid)).to.equal(false)
+    })
+  })
+
+  describe('buildRequests', () => {
+    const bid = JSON.parse(JSON.stringify(bidRequestData))
+    const request = spec.buildRequests([bid], bid)
+    const payload = JSON.parse(request[0].data)
+
+    it('should include ext in imp', () => {
+      expect(payload.imp[0].ext).to.exist
+      expect(payload.imp[0].ext).to.deep.equal({
+        prebid: { storedrequest: { id: '12345' } },
+      })
+    })
+
+    it('should include banner format in imp', () => {
+      expect(payload.imp[0].banner).to.exist
+      expect(payload.imp[0].banner).to.deep.equal({
+        format: [{ w: 300, h: 250 }],
+      })
+    })
+
+    it('should include ortb2 first party data', () => {
+      expect(payload.device.w).to.equal(1860)
+      expect(payload.device.h).to.equal(410)
+      expect(payload.user.ext.consent).to.equal('G4ll0p1ng_Un1c0rn5')
+      expect(payload.regs.gdpr).to.equal(1)
+    })
+  })
+
+  describe('interpretResponse', () => {
+    const serverResponse = {
+      body: {
+        id: 'test-id',
+        cur: 'USD',
+        seatbid: [
+          {
+            bid: [
+              {
+                id: 'testbidid',
+                price: 0.4,
+                adm: 'test-ad',
+                adid: 789456,
+                crid: 1234,
+                w: 300,
+                h: 250,
+              },
+            ],
+          },
+        ],
+      },
+    }
+
+    const interpretedResponse = spec.interpretResponse(
+      serverResponse,
+      bidRequestData
+    )
+
+    it('should interpret response', () => {
+      expect(interpretedResponse[0].requestId).to.equal(bidRequestData.bidId)
+      expect(interpretedResponse[0].cpm).to.equal(
+        serverResponse.body.seatbid[0].bid[0].price
+      )
+      expect(interpretedResponse[0].ad).to.equal(
+        serverResponse.body.seatbid[0].bid[0].adm
+      )
+      expect(interpretedResponse[0].creativeId).to.equal(
+        serverResponse.body.seatbid[0].bid[0].crid
+      )
+      expect(interpretedResponse[0].width).to.equal(
+        serverResponse.body.seatbid[0].bid[0].w
+      )
+      expect(interpretedResponse[0].height).to.equal(
+        serverResponse.body.seatbid[0].bid[0].h
+      )
+      expect(interpretedResponse[0].currency).to.equal(serverResponse.body.cur)
+    })
+  })
+
+  describe('getUserSyncs', () => {
+    it('should return user sync', () => {
+      const optionsType = {
+        iframeEnabled: true,
+        pixelEnabled: true,
+      }
+      const serverResponse = [
+        {
+          body: {
+            ext: {
+              responsetimemillis: {
+                'test seat 1': 2,
+                'test seat 2': 1,
+              },
+            },
+          },
+        },
+      ]
+      const gdprConsent = {
+        gdprApplies: 1,
+        consentString: 'dkj49Sjmfjuj34as:12jaf90123hufabidfy9u23brfpoig',
+      }
+      const uspConsent = 'mkjvbiniwot4827obfoy8sdg8203gb'
+      const expectedUserSyncs = [
+        {
+          type: 'iframe',
+          url: 'https://null.holid.io/sync.html?bidders=%5B%22test%20seat%201%22%2C%22test%20seat%202%22%5D&gdpr=1&gdpr_consent=dkj49Sjmfjuj34as:12jaf90123hufabidfy9u23brfpoig&usp_consent=mkjvbiniwot4827obfoy8sdg8203gb&type=iframe',
+        },
+      ]
+
+      const userSyncs = spec.getUserSyncs(
+        optionsType,
+        serverResponse,
+        gdprConsent,
+        uspConsent
+      )
+
+      expect(userSyncs).to.deep.equal(expectedUserSyncs)
+    })
+  })
+})