Openx bid adapter: WIP deduplicate request #14477
+72
−59
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -416,16 +416,12 @@ describe('OpenxRtbAdapter', function () { | |
| playerSize: [640, 480] | ||
| }; | ||
| const requests = spec.buildRequests([multiformat], mockBidderRequest); | ||
| expect(requests).to.have.length(1); | ||
| expect(requests[0].data.imp).to.have.length(1); | ||
| expect(requests[0].data.imp[0].banner).to.exist; | ||
| expect(requests[0].data.imp[0].native).to.not.exist; | ||
| if (FEATURES.VIDEO) { | ||
| expect(requests[0].data.imp[0].video).to.exist; | ||
| } | ||
| }) | ||
|
|
||
|
|
@@ -454,21 +450,33 @@ describe('OpenxRtbAdapter', function () { | |
| sizes: [[300, 250]] | ||
| } | ||
| const requests = spec.buildRequests([multiformat], mockBidderRequest); | ||
| expect(requests).to.have.length(1); | ||
| expect(requests[0].data.imp).to.have.length(1); | ||
| expect(requests[0].data.imp[0].banner).to.exist; | ||
| if (FEATURES.NATIVE) { | ||
| expect(requests[0].data.imp[0].native).to.exist; | ||
| } | ||
| if (FEATURES.VIDEO) { | ||
| expect(requests[0].data.imp[0].video).to.exist; | ||
| } | ||
| }) | ||
|
|
||
| it('should send banner, video and native bids in a single HTTP request', function () { | ||
| const allBids = [...bidRequestsWithMediaTypes, nativeBidRequest]; | ||
| const request = spec.buildRequests(allBids, mockBidderRequest); | ||
| expect(request).to.have.length(1); | ||
| expect(request[0].data.imp).to.have.length(3); | ||
| expect(request[0].data.imp[0].banner).to.exist; | ||
| if (FEATURES.VIDEO) { | ||
| const videoImp = request[0].data.imp.find(imp => imp.id === bidRequestsWithMediaTypes[1].bidId); | ||
| expect(videoImp.video).to.exist; | ||
| } | ||
| if (FEATURES.NATIVE) { | ||
| const nativeImp = request[0].data.imp.find(imp => imp.id === nativeBidRequest.bidId); | ||
| expect(nativeImp.native).to.exist; | ||
| } | ||
| }); | ||
|
|
||
| it('should send bid request to openx url via POST', function () { | ||
| const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest); | ||
| expect(request[0].url).to.equal(REQUEST_URL); | ||
|
|
@@ -482,19 +490,26 @@ describe('OpenxRtbAdapter', function () { | |
| expect(request[0].data.ext.platformId).to.be.undefined; | ||
| }); | ||
|
|
||
| it('should send platform id from first bid, if available', function () { | ||
| bidRequestsWithMediaTypes[0].params.platform = '1cabba9e-cafe-3665-beef-f00f00f00f00'; | ||
| bidRequestsWithMediaTypes[1].params.platform = '51ca3159-abc2-4035-8e00-fe26eaa09397'; | ||
|
|
||
| const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest); | ||
| expect(request.length).to.equal(1); | ||
| expect(request[0].data.ext.platform).to.equal(bidRequestsWithMediaTypes[0].params.platform); | ||
| }); | ||
|
|
||
| it('should send delDomain from first bid when bids have different delDomains', function () { | ||
| bidRequestsWithMediaTypes[0].params.delDomain = 'domain-a.test'; | ||
| bidRequestsWithMediaTypes[1].params.delDomain = 'domain-b.test'; | ||
| const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest); | ||
| expect(request[0].data.ext.delDomain).to.equal('domain-a.test'); | ||
| }); | ||
|
|
||
| it('should send openx adunit codes', function () { | ||
| const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest); | ||
| expect(request[0].data.imp[0].tagid).to.equal(bidRequestsWithMediaTypes[0].params.unit); | ||
| expect(request[0].data.imp[1].tagid).to.equal(bidRequestsWithMediaTypes[1].params.unit); | ||
| }); | ||
|
|
||
| it('should send out custom params on bids that have customParams specified', function () { | ||
|
|
@@ -563,7 +578,7 @@ describe('OpenxRtbAdapter', function () { | |
| expect(request[0].data.imp[0].bidfloorcur).to.equal('USD'); | ||
| }); | ||
|
|
||
| it('should not send floors', function () { | ||
| adServerCurrencyStub.returns('EUR'); | ||
| const bidRequest = Object.assign({}, | ||
| bidRequestsWithMediaTypes[0], | ||
|
|
@@ -904,7 +919,6 @@ describe('OpenxRtbAdapter', function () { | |
| it('should send a signal to specify that US Privacy applies to this request', async function () { | ||
| const request = spec.buildRequests(bidRequests, await addFPDToBidderRequest(bidderRequest)); | ||
| expect(request[0].data.regs.ext.us_privacy).to.equal('1YYN'); | ||
| }); | ||
|
|
||
| it('should not send the regs object, when consent string is undefined', async function () { | ||
|
|
@@ -946,29 +960,25 @@ describe('OpenxRtbAdapter', function () { | |
| bidderRequest.bids = bidRequests; | ||
| const request = spec.buildRequests(bidRequests, await addFPDToBidderRequest(bidderRequest)); | ||
| expect(request[0].data.regs.ext.gdpr).to.equal(1); | ||
| }); | ||
|
|
||
| it('should send the consent string', async function () { | ||
| bidderRequest.bids = bidRequests; | ||
| const request = spec.buildRequests(bidRequests, await addFPDToBidderRequest(bidderRequest)); | ||
| expect(request[0].data.user.ext.consent).to.equal(bidderRequest.gdprConsent.consentString); | ||
| }); | ||
|
|
||
| it('should send the addtlConsent string', async function () { | ||
| bidderRequest.bids = bidRequests; | ||
| const request = spec.buildRequests(bidRequests, await addFPDToBidderRequest(bidderRequest)); | ||
| expect(request[0].data.user.ext.ConsentedProvidersSettings.consented_providers).to.equal(bidderRequest.gdprConsent.addtlConsent); | ||
| }); | ||
|
|
||
| it('should send a signal to specify that GDPR does not apply to this request', async function () { | ||
| bidderRequest.gdprConsent.gdprApplies = false; | ||
| bidderRequest.bids = bidRequests; | ||
| const request = spec.buildRequests(bidRequests, await addFPDToBidderRequest(bidderRequest)); | ||
| expect(request[0].data.regs.ext.gdpr).to.equal(0); | ||
| }); | ||
|
|
||
| it('when GDPR application is undefined, should not send a signal to specify whether GDPR applies to this request, ' + | ||
|
|
@@ -978,15 +988,14 @@ describe('OpenxRtbAdapter', function () { | |
| const request = spec.buildRequests(bidRequests, await addFPDToBidderRequest(bidderRequest)); | ||
| expect(request[0].data.regs?.ext?.gdpr).to.not.be.ok; | ||
| expect(request[0].data.user.ext.consent).to.equal(bidderRequest.gdprConsent.consentString); | ||
| }); | ||
|
|
||
| it('when consent string is undefined, should not send the consent string, ', async function () { | ||
| delete bidderRequest.gdprConsent.consentString; | ||
| bidderRequest.bids = bidRequests; | ||
| const request = spec.buildRequests(bidRequests, await addFPDToBidderRequest(bidderRequest)); | ||
| expect(request[0].data.imp[0].ext.consent).to.equal(undefined); | ||
| expect(request[0].data.imp[1].ext.consent).to.equal(undefined); | ||
| }); | ||
| }); | ||
|
|
||
|
|
@@ -1002,8 +1011,6 @@ describe('OpenxRtbAdapter', function () { | |
| const request = spec.buildRequests(bidRequests, bidderRequest); | ||
| expect(request[0].data.regs.gpp).to.equal('test-gpp-string'); | ||
| expect(request[0].data.regs.gpp_sid).to.deep.equal([6]); | ||
| }); | ||
|
|
||
| it('should not send GPP string and GPP section IDs in bid request when not available', async function () { | ||
|
|
@@ -1014,8 +1021,6 @@ describe('OpenxRtbAdapter', function () { | |
| const request = spec.buildRequests(bidRequests, bidderRequest); | ||
| expect(request[0].data.regs.gpp).to.not.exist; | ||
| expect(request[0].data.regs.gpp_sid).to.not.exist; | ||
| }); | ||
| }); | ||
| }); | ||
|
|
@@ -1251,7 +1256,7 @@ describe('OpenxRtbAdapter', function () { | |
| context('video', function () { | ||
| it('should send bid request with a mediaTypes specified with video type', function () { | ||
| const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest); | ||
| expect(request[0].data.imp[1]).to.have.any.keys(VIDEO); | ||
| }); | ||
|
|
||
| it('Update imp.video with OpenRTB options from mimeTypes and params', function() { | ||
|
|
@@ -1288,8 +1293,8 @@ describe('OpenxRtbAdapter', function () { | |
| h: 250 | ||
| }; | ||
| const requests = spec.buildRequests([bid01], bidderRequest); | ||
| expect(requests).to.have.lengthOf(1); | ||
| expect(requests[0].data.imp[0].video).to.deep.equal(expected); | ||
| }); | ||
| }); | ||
| } | ||
|
|
@@ -1573,6 +1578,7 @@ describe('OpenxRtbAdapter', function () { | |
| crid: 'test-creative-id', | ||
| dealid: 'test-deal-id', | ||
| adm: '<VAST version="4.0"><Ad></Ad></VAST>', | ||
| mtype: 2, | ||
|
There was a problem hiding this comment. The PR title indicates this is a "WIP" (Work In Progress). However, the code changes appear complete with proper test coverage. Please update the PR title to remove "WIP" if this is ready for review, or clarify what remaining work is needed before this can be merged. |
||
| }] | ||
| }], | ||
| cur: 'AUS' | ||
|
|
@@ -1693,6 +1699,39 @@ describe('OpenxRtbAdapter', function () { | |
| }); | ||
| } | ||
|
|
||
| context('when multiple bid requests (banner + video) are in one request and both bids are returned', function() { | ||
| it('should correctly return both banner and video bids', function () { | ||
| const bidRequestConfigs = [ | ||
| { | ||
| bidder: 'openx', params: { unit: '1', delDomain: 'test-del-domain' }, | ||
| adUnitCode: 'au-1', mediaTypes: { banner: { sizes: [[300, 250]] } }, | ||
| bidId: 'bid-id-banner', bidderRequestId: 'br-1', auctionId: 'a-1' | ||
| }, | ||
| { | ||
| bidder: 'openx', params: { unit: '2', delDomain: 'test-del-domain' }, | ||
| adUnitCode: 'au-2', mediaTypes: { video: { playerSize: [640, 480] } }, | ||
| bidId: 'bid-id-video', bidderRequestId: 'br-1', auctionId: 'a-1' | ||
| } | ||
| ]; | ||
| const bidRequest = spec.buildRequests(bidRequestConfigs, {refererInfo: {}})[0]; | ||
| const bidResponse = { | ||
| seatbid: [{ | ||
| bid: [ | ||
| { impid: 'bid-id-banner', price: 1, adm: '<div>ad</div>', mtype: 1 }, | ||
| { impid: 'bid-id-video', price: 2, adm: '<VAST/>', mtype: 2 } | ||
| ] | ||
| }], | ||
| cur: 'USD' | ||
| }; | ||
| const result = spec.interpretResponse({ body: bidResponse }, bidRequest); | ||
| expect(result.bids).to.have.length(2); | ||
| expect(result.bids[0].mediaType).to.equal(BANNER); | ||
| expect(result.bids[1].mediaType).to.equal(VIDEO); | ||
| expect(result.bids[0].requestId).to.equal('bid-id-banner'); | ||
| expect(result.bids[1].requestId).to.equal('bid-id-video'); | ||
| }); | ||
| }); | ||
|
|
||
| if (FEATURES.NATIVE) { | ||
| context('when native request and the response is a native', function() { | ||
| beforeEach(function () { | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The simplified request consolidation now uses only the first bid request's parameters for request-level fields (platform, delDomain, coppa, doNotTrack, response_template_name, test - see lines 60-78 of the converter configuration). If different bid requests specify different values for these parameters, only the first request's values will be used. Consider validating that all bid requests have consistent request-level parameters, or document this limitation so publishers understand these parameters must be consistent across all ad units in an auction.