prebid.js 6.0.0 → 6.4.0

package/test/spec/modules/ixBidAdapter_spec.js

@@ -2,7 +2,7 @@ import * as utils from 'src/utils.js';
 import { config } from 'src/config.js';
 import { expect } from 'chai';
 import { newBidder } from 'src/adapters/bidderFactory.js';
-import { spec } from 'modules/ixBidAdapter.js';
+import { spec, storage, ERROR_CODES } from '../../../modules/ixBidAdapter.js';
 import { createEidsArray } from 'modules/userId/eids.js';
 
 describe('IndexexchangeAdapter', function () {
@@ -353,6 +353,37 @@ describe('IndexexchangeAdapter', function () {
     ]
   };
 
+  const DEFAULT_VIDEO_BID_RESPONSE_WITH_MTYPE_SET = {
+    cur: 'USD',
+    id: '1aa2bb3cc4de',
+    seatbid: [
+      {
+        bid: [
+          {
+            crid: '12346',
+            adomain: ['www.abcd.com'],
+            adid: '14851456',
+            impid: '1a2b3c4e',
+            cid: '3051267',
+            price: 110,
+            id: '2',
+            mtype: 2,
+            adm: '<?xml version=\"1.0\" encoding=\"UTF-8\"?><VAST xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"vast.xsd\" version=\"3.0\"> <Ad id=\"488427365\">  <InLine>   <AdSystem>Test</AdSystem>   <AdTitle>In-Stream Video</AdTitle> </InLine> </Ad></VAST',
+            ext: {
+              vasturl: 'www.abcd.com/vast',
+              errorurl: 'www.abcd.com/error',
+              dspid: 51,
+              pricelevel: '_110',
+              advbrandid: 303326,
+              advbrand: 'OECTB'
+            }
+          }
+        ],
+        seat: '3971'
+      }
+    ]
+  };
+
   const DEFAULT_OPTION = {
     gdprConsent: {
       gdprApplies: true,
@@ -1236,7 +1267,7 @@ describe('IndexexchangeAdapter', function () {
     afterEach(function () {
       config.setConfig({
         ortb2: {}
-      })
+      });
     });
 
     it('should not set ixdiag.fpd value if not defined', function () {
@@ -2343,6 +2374,45 @@ describe('IndexexchangeAdapter', function () {
       expect(result[0]).to.deep.equal(expectedParse[0]);
     });
 
+    it('should get correct bid response for video ad and set bid.vastXml when mtype is 2 (video)', function () {
+      const expectedParse = [
+        {
+          requestId: '1a2b3c4e',
+          cpm: 1.1,
+          creativeId: '12346',
+          mediaType: 'video',
+          mediaTypes: {
+            video: {
+              context: 'instream',
+              playerSize: [
+                [
+                  400,
+                  100
+                ]
+              ]
+            }
+          },
+          width: 640,
+          height: 480,
+          currency: 'USD',
+          ttl: 3600,
+          netRevenue: true,
+          vastXml: '<?xml version=\"1.0\" encoding=\"UTF-8\"?><VAST xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"vast.xsd\" version=\"3.0\"> <Ad id=\"488427365\">  <InLine>   <AdSystem>Test</AdSystem>   <AdTitle>In-Stream Video</AdTitle> </InLine> </Ad></VAST',
+          meta: {
+            networkId: 51,
+            brandId: 303326,
+            brandName: 'OECTB',
+            advertiserDomains: ['www.abcd.com']
+          }
+        }
+      ];
+      const result = spec.interpretResponse({ body: DEFAULT_VIDEO_BID_RESPONSE_WITH_MTYPE_SET }, {
+        data: DEFAULT_BIDDER_REQUEST_DATA, validBidRequests: ONE_VIDEO
+      });
+
+      expect(result[0]).to.deep.equal(expectedParse[0]);
+    });
+
     it('bidrequest should not have page if options is undefined', function () {
       const options = {};
       const validBidWithoutreferInfo = spec.buildRequests(DEFAULT_BANNER_VALID_BID, options);
@@ -2524,4 +2594,225 @@ describe('IndexexchangeAdapter', function () {
       expect(r.regs.coppa).to.be.undefined;
     });
   });
+
+  describe('LocalStorage ixdiag', () => {
+    let TODAY = new Date().toISOString().slice(0, 10);
+    const key = 'ixdiag';
+
+    let sandbox;
+    let setDataInLocalStorageStub;
+    let getDataFromLocalStorageStub;
+    let removeDataFromLocalStorageStub;
+    let localStorageValues = {};
+
+    beforeEach(() => {
+      sandbox = sinon.sandbox.create();
+      setDataInLocalStorageStub = sandbox.stub(storage, 'setDataInLocalStorage').callsFake((key, value) => localStorageValues[key] = value)
+      getDataFromLocalStorageStub = sandbox.stub(storage, 'getDataFromLocalStorage').callsFake((key) => localStorageValues[key])
+      removeDataFromLocalStorageStub = sandbox.stub(storage, 'removeDataFromLocalStorage').callsFake((key) => delete localStorageValues[key])
+      sandbox.stub(storage, 'localStorageIsEnabled').returns(true);
+    });
+
+    afterEach(() => {
+      setDataInLocalStorageStub.restore();
+      getDataFromLocalStorageStub.restore();
+      removeDataFromLocalStorageStub.restore();
+      localStorageValues = {};
+      sandbox.restore();
+
+      config.setConfig({
+        fpd: {},
+        ix: {},
+      })
+    });
+
+    it('should not log error in LocalStorage when there is no logError called.', () => {
+      const bid = DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0];
+      expect(spec.isBidRequestValid(bid)).to.be.true;
+      expect(localStorageValues[key]).to.be.undefined;
+    });
+
+    it('should log ERROR_CODES.BID_SIZE_INVALID_FORMAT in LocalStorage when there is logError called.', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.size = ['400', 100];
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.BID_SIZE_INVALID_FORMAT]: 1 } });
+    });
+
+    it('should log ERROR_CODES.BID_SIZE_NOT_INCLUDED in LocalStorage when there is logError called.', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.size = [407, 100];
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.BID_SIZE_NOT_INCLUDED]: 1 } });
+    });
+
+    it('should log ERROR_CODES.PROPERTY_NOT_INCLUDED in LocalStorage when there is logError called.', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.video = {};
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.PROPERTY_NOT_INCLUDED]: 4 } });
+    });
+
+    it('should log ERROR_CODES.SITE_ID_INVALID_VALUE in LocalStorage when there is logError called.', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.siteId = false;
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.SITE_ID_INVALID_VALUE]: 1 } });
+    });
+
+    it('should log ERROR_CODES.BID_FLOOR_INVALID_FORMAT in LocalStorage when there is logError called.', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.bidFloor = true;
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.BID_FLOOR_INVALID_FORMAT]: 1 } });
+    });
+
+    it('should log ERROR_CODES.IX_FPD_EXCEEDS_MAX_SIZE in LocalStorage when there is logError called.', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+
+      config.setConfig({
+        ix: {
+          firstPartyData: {
+            cd: Array(1700).join('#')
+          }
+        }
+      });
+
+      expect(spec.isBidRequestValid(bid)).to.be.true;
+      spec.buildRequests([bid]);
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.IX_FPD_EXCEEDS_MAX_SIZE]: 2 } });
+    });
+
+    it('should log ERROR_CODES.EXCEEDS_MAX_SIZE in LocalStorage when there is logError called.', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.bidderRequestId = Array(8000).join('#');
+
+      expect(spec.isBidRequestValid(bid)).to.be.true;
+      spec.buildRequests([bid]);
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.EXCEEDS_MAX_SIZE]: 2 } });
+    });
+
+    it('should log ERROR_CODES.PB_FPD_EXCEEDS_MAX_SIZE in LocalStorage when there is logError called.', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+
+      config.setConfig({
+        fpd: {
+          site: {
+            data: {
+              pageType: Array(5700).join('#')
+            }
+          }
+        }
+      });
+
+      expect(spec.isBidRequestValid(bid)).to.be.true;
+      spec.buildRequests([bid]);
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.PB_FPD_EXCEEDS_MAX_SIZE]: 2 } });
+    });
+
+    it('should log ERROR_CODES.VIDEO_DURATION_INVALID in LocalStorage when there is logError called.', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.video.minduration = 1;
+      bid.params.video.maxduration = 0;
+
+      expect(spec.isBidRequestValid(bid)).to.be.true;
+      spec.buildRequests([bid]);
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.VIDEO_DURATION_INVALID]: 2 } });
+    });
+
+    it('should increment errors for errorCode', () => {
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.video = {};
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.PROPERTY_NOT_INCLUDED]: 4 } });
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.PROPERTY_NOT_INCLUDED]: 8 } });
+    });
+
+    it('should add new errorCode to ixdiag.', () => {
+      let bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.size = ['400', 100];
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { [ERROR_CODES.BID_SIZE_INVALID_FORMAT]: 1 } });
+
+      bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.siteId = false;
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({
+        [TODAY]: {
+          [ERROR_CODES.BID_SIZE_INVALID_FORMAT]: 1,
+          [ERROR_CODES.SITE_ID_INVALID_VALUE]: 1
+        }
+      });
+    });
+
+    it('should clear errors with successful response', () => {
+      const ixdiag = { [TODAY]: { '1': 1, '3': 8, '4': 1 } };
+      setDataInLocalStorageStub(key, JSON.stringify(ixdiag));
+
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal(ixdiag);
+
+      const request = DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0];
+      expect(spec.isBidRequestValid(request)).to.be.true;
+
+      const data = {
+        ...utils.deepClone(DEFAULT_BIDDER_REQUEST_DATA[0]),
+        r: JSON.stringify({
+          id: '345',
+          imp: [
+            {
+              id: '1a2b3c4e',
+            }
+          ],
+          ext: {
+            ixdiag: {
+              err: {
+                '4': 8
+              }
+            }
+          }
+        }),
+      };
+
+      const validBidRequests = [
+        DEFAULT_MULTIFORMAT_BANNER_VALID_BID[0],
+        DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]
+      ];
+
+      spec.interpretResponse({ body: DEFAULT_BANNER_BID_RESPONSE }, { data, validBidRequests });
+
+      expect(localStorageValues[key]).to.be.undefined;
+    });
+
+    it('should clear errors after 7 day expiry errorCode', () => {
+      const EXPIRED_DATE = '2019-12-12';
+
+      const ixdiag = { [EXPIRED_DATE]: { '1': 1, '3': 8, '4': 1 }, [TODAY]: { '3': 8, '4': 1 } };
+      setDataInLocalStorageStub(key, JSON.stringify(ixdiag));
+
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.size = ['400', 100];
+
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(JSON.parse(localStorageValues[key])[EXPIRED_DATE]).to.be.undefined;
+      expect(JSON.parse(localStorageValues[key])).to.deep.equal({ [TODAY]: { '1': 1, '3': 8, '4': 1 } })
+    });
+
+    it('should not save error data into localstorage if consent is not given', () => {
+      config.setConfig({ deviceAccess: false });
+      const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
+      bid.params.size = ['400', 100];
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(localStorageValues[key]).to.be.undefined;
+    });
+  });
 });

package/test/spec/modules/konduitWrapper_spec.js

@@ -53,7 +53,6 @@ describe('The Konduit vast wrapper module', function () {
       const callback = sinon.spy();
       processBids({ bid, callback });
       server.respond();
-
       expect(server.requests.length).to.equal(1);
 
       const requestBody = JSON.parse(server.requests[0].requestBody);

package/test/spec/modules/limelightDigitalBidAdapter_spec.js

@@ -9,7 +9,8 @@ describe('limelightDigitalAdapter', function () {
     params: {
       host: 'exchange.ortb.net',
       adUnitId: 123,
-      adUnitType: 'banner'
+      adUnitType: 'banner',
+      publisherId: 'perfectPublisher'
     },
     placementCode: 'placement_0',
     auctionId: '74f78609-a92d-4cf1-869f-1b244bbfb5d2',
@@ -41,7 +42,8 @@ describe('limelightDigitalAdapter', function () {
     params: {
       host: 'exchange.ortb.net',
       adUnitId: 789,
-      adUnitType: 'video'
+      adUnitType: 'video',
+      publisherId: 'secondPerfectPublisher'
     },
     placementCode: 'placement_2',
     auctionId: 'e4771143-6aa7-41ec-8824-ced4342c96c8',
@@ -89,7 +91,7 @@ describe('limelightDigitalAdapter', function () {
         expect(data.deviceHeight).to.be.a('number')
         expect(data.secure).to.be.a('boolean')
         data.adUnits.forEach(adUnit => {
-          expect(adUnit).to.have.all.keys('id', 'bidId', 'type', 'sizes', 'transactionId')
+          expect(adUnit).to.have.all.keys('id', 'bidId', 'type', 'sizes', 'transactionId', 'publisherId')
           expect(adUnit.id).to.be.a('number')
           expect(adUnit.bidId).to.be.a('string')
           expect(adUnit.type).to.be.a('string')
@@ -456,10 +458,10 @@ describe('limelightDigitalAdapter', function () {
 });
 
 function validateAdUnit(adUnit, bid) {
-  expect(adUnit.id).to.equal(bid.params.adUnitId)
-  expect(adUnit.bidId).to.equal(bid.bidId)
-  expect(adUnit.type).to.equal(bid.params.adUnitType.toUpperCase())
-  expect(adUnit.transactionId).to.equal(bid.transactionId)
+  expect(adUnit.id).to.equal(bid.params.adUnitId);
+  expect(adUnit.bidId).to.equal(bid.bidId);
+  expect(adUnit.type).to.equal(bid.params.adUnitType.toUpperCase());
+  expect(adUnit.transactionId).to.equal(bid.transactionId);
   let bidSizes = [];
   if (bid.mediaTypes) {
     if (bid.mediaTypes.video && bid.mediaTypes.video.playerSize) {
@@ -478,4 +480,5 @@ function validateAdUnit(adUnit, bid) {
       height: size[1]
     }
   }));
+  expect(adUnit.publisherId).to.equal(bid.params.publisherId);
 }

package/test/spec/modules/livewrappedBidAdapter_spec.js

@@ -885,6 +885,37 @@ describe('Livewrapped adapter tests', function () {
     expect(data.rtbData.user.ext.eids).to.deep.equal(testbidRequest.bids[0].userIdAsEids);
   });
 
+  it('should merge user ids with existing ortb2', function() {
+    sandbox.stub(utils, 'isSafariBrowser').callsFake(() => false);
+    sandbox.stub(storage, 'cookiesAreEnabled').callsFake(() => true);
+
+    let origGetConfig = config.getConfig;
+    sandbox.stub(config, 'getConfig').callsFake(function (key) {
+      if (key === 'ortb2') {
+        return {user: {ext: {prop: 'value'}}};
+      }
+      return origGetConfig.apply(config, arguments);
+    });
+
+    let testbidRequest = clone(bidderRequest);
+    delete testbidRequest.bids[0].params.userId;
+    testbidRequest.bids[0].userIdAsEids = [
+      {
+        'source': 'pubcid.org',
+        'uids': [{
+          'id': 'publisher-common-id',
+          'atype': 1
+        }]
+      }
+    ];
+
+    let result = spec.buildRequests(testbidRequest.bids, testbidRequest);
+    let data = JSON.parse(result.data);
+    var expected = {user: {ext: {prop: 'value', eids: testbidRequest.bids[0].userIdAsEids}}}
+
+    expect(data.rtbData).to.deep.equal(expected);
+  });
+
   it('should send schain object if available', function() {
     sandbox.stub(utils, 'isSafariBrowser').callsFake(() => false);
     sandbox.stub(storage, 'cookiesAreEnabled').callsFake(() => true);

package/test/spec/modules/lotamePanoramaIdSystem_spec.js

@@ -2,6 +2,7 @@ import {
   lotamePanoramaIdSubmodule,
   storage,
 } from 'modules/lotamePanoramaIdSystem.js';
+import { uspDataHandler } from 'src/adapterManager.js';
 import * as utils from 'src/utils.js';
 import { server } from 'test/mocks/xhr.js';
 import sinon from 'sinon';
@@ -16,6 +17,7 @@ describe('LotameId', function() {
   let setLocalStorageStub;
   let removeFromLocalStorageStub;
   let timeStampStub;
+  let uspConsentDataStub;
 
   const nowTimestamp = new Date().getTime();
 
@@ -30,6 +32,7 @@ describe('LotameId', function() {
       'removeDataFromLocalStorage'
     );
     timeStampStub = sinon.stub(utils, 'timestamp').returns(nowTimestamp);
+    uspConsentDataStub = sinon.stub(uspDataHandler, 'getConsentData');
   });
 
   afterEach(function () {
@@ -40,6 +43,7 @@ describe('LotameId', function() {
     setLocalStorageStub.restore();
     removeFromLocalStorageStub.restore();
     timeStampStub.restore();
+    uspConsentDataStub.restore();
   });
 
   describe('caching initial data received from the remote server', function () {
@@ -726,4 +730,227 @@ describe('LotameId', function() {
       );
     });
   });
+
+  describe('with a custom client id', function () {
+    describe('with a client expiry set', function () {
+      beforeEach(function () {
+        getCookieStub
+          .withArgs('panoramaId_expiry_1234')
+          .returns(String(Date.now() + 500 * 1000));
+      });
+
+      describe('and an existing pano id', function() {
+        let submoduleCallback;
+        beforeEach(function () {
+          getCookieStub
+            .withArgs('panoramaId_expiry')
+            .returns(String(Date.now() + 100000));
+          getCookieStub
+            .withArgs('panoramaId')
+            .returns(
+              'ca22992567e3cd4d116a5899b88a55d0d857a23610db939ae6ac13ba2335d87c'
+            );
+          submoduleCallback = lotamePanoramaIdSubmodule.getId(
+            {
+              params: {
+                clientId: '1234',
+              },
+            },
+            {
+              gdprApplies: false,
+            }
+          );
+        });
+
+        it('should not call the remote server when getId is called nor get an id', function () {
+          expect(submoduleCallback).to.be.eql({
+            id: undefined,
+            reason: 'NO_CLIENT_CONSENT',
+          });
+        });
+      });
+
+      describe('and no existing pano id', function () {
+        let submoduleCallback;
+
+        beforeEach(function () {
+          // Let the panoramaId_expiry be empty
+
+          submoduleCallback = lotamePanoramaIdSubmodule.getId(
+            {
+              params: {
+                clientId: '1234',
+              },
+            },
+            {
+              gdprApplies: false,
+            }
+          );
+        });
+
+        it('should not call the remote server nor return an id', function () {
+          expect(submoduleCallback).to.be.eql({
+            id: undefined,
+            reason: 'NO_CLIENT_CONSENT',
+          });
+        });
+      });
+    });
+
+    describe('with no client expiry set', function () {
+      describe('and no existing pano id', function () {
+        let request;
+        let callBackSpy = sinon.spy();
+
+        beforeEach(function () {
+          uspConsentDataStub.returns('1NNN');
+          let submoduleCallback = lotamePanoramaIdSubmodule.getId(
+            {
+              params: {
+                clientId: '1234',
+              },
+            },
+            {
+              gdprApplies: false,
+            }
+          ).callback;
+          submoduleCallback(callBackSpy);
+
+          request = server.requests[0];
+
+          request.respond(
+            200,
+            responseHeader,
+            JSON.stringify({
+              profile_id: '4ec137245858469eb94a4e248f238694',
+              core_id:
+                'ca22992567e3cd4d116a5899b88a55d0d857a23610db939ae6ac13ba2335d87f',
+              expiry_ts: 3600000,
+            })
+          );
+        });
+
+        it('should call the remote server when getId is called', function () {
+          expect(callBackSpy.calledOnce).to.be.true;
+        });
+
+        it('should pass the usp consent string and client id back', function () {
+          expect(request.url).to.be.eq(
+            'https://id.crwdcntrl.net/id?gdpr_applies=false&us_privacy=1NNN&c=1234'
+          );
+        });
+
+        it('should NOT set an expiry for the client', function () {
+          sinon.assert.neverCalledWith(
+            setCookieStub,
+            'panoramaId_expiry_1234',
+            sinon.match.number
+          );
+        });
+      });
+
+      describe('and an existing pano id', function () {
+        let submoduleCallback;
+
+        beforeEach(function () {
+          getCookieStub
+            .withArgs('panoramaId_expiry')
+            .returns(String(Date.now() + 100000));
+          getCookieStub
+            .withArgs('panoramaId')
+            .returns(
+              'ca22992567e3cd4d116a5899b88a55d0d857a23610db939ae6ac13ba2335d87c'
+            );
+          submoduleCallback = lotamePanoramaIdSubmodule.getId(
+            {
+              params: {
+                clientId: '1234',
+              },
+            },
+            {
+              gdprApplies: false,
+            }
+          );
+        });
+
+        it('should not call the remote server but use the cached value', function () {
+          expect(submoduleCallback).to.be.eql({
+            id: 'ca22992567e3cd4d116a5899b88a55d0d857a23610db939ae6ac13ba2335d87c',
+          });
+        });
+
+        it('should NOT set an expiry for the client', function () {
+          sinon.assert.neverCalledWith(
+            setCookieStub,
+            'panoramaId_expiry_1234',
+            sinon.match.number
+          );
+        });
+      });
+    });
+    describe('when client consent has errors', function () {
+      let request;
+      let callBackSpy = sinon.spy();
+
+      beforeEach(function () {
+        let submoduleCallback = lotamePanoramaIdSubmodule.getId(
+          {
+            params: {
+              clientId: '1234',
+            },
+          },
+          {
+            gdprApplies: false,
+          }
+        ).callback;
+        submoduleCallback(callBackSpy);
+
+        request = server.requests[0];
+
+        request.respond(
+          200,
+          responseHeader,
+          JSON.stringify({
+            expiry_ts: 3600000,
+            errors: [111],
+            no_consent: 'CLIENT',
+          })
+        );
+      });
+
+      it('should call the remote server when getId is called', function () {
+        expect(callBackSpy.calledOnce).to.be.true;
+      });
+
+      it('should pass client id back', function () {
+        expect(request.url).to.be.eq(
+          'https://id.crwdcntrl.net/id?gdpr_applies=false&c=1234'
+        );
+      });
+
+      it('should set the received expiry for the client', function() {
+        sinon.assert.calledWith(
+          setCookieStub,
+          'panoramaId_expiry_1234',
+          3600000
+        );
+      });
+
+      it('should not clear the cache for the panorama id', function() {
+        sinon.assert.neverCalledWith(
+          setCookieStub,
+          'panoramaId',
+          sinon.match.any
+        );
+      });
+
+      it('should not clear the cache for the panorama id expiry', function () {
+        sinon.assert.neverCalledWith(
+          setCookieStub,
+          'panoramaId_expiry',
+          sinon.match.any
+        );
+      });
+    });
+  });
 });