prebid.js 9.4.0 → 9.5.0

package/test/spec/modules/targetVideoBidAdapter_spec.js

@@ -1,27 +1,42 @@
 import { spec } from '../../../modules/targetVideoBidAdapter.js'
 
 describe('TargetVideo Bid Adapter', function() {
+  const bidder = 'targetVideo';
+  const params = {
+    placementId: 12345,
+  };
+
   const bannerRequest = [{
-    bidder: 'targetVideo',
+    bidder,
+    params,
     mediaTypes: {
       banner: {
         sizes: [[300, 250]],
       }
     },
-    params: {
-      placementId: 12345,
+  }];
+
+  const videoRequest = [{
+    bidder,
+    params,
+    mediaTypes: {
+      video: {
+        playerSize: [[640, 360]],
+        context: 'instream',
+        playbackmethod: [1, 2, 3, 4]
+      }
     }
   }];
 
   it('Test the bid validation function', function() {
-    const validBid = spec.isBidRequestValid(bannerRequest[0]);
+    const validBid = spec.isBidRequestValid(bannerRequest[0]) && spec.isBidRequestValid(videoRequest[0]);
     const invalidBid = spec.isBidRequestValid(null);
 
     expect(validBid).to.be.true;
     expect(invalidBid).to.be.false;
   });
 
-  it('Test the request processing function', function () {
+  it('Test the BANNER request processing function', function() {
     const request = spec.buildRequests(bannerRequest, bannerRequest[0]);
     expect(request).to.not.be.empty;
 
@@ -36,7 +51,20 @@ describe('TargetVideo Bid Adapter', function() {
     expect(payload.tags[0].ad_types[0]).to.equal('video');
   });
 
-  it('Handle nobid responses', function () {
+  it('Test the VIDEO request processing function', function() {
+    const request = spec.buildRequests(videoRequest, videoRequest[0]);
+    expect(request).to.not.be.empty;
+
+    const payload = JSON.parse(request[0].data);
+    expect(payload).to.not.be.empty;
+    expect(payload.sdk).to.deep.equal({
+      source: 'pbjs',
+      version: '$prebid.version$'
+    });
+    expect(payload.imp[0].ext.prebid.storedrequest.id).to.equal(12345);
+  })
+
+  it('Handle BANNER nobid responses', function() {
     const responseBody = {
       'version': '0.0.1',
       'tags': [{
@@ -48,11 +76,24 @@ describe('TargetVideo Bid Adapter', function() {
     };
     const bidderRequest = null;
 
-    const bidResponse = spec.interpretResponse({ body: responseBody }, {bidderRequest});
+    const bidResponse = spec.interpretResponse({ body: responseBody }, { bidderRequest });
     expect(bidResponse.length).to.equal(0);
   });
 
-  it('Test the response parsing function', function () {
+  it('Handle VIDEO nobid responses', function() {
+    const responseBody = {
+      'id': 'test-id',
+      'cur': 'USD',
+      'seatbid': [],
+      'nbr': 0
+    };
+    const bidderRequest = null;
+
+    const bidResponse = spec.interpretResponse({ body: responseBody }, { bidderRequest });
+    expect(bidResponse.length).to.equal(0);
+  })
+
+  it('Test the BANNER response parsing function', function() {
     const responseBody = {
       'tags': [{
         'uuid': '84ab500420319d',
@@ -82,7 +123,7 @@ describe('TargetVideo Bid Adapter', function() {
       }]
     };
 
-    const bidResponse = spec.interpretResponse({ body: responseBody }, {bidderRequest});
+    const bidResponse = spec.interpretResponse({ body: responseBody }, { bidderRequest });
     expect(bidResponse).to.not.be.empty;
 
     const bid = bidResponse[0];
@@ -94,7 +135,43 @@ describe('TargetVideo Bid Adapter', function() {
     expect(bid.ad).to.include('initPlayer')
   });
 
-  it('Test GDPR consent information is present in the request', function () {
+  it('Test the VIDEO response parsing function', function() {
+    const responseBody = {
+      'id': 'test-id',
+      'cur': 'USD',
+      'seatbid': [{
+        'bid': [{
+          'id': '5044997188309660254',
+          'price': 10,
+          'adm': 'test ad',
+          'adid': '97517771',
+          'crid': '97517771',
+          'adomain': ['domain.com'],
+          'w': 640,
+          'h': 480
+        }],
+        'seat': 'bidder'
+      }]
+    };
+    const bidderRequest = {
+      bidderCode: 'brid',
+      bidderRequestId: '22edbae2733bf6',
+      bids: videoRequest
+    };
+
+    const bidResponse = spec.interpretResponse({ body: responseBody }, { bidderRequest });
+    expect(bidResponse).to.not.be.empty;
+
+    const bid = bidResponse[0];
+    expect(bid).to.not.be.empty;
+    expect(bid.ad).to.equal('test ad');
+    expect(bid.cpm).to.equal(10);
+    expect(bid.width).to.equal(640);
+    expect(bid.height).to.equal(480);
+    expect(bid.currency).to.equal('USD');
+  })
+
+  it('Test BANNER GDPR consent information is present in the request', function() {
     let consentString = 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A==';
     let bidderRequest = {
       'bidderCode': 'targetVideo',
@@ -119,7 +196,7 @@ describe('TargetVideo Bid Adapter', function() {
     expect(payload.gdpr_consent.addtl_consent).to.exist.and.to.deep.equal([7, 12, 35, 62, 66, 70, 89, 93, 108]);
   });
 
-  it('Test US Privacy string is present in the request', function() {
+  it('Test BANNER US Privacy string is present in the request', function() {
     let consentString = '1YA-';
     let bidderRequest = {
       'bidderCode': 'targetVideo',
@@ -136,4 +213,28 @@ describe('TargetVideo Bid Adapter', function() {
     expect(payload.us_privacy).to.exist;
     expect(payload.us_privacy).to.exist.and.to.equal(consentString);
   });
+
+  it('Test VIDEO GDPR and USP consents  are present in the request', function() {
+    let gdprConsentString = 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A==';
+    let uspConsentString = '1YA-';
+    let bidderRequest = {
+      'bidderCode': 'targetVideo',
+      'bidderRequestId': '22edbae2733bf6',
+      'timeout': 3000,
+      'uspConsent': uspConsentString,
+      'gdprConsent': {
+        consentString: gdprConsentString,
+        gdprApplies: true,
+        addtlConsent: '1~7.12.35.62.66.70.89.93.108'
+      }
+    };
+    bidderRequest.bids = videoRequest;
+
+    const request = spec.buildRequests(videoRequest, bidderRequest);
+    const payload = JSON.parse(request[0].data);
+
+    expect(payload.user.ext.consent).to.equal(gdprConsentString);
+    expect(payload.regs.ext.us_privacy).to.equal(uspConsentString);
+    expect(payload.regs.ext.gdpr).to.equal(1);
+  });
 });

package/test/spec/modules/yandexIdSystem_spec.js

@@ -110,12 +110,17 @@ describe('YandexId module', () => {
 
     describe('crypto', () => {
       it('uses Math.random when crypto is not available', () => {
-        sandbox.stub(window, 'crypto').value(undefined);
+        const cryptoTmp = window.crypto;
+
+        // @ts-expect-error -- Crypto is always defined in modern JS. TS yells when trying to delete non-nullable property.
+        delete window.crypto;
 
         yandexIdSubmodule.getId(CORRECT_SUBMODULE_CONFIG);
 
         expect(randomStub.calledOnce).to.be.true;
         expect(getCryptoRandomValuesStub.called).to.be.false;
+
+        window.crypto = cryptoTmp;
       });
 
       it('uses crypto when it is available', () => {

package/test/spec/schainSerializer/schainSerializer_spec.js

@@ -0,0 +1,138 @@
+import {serializeSupplyChain} from '../../../libraries/schainSerializer/schainSerializer.js'
+describe('serializeSupplyChain', () => {
+  describe('Single Hop - Chain Complete', () => {
+    it('should serialize a single hop chain with complete information', () => {
+      const schain = {
+        ver: '1.0',
+        complete: 1,
+        nodes: [
+          {
+            asi: 'exchange1.com',
+            sid: '1234',
+            hp: 1,
+            rid: 'bid-request-1',
+            name: 'publisher',
+            domain: 'publisher.com'
+          }
+        ]
+      };
+      const nodesProperties = ['asi', 'sid', 'hp', 'rid', 'name', 'domain'];
+      const expectedResult = '1.0,1!exchange1.com,1234,1,bid-request-1,publisher,publisher.com';
+      expect(serializeSupplyChain(schain, nodesProperties)).to.equal(expectedResult);
+    });
+  });
+
+  describe('Single Hop - Chain Complete, optional fields missing', () => {
+    it('should serialize a single hop chain with missing optional fields', () => {
+      const schain = {
+        ver: '1.0',
+        complete: 1,
+        nodes: [
+          {
+            asi: 'exchange1.com',
+            sid: '1234',
+            hp: 1
+          }
+        ]
+      };
+      const nodesProperties = ['asi', 'sid', 'hp', 'rid', 'name', 'domain'];
+      const expectedResult = '1.0,1!exchange1.com,1234,1,,,';
+      expect(serializeSupplyChain(schain, nodesProperties)).to.equal(expectedResult);
+    });
+  });
+
+  describe('Multiple Hops - With all properties supplied', () => {
+    it('should serialize multiple hops with all properties supplied', () => {
+      const schain = {
+        ver: '1.0',
+        complete: 1,
+        nodes: [
+          {
+            asi: 'exchange1.com',
+            sid: '1234',
+            hp: 1,
+            rid: 'bid-request-1',
+            name: 'publisher',
+            domain: 'publisher.com'
+          },
+          {
+            asi: 'exchange2.com',
+            sid: 'abcd',
+            hp: 1,
+            rid: 'bid-request-2',
+            name: 'intermediary',
+            domain: 'intermediary.com'
+          }
+        ]
+      };
+      const nodesProperties = ['asi', 'sid', 'hp', 'rid', 'name', 'domain'];
+      const expectedResult = '1.0,1!exchange1.com,1234,1,bid-request-1,publisher,publisher.com!exchange2.com,abcd,1,bid-request-2,intermediary,intermediary.com';
+      expect(serializeSupplyChain(schain, nodesProperties)).to.equal(expectedResult);
+    });
+  });
+
+  describe('Multiple Hops - Chain Complete, optional fields missing', () => {
+    it('should serialize multiple hops with missing optional fields', () => {
+      const schain = {
+        ver: '1.0',
+        complete: 1,
+        nodes: [
+          {
+            asi: 'exchange1.com',
+            sid: '1234',
+            hp: 1
+          },
+          {
+            asi: 'exchange2.com',
+            sid: 'abcd',
+            hp: 1
+          }
+        ]
+      };
+      const nodesProperties = ['asi', 'sid', 'hp', 'rid', 'name', 'domain'];
+      const expectedResult = '1.0,1!exchange1.com,1234,1,,,!exchange2.com,abcd,1,,,';
+      expect(serializeSupplyChain(schain, nodesProperties)).to.equal(expectedResult);
+    });
+  });
+
+  describe('Multiple Hops Expected - Chain Incomplete', () => {
+    it('should serialize multiple hops with chain incomplete', () => {
+      const schain = {
+        ver: '1.0',
+        complete: 0,
+        nodes: [
+          {
+            asi: 'exchange2.com',
+            sid: 'abcd',
+            hp: 1
+          }
+        ]
+      };
+      const nodesProperties = ['asi', 'sid', 'hp', 'rid', 'name', 'domain'];
+      const expectedResult = '1.0,0!exchange2.com,abcd,1,,,';
+      expect(serializeSupplyChain(schain, nodesProperties)).to.equal(expectedResult);
+    });
+  });
+
+  describe('Single Hop - Chain Complete, encoded values', () => {
+    it('should serialize a single hop chain with encoded values', () => {
+      const schain = {
+        ver: '1.0',
+        complete: 1,
+        nodes: [
+          {
+            asi: 'exchange1.com',
+            sid: '1234!abcd',
+            hp: 1,
+            rid: 'bid-request-1',
+            name: 'publisher, Inc.',
+            domain: 'publisher.com'
+          }
+        ]
+      };
+      const nodesProperties = ['asi', 'sid', 'hp', 'rid', 'name', 'domain'];
+      const expectedResult = '1.0,1!exchange1.com,1234%21abcd,1,bid-request-1,publisher%2C%20Inc.,publisher.com';
+      expect(serializeSupplyChain(schain, nodesProperties)).to.equal(expectedResult);
+    });
+  });
+});

package/test/spec/unit/core/storageManager_spec.js

@@ -26,15 +26,15 @@ describe('storage manager', function() {
     hook.ready();
   });
 
-  beforeEach(function() {
+  beforeEach(function () {
     resetData();
   });
 
-  afterEach(function() {
+  afterEach(function () {
     config.resetConfig();
   })
 
-  it('should allow to set cookie for core modules without checking gdpr enforcements', function() {
+  it('should allow to set cookie for core modules without checking gdpr enforcements', function () {
     const coreStorage = getCoreStorageManager();
     let date = new Date();
     date.setTime(date.getTime() + (24 * 60 * 60 * 1000));
@@ -43,7 +43,7 @@ describe('storage manager', function() {
     expect(coreStorage.getCookie('hello')).to.equal('world');
   });
 
-  it('should add done callbacks to storageCallbacks array', function() {
+  it('should add done callbacks to storageCallbacks array', function () {
     let noop = sinon.spy();
     const coreStorage = newStorageManager();
 
@@ -55,11 +55,15 @@ describe('storage manager', function() {
     coreStorage.getDataFromLocalStorage('foo', noop);
     coreStorage.removeDataFromLocalStorage('foo', noop);
     coreStorage.hasLocalStorage(noop);
+    coreStorage.setDataInSessionStorage('foo', 'bar', noop);
+    coreStorage.getDataFromSessionStorage('foo', noop);
+    coreStorage.removeDataFromSessionStorage('foo', noop);
+    coreStorage.hasSessionStorage(noop);
 
-    expect(storageCallbacks.length).to.equal(8);
+    expect(storageCallbacks.length).to.equal(12);
   });
 
-  it('should allow bidder to access device if gdpr enforcement module is not included', function() {
+  it('should allow bidder to access device if gdpr enforcement module is not included', function () {
     let deviceAccessSpy = sinon.spy(utils, 'hasDeviceAccess');
     const storage = newStorageManager();
     storage.setCookie('foo1', 'baz1');
@@ -87,12 +91,16 @@ describe('storage manager', function() {
       }));
     });
 
-    it('should deny access if activity is denied', () => {
-      isAllowed.returns(false);
-      const mgr = mkManager(MODULE_TYPE_PREBID, 'mockMod');
-      mgr.setDataInLocalStorage('testKey', 'val');
-      expect(mgr.getDataFromLocalStorage('testKey')).to.not.exist;
-    });
+    ['Local', 'Session'].forEach(type => {
+      describe(`${type} storage`, () => {
+        it('should deny access if activity is denied', () => {
+          isAllowed.returns(false);
+          const mgr = mkManager(MODULE_TYPE_PREBID, 'mockMod');
+          mgr[`setDataIn${type}Storage`]('testKey', 'val');
+          expect(mgr[`getDataFrom${type}Storage`]('testKey')).to.not.exist;
+        });
+      })
+    })
 
     it('should use bidder aliases when possible', () => {
       adapterManager.registerBidAdapter({callBids: sinon.stub(), getSpec: () => ({})}, 'mockBidder');
@@ -103,57 +111,66 @@ describe('storage manager', function() {
         [ACTIVITY_PARAM_COMPONENT_NAME]: 'mockAlias'
       }))
     })
-  })
-
-  describe('localstorage forbidden access in 3rd-party context', function() {
-    let errorLogSpy;
-    let originalLocalStorage;
-    const localStorageMock = { get: () => { throw Error } };
+  });
 
-    beforeEach(function() {
-      originalLocalStorage = window.localStorage;
-      Object.defineProperty(window, 'localStorage', localStorageMock);
-      errorLogSpy = sinon.spy(utils, 'logError');
-    });
+  ['localStorage', 'sessionStorage'].forEach(storage => {
+    const Storage = storage.charAt(0).toUpperCase() + storage.substring(1);
 
-    afterEach(function() {
-      Object.defineProperty(window, 'localStorage', { get: () => originalLocalStorage });
-      errorLogSpy.restore();
-    })
+    describe(`${storage} forbidden access in 3rd-party context`, function () {
+      let errorLogSpy;
+      let originalStorage;
+      const storageMock = {
+        get: () => {
+          throw Error
+        }
+      };
 
-    it('should not throw if the localstorage is not accessible when setting/getting/removing from localstorage', function() {
-      const coreStorage = newStorageManager();
+      beforeEach(function () {
+        originalStorage = window[storage];
+        Object.defineProperty(window, storage, storageMock);
+        errorLogSpy = sinon.spy(utils, 'logError');
+      });
 
-      coreStorage.setDataInLocalStorage('key', 'value');
-      const val = coreStorage.getDataFromLocalStorage('key');
-      coreStorage.removeDataFromLocalStorage('key');
+      afterEach(function () {
+        Object.defineProperty(window, storage, {get: () => originalStorage});
+        errorLogSpy.restore();
+      })
 
-      expect(val).to.be.null;
-      sinon.assert.calledThrice(errorLogSpy);
-    })
-  })
+      it('should not throw if storage is not accessible when setting/getting/removing', function () {
+        const coreStorage = newStorageManager();
 
-  describe('localstorage is enabled', function() {
-    let localStorage;
+        coreStorage[`setDataIn${Storage}`]('key', 'value');
+        const val = coreStorage[`getDataFrom${Storage}`]('key');
+        coreStorage[`removeDataFrom${Storage}`]('key');
 
-    beforeEach(function() {
-      localStorage = window.localStorage;
-      localStorage.clear();
+        expect(val).to.be.null;
+        sinon.assert.calledThrice(errorLogSpy);
+      });
     });
+  });
 
-    afterEach(function() {
-      localStorage.clear();
-    })
+  ['localStorage', 'sessionStorage'].forEach(storage => {
+    describe(`${storage} is enabled`, function () {
+      let store;
+      beforeEach(function () {
+        store = window[storage];
+        store.clear();
+      });
 
-    it('should remove side-effect after checking', function () {
-      const storage = newStorageManager();
+      afterEach(function () {
+        store.clear();
+      })
 
-      localStorage.setItem('unrelated', 'dummy');
-      const val = storage.localStorageIsEnabled();
+      it('should remove side-effect after checking', function () {
+        const storageMgr = newStorageManager();
 
-      expect(val).to.be.true;
-      expect(localStorage.length).to.be.eq(1);
-      expect(localStorage.getItem('unrelated')).to.be.eq('dummy');
+        store.setItem('unrelated', 'dummy');
+        const val = storageMgr[`${storage}IsEnabled`]();
+
+        expect(val).to.be.true;
+        expect(store.length).to.be.eq(1);
+        expect(store.getItem('unrelated')).to.be.eq('dummy');
+      });
     });
   });
 

package/test/spec/utils_spec.js

@@ -1223,6 +1223,25 @@ describe('Utils', function () {
       expect(script.id).to.equal('newId');
     });
   });
+
+  describe('safeJSONParse', () => {
+    it('correctly encodes valid input', () => {
+      const jsonObj = {
+        key1: 'val1',
+        key2: {
+          key3: 100,
+          key4: true
+        }
+      };
+      const result = utils.safeJSONEncode(jsonObj);
+      expect(result).to.equal(`{"key1":"val1","key2":{"key3":100,"key4":true}}`);
+    });
+    it('return empty string for stringify errors', () => {
+      const jsonObj = {k: 2n};
+      const result = utils.safeJSONEncode(jsonObj);
+      expect(result).to.equal('');
+    });
+  });
 });
 
 describe('memoize', () => {