prebid.js 6.28.0 → 6.29.2

package/src/utils/promise.js

@@ -1,36 +1,111 @@
 const SUCCESS = 0;
 const FAIL = 1;
-const RESULT = 2;
 
 /**
- * @returns a {promise, resolve, reject} trio where `promise` is resolved by calling `resolve` or `reject`.
+ * A version of Promise that runs callbacks synchronously when it can (i.e. after it's been fulfilled or rejected).
  */
-export function promiseControls({promiseFactory = (resolver) => new Promise(resolver)} = {}) {
-  const status = {};
+export class GreedyPromise extends Promise {
+  #result;
+  #callbacks;
+  #parent = null;
+
+  /**
+   * Convenience wrapper for setTimeout; takes care of returning an already fulfilled GreedyPromise when the delay is zero.
+   *
+   * @param {Number} delayMs delay in milliseconds
+   * @returns {GreedyPromise} a promise that resolves (to undefined) in `delayMs` milliseconds
+   */
+  static timeout(delayMs = 0) {
+    return new GreedyPromise((resolve) => {
+      delayMs === 0 ? resolve() : setTimeout(resolve, delayMs);
+    });
+  }
 
-  function finisher(slot) {
-    return function (val) {
-      if (typeof status[slot] === 'function') {
-        status[slot](val);
-      } else if (!status[slot]) {
-        status[slot] = true;
-        status[RESULT] = val;
+  constructor(resolver) {
+    const result = [];
+    const callbacks = [];
+    function handler(type, resolveFn) {
+      return function (value) {
+        if (!result.length) {
+          result.push(type, value);
+          while (callbacks.length) callbacks.shift()();
+          resolveFn(value);
+        }
+      }
+    }
+    super(
+      typeof resolver !== 'function'
+        ? resolver // let super throw an error
+        : (resolve, reject) => {
+          const rejectHandler = handler(FAIL, reject);
+          const resolveHandler = (() => {
+            const done = handler(SUCCESS, resolve);
+            return value =>
+              typeof value?.then === 'function' ? value.then(done, rejectHandler) : done(value);
+          })();
+          try {
+            resolver(resolveHandler, rejectHandler);
+          } catch (e) {
+            rejectHandler(e);
+          }
+        }
+    );
+    this.#result = result;
+    this.#callbacks = callbacks;
+  }
+  then(onSuccess, onError) {
+    if (typeof onError === 'function') {
+      // if an error handler is provided, attach a dummy error handler to super,
+      // and do the same for all promises without an error handler that precede this one in a chain.
+      // This is to avoid unhandled rejection events / warnings for errors that were, in fact, handled;
+      // since we are not using super's callback mechanisms we need to make it aware of this separately.
+      let node = this;
+      while (node) {
+        super.then.call(node, null, () => null);
+        const next = node.#parent;
+        node.#parent = null; // since we attached a handler already, we are no longer interested in what will happen later in the chain
+        node = next;
       }
     }
+    const result = this.#result;
+    const res = new GreedyPromise((resolve, reject) => {
+      const continuation = () => {
+        let value = result[1];
+        let [handler, resolveFn] = result[0] === SUCCESS ? [onSuccess, resolve] : [onError, reject];
+        if (typeof handler === 'function') {
+          try {
+            value = handler(value);
+          } catch (e) {
+            reject(e);
+            return;
+          }
+          resolveFn = resolve;
+        }
+        resolveFn(value);
+      }
+      result.length ? continuation() : this.#callbacks.push(continuation);
+    });
+    res.#parent = this;
+    return res;
   }
+}
+
+/**
+ * @returns a {promise, resolve, reject} trio where `promise` is resolved by calling `resolve` or `reject`.
+ */
+export function defer({promiseFactory = (resolver) => new GreedyPromise(resolver)} = {}) {
+  function invoker(delegate) {
+    return (val) => delegate(val);
+  }
+
+  let resolveFn, rejectFn;
 
   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;
-      }
+      resolveFn = resolve;
+      rejectFn = reject;
     }),
-    resolve: finisher(SUCCESS),
-    reject: finisher(FAIL)
+    resolve: invoker(resolveFn),
+    reject: invoker(rejectFn)
   }
 }

package/src/utils.js

@@ -2,6 +2,7 @@ import { config } from './config.js';
 import clone from 'just-clone';
 import {find, includes} from './polyfill.js';
 import CONSTANTS from './constants.json';
+import {GreedyPromise} from './utils/promise.js';
 export { default as deepAccess } from 'dlv/index.js';
 export { default as deepSetValue } from 'dset';
 
@@ -487,7 +488,7 @@ export function hasOwn(objectToCheck, propertyToCheckFor) {
 * @param {HTMLElement} [doc]
 * @param {HTMLElement} [target]
 * @param {Boolean} [asLastChildChild]
-* @return {HTMLElement}
+* @return {HTML Element}
 */
 export function insertElement(elm, doc, target, asLastChildChild) {
   doc = doc || document;
@@ -517,7 +518,7 @@ export function insertElement(elm, doc, target, asLastChildChild) {
  */
 export function waitForElementToLoad(element, timeout) {
   let timer = null;
-  return new Promise((resolve) => {
+  return new GreedyPromise((resolve) => {
     const onLoad = function() {
       element.removeEventListener('load', onLoad);
       element.removeEventListener('error', onLoad);

package/test/helpers/consentData.js

@@ -1,6 +1,7 @@
 import {gdprDataHandler} from 'src/adapterManager.js';
+import {GreedyPromise} from '../../src/utils/promise.js';
 
 export function mockGdprConsent(sandbox, getConsentData = () => null) {
-  sandbox.stub(gdprDataHandler, 'promise').get(() => Promise.resolve(getConsentData()));
+  sandbox.stub(gdprDataHandler, 'promise').get(() => GreedyPromise.resolve(getConsentData()));
   sandbox.stub(gdprDataHandler, 'getConsentData').callsFake(getConsentData)
 }

package/test/spec/auctionmanager_spec.js

@@ -21,7 +21,6 @@ import {auctionManager} from '../../src/auctionManager.js';
 import 'src/debugging.js' // some tests look for debugging side effects
 import {AuctionIndex} from '../../src/auctionIndex.js';
 import {expect} from 'chai';
-import {synchronizePromise} from '../helpers/syncPromise.js';
 
 var assert = require('assert');
 
@@ -134,7 +133,7 @@ function mockAjaxBuilder() {
 }
 
 describe('auctionmanager.js', function () {
-  let indexAuctions, indexStub, promiseSandbox;
+  let indexAuctions, indexStub
 
   before(() => {
     // hooks are global and their side effects depend on what has been loaded
@@ -150,13 +149,10 @@ describe('auctionmanager.js', function () {
     indexAuctions = [];
     indexStub = sinon.stub(auctionManager, 'index');
     indexStub.get(() => new AuctionIndex(() => indexAuctions));
-    promiseSandbox = sinon.createSandbox();
-    synchronizePromise(promiseSandbox);
   });
 
   afterEach(() => {
     indexStub.restore();
-    promiseSandbox.restore();
   });
 
   describe('getKeyValueTargetingPairs', function () {
@@ -1421,7 +1417,6 @@ describe('auctionmanager.js', function () {
       }
 
       beforeEach(() => {
-        promiseSandbox.restore();
         bids = [
           mockBid({bidderCode: BIDDER_CODE1}),
           mockBid({bidderCode: BIDDER_CODE})

package/test/spec/modules/adoceanBidAdapter_spec.js

@@ -83,6 +83,20 @@ describe('AdoceanAdapter', function () {
         'auctionId': '1d1a030790a475',
       }
     ];
+    const schainExample = {
+      'schain': {
+        ver: '1.0',
+        complete: 1,
+        nodes: [
+          {
+            asi: 'directseller.com',
+            sid: '00001!,2',
+            rid: 'BidRequest1',
+            hp: 1
+          }
+        ]
+      }
+    };
 
     const bidderRequest = {
       gdprConsent: {
@@ -134,7 +148,17 @@ describe('AdoceanAdapter', function () {
       expect(requests[0].url).to.include('aosspsizes=myaozpniqismex~300x250_300x600-myaowafpdwlrks~300x200_600x250');
       expect((requests[0].url.match(/aosspsizes=/g) || []).length).to.equal(1);
     });
-  })
+
+    it('should attach schain parameter if available', function() {
+      let requests = spec.buildRequests(bidRequests, bidderRequest);
+      expect(requests.some(e => e.url.includes('schain='))).to.be.false;
+
+      const bidsWithSchain = deepClone(bidRequests).map(e => ({...e, ...schainExample}));
+      requests = spec.buildRequests(bidsWithSchain, bidderRequest);
+      expect(requests.every(e => e.url.includes('schain=1.0,1!directseller.com,00001%21%2C2,1,BidRequest1,,,0')),
+        `One of urls does not contain valid schain param: ${requests.map(e => e.url).join('\n')}`).to.be.true;
+    });
+  });
 
   describe('interpretResponse', function () {
     const response = {

package/test/spec/modules/consentManagement_spec.js

@@ -797,25 +797,84 @@ describe('consentManagement', function () {
           expect(gdprDataHandler.ready).to.be.true;
         });
 
-        it('allows the auction when CMP is unresponsive', (done) => {
-          setConsentConfig({
-            cmpApi: 'iab',
-            timeout: 10,
-            defaultGdprScope: true
+        describe('when proper consent is not available', () => {
+          let tcfStub;
+
+          function runAuction() {
+            setConsentConfig({
+              cmpApi: 'iab',
+              timeout: 10,
+              defaultGdprScope: true
+            });
+            return new Promise((resolve, reject) => {
+              requestBidsHook(() => {
+                didHookReturn = true;
+              }, {});
+              setTimeout(() => didHookReturn ? resolve() : reject(new Error('Auction did not run')), 20);
+            })
+          }
+
+          function mockTcfEvent(tcdata) {
+            tcfStub.callsFake((api, version, cb) => {
+              if (api === 'addEventListener' && version === 2) {
+                // eslint-disable-next-line standard/no-callback-literal
+                cb(tcdata, true)
+              }
+            });
+          }
+
+          beforeEach(() => {
+            tcfStub = sinon.stub(window, '__tcfapi');
           });
 
-          requestBidsHook(() => {
-            didHookReturn = true;
-          }, {});
+          afterEach(() => {
+            tcfStub.restore();
+          })
+
+          it('should continue auction with null consent when CMP is unresponsive', () => {
+            return runAuction().then(() => {
+              const consent = gdprDataHandler.getConsentData();
+              expect(consent.gdprApplies).to.be.true;
+              expect(consent.consentString).to.be.undefined;
+              expect(gdprDataHandler.ready).to.be.true;
+            });
+          });
 
-          setTimeout(() => {
-            expect(didHookReturn).to.be.true;
-            const consent = gdprDataHandler.getConsentData();
-            expect(consent.gdprApplies).to.be.true;
-            expect(consent.consentString).to.be.undefined;
-            expect(gdprDataHandler.ready).to.be.true;
-            done();
-          }, 20);
+          it('should use consent provided by events other than tcloaded', () => {
+            mockTcfEvent({
+              eventStatus: 'cmpuishown',
+              tcString: 'mock-consent-string',
+              vendorData: {}
+            });
+            return runAuction().then(() => {
+              const consent = gdprDataHandler.getConsentData();
+              expect(consent.gdprApplies).to.be.true;
+              expect(consent.consentString).to.equal('mock-consent-string');
+              expect(consent.vendorData.vendorData).to.eql({});
+              expect(gdprDataHandler.ready).to.be.true;
+            });
+          });
+
+          Object.entries({
+            'null': null,
+            'empty': '',
+            'undefined': undefined
+          }).forEach(([t, cs]) => {
+            // some CMPs appear to reply with an empty consent string in 'cmpuishown' - make sure we don't use that
+            it(`should NOT use "default" consent if string is ${t}`, () => {
+              mockTcfEvent({
+                eventStatus: 'cmpuishown',
+                tcString: cs,
+                vendorData: {random: 'junk'}
+              });
+              return runAuction().then(() => {
+                const consent = gdprDataHandler.getConsentData();
+                expect(consent.gdprApplies).to.be.true;
+                expect(consent.consentString).to.be.undefined;
+                expect(consent.vendorData).to.be.undefined;
+              });
+            })
+          });
         });
 
         it('It still considers it a valid cmp response if gdprApplies is not a boolean', function () {

package/test/spec/modules/eids_spec.js

@@ -82,20 +82,65 @@ describe('eids array generation for known sub-modules', function() {
     });
   });
 
-  it('merkleId', function() {
+  it('merkleId (legacy) - supports single id', function() {
     const userId = {
       merkleId: {
         id: 'some-random-id-value', keyID: 1
       }
     };
     const newEids = createEidsArray(userId);
+
     expect(newEids.length).to.equal(1);
     expect(newEids[0]).to.deep.equal({
       source: 'merkleinc.com',
+      uids: [{
+        id: 'some-random-id-value',
+        atype: 3,
+        ext: { keyID: 1 }
+      }]
+    });
+  });
+
+  it('merkleId supports multiple source providers', function() {
+    const userId = {
+      merkleId: [{
+        id: 'some-random-id-value', ext: { enc: 1, keyID: 16, idName: 'pamId', ssp: 'ssp1' }
+      }, {
+        id: 'another-random-id-value',
+        ext: {
+          enc: 1,
+          idName: 'pamId',
+          third: 4,
+          ssp: 'ssp2'
+        }
+      }]
+    }
+
+    const newEids = createEidsArray(userId);
+    expect(newEids.length).to.equal(2);
+    expect(newEids[0]).to.deep.equal({
+      source: 'ssp1.merkleinc.com',
       uids: [{id: 'some-random-id-value',
         atype: 3,
-        ext: { keyID: 1
-        }}]
+        ext: {
+          enc: 1,
+          keyID: 16,
+          idName: 'pamId',
+          ssp: 'ssp1'
+        }
+      }]
+    });
+    expect(newEids[1]).to.deep.equal({
+      source: 'ssp2.merkleinc.com',
+      uids: [{id: 'another-random-id-value',
+        atype: 3,
+        ext: {
+          third: 4,
+          enc: 1,
+          idName: 'pamId',
+          ssp: 'ssp2'
+        }
+      }]
     });
   });