From 94f954907155c93d609fe6264f3e16d182f856f1 Mon Sep 17 00:00:00 2001
From: Chris Huie <phoenixtechnerd@gmail.com>
Date: Tue, 11 Oct 2022 05:07:02 -0600
Subject: [PATCH] Eplanning Bid Adapter: add support for video (#9044)

* add video

* move up imptypes logic

* fix linting

* update curly braces

* fix spaces linting

* fix line
---
 modules/eplanningBidAdapter.js                |  50 ++-
 test/spec/modules/eplanningBidAdapter_spec.js | 286 +++++++++++++++++-
 2 files changed, 333 insertions(+), 3 deletions(-)

diff --git a/modules/eplanningBidAdapter.js b/modules/eplanningBidAdapter.js
index 0d37b72f4ad..b60c3571d47 100644
--- a/modules/eplanningBidAdapter.js
+++ b/modules/eplanningBidAdapter.js
@@ -2,6 +2,7 @@ import {getWindowSelf, isEmpty, parseSizesInput, isGptPubadsDefined, isSlotMatch
 import {getGlobal} from '../src/prebidGlobal.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {getStorageManager} from '../src/storageManager.js';
+import {BANNER, VIDEO} from '../src/mediaTypes.js';
 
 const BIDDER_CODE = 'eplanning';
 export const storage = getStorageManager({bidderCode: BIDDER_CODE});
@@ -19,9 +20,14 @@ const STORAGE_VIEW_PREFIX = 'pbvi_';
 const mobileUserAgent = isMobileUserAgent();
 const PRIORITY_ORDER_FOR_MOBILE_SIZES_ASC = ['1x1', '300x50', '320x50', '300x250'];
 const PRIORITY_ORDER_FOR_DESKTOP_SIZES_ASC = ['1x1', '970x90', '970x250', '160x600', '300x600', '728x90', '300x250'];
+const VAST_INSTREAM = 1;
+const VAST_OUTSTREAM = 2;
+const VAST_VERSION_DEFAULT = 3;
+const DEFAULT_SIZE_VAST = '640x480';
 
 export const spec = {
   code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO],
 
   isBidRequestValid: function(bid) {
     return Boolean(bid.params.ci) || Boolean(bid.params.t);
@@ -86,6 +92,10 @@ export const spec = {
           params['e_' + id] = (typeof userIds[id] === 'object') ? encodeURIComponent(JSON.stringify(userIds[id])) : encodeURIComponent(userIds[id]);
         }
       }
+      if (spaces.impType) {
+        params.vctx = spaces.impType & VAST_INSTREAM ? VAST_INSTREAM : VAST_OUTSTREAM;
+        params.vv = VAST_VERSION_DEFAULT;
+      }
     }
 
     return {
@@ -108,7 +118,6 @@ export const spec = {
               cpm: ad.pr,
               width: ad.w,
               height: ad.h,
-              ad: ad.adm,
               ttl: TTL,
               creativeId: ad.crid,
               netRevenue: NET_REVENUE,
@@ -119,6 +128,13 @@ export const spec = {
                 advertiserDomains: ad.adom
               };
             }
+            if (isVastResponse(ad)) {
+              bidResponse.vastXml = ad.adm;
+              bidResponse.mediaTypes = VIDEO;
+            } else {
+              bidResponse.ad = ad.adm;
+            }
+
             bidResponses.push(bidResponse);
           });
         }
@@ -236,17 +252,42 @@ function getSpacesStruct(bids) {
   return e;
 }
 
+function getFirstSizeVast(sizes) {
+  if (sizes == undefined || !Array.isArray(sizes)) {
+    return undefined;
+  }
+
+  let size = Array.isArray(sizes[0]) ? sizes[0] : sizes;
+
+  return (Array.isArray(size) && size.length == 2) ? size : undefined;
+}
+
 function cleanName(name) {
   return name.replace(/_|\.|-|\//g, '').replace(/\)\(|\(|\)|:/g, '_').replace(/^_+|_+$/g, '');
 }
 
 function getSpaces(bidRequests, ml) {
+  let impType = bidRequests.reduce((previousBits, bid) => (bid.mediaTypes && bid.mediaTypes[VIDEO]) ? (bid.mediaTypes[VIDEO].context == 'outstream' ? (previousBits | 2) : (previousBits | 1)) : previousBits, 0);
+  // Only one type of auction is supported at a time
+  if (impType) {
+    bidRequests = bidRequests.filter((bid) => bid.mediaTypes && bid.mediaTypes[VIDEO] && (impType & VAST_INSTREAM ? (!bid.mediaTypes[VIDEO].context || bid.mediaTypes[VIDEO].context == 'instream') : (bid.mediaTypes[VIDEO].context == 'outstream')));
+  }
+
   let spacesStruct = getSpacesStruct(bidRequests);
-  let es = {str: '', vs: '', map: {}};
+  let es = {str: '', vs: '', map: {}, impType: impType};
   es.str = Object.keys(spacesStruct).map(size => spacesStruct[size].map((bid, i) => {
     es.vs += getVs(bid);
 
     let name;
+
+    if (impType) {
+      let firstSize = getFirstSizeVast(bid.mediaTypes[VIDEO].playerSize);
+      let sizeVast = firstSize ? firstSize.join('x') : DEFAULT_SIZE_VAST;
+      name = 'video_' + sizeVast + '_' + i;
+      es.map[name] = bid.bidId;
+      return name + ':' + sizeVast + ';1';
+    }
+
     if (ml) {
       name = cleanName(bid.adUnitCode);
     } else {
@@ -462,4 +503,9 @@ function registerAuction(storageID) {
 
   return true;
 }
+
+function isVastResponse(bid) {
+  return bid.adm.match(/^(<VAST)|(<VideoAdServingTemplate)/gmi);
+}
+
 registerBidder(spec);
diff --git a/test/spec/modules/eplanningBidAdapter_spec.js b/test/spec/modules/eplanningBidAdapter_spec.js
index db70f7956d7..a356c9cee95 100644
--- a/test/spec/modules/eplanningBidAdapter_spec.js
+++ b/test/spec/modules/eplanningBidAdapter_spec.js
@@ -7,6 +7,7 @@ import * as utils from 'src/utils.js';
 import {hook} from '../../../src/hook.js';
 import {getGlobal} from '../../../src/prebidGlobal.js';
 import { makeSlot } from '../integration/faker/googletag.js';
+import {BANNER, VIDEO} from '../../../src/mediaTypes.js';
 
 describe('E-Planning Adapter', function () {
   const adapter = newBidder('spec');
@@ -19,6 +20,7 @@ describe('E-Planning Adapter', function () {
   const CLEAN_ADUNIT_CODE2 = '300x250_1';
   const CLEAN_ADUNIT_CODE = '300x250_0';
   const CLEAN_ADUNIT_CODE_ML = 'adunitco_de';
+  const CLEAN_ADUNIT_CODE_VAST = 'VIDEO_300x250_0';
   const BID_ID = '123456789';
   const BID_ID2 = '987654321';
   const BID_ID3 = '998877665';
@@ -30,6 +32,9 @@ describe('E-Planning Adapter', function () {
   const CRID = '1234567890';
   const TEST_ISV = 'leles.e-planning.net';
   const ADOMAIN = 'adomain.com';
+  const ADM_VAST = '<VAST version=\"2.0\">\n<Ad id=\"602833\">\n<Wrapper>\n<AdSystem>Acudeo Compatible</AdSystem>\n<VASTAdTagURI>\nhttp://demo.tremormedia.com/proddev/vast/vast_inline_linear.xml\n</VASTAdTagURI>\n<Impression><![CDATA[https://cndigrazia34.devel.e-planning.net:444/eli/4/19911d/6584303d5d0da8bc?i=0123456789012345&fi=0123456789abcdef&pb=<% EXCHANGE_EPBID_49 %>&nfc=1&S=<% SERVER_ID %>&rnd=733663791&bk=0123456789abcdef]]></Impression><Impression>http://myTrackingURL/wrapper/impression</Impression>\n<Creatives>\n<Creative AdID=\"602833\">\n<Linear>\n<TrackingEvents></TrackingEvents>\n</Linear>\n</Creative>\n<Creative AdID=\"602833-Companion\">\n<CompanionAds>\n<Companion width=\"300\" height=\"250\">\n<StaticResource creativeType=\"image/jpeg\">\nhttp://demo.tremormedia.com/proddev/vast/300x250_banner1.jpg\n</StaticResource>\n<TrackingEvents>\n<Tracking event=\"creativeView\">\nhttp://myTrackingURL/wrapper/firstCompanionCreativeView\n</Tracking>\n</TrackingEvents>\n<CompanionClickThrough>http://www.tremormedia.com</CompanionClickThrough>\n</Companion>\n<Companion width=\"728\" height=\"90\">\n<StaticResource creativeType=\"image/jpeg\">\nhttp://demo.tremormedia.com/proddev/vast/728x90_banner1.jpg\n</StaticResource>\n<CompanionClickThrough>http://www.tremormedia.com</CompanionClickThrough>\n</Companion>\n</CompanionAds>\n</Creative>\n</Creatives>\n</Wrapper>\n</Ad>\n</VAST>\n';
+  const ADM_VAST_VV_1 = '<VideoAdServingTemplate xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"vast_loose.xsd\">test</VideoAdServingTemplate>';
+  const DEFAULT_SIZE_VAST = '640x480';
   const validBid = {
     'bidder': 'eplanning',
     'bidId': BID_ID,
@@ -69,6 +74,110 @@ describe('E-Planning Adapter', function () {
     },
     'sizes': [[300, 250], [300, 600]],
   };
+  const validBidSpaceOutstream = {
+    'bidder': 'eplanning',
+    'bidId': BID_ID,
+    'params': {
+      'ci': CI,
+      'sn': SN,
+    },
+    'mediaTypes': {
+      'video': {
+        'context': 'outstream',
+        'playerSize': [300, 600],
+        'mimes': ['video/mp4'],
+        'protocols': [1, 2, 3, 4, 5, 6],
+        'playbackmethod': [2],
+        'skip': 1
+      }
+    },
+  };
+  const validBidOutstreamNoSize = {
+    'bidder': 'eplanning',
+    'bidId': BID_ID,
+    'params': {
+      'ci': CI,
+      'sn': SN,
+    },
+    'mediaTypes': {
+      'video': {
+        'context': 'outstream',
+        'mimes': ['video/mp4'],
+        'protocols': [1, 2, 3, 4, 5, 6],
+        'playbackmethod': [2],
+        'skip': 1
+      }
+    },
+  };
+  const validBidOutstreamNSizes = {
+    'bidder': 'eplanning',
+    'bidId': BID_ID,
+    'params': {
+      'ci': CI,
+      'sn': SN,
+    },
+    'mediaTypes': {
+      'video': {
+        'context': 'outstream',
+        'playerSize': [[300, 600], [400, 500], [500, 500]],
+        'mimes': ['video/mp4'],
+        'protocols': [1, 2, 3, 4, 5, 6],
+        'playbackmethod': [2],
+        'skip': 1
+      }
+    },
+  };
+  const bidOutstreamInvalidSizes = {
+    'bidder': 'eplanning',
+    'bidId': BID_ID,
+    'params': {
+      'ci': CI,
+      'sn': SN,
+    },
+    'mediaTypes': {
+      'video': {
+        'context': 'outstream',
+        'playerSize': 'invalidSize',
+        'mimes': ['video/mp4'],
+        'protocols': [1, 2, 3, 4, 5, 6],
+        'playbackmethod': [2],
+        'skip': 1
+      }
+    },
+  };
+  const validBidSpaceInstream = {
+    'bidder': 'eplanning',
+    'bidId': BID_ID,
+    'params': {
+      'ci': CI,
+      'sn': SN,
+    },
+    'mediaTypes': {
+      'video': {
+        'context': 'instream',
+        'mimes': ['video/mp4'],
+        'protocols': [1, 2, 3, 4, 5, 6],
+        'playbackmethod': [2],
+        'skip': 1
+      }
+    },
+  };
+  const validBidSpaceVastNoContext = {
+    'bidder': 'eplanning',
+    'bidId': BID_ID,
+    'params': {
+      'ci': CI,
+      'sn': SN,
+    },
+    'mediaTypes': {
+      'video': {
+        'mimes': ['video/mp4'],
+        'protocols': [1, 2, 3, 4, 5, 6],
+        'playbackmethod': [2],
+        'skip': 1
+      }
+    },
+  };
   const validBidView = {
     'bidder': 'eplanning',
     'bidId': BID_ID,
@@ -145,6 +254,14 @@ describe('E-Planning Adapter', function () {
       }
     }
   };
+  const validBidNoSize = {
+    'bidder': 'eplanning',
+    'bidId': BID_ID,
+    'params': {
+      'ci': CI,
+      'sn': SN,
+    }
+  };
   const response = {
     body: {
       'sI': {
@@ -176,6 +293,68 @@ describe('E-Planning Adapter', function () {
       ]
     }
   };
+  const responseVast = {
+    body: {
+      'sI': {
+        'k': '12345'
+      },
+      'sec': {
+        'k': 'ROS'
+      },
+      'sp': [{
+        'k': CLEAN_ADUNIT_CODE_VAST,
+        'a': [{
+          'adm': ADM_VAST,
+          'id': '7854abc56248f874',
+          'i': I_ID,
+          'fi': '7854abc56248f872',
+          'ip': '45621afd87462104',
+          'w': W,
+          'h': H,
+          'crid': CRID,
+          'pr': CPM
+        }],
+      }],
+      'cs': [
+        'http://a-sync-url.com/',
+        {
+          'u': 'http://another-sync-url.com/test.php?&partner=123456&endpoint=us-east',
+          'ifr': true
+        }
+      ]
+    }
+  };
+  const responseVastVV1 = {
+    body: {
+      'sI': {
+        'k': '12345'
+      },
+      'sec': {
+        'k': 'ROS'
+      },
+      'sp': [{
+        'k': CLEAN_ADUNIT_CODE_VAST,
+        'a': [{
+          'adm': ADM_VAST_VV_1,
+          'id': '7854abc56248f874',
+          'i': I_ID,
+          'fi': '7854abc56248f872',
+          'ip': '45621afd87462104',
+          'w': W,
+          'h': H,
+          'crid': CRID,
+          'pr': CPM
+        }],
+      }],
+      'cs': [
+        'http://a-sync-url.com/',
+        {
+          'u': 'http://another-sync-url.com/test.php?&partner=123456&endpoint=us-east',
+          'ifr': true
+        }
+      ]
+    }
+  };
   const responseWithTwoAdunits = {
     body: {
       'sI': {
@@ -411,6 +590,77 @@ describe('E-Planning Adapter', function () {
       expect(e).to.equal('300x250_0:300x250,300x600+100x100_0:100x100');
     });
 
+    it('should return correct e parameter with support vast with one space with size outstream', function () {
+      let bidRequests = [validBidSpaceOutstream];
+      const data = spec.buildRequests(bidRequests, bidderRequest).data;
+      expect(data.e).to.equal('video_300x600_0:300x600;1');
+      expect(data.vctx).to.equal(2);
+      expect(data.vv).to.equal(3);
+    });
+
+    it('should correctly return the e parameter with n sizes in playerSize', function () {
+      let bidRequests = [validBidOutstreamNSizes];
+      const data = spec.buildRequests(bidRequests, bidderRequest).data;
+      expect(data.e).to.equal('video_300x600_0:300x600;1');
+      expect(data.vctx).to.equal(2);
+      expect(data.vv).to.equal(3);
+    });
+
+    it('should correctly return the e parameter with invalid sizes in playerSize', function () {
+      let bidRequests = [bidOutstreamInvalidSizes];
+      const data = spec.buildRequests(bidRequests, bidderRequest).data;
+      expect(data.e).to.equal('video_' + DEFAULT_SIZE_VAST + '_0:' + DEFAULT_SIZE_VAST + ';1');
+      expect(data.vctx).to.equal(2);
+      expect(data.vv).to.equal(3);
+    });
+
+    it('should return correct e parameter with support vast with one space with size default outstream', function () {
+      let bidRequests = [validBidOutstreamNoSize];
+      const data = spec.buildRequests(bidRequests, bidderRequest).data;
+      expect(data.e).to.equal('video_640x480_0:640x480;1');
+      expect(data.vctx).to.equal(2);
+      expect(data.vv).to.equal(3);
+    });
+
+    it('should return correct e parameter with support vast with one space with size instream', function () {
+      let bidRequests = [validBidSpaceInstream];
+      const data = spec.buildRequests(bidRequests, bidderRequest).data;
+      expect(data.e).to.equal('video_640x480_0:640x480;1');
+      expect(data.vctx).to.equal(1);
+      expect(data.vv).to.equal(3);
+    });
+
+    it('should return correct e parameter with support vast with one space with size default and vctx default', function () {
+      let bidRequests = [validBidSpaceVastNoContext];
+      const data = spec.buildRequests(bidRequests, bidderRequest).data;
+      expect(data.e).to.equal('video_640x480_0:640x480;1');
+      expect(data.vctx).to.equal(1);
+      expect(data.vv).to.equal(3);
+    });
+
+    it('if 2 bids arrive, one outstream and the other instream, instream has more priority', function () {
+      let bidRequests = [validBidSpaceOutstream, validBidSpaceInstream];
+      const data = spec.buildRequests(bidRequests, bidderRequest).data;
+      expect(data.e).to.equal('video_640x480_0:640x480;1');
+      expect(data.vctx).to.equal(1);
+      expect(data.vv).to.equal(3);
+    });
+    it('if 2 bids arrive, one outstream and another banner, outstream has more priority', function () {
+      let bidRequests = [validBidSpaceOutstream, validBidSpaceName];
+      const data = spec.buildRequests(bidRequests, bidderRequest).data;
+      expect(data.e).to.equal('video_300x600_0:300x600;1');
+      expect(data.vctx).to.equal(2);
+      expect(data.vv).to.equal(3);
+    });
+
+    it('should return correct e parameter with support vast with one space outstream', function () {
+      let bidRequests = [validBidSpaceOutstream, validBidOutstreamNoSize];
+      const data = spec.buildRequests(bidRequests, bidderRequest).data;
+      expect(data.e).to.equal('video_300x600_0:300x600;1+video_640x480_1:640x480;1');
+      expect(data.vctx).to.equal(2);
+      expect(data.vv).to.equal(3);
+    });
+
     it('should return correct e parameter with linear mapping attribute with more than one adunit', function () {
       let bidRequestsML = [validBidMappingLinear];
       const NEW_CODE = ADUNIT_CODE + '2';
@@ -588,6 +838,40 @@ describe('E-Planning Adapter', function () {
       };
       expect(bidResponse).to.deep.equal(expectedResponse);
     });
+
+    it('should correctly map the parameters in the response vast', function () {
+      const bidResponse = spec.interpretResponse(responseVast, { adUnitToBidId: { [CLEAN_ADUNIT_CODE_VAST]: BID_ID } })[0];
+      const expectedResponse = {
+        requestId: BID_ID,
+        cpm: CPM,
+        width: W,
+        height: H,
+        ttl: 120,
+        creativeId: CRID,
+        netRevenue: true,
+        currency: 'USD',
+        vastXml: ADM_VAST,
+        mediaTypes: VIDEO
+      };
+      expect(bidResponse).to.deep.equal(expectedResponse);
+    });
+
+    it('should correctly map the parameters in the response vast vv 1', function () {
+      const bidResponse = spec.interpretResponse(responseVastVV1, { adUnitToBidId: { [CLEAN_ADUNIT_CODE_VAST]: BID_ID } })[0];
+      const expectedResponse = {
+        requestId: BID_ID,
+        cpm: CPM,
+        width: W,
+        height: H,
+        ttl: 120,
+        creativeId: CRID,
+        netRevenue: true,
+        currency: 'USD',
+        vastXml: ADM_VAST_VV_1,
+        mediaTypes: VIDEO
+      };
+      expect(bidResponse).to.deep.equal(expectedResponse);
+    });
   });
 
   describe('getUserSyncs', function () {
@@ -1029,7 +1313,7 @@ describe('E-Planning Adapter', function () {
       sandbox.restore();
     })
 
-    it('should add eids to the request ', function() {
+    it('should add eids to the request', function() {
       let bidRequests = [validBidView];
       const expected_id5id = encodeURIComponent(JSON.stringify({ uid: 'ID5-ZHMOL_IfFSt7_lVYX8rBZc6GH3XMWyPQOBUfr4bm0g!', ext: { linkType: 1 } }));
       const request = spec.buildRequests(bidRequests, bidderRequest);