prebid.js 6.4.0 → 6.5.0

package/src/utils.js

@@ -1272,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/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);
+  });
 });

package/test/spec/modules/adyoulikeBidAdapter_spec.js

@@ -95,6 +95,40 @@ describe('Adyoulike Adapter', function () {
     }
   ];
 
+  const bidRequestWithMultipleMediatype = [
+    {
+      'bidId': 'bid_id_0',
+      'bidder': 'adyoulike',
+      'placementCode': 'adunit/hb-0',
+      'params': {
+        'placement': 'placement_0'
+      },
+      'sizes': '300x250',
+      'mediaTypes': {
+        'banner': {
+          'sizes': ['640x480']
+        },
+        'video': {
+          'playerSize': [640, 480],
+          'context': 'outstream'
+        },
+        'native': {
+          'image': {
+            'required': true,
+          },
+          'title': {
+            'required': true,
+            'len': 80
+          },
+          'cta': {
+            'required': false
+          },
+        }
+      },
+      'transactionId': 'bid_id_0_transaction_id'
+    }
+  ];
+
   const bidRequestWithNativeImageType = [
     {
       'bidId': 'bid_id_0',
@@ -647,6 +681,21 @@ describe('Adyoulike Adapter', function () {
       expect(payload.Bids['bid_id_0'].TransactionID).to.be.equal('bid_id_0_transaction_id');
     });
 
+    it('sends bid request to endpoint with single placement multiple mediatype', function () {
+      canonicalQuery.restore();
+      const request = spec.buildRequests(bidRequestWithMultipleMediatype, bidderRequest);
+      const payload = JSON.parse(request.data);
+
+      expect(request.url).to.contain(getEndpoint());
+      expect(request.method).to.equal('POST');
+
+      expect(request.url).to.not.contains('CanonicalUrl=' + encodeURIComponent(canonicalUrl));
+      expect(payload.Version).to.equal('1.0');
+      expect(payload.Bids['bid_id_0'].PlacementID).to.be.equal('placement_0');
+      expect(payload.PageRefreshed).to.equal(false);
+      expect(payload.Bids['bid_id_0'].TransactionID).to.be.equal('bid_id_0_transaction_id');
+    });
+
     it('sends bid request to endpoint with multiple placements', function () {
       const request = spec.buildRequests(bidRequestMultiPlacements, bidderRequest);
       const payload = JSON.parse(request.data);

package/test/spec/modules/consentManagement_spec.js

@@ -715,6 +715,26 @@ describe('consentManagement', function () {
           expect(consent).to.be.null;
         });
 
+        it('allows the auction when CMP is unresponsive', (done) => {
+          setConsentConfig({
+            cmpApi: 'iab',
+            timeout: 10,
+            defaultGdprScope: true
+          });
+
+          requestBidsHook(() => {
+            didHookReturn = true;
+          }, {});
+
+          setTimeout(() => {
+            expect(didHookReturn).to.be.true;
+            const consent = gdprDataHandler.getConsentData();
+            expect(consent.gdprApplies).to.be.true;
+            expect(consent.consentString).to.be.undefined;
+            done();
+          }, 20);
+        });
+
         it('It still considers it a valid cmp response if gdprApplies is not a boolean', function () {
           // gdprApplies is undefined, should just still store consent response but use whatever defaultGdprScope was
           let testConsentData = {

package/test/spec/modules/docereeBidAdapter_spec.js

@@ -31,6 +31,8 @@ describe('BidlabBidAdapter', function () {
     bidder: 'doceree',
     params: {
       placementId: 'DOC_7jm9j5eqkl0xvc5w',
+      gdpr: '1',
+      gdprConsent: 'CPQfU1jPQfU1jG0AAAENAwCAAAAAAAAAAAAAAAAAAAAA.IGLtV_T9fb2vj-_Z99_tkeYwf95y3p-wzhheMs-8NyZeH_B4Wv2MyvBX4JiQKGRgksjLBAQdtHGlcTQgBwIlViTLMYk2MjzNKJrJEilsbO2dYGD9Pn8HT3ZCY70-vv__7v3ff_3g'
     }
   };
 
@@ -44,6 +46,12 @@ describe('BidlabBidAdapter', function () {
     });
   });
 
+  describe('isGdprConsentPresent', function () {
+    it('Should return true if gdpr consent is present', function () {
+      expect(spec.isGdprConsentPresent(bid)).to.be.true;
+    });
+  });
+
   describe('buildRequests', function () {
     let serverRequest = spec.buildRequests([bid]);
     serverRequest = serverRequest[0]
@@ -56,7 +64,7 @@ describe('BidlabBidAdapter', function () {
       expect(serverRequest.method).to.equal('GET');
     });
     it('Returns valid URL', function () {
-      expect(serverRequest.url).to.equal('https://bidder.doceree.com/v1/adrequest?id=DOC_7jm9j5eqkl0xvc5w&pubRequestedURL=undefined&loggedInUser=JTdCJTIyZ2VuZGVyJTIyJTNBJTIyJTIyJTJDJTIyZW1haWwlMjIlM0ElMjIlMjIlMkMlMjJoYXNoZWRFbWFpbCUyMiUzQSUyMiUyMiUyQyUyMmZpcnN0TmFtZSUyMiUzQSUyMiUyMiUyQyUyMmxhc3ROYW1lJTIyJTNBJTIyJTIyJTJDJTIybnBpJTIyJTNBJTIyJTIyJTJDJTIyaGFzaGVkTlBJJTIyJTNBJTIyJTIyJTJDJTIyY2l0eSUyMiUzQSUyMiUyMiUyQyUyMnppcENvZGUlMjIlM0ElMjIlMjIlMkMlMjJzcGVjaWFsaXphdGlvbiUyMiUzQSUyMiUyMiU3RA%3D%3D&prebidjs=true&requestId=testing&');
+      expect(serverRequest.url).to.equal('https://bidder.doceree.com/v1/adrequest?id=DOC_7jm9j5eqkl0xvc5w&pubRequestedURL=undefined&loggedInUser=JTdCJTIyZ2VuZGVyJTIyJTNBJTIyJTIyJTJDJTIyZW1haWwlMjIlM0ElMjIlMjIlMkMlMjJoYXNoZWRFbWFpbCUyMiUzQSUyMiUyMiUyQyUyMmZpcnN0TmFtZSUyMiUzQSUyMiUyMiUyQyUyMmxhc3ROYW1lJTIyJTNBJTIyJTIyJTJDJTIybnBpJTIyJTNBJTIyJTIyJTJDJTIyaGFzaGVkTlBJJTIyJTNBJTIyJTIyJTJDJTIyY2l0eSUyMiUzQSUyMiUyMiUyQyUyMnppcENvZGUlMjIlM0ElMjIlMjIlMkMlMjJzcGVjaWFsaXphdGlvbiUyMiUzQSUyMiUyMiU3RA%3D%3D&prebidjs=true&requestId=testing&gdpr=1&gdpr_consent=CPQfU1jPQfU1jG0AAAENAwCAAAAAAAAAAAAAAAAAAAAA.IGLtV_T9fb2vj-_Z99_tkeYwf95y3p-wzhheMs-8NyZeH_B4Wv2MyvBX4JiQKGRgksjLBAQdtHGlcTQgBwIlViTLMYk2MjzNKJrJEilsbO2dYGD9Pn8HT3ZCY70-vv__7v3ff_3g&');
     });
   });
   describe('interpretResponse', function () {

package/test/spec/modules/gptPreAuction_spec.js

@@ -20,7 +20,9 @@ describe('GPT pre-auction module', () => {
   const testSlots = [
     makeSlot({ code: 'slotCode1', divId: 'div1' }),
     makeSlot({ code: 'slotCode2', divId: 'div2' }),
-    makeSlot({ code: 'slotCode3', divId: 'div3' })
+    makeSlot({ code: 'slotCode3', divId: 'div3' }),
+    makeSlot({ code: 'slotCode4', divId: 'div4' }),
+    makeSlot({ code: 'slotCode4', divId: 'div5' })
   ];
 
   describe('appendPbAdSlot', () => {
@@ -172,7 +174,9 @@ describe('GPT pre-auction module', () => {
       expect(_currentConfig).to.deep.equal({
         enabled: true,
         customGptSlotMatching: false,
-        customPbAdSlot: false
+        customPbAdSlot: false,
+        customPreAuction: false,
+        useDefaultPreAuction: false
       });
     });
   });
@@ -266,5 +270,176 @@ describe('GPT pre-auction module', () => {
       runMakeBidRequests(testAdUnits);
       expect(returnedAdUnits).to.deep.equal(expectedAdUnits);
     });
+
+    it('should use the passed customPreAuction logic', () => {
+      let counter = 0;
+      config.setConfig({
+        gptPreAuction: {
+          enabled: true,
+          customPreAuction: (adUnit, slotName) => {
+            counter += 1;
+            return `${adUnit.code}-${slotName || counter}`;
+          }
+        }
+      });
+      const testAdUnits = [
+        {
+          code: 'adUnit1',
+          ortb2Imp: { ext: { data: { pbadslot: '12345' } } }
+        },
+        {
+          code: 'adUnit2',
+        },
+        {
+          code: 'slotCode3',
+        },
+        {
+          code: 'div4',
+        }
+      ];
+
+      // all slots should be passed in same time and have slot-${index}
+      const expectedAdUnits = [{
+        code: 'adUnit1',
+        ortb2Imp: {
+          ext: {
+            // no slotname match so uses adUnit.code-counter
+            data: {
+              pbadslot: 'adUnit1-1'
+            },
+            gpid: 'adUnit1-1'
+          }
+        }
+      },
+      // second adunit
+      {
+        code: 'adUnit2',
+        ortb2Imp: {
+          ext: {
+            // no slotname match so uses adUnit.code-counter
+            data: {
+              pbadslot: 'adUnit2-2'
+            },
+            gpid: 'adUnit2-2'
+          }
+        }
+      }, {
+        code: 'slotCode3',
+        ortb2Imp: {
+          ext: {
+            // slotname found, so uses code + slotname (which is same)
+            data: {
+              pbadslot: 'slotCode3-slotCode3',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode3'
+              }
+            },
+            gpid: 'slotCode3-slotCode3'
+          }
+        }
+      }, {
+        code: 'div4',
+        ortb2Imp: {
+          ext: {
+            // slotname found, so uses code + slotname
+            data: {
+              pbadslot: 'div4-slotCode4',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode4'
+              }
+            },
+            gpid: 'div4-slotCode4'
+          }
+        }
+      }];
+
+      window.googletag.pubads().setSlots(testSlots);
+      runMakeBidRequests(testAdUnits);
+      expect(returnedAdUnits).to.deep.equal(expectedAdUnits);
+    });
+
+    it('should use useDefaultPreAuction logic', () => {
+      config.setConfig({
+        gptPreAuction: {
+          enabled: true,
+          useDefaultPreAuction: true
+        }
+      });
+      const testAdUnits = [
+        // First adUnit should use the preset pbadslot
+        {
+          code: 'adUnit1',
+          ortb2Imp: { ext: { data: { pbadslot: '12345' } } }
+        },
+        // Second adUnit should not match a gam slot, so no slot set
+        {
+          code: 'adUnit2',
+        },
+        // third adunit matches a single slot so uses it
+        {
+          code: 'slotCode3',
+        },
+        // fourth adunit matches multiple slots so combination
+        {
+          code: 'div4',
+        }
+      ];
+
+      const expectedAdUnits = [{
+        code: 'adUnit1',
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: '12345'
+            },
+            gpid: '12345'
+          }
+        }
+      },
+      // second adunit
+      {
+        code: 'adUnit2',
+        ortb2Imp: {
+          ext: {
+            data: {
+            },
+          }
+        }
+      }, {
+        code: 'slotCode3',
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: 'slotCode3',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode3'
+              }
+            },
+            gpid: 'slotCode3'
+          }
+        }
+      }, {
+        code: 'div4',
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: 'slotCode4#div4',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode4'
+              }
+            },
+            gpid: 'slotCode4#div4'
+          }
+        }
+      }];
+
+      window.googletag.pubads().setSlots(testSlots);
+      runMakeBidRequests(testAdUnits);
+      expect(returnedAdUnits).to.deep.equal(expectedAdUnits);
+    });
   });
 });