PBS adapter - fix logic for undefined endpoint URLs #7076

jsnellbaker · 2021-06-22T13:48:27Z

Type of change

Bugfix

Description of change

There was an issue present in s2sConfigs if the publisher defined the endpoint (or syncEndpoint) object config but didn't define both p1Consent and noP1Consent fields. In this case, the field that was undefined would still try to make a call to PBS with an undefined URL for that type of user.

This PR addresses this scenario by blocking the call to PBS entirely if a particular URL field was undefined for that type of user. It will return an error for this scenario notifying what likely happened.

Also added a warning when evaluating the s2sConfig if one of these fields were undefined when using the object config.

TO NOTE:
Publishers still using the old string version of the endpoint (or syncEndpoint) fields or who relied on the defaultVendor feature to populate the endpoint URLs are unaffected by this scenario/fix. For the former, the single URL they define in the s2sConfig is still shared between consent/non-consent users. For the latter, the URLs are still read/assigned based on the configs defined in Prebid.js.

bretg · 2021-06-22T16:54:06Z

modules/prebidServerBidAdapter/index.js

+    if (utils.isPlainObject(option[prop]) && (!option[prop].p1Consent || !option[prop].noP1Consent)) {
+      ['p1Consent', 'noP1Consent'].forEach((conUrl) => {
+        if (!option[prop][conUrl]) {
+          utils.logWarn(`s2sConfig.${prop}.${conUrl} was not defined in manually set s2sConfig.  This may prevent PBS requests from executing in certain cases.  Please define field manually or instead use the defaultVendor settings of host company (if avialable).`);


I've been encouraging folks to keep messages short because they don't minify.

How about something more terse like "s2sConfig.${prop}.${conUrl} not defined. PBS request will be skipped in some P1 scenarios."

thanks, makes sense. updated.

bretg · 2021-06-22T16:56:18Z

modules/prebidServerBidAdapter/index.js

@@ -1107,6 +1114,8 @@ export function PrebidServer() {
          requestJson,
          { contentType: 'text/plain', withCredentials: true }
        );
+      } else {
+        utils.logError('Prebid Server request did not execute.  Please ensure endpoint URL(s) are properly defined in your s2sConfig.  Otherwise check for warnings/errors, likely noted earlier in console logs...');


Again, with the goal of saving bytes in the package, how about something more terse like

"PBS request not made. Check endpoints."

jsnellbaker · 2021-06-22T17:12:28Z

updated messages and added unit test

modules/prebidServerBidAdapter/index.js

muuki88 · 2021-06-23T07:07:18Z

modules/prebidServerBidAdapter/index.js

@@ -1097,7 +1104,7 @@ export function PrebidServer() {
      const request = OPEN_RTB_PROTOCOL.buildRequest(s2sBidRequest, bidRequests, validAdUnits, s2sBidRequest.s2sConfig, requestedBidders);
      const requestJson = request && JSON.stringify(request);
      utils.logInfo('BidRequest: ' + requestJson);
-      if (request && requestJson) {
+      if (request && requestJson && getMatchingConsentUrl(s2sBidRequest.s2sConfig.endpoint, gdprConsent)) {


Maybe put the URL into a variable. Makes refactoring easier as there's only one place to look for

muuki88 · 2021-06-23T07:10:19Z

test/spec/modules/prebidServerBidAdapter_spec.js

+    it('should block request if config did not define proper URL in endpoint object config', function() {
+      let badConfig = utils.deepClone(CONFIG);
+      badConfig.endpoint = { noP1Consent: 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction' };
+      config.setConfig({ s2sConfig: badConfig });
+
+      let badCfgRequest = utils.deepClone(REQUEST);
+      badCfgRequest.s2sConfig = badConfig;
+
+      adapter.callBids(badCfgRequest, BID_REQUESTS, addBidResponse, done, ajax);
+
+      expect(server.requests.length).to.equal(0);
+    });
+


Maybe add two more test cases

for p1Consent only configuration (which is probably the more common one)

for an empty object

Suggested change

it('should block request if config did not define proper URL in endpoint object config', function() {

let badConfig = utils.deepClone(CONFIG);

badConfig.endpoint = { noP1Consent: 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction' };

config.setConfig({ s2sConfig: badConfig });

let badCfgRequest = utils.deepClone(REQUEST);

badCfgRequest.s2sConfig = badConfig;

adapter.callBids(badCfgRequest, BID_REQUESTS, addBidResponse, done, ajax);

expect(server.requests.length).to.equal(0);

});

[

{ p1Consent: 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction' },

{ noP1Consent: 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction' },

{ }

].forEach(endpoint => {

it('should block request if config did not define proper URL in endpoint object config', function() {

let badConfig = utils.deepClone(CONFIG);

badConfig.endpoint = endpoint;

config.setConfig({ s2sConfig: badConfig });

let badCfgRequest = utils.deepClone(REQUEST);

badCfgRequest.s2sConfig = badConfig;

adapter.callBids(badCfgRequest, BID_REQUESTS, addBidResponse, done, ajax);

expect(server.requests.length).to.equal(0);

});

});

Do you mean add a test for when p1Consent is the only property defined and the request contains a no-consent scenario - to test that the request is blocked here as well?

Ok thanks for confirming. I added some tests guessing that was the case. Please take a look when you have the chance (in addition to the other change you suggested).

muuki88 · 2021-06-23T07:11:25Z

Thanks for the fast fix @jsnellbaker ❤️

muuki88

Thanks for the quick fix 👏 👏

test/spec/modules/prebidServerBidAdapter_spec.js

modules/prebidServerBidAdapter/index.js

muuki88 · 2021-07-12T10:29:04Z

@bretg is this good to go? We have some publishers that have way to many calls to /undefined 😉

* PBS adapter - fix logic for undefined endpoint URLs * update messages and add unit test * fix lint error * new tests and other changes Co-authored-by: Chris Huie <phoenixtechnerd@gmail.com>

PBS adapter - fix logic for undefined endpoint URLs

3c8055e

jsnellbaker requested a review from bretg June 22, 2021 13:48

jsnellbaker added bugfix do not merge minor labels Jun 22, 2021

bretg requested changes Jun 22, 2021

View reviewed changes

update messages and add unit test

793934b

jsnellbaker removed the do not merge label Jun 22, 2021

jsnellbaker requested a review from msm0504 June 22, 2021 17:12

jsnellbaker assigned msm0504 Jun 22, 2021

fix lint error

e23cf2d

msm0504 reviewed Jun 22, 2021

View reviewed changes

modules/prebidServerBidAdapter/index.js Show resolved Hide resolved

muuki88 requested changes Jun 23, 2021

View reviewed changes

jsnellbaker added 2 commits June 23, 2021 10:41

new tests and other changes

86a73c8

resolve conflict issue

0a0274f

muuki88 approved these changes Jun 24, 2021

View reviewed changes

test/spec/modules/prebidServerBidAdapter_spec.js Show resolved Hide resolved

modules/prebidServerBidAdapter/index.js Show resolved Hide resolved

msm0504 approved these changes Jun 29, 2021

View reviewed changes

ChrisHuie approved these changes Jun 30, 2021

View reviewed changes

jsnellbaker mentioned this pull request Jun 30, 2021

update s2sconfig for endpoint object config and add openx defaultVendor prebid/prebid.github.io#3083

Merged

ChrisHuie merged commit dc5f028 into master Jul 12, 2021

ChrisHuie deleted the pbs_config_consentUrl_fix branch July 12, 2021 15:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PBS adapter - fix logic for undefined endpoint URLs #7076

PBS adapter - fix logic for undefined endpoint URLs #7076

jsnellbaker commented Jun 22, 2021 •

edited

Loading

bretg Jun 22, 2021

jsnellbaker Jun 22, 2021

bretg Jun 22, 2021

jsnellbaker Jun 22, 2021

jsnellbaker commented Jun 22, 2021

muuki88 Jun 23, 2021

muuki88 Jun 23, 2021

jsnellbaker Jun 23, 2021

muuki88 Jun 23, 2021

jsnellbaker Jun 23, 2021

muuki88 commented Jun 23, 2021

muuki88 left a comment

muuki88 commented Jul 12, 2021

PBS adapter - fix logic for undefined endpoint URLs #7076

PBS adapter - fix logic for undefined endpoint URLs #7076

Conversation

jsnellbaker commented Jun 22, 2021 • edited Loading

Type of change

Description of change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsnellbaker commented Jun 22, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

muuki88 commented Jun 23, 2021

muuki88 left a comment

Choose a reason for hiding this comment

muuki88 commented Jul 12, 2021

jsnellbaker commented Jun 22, 2021 •

edited

Loading