Various adapters: consolidate devicepixelratio usage into a library

libraries/devicePixelRatio/devicePixelRatio.js

@@ -0,0 +1,17 @@
+import {canAccessWindowTop, internal as utilsInternals} from '../../src/utils.js';
+
+function getFallbackWindow(win) {
+  if (win) {
+    return win;
+  }
+
+  return canAccessWindowTop() ? utilsInternals.getWindowTop() : utilsInternals.getWindowSelf();
+}
+
+export function getDevicePixelRatio(win) {
+  try {
+    return getFallbackWindow(win).devicePixelRatio;
+  } catch (e) {
+  }
+  return 1;
+}

modules/apstreamBidAdapter.js

@@ -1,5 +1,6 @@
 import {getDNT} from '../libraries/dnt/index.js';
 import { generateUUID, deepAccess, createTrackPixelHtml } from '../src/utils.js';
+import { getDevicePixelRatio } from '../libraries/devicePixelRatio/devicePixelRatio.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { getStorageManager } from '../src/storageManager.js';
@@ -335,7 +336,7 @@
 }
 
 function getScreenParams() {
-  return `${window.screen.width}x${window.screen.height}@${window.devicePixelRatio}`;
+  return `${window.screen.width}x${window.screen.height}@${getDevicePixelRatio(window)}`;
 }
 
 function getBids(bids) {

modules/datablocksBidAdapter.js

@@ -1,3 +1,4 @@
+import {getDevicePixelRatio} from '../libraries/devicePixelRatio/devicePixelRatio.js';
 import {deepAccess, getWinDimensions, getWindowTop, isGptPubadsDefined} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {config} from '../src/config.js';
@@ -135,7 +136,7 @@
       'whl': win.history.length,
       'wxo': win.pageXOffset,
       'wyo': win.pageYOffset,
-      'wpr': win.devicePixelRatio,
+      'wpr': getDevicePixelRatio(win),
       'is_bot': botTest.doTests(),
       'is_hid': win.document.hidden,
       'vs': win.document.visibilityState
@@ -216,7 +217,7 @@
             h: sizes[0][1],
             format: sizes.map(size => ({ w: size[0], h: size[1] }))
           };
 
           // ADD TO THE LIST OF IMP REQUESTS
           imps.push(imp);
         }

modules/greenbidsBidAdapter.js

@@ -1,4 +1,5 @@
 import { getValue, logError, deepAccess, parseSizesInput, getBidIdParameter, logInfo, getWinDimensions, getScreenOrientation } from '../src/utils.js';
+import { getDevicePixelRatio } from '../libraries/devicePixelRatio/devicePixelRatio.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { getStorageManager } from '../src/storageManager.js';
 import { getHLen } from '../libraries/navigatorData/navigatorData.js';
@@ -65,7 +66,7 @@
       device: bidderRequest?.ortb2?.device || {},
       deviceWidth: screen.width,
       deviceHeight: screen.height,
-      devicePixelRatio: topWindow.devicePixelRatio,
+      devicePixelRatio: getDevicePixelRatio(topWindow),
       screenOrientation: getScreenOrientation(),
       historyLength: getHLen(),
       viewportHeight: getWinDimensions().visualViewport.height,

modules/gumgumBidAdapter.js

@@ -1,5 +1,6 @@
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {_each, deepAccess, getWinDimensions, logError, logWarn, parseSizesInput} from '../src/utils.js';
+import {getDevicePixelRatio} from '../libraries/devicePixelRatio/devicePixelRatio.js';
 
 import {config} from '../src/config.js';
 import {getStorageManager} from '../src/storageManager.js';
@@ -89,7 +90,7 @@
     pu: stripGGParams(topUrl),
     tpl: mosttopURL,
     ce: storage.cookiesAreEnabled(),
-    dpr: topWindow.devicePixelRatio || 1,
+    dpr: getDevicePixelRatio(topWindow),
     jcsi: JSON.stringify(JCSI),
     ogu: getOgURL()
   };

modules/hypelabBidAdapter.js

@@ -1,6 +1,7 @@
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER } from '../src/mediaTypes.js';
 import { generateUUID, isFn, isPlainObject, getWinDimensions } from '../src/utils.js';
+import { getDevicePixelRatio } from '../libraries/devicePixelRatio/devicePixelRatio.js';
 import { ajax } from '../src/ajax.js';
 import { getBoundingClientRect } from '../libraries/boundingClientRect/boundingClientRect.js';
 import { getWalletPresence, getWalletProviderFlags } from '../libraries/hypelabUtils/hypelabUtils.js';
@@ -40,7 +41,7 @@
 
     const uuid = uids[0] ? uids[0] : generateTemporaryUUID();
     const floor = getBidFloor(request, request.sizes || []);
-    const dpr = typeof window !== 'undefined' ? window.devicePixelRatio : 1;
+    const dpr = typeof window !== 'undefined' ? getDevicePixelRatio(window) : 1;
     const wp = getWalletPresence();
     const wpfs = getWalletProviderFlags();
     const winDimensions = getWinDimensions();

modules/oguryBidAdapter.js

@@ -2,6 +2,7 @@
 
 import { BANNER } from '../src/mediaTypes.js';
 import { getWindowSelf, getWindowTop, isFn, deepAccess, isPlainObject, deepSetValue, mergeDeep } from '../src/utils.js';
+import { getDevicePixelRatio } from '../libraries/devicePixelRatio/devicePixelRatio.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { ajax } from '../src/ajax.js';
 import { getAdUnitSizes } from '../libraries/sizeUtils/sizeUtils.js';
@@ -25,7 +26,7 @@
   request(buildRequest, imps, bidderRequest, context) {
     const req = buildRequest(imps, bidderRequest, context);
     req.tmax = DEFAULT_TIMEOUT;
-    deepSetValue(req, 'device.pxratio', window.devicePixelRatio);
+    deepSetValue(req, 'device.pxratio', getDevicePixelRatio(getWindowContext()));
     deepSetValue(req, 'site.page', getWindowContext().location.href);
 
     req.ext = mergeDeep({}, req.ext, {

modules/sspBCBidAdapter.js

@@ -1,4 +1,5 @@
 import { deepAccess, getWinDimensions, getWindowTop, isArray, logInfo, logWarn } from '../src/utils.js';
+import { getDevicePixelRatio } from '../libraries/devicePixelRatio/devicePixelRatio.js';
 import { ajax } from '../src/ajax.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js';
@@ -174,7 +175,7 @@
     'CH-SaveData': connection.saveData,
     'CH-Downlink': connection.downlink,
     'CH-DeviceMemory': null,
-    'CH-Dpr': W.devicePixelRatio,
+    'CH-Dpr': getDevicePixelRatio(W),
     'CH-ViewportWidth': viewport.width,
     'CH-BrowserBrands': JSON.stringify(userAgentData.brands),
     'CH-isMobile': userAgentData.mobile,

modules/teadsBidAdapter.js

@@ -1,4 +1,5 @@
 import {logError, parseSizesInput, isArray, getBidIdParameter, getWinDimensions, getScreenOrientation} from '../src/utils.js';
+import {getDevicePixelRatio} from '../libraries/devicePixelRatio/devicePixelRatio.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {getStorageManager} from '../src/storageManager.js';
 import {isAutoplayEnabled} from '../libraries/autoplayDetection/autoplay.js';
@@ -72,7 +73,7 @@
       device: bidderRequest?.ortb2?.device || {},
       deviceWidth: screen.width,
       deviceHeight: screen.height,
-      devicePixelRatio: topWindow.devicePixelRatio,
+      devicePixelRatio: getDevicePixelRatio(topWindow),
       screenOrientation: getScreenOrientation(),
       historyLength: getHLen(),
       viewportHeight: getWinDimensions().visualViewport.height,

src/utils/winDimensions.js

@@ -34,22 +34,22 @@ const winDimensions = new CachedApiWrapper(
 );
 
 export const internal = {
-  reset: winDimensions.reset,
+  winDimensions,
 };
 
 export const getWinDimensions = (() => {
   let lastCheckTimestamp;
   return function () {
     if (!lastCheckTimestamp || (Date.now() - lastCheckTimestamp > CHECK_INTERVAL_MS)) {
-      internal.reset();
+      internal.winDimensions.reset();
       lastCheckTimestamp = Date.now();
     }
-    return winDimensions.obj;
+    return internal.winDimensions.obj;
   }
 })();
 
 export function resetWinDimensions() {
-  internal.reset();
+  internal.winDimensions.reset();
 }
 
 export function getScreenOrientation(win) {

test/spec/modules/greenbidsBidAdapter_spec.js

@@ -2,6 +2,7 @@ import { expect } from 'chai';
 import { newBidder } from 'src/adapters/bidderFactory.js';
 import { spec, ENDPOINT_URL } from 'modules/greenbidsBidAdapter.js';
 import { getScreenOrientation } from 'src/utils.js';
+import {getDevicePixelRatio} from '../../../libraries/devicePixelRatio/devicePixelRatio.js';
 const AD_SCRIPT = '<script type="text/javascript" class="greenbids" async="true" src="https://greenbids.ai/settings"></script>"';
 
 describe('greenbidsBidAdapter', () => {
@@ -277,7 +278,7 @@ describe('greenbidsBidAdapter', () => {
     it('should add pixelRatio info to payload', function () {
       const request = spec.buildRequests(bidRequests, bidderRequestDefault);
       const payload = JSON.parse(request.data);
-      const pixelRatio = window.top.devicePixelRatio
+      const pixelRatio = getDevicePixelRatio()
 
       expect(payload.devicePixelRatio).to.exist;
       expect(payload.devicePixelRatio).to.deep.equal(pixelRatio);

test/spec/modules/hypelabBidAdapter_spec.js

@@ -13,6 +13,7 @@ import {
 } from 'modules/hypelabBidAdapter.js';
 
 import { BANNER } from 'src/mediaTypes.js';
+import {getDevicePixelRatio} from '../../../libraries/devicePixelRatio/devicePixelRatio.js';
 
 const mockValidBidRequest = {
   bidder: 'hypelab',
@@ -177,7 +178,7 @@ describe('hypelabBidAdapter', function () {
       expect(data.dpr).to.be.a('number');
       expect(data.location).to.be.a('string');
       expect(data.floor).to.equal(null);
-      expect(data.dpr).to.equal(1);
+      expect(data.dpr).to.equal(getDevicePixelRatio());
       expect(data.wp).to.deep.equal({
         ada: false,
         bnb: false,

test/spec/modules/oguryBidAdapter_spec.js

@@ -3,6 +3,7 @@
 import { spec, ortbConverterProps } from 'modules/oguryBidAdapter';
 import * as utils from 'src/utils.js';
 import { server } from '../../mocks/xhr.js';
+import {getDevicePixelRatio} from '../../../libraries/devicePixelRatio/devicePixelRatio.js';
 
 const BID_URL = 'https://mweb-hb.presage.io/api/header-bidding-request';
 const TIMEOUT_URL = 'https://ms-ads-monitoring-events.presage.io/bid_timeout'
@@ -577,10 +578,6 @@
       return stubbedCurrentTime;
     });
 
-    const stubbedDevicePixelMethod = sinon.stub(window, 'devicePixelRatio').get(function() {
-      return stubbedDevicePixelRatio;
-    });
-
     const defaultTimeout = 1000;
 
     function assertImpObject(ortbBidRequest, bidRequest) {
@@ -639,7 +636,7 @@
 
     beforeEach(() => {
       windowTopStub = sinon.stub(utils, 'getWindowTop');
-      windowTopStub.returns({ location: { href: currentLocation } });
+      windowTopStub.returns({ location: { href: currentLocation } , devicePixelRatio: stubbedDevicePixelRatio});
     });
 
     afterEach(() => {
@@ -648,7 +645,6 @@
 
     after(() => {
       stubbedCurrentTimeMethod.restore();
-      stubbedDevicePixelMethod.restore();
     });
 
     it('sends bid request to ENDPOINT via POST', function () {

test/spec/modules/teadsBidAdapter_spec.js

@@ -3,6 +3,7 @@ import * as autoplay from 'libraries/autoplayDetection/autoplay.js';
 import { spec, storage } from 'modules/teadsBidAdapter.js';
 import { newBidder } from 'src/adapters/bidderFactory.js';
 import { getScreenOrientation } from 'src/utils.js';
+import {getDevicePixelRatio} from '../../../libraries/devicePixelRatio/devicePixelRatio.js';
 
 const ENDPOINT = 'https://a.teads.tv/hb/bid-request';
 const AD_SCRIPT = '<script type="text/javascript" class="teads" async="true" src="https://a.teads.tv/hb/getAdSettings"></script>"';
@@ -360,7 +361,7 @@ describe('teadsBidAdapter', () => {
     it('should add pixelRatio info to payload', function () {
       const request = spec.buildRequests(bidRequests, bidderRequestDefault);
       const payload = JSON.parse(request.data);
-      const pixelRatio = window.top.devicePixelRatio
+      const pixelRatio = getDevicePixelRatio();
 
       expect(payload.devicePixelRatio).to.exist;
       expect(payload.devicePixelRatio).to.deep.equal(pixelRatio);

test/spec/utils_spec.js

@@ -1446,7 +1446,7 @@ describe('getWinDimensions', () => {
   });
 
   it('should clear cache once per 20ms', () => {
-    const resetWinDimensionsSpy = sinon.spy(winDimensions.internal, 'reset');
+    const resetWinDimensionsSpy = sinon.spy(winDimensions.internal.winDimensions, 'reset');
     expect(getWinDimensions().innerHeight).to.exist;
     clock.tick(1);
     expect(getWinDimensions().innerHeight).to.exist;