prebid.js 6.2.0 → 6.6.0

package/src/utils.js

@@ -482,16 +482,43 @@ export function insertElement(elm, doc, target, asLastChildChild) {
   } catch (e) {}
 }
 
+/**
+ * Returns a promise that completes when the given element triggers a 'load' or 'error' DOM event, or when
+ * `timeout` milliseconds have elapsed.
+ *
+ * @param {HTMLElement} element
+ * @param {Number} [timeout]
+ * @returns {Promise}
+ */
+export function waitForElementToLoad(element, timeout) {
+  let timer = null;
+  return new Promise((resolve) => {
+    const onLoad = function() {
+      element.removeEventListener('load', onLoad);
+      element.removeEventListener('error', onLoad);
+      if (timer != null) {
+        window.clearTimeout(timer);
+      }
+      resolve();
+    };
+    element.addEventListener('load', onLoad);
+    element.addEventListener('error', onLoad);
+    if (timeout != null) {
+      timer = window.setTimeout(onLoad, timeout);
+    }
+  });
+}
+
 /**
  * Inserts an image pixel with the specified `url` for cookie sync
  * @param {string} url URL string of the image pixel to load
  * @param  {function} [done] an optional exit callback, used when this usersync pixel is added during an async process
+ * @param  {Number} [timeout] an optional timeout in milliseconds for the image to load before calling `done`
  */
-export function triggerPixel(url, done) {
+export function triggerPixel(url, done, timeout) {
   const img = new Image();
   if (done && internal.isFn(done)) {
-    img.addEventListener('load', done);
-    img.addEventListener('error', done);
+    waitForElementToLoad(img, timeout).then(done);
   }
   img.src = url;
 }
@@ -539,18 +566,18 @@ export function insertHtmlIntoIframe(htmlCode) {
  * @param  {string} url URL to be requested
  * @param  {string} encodeUri boolean if URL should be encoded before inserted. Defaults to true
  * @param  {function} [done] an optional exit callback, used when this usersync pixel is added during an async process
+ * @param  {Number} [timeout] an optional timeout in milliseconds for the iframe to load before calling `done`
  */
-export function insertUserSyncIframe(url, done) {
+export function insertUserSyncIframe(url, done, timeout) {
   let iframeHtml = internal.createTrackPixelIframeHtml(url, false, 'allow-scripts allow-same-origin');
   let div = document.createElement('div');
   div.innerHTML = iframeHtml;
   let iframe = div.firstChild;
   if (done && internal.isFn(done)) {
-    iframe.addEventListener('load', done);
-    iframe.addEventListener('error', done);
+    waitForElementToLoad(iframe, timeout).then(done);
   }
   internal.insertElement(iframe, document, 'html', true);
-};
+}
 
 /**
  * Creates a snippet of HTML that retrieves the specified `url`
@@ -1245,7 +1272,18 @@ export function mergeDeep(target, ...sources) {
         if (!target[key]) {
           Object.assign(target, { [key]: source[key] });
         } else if (isArray(target[key])) {
-          target[key] = target[key].concat(source[key]);
+          source[key].forEach(obj => {
+            let addItFlag = 1;
+            for (let i = 0; i < target[key].length; i++) {
+              if (deepEqual(target[key][i], obj)) {
+                addItFlag = 0;
+                break;
+              }
+            }
+            if (addItFlag) {
+              target[key].push(obj);
+            }
+          });
         }
       } else {
         Object.assign(target, { [key]: source[key] });

package/test/helpers/prebidGlobal.js

@@ -1,3 +1,4 @@
 window.$$PREBID_GLOBAL$$ = (window.$$PREBID_GLOBAL$$ || {});
+window.$$PREBID_GLOBAL$$.installedModules = (window.$$PREBID_GLOBAL$$.installedModules || []);
 window.$$PREBID_GLOBAL$$.cmd = window.$$PREBID_GLOBAL$$.cmd || [];
 window.$$PREBID_GLOBAL$$.que = window.$$PREBID_GLOBAL$$.que || [];

package/test/spec/config_spec.js

@@ -7,8 +7,10 @@ const utils = require('src/utils');
 let getConfig;
 let setConfig;
 let readConfig;
+let mergeConfig;
 let getBidderConfig;
 let setBidderConfig;
+let mergeBidderConfig;
 let setDefaults;
 
 describe('config API', function () {
@@ -19,8 +21,10 @@ describe('config API', function () {
     getConfig = config.getConfig;
     setConfig = config.setConfig;
     readConfig = config.readConfig;
+    mergeConfig = config.mergeConfig;
     getBidderConfig = config.getBidderConfig;
     setBidderConfig = config.setBidderConfig;
+    mergeBidderConfig = config.mergeBidderConfig;
     setDefaults = config.setDefaults;
     logErrorSpy = sinon.spy(utils, 'logError');
     logWarnSpy = sinon.spy(utils, 'logWarn');
@@ -345,4 +349,279 @@ describe('config API', function () {
     const warning = 'Auction Options given an incorrect param: testing';
     assert.ok(logWarnSpy.calledWith(warning), 'expected warning was logged');
   });
+
+  it('should merge input with existing global config', function () {
+    const obj = {
+      ortb2: {
+        site: {
+          name: 'example',
+          domain: 'page.example.com',
+          cat: ['IAB2'],
+          sectioncat: ['IAB2-2'],
+          pagecat: ['IAB2-2']
+        }
+      }
+    };
+    setConfig({ ortb2: {
+      user: {
+        ext: {
+          data: {
+            registered: true,
+            interests: ['cars']
+          }
+        }
+      }
+    }
+    });
+    mergeConfig(obj);
+    const expected = {
+      site: {
+        name: 'example',
+        domain: 'page.example.com',
+        cat: ['IAB2'],
+        sectioncat: ['IAB2-2'],
+        pagecat: ['IAB2-2']
+      },
+      user: {
+        ext: {
+          data: {
+            registered: true,
+            interests: ['cars']
+          }
+        }
+      }
+    }
+    expect(getConfig('ortb2')).to.deep.equal(expected);
+  });
+
+  it('input should take precedence over existing config if keys are the same', function() {
+    const input = {
+      ortb2: {
+        user: {
+          ext: {
+            data: {
+              registered: true,
+              interests: ['cars']
+            }
+          }
+        }
+      }
+    }
+    setConfig({ ortb2: {
+      user: {
+        ext: {
+          data: {
+            registered: false
+          }
+        }
+      }
+    }});
+    mergeConfig(input);
+    const expected = {
+      user: {
+        ext: {
+          data: {
+            registered: true,
+            interests: ['cars']
+          }
+        }
+      }
+    }
+    expect(getConfig('ortb2')).to.deep.equal(expected);
+  });
+
+  it('should log error for a non-object value passed in', function () {
+    mergeConfig('invalid object');
+    expect(logErrorSpy.calledOnce).to.equal(true);
+    const error = 'mergeConfig input must be an object';
+    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+  });
+
+  it('should merge input with existing bidder config', function () {
+    const input = {
+      bidders: ['rubicon', 'appnexus'],
+      config: {
+        ortb2: {
+          site: {
+            name: 'example',
+            domain: 'page.example.com',
+            cat: ['IAB2'],
+            sectioncat: ['IAB2-2'],
+            pagecat: ['IAB2-2']
+          },
+          user: {
+            ext: {
+              ssp: 'magnite',
+              data: {
+                registered: false,
+                interests: ['sports']
+              }
+            }
+          }
+        }
+      }
+    };
+    setBidderConfig({
+      bidders: ['rubicon'],
+      config: {
+        ortb2: {
+          user: {
+            ext: {
+              data: {
+                registered: true,
+                interests: ['cars']
+              }
+            }
+          }
+        }
+      }
+    });
+    mergeBidderConfig(input);
+    const expected = {
+      rubicon: {
+        ortb2: {
+          site: {
+            name: 'example',
+            domain: 'page.example.com',
+            cat: ['IAB2'],
+            sectioncat: ['IAB2-2'],
+            pagecat: ['IAB2-2']
+          },
+          user: {
+            ext: {
+              ssp: 'magnite',
+              data: {
+                registered: false,
+                interests: ['cars', 'sports']
+              }
+            }
+          }
+        }
+      },
+      appnexus: {
+        ortb2: {
+          site: {
+            name: 'example',
+            domain: 'page.example.com',
+            cat: ['IAB2'],
+            sectioncat: ['IAB2-2'],
+            pagecat: ['IAB2-2']
+          },
+          user: {
+            ext: {
+              ssp: 'magnite',
+              data: {
+                registered: false,
+                interests: ['sports']
+              }
+            }
+          }
+        }
+      }
+    }
+    expect(getBidderConfig()).to.deep.equal(expected);
+  });
+
+  it('should log error for a non-object value passed in', function () {
+    mergeBidderConfig('invalid object');
+    expect(logErrorSpy.calledOnce).to.equal(true);
+    const error = 'setBidderConfig bidder options must be an object';
+    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+  });
+
+  it('should log error for empty bidders array', function () {
+    mergeBidderConfig({
+      bidders: [],
+      config: {
+        ortb2: {
+          site: {
+            name: 'example',
+            domain: 'page.example.com',
+            cat: ['IAB2'],
+            sectioncat: ['IAB2-2'],
+            pagecat: ['IAB2-2']
+          }
+        }
+      }
+    });
+    expect(logErrorSpy.calledOnce).to.equal(true);
+    const error = 'setBidderConfig bidder options must contain a bidders list with at least 1 bidder';
+    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+  });
+
+  it('should log error for nonexistent config object', function () {
+    mergeBidderConfig({
+      bidders: ['appnexus']
+    });
+    expect(logErrorSpy.calledOnce).to.equal(true);
+    const error = 'setBidderConfig bidder options must contain a config object';
+    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+  });
+
+  it('should merge without array duplication', function() {
+    const userObj1 = {
+      name: 'www.dataprovider1.com',
+      ext: { taxonomyname: 'iab_audience_taxonomy' },
+      segment: [{
+        id: '1776'
+      }]
+    };
+
+    const userObj2 = {
+      name: 'www.dataprovider2.com',
+      ext: { taxonomyname: 'iab_audience_taxonomy' },
+      segment: [{
+        id: '1914'
+      }]
+    };
+
+    const siteObj1 = {
+      name: 'www.dataprovider3.com',
+      ext: {
+        taxonomyname: 'iab_audience_taxonomy'
+      },
+      segment: [
+        {
+          id: '1812'
+        },
+        {
+          id: '1955'
+        }
+      ]
+    }
+
+    setConfig({
+      ortb2: {
+        user: {
+          data: [userObj1, userObj2]
+        },
+        site: {
+          content: {
+            data: [siteObj1]
+          }
+        }
+      }
+    });
+
+    const rtd = {
+      ortb2: {
+        user: {
+          data: [userObj1]
+        },
+        site: {
+          content: {
+            data: [siteObj1]
+          }
+        }
+      }
+    };
+    mergeConfig(rtd);
+
+    let ortb2Config = getConfig('ortb2');
+
+    expect(ortb2Config.user.data).to.deep.include.members([userObj1, userObj2]);
+    expect(ortb2Config.site.content.data).to.deep.include.members([siteObj1]);
+    expect(ortb2Config.user.data).to.have.lengthOf(2);
+    expect(ortb2Config.site.content.data).to.have.lengthOf(1);
+  });
 });