prebid.js 5.16.0 → 5.20.0

package/test/spec/modules/codefuelBidAdapter_spec.js

@@ -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

@@ -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;
+      });
+    });
+  });
+});