npm - prebid.js - Versions diffs - 5.17.0 → 6.0.0 - Mend

prebid.js 5.17.0 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (145) hide show

package/.babelrc.js +3 -6
package/README.md +3 -1
package/browsers.json +1 -8
package/integrationExamples/gpt/akamaidap_segments_example.html +132 -0
package/modules/.submodules.json +1 -0
package/modules/adfBidAdapter.js +21 -16
package/modules/adgenerationBidAdapter.js +28 -4
package/modules/adkernelBidAdapter.js +2 -1
package/modules/admixerBidAdapter.js +11 -0
package/modules/adtelligentBidAdapter.js +2 -1
package/modules/airgridRtdProvider.js +1 -1
package/modules/akamaiDapRtdProvider.js +474 -0
package/modules/akamaiDapRtdProvider.md +47 -0
package/modules/aolBidAdapter.js +2 -1
package/modules/appnexusBidAdapter.js +5 -3
package/modules/atsAnalyticsAdapter.js +67 -46
package/modules/atsAnalyticsAdapter.md +1 -0
package/modules/betweenBidAdapter.js +20 -3
package/modules/bliinkBidAdapter.js +58 -32
package/modules/bliinkBidAdapter.md +29 -6
package/modules/browsiRtdProvider.js +106 -18
package/modules/cleanioRtdProvider.js +192 -0
package/modules/cleanioRtdProvider.md +59 -0
package/modules/codefuelBidAdapter.js +183 -0
package/modules/codefuelBidAdapter.md +111 -0
package/modules/connectIdSystem.js +104 -0
package/modules/connectIdSystem.md +33 -0
package/modules/cwireBidAdapter.js +272 -0
package/modules/cwireBidAdapter.md +43 -0
package/modules/deepintentBidAdapter.js +106 -9
package/modules/deepintentBidAdapter.md +36 -1
package/modules/deltaprojectsBidAdapter.js +252 -0
package/modules/deltaprojectsBidAdapter.md +32 -0
package/modules/dgkeywordRtdProvider.js +0 -1
package/modules/engageyaBidAdapter.js +157 -0
package/modules/gridBidAdapter.js +1 -0
package/modules/gumgumBidAdapter.js +8 -0
package/modules/inskinBidAdapter.js +7 -3
package/modules/ixBidAdapter.js +8 -1
package/modules/jixieBidAdapter.js +8 -2
package/modules/justpremiumBidAdapter.js +6 -1
package/modules/limelightDigitalBidAdapter.js +22 -2
package/modules/livewrappedAnalyticsAdapter.js +53 -3
package/modules/mediakeysBidAdapter.js +2 -1
package/modules/multibid/index.js +3 -3
package/modules/nativoBidAdapter.js +6 -2
package/modules/nextMillenniumBidAdapter.js +12 -3
package/modules/oguryBidAdapter.js +36 -7
package/modules/openxBidAdapter.js +34 -22
package/modules/operaadsBidAdapter.js +21 -1
package/modules/otmBidAdapter.js +146 -0
package/modules/otmBidAdapter.md +27 -26
package/modules/outbrainBidAdapter.js +5 -0
package/modules/pixfutureBidAdapter.js +24 -4
package/modules/pixfutureBidAdapter.md +127 -0
package/modules/playwireBidAdapter.md +61 -0
package/modules/prebidServerBidAdapter/index.js +1 -1
package/modules/proxistoreBidAdapter.js +4 -6
package/modules/publinkIdSystem.js +11 -6
package/modules/pubmaticBidAdapter.js +9 -0
package/modules/pubmaticBidAdapter.md +1 -1
package/modules/rtdModule/index.js +2 -2
package/modules/sonobiBidAdapter.js +7 -0
package/modules/sortableBidAdapter.js +1 -0
package/modules/talkadsBidAdapter.js +129 -0
package/modules/talkadsBidAdapter.md +60 -0
package/modules/teadsBidAdapter.js +3 -0
package/modules/tripleliftBidAdapter.js +22 -5
package/modules/trustxBidAdapter.js +8 -6
package/modules/undertoneBidAdapter.js +9 -5
package/modules/undertoneBidAdapter.md +5 -1
package/modules/unicornBidAdapter.js +3 -3
package/modules/userId/eids.js +18 -0
package/modules/userId/eids.md +7 -0
package/modules/userId/userId.md +12 -0
package/modules/ventesBidAdapter.js +370 -0
package/modules/ventesBidAdapter.md +94 -0
package/modules/videobyteBidAdapter.js +13 -6
package/modules/videobyteBidAdapter.md +49 -0
package/modules/visxBidAdapter.js +15 -22
package/modules/yahoosspBidAdapter.js +637 -0
package/modules/yahoosspBidAdapter.md +795 -0
package/modules/yieldlabBidAdapter.js +48 -3
package/modules/yieldlabBidAdapter.md +16 -1
package/modules/yieldmoSyntheticInventoryModule.js +46 -0
package/modules/yieldmoSyntheticInventoryModule.md +68 -0
package/package.json +1 -1
package/src/adapterManager.js +5 -0
package/src/adapters/bidderFactory.js +4 -3
package/src/auction.js +11 -11
package/src/constants.json +1 -0
package/src/secureCreatives.js +6 -7
package/src/targeting.js +11 -9
package/test/spec/modules/adfBidAdapter_spec.js +83 -29
package/test/spec/modules/adgenerationBidAdapter_spec.js +121 -50
package/test/spec/modules/adtelligentBidAdapter_spec.js +1 -0
package/test/spec/modules/akamaiDapRtdProvider_spec.js +246 -0
package/test/spec/modules/appnexusBidAdapter_spec.js +2 -1
package/test/spec/modules/atsAnalyticsAdapter_spec.js +42 -9
package/test/spec/modules/betweenBidAdapter_spec.js +41 -0
package/test/spec/modules/bliinkBidAdapter_spec.js +87 -36
package/test/spec/modules/browsiRtdProvider_spec.js +62 -7
package/test/spec/modules/cleanioRtdProvider_spec.js +188 -0
package/test/spec/modules/codefuelBidAdapter_spec.js +316 -0
package/test/spec/modules/connectIdSystem_spec.js +189 -0
package/test/spec/modules/cwireBidAdapter_spec.js +246 -0
package/test/spec/modules/deepintentBidAdapter_spec.js +153 -3
package/test/spec/modules/deltaprojectsBidAdapter_spec.js +399 -0
package/test/spec/modules/engageyaBidAdapter_spec.js +286 -0
package/test/spec/modules/gumgumBidAdapter_spec.js +5 -1
package/test/spec/modules/ixBidAdapter_spec.js +13 -3
package/test/spec/modules/jixieBidAdapter_spec.js +13 -11
package/test/spec/modules/justpremiumBidAdapter_spec.js +9 -2
package/test/spec/modules/limelightDigitalBidAdapter_spec.js +155 -1
package/test/spec/modules/livewrappedAnalyticsAdapter_spec.js +67 -12
package/test/spec/modules/multibid_spec.js +31 -31
package/test/spec/modules/nextMillenniumBidAdapter_spec.js +13 -1
package/test/spec/modules/oguryBidAdapter_spec.js +125 -37
package/test/spec/modules/openxBidAdapter_spec.js +85 -13
package/test/spec/modules/operaadsBidAdapter_spec.js +38 -6
package/test/spec/modules/otmBidAdapter_spec.js +67 -0
package/test/spec/modules/outbrainBidAdapter_spec.js +18 -0
package/test/spec/modules/publinkIdSystem_spec.js +6 -6
package/test/spec/modules/pubmaticBidAdapter_spec.js +39 -1
package/test/spec/modules/sonobiBidAdapter_spec.js +34 -1
package/test/spec/modules/sortableBidAdapter_spec.js +11 -0
package/test/spec/modules/talkadsBidAdapter_spec.js +231 -0
package/test/spec/modules/teadsBidAdapter_spec.js +132 -0
package/test/spec/modules/tripleliftBidAdapter_spec.js +128 -0
package/test/spec/modules/trustxBidAdapter_spec.js +3 -3
package/test/spec/modules/undertoneBidAdapter_spec.js +52 -0
package/test/spec/modules/unicornBidAdapter_spec.js +4 -4
package/test/spec/modules/ventesBidAdapter_spec.js +845 -0
package/test/spec/modules/videobyteBidAdapter_spec.js +2 -2
package/test/spec/modules/visxBidAdapter_spec.js +48 -4
package/test/spec/modules/yahoosspBidAdapter_spec.js +1332 -0
package/test/spec/modules/yieldlabBidAdapter_spec.js +65 -1
package/test/spec/modules/yieldmoSyntheticInventoryModule_spec.js +89 -0
package/test/spec/unit/core/adapterManager_spec.js +32 -0
package/test/spec/unit/core/bidderFactory_spec.js +61 -1
package/test/spec/unit/pbjs_api_spec.js +37 -2
package/test/spec/unit/secureCreatives_spec.js +54 -25
package/wdio.conf.js +1 -1
package/modules/turktelekomBidAdapter.md +0 -49
package/yarn.lock +0 -13122

package/test/spec/modules/cleanioRtdProvider_spec.js ADDED Viewed

@@ -0,0 +1,188 @@
+import * as utils from '../../../src/utils.js';
+import * as hook from '../../../src/hook.js'
+import { __TEST__ } from '../../../modules/cleanioRtdProvider.js';
+const {
+  readConfig,
+  ConfigError,
+  pageInitStepPreloadScript,
+  pageInitStepProtectPage,
+  bidWrapStepAugmentHtml,
+  bidWrapStepProtectByWrapping,
+  beforeInit,
+} = __TEST__;
+sinon.assert.expose(chai.assert, { prefix: 'sinon' });
+const fakeScriptURL = 'https://example.com/script.js';
+function makeFakeBidResponse() {
+  return {
+    ad: '<body>hello ad</body>',
+    bidderCode: 'BIDDER',
+    creativeId: 'CREATIVE',
+    cpm: 1.23,
+  };
+}
+describe('clean.io RTD module', function () {
+  describe('readConfig()', function() {
+    it('should throw ConfigError on invalid configurations', function() {
+      expect(() => readConfig({})).to.throw(ConfigError);
+      expect(() => readConfig({ params: {} })).to.throw(ConfigError);
+      expect(() => readConfig({ params: { protectionMode: 'bids' } })).to.throw(ConfigError);
+      expect(() => readConfig({ params: { cdnUrl: 'abc' } })).to.throw(ConfigError);
+      expect(() => readConfig({ params: { cdnUrl: 'abc', protectionMode: 'bids' } })).to.throw(ConfigError);
+      expect(() => readConfig({ params: { cdnUrl: 'https://abc1234567890.cloudfront.net/script.js', protectionMode: '123' } })).to.throw(ConfigError);
+    });
+    it('should accept valid configurations', function() {
+      expect(() => readConfig({ params: { cdnUrl: 'https://abc1234567890.cloudfront.net/script.js', protectionMode: 'full' } })).to.not.throw();
+      expect(() => readConfig({ params: { cdnUrl: 'https://abc1234567890.cloudfront.net/script.js', protectionMode: 'bids' } })).to.not.throw();
+      expect(() => readConfig({ params: { cdnUrl: 'https://abc1234567890.cloudfront.net/script.js', protectionMode: 'bids-nowait' } })).to.not.throw();
+    });
+  });
+  describe('Module initialization step', function() {
+    let insertElementStub;
+    beforeEach(function() {
+      insertElementStub = sinon.stub(utils, 'insertElement');
+    });
+    afterEach(function() {
+      utils.insertElement.restore();
+    });
+    it('pageInitStepPreloadScript() should insert link/preload element', function() {
+      pageInitStepPreloadScript(fakeScriptURL);
+      sinon.assert.calledOnce(insertElementStub);
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.tagName === 'LINK'));
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.rel === 'preload'));
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.as === 'script'));
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.href === fakeScriptURL));
+    });
+    it('pageInitStepProtectPage() should insert script element', function() {
+      pageInitStepProtectPage(fakeScriptURL);
+      sinon.assert.calledOnce(insertElementStub);
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.tagName === 'SCRIPT'));
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.type === 'text/javascript'));
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.src === fakeScriptURL));
+    });
+  });
+  function ensurePrependToBidResponse(fakeBidResponse) {
+    expect(fakeBidResponse).to.have.own.property('ad').which.is.a('string');
+    expect(fakeBidResponse.ad).to.contain('<!-- pbad://creativeId=CREATIVE&bidderCode=BIDDER&cpm=1.23 -->');
+  }
+  function ensureWrapBidResponse(fakeBidResponse, scriptUrl) {
+    expect(fakeBidResponse).to.have.own.property('ad').which.is.a('string');
+    expect(fakeBidResponse.ad).to.contain(`src="${scriptUrl}"`);
+    expect(fakeBidResponse.ad).to.contain('agent.put(ad)');
+  }
+  describe('Bid processing step', function() {
+    it('bidWrapStepAugmentHtml() should prepend bid-specific information in a comment', function() {
+      const fakeBidResponse = makeFakeBidResponse();
+      bidWrapStepAugmentHtml(fakeBidResponse);
+      ensurePrependToBidResponse(fakeBidResponse);
+    });
+    it('bidWrapStepProtectByWrapping() should wrap payload into a script tag', function() {
+      const fakeBidResponse = makeFakeBidResponse();
+      bidWrapStepProtectByWrapping(fakeScriptURL, 0, fakeBidResponse);
+      ensureWrapBidResponse(fakeBidResponse, fakeScriptURL);
+    });
+  });
+  describe('Sumbodule execution', function() {
+    let submoduleStub;
+    let insertElementStub;
+    beforeEach(function () {
+      submoduleStub = sinon.stub(hook, 'submodule');
+      insertElementStub = sinon.stub(utils, 'insertElement');
+    });
+    afterEach(function () {
+      utils.insertElement.restore();
+      submoduleStub.restore();
+    });
+    function getModule() {
+      beforeInit();
+      expect(submoduleStub.calledOnceWith('realTimeData')).to.equal(true);
+      const registeredSubmoduleDefinition = submoduleStub.getCall(0).args[1];
+      expect(registeredSubmoduleDefinition).to.be.an('object');
+      expect(registeredSubmoduleDefinition).to.have.own.property('name', 'clean.io');
+      expect(registeredSubmoduleDefinition).to.have.own.property('init').that.is.a('function');
+      expect(registeredSubmoduleDefinition).to.have.own.property('onBidResponseEvent').that.is.a('function');
+      return registeredSubmoduleDefinition;
+    }
+    it('should register clean.io RTD submodule provider', function () {
+      getModule();
+    });
+    it('should refuse initialization with incorrect parameters', function () {
+      const { init } = getModule();
+      expect(init({ params: { cdnUrl: 'abc', protectionMode: 'full' } }, {})).to.equal(false); // too short distribution name
+      sinon.assert.notCalled(insertElementStub);
+    });
+    it('should iniitalize in full (page) protection mode', function () {
+      const { init, onBidResponseEvent } = getModule();
+      expect(init({ params: { cdnUrl: 'https://abc1234567890.cloudfront.net/script.js', protectionMode: 'full' } }, {})).to.equal(true);
+      sinon.assert.calledOnce(insertElementStub);
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.tagName === 'SCRIPT'));
+      const fakeBidResponse = makeFakeBidResponse();
+      onBidResponseEvent(fakeBidResponse, {}, {});
+      ensurePrependToBidResponse(fakeBidResponse);
+    });
+    it('should iniitalize in bids (frame) protection mode', function () {
+      const { init, onBidResponseEvent } = getModule();
+      expect(init({ params: { cdnUrl: 'https://abc1234567890.cloudfront.net/script.js', protectionMode: 'bids' } }, {})).to.equal(true);
+      sinon.assert.calledOnce(insertElementStub);
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.tagName === 'LINK'));
+      const fakeBidResponse = makeFakeBidResponse();
+      onBidResponseEvent(fakeBidResponse, {}, {});
+      ensureWrapBidResponse(fakeBidResponse, 'https://abc1234567890.cloudfront.net/script.js');
+    });
+    it('should respect preload status in bids-nowait protection mode', function () {
+      const { init, onBidResponseEvent } = getModule();
+      expect(init({ params: { cdnUrl: 'https://abc1234567890.cloudfront.net/script.js', protectionMode: 'bids-nowait' } }, {})).to.equal(true);
+      sinon.assert.calledOnce(insertElementStub);
+      sinon.assert.calledWith(insertElementStub, sinon.match(elem => elem.tagName === 'LINK'));
+      const preloadLink = insertElementStub.getCall(0).args[0];
+      expect(preloadLink).to.have.property('onload').which.is.a('function');
+      expect(preloadLink).to.have.property('onerror').which.is.a('function');
+      const fakeBidResponse1 = makeFakeBidResponse();
+      onBidResponseEvent(fakeBidResponse1, {}, {});
+      ensurePrependToBidResponse(fakeBidResponse1);
+      // Simulate successful preloading
+      preloadLink.onload();
+      const fakeBidResponse2 = makeFakeBidResponse();
+      onBidResponseEvent(fakeBidResponse2, {}, {});
+      ensureWrapBidResponse(fakeBidResponse2, 'https://abc1234567890.cloudfront.net/script.js');
+      // Simulate error
+      preloadLink.onerror();
+      // Now we should fallback to just prepending
+      const fakeBidResponse3 = makeFakeBidResponse();
+      onBidResponseEvent(fakeBidResponse3, {}, {});
+      ensurePrependToBidResponse(fakeBidResponse3);
+    });
+  });
+});

package/test/spec/modules/codefuelBidAdapter_spec.js ADDED Viewed

@@ -0,0 +1,316 @@
+import {expect} from 'chai';
+import {spec} from 'modules/codefuelBidAdapter.js';
+import {config} from 'src/config.js';
+import {server} from 'test/mocks/xhr';
+const USER_AGENT = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/92.0.4515.159 Safari/537.36';
+const DEFAULT_USER_AGENT = window.navigator.userAgent;
+const setUADefault = () => { window.navigator.__defineGetter__('userAgent', function () { return DEFAULT_USER_AGENT }) };
+const setUAMock = () => { window.navigator.__defineGetter__('userAgent', function () { return USER_AGENT }) };
+describe('Codefuel Adapter', function () {
+  describe('Bid request and response', function () {
+    const commonBidRequest = {
+      bidder: 'codefuel',
+      params: {
+        publisher: {
+          id: 'publisher-id'
+        },
+      },
+      bidId: '2d6815a92ba1ba',
+      auctionId: '12043683-3254-4f74-8934-f941b085579e',
+    }
+    const nativeBidRequestParams = {
+      nativeParams: {
+        image: {
+          required: true,
+          sizes: [
+            120,
+            100
+          ],
+          sendId: true
+        },
+        title: {
+          required: true,
+          sendId: true
+        },
+        sponsoredBy: {
+          required: false
+        }
+      },
+    }
+    const displayBidRequestParams = {
+      sizes: [
+        [
+          300,
+          250
+        ]
+      ]
+    }
+    describe('isBidRequestValid', function () {
+      before(() => {
+        config.setConfig({
+          codefuel: {
+            bidderUrl: 'https://bidder-url.com',
+          }
+        }
+        )
+      })
+      after(() => {
+        config.resetConfig()
+      })
+      it('should fail when bid is invalid', function () {
+        const bid = {
+          bidder: 'codefuel',
+          params: {
+            publisher: {
+              id: 'publisher-id',
+            }
+          },
+        }
+        expect(spec.isBidRequestValid(bid)).to.equal(false)
+      })
+      it('should not succeed when bid contains native params', function () {
+        const bid = {
+          bidder: 'codefuel',
+          params: {
+            publisher: {
+              id: 'publisher-id',
+            }
+          },
+          ...nativeBidRequestParams,
+        }
+        expect(spec.isBidRequestValid(bid)).to.equal(false)
+      })
+      it('should not succeed when bid contains only sizes', function () {
+        const bid = {
+          bidder: 'codefuel',
+          params: {
+            publisher: {
+              id: 'publisher-id',
+            }
+          },
+          ...displayBidRequestParams,
+        }
+        expect(spec.isBidRequestValid(bid)).to.equal(false)
+      })
+      it('should fail if publisher id is not set', function () {
+        const bid = {
+          bidder: 'codefuel',
+          ...nativeBidRequestParams,
+        }
+        expect(spec.isBidRequestValid(bid)).to.equal(false)
+      })
+      it('should fail if bidder url is not set', function () {
+        const bid = {
+          bidder: 'codefuel',
+          params: {
+            publisher: {
+              id: 'publisher-id',
+            }
+          },
+          ...nativeBidRequestParams,
+        }
+        config.resetConfig()
+        expect(spec.isBidRequestValid(bid)).to.equal(false)
+      })
+    })
+    describe('buildRequests', function () {
+      before(() => {
+        setUAMock()
+        config.setConfig({
+          codefuel: {
+            bidderUrl: 'https://bidder-url.com',
+          }
+        }
+        )
+      })
+      after(() => {
+        config.resetConfig()
+        setUADefault()
+      })
+      const commonBidderRequest = {
+        timeout: 500,
+        auctionId: '12043683-3254-4f74-8934-f941b085579e',
+        refererInfo: {
+          referer: 'https://example.com/',
+        }
+      }
+      it('should build display request', function () {
+        const bidRequest = {
+          ...commonBidRequest,
+          ...displayBidRequestParams,
+        }
+        const expectedData = {
+          cur: [
+            'USD'
+          ],
+          device: {
+            devicetype: 2,
+            ua: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/92.0.4515.159 Safari/537.36'
+          },
+          id: '12043683-3254-4f74-8934-f941b085579e',
+          imp: [
+            {
+              banner: {
+                format: [
+                  {
+                    h: 250,
+                    w: 300
+                  }
+                ]
+              },
+              id: '1'
+            }
+          ],
+          site: {
+            domain: 'example.com',
+            page: 'https://example.com/',
+            publisher: {
+              id: 'publisher-id'
+            }
+          },
+          source: {
+            fd: 1
+          },
+          tmax: 500
+        }
+        const res = spec.buildRequests([bidRequest], commonBidderRequest)
+        expect(res.url).to.equal('https://bidder-url.com')
+        expect(res.data).to.deep.equal(expectedData)
+      })
+      it('should pass bidder timeout', function () {
+        const bidRequest = {
+          ...commonBidRequest,
+        }
+        const bidderRequest = {
+          ...commonBidderRequest,
+          timeout: 500
+        }
+        const res = spec.buildRequests([bidRequest], bidderRequest)
+        const resData = res.data
+        expect(resData.tmax).to.equal(500)
+      });
+    })
+    describe('interpretResponse', function () {
+      it('should return empty array if no valid bids', function () {
+        const res = spec.interpretResponse({}, [])
+        expect(res).to.be.an('array').that.is.empty
+      });
+      it('should interpret display response', function () {
+        const serverResponse = {
+          body: {
+            id: '6b2eedc8-8ff5-46ef-adcf-e701b508943e',
+            seatbid: [
+              {
+                bid: [
+                  {
+                    id: 'd90fe7fa-28d7-11eb-8ce4-462a842a7cf9',
+                    impid: '1',
+                    price: 1.1,
+                    nurl: 'http://example.com/win/${AUCTION_PRICE}',
+                    adm: '<div>ad</div>',
+                    adomain: [
+                      'example.com'
+                    ],
+                    cid: '3865084',
+                    crid: '29998660',
+                    cat: [
+                      'IAB10-2'
+                    ],
+                    w: 300,
+                    h: 250
+                  }
+                ],
+                seat: 'acc-6536'
+              }
+            ],
+            bidid: 'd90fe7fa-28d7-11eb-8ce4-13d94bfa26f9',
+            cur: 'USD'
+          }
+        }
+        const request = {
+          bids: [
+            {
+              ...commonBidRequest,
+              ...displayBidRequestParams
+            }
+          ]
+        }
+        const expectedRes = [
+          {
+            requestId: request.bids[0].bidId,
+            cpm: 1.1,
+            creativeId: '29998660',
+            ttl: 360,
+            netRevenue: true,
+            currency: 'USD',
+            mediaType: 'banner',
+            ad: '<div>ad</div>',
+            width: 300,
+            height: 250,
+            meta: {'advertiserDomains': []}
+          }
+        ]
+        const res = spec.interpretResponse(serverResponse, request)
+        expect(res).to.deep.equal(expectedRes)
+      });
+    })
+  })
+  describe('getUserSyncs', function () {
+    const usersyncUrl = 'https://usersync-url.com';
+    beforeEach(() => {
+      config.setConfig({
+        codefuel: {
+          usersyncUrl: usersyncUrl,
+        }
+      }
+      )
+    })
+    after(() => {
+      config.resetConfig()
+    })
+    it('should not return user sync if pixel enabled with codefuel config', function () {
+      const ret = spec.getUserSyncs({pixelEnabled: true})
+      expect(ret).to.be.an('array').that.is.empty
+    })
+    it('should not return user sync if pixel disabled', function () {
+      const ret = spec.getUserSyncs({pixelEnabled: false})
+      expect(ret).to.be.an('array').that.is.empty
+    })
+    it('should not return user sync if url is not set', function () {
+      config.resetConfig()
+      const ret = spec.getUserSyncs({pixelEnabled: true})
+      expect(ret).to.be.an('array').that.is.empty
+    })
+    it('should not pass GDPR consent', function() {
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: true, consentString: 'foo'}, undefined)).to.to.be.an('array').that.is.empty
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: false, consentString: 'foo'}, undefined)).to.be.an('array').that.is.empty
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: true, consentString: undefined}, undefined)).to.be.an('array').that.is.empty
+    });
+    it('should not pass US consent', function() {
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, undefined, '1NYN')).to.be.an('array').that.is.empty
+    });
+    it('should pass GDPR and US consent', function() {
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: true, consentString: 'foo'}, '1NYN')).to.be.an('array').that.is.empty
+    });
+  })
+})

package/test/spec/modules/connectIdSystem_spec.js ADDED Viewed

@@ -0,0 +1,189 @@
+import {expect} from 'chai';
+import {parseQS} from 'src/utils.js';
+import {connectIdSubmodule} from 'modules/connectIdSystem.js';
+describe('Yahoo ConnectID Submodule', () => {
+  const HASHED_EMAIL = '6bda6f2fa268bf0438b5423a9861a2cedaa5dec163c03f743cfe05c08a8397b2';
+  const PIXEL_ID = '1234';
+  const PROD_ENDPOINT = `https://ups.analytics.yahoo.com/ups/${PIXEL_ID}/fed`;
+  const OVERRIDE_ENDPOINT = 'https://foo/bar';
+  it('should have the correct module name declared', () => {
+    expect(connectIdSubmodule.name).to.equal('connectId');
+  });
+  it('should have the correct TCFv2 Vendor ID declared', () => {
+    expect(connectIdSubmodule.gvlid).to.equal(25);
+  });
+  describe('getId()', () => {
+    let ajaxStub;
+    let getAjaxFnStub;
+    let consentData;
+    beforeEach(() => {
+      ajaxStub = sinon.stub();
+      getAjaxFnStub = sinon.stub(connectIdSubmodule, 'getAjaxFn');
+      getAjaxFnStub.returns(ajaxStub);
+      consentData = {
+        gdpr: {
+          gdprApplies: 1,
+          consentString: 'GDPR_CONSENT_STRING'
+        },
+        uspConsent: 'USP_CONSENT_STRING'
+      };
+    });
+    afterEach(() => {
+      getAjaxFnStub.restore();
+    });
+    function invokeGetIdAPI(configParams, consentData) {
+      let result = connectIdSubmodule.getId({
+        params: configParams
+      }, consentData);
+      if (typeof result === 'object') {
+        result.callback(sinon.stub());
+      }
+      return result;
+    }
+    it('returns undefined if he and pixelId params are not passed', () => {
+      expect(invokeGetIdAPI({}, consentData)).to.be.undefined;
+      expect(ajaxStub.callCount).to.equal(0);
+    });
+    it('returns undefined if the pixelId param is not passed', () => {
+      expect(invokeGetIdAPI({
+        he: HASHED_EMAIL
+      }, consentData)).to.be.undefined;
+      expect(ajaxStub.callCount).to.equal(0);
+    });
+    it('returns undefined if the he param is not passed', () => {
+      expect(invokeGetIdAPI({
+        pixelId: PIXEL_ID
+      }, consentData)).to.be.undefined;
+      expect(ajaxStub.callCount).to.equal(0);
+    });
+    it('returns an object with the callback function if the correct params are passed', () => {
+      let result = invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID
+      }, consentData);
+      expect(result).to.be.an('object').that.has.all.keys('callback');
+      expect(result.callback).to.be.a('function');
+    });
+    it('Makes an ajax GET request to the production API endpoint with query params', () => {
+      invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID
+      }, consentData);
+      const expectedParams = {
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID,
+        '1p': '0',
+        gdpr: '1',
+        gdpr_consent: consentData.gdpr.consentString,
+        us_privacy: consentData.uspConsent
+      };
+      const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
+      expect(ajaxStub.firstCall.args[0].indexOf(`${PROD_ENDPOINT}?`)).to.equal(0);
+      expect(requestQueryParams).to.deep.equal(expectedParams);
+      expect(ajaxStub.firstCall.args[3]).to.deep.equal({method: 'GET', withCredentials: true});
+    });
+    it('Makes an ajax GET request to the specified override API endpoint with query params', () => {
+      invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        endpoint: OVERRIDE_ENDPOINT
+      }, consentData);
+      const expectedParams = {
+        he: HASHED_EMAIL,
+        '1p': '0',
+        gdpr: '1',
+        gdpr_consent: consentData.gdpr.consentString,
+        us_privacy: consentData.uspConsent
+      };
+      const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
+      expect(ajaxStub.firstCall.args[0].indexOf(`${OVERRIDE_ENDPOINT}?`)).to.equal(0);
+      expect(requestQueryParams).to.deep.equal(expectedParams);
+      expect(ajaxStub.firstCall.args[3]).to.deep.equal({method: 'GET', withCredentials: true});
+    });
+    it('sets the callbacks param of the ajax function call correctly', () => {
+      invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID,
+      }, consentData);
+      expect(ajaxStub.firstCall.args[1]).to.be.an('object').that.has.all.keys(['success', 'error']);
+    });
+    it('sets GDPR consent data flag correctly when call is under GDPR jurisdiction.', () => {
+      invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID,
+      }, consentData);
+      const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
+      expect(requestQueryParams.gdpr).to.equal('1');
+      expect(requestQueryParams.gdpr_consent).to.equal(consentData.gdpr.consentString);
+    });
+    it('sets GDPR consent data flag correctly when call is NOT under GDPR jurisdiction.', () => {
+      consentData.gdpr.gdprApplies = false;
+      invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID,
+      }, consentData);
+      const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
+      expect(requestQueryParams.gdpr).to.equal('0');
+      expect(requestQueryParams.gdpr_consent).to.equal('');
+    });
+    [1, '1', true].forEach(firstPartyParamValue => {
+      it(`sets 1p payload property to '1' for a config value of ${firstPartyParamValue}`, () => {
+        invokeGetIdAPI({
+          '1p': firstPartyParamValue,
+          he: HASHED_EMAIL,
+          pixelId: PIXEL_ID,
+        }, consentData);
+        const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
+        expect(requestQueryParams['1p']).to.equal('1');
+      });
+    });
+  });
+  describe('decode()', () => {
+    const VALID_API_RESPONSES = [{
+      key: 'connectid',
+      expected: '4567',
+      payload: {
+        connectid: '4567'
+      }
+    }];
+    VALID_API_RESPONSES.forEach(responseData => {
+      it('should return a newly constructed object with the connect ID for a payload with ${responseData.key} key(s)', () => {
+        expect(connectIdSubmodule.decode(responseData.payload)).to.deep.equal(
+          {connectId: responseData.expected}
+        );
+      });
+    });
+    [{}, '', {foo: 'bar'}].forEach((response) => {
+      it(`should return undefined for an invalid response "${JSON.stringify(response)}"`, () => {
+        expect(connectIdSubmodule.decode(response)).to.be.undefined;
+      });
+    });
+  });
+});