prebid.js 7.30.0 → 7.32.0

package/test/spec/modules/orbitsoftBidAdapter_spec.js

@@ -0,0 +1,255 @@
+import {expect} from 'chai';
+import {spec} from 'modules/orbitsoftBidAdapter.js';
+
+const ENDPOINT_URL = 'https://orbitsoft.com/php/ads/hb.phps';
+const REFERRER_URL = 'http://referrer.url/?_=';
+
+describe('Orbitsoft adapter', function () {
+  describe('implementation', function () {
+    describe('for requests', function () {
+      it('should accept valid bid', function () {
+        let validBid = {
+            bidder: 'orbitsoft',
+            params: {
+              placementId: '123',
+              requestUrl: ENDPOINT_URL
+            }
+          },
+          isValid = spec.isBidRequestValid(validBid);
+
+        expect(isValid).to.equal(true);
+      });
+
+      it('should reject invalid bid', function () {
+        let invalidBid = {
+            bidder: 'orbitsoft'
+          },
+          isValid = spec.isBidRequestValid(invalidBid);
+
+        expect(isValid).to.equal(false);
+      });
+    });
+    describe('for requests', function () {
+      it('should accept valid bid with styles', function () {
+        let validBid = {
+            bidder: 'orbitsoft',
+            params: {
+              placementId: '123',
+              requestUrl: ENDPOINT_URL,
+              style: {
+                title: {
+                  family: 'Tahoma',
+                  size: 'medium',
+                  weight: 'normal',
+                  style: 'normal',
+                  color: '0053F9'
+                },
+                description: {
+                  family: 'Tahoma',
+                  size: 'medium',
+                  weight: 'normal',
+                  style: 'normal',
+                  color: '0053F9'
+                },
+                url: {
+                  family: 'Tahoma',
+                  size: 'medium',
+                  weight: 'normal',
+                  style: 'normal',
+                  color: '0053F9'
+                },
+                colors: {
+                  background: 'ffffff',
+                  border: 'E0E0E0',
+                  link: '5B99FE'
+                }
+              }
+            },
+            refererInfo: {referer: REFERRER_URL},
+          },
+          isValid = spec.isBidRequestValid(validBid);
+        expect(isValid).to.equal(true);
+
+        let buildRequest = spec.buildRequests([validBid])[0];
+        let requestUrl = buildRequest.url;
+        let requestUrlParams = buildRequest.data;
+        expect(requestUrl).to.equal(ENDPOINT_URL);
+        expect(requestUrlParams).have.property('f1', 'Tahoma');
+        expect(requestUrlParams).have.property('fs1', 'medium');
+        expect(requestUrlParams).have.property('w1', 'normal');
+        expect(requestUrlParams).have.property('s1', 'normal');
+        expect(requestUrlParams).have.property('c3', '0053F9');
+        expect(requestUrlParams).have.property('f2', 'Tahoma');
+        expect(requestUrlParams).have.property('fs2', 'medium');
+        expect(requestUrlParams).have.property('w2', 'normal');
+        expect(requestUrlParams).have.property('s2', 'normal');
+        expect(requestUrlParams).have.property('c4', '0053F9');
+        expect(requestUrlParams).have.property('f3', 'Tahoma');
+        expect(requestUrlParams).have.property('fs3', 'medium');
+        expect(requestUrlParams).have.property('w3', 'normal');
+        expect(requestUrlParams).have.property('s3', 'normal');
+        expect(requestUrlParams).have.property('c5', '0053F9');
+        expect(requestUrlParams).have.property('c2', 'ffffff');
+        expect(requestUrlParams).have.property('c1', 'E0E0E0');
+        expect(requestUrlParams).have.property('c6', '5B99FE');
+      });
+
+      it('should accept valid bid with custom params', function () {
+        let validBid = {
+            bidder: 'orbitsoft',
+            params: {
+              placementId: '123',
+              requestUrl: ENDPOINT_URL,
+              customParams: {
+                cacheBuster: 'bf4d7c1',
+                clickUrl: 'http://testclickurl.com'
+              }
+            },
+            refererInfo: {referer: REFERRER_URL},
+          },
+          isValid = spec.isBidRequestValid(validBid);
+        expect(isValid).to.equal(true);
+
+        let buildRequest = spec.buildRequests([validBid])[0];
+        let requestUrlCustomParams = buildRequest.data;
+        expect(requestUrlCustomParams).have.property('c.cacheBuster', 'bf4d7c1');
+        expect(requestUrlCustomParams).have.property('c.clickUrl', 'http://testclickurl.com');
+      });
+
+      it('should reject invalid bid without requestUrl', function () {
+        let invalidBid = {
+            bidder: 'orbitsoft',
+            params: {
+              placementId: '123'
+            }
+          },
+          isValid = spec.isBidRequestValid(invalidBid);
+
+        expect(isValid).to.equal(false);
+      });
+
+      it('should reject invalid bid without placementId', function () {
+        let invalidBid = {
+            bidder: 'orbitsoft',
+            params: {
+              requestUrl: ENDPOINT_URL
+            }
+          },
+          isValid = spec.isBidRequestValid(invalidBid);
+
+        expect(isValid).to.equal(false);
+      });
+    });
+    describe('bid responses', function () {
+      it('should return complete bid response', function () {
+        let serverResponse = {
+          body: {
+            callback_uid: '265b29b70cc106',
+            cpm: 0.5,
+            width: 240,
+            height: 240,
+            content_url: 'https://orbitsoft.com/php/ads/hb.html',
+            adomain: ['test.adomain.tld']
+          }
+        };
+
+        let bidRequests = [
+          {
+            bidder: 'orbitsoft',
+            params: {
+              placementId: '123',
+              requestUrl: ENDPOINT_URL
+            }
+          }
+        ];
+        let bids = spec.interpretResponse(serverResponse, {'bidRequest': bidRequests[0]});
+        expect(bids).to.be.lengthOf(1);
+        expect(bids[0].cpm).to.equal(serverResponse.body.cpm);
+        expect(bids[0].width).to.equal(serverResponse.body.width);
+        expect(bids[0].height).to.equal(serverResponse.body.height);
+        expect(bids[0].currency).to.equal('USD');
+        expect(bids[0].netRevenue).to.equal(true);
+        expect(bids[0].adUrl).to.have.length.above(1);
+        expect(bids[0].adUrl).to.have.string('https://orbitsoft.com/php/ads/hb.html');
+        expect(Object.keys(bids[0].meta)).to.include.members(['advertiserDomains']);
+        expect(bids[0].meta.advertiserDomains).to.deep.equal(serverResponse.body.adomain);
+      });
+
+      it('should return empty bid response', function () {
+        let bidRequests = [
+          {
+            bidder: 'orbitsoft',
+            params: {
+              placementId: '123',
+              requestUrl: ENDPOINT_URL
+            }
+          }
+        ];
+        let serverResponse = {
+            body: {
+              callback_uid: '265b29b70cc106',
+              cpm: 0
+            }
+          },
+          bids = spec.interpretResponse(serverResponse, {'bidRequest': bidRequests[0]});
+
+        expect(bids).to.be.lengthOf(0);
+      });
+
+      it('should return empty bid response on incorrect size', function () {
+        let bidRequests = [
+          {
+            bidder: 'orbitsoft',
+            params: {
+              placementId: '123',
+              requestUrl: ENDPOINT_URL
+            }
+          }
+        ];
+        let serverResponse = {
+            body: {
+              callback_uid: '265b29b70cc106',
+              cpm: 1.5,
+              width: 0,
+              height: 0
+            }
+          },
+          bids = spec.interpretResponse(serverResponse, {'bidRequest': bidRequests[0]});
+
+        expect(bids).to.be.lengthOf(0);
+      });
+
+      it('should return empty bid response with error', function () {
+        let bidRequests = [
+          {
+            bidder: 'orbitsoft',
+            params: {
+              placementId: '123',
+              requestUrl: ENDPOINT_URL
+            }
+          }
+        ];
+        let serverResponse = {error: 'error'},
+          bids = spec.interpretResponse(serverResponse, {'bidRequest': bidRequests[0]});
+
+        expect(bids).to.be.lengthOf(0);
+      });
+
+      it('should return empty bid response on empty body', function () {
+        let bidRequests = [
+          {
+            bidder: 'orbitsoft',
+            params: {
+              placementId: '123',
+              requestUrl: ENDPOINT_URL
+            }
+          }
+        ];
+        let serverResponse = {},
+          bids = spec.interpretResponse(serverResponse, {'bidRequest': bidRequests[0]});
+
+        expect(bids).to.be.lengthOf(0);
+      });
+    });
+  });
+});

package/test/spec/modules/riseBidAdapter_spec.js

@@ -116,6 +116,13 @@ describe('riseAdapter', function () {
       expect(request.data.bids[0].placementId).to.equal(placementId);
     });
 
+    it('sends the is_wrapper parameter to ENDPOINT via POST', function() {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.params).to.be.an('object');
+      expect(request.data.params).to.have.property('is_wrapper');
+      expect(request.data.params.is_wrapper).to.equal(false);
+    });
+
     it('sends bid request to ENDPOINT via POST', function () {
       const request = spec.buildRequests(bidRequests, bidderRequest);
       expect(request.url).to.equal(ENDPOINT);

package/test/spec/modules/seedtagBidAdapter_spec.js

@@ -395,6 +395,52 @@ describe('Seedtag Adapter', function () {
         expect(payload.schain).to.not.exist;
       });
     });
+
+    describe('GPP param', function () {
+      it('should be added to payload when bidderRequest has gppConsent param', function () {
+        const gppConsent = {
+          gppString: 'someGppString',
+          applicableSections: [7]
+        }
+        bidderRequest['gppConsent'] = gppConsent
+        const request = spec.buildRequests(validBidRequests, bidderRequest);
+        const data = JSON.parse(request.data);
+        expect(data.gppConsent).to.exist;
+        expect(data.gppConsent.gppString).to.equal(gppConsent.gppString);
+        expect(data.gppConsent.applicableSections[0]).to.equal(gppConsent.applicableSections[0]);
+      });
+
+      it('should be undefined on payload when bidderRequest has not gppConsent param', function () {
+        bidderRequest.gppConsent = undefined
+        const request = spec.buildRequests(validBidRequests, bidderRequest);
+        const data = JSON.parse(request.data);
+        expect(data.gppConsent).to.be.undefined;
+      });
+
+      it('should be added to payload when bidderRequest has ortb2 param', function () {
+        const ortb2 = {
+          regs: {
+            gpp: 'someGppString',
+            gpp_sid: [7]
+          }
+        }
+        bidderRequest['gppConsent'] = undefined
+        bidderRequest['ortb2'] = ortb2;
+        const request = spec.buildRequests(validBidRequests, bidderRequest);
+        const data = JSON.parse(request.data);
+        expect(data.gppConsent).to.exist;
+        expect(data.gppConsent.gppString).to.equal(ortb2.regs.gpp);
+        expect(data.gppConsent.applicableSections[0]).to.equal(ortb2.regs.gpp_sid[0]);
+      });
+
+      it('should be added to payload when bidderRequest has neither gppConsent nor ortb2', function () {
+        bidderRequest['ortb2'] = undefined;
+        bidderRequest['gppConsent'] = undefined;
+        const request = spec.buildRequests(validBidRequests, bidderRequest);
+        const data = JSON.parse(request.data);
+        expect(data.gppConsent).to.be.undefined;
+      });
+    });
   });
 
   describe('interpret response method', function () {
@@ -533,11 +579,11 @@ describe('Seedtag Adapter', function () {
       const timeoutUrl = getTimeoutUrl(timeoutData);
       expect(timeoutUrl).to.equal(
         'https://s.seedtag.com/se/hb/timeout?publisherToken=' +
-          params.publisherId +
-          '&adUnitId=' +
-          params.adUnitId +
-          '&timeout=' +
-          timeout
+        params.publisherId +
+        '&adUnitId=' +
+        params.adUnitId +
+        '&timeout=' +
+        timeout
       );
     });
 
@@ -549,11 +595,11 @@ describe('Seedtag Adapter', function () {
       expect(
         utils.triggerPixel.calledWith(
           'https://s.seedtag.com/se/hb/timeout?publisherToken=' +
-            params.publisherId +
-            '&adUnitId=' +
-            params.adUnitId +
-            '&timeout=' +
-            timeout
+          params.publisherId +
+          '&adUnitId=' +
+          params.adUnitId +
+          '&timeout=' +
+          timeout
         )
       ).to.equal(true);
     });

package/test/spec/modules/smartxBidAdapter_spec.js

@@ -374,6 +374,16 @@ describe('The smartx adapter', function () {
         }
       })
     });
+
+    it('should pass sitekey param', function () {
+      var request;
+
+      bid.params.sitekey = 'foo'
+
+      request = spec.buildRequests([bid], bidRequestObj)[0];
+
+      expect(request.data.site.content.ext.sitekey).to.equal('foo');
+    });
   });
 
   describe('interpretResponse', function () {

package/test/spec/modules/taboolaBidAdapter_spec.js

@@ -2,6 +2,7 @@ import {expect} from 'chai';
 import {spec, internal, END_POINT_URL, userData} from 'modules/taboolaBidAdapter.js';
 import {config} from '../../../src/config'
 import * as utils from '../../../src/utils'
+import {server} from '../../mocks/xhr'
 
 describe('Taboola Adapter', function () {
   let hasLocalStorage, cookiesAreEnabled, getDataFromLocalStorage, localStorageIsEnabled, getCookie, commonBidRequest;
@@ -91,6 +92,31 @@ describe('Taboola Adapter', function () {
     })
   })
 
+  describe('onBidWon', function () {
+    it('onBidWon exist as a function', () => {
+      expect(spec.onBidWon).to.exist.and.to.be.a('function');
+    });
+
+    it('should resolve price macro in nurl', function () {
+      const nurl = 'http://win.example.com/${AUCTION_PRICE}';
+      const bid = {
+        requestId: 1,
+        cpm: 2,
+        originalCpm: 3.4,
+        creativeId: 1,
+        ttl: 60,
+        netRevenue: true,
+        mediaType: 'banner',
+        ad: '...',
+        width: 300,
+        height: 250,
+        nurl: nurl
+      }
+      spec.onBidWon(bid);
+      expect(server.requests[0].url).to.equals('http://win.example.com/3.4')
+    });
+  });
+
   describe('buildRequests', function () {
     const defaultBidRequest = {
       ...createBidRequest(),
@@ -122,7 +148,8 @@ describe('Taboola Adapter', function () {
           },
           'tagid': commonBidRequest.params.tagId,
           'bidfloor': null,
-          'bidfloorcur': 'USD'
+          'bidfloorcur': 'USD',
+          'ext': {}
         }],
         'site': {
           'id': commonBidRequest.params.publisherId,
@@ -137,11 +164,13 @@ describe('Taboola Adapter', function () {
         'source': {'fd': 1},
         'bcat': [],
         'badv': [],
+        'wlang': [],
         'user': {
           'buyeruid': 0,
           'ext': {},
         },
-        'regs': {'coppa': 0, 'ext': {}}
+        'regs': {'coppa': 0, 'ext': {}},
+        'ext': {}
       };
 
       const res = spec.buildRequests([defaultBidRequest], commonBidderRequest);
@@ -184,7 +213,7 @@ describe('Taboola Adapter', function () {
       expect(resData.imp[0].bidfloorcur).to.deep.equal('USD');
     });
 
-    it('should pass bid floor even if they is a bid floor param', function () {
+    it('should pass bid floor even if it is a bid floor param', function () {
       const optionalParams = {
         bidfloor: 0.25,
         bidfloorcur: 'EUR'
@@ -206,6 +235,38 @@ describe('Taboola Adapter', function () {
       expect(resData.imp[0].bidfloorcur).to.deep.equal('USD');
     });
 
+    it('should pass impression position', function () {
+      const optionalParams = {
+        position: 2
+      };
+
+      const bidRequest = {
+        ...defaultBidRequest,
+        params: {...commonBidRequest.params, ...optionalParams}
+      };
+
+      const res = spec.buildRequests([bidRequest], commonBidderRequest);
+      const resData = JSON.parse(res.data);
+      expect(resData.imp[0].banner.pos).to.deep.equal(2);
+    });
+
+    it('should pass gpid if configured', function () {
+      const ortb2Imp = {
+        ext: {
+          gpid: '/homepage/#1'
+        }
+      }
+      const bidRequest = {
+        ...defaultBidRequest,
+        ortb2Imp: ortb2Imp,
+        params: {...commonBidRequest.params}
+      };
+
+      const res = spec.buildRequests([bidRequest], commonBidderRequest);
+      const resData = JSON.parse(res.data);
+      expect(resData.imp[0].ext.gpid).to.deep.equal('/homepage/#1');
+    });
+
     it('should pass bidder timeout', function () {
       const bidderRequest = {
         ...commonBidderRequest,
@@ -216,6 +277,40 @@ describe('Taboola Adapter', function () {
       expect(resData.tmax).to.equal(500);
     });
 
+    describe('first party data', function () {
+      it('should parse first party data', function () {
+        const bidderRequest = {
+          ...commonBidderRequest,
+          ortb2: {
+            bcat: ['EX1', 'EX2', 'EX3'],
+            badv: ['site.com'],
+            wlang: ['de'],
+          }
+        }
+        const res = spec.buildRequests([defaultBidRequest], bidderRequest);
+        const resData = JSON.parse(res.data);
+        expect(resData.bcat).to.deep.equal(bidderRequest.ortb2.bcat)
+        expect(resData.badv).to.deep.equal(bidderRequest.ortb2.badv)
+        expect(resData.wlang).to.deep.equal(bidderRequest.ortb2.wlang)
+      });
+
+      it('should pass pageType if exists in ortb2', function () {
+        const bidderRequest = {
+          ...commonBidderRequest,
+          ortb2: {
+            ext: {
+              data: {
+                pageType: 'news'
+              }
+            }
+          }
+        }
+        const res = spec.buildRequests([defaultBidRequest], bidderRequest);
+        const resData = JSON.parse(res.data);
+        expect(resData.ext.pageType).to.deep.equal(bidderRequest.ortb2.ext.data.pageType);
+      });
+    });
+
     describe('handle privacy segments when building request', function () {
       it('should pass GDPR consent', function () {
         const bidderRequest = {
@@ -234,6 +329,20 @@ describe('Taboola Adapter', function () {
         expect(resData.regs.ext.gdpr).to.equal(1)
       });
 
+      it('should pass GPP consent if exist in ortb2', function () {
+        const ortb2 = {
+          regs: {
+            gpp: 'testGpp',
+            gpp_sid: [1, 2, 3]
+          }
+        }
+
+        const res = spec.buildRequests([defaultBidRequest], {...commonBidderRequest, ortb2})
+        const resData = JSON.parse(res.data)
+        expect(resData.regs.ext.gpp).to.equal('testGpp')
+        expect(resData.regs.ext.gpp_sid).to.deep.equal([1, 2, 3])
+      });
+
       it('should pass us privacy consent', function () {
         const bidderRequest = {
           refererInfo: {
@@ -552,8 +661,36 @@ describe('Taboola Adapter', function () {
     });
   })
 
-  describe('userData', function () {
-    // todo: add UT for getUserSyncs
+  describe('getUserSyncs', function () {
+    const usersyncUrl = 'https://trc.taboola.com/sg/prebidJS/1/cm';
+
+    it('should not return user sync if pixelEnabled is false', function () {
+      const res = spec.getUserSyncs({pixelEnabled: false});
+      expect(res).to.be.an('array').that.is.empty;
+    });
+
+    it('should return user sync if pixelEnabled is true', function () {
+      const res = spec.getUserSyncs({pixelEnabled: true});
+      expect(res).to.deep.equal([{type: 'image', url: usersyncUrl}]);
+    });
+
+    it('should pass consent tokens values', function() {
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: true, consentString: 'GDPR_CONSENT'}, 'USP_CONSENT')).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?gdpr=1&gdpr_consent=GDPR_CONSENT&us_privacy=USP_CONSENT`
+      }]);
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: false, consentString: undefined}, undefined)).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?gdpr=0&gdpr_consent=`
+      }]);
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: false, consentString: undefined}, undefined)).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?gdpr=0&gdpr_consent=`
+      }]);
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, undefined, 'USP_CONSENT')).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?us_privacy=USP_CONSENT`
+      }]);
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, undefined, 'USP_CONSENT', 'GPP_STRING')).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?us_privacy=USP_CONSENT&gpp=GPP_STRING`
+      }]);
+    });
   })
 
   describe('internal functions', function () {