prebid.js 6.24.0 → 6.26.0

package/src/hook.js

@@ -1,10 +1,28 @@
-
 import funHooks from 'fun-hooks/no-eval/index.js';
+import {promiseControls} from './utils/promise.js';
 
 export let hook = funHooks({
   ready: funHooks.SYNC | funHooks.ASYNC | funHooks.QUEUE
 });
 
+const readyCtl = promiseControls();
+hook.ready = (() => {
+  const ready = hook.ready;
+  return function () {
+    try {
+      return ready.apply(hook, arguments);
+    } finally {
+      readyCtl.resolve();
+    }
+  }
+})();
+
+/**
+ * A promise that resolves when hooks are ready.
+ * @type {Promise}
+ */
+export const ready = readyCtl.promise;
+
 export const getHook = hook.get;
 
 export function setupBeforeHookFnOnce(baseFn, hookFn, priority = 15) {

package/src/utils/promise.js

@@ -0,0 +1,36 @@
+const SUCCESS = 0;
+const FAIL = 1;
+const RESULT = 2;
+
+/**
+ * @returns a {promise, resolve, reject} trio where `promise` is resolved by calling `resolve` or `reject`.
+ */
+export function promiseControls({promiseFactory = (resolver) => new Promise(resolver)} = {}) {
+  const status = {};
+
+  function finisher(slot) {
+    return function (val) {
+      if (typeof status[slot] === 'function') {
+        status[slot](val);
+      } else if (!status[slot]) {
+        status[slot] = true;
+        status[RESULT] = val;
+      }
+    }
+  }
+
+  return {
+    promise: promiseFactory((resolve, reject) => {
+      if (status[SUCCESS] != null) {
+        resolve(status[RESULT]);
+      } else if (status[FAIL] != null) {
+        reject(status[RESULT]);
+      } else {
+        status[SUCCESS] = resolve;
+        status[FAIL] = reject;
+      }
+    }),
+    resolve: finisher(SUCCESS),
+    reject: finisher(FAIL)
+  }
+}

package/test/spec/modules/adtelligentBidAdapter_spec.js

@@ -18,6 +18,7 @@ const aliasEP = {
   bidsxchange: 'https://ghb.hbd.bidsxchange.com/v2/auction/',
   streamkey: 'https://ghb.hb.streamkey.net/v2/auction/',
   janet: 'https://ghb.bidder.jmgads.com/v2/auction/',
+  pgam: 'https://ghb.pgamssp.com/v2/auction/',
 };
 
 const DEFAULT_ADATPER_REQ = { bidderCode: 'adtelligent' };

package/test/spec/modules/appnexusBidAdapter_spec.js

@@ -1549,14 +1549,24 @@ describe('AppNexusAdapter', function () {
   });
 
   describe('transformBidParams', function () {
-    it('convert keywords param differently for psp endpoint', function () {
-      sinon.stub(config, 'getConfig')
-        .withArgs('s2sConfig')
-        .returns({
-          endpoint: {
-            p1Consent: 'https://ib.adnxs.com/openrtb2/prebid'
-          }
-        });
+    let gcStub;
+    let adUnit = { bids: [{ bidder: 'appnexus' }] }; ;
+
+    before(function() {
+      gcStub = sinon.stub(config, 'getConfig');
+    });
+
+    after(function() {
+      gcStub.restore();
+    });
+
+    it('convert keywords param differently for psp endpoint with single s2sConfig', function () {
+      gcStub.withArgs('s2sConfig').returns({
+        bidders: ['appnexus'],
+        endpoint: {
+          p1Consent: 'https://ib.adnxs.com/openrtb2/prebid'
+        }
+      });
 
       const oldParams = {
         keywords: {
@@ -1565,10 +1575,27 @@ describe('AppNexusAdapter', function () {
         }
       };
 
-      const newParams = spec.transformBidParams(oldParams, true);
+      const newParams = spec.transformBidParams(oldParams, true, adUnit);
       expect(newParams.keywords).to.equal('genre=rock,genre=pop,pets=dog');
+    });
 
-      config.getConfig.restore();
+    it('convert keywords param differently for psp endpoint with array s2sConfig', function () {
+      gcStub.withArgs('s2sConfig').returns([{
+        bidders: ['appnexus'],
+        endpoint: {
+          p1Consent: 'https://ib.adnxs.com/openrtb2/prebid'
+        }
+      }]);
+
+      const oldParams = {
+        keywords: {
+          genre: ['rock', 'pop'],
+          pets: 'dog'
+        }
+      };
+
+      const newParams = spec.transformBidParams(oldParams, true, adUnit);
+      expect(newParams.keywords).to.equal('genre=rock,genre=pop,pets=dog');
     });
   });
 });

package/test/spec/modules/beopBidAdapter_spec.js

@@ -115,7 +115,7 @@ describe('BeOp Bid Adapter tests', () => {
         },
         'refererInfo':
         {
-          'canonicalUrl': 'http://test.te'
+          'canonicalUrl': 'test.te'
         }
       };
 
@@ -124,7 +124,20 @@ describe('BeOp Bid Adapter tests', () => {
       expect(payload.tc_string).to.exist;
       expect(payload.tc_string).to.equal('BOJ8RZsOJ8RZsABAB8AAAAAZ+A==');
       expect(payload.url).to.exist;
-      expect(payload.url).to.equal('http://localhost:9876/context.html');
+      // check that the protocol is added correctly
+      expect(payload.url).to.equal('http://test.te');
+    });
+
+    it('should not prepend the protocol in page url if already present', function () {
+      const bidderRequest = {
+        'refererInfo': {
+          'canonicalUrl': 'https://test.te'
+        }
+      };
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const payload = JSON.parse(request.data);
+      expect(payload.url).to.exist;
+      expect(payload.url).to.equal('https://test.te');
     });
   });
 

package/test/spec/modules/dfpAdServerVideo_spec.js

@@ -10,6 +10,9 @@ import { auctionManager } from 'src/auctionManager.js';
 import { gdprDataHandler, uspDataHandler } from 'src/adapterManager.js';
 import * as adpod from 'modules/adpod.js';
 import { server } from 'test/mocks/xhr.js';
+import * as adServer from 'src/adserver.js';
+import {deepClone} from 'src/utils.js';
+import {hook} from '../../../src/hook.js';
 
 const bid = {
   videoCacheKey: 'abc',
@@ -20,6 +23,10 @@ const bid = {
 };
 
 describe('The DFP video support module', function () {
+  before(() => {
+    hook.ready();
+  });
+
   it('should make a legal request URL when given the required params', function () {
     const url = parse(buildDfpVideoUrl({
       adUnit: adUnit,
@@ -226,6 +233,44 @@ describe('The DFP video support module', function () {
     gdprDataHandlerStub.restore();
   });
 
+  describe('GAM PPID', () => {
+    let ppid;
+    let getPPIDStub;
+    beforeEach(() => {
+      getPPIDStub = sinon.stub(adServer, 'getPPID').callsFake(() => ppid);
+    });
+    afterEach(() => {
+      getPPIDStub.restore();
+    });
+
+    Object.entries({
+      'params': {params: {'iu': 'mock/unit'}},
+      'url': {url: 'https://video.adserver.mock/', params: {'iu': 'mock/unit'}}
+    }).forEach(([t, opts]) => {
+      describe(`when using ${t}`, () => {
+        function buildUrlAndGetParams() {
+          const url = parse(buildDfpVideoUrl(Object.assign({
+            adUnit: adUnit,
+            bid: deepClone(bid),
+          }, opts)));
+          return utils.parseQS(url.query);
+        }
+
+        it('should be included if available', () => {
+          ppid = 'mockPPID';
+          const q = buildUrlAndGetParams();
+          expect(q.ppid).to.equal('mockPPID');
+        });
+
+        it('should not be included if not available', () => {
+          ppid = undefined;
+          const q = buildUrlAndGetParams();
+          expect(q.hasOwnProperty('ppid')).to.be.false;
+        })
+      })
+    })
+  })
+
   describe('special targeting unit test', function () {
     const allTargetingData = {
       'hb_format': 'video',

package/test/spec/modules/gravitoIdSystem_spec.js

@@ -0,0 +1,51 @@
+import { gravitoIdSystemSubmodule, storage, cookieKey } from 'modules/gravitoIdSystem.js';
+
+const GRAVITOID_TEST_VALUE = 'gravitompIdTest';
+const GRAVITOID_TEST_OBJ = {
+  gravitompId: GRAVITOID_TEST_VALUE
+};
+
+describe('gravitompId module', function () {
+  let getCookieStub;
+
+  beforeEach(function (done) {
+    getCookieStub = sinon.stub(storage, 'getCookie');
+    done();
+  });
+
+  afterEach(function () {
+    getCookieStub.restore();
+  });
+
+  const cookieTestCasesForEmpty = [
+    undefined,
+    null,
+    ''
+  ]
+
+  describe('getId()', function () {
+    it('should return the gravitompId when it exists in cookie', function () {
+      getCookieStub.withArgs(cookieKey).returns(GRAVITOID_TEST_VALUE);
+      const id = gravitoIdSystemSubmodule.getId();
+      expect(id).to.be.deep.equal({id: {gravitompId: GRAVITOID_TEST_VALUE}});
+    });
+
+    cookieTestCasesForEmpty.forEach(testCase => it('should return the gravitompId when it not exists in cookie', function () {
+      getCookieStub.withArgs(cookieKey).returns(testCase);
+      const id = gravitoIdSystemSubmodule.getId();
+      expect(id).to.be.deep.equal(undefined);
+    }));
+  });
+
+  describe('decode()', function () {
+    it('should return the gravitompId when it exists in cookie', function () {
+      const decoded = gravitoIdSystemSubmodule.decode(GRAVITOID_TEST_OBJ);
+      expect(decoded).to.be.deep.equal({gravitompId: {id: GRAVITOID_TEST_VALUE}});
+    });
+
+    it('should return the undefined when decode id is not "string"', function () {
+      const decoded = gravitoIdSystemSubmodule.decode(1);
+      expect(decoded).to.equal(undefined);
+    });
+  });
+});