prebid.js 7.26.0 → 7.28.0

package/test/spec/ortb2.5StrictTranslator/spec_spec.js

@@ -0,0 +1,358 @@
+import {BidRequest} from '../../../libraries/ortb2.5StrictTranslator/spec.js';
+
+// sample requests taken from ORTB 2.5 spec: https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf
+const SAMPLE_REQUESTS = [
+  {
+    'id': '80ce30c53c16e6ede735f123ef6e32361bfc7b22',
+    'at': 1,
+    'cur': ['USD'],
+    'imp': [
+      {
+        'id': '1',
+        'bidfloor': 0.03,
+        'banner': {
+          'h': 250, 'w': 300, 'pos': 0
+        }
+      }
+    ],
+    'site': {
+      'id': '102855',
+      'cat': ['IAB3-1'],
+      'domain': 'www.foobar.com',
+      'page': 'http://www.foobar.com/1234.html ',
+      'publisher': {
+        'id': '8953',
+        'name': 'foobar.com',
+        'cat': ['IAB3-1'],
+        'domain': 'foobar.com'
+      }
+    },
+    'device': {
+      'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13 (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2',
+      'ip': '123.145.167.10'
+    },
+    'user': {
+      'id': '55816b39711f9b5acf3b90e313ed29e51665623f'
+    }
+  },
+  {
+    'id': '123456789316e6ede735f123ef6e32361bfc7b22',
+    'at': 2,
+    'cur': ['USD'],
+    'imp': [
+      {
+        'id': '1',
+        'bidfloor': 0.03,
+        'iframebuster': ['vendor1.com', 'vendor2.com'],
+        'banner': {
+          'h': 250,
+          'w': 300,
+          'pos': 0,
+          'battr': [13],
+          'expdir': [2, 4]
+        }
+      }
+    ],
+    'site': {
+      'id': '102855',
+      'cat': ['IAB3-1'],
+      'domain': 'www.foobar.com',
+      'page': 'http://www.foobar.com/1234.html',
+      'publisher': {
+        'id': '8953',
+        'name': 'foobar.com',
+        'cat': ['IAB3-1'],
+        'domain': 'foobar.com'
+      }
+    },
+    'device': {
+      'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13 (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2',
+      'ip': '123.145.167.10'
+    },
+    'user': {
+      'id': '55816b39711f9b5acf3b90e313ed29e51665623f',
+      'buyeruid': '545678765467876567898765678987654',
+      'data': [
+        {
+          'id': '6',
+          'name': 'Data Provider 1',
+          'segment': [
+            {
+              'id': '12341318394918', 'name': 'auto intenders'
+            },
+            {
+              'id': '1234131839491234', 'name': 'auto enthusiasts'
+            },
+            {
+              'id': '23423424',
+              'name': 'data-provider1-age',
+              'value': '30-40'
+            }
+          ]
+        }
+      ]
+    }
+  },
+  {
+    'id': 'IxexyLDIIk',
+    'at': 2,
+    'bcat': ['IAB25', 'IAB7-39', 'IAB8-18', 'IAB8-5', 'IAB9-9'],
+    'badv': ['apple.com', 'go-text.me', 'heywire.com'],
+    'imp': [
+      {
+        'id': '1',
+        'bidfloor': 0.5,
+        'instl': 0,
+        'tagid': 'agltb3B1Yi1pbmNyDQsSBFNpdGUY7fD0FAw',
+        'banner': {
+          'w': 728,
+          'h': 90,
+          'pos': 1,
+          'btype': [4],
+          'battr': [14],
+          'api': [3]
+        }
+      }
+    ],
+    'app': {
+      'id': 'agltb3B1Yi1pbmNyDAsSA0FwcBiJkfIUDA',
+      'name': 'Yahoo Weather',
+      'cat': ['IAB15', 'IAB15-10'],
+      'ver': '1.0.2',
+      'bundle': '12345',
+      'storeurl': 'https://itunes.apple.com/id628677149',
+      'publisher': {
+        'id': 'agltb3B1Yi1pbmNyDAsSA0FwcBiJkfTUCV',
+        'name': 'yahoo',
+        'domain': 'www.yahoo.com'
+      }
+    },
+    'device': {
+      'dnt': 0,
+      'ua': 'Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9A334 Safari/7534.48.3',
+      'ip': '123.145.167.189',
+      'ifa': 'AA000DFE74168477C70D291f574D344790E0BB11',
+      'carrier': 'VERIZON',
+      'language': 'en',
+      'make': 'Apple',
+      'model': 'iPhone',
+      'os': 'iOS',
+      'osv': '6.1',
+      'js': 1,
+      'connectiontype': 3,
+      'devicetype': 1,
+      'geo': {
+        'lat': 35.012345,
+        'lon': -115.12345,
+        'country': 'USA',
+        'metro': '803',
+        'region': 'CA',
+        'city': 'Los Angeles',
+        'zip': '90049'
+      }
+    },
+    'user': {
+      'id': 'ffffffd5135596709273b3a1a07e466ea2bf4fff',
+      'yob': 1984,
+      'gender': 'M'
+    }
+  },
+  {
+    'id': '1234567893',
+    'at': 2,
+    'tmax': 120,
+    'imp': [
+      {
+        'id': '1',
+        'bidfloor': 0.03,
+        'video': {
+          'w': 640,
+          'h': 480,
+          'pos': 1,
+          'startdelay': 0,
+          'minduration': 5,
+          'maxduration': 30,
+          'maxextended': 30,
+          'minbitrate': 300,
+          'maxbitrate': 1500,
+          'api': [1, 2],
+          'protocols': [2, 3],
+          'mimes': [
+            'video/x-flv',
+            'video/mp4',
+            'application/x-shockwave-flash',
+            'application/javascript'
+          ],
+          'linearity': 1,
+          'boxingallowed': 1,
+          'playbackmethod': [1, 3],
+          'delivery': [2],
+          'battr': [13, 14],
+          'companionad': [
+            {
+              'id': '1234567893-1',
+              'w': 300,
+              'h': 250,
+              'pos': 1,
+              'battr': [13, 14],
+              'expdir': [2, 4]
+            },
+            {
+              'id': '1234567893-2',
+              'w': 728,
+              'h': 90,
+              'pos': 1,
+              'battr': [13, 14]
+            }
+          ],
+          'companiontype': [1, 2]
+        }
+      }
+    ],
+    'site': {
+      'id': '1345135123',
+      'name': 'Site ABCD',
+      'domain': 'siteabcd.com',
+      'cat': ['IAB2-1', 'IAB2-2'],
+      'page': 'http://siteabcd.com/page.htm',
+      'ref': 'http://referringsite.com/referringpage.htm',
+      'privacypolicy': 1,
+      'publisher': {
+        'id': 'pub12345', 'name': 'Publisher A'
+      },
+      'content': {
+        'id': '1234567',
+        'series': 'All About Cars',
+        'season': '2',
+        'episode': 23,
+        'title': 'Car Show',
+        'cat': ['IAB2-2'],
+        'keywords': 'keyword-a,keyword-b,keyword-c'
+      }
+    },
+    'device': {
+      'ip': '64.124.253.1',
+      'ua': 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.16) Gecko/20110319 Firefox/3.6.16',
+      'os': 'OS X',
+      'flashver': '10.1',
+      'js': 1
+    },
+    'user': {
+      'id': '456789876567897654678987656789',
+      'buyeruid': '545678765467876567898765678987654',
+      'data': [
+        {
+          'id': '6',
+          'name': 'Data Provider 1',
+          'segment': [
+            {
+              'id': '12341318394918', 'name': 'auto intenders'
+            },
+            {
+              'id': '1234131839491234', 'name': 'auto enthusiasts'
+            }
+          ]
+        }
+      ]
+    }
+  },
+  {
+    'id': '80ce30c53c16e6ede735f123ef6e32361bfc7b22',
+    'at': 1,
+    'cur': ['USD'],
+    'imp': [
+      {
+        'id': '1',
+        'bidfloor': 0.03,
+        'banner': {
+          'h': 250, 'w': 300, 'pos': 0
+        },
+        'pmp': {
+          'private_auction': 1,
+          'deals': [
+            {
+              'id': 'AB-Agency1-0001',
+              'at': 1,
+              'bidfloor': 2.5,
+              'wseat': ['Agency1']
+            },
+            {
+              'id': 'XY-Agency2-0001',
+              'at': 2,
+              'bidfloor': 2,
+              'wseat': ['Agency2']
+            }
+          ]
+        }
+      }
+    ],
+    'site': {
+      'id': '102855',
+      'domain': 'www.foobar.com',
+      'cat': ['IAB3-1'],
+      'page': 'http://www.foobar.com/1234.html',
+      'publisher': {
+        'id': '8953',
+        'name': 'foobar.com',
+        'cat': ['IAB3-1'],
+        'domain': 'foobar.com'
+      }
+    },
+    'device': {
+      'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13 (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2',
+      'ip': '123.145.167.10'
+    },
+    'user': {
+      'id': '55816b39711f9b5acf3b90e313ed29e51665623f'
+    }
+  },
+];
+
+if (FEATURES.NATIVE) {
+  SAMPLE_REQUESTS.push({
+    'id': '80ce30c53c16e6ede735f123ef6e32361bfc7b22',
+    'at': 1,
+    'cur': ['USD'],
+    'imp': [
+      {
+        'id': '1',
+        'bidfloor': 0.03,
+        'native': {
+          'request': '{"native":{"ver":"1.0","assets":[ ... ]}}',
+          'ver': '1.0',
+          'api': [3],
+          'battr': [13, 14]
+        }
+      }
+    ],
+    'site': {
+      'id': '102855',
+      'cat': ['IAB3-1'],
+      'domain': 'www.foobar.com',
+      'page': 'http://www.foobar.com/1234.html ',
+      'publisher': {
+        'id': '8953',
+        'name': 'foobar.com',
+        'cat': ['IAB3-1'],
+        'domain': 'foobar.com'
+      }
+    },
+    'device': {
+      'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13 (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2',
+      'ip': '123.145.167.10'
+    },
+    'user': {
+      'id': '55816b39711f9b5acf3b90e313ed29e51665623f'
+    }
+  });
+}
+
+describe('BidRequest spec', () => {
+  SAMPLE_REQUESTS.forEach((req, i) => {
+    it(`accepts sample #${i}`, () => {
+      const onError = sinon.stub();
+      BidRequest(null, null, null, req, onError);
+      sinon.assert.notCalled(onError);
+    });
+  });
+});

package/test/spec/ortb2.5StrictTranslator/translator_spec.js

@@ -0,0 +1,16 @@
+import {toOrtb25Strict} from '../../../libraries/ortb2.5StrictTranslator/translator.js';
+
+describe('toOrtb25Strict', () => {
+  let translator;
+  beforeEach(() => {
+    translator = sinon.stub().callsFake((o) => o);
+  })
+  it('uses provided translator', () => {
+    translator.reset();
+    translator.callsFake(() => ({id: 'test'}));
+    expect(toOrtb25Strict(null, translator)).to.eql({id: 'test'});
+  });
+  it('removes fields out of spec', () => {
+    expect(toOrtb25Strict({unk: 'field', imp: ['err', {}]}, translator)).to.eql({imp: [{}]});
+  });
+});

package/test/spec/ortb2.5Translator/translator_spec.js

@@ -0,0 +1,64 @@
+import {EXT_PROMOTIONS, moveRule, splitPath, toOrtb25} from '../../../libraries/ortb2.5Translator/translator.js';
+import {deepAccess, deepClone, deepSetValue} from '../../../src/utils.js';
+
+describe('ORTB 2.5 translation', () => {
+  describe('moveRule', () => {
+    const rule = moveRule('f1.f2.f3', (prefix, field) => `${prefix}.m1.m2.${field}`);
+
+    function applyRule(rule, obj, del = true) {
+      obj = deepClone(obj);
+      const deleter = rule(obj);
+      if (typeof deleter === 'function' && del) {
+        deleter();
+      }
+      return obj;
+    }
+
+    it('returns undef when field is not present', () => {
+      expect(rule({})).to.eql(undefined);
+    });
+    it('can copy field', () => {
+      expect(applyRule(rule, {f1: {f2: {f3: 'value'}}}, false)).to.eql({
+        f1: {
+          f2: {
+            f3: 'value',
+            m1: {m2: {f3: 'value'}}
+          }
+        }
+      });
+    });
+    it('can move field', () => {
+      expect(applyRule(rule, {f1: {f2: {f3: 'value'}}}, true)).to.eql({f1: {f2: {m1: {m2: {f3: 'value'}}}}});
+    });
+  });
+  describe('toOrtb25', () => {
+    EXT_PROMOTIONS.forEach(path => {
+      const newPath = (() => {
+        const [prefix, field] = splitPath(path);
+        return `${prefix}.ext.${field}`;
+      })();
+
+      it(`moves ${path} to ${newPath}`, () => {
+        const obj = {};
+        deepSetValue(obj, path, 'val');
+        toOrtb25(obj);
+        expect(deepAccess(obj, path)).to.eql(undefined);
+        expect(deepAccess(obj, newPath)).to.eql('val');
+      });
+    });
+    it('moves kwarray into keywords', () => {
+      expect(toOrtb25({app: {keywords: 'k1,k2', kwarray: ['ka1', 'ka2']}})).to.eql({app: {keywords: 'k1,k2,ka1,ka2'}});
+    });
+    it('does not choke if kwarray is not an array', () => {
+      expect(toOrtb25({site: {keywords: 'k1,k2', kwarray: 'err'}})).to.eql({site: {keywords: 'k1,k2'}});
+    });
+    it('does not choke if keywords is not a string', () => {
+      expect(toOrtb25({user: {keywords: {}, kwarray: ['ka1', 'ka2']}})).to.eql({
+        user: {
+          keywords: {},
+          kwarray: ['ka1', 'ka2']
+        }
+      });
+    });
+  });
+});

package/test/spec/refererDetection_spec.js

@@ -2,94 +2,7 @@ import {detectReferer, ensureProtocol, parseDomain} from 'src/refererDetection.j
 import {config} from 'src/config.js';
 import {expect} from 'chai';
 
-/**
- * Build a walkable linked list of window-like objects for testing.
- *
- * @param {Array} urls Array of URL strings starting from the top window.
- * @param {string} [topReferrer]
- * @param {string} [canonicalUrl]
- * @param {boolean} [ancestorOrigins]
- * @returns {Object}
- */
-function buildWindowTree(urls, topReferrer = null, canonicalUrl = null, ancestorOrigins = false) {
-  /**
-   * Find the origin from a given fully-qualified URL.
-   *
-   * @param {string} url The fully qualified URL
-   * @returns {string|null}
-   */
-  function getOrigin(url) {
-    const originRegex = new RegExp('^(https?://[^/]+/?)');
-
-    const result = originRegex.exec(url);
-
-    if (result && result[0]) {
-      return result[0];
-    }
-
-    return null;
-  }
-
-  const inaccessibles = [];
-
-  let previousWindow, topWindow;
-  const topOrigin = getOrigin(urls[0]);
-
-  const windowList = urls.map((url, index) => {
-    const thisOrigin = getOrigin(url),
-      sameOriginAsPrevious = index === 0 ? true : (getOrigin(urls[index - 1]) === thisOrigin),
-      sameOriginAsTop = thisOrigin === topOrigin;
-
-    const win = {
-      location: {
-        href: url,
-      },
-      document: {
-        referrer: index === 0 ? topReferrer : urls[index - 1]
-      }
-    };
-
-    if (topWindow == null) {
-      topWindow = win;
-      win.document.querySelector = function (selector) {
-        if (selector === 'link[rel=\'canonical\']') {
-          return {
-            href: canonicalUrl
-          };
-        }
-        return null;
-      };
-    }
-
-    if (sameOriginAsPrevious) {
-      win.parent = previousWindow;
-    } else {
-      win.parent = inaccessibles[inaccessibles.length - 1];
-    }
-    if (ancestorOrigins) {
-      win.location.ancestorOrigins = urls.slice(0, index).reverse().map(getOrigin);
-    }
-    win.top = sameOriginAsTop ? topWindow : inaccessibles[0];
-
-    const inWin = {parent: inaccessibles[inaccessibles.length - 1], top: inaccessibles[0]};
-    if (index === 0) {
-      inWin.top = inWin;
-    }
-    ['document', 'location'].forEach((prop) => {
-      Object.defineProperty(inWin, prop, {
-        get: function () {
-          throw new Error('cross-origin access');
-        }
-      });
-    });
-    inaccessibles.push(inWin);
-    previousWindow = win;
-
-    return win;
-  });
-
-  return windowList[windowList.length - 1];
-}
+import { buildWindowTree } from '../helpers/refererDetectionHelper';
 
 describe('Referer detection', () => {
   afterEach(function () {
@@ -128,11 +41,49 @@ describe('Referer detection', () => {
           numIframes: 0,
           stack: ['https://example.com/some/page'],
           canonicalUrl: 'https://example.com/canonical/page',
-          page: 'https://example.com/canonical/page',
+          page: 'https://example.com/some/page',
           ref: 'https://othersite.com/',
           domain: 'example.com'
         });
       });
+
+      it('Should set page and canonical to pageUrl value set in config if present, even if canonical url is also present in head', () => {
+        config.setConfig({'pageUrl': 'https://www.set-from-config.com/path'});
+        const testWindow = buildWindowTree(['https://example.com/some/page'], 'https://othersite.com/', 'https://example.com/canonical/page'),
+          result = detectReferer(testWindow)();
+
+        sinon.assert.match(result, {
+          topmostLocation: 'https://example.com/some/page',
+          location: 'https://example.com/some/page',
+          reachedTop: true,
+          isAmp: false,
+          numIframes: 0,
+          stack: ['https://example.com/some/page'],
+          canonicalUrl: 'https://www.set-from-config.com/path',
+          page: 'https://www.set-from-config.com/path',
+          ref: 'https://othersite.com/',
+          domain: 'www.set-from-config.com'
+        });
+      });
+
+      it('Should set page with query params if canonical url is present without query params but the current page does have them', () => {
+        config.setConfig({'pageUrl': 'https://www.set-from-config.com/path'});
+        const testWindow = buildWindowTree(['https://example.com/some/page?query1=123&query2=456'], 'https://othersite.com/', 'https://example.com/canonical/page'),
+          result = detectReferer(testWindow)();
+
+        sinon.assert.match(result, {
+          topmostLocation: 'https://example.com/some/page?query1=123&query2=456',
+          location: 'https://example.com/some/page?query1=123&query2=456',
+          reachedTop: true,
+          isAmp: false,
+          numIframes: 0,
+          stack: ['https://example.com/some/page?query1=123&query2=456'],
+          canonicalUrl: 'https://www.set-from-config.com/path',
+          page: 'https://www.set-from-config.com/path?query1=123&query2=456',
+          ref: 'https://othersite.com/',
+          domain: 'www.set-from-config.com'
+        });
+      });
     });
 
     describe('Friendly iframes', () => {
@@ -174,7 +125,7 @@ describe('Referer detection', () => {
             'https://example.com/third/page'
           ],
           canonicalUrl: 'https://example.com/canonical/page',
-          page: 'https://example.com/canonical/page',
+          page: 'https://example.com/some/page',
           ref: 'https://othersite.com/',
           domain: 'example.com'
         });
@@ -317,7 +268,7 @@ describe('Referer detection', () => {
           'https://ad-iframe.ampproject.org/ad'
         ],
         canonicalUrl: 'https://example.com/some/page/',
-        page: 'https://example.com/some/page/',
+        page: 'https://example.com/some/page/amp/',
         ref: null,
         domain: 'example.com'
       });
@@ -344,7 +295,7 @@ describe('Referer detection', () => {
           'https://ad-iframe.ampproject.org/ad'
         ],
         canonicalUrl: 'https://example.com/some/page/',
-        page: 'https://example.com/some/page/',
+        page: 'https://example.com/some/page/amp/',
         ref: null,
         domain: 'example.com'
       });
@@ -384,7 +335,7 @@ describe('Referer detection', () => {
             'https://ad-iframe.ampproject.org/ad'
           ],
           canonicalUrl: 'https://example.com/some/page/',
-          page: 'https://example.com/some/page/',
+          page: 'https://example.com/some/page/amp/',
           ref: null,
           domain: 'example.com',
         });
@@ -412,7 +363,7 @@ describe('Referer detection', () => {
             'https://ad-iframe.ampproject.org/ad'
           ],
           canonicalUrl: 'https://example.com/some/page/',
-          page: 'https://example.com/some/page/',
+          page: 'https://example.com/some/page/amp/',
           ref: null,
           domain: 'example.com'
         });
@@ -441,7 +392,7 @@ describe('Referer detection', () => {
             'https://ad-iframe.ampproject.org/ad'
           ],
           canonicalUrl: 'https://example.com/some/page/',
-          page: 'https://example.com/some/page/',
+          page: 'https://example.com/some/page/amp/',
           ref: null,
           domain: 'example.com',
         });

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

@@ -8,6 +8,7 @@ import {
 import { config } from 'src/config.js';
 import * as utils from 'src/utils.js';
 import {hook} from '../../../../src/hook.js';
+import {VENDORLESS_GVLID} from '../../../../src/consentHandler.js';
 
 describe('storage manager', function() {
   before(() => {
@@ -73,7 +74,7 @@ describe('storage manager', function() {
 
     it('should respect (vendorless) consent enforcement', () => {
       storage.localStorageIsEnabled();
-      expect(validateHook.args[0][1]).to.eql(true); // isVendorless should be set to true
+      expect(validateHook.args[0][1]).to.equal(VENDORLESS_GVLID); // gvlid should be set to VENDORLESS_GVLID
     });
 
     it('should respect the deviceAccess flag', () => {