Add adapter specific params to orbidder adapter (prebid#3467)

* initial orbidder version in personal github repo

* use adUnits from orbidder_example.html

* replace obsolete functions

* forgot to commit the test

* check if bidderRequest object is available

* try to fix weird safari/ie issue

* ebayK: add more params

* update orbidderBidAdapter.md

* use spec.<function> instead of this.<function> for consistency reasons

Author: mmethner

modules/orbidderBidAdapter.js

@@ -4,6 +4,7 @@ import {registerBidder} from '../src/adapters/bidderFactory';
 
 export const spec = {
   code: 'orbidder',
+  bidParams: {},
   orbidderHost: (() => {
     let ret = 'https://orbidder.otto.de';
     try {
@@ -14,7 +15,10 @@ export const spec = {
   })(),
 
   isBidRequestValid(bid) {
-    return !!(bid.sizes && bid.bidId);
+    return !!(bid.sizes && bid.bidId && bid.params &&
+      (bid.params.accountId && (typeof bid.params.accountId === 'string')) &&
+      (bid.params.placementId && (typeof bid.params.placementId === 'string')) &&
+      ((typeof bid.params.keyValues === 'undefined') || (typeof bid.params.keyValues === 'object')));
   },
 
   buildRequests(validBidRequests, bidderRequest) {
@@ -24,7 +28,7 @@ export const spec = {
         referer = bidderRequest.refererInfo.referer || '';
       }
       const ret = {
-        url: `${this.orbidderHost}/bid`,
+        url: `${spec.orbidderHost}/bid`,
         method: 'POST',
         data: {
           pageUrl: referer,
@@ -36,6 +40,7 @@ export const spec = {
           params: bidRequest.params
         }
       };
+      spec.bidParams[bidRequest.bidId] = bidRequest.params;
       if (bidRequest && bidRequest.gdprConsent) {
         ret.data.gdprConsent = {
           consentString: bidRequest.gdprConsent.consentString,
@@ -68,9 +73,13 @@ export const spec = {
 
   onBidWon(winObj) {
     const getRefererInfo = detectReferer(window);
-    const refererInfo = getRefererInfo();
-    winObj.pageUrl = refererInfo.referer;
-    spec.ajaxCall(`${this.orbidderHost}/win`, JSON.stringify(winObj));
+
+    winObj.pageUrl = getRefererInfo().referer;
+    if (spec.bidParams[winObj.adId]) {
+      winObj.params = spec.bidParams[winObj.adId];
+    }
+
+    spec.ajaxCall(`${spec.orbidderHost}/win`, JSON.stringify(winObj));
   },
 
   ajaxCall(endpoint, data) {

modules/orbidderBidAdapter.md

@@ -21,6 +21,10 @@ var adUnits = [{
     },
     bids: [{
         bidder: 'orbidder'
+        params: {
+            accountId: "someAccount",
+            placementId: "somePlace"
+        }
     }]
 }];
 ```

test/spec/modules/orbidderBidAdapter_spec.js

@@ -4,17 +4,22 @@ import {newBidder} from 'src/adapters/bidderFactory';
 
 describe('orbidderBidAdapter', () => {
   const adapter = newBidder(spec);
-  const bidRequest = {
+  const defaultBidRequest = {
     bidId: 'd66fa86787e0b0ca900a96eacfd5f0bb',
     auctionId: 'ccc4c7cdfe11cfbd74065e6dd28413d8',
     transactionId: 'd58851660c0c4461e4aa06344fc9c0c6',
     adUnitCode: 'adunit-code',
     sizes: [[300, 250], [300, 600]],
     params: {
-      'foo': 'bar'
+      'accountId': 'string1',
+      'placementId': 'string2'
     }
   };
 
+  const deepClone = function (val) {
+    return JSON.parse(JSON.stringify(val));
+  };
+
   const buildRequest = function (buildRequest) {
     return spec.buildRequests(
       [buildRequest],
@@ -23,7 +28,7 @@ describe('orbidderBidAdapter', () => {
           referer: 'http://localhost:9876/'
         }
       })[0];
-  }
+  };
 
   describe('inherited functions', () => {
     it('exists and is a function', () => {
@@ -33,18 +38,36 @@ describe('orbidderBidAdapter', () => {
 
   describe('isBidRequestValid', () => {
     it('should return true when required params found', () => {
+      expect(spec.isBidRequestValid(defaultBidRequest)).to.equal(true);
+    });
+
+    it('accepts optional keyValues object', () => {
+      const bidRequest = deepClone(defaultBidRequest);
+      bidRequest.params.keyValues = {'key': 'value'};
       expect(spec.isBidRequestValid(bidRequest)).to.equal(true);
     });
 
+    it('performs type checking', () => {
+      const bidRequest = deepClone(defaultBidRequest);
+      bidRequest.params.accountId = 1; // supposed to be a string
+      expect(spec.isBidRequestValid(bidRequest)).to.equal(false);
+    });
+
+    it('doesn\'t accept malformed keyValues', () => {
+      const bidRequest = deepClone(defaultBidRequest);
+      bidRequest.params.keyValues = 'another not usable string';
+      expect(spec.isBidRequestValid(bidRequest)).to.equal(false);
+    });
+
     it('should return false when required params are not passed', () => {
-      let bidRequest = Object.assign({}, bidRequest);
+      const bidRequest = deepClone(defaultBidRequest);
       delete bidRequest.params;
       expect(spec.isBidRequestValid(bidRequest)).to.equal(false);
     });
   });
 
   describe('buildRequests', () => {
-    const request = buildRequest(bidRequest);
+    const request = buildRequest(defaultBidRequest);
 
     it('sends bid request to endpoint via https using post', () => {
       expect(request.method).to.equal('POST');
@@ -54,24 +77,24 @@ describe('orbidderBidAdapter', () => {
 
     it('sends correct bid parameters', () => {
       // we add one, because we add referer information from bidderRequest object
-      expect(Object.keys(request.data).length).to.equal(Object.keys(bidRequest).length + 1);
+      expect(Object.keys(request.data).length).to.equal(Object.keys(defaultBidRequest).length + 1);
       expect(request.data.pageUrl).to.equal('http://localhost:9876/');
       // expect(request.data.referrer).to.equal('');
-      Object.keys(bidRequest).forEach((key) => {
-        expect(bidRequest[key]).to.equal(request.data[key]);
+      Object.keys(defaultBidRequest).forEach((key) => {
+        expect(defaultBidRequest[key]).to.equal(request.data[key]);
       });
     });
 
     it('handles empty gdpr object', () => {
-      let bidRequest = Object.assign({}, bidRequest);
+      const bidRequest = deepClone(defaultBidRequest);
       bidRequest.gdprConsent = {};
 
       const request = buildRequest(bidRequest);
       expect(request.data.gdprConsent.consentRequired).to.be.equal(true);
     });
 
     it('handles non-existent gdpr object', () => {
-      let bidRequest = Object.assign({}, bidRequest);
+      const bidRequest = deepClone(defaultBidRequest);
       bidRequest.gdprConsent = null;
 
       const request = buildRequest(bidRequest);
@@ -80,7 +103,7 @@ describe('orbidderBidAdapter', () => {
 
     it('handles properly filled gdpr object where gdpr applies', () => {
       const consentString = 'someWeirdString';
-      const bidRequest = Object.assign({}, bidRequest);
+      const bidRequest = deepClone(defaultBidRequest);
       bidRequest.gdprConsent = {
         gdprApplies: true,
         consentString: 'someWeirdString'
@@ -94,7 +117,7 @@ describe('orbidderBidAdapter', () => {
 
     it('handles properly filled gdpr object where gdpr does not apply', () => {
       const consentString = 'someWeirdString';
-      const bidRequest = Object.assign({}, bidRequest);
+      const bidRequest = deepClone(defaultBidRequest);
       bidRequest.gdprConsent = {
         gdprApplies: false,
         consentString: 'someWeirdString'
@@ -110,6 +133,7 @@ describe('orbidderBidAdapter', () => {
   describe('onBidWon', () => {
     let ajaxStub;
     const winObj = {
+      adId: 'testId',
       test: 1,
       pageUrl: 'www.someurl.de',
       referrer: 'www.somereferrer.de'