prebid.js 7.46.0 → 7.48.0

package/test/spec/modules/greenbidsRtdProvider_spec.js

@@ -0,0 +1,210 @@
+import { expect } from 'chai';
+import sinon from 'sinon';
+import {
+  deepClone,
+} from '../../../src/utils.js';
+import {
+  greenbidsSubmodule
+} from 'modules/greenbidsRtdProvider.js';
+
+describe('greenbidsRtdProvider', () => {
+  let server;
+
+  beforeEach(() => {
+    server = sinon.createFakeServer();
+  });
+
+  afterEach(() => {
+    server.restore();
+  });
+
+  const endPoint = 'europe-west1-greenbids-357713.cloudfunctions.net';
+
+  const SAMPLE_MODULE_CONFIG = {
+    params: {
+      pbuid: '12345',
+      timeout: 200,
+      targetTPR: 0.95
+    }
+  };
+
+  const SAMPLE_REQUEST_BIDS_CONFIG_OBJ = {
+    adUnits: [
+      {
+        code: 'adUnit1',
+        bids: [
+          { bidder: 'appnexus', params: {} },
+          { bidder: 'rubicon', params: {} },
+          { bidder: 'ix', params: {} }
+        ]
+      },
+      {
+        code: 'adUnit2',
+        bids: [
+          { bidder: 'appnexus', params: {} },
+          { bidder: 'rubicon', params: {} },
+          { bidder: 'openx', params: {} }
+        ]
+      }]
+  };
+
+  const SAMPLE_RESPONSE_ADUNITS = [
+    {
+      code: 'adUnit1',
+      bidders: {
+        'appnexus': true,
+        'rubicon': false,
+        'ix': true
+      }
+    },
+    {
+      code: 'adUnit2',
+      bidders: {
+        'appnexus': false,
+        'rubicon': true,
+        'openx': true
+      }
+    }];
+
+  describe('init', () => {
+    it('should return true and set rtdOptions if pbuid is present', () => {
+      const result = greenbidsSubmodule.init(SAMPLE_MODULE_CONFIG);
+      expect(result).to.be.true;
+    });
+
+    it('should return false if pbuid is not present', () => {
+      const result = greenbidsSubmodule.init({ params: {} });
+      expect(result).to.be.false;
+    });
+  });
+
+  describe('updateAdUnitsBasedOnResponse', () => {
+    it('should update ad units based on response', () => {
+      const adUnits = JSON.parse(JSON.stringify(SAMPLE_REQUEST_BIDS_CONFIG_OBJ.adUnits));
+      greenbidsSubmodule.updateAdUnitsBasedOnResponse(adUnits, SAMPLE_RESPONSE_ADUNITS);
+
+      expect(adUnits[0].bids).to.have.length(2);
+      expect(adUnits[1].bids).to.have.length(2);
+    });
+  });
+
+  describe('findMatchingAdUnit', () => {
+    it('should find matching ad unit by code', () => {
+      const matchingAdUnit = greenbidsSubmodule.findMatchingAdUnit(SAMPLE_RESPONSE_ADUNITS, 'adUnit1');
+      expect(matchingAdUnit).to.deep.equal(SAMPLE_RESPONSE_ADUNITS[0]);
+    });
+    it('should return undefined if no matching ad unit is found', () => {
+      const matchingAdUnit = greenbidsSubmodule.findMatchingAdUnit(SAMPLE_RESPONSE_ADUNITS, 'nonexistent');
+      expect(matchingAdUnit).to.be.undefined;
+    });
+  });
+
+  describe('removeFalseBidders', () => {
+    it('should remove bidders with false value', () => {
+      const adUnit = JSON.parse(JSON.stringify(SAMPLE_REQUEST_BIDS_CONFIG_OBJ.adUnits[0]));
+      const matchingAdUnit = SAMPLE_RESPONSE_ADUNITS[0];
+      greenbidsSubmodule.removeFalseBidders(adUnit, matchingAdUnit);
+      expect(adUnit.bids).to.have.length(2);
+      expect(adUnit.bids.map((bid) => bid.bidder)).to.not.include('rubicon');
+    });
+  });
+
+  describe('getFalseBidders', () => {
+    it('should return an array of false bidders', () => {
+      const bidders = {
+        appnexus: true,
+        rubicon: false,
+        ix: true,
+        openx: false
+      };
+      const falseBidders = greenbidsSubmodule.getFalseBidders(bidders);
+      expect(falseBidders).to.have.length(2);
+      expect(falseBidders).to.include('rubicon');
+      expect(falseBidders).to.include('openx');
+    });
+  });
+
+  describe('getBidRequestData', () => {
+    it('Callback is called if the server responds a 200 within the time limit', (done) => {
+      let requestBids = deepClone(SAMPLE_REQUEST_BIDS_CONFIG_OBJ);
+      let callback = sinon.stub();
+
+      greenbidsSubmodule.getBidRequestData(requestBids, callback, SAMPLE_MODULE_CONFIG);
+
+      setTimeout(() => {
+        server.requests[0].respond(
+          200,
+          {'Content-Type': 'application/json'},
+          JSON.stringify(SAMPLE_RESPONSE_ADUNITS)
+        );
+        done();
+      }, 50);
+
+      setTimeout(() => {
+        const requestUrl = new URL(server.requests[0].url);
+        expect(requestUrl.host).to.be.eq(endPoint);
+        expect(requestBids.adUnits[0].bids).to.have.length(2);
+        expect(requestBids.adUnits[0].bids.map((bid) => bid.bidder)).to.not.include('rubicon');
+        expect(requestBids.adUnits[0].bids.map((bid) => bid.bidder)).to.include('ix');
+        expect(requestBids.adUnits[0].bids.map((bid) => bid.bidder)).to.include('appnexus');
+        expect(requestBids.adUnits[1].bids).to.have.length(2);
+        expect(requestBids.adUnits[1].bids.map((bid) => bid.bidder)).to.not.include('appnexus');
+        expect(requestBids.adUnits[1].bids.map((bid) => bid.bidder)).to.include('rubicon');
+        expect(requestBids.adUnits[1].bids.map((bid) => bid.bidder)).to.include('openx');
+        expect(callback.calledOnce).to.be.true;
+      }, 60);
+    });
+  });
+
+  describe('getBidRequestData', () => {
+    it('Nothing changes if the server times out but still the callback is called', (done) => {
+      let requestBids = deepClone(SAMPLE_REQUEST_BIDS_CONFIG_OBJ);
+      let callback = sinon.stub();
+
+      greenbidsSubmodule.getBidRequestData(requestBids, callback, SAMPLE_MODULE_CONFIG);
+
+      setTimeout(() => {
+        server.requests[0].respond(
+          200,
+          {'Content-Type': 'application/json'},
+          JSON.stringify(SAMPLE_RESPONSE_ADUNITS)
+        );
+        done();
+      }, 300);
+
+      setTimeout(() => {
+        const requestUrl = new URL(server.requests[0].url);
+        expect(requestUrl.host).to.be.eq(endPoint);
+        expect(requestBids.adUnits[0].bids).to.have.length(3);
+        expect(requestBids.adUnits[1].bids).to.have.length(3);
+        expect(callback.calledOnce).to.be.true;
+      }, 200);
+    });
+  });
+
+  describe('getBidRequestData', () => {
+    it('callback is called if the server responds a 500 error within the time limit and no changes are made', (done) => {
+      let requestBids = deepClone(SAMPLE_REQUEST_BIDS_CONFIG_OBJ);
+      let callback = sinon.stub();
+
+      greenbidsSubmodule.getBidRequestData(requestBids, callback, SAMPLE_MODULE_CONFIG);
+
+      setTimeout(() => {
+        server.requests[0].respond(
+          500,
+          {'Content-Type': 'application/json'},
+          JSON.stringify({'failure': 'fail'})
+        );
+        done();
+      }, 50);
+
+      setTimeout(() => {
+        const requestUrl = new URL(server.requests[0].url);
+        expect(requestUrl.host).to.be.eq(endPoint);
+        expect(requestBids.adUnits[0].bids).to.have.length(3);
+        expect(requestBids.adUnits[1].bids).to.have.length(3);
+        expect(callback.calledOnce).to.be.true;
+      }, 60);
+    });
+  });
+});

package/test/spec/modules/relevantdigitalBidAdapter_spec.js

@@ -0,0 +1,295 @@
+import {spec, resetBidderConfigs} from 'modules/relevantdigitalBidAdapter.js';
+import { parseUrl, deepClone } from 'src/utils.js';
+
+const expect = require('chai').expect;
+
+const PBS_HOST = 'dev-api.relevant-digital.com';
+const PLACEMENT_ID = 'example_placement_id';
+const ACCOUNT_ID = 'example_account_id';
+const TEST_DOMAIN = 'example.com';
+const TEST_PAGE = `https://${TEST_DOMAIN}/page.html`;
+
+const BID_REQUEST =
+{
+  'bidder': 'relevantdigital',
+  'params': {
+    'placementId': PLACEMENT_ID,
+    'accountId': ACCOUNT_ID,
+    'pbsHost': PBS_HOST,
+  },
+  'ortb2Imp': {
+    'ext': {
+      'tid': 'e13391ea-00f3-495d-99a6-d937990d73a9'
+    }
+  },
+  'mediaTypes': {
+    'banner': {
+      'sizes': [
+        [
+          300,
+          250
+        ],
+      ]
+    }
+  },
+  'adUnitCode': '/19968336/header-bid-tag-0',
+  'transactionId': 'e13391ea-00f3-495d-99a6-d937990d73a9',
+  'sizes': [
+    [
+      300,
+      250
+    ],
+  ],
+  'bidId': '2d69406037a662',
+  'bidderRequestId': '1decd098c76ed2',
+  'auctionId': '251a6a36-a5c5-4b82-b2b3-538c148a29dd',
+  'src': 'client',
+  'metrics': {
+    'requestBids.validate': 0.7,
+    'requestBids.makeRequests': 2.9,
+    'adapter.client.validate': 0.4,
+    'adapters.client.relevantdigital.validate': 0.4
+  },
+  'bidRequestsCount': 1,
+  'bidderRequestsCount': 1,
+  'bidderWinsCount': 0,
+  'ortb2': {
+    'site': {
+      'page': TEST_PAGE,
+      'domain': TEST_DOMAIN,
+      'publisher': {
+        'domain': 'relevant-digital.com'
+      }
+    },
+    'device': {
+      'w': 1848,
+      'h': 1007,
+      'dnt': 0,
+      'ua': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36',
+      'language': 'en',
+      'sua': {
+        'source': 2,
+        'platform': {
+          'brand': 'Linux',
+          'version': [
+            '5',
+            '4',
+            '0'
+          ]
+        },
+        'browsers': [
+          {
+            'brand': 'Google Chrome',
+            'version': [
+              '111',
+              '0',
+              '5563',
+              '146'
+            ]
+          },
+        ],
+        'mobile': 0,
+        'model': '',
+        'bitness': '64',
+        'architecture': 'x86'
+      }
+    }
+  }
+};
+
+const BIDDER_REQUEST = {
+  'bidderCode': BID_REQUEST.bidder,
+  'auctionId': BID_REQUEST.auctionId,
+  'bidderRequestId': BID_REQUEST.bidderRequestId,
+  'bids': [BID_REQUEST],
+  'metrics': BID_REQUEST.metrics,
+  'ortb2': BID_REQUEST.ortb2,
+  'auctionStart': 1681224591370,
+  'timeout': 1000,
+  'refererInfo': {
+    'reachedTop': true,
+    'isAmp': false,
+    'numIframes': 0,
+    'stack': [
+      TEST_PAGE
+    ],
+    'topmostLocation': TEST_PAGE,
+    'location': TEST_PAGE,
+    'canonicalUrl': null,
+    'page': TEST_PAGE,
+    'domain': TEST_DOMAIN,
+    'ref': null,
+    'legacy': {
+      'reachedTop': true,
+      'isAmp': false,
+      'numIframes': 0,
+      'stack': [
+        TEST_PAGE
+      ],
+      'referer': TEST_PAGE,
+      'canonicalUrl': null
+    }
+  },
+  'start': 1681224591375
+};
+
+const BID_RESPONSE = {
+  'seatbid': [
+    {
+      'bid': [
+        {
+          'id': '613673EF-A07C-4486-8EE9-3FC71A7DC73D',
+          'impid': BID_REQUEST.bidId,
+          'price': 10.76091063668997,
+          'adm': '<html><a href="http://www.pubmatic.com" target="_blank"><img src ="https://stagingva.pubmatic.com:8443/image/300x250.jpg" /></a></html>',
+          'adomain': [
+            'www.addomain.com'
+          ],
+          'iurl': 'http://localhost11',
+          'crid': 'creative111',
+          'w': 300,
+          'h': 250,
+          'ext': {
+            'bidtype': 0,
+            'dspid': 6,
+            'origbidcpm': 1,
+            'origbidcur': 'USD',
+            'prebid': {
+              'meta': {
+                'adaptercode': 'pubmatic'
+              },
+              'targeting': {
+                'hb_bidder': 'pubmatic',
+                'hb_cache_host': PBS_HOST,
+                'hb_cache_path': '/analytics_cache/read',
+                'hb_format': 'banner',
+                'hb_pb': '10.70',
+                'hb_size': '300x250'
+              },
+              'type': 'banner',
+              'video': {
+                'duration': 0,
+                'primary_category': ''
+              },
+              'events': {
+                'win': `https://${PBS_HOST}/event?t=win&b=fed970f7-4295-456d-a251-38013faab795&a=620523ae7f4bbe1691bbb815&bidder=pubmatic&ts=1678646619765`,
+                'imp': `https://${PBS_HOST}/event?t=imp&b=fed970f7-4295-456d-a251-38013faab795&a=620523ae7f4bbe1691bbb815&bidder=pubmatic&ts=1678646619765`
+              },
+              'bidid': 'fed970f7-4295-456d-a251-38013faab795'
+            }
+          }
+        }
+      ],
+      'seat': 'pubmatic'
+    }
+  ],
+  'cur': 'SEK',
+  'ext': {
+    'responsetimemillis': {
+      'appnexus': 305,
+      'pubmatic': 156
+    },
+    'tmaxrequest': 750,
+    'relevant': {
+      'sync': [
+        { 'type': 'redirect', 'url': 'https://example1.com/sync' },
+        { 'type': 'redirect', 'url': 'https://example2.com/sync' },
+      ],
+    },
+    'prebid': {
+      'auctiontimestamp': 1678646619765,
+      'passthrough': {
+        'relevant': {
+          'bidder': spec.code
+        }
+      }
+    }
+  }
+};
+
+const S2S_RESPONSE_BIDDER = BID_RESPONSE.seatbid[0].seat;
+
+const resetAndBuildRequest = (params) => {
+  resetBidderConfigs();
+  const bidRequest = {
+    ...BID_REQUEST,
+    params: {
+      ...BID_REQUEST.params,
+      ...params,
+    },
+  };
+  return spec.buildRequests([bidRequest], BIDDER_REQUEST);
+};
+
+describe('Relevant Digital Bid Adaper', function () {
+  describe('buildRequests', () => {
+    const [request] = resetAndBuildRequest();
+    const {data, url} = request
+    it('should give the correct URL', () => {
+      expect(url).equal(`https://${PBS_HOST}/openrtb2/auction`);
+    });
+    it('should set the correct stored request ids', () => {
+      expect(data.ext.prebid.storedrequest.id).equal(ACCOUNT_ID);
+      expect(data.imp[0].ext.prebid.storedrequest.id).equal(PLACEMENT_ID);
+    });
+    it('should include bidder code in passthrough object', () => {
+      expect(data.ext.prebid.passthrough.relevant.bidder).equal(spec.code);
+    });
+    it('should set tmax to something below the timeout', () => {
+      expect(data.tmax).be.greaterThan(0);
+      expect(data.tmax).be.lessThan(BIDDER_REQUEST.timeout)
+    });
+  });
+  describe('interpreteResponse', () => {
+    const [request] = resetAndBuildRequest();
+    const [bid] = spec.interpretResponse({ body: BID_RESPONSE }, request);
+    it('should not have S2S bidder\'s bidder code', () => {
+      expect(bid.bidderCode).not.equal(S2S_RESPONSE_BIDDER);
+    });
+    it('should return the right creative content', () => {
+      const respBid = BID_RESPONSE.seatbid[0].bid[0];
+      expect(bid.cpm).equal(respBid.price);
+      expect(bid.ad).equal(respBid.adm);
+      expect(bid.width).equal(respBid.w);
+      expect(bid.height).equal(respBid.h);
+    });
+  });
+  describe('interpreteResponse with useSourceBidderCode', () => {
+    const [request] = resetAndBuildRequest({ useSourceBidderCode: true });
+    const [bid] = spec.interpretResponse({ body: BID_RESPONSE }, request);
+    it('should have S2S bidder\'s code', () => {
+      expect(bid.bidderCode).equal(S2S_RESPONSE_BIDDER);
+    });
+  });
+  describe('getUserSyncs with iframeEnabled', () => {
+    resetAndBuildRequest()
+    const allSyncs = spec.getUserSyncs({ iframeEnabled: true }, [{ body: BID_RESPONSE }], null, null);
+    const [{ url, type }] = allSyncs;
+    const { bidders, endpoint } = parseUrl(url).search;
+    it('should return a single sync object', () => {
+      expect(allSyncs.length).equal(1);
+    });
+    it('should use iframe sync when available', () => {
+      expect(type).equal('iframe');
+    });
+    it('should sync to all s2s bidders', () => {
+      expect(bidders.split(',').sort()).to.deep.equal(['appnexus', 'pubmatic']);
+    });
+    it('should sync to the right endpoint', () => {
+      expect(endpoint).equal(`https://${PBS_HOST}/cookie_sync`);
+    });
+    it('should not sync to the same s2s bidders when called again', () => {
+      const newSyncs = spec.getUserSyncs({ iframeEnabled: true }, [{ body: BID_RESPONSE }], null, null);
+      expect(newSyncs).to.deep.equal([]);
+    });
+  });
+  describe('getUserSyncs with pixelEnabled', () => {
+    resetAndBuildRequest()
+    const responseSyncs = BID_RESPONSE.ext.relevant.sync;
+    const allSyncs = spec.getUserSyncs({ pixelEnabled: true }, [{ body: BID_RESPONSE }], null, null);
+    it('should return one sync object per pixel', () => {
+      const expectedResult = responseSyncs.map(({ url }) => ({url, type: 'image'}));
+      expect(allSyncs).to.deep.equal(expectedResult)
+    });
+  });
+});

package/test/spec/modules/rtbhouseBidAdapter_spec.js

@@ -282,6 +282,28 @@ describe('RTBHouseAdapter', () => {
       expect(data.source).to.not.have.property('ext');
     });
 
+    it('should include first party data', function () {
+      const bidRequest = Object.assign([], bidRequests);
+      const localBidderRequest = {
+        ...bidderRequest,
+        ortb2: {
+          bcat: ['IAB1', 'IAB2-1'],
+          badv: ['domain1.com', 'domain2.com'],
+          site: { ext: { data: 'some site data' } },
+          device: { ext: { data: 'some device data' } },
+          user: { ext: { data: 'some user data' } }
+        }
+      };
+
+      const request = spec.buildRequests(bidRequest, localBidderRequest);
+      const data = JSON.parse(request.data);
+      expect(data.bcat).to.deep.equal(localBidderRequest.ortb2.bcat);
+      expect(data.badv).to.deep.equal(localBidderRequest.ortb2.badv);
+      expect(data.site).to.nested.include({'ext.data': 'some site data'});
+      expect(data.device).to.nested.include({'ext.data': 'some device data'});
+      expect(data.user).to.nested.include({'ext.data': 'some user data'});
+    });
+
     context('FLEDGE', function() {
       afterEach(function () {
         config.resetConfig();
@@ -631,10 +653,10 @@ describe('RTBHouseAdapter', () => {
         expect(bids[0].meta.advertiserDomains).to.deep.equal(['rtbhouse.com']);
         expect(bids[0].native).to.deep.equal({
           title: 'Title text',
-          clickUrl: encodeURIComponent('https://example.com'),
+          clickUrl: encodeURI('https://example.com'),
           impressionTrackers: ['https://example.com/imptracker'],
           image: {
-            url: encodeURIComponent('https://example.com/image.jpg'),
+            url: encodeURI('https://example.com/image.jpg'),
             width: 150,
             height: 50
           },

package/test/spec/modules/sovrnBidAdapter_spec.js

@@ -248,6 +248,71 @@ describe('sovrnBidAdapter', function() {
       expect(data.regs.ext['us_privacy']).to.equal(bidderRequest.uspConsent)
     })
 
+    it('should send gpp info in OpenRTB 2.6 location when gppConsent defined', function () {
+      const bidderRequest = {
+        ...baseBidderRequest,
+        bidderCode: 'sovrn',
+        auctionId: '1d1a030790a475',
+        bidderRequestId: '22edbae2733bf6',
+        timeout: 3000,
+        gppConsent: {
+          gppString: 'gppstring',
+          applicableSections: [8]
+        },
+        bids: [baseBidRequest]
+      }
+      const { regs } = JSON.parse(spec.buildRequests([baseBidRequest], bidderRequest).data)
+      expect(regs.gpp).to.equal('gppstring')
+      expect(regs.gpp_sid).to.be.an('array')
+      expect(regs.gpp_sid).to.include(8)
+    })
+
+    it('should not send gpp info when gppConsent is not defined', function () {
+      const bidderRequest = {
+        ...baseBidderRequest,
+        bidderCode: 'sovrn',
+        auctionId: '1d1a030790a475',
+        bidderRequestId: '22edbae2733bf6',
+        timeout: 3000,
+        bids: [baseBidRequest],
+        gdprConsent: {
+          consentString: 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A==',
+          gdprApplies: true
+        },
+      }
+      const { regs } = JSON.parse(spec.buildRequests([baseBidRequest], bidderRequest).data)
+      expect(regs.gpp).to.be.undefined
+    })
+
+    it('should send gdpr info even when gppConsent defined', function () {
+      const bidderRequest = {
+        ...baseBidderRequest,
+        bidderCode: 'sovrn',
+        auctionId: '1d1a030790a475',
+        bidderRequestId: '22edbae2733bf6',
+        timeout: 3000,
+        gdprConsent: {
+          consentString: 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A==',
+          gdprApplies: true
+        },
+        gppConsent: {
+          gppString: 'gppstring',
+          applicableSections: [8]
+        },
+        bids: [baseBidRequest]
+      }
+
+      const { regs, user } = JSON.parse(spec.buildRequests([baseBidRequest], bidderRequest).data)
+
+      expect(regs.ext.gdpr).to.exist.and.to.be.a('number')
+      expect(regs.ext.gdpr).to.equal(1)
+      expect(user.ext.consent).to.exist.and.to.be.a('string')
+      expect(user.ext.consent).to.equal(bidderRequest.gdprConsent.consentString)
+      expect(regs.gpp).to.equal('gppstring')
+      expect(regs.gpp_sid).to.be.an('array')
+      expect(regs.gpp_sid).to.include(8)
+    })
+
     it('should add schain if present', function() {
       const schainRequest = {
         ...baseBidRequest,