Core: fix spurious warnings on mergeConfig (prebid#9704)

* Core: fix spurious warnings on `mergeConfig` * Fix sendAllBid config name
jwplayer · May 18, 2023 · 30173c2 · 30173c2
1 parent 23f5b7a
commit 30173c2
Show file tree

Hide file tree

Showing 2 changed files with 79 additions and 128 deletions.
diff --git a/src/config.js b/src/config.js
@@ -66,158 +66,109 @@ export function newConfig() {
 
   function resetConfig() {
     defaults = {};
-    let newConfig = {
-      // `debug` is equivalent to legacy `pbjs.logging` property
-      _debug: DEFAULT_DEBUG,
-      get debug() {
-        return this._debug;
-      },
-      set debug(val) {
-        this._debug = val;
-      },
 
-      // default timeout for all bids
-      _bidderTimeout: DEFAULT_BIDDER_TIMEOUT,
-      get bidderTimeout() {
-        return this._bidderTimeout;
-      },
-      set bidderTimeout(val) {
-        this._bidderTimeout = val;
-      },
+    function getProp(name) {
+      return props[name].val;
+    }
 
-      _publisherDomain: null,
-      get publisherDomain() {
-        return this._publisherDomain;
-      },
-      set publisherDomain(val) {
-        logWarn('publisherDomain is deprecated and has no effect since v7 - use pageUrl instead')
-        this._publisherDomain = val;
-      },
+    function setProp(name, val) {
+      props[name].val = val;
+    }
 
-      // calls existing function which may be moved after deprecation
-      _priceGranularity: GRANULARITY_OPTIONS.MEDIUM,
-      set priceGranularity(val) {
-        if (validatePriceGranularity(val)) {
-          if (typeof val === 'string') {
-            this._priceGranularity = (hasGranularity(val)) ? val : GRANULARITY_OPTIONS.MEDIUM;
-          } else if (isPlainObject(val)) {
-            this._customPriceBucket = val;
-            this._priceGranularity = GRANULARITY_OPTIONS.CUSTOM;
-            logMessage('Using custom price granularity');
+    const props = {
+      publisherDomain: {
+        set(val) {
+          if (val != null) {
+            logWarn('publisherDomain is deprecated and has no effect since v7 - use pageUrl instead')
           }
+          setProp('publisherDomain', val);
         }
       },
-      get priceGranularity() {
-        return this._priceGranularity;
-      },
-
-      _customPriceBucket: {},
-      get customPriceBucket() {
-        return this._customPriceBucket;
-      },
-
-      /**
-       * mediaTypePriceGranularity
-       * @type {MediaTypePriceGranularity}
-       */
-      _mediaTypePriceGranularity: {},
-
-      get mediaTypePriceGranularity() {
-        return this._mediaTypePriceGranularity;
-      },
-      set mediaTypePriceGranularity(val) {
-        this._mediaTypePriceGranularity = Object.keys(val).reduce((aggregate, item) => {
-          if (validatePriceGranularity(val[item])) {
+      priceGranularity: {
+        val: GRANULARITY_OPTIONS.MEDIUM,
+        set(val) {
+          if (validatePriceGranularity(val)) {
             if (typeof val === 'string') {
-              aggregate[item] = (hasGranularity(val[item])) ? val[item] : this._priceGranularity;
+              setProp('priceGranularity', (hasGranularity(val)) ? val : GRANULARITY_OPTIONS.MEDIUM);
             } else if (isPlainObject(val)) {
-              aggregate[item] = val[item];
-              logMessage(`Using custom price granularity for ${item}`);
+              setProp('customPriceBucket', val);
+              setProp('priceGranularity', GRANULARITY_OPTIONS.CUSTOM)
+              logMessage('Using custom price granularity');
             }
-          } else {
-            logWarn(`Invalid price granularity for media type: ${item}`);
           }
-          return aggregate;
-        }, {});
-      },
-
-      _sendAllBids: DEFAULT_ENABLE_SEND_ALL_BIDS,
-      get enableSendAllBids() {
-        return this._sendAllBids;
+        }
       },
-      set enableSendAllBids(val) {
-        this._sendAllBids = val;
+      customPriceBucket: {
+        val: {},
+        set() {}
       },
-
-      _useBidCache: DEFAULT_BID_CACHE,
-      get useBidCache() {
-        return this._useBidCache;
+      mediaTypePriceGranularity: {
+        val: {},
+        set(val) {
+          val != null && setProp('mediaTypePriceGranularity', Object.keys(val).reduce((aggregate, item) => {
+            if (validatePriceGranularity(val[item])) {
+              if (typeof val === 'string') {
+                aggregate[item] = (hasGranularity(val[item])) ? val[item] : getProp('priceGranularity');
+              } else if (isPlainObject(val)) {
+                aggregate[item] = val[item];
+                logMessage(`Using custom price granularity for ${item}`);
+              }
+            } else {
+              logWarn(`Invalid price granularity for media type: ${item}`);
+            }
+            return aggregate;
+          }, {}));
+        }
       },
-      set useBidCache(val) {
-        this._useBidCache = val;
+      bidderSequence: {
+        val: DEFAULT_BIDDER_SEQUENCE,
+        set(val) {
+          if (VALID_ORDERS[val]) {
+            setProp('bidderSequence', val);
+          } else {
+            logWarn(`Invalid order: ${val}. Bidder Sequence was not set.`);
+          }
+        }
       },
+      auctionOptions: {
+        val: {},
+        set(val) {
+          if (validateauctionOptions(val)) {
+            setProp('auctionOptions', val);
+          }
+        }
+      }
+    }
+    let newConfig = {
+      // `debug` is equivalent to legacy `pbjs.logging` property
+      debug: DEFAULT_DEBUG,
+      bidderTimeout: DEFAULT_BIDDER_TIMEOUT,
+      enableSendAllBids: DEFAULT_ENABLE_SEND_ALL_BIDS,
+      useBidCache: DEFAULT_BID_CACHE,
 
       /**
        * deviceAccess set to false will disable setCookie, getCookie, hasLocalStorage
        * @type {boolean}
        */
-      _deviceAccess: DEFAULT_DEVICE_ACCESS,
-      get deviceAccess() {
-        return this._deviceAccess;
-      },
-      set deviceAccess(val) {
-        this._deviceAccess = val;
-      },
-
-      _bidderSequence: DEFAULT_BIDDER_SEQUENCE,
-      get bidderSequence() {
-        return this._bidderSequence;
-      },
-      set bidderSequence(val) {
-        if (VALID_ORDERS[val]) {
-          this._bidderSequence = val;
-        } else {
-          logWarn(`Invalid order: ${val}. Bidder Sequence was not set.`);
-        }
-      },
+      deviceAccess: DEFAULT_DEVICE_ACCESS,
 
       // timeout buffer to adjust for bidder CDN latency
-      _timeoutBuffer: DEFAULT_TIMEOUTBUFFER,
-      get timeoutBuffer() {
-        return this._timeoutBuffer;
-      },
-      set timeoutBuffer(val) {
-        this._timeoutBuffer = val;
-      },
-
-      _disableAjaxTimeout: DEFAULT_DISABLE_AJAX_TIMEOUT,
-      get disableAjaxTimeout() {
-        return this._disableAjaxTimeout;
-      },
-      set disableAjaxTimeout(val) {
-        this._disableAjaxTimeout = val;
-      },
+      timeoutBuffer: DEFAULT_TIMEOUTBUFFER,
+      disableAjaxTimeout: DEFAULT_DISABLE_AJAX_TIMEOUT,
 
       // default max nested iframes for referer detection
-      _maxNestedIframes: DEFAULT_MAX_NESTED_IFRAMES,
-      get maxNestedIframes() {
-        return this._maxNestedIframes;
-      },
-      set maxNestedIframes(val) {
-        this._maxNestedIframes = val;
-      },
-
-      _auctionOptions: {},
-      get auctionOptions() {
-        return this._auctionOptions;
-      },
-      set auctionOptions(val) {
-        if (validateauctionOptions(val)) {
-          this._auctionOptions = val;
-        }
-      },
+      maxNestedIframes: DEFAULT_MAX_NESTED_IFRAMES,
     };
 
+    Object.defineProperties(newConfig,
+      Object.fromEntries(Object.entries(props)
+        .map(([k, def]) => [k, Object.assign({
+          get: getProp.bind(null, k),
+          set: setProp.bind(null, k),
+          enumerable: true,
+        }, def)]))
+    );
+
     if (config) {
       callSubscribers(
         Object.keys(config).reduce((memo, topic) => {

diff --git a/test/spec/modules/ooloAnalyticsAdapter_spec.js b/test/spec/modules/ooloAnalyticsAdapter_spec.js
@@ -194,7 +194,7 @@ describe('oolo Prebid Analytic', () => {
       })
 
       const conf = {}
-      const pbjsConfig = config.getConfig()
+      const pbjsConfig = JSON.parse(JSON.stringify(config.getConfig()))
 
       Object.keys(pbjsConfig).forEach(key => {
         if (key[0] !== '_') {