mk9-prebid/test/spec/modules/verizonMediaIdSystem_spec.js

Header Bidding Management Library

import {expect} from 'chai';
import * as utils from 'src/utils.js';
import {verizonMediaIdSubmodule} from 'modules/verizonMediaIdSystem.js';

describe('Verizon Media ID 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(verizonMediaIdSubmodule.name).to.equal('verizonMediaId');
  });

  it('should have the correct TCFv2 Vendor ID declared', () => {
    expect(verizonMediaIdSubmodule.gvlid).to.equal(25);
  });

  describe('getId()', () => {
    let ajaxStub;
    let getAjaxFnStub;
    let consentData;
    beforeEach(() => {
      ajaxStub = sinon.stub();
      getAjaxFnStub = sinon.stub(verizonMediaIdSubmodule, '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 = verizonMediaIdSubmodule.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 = utils.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 = utils.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 = utils.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 = utils.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 = utils.parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
        expect(requestQueryParams['1p']).to.equal('1');
      });
    });
  });

  describe('decode()', () => {
    const VALID_API_RESPONSES = [{
      key: 'vmiud',
      expected: '1234',
      payload: {
        vmuid: '1234'
      }
    },
    {
      key: 'connectid',
      expected: '4567',
      payload: {
        connectid: '4567'
      }
    },
    {
      key: 'both',
      expected: '4567',
      payload: {
        vmuid: '1234',
        connectid: '4567'
      }
    }];
    VALID_API_RESPONSES.forEach(responseData => {
      it('should return a newly constructed object with the connectid for a payload with ${responseData.key} key(s)', () => {
        expect(verizonMediaIdSubmodule.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(verizonMediaIdSubmodule.decode(response)).to.be.undefined;
      });
    });
  });
});