prebid.js 9.53.3 → 9.53.4

package/modules/timeoutRtdProvider.js

@@ -2,6 +2,7 @@ import { submodule } from '../src/hook.js';
 import * as ajax from '../src/ajax.js';
 import { logInfo, deepAccess, logError } from '../src/utils.js';
 import { getGlobal } from '../src/prebidGlobal.js';
+import { bidderTimeoutFunctions } from '../libraries/bidderTimeoutUtils/bidderTimeoutUtils.js';
 
 /**
  * @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
@@ -11,113 +12,9 @@ const SUBMODULE_NAME = 'timeout';
 
 // this allows the stubbing of functions during testing
 export const timeoutRtdFunctions = {
-  getDeviceType,
-  getConnectionSpeed,
-  checkVideo,
-  calculateTimeoutModifier,
   handleTimeoutIncrement
 };
 
-const entries = Object.entries || function(obj) {
-  const ownProps = Object.keys(obj);
-  let i = ownProps.length;
-  let resArray = new Array(i);
-  while (i--) { resArray[i] = [ownProps[i], obj[ownProps[i]]]; }
-  return resArray;
-};
-
-function getDeviceType() {
-  const userAgent = window.navigator.userAgent.toLowerCase();
-  if ((/ipad|android 3.0|xoom|sch-i800|playbook|tablet|kindle/i.test(userAgent))) {
-    return 5; // tablet
-  }
-  if ((/iphone|ipod|android|blackberry|opera|mini|windows\sce|palm|smartphone|iemobile/i.test(userAgent))) {
-    return 4; // mobile
-  }
-  return 2; // personal computer
-}
-
-function checkVideo(adUnits) {
-  return adUnits.some((adUnit) => {
-    return adUnit.mediaTypes && adUnit.mediaTypes.video;
-  });
-}
-
-function getConnectionSpeed() {
-  const connection = window.navigator.connection || window.navigator.mozConnection || window.navigator.webkitConnection || {}
-  const connectionType = connection.type || connection.effectiveType;
-
-  switch (connectionType) {
-    case 'slow-2g':
-    case '2g':
-      return 'slow';
-
-    case '3g':
-      return 'medium';
-
-    case 'bluetooth':
-    case 'cellular':
-    case 'ethernet':
-    case 'wifi':
-    case 'wimax':
-    case '4g':
-      return 'fast';
-  }
-
-  return 'unknown';
-}
-/**
- * Calculate the time to be added to the timeout
- * @param {Array} adUnits
- * @param {Object} rules
- * @return {number}
- */
-function calculateTimeoutModifier(adUnits, rules) {
-  logInfo('Timeout rules', rules);
-  let timeoutModifier = 0;
-  let toAdd = 0;
-
-  if (rules.includesVideo) {
-    const hasVideo = timeoutRtdFunctions.checkVideo(adUnits);
-    toAdd = rules.includesVideo[hasVideo] || 0;
-    logInfo(`Adding ${toAdd} to timeout for includesVideo ${hasVideo}`)
-    timeoutModifier += toAdd;
-  }
-
-  if (rules.numAdUnits) {
-    const numAdUnits = adUnits.length;
-    if (rules.numAdUnits[numAdUnits]) {
-      timeoutModifier += rules.numAdUnits[numAdUnits];
-    } else {
-      for (const [rangeStr, timeoutVal] of entries(rules.numAdUnits)) {
-        const [lowerBound, upperBound] = rangeStr.split('-');
-        if (parseInt(lowerBound) <= numAdUnits && numAdUnits <= parseInt(upperBound)) {
-          logInfo(`Adding ${timeoutVal} to timeout for numAdUnits ${numAdUnits}`)
-          timeoutModifier += timeoutVal;
-          break;
-        }
-      }
-    }
-  }
-
-  if (rules.deviceType) {
-    const deviceType = timeoutRtdFunctions.getDeviceType();
-    toAdd = rules.deviceType[deviceType] || 0;
-    logInfo(`Adding ${toAdd} to timeout for deviceType ${deviceType}`)
-    timeoutModifier += toAdd;
-  }
-
-  if (rules.connectionSpeed) {
-    const connectionSpeed = timeoutRtdFunctions.getConnectionSpeed();
-    toAdd = rules.connectionSpeed[connectionSpeed] || 0;
-    logInfo(`Adding ${toAdd} to timeout for connectionSpeed ${connectionSpeed}`)
-    timeoutModifier += toAdd;
-  }
-
-  logInfo('timeout Modifier calculated', timeoutModifier);
-  return timeoutModifier;
-}
-
 /**
  *
  * @param {Object} reqBidsConfigObj
@@ -161,7 +58,7 @@ function getBidRequestData(reqBidsConfigObj, callback, config, userConsent) {
  */
 function handleTimeoutIncrement(reqBidsConfigObj, rules) {
   const adUnits = reqBidsConfigObj.adUnits || getGlobal().adUnits;
-  const timeoutModifier = timeoutRtdFunctions.calculateTimeoutModifier(adUnits, rules);
+  const timeoutModifier = bidderTimeoutFunctions.calculateTimeoutModifier(adUnits, rules);
   const bidderTimeout = reqBidsConfigObj.timeout || getGlobal().getConfig('bidderTimeout');
   reqBidsConfigObj.timeout = bidderTimeout + timeoutModifier;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "9.53.3",
+  "version": "9.53.4",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.public.js",
   "exports": {

package/test/spec/activities/objectGuard_spec.js

@@ -13,6 +13,18 @@ describe('objectGuard', () => {
         get(val) { return `repl${val}` },
       }
     })
+
+    it('should reject conflicting rules', () => {
+      const crule = {...rule, paths: ['outer']};
+      expect(() => objectGuard([rule, crule])).to.throw();
+      expect(() => objectGuard([crule, rule])).to.throw();
+    });
+
+    it('should preserve object identity', () => {
+      const guard = objectGuard([rule])({outer: {inner: {foo: 'bar'}}});
+      expect(guard.outer).to.equal(guard.outer);
+      expect(guard.outer.inner).to.equal(guard.outer.inner);
+    })
     it('can prevent top level read access', () => {
       const obj = objectGuard([rule])({'foo': 1, 'other': 2});
       expect(obj).to.eql({
@@ -97,6 +109,18 @@ describe('objectGuard', () => {
       });
     });
 
+    it('should reject conflicting rules', () => {
+      const crule = {...rule, paths: ['outer']};
+      expect(() => objectGuard([rule, crule])).to.throw();
+      expect(() => objectGuard([crule, rule])).to.throw();
+    });
+
+    it('should preserve object identity', () => {
+      const guard = objectGuard([rule])({outer: {inner: {foo: 'bar'}}});
+      expect(guard.outer).to.equal(guard.outer);
+      expect(guard.outer.inner).to.equal(guard.outer.inner);
+    })
+
     it('does not mess up array reads', () => {
       const guard = objectGuard([rule])({foo: [{bar: 'baz'}]});
       expect(guard.foo).to.eql([{bar: 'baz'}]);
@@ -247,22 +271,31 @@ describe('objectGuard', () => {
       expect(obj.foo).to.eql('21bar');
     });
 
-    it('can apply both redact and write protect', () => {
-      const obj = objectGuard([
-        redactRule({
-          paths: ['foo'],
-          applies: () => true,
-          get(val) {
-            return 'redact' + val;
-          },
-        }),
-        writeProtectRule({
-          paths: ['foo'],
-          applies: () => true,
+    describe('when a property has both redact and write protect rules', () => {
+      let rules;
+      beforeEach(() => {
+        rules = [
+          redactRule({
+            paths: ['foo'],
+            applies: () => true,
+          }),
+          writeProtectRule({
+            paths: ['foo'],
+            applies: () => true,
+          })
+        ];
+      })
+      Object.entries({
+        'simple value': 'val',
+        'object value': {inner: 'val'}
+      }).forEach(([t, val]) => {
+        it(`can apply them both (on ${t})`, () => {
+          const obj = objectGuard(rules)({foo: val});
+          expect(obj.foo).to.not.exist;
+          obj.foo = {other: 'val'};
+          expect(obj.foo).to.not.exist;
         })
-      ])({foo: 'bar'});
-      obj.foo = 'baz';
-      expect(obj.foo).to.eql('redactbar');
-    });
+      })
+    })
   })
 });

package/test/spec/libraries/bidderTimeoutUtils/bidderTimeoutUtils_spec.js

@@ -0,0 +1,213 @@
+import { bidderTimeoutFunctions } from '../../../../libraries/bidderTimeoutUtils/bidderTimeoutUtils.js'
+import { expect } from 'chai';
+
+const DEFAULT_USER_AGENT = window.navigator.userAgent;
+const DEFAULT_CONNECTION = window.navigator.connection;
+
+const PC_USER_AGENT = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.135 Safari/537.36 Edge/12.246';
+const MOBILE_USER_AGENT = 'Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_1 like Mac OS X) AppleWebKit/603.1.30 (KHTML, like Gecko) Version/10.0 Mobile/14E304 Safari/602.1';
+const TABLET_USER_AGENT = 'Mozilla/5.0 (iPad; CPU OS 12_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148';
+
+function resetUserAgent() {
+  window.navigator.__defineGetter__('userAgent', () => DEFAULT_USER_AGENT);
+};
+
+function setUserAgent(userAgent) {
+  window.navigator.__defineGetter__('userAgent', () => userAgent);
+}
+
+function resetConnection() {
+  window.navigator.__defineGetter__('connection', () => DEFAULT_CONNECTION);
+}
+function setConnectionType(connectionType) {
+  window.navigator.__defineGetter__('connection', () => { return { 'type': connectionType } });
+}
+
+describe('Timeout RTD submodule', () => {
+  let sandbox;
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  describe('getDeviceType', () => {
+    afterEach(() => {
+      resetUserAgent();
+    });
+
+    [
+      // deviceType, userAgent, deviceTypeNum
+      ['pc', PC_USER_AGENT, 2],
+      ['mobile', MOBILE_USER_AGENT, 4],
+      ['tablet', TABLET_USER_AGENT, 5],
+    ].forEach(function (args) {
+      const [deviceType, userAgent, deviceTypeNum] = args;
+      it(`should be able to recognize ${deviceType} devices`, () => {
+        setUserAgent(userAgent);
+        const res = bidderTimeoutFunctions.getDeviceType();
+        expect(res).to.equal(deviceTypeNum)
+      })
+    })
+  });
+
+  describe('getConnectionSpeed', () => {
+    afterEach(() => {
+      resetConnection();
+    });
+    [
+      // connectionType, connectionSpeed
+      ['slow-2g', 'slow'],
+      ['2g', 'slow'],
+      ['3g', 'medium'],
+      ['bluetooth', 'fast'],
+      ['cellular', 'fast'],
+      ['ethernet', 'fast'],
+      ['wifi', 'fast'],
+      ['wimax', 'fast'],
+      ['4g', 'fast'],
+      ['not known', 'unknown'],
+      [undefined, 'unknown'],
+    ].forEach(function (args) {
+      const [connectionType, connectionSpeed] = args;
+      it(`should be able to categorize connection speed when the connection type is ${connectionType}`, () => {
+        setConnectionType(connectionType);
+        const res = bidderTimeoutFunctions.getConnectionSpeed();
+        expect(res).to.equal(connectionSpeed)
+      })
+    })
+  });
+
+  describe('Timeout modifier calculations', () => {
+    let sandbox;
+    beforeEach(() => {
+      sandbox = sinon.createSandbox();
+    });
+
+    afterEach(() => {
+      sandbox.restore();
+    });
+
+    it('should be able to detect video ad units', () => {
+      let adUnits = []
+      let res = bidderTimeoutFunctions.checkVideo(adUnits);
+      expect(res).to.be.false;
+
+      adUnits = [{
+        mediaTypes: {
+          video: []
+        }
+      }];
+      res = bidderTimeoutFunctions.checkVideo(adUnits);
+      expect(res).to.be.true;
+
+      adUnits = [{
+        mediaTypes: {
+          banner: []
+        }
+      }];
+      res = bidderTimeoutFunctions.checkVideo(adUnits);
+      expect(res).to.be.false;
+    });
+
+    it('should calculate the timeout modifier for video', () => {
+      sandbox.stub(bidderTimeoutFunctions, 'checkVideo').returns(true);
+      const rules = {
+        includesVideo: {
+          'true': 200,
+          'false': 50
+        }
+      }
+      const res = bidderTimeoutFunctions.calculateTimeoutModifier([], rules);
+      expect(res).to.equal(200)
+    });
+
+    it('should calculate the timeout modifier for connectionSpeed', () => {
+      sandbox.stub(bidderTimeoutFunctions, 'getConnectionSpeed').returns('slow');
+      const rules = {
+        connectionSpeed: {
+          'slow': 200,
+          'medium': 100,
+          'fast': 50
+        }
+      }
+      const res = bidderTimeoutFunctions.calculateTimeoutModifier([], rules);
+      expect(res).to.equal(200);
+    });
+
+    it('should calculate the timeout modifier for deviceType', () => {
+      sandbox.stub(bidderTimeoutFunctions, 'getDeviceType').returns(4);
+      const rules = {
+        deviceType: {
+          '2': 50,
+          '4': 100,
+          '5': 200
+        },
+      }
+      const res = bidderTimeoutFunctions.calculateTimeoutModifier([], rules);
+      expect(res).to.equal(100)
+    });
+
+    it('should calculate the timeout modifier for ranged numAdunits', () => {
+      const rules = {
+        numAdUnits: {
+          '1-5': 100,
+          '6-10': 200,
+          '11-15': 300,
+        }
+      }
+      const adUnits = [1, 2, 3, 4, 5, 6];
+      const res = bidderTimeoutFunctions.calculateTimeoutModifier(adUnits, rules);
+      expect(res).to.equal(200)
+    });
+
+    it('should calculate the timeout modifier for exact numAdunits', () => {
+      const rules = {
+        numAdUnits: {
+          '1': 100,
+          '2': 200,
+          '3': 300,
+          '4-5': 400,
+        }
+      }
+      const adUnits = [1, 2];
+      const res = bidderTimeoutFunctions.calculateTimeoutModifier(adUnits, rules);
+      expect(res).to.equal(200);
+    });
+
+    it('should add up all the modifiers when all the rules are present', () => {
+      sandbox.stub(bidderTimeoutFunctions, 'getConnectionSpeed').returns('slow');
+      sandbox.stub(bidderTimeoutFunctions, 'getDeviceType').returns(4);
+      const rules = {
+        connectionSpeed: {
+          'slow': 200,
+          'medium': 100,
+          'fast': 50
+        },
+        deviceType: {
+          '2': 50,
+          '4': 100,
+          '5': 200
+        },
+        includesVideo: {
+          'true': 200,
+          'false': 50
+        },
+        numAdUnits: {
+          '1': 100,
+          '2': 200,
+          '3': 300,
+          '4-5': 400,
+        }
+      }
+      const res = bidderTimeoutFunctions.calculateTimeoutModifier([{
+        mediaTypes: {
+          video: []
+        }
+      }], rules);
+      expect(res).to.equal(600);
+    });
+  });
+});