Adagio Bid Adapter: hotfix - detect support for intersectionObserver (p…

…rebid#6095) * Detect support for intersectionObserver * Fix IE11 * Add special params for non standard integration * Stronger IntersectionObserver detection * Fix test and add new params to .md file
cointraffic · May 28, 2021 · 6ee35fc · 6ee35fc
1 parent c3780a6
commit 6ee35fc
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 6 deletions.
diff --git a/modules/adagioBidAdapter.js b/modules/adagioBidAdapter.js
@@ -495,6 +495,12 @@ function autoDetectEnvironment() {
   return environment;
 };
 
+function supportIObs() {
+  const currentWindow = internal.getCurrentWindow();
+  return !!(currentWindow && currentWindow.IntersectionObserver && currentWindow.IntersectionObserverEntry &&
+    currentWindow.IntersectionObserverEntry.prototype && 'intersectionRatio' in currentWindow.IntersectionObserverEntry.prototype);
+}
+
 function getFeatures(bidRequest, bidderRequest) {
   const { adUnitCode, params } = bidRequest;
   const { adUnitElementId } = params;
@@ -569,6 +575,7 @@ export const internal = {
   getRefererInfo,
   adagioScriptFromLocalStorageCb,
   getCurrentWindow,
+  supportIObs,
   canAccessTopWindow,
   isRendererPreferredFromPublisher
 };
@@ -692,15 +699,21 @@ export const spec = {
       return false;
     }
 
-    const { organizationId, site, placement } = params;
-    const adUnitElementId = params.adUnitElementId || internal.autoDetectAdUnitElementId(adUnitCode);
+    const { organizationId, site } = params;
+    const adUnitElementId = (params.useAdUnitCodeAsAdUnitElementId === true)
+      ? adUnitCode
+      : params.adUnitElementId || internal.autoDetectAdUnitElementId(adUnitCode);
+    const placement = (params.useAdUnitCodeAsPlacement === true) ? adUnitCode : params.placement;
     const environment = params.environment || internal.autoDetectEnvironment();
+    const supportIObs = internal.supportIObs();
 
     // insure auto-detected params are kept in `bid` object.
     bid.params = {
       ...params,
       adUnitElementId,
-      environment
+      environment,
+      placement,
+      supportIObs
     };
 
     const debugData = () => ({

diff --git a/modules/adagioBidAdapter.md b/modules/adagioBidAdapter.md
@@ -38,6 +38,8 @@ Connects to Adagio demand source to fetch bids.
             category: 'sport', // Recommended. Category of the content displayed in the page.
             subcategory: 'handball', // Optional. Subcategory of the content displayed in the page.
             postBid: false, // Optional. Use it in case of Post-bid integration only.
+            useAdUnitCodeAsAdUnitElementId: false // Optional. Use it by-pass adUnitElementId and use the adUnit code as value
+            useAdUnitCodeAsPlacement: false // Optional. Use it to by-pass placement and use the adUnit code as value
             // Optional debug mode, used to get a bid response with expected cpm.
             debug: {
               enabled: true,
@@ -76,6 +78,8 @@ Connects to Adagio demand source to fetch bids.
             category: 'sport', // Recommended. Category of the content displayed in the page.
             subcategory: 'handball', // Optional. Subcategory of the content displayed in the page.
             postBid: false, // Optional. Use it in case of Post-bid integration only.
+            useAdUnitCodeAsAdUnitElementId: false // Optional. Use it by-pass adUnitElementId and use the adUnit code as value
+            useAdUnitCodeAsPlacement: false // Optional. Use it to by-pass placement and use the adUnit code as value
             video: {
               skip: 0
               // OpenRTB 2.5 video options defined here override ones defined in mediaTypes.

diff --git a/test/spec/modules/adagioBidAdapter_spec.js b/test/spec/modules/adagioBidAdapter_spec.js
@@ -144,6 +144,19 @@ describe('Adagio bid adapter', () => {
       sinon.assert.callCount(utils.logWarn, 1);
     });
 
+    it('should use adUnit code for adUnitElementId and placement params', function() {
+      const bid01 = new BidRequestBuilder({ params: {
+        organizationId: '1000',
+        site: 'site-name',
+        useAdUnitCodeAsPlacement: true,
+        useAdUnitCodeAsAdUnitElementId: true
+      }}).build();
+
+      expect(spec.isBidRequestValid(bid01)).to.equal(true);
+      expect(bid01.params.adUnitElementId).to.equal('adunit-code');
+      expect(bid01.params.placement).to.equal('adunit-code');
+    })
+
     it('should return false when a required param is missing', function() {
       const bid01 = new BidRequestBuilder({ params: {
         organizationId: '1000',
@@ -229,7 +242,8 @@ describe('Adagio bid adapter', () => {
               placement: 'PAVE_ATF',
               site: 'SITE-NAME',
               adUnitElementId: 'gpt-adunit-code',
-              environment: 'desktop'
+              environment: 'desktop',
+              supportIObs: true
             }
           }],
           auctionId: '4fd1ca2d-846c-4211-b9e5-321dfe1709c9',
@@ -249,7 +263,8 @@ describe('Adagio bid adapter', () => {
               placement: 'PAVE_ATF',
               site: 'SITE-NAME',
               adUnitElementId: 'gpt-adunit-code',
-              environment: 'desktop'
+              environment: 'desktop',
+              supportIObs: true
             }
           }],
           auctionId: '4fd1ca2d-846c-4211-b9e5-321dfe1709c9',
@@ -260,6 +275,7 @@ describe('Adagio bid adapter', () => {
 
       it('should store bids config once by bid in window.top if it accessible', function() {
         sandbox.stub(adagio, 'getCurrentWindow').returns(window.top);
+        sandbox.stub(adagio, 'supportIObs').returns(true);
 
         // replace by the values defined in beforeEach
         window.top.ADAGIO = {
@@ -274,8 +290,22 @@ describe('Adagio bid adapter', () => {
         expect(find(window.top.ADAGIO.pbjsAdUnits, aU => aU.code === 'adunit-code-02')).to.deep.eql(expected[1]);
       });
 
+      it('should detect IntersectionObserver support', function() {
+        sandbox.stub(adagio, 'getCurrentWindow').returns(window.top);
+        sandbox.stub(adagio, 'supportIObs').returns(false);
+
+        window.top.ADAGIO = {
+          ...window.ADAGIO
+        };
+
+        spec.isBidRequestValid(bid01);
+        const validBidReq = find(window.top.ADAGIO.pbjsAdUnits, aU => aU.code === 'adunit-code-01');
+        expect(validBidReq.bids[0].params.supportIObs).to.equal(false);
+      });
+
       it('should store bids config once by bid in current window', function() {
         sandbox.stub(adagio, 'getCurrentWindow').returns(window.self);
+        sandbox.stub(adagio, 'supportIObs').returns(true);
 
         spec.isBidRequestValid(bid01);
         spec.isBidRequestValid(bid02);
@@ -740,7 +770,8 @@ describe('Adagio bid adapter', () => {
             pagetype: 'ARTICLE',
             category: 'NEWS',
             subcategory: 'SPORT',
-            environment: 'desktop'
+            environment: 'desktop',
+            supportIObs: true
           },
           adUnitCode: 'adunit-code',
           mediaTypes: {