prebid.js 5.16.0 → 5.20.0

package/test/spec/modules/mediakeysBidAdapter_spec.js

@@ -1,9 +1,11 @@
 import { expect } from 'chai';
+import find from 'core-js-pure/features/array/find.js';
 import { spec } from 'modules/mediakeysBidAdapter.js';
 import { newBidder } from 'src/adapters/bidderFactory.js';
 import * as utils from 'src/utils.js';
 import { config } from 'src/config.js';
 import { BANNER, NATIVE, VIDEO } from '../../../src/mediaTypes.js';
+import { OUTSTREAM } from '../../../src/video.js';
 
 describe('mediakeysBidAdapter', function () {
   const adapter = newBidder(spec);
@@ -39,39 +41,100 @@ describe('mediakeysBidAdapter', function () {
     }
   };
 
+  const bidNative = {
+    bidder: 'mediakeys',
+    params: {},
+    mediaTypes: {
+      native: {
+        body: {
+          required: true
+        },
+        title: {
+          required: true,
+          len: 800
+        },
+        sponsoredBy: {
+          required: true
+        },
+        body2: {
+          required: true
+        },
+        image: {
+          required: true,
+          sizes: [[300, 250], [300, 600], [100, 150]],
+        },
+        icon: {
+          required: true,
+          sizes: [50, 50],
+        },
+      },
+    },
+    nativeParams: {
+      body: {
+        required: true
+      },
+      title: {
+        required: true,
+        len: 800
+      },
+      sponsoredBy: {
+        required: true
+      },
+      body2: {
+        required: true
+      },
+      image: {
+        required: true,
+        sizes: [[300, 250], [300, 600], [100, 150]],
+      },
+      icon: {
+        required: true,
+        sizes: [50, 50],
+      },
+    },
+    adUnitCode: 'div-gpt-ad-1460505748561-0',
+    transactionId: '47789656-9e5c-4250-b7e0-2ce4cbe71a55',
+    bidId: '299320f4de980d',
+    bidderRequestId: '1c1b642f803242',
+    auctionId: '84212956-c377-40e8-b000-9885a06dc692',
+    src: 'client',
+    bidRequestsCount: 1,
+    bidderRequestsCount: 1,
+    bidderWinsCount: 0,
+    ortb2Imp: {
+      ext: { data: { something: 'test' } }
+    }
+  };
+
+  const bidVideo = {
+    bidder: 'mediakeys',
+    params: {},
+    mediaTypes: {
+      video: {
+        context: OUTSTREAM,
+        playerSize: [480, 320]
+      }
+    },
+    adUnitCode: 'div-gpt-ad-1460505748561-0',
+    transactionId: '47789656-9e5c-4250-b7e0-2ce4cbe71a55',
+    bidId: '299320f4de980d',
+    bidderRequestId: '1c1b642f803242',
+    auctionId: '84212956-c377-40e8-b000-9885a06dc692',
+    src: 'client',
+    bidRequestsCount: 1,
+    bidderRequestsCount: 1,
+    bidderWinsCount: 0,
+    ortb2Imp: {
+      ext: { data: { something: 'test' } }
+    }
+  };
+
   const bidderRequest = {
     bidderCode: 'mediakeys',
     auctionId: '84212956-c377-40e8-b000-9885a06dc692',
     bidderRequestId: '1c1b642f803242',
     bids: [
-      {
-        bidder: 'mediakeys',
-        params: {},
-        mediaTypes: {
-          banner: {
-            sizes: [
-              [300, 250],
-              [300, 600],
-            ],
-          },
-        },
-        adUnitCode: 'div-gpt-ad-1460505748561-0',
-        transactionId: '47789656-9e5c-4250-b7e0-2ce4cbe71a55',
-        sizes: [
-          [300, 250],
-          [300, 600],
-        ],
-        bidId: '299320f4de980d',
-        bidderRequestId: '1c1b642f803242',
-        auctionId: '84212956-c377-40e8-b000-9885a06dc692',
-        src: 'client',
-        bidRequestsCount: 1,
-        bidderRequestsCount: 1,
-        bidderWinsCount: 0,
-        ortb2Imp: {
-          ext: { data: { something: 'test' } }
-        }
-      },
+      bid
     ],
     auctionStart: 1620973766319,
     timeout: 1000,
@@ -116,23 +179,25 @@ describe('mediakeysBidAdapter', function () {
     it('should create imp for supported mediaType only', function() {
       const bidRequests = [utils.deepClone(bid)];
       const bidderRequestCopy = utils.deepClone(bidderRequest);
+      bidderRequestCopy.bids = bidRequests;
 
       bidRequests[0].mediaTypes.video = {
         playerSize: [300, 250],
-        context: 'outstream'
+        context: OUTSTREAM
       }
 
-      bidRequests[0].mediaTypes.native = {
-        type: 'image'
-      }
+      bidRequests[0].mediaTypes.native = bidNative.mediaTypes.native;
+      bidRequests[0].nativeParams = bidNative.mediaTypes.native;
+
+      bidderRequestCopy.bids = bidRequests[0];
 
       const request = spec.buildRequests(bidRequests, bidderRequestCopy);
       const data = request.data;
 
       expect(data.imp.length).to.equal(1);
       expect(data.imp[0].banner).to.exist;
-      expect(data.imp[0].video).to.not.exist;
-      expect(data.imp[0].native).to.not.exist;
+      expect(data.imp[0].video).to.exist;
+      expect(data.imp[0].native).to.exist;
     });
 
     it('should get expected properties with default values (no params set)', function () {
@@ -161,6 +226,205 @@ describe('mediakeysBidAdapter', function () {
       expect(data.imp[0].ext.data.something).to.equal('test');
     });
 
+    describe('native imp', function() {
+      it('should get a native object in request', function() {
+        const bidRequests = [utils.deepClone(bidNative)];
+        const bidderRequestCopy = utils.deepClone(bidderRequest);
+        bidderRequestCopy.bids = bidRequests;
+
+        const request = spec.buildRequests(bidRequests, bidderRequestCopy);
+        const data = request.data;
+
+        expect(data.imp.length).to.equal(1);
+        expect(data.imp[0].id).to.equal(bidRequests[0].bidId);
+        expect(data.imp[0].native).to.exist;
+        expect(data.imp[0].native.request.ver).to.equal('1.2');
+        expect(data.imp[0].native.request.context).to.equal(1);
+        expect(data.imp[0].native.request.plcmttype).to.equal(1);
+        expect(data.imp[0].native.request.assets.length).to.equal(6);
+        // find the asset body
+        const bodyAsset = find(data.imp[0].native.request.assets, asset => asset.id === 6);
+        expect(bodyAsset.data.type).to.equal(2);
+      });
+
+      it('should get a native object in request with properties filled with params values', function() {
+        const bidRequests = [utils.deepClone(bidNative)];
+        bidRequests[0].params = {
+          native: {
+            context: 3,
+            plcmttype: 3,
+          }
+        }
+        const bidderRequestCopy = utils.deepClone(bidderRequest);
+        bidderRequestCopy.bids = bidRequests;
+
+        const request = spec.buildRequests(bidRequests, bidderRequestCopy);
+        const data = request.data;
+
+        expect(data.imp.length).to.equal(1);
+        expect(data.imp[0].id).to.equal(bidRequests[0].bidId);
+        expect(data.imp[0].native).to.exist;
+        expect(data.imp[0].native.request.ver).to.equal('1.2');
+        expect(data.imp[0].native.request.context).to.equal(3);
+        expect(data.imp[0].native.request.plcmttype).to.equal(3);
+        expect(data.imp[0].native.request.assets.length).to.equal(6);
+      });
+
+      it('should get a native object in request when native type ,image" has been set', function() {
+        const bidRequests = [utils.deepClone(bidNative)];
+        bidRequests[0].mediaTypes.native = { type: 'image' };
+        bidRequests[0].nativeParams = {
+          image: { required: true },
+          title: { required: true },
+          sponsoredBy: { required: true },
+          clickUrl: { required: true }, // [1] Will be ignored as it is used in response validation only
+          body: { required: false },
+          icon: { required: false },
+        };
+
+        const bidderRequestCopy = utils.deepClone(bidderRequest);
+        bidderRequestCopy.bids = bidRequests;
+
+        const request = spec.buildRequests(bidRequests, bidderRequestCopy);
+        const data = request.data;
+
+        expect(data.imp.length).to.equal(1);
+        expect(data.imp[0].id).to.equal(bidRequests[0].bidId);
+        expect(data.imp[0].native).to.exist;
+        expect(data.imp[0].native.request.ver).to.equal('1.2');
+        expect(data.imp[0].native.request.context).to.equal(1);
+        expect(data.imp[0].native.request.plcmttype).to.equal(1);
+        expect(data.imp[0].native.request.assets.length).to.equal(5); // [1] clickUrl ignored
+      });
+
+      it('should log errors and ignore misformated assets', function() {
+        const bidRequests = [utils.deepClone(bidNative)];
+        delete bidRequests[0].nativeParams.title.len;
+        bidRequests[0].nativeParams.unregistred = {required: true};
+
+        const bidderRequestCopy = utils.deepClone(bidderRequest);
+        bidderRequestCopy.bids = bidRequests;
+
+        utilsMock.expects('logWarn').twice();
+
+        const request = spec.buildRequests(bidRequests, bidderRequestCopy);
+        const data = request.data;
+
+        expect(data.imp.length).to.equal(1);
+        expect(data.imp[0].id).to.equal(bidRequests[0].bidId);
+        expect(data.imp[0].native).to.exist;
+        expect(data.imp[0].native.request.assets.length).to.equal(5);
+      });
+    });
+
+    describe('video imp', function() {
+      it('should get a video object in request', function() {
+        const bidRequests = [utils.deepClone(bidVideo)];
+        const bidderRequestCopy = utils.deepClone(bidderRequest);
+        bidderRequestCopy.bids = bidRequests;
+
+        const request = spec.buildRequests(bidRequests, bidderRequestCopy);
+        const data = request.data;
+
+        expect(data.imp.length).to.equal(1);
+        expect(data.imp[0].id).to.equal(bidRequests[0].bidId);
+        expect(data.imp[0].banner).to.not.exist;
+        expect(data.imp[0].video).to.exist;
+        expect(data.imp[0].video.w).to.equal(480);
+        expect(data.imp[0].video.h).to.equal(320);
+      });
+
+      it('should ignore and warn misformated ORTB video properties', function() {
+        const bidRequests = [utils.deepClone(bidVideo)];
+        bidRequests[0].mediaTypes.video.unknown = 'foo';
+        bidRequests[0].mediaTypes.video.placement = 10;
+        bidRequests[0].mediaTypes.video.skipmin = 5;
+        const bidderRequestCopy = utils.deepClone(bidderRequest);
+        bidderRequestCopy.bids = bidRequests;
+
+        const request = spec.buildRequests(bidRequests, bidderRequestCopy);
+        const data = request.data;
+
+        expect(data.imp.length).to.equal(1);
+        expect(data.imp[0].id).to.equal(bidRequests[0].bidId);
+        expect(data.imp[0].banner).to.not.exist;
+        expect(data.imp[0].video).to.exist;
+        expect(data.imp[0].video.w).to.equal(480);
+        expect(data.imp[0].video.h).to.equal(320);
+        expect(data.imp[0].video.skipmin).to.equal(5);
+        expect(data.imp[0].video.placement).to.not.exist;
+        expect(data.imp[0].video.unknown).to.not.exist;
+      });
+
+      it('should merge adUnit mediaTypes level and bidder level params properties ', function() {
+        const bidRequests = [utils.deepClone(bidVideo)];
+        bidRequests[0].mediaTypes.video.placement = 1;
+        bidRequests[0].mediaTypes.video.mimes = ['video/mpeg4'];
+        bidRequests[0].mediaTypes.video.protocols = [1];
+        bidRequests[0].mediaTypes.video.minduration = 10;
+        bidRequests[0].mediaTypes.video.maxduration = 45;
+        bidRequests[0].mediaTypes.video.skipmin = 5;
+        bidRequests[0].mediaTypes.video.sequence = 3;
+        bidRequests[0].mediaTypes.video.linearity = 1;
+        bidRequests[0].mediaTypes.video.battr = [12];
+        bidRequests[0].mediaTypes.video.maxextended = 10;
+        bidRequests[0].mediaTypes.video.minbitrate = 720;
+        bidRequests[0].mediaTypes.video.maxbitrate = 720;
+        bidRequests[0].mediaTypes.video.boxingallowed = 1;
+        bidRequests[0].mediaTypes.video.playbackmethod = [1];
+        bidRequests[0].mediaTypes.video.playbackend = 2;
+        bidRequests[0].mediaTypes.video.delivery = 2;
+        bidRequests[0].mediaTypes.video.pos = 0;
+        bidRequests[0].mediaTypes.video.companionad = [{ w: 360, h: 80 }]
+        bidRequests[0].mediaTypes.video.api = [1];
+        bidRequests[0].mediaTypes.video.companiontype = [1];
+
+        // bidder level
+        bidRequests[0].params.video = {
+          pos: 2, // override
+          skip: 1,
+          skipafter: 10,
+          startdelay: 3
+        };
+
+        const bidderRequestCopy = utils.deepClone(bidderRequest);
+        bidderRequestCopy.bids = bidRequests;
+
+        utilsMock.expects('logWarn').never();
+
+        const request = spec.buildRequests(bidRequests, bidderRequestCopy);
+        const data = request.data;
+
+        expect(data.imp.length).to.equal(1);
+        expect(data.imp[0].id).to.equal(bidRequests[0].bidId);
+        expect(data.imp[0].banner).to.not.exist;
+        expect(data.imp[0].video).to.exist;
+
+        expect(Object.keys(data.imp[0].video).length).to.equal(23); // 21 ortb params (2 skipped) + computed width/height.
+        expect(data.imp[0].video.w).to.equal(480);
+        expect(data.imp[0].video.h).to.equal(320);
+        expect(data.imp[0].video.mimes[0]).to.equal('video/mpeg4');
+        expect(data.imp[0].video.pos).to.equal(2);
+        expect(data.imp[0].video.skip).to.equal(1);
+        expect(data.imp[0].video.skipafter).to.equal(10);
+        expect(data.imp[0].video.startdelay).to.equal(3);
+        expect(data.imp[0].video.companionad).to.not.exist;
+        expect(data.imp[0].video.companiontype).to.not.exist;
+      });
+
+      it('should log warn message when OpenRTB validation fails ', function() {
+        const bidRequests = [utils.deepClone(bidVideo)];
+        bidRequests[0].mediaTypes.video.placement = 'string';
+        bidRequests[0].mediaTypes.video.api = 1;
+        const bidderRequestCopy = utils.deepClone(bidderRequest);
+        bidderRequestCopy.bids = bidRequests;
+
+        utilsMock.expects('logWarn').twice();
+
+        spec.buildRequests(bidRequests, bidderRequestCopy);
+      });
+    });
+
     it('should get expected properties with values from params', function () {
       const bidRequests = [utils.deepClone(bid)];
       bidRequests[0].params = {
@@ -265,13 +529,25 @@ describe('mediakeysBidAdapter', function () {
         expect(data.imp[0].bidfloor).to.not.exist;
       });
 
-      it('should get and set floor by mediatype', function() {
+      it('should get the highest floorPrice found when bid have several mediaTypes', function() {
         const bidWithPriceFloors = utils.deepClone(bid);
 
         bidWithPriceFloors.mediaTypes.video = {
           playerSize: [600, 480]
         };
 
+        bidWithPriceFloors.mediaTypes.native = {
+          body: {
+            required: true
+          }
+        };
+
+        bidWithPriceFloors.nativeParams = {
+          body: {
+            required: true
+          }
+        };
+
         bidWithPriceFloors.getFloor = getFloorTest;
 
         const bidRequests = [bidWithPriceFloors];
@@ -279,10 +555,9 @@ describe('mediakeysBidAdapter', function () {
         const data = request.data;
 
         expect(data.imp[0].banner).to.exist;
-        expect(data.imp[0].bidfloor).to.equal(1);
-
-        // expect(data.imp[1].video).to.exist;
-        // expect(data.imp[1].bidfloor).to.equal(5);
+        expect(data.imp[0].video).to.exist;
+        expect(data.imp[0].native).to.exist;
+        expect(data.imp[0].bidfloor).to.equal(5);
       });
 
       it('should set properties at payload level from FPD', function() {
@@ -420,8 +695,8 @@ describe('mediakeysBidAdapter', function () {
       const bidRequests = [utils.deepClone(bid)];
       const request = spec.buildRequests(bidRequests, bidderRequest);
       sinon.stub(utils, 'isArray').throws();
-      spec.interpretResponse(rawServerResponse, request);
       utilsMock.expects('logError').once();
+      spec.interpretResponse(rawServerResponse, request);
       utils.isArray.restore();
     });
 
@@ -483,28 +758,108 @@ describe('mediakeysBidAdapter', function () {
       });
     });
 
-    it('Build video response', function () {
-      const bidRequests = [utils.deepClone(bid)];
+    it('interprets video bid response', function () {
+      const vastUrl = 'https://url.local?req=content';
+      const bidRequests = [utils.deepClone(bidVideo)];
       const request = spec.buildRequests(bidRequests, bidderRequest);
+
       const rawServerResponseVideo = utils.deepClone(rawServerResponse);
       rawServerResponseVideo.body.seatbid[0].bid[0].ext.prebid.type = 'V';
+      rawServerResponseVideo.body.seatbid[0].bid[0].ext.vast_url = vastUrl;
+
       const response = spec.interpretResponse(rawServerResponseVideo, request);
 
       expect(response.length).to.equal(1);
       expect(response[0].mediaType).to.equal('video');
       expect(response[0].meta.mediaType).to.equal('video');
+      expect(response[0].vastXml).to.not.exist;
+      expect(response[0].vastUrl).to.equal(vastUrl + '&no_cache');
+      expect(response[0].videoCacheKey).to.equal('no_cache');
     });
 
-    it('Build native response', function () {
-      const bidRequests = [utils.deepClone(bid)];
-      const request = spec.buildRequests(bidRequests, bidderRequest);
-      const rawServerResponseVideo = utils.deepClone(rawServerResponse);
-      rawServerResponseVideo.body.seatbid[0].bid[0].ext.prebid.type = 'N';
-      const response = spec.interpretResponse(rawServerResponseVideo, request);
+    describe('Native response', function () {
+      let bidRequests;
+      let bidderRequestCopy;
+      let request;
+      let rawServerResponseNative;
+      let nativeObject;
+
+      beforeEach(function() {
+        bidRequests = [utils.deepClone(bidNative)];
+        bidderRequestCopy = utils.deepClone(bidderRequest);
+        bidderRequestCopy.bids = bidRequests;
+
+        request = spec.buildRequests(bidRequests, bidderRequestCopy);
+
+        nativeObject = {
+          ver: '1.2',
+          privacy: 'https://privacy.me',
+          assets: [
+            { id: 5, data: { type: 1, value: 'Sponsor Brand' } },
+            { id: 6, data: { type: 2, value: 'Brand Body' } },
+            { id: 14, data: { type: 10, value: 'Brand Body 2' } },
+            { id: 1, title: { text: 'Brand Title' } },
+            { id: 2, img: { type: 3, url: 'https://url.com/img.jpg', w: 300, h: 250 } },
+            { id: 3, img: { type: 1, url: 'https://url.com/ico.png', w: 50, h: 50 } },
+          ],
+          link: {
+            url: 'https://brand.me',
+            clicktrackers: [
+              'https://click.me'
+            ]
+          },
+          eventtrackers: [
+            { event: 1, method: 1, url: 'https://click.me' },
+            { event: 1, method: 2, url: 'https://click-script.me' }
+          ]
+        };
 
-      expect(response.length).to.equal(1);
-      expect(response[0].mediaType).to.equal('native');
-      expect(response[0].meta.mediaType).to.equal('native');
+        rawServerResponseNative = utils.deepClone(rawServerResponse);
+        rawServerResponseNative.body.seatbid[0].bid[0].ext.prebid.type = 'N';
+        rawServerResponseNative.body.seatbid[0].bid[0].adm = JSON.stringify(nativeObject)
+      });
+
+      it('should ignore invalid native response', function() {
+        const nativeObjectCopy = utils.deepClone(nativeObject);
+        nativeObjectCopy.assets = [];
+        const rawServerResponseNativeCopy = utils.deepClone(rawServerResponseNative);
+        rawServerResponseNativeCopy.body.seatbid[0].bid[0].adm = JSON.stringify(nativeObjectCopy)
+        const response = spec.interpretResponse(rawServerResponseNativeCopy, request);
+        expect(response.length).to.equal(1);
+        expect(response[0].native).to.not.exist;
+      });
+
+      it('should build a classic Prebid.js native object for response', function() {
+        const rawServerResponseNativeCopy = utils.deepClone(rawServerResponseNative);
+        const response = spec.interpretResponse(rawServerResponseNativeCopy, request);
+        expect(response.length).to.equal(1);
+        expect(response[0].mediaType).to.equal('native');
+        expect(response[0].meta.mediaType).to.equal('native');
+        expect(response[0].native).to.exist;
+        expect(response[0].native.body).to.exist;
+        expect(response[0].native.privacyLink).to.exist;
+        expect(response[0].native.body2).to.exist;
+        expect(response[0].native.sponsoredBy).to.exist;
+        expect(response[0].native.image).to.exist;
+        expect(response[0].native.icon).to.exist;
+        expect(response[0].native.title).to.exist;
+        expect(response[0].native.clickUrl).to.exist;
+        expect(response[0].native.clickTrackers).to.exist;
+        expect(response[0].native.clickTrackers.length).to.equal(1);
+        expect(response[0].native.javascriptTrackers).to.equal('<script src="https://click-script.me"></script>');
+        expect(response[0].native.impressionTrackers).to.exist;
+        expect(response[0].native.impressionTrackers.length).to.equal(1);
+      });
+
+      it('should ignore eventtrackers with a unsupported type', function() {
+        const rawServerResponseNativeCopy = utils.deepClone(rawServerResponseNative);
+        const nativeObjectCopy = utils.deepClone(nativeObject);
+        nativeObjectCopy.eventtrackers[0].event = 2;
+        rawServerResponseNativeCopy.body.seatbid[0].bid[0].adm = JSON.stringify(nativeObjectCopy);
+        const response = spec.interpretResponse(rawServerResponseNativeCopy, request);
+        expect(response[0].native.impressionTrackers).to.exist;
+        expect(response[0].native.impressionTrackers.length).to.equal(0);
+      })
     });
   });