Yieldmo adapter: cut banner bid request parameters in case the url fo…

…r bunner request is too long
prebid · Apr 8, 2021 · 8352d7f · 8352d7f
1 parent e33442d
commit 8352d7f
Show file tree

Hide file tree

Showing 2 changed files with 87 additions and 2 deletions.
diff --git a/modules/yieldmoBidAdapter.js b/modules/yieldmoBidAdapter.js
@@ -13,6 +13,8 @@ const VIDEO_SERVER_ENDPOINT = 'https://ads.yieldmo.com/exchange/prebidvideo';
 const OPENRTB_VIDEO_BIDPARAMS = ['placement', 'startdelay', 'skipafter',
   'protocols', 'api', 'playbackmethod', 'maxduration', 'minduration', 'pos'];
 const OPENRTB_VIDEO_SITEPARAMS = ['name', 'domain', 'cat', 'keywords'];
+const MAX_BANNER_REQUEST_URL_LENGTH = 8000;
+const BANNER_REQUEST_PROPERTIES_TO_REDUCE = ['description', 'title', 'pr', 'page_url'];
 const localWindow = utils.getWindowTop();
 
 export const spec = {
@@ -47,7 +49,7 @@ export const spec = {
         p: [],
         page_url: bidderRequest.refererInfo.referer,
         bust: new Date().getTime().toString(),
-        pr: bidderRequest.refererInfo.referer,
+        pr: (localWindow.document && localWindow.document.referrer) || '',
         scrd: localWindow.devicePixelRatio || 0,
         dnt: getDNT(),
         description: getPageDescription(),
@@ -88,6 +90,20 @@ export const spec = {
         }
       });
       serverRequest.p = '[' + serverRequest.p.toString() + ']';
+
+      // check if url exceeded max length
+      const url = `${BANNER_SERVER_ENDPOINT}?${utils.parseQueryStringParameters(serverRequest)}`;
+      let extraCharacters = url.length - MAX_BANNER_REQUEST_URL_LENGTH;
+      if (extraCharacters > 0) {
+        for (const property of BANNER_REQUEST_PROPERTIES_TO_REDUCE) {
+          extraCharacters = shortcutProperty(extraCharacters, serverRequest, property);
+
+          if (extraCharacters <= 0) {
+            break;
+          }
+        }
+      }
+
       serverRequests.push({
         method: 'GET',
         url: BANNER_SERVER_ENDPOINT,
@@ -230,7 +246,7 @@ function getPageDescription() {
   if (document.querySelector('meta[name="description"]')) {
     return document
       .querySelector('meta[name="description"]')
-      .getAttribute('content'); // Value of the description metadata from the publisher's page.
+      .getAttribute('content') || ''; // Value of the description metadata from the publisher's page.
   } else {
     return '';
   }
@@ -457,3 +473,25 @@ function validateVideoParams(bid) {
     return false;
   }
 }
+
+/**
+ * Shortcut object property and check if required characters count was deleted
+ *
+ * @param {number} extraCharacters, count of characters to remove
+ * @param {object} target, object on which string property length should be reduced
+ * @param {string} propertyName, name of property to reduce
+ * @return {number} 0 if required characters count was removed otherwise count of how many left
+ */
+function shortcutProperty(extraCharacters, target, propertyName) {
+  if (target[propertyName].length > extraCharacters) {
+    target[propertyName] = target[propertyName].substring(0, target[propertyName].length - extraCharacters);
+
+    return 0
+  }
+
+  const charactersLeft = extraCharacters - target[propertyName].length;
+
+  target[propertyName] = '';
+
+  return charactersLeft;
+}
diff --git a/test/spec/modules/yieldmoBidAdapter_spec.js b/test/spec/modules/yieldmoBidAdapter_spec.js
@@ -256,6 +256,53 @@ describe('YieldmoAdapter', function () {
         const data = buildAndGetData([mockBannerBid({schain})]);
         expect(data.schain).equal(JSON.stringify(schain));
       });
+
+      it('should not exceed max url length', () => {
+        const longString = new Array(8000).join('a');
+        const localWindow = utils.getWindowTop();
+
+        const originalTitle = localWindow.document.title;
+        localWindow.document.title = longString;
+
+        const request = spec.buildRequests(
+          [mockBannerBid()],
+          mockBidderRequest({
+            refererInfo: {
+              numIframes: 1,
+              reachedTop: true,
+              referer: longString,
+            },
+          })
+        )[0];
+        const url = `${request.url}?${utils.parseQueryStringParameters(request.data)}`;
+
+        expect(url.length).equal(8000);
+
+        localWindow.document.title = originalTitle;
+      });
+
+      it('should only shortcut properties rather then completely remove it', () => {
+        const longString = new Array(7516).join('a');
+        const localWindow = utils.getWindowTop();
+
+        const originalTitle = localWindow.document.title;
+        localWindow.document.title = `testtitle${longString}`;
+
+        const request = spec.buildRequests(
+          [mockBannerBid()],
+          mockBidderRequest({
+            refererInfo: {
+              numIframes: 1,
+              reachedTop: true,
+              referer: longString,
+            },
+          })
+        )[0];
+
+        expect(request.data.title).equal('testtitle');
+
+        localWindow.document.title = originalTitle;
+      });
     });
 
     describe('Instream video:', function () {