Yahoo Ads: Migrate to OpenRTB 2.6

src/main/java/org/prebid/server/bidder/yahooads/YahooAdsBidder.java

@@ -1,10 +1,8 @@
 package org.prebid.server.bidder.yahooads;
 
 import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.node.ArrayNode;
-import com.fasterxml.jackson.databind.node.IntNode;
+import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
-import com.fasterxml.jackson.databind.node.TextNode;
 import com.iab.openrtb.request.App;
 import com.iab.openrtb.request.Banner;
 import com.iab.openrtb.request.BidRequest;
@@ -20,8 +18,6 @@
 import io.vertx.core.http.HttpMethod;
 import org.apache.commons.collections4.CollectionUtils;
 import org.apache.commons.lang3.StringUtils;
-import org.prebid.server.auction.versionconverter.BidRequestOrtbVersionConversionManager;
-import org.prebid.server.auction.versionconverter.OrtbVersion;
 import org.prebid.server.bidder.Bidder;
 import org.prebid.server.bidder.model.BidderBid;
 import org.prebid.server.bidder.model.BidderCall;
@@ -32,9 +28,7 @@
 import org.prebid.server.json.DecodeException;
 import org.prebid.server.json.JacksonMapper;
 import org.prebid.server.proto.openrtb.ext.ExtPrebid;
-import org.prebid.server.proto.openrtb.ext.FlexibleExtension;
 import org.prebid.server.proto.openrtb.ext.request.ExtRegs;
-import org.prebid.server.proto.openrtb.ext.request.ExtRegsDsa;
 import org.prebid.server.proto.openrtb.ext.request.yahooads.ExtImpYahooAds;
 import org.prebid.server.proto.openrtb.ext.response.BidType;
 import org.prebid.server.util.HttpUtil;
@@ -44,24 +38,24 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
-import java.util.Optional;
 
 public class YahooAdsBidder implements Bidder<BidRequest> {
 
     private static final TypeReference<ExtPrebid<?, ExtImpYahooAds>> YAHOO_ADVERTISING_EXT_TYPE_REFERENCE =
             new TypeReference<>() {
             };
 
+    private static final String OPENRTB_VERSION = "2.6";
+    private static final String GPP_PROPERTY = "gpp";
+    private static final String GPP_SID_PROPERTY = "gpp_sid";
+
     private final String endpointUrl;
-    private final BidRequestOrtbVersionConversionManager conversionManager;
     private final JacksonMapper mapper;
 
     public YahooAdsBidder(String endpointUrl,
-                          BidRequestOrtbVersionConversionManager conversionManager,
                           JacksonMapper mapper) {
         this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl));
         this.mapper = Objects.requireNonNull(mapper);
-        this.conversionManager = Objects.requireNonNull(conversionManager);
     }
 
     @Override
@@ -70,16 +64,14 @@ public Result<List<HttpRequest<BidRequest>>> makeHttpRequests(BidRequest bidRequ
         final List<BidderError> errors = new ArrayList<>();
 
         final Regs regs = bidRequest.getRegs();
-        final BidRequest bidRequestOpenRtb25 = this.conversionManager.convertFromAuctionSupportedVersion(bidRequest,
-                OrtbVersion.ORTB_2_5);
+        final Regs modifiedRegs = regs != null ? modifyRegs(regs) : null;
 
-        final List<Imp> impList = bidRequestOpenRtb25.getImp();
+        final List<Imp> impList = bidRequest.getImp();
         for (int i = 0; i < impList.size(); i++) {
             try {
                 final Imp imp = impList.get(i);
                 final ExtImpYahooAds extImpYahooAds = parseAndValidateImpExt(imp.getExt(), i);
-                final BidRequest modifiedRequest = modifyRequest(bidRequestOpenRtb25, imp, extImpYahooAds,
-                        regs);
+                final BidRequest modifiedRequest = modifyRequest(bidRequest, imp, extImpYahooAds, modifiedRegs);
                 bidRequests.add(makeHttpRequest(modifiedRequest));
             } catch (PreBidException e) {
                 errors.add(BidderError.badInput(e.getMessage()));
@@ -111,8 +103,7 @@ private ExtImpYahooAds parseAndValidateImpExt(ObjectNode impExtNode, int index)
         return extImpYahooAds;
     }
 
-    private BidRequest modifyRequest(BidRequest request, Imp imp, ExtImpYahooAds extImpYahooAds,
-                                     Regs regs) {
+    private BidRequest modifyRequest(BidRequest request, Imp imp, ExtImpYahooAds extImpYahooAds, Regs regs) {
         final BidRequest.BidRequestBuilder requestBuilder = request.toBuilder();
 
         final Site site = request.getSite();
@@ -125,7 +116,7 @@ private BidRequest modifyRequest(BidRequest request, Imp imp, ExtImpYahooAds ext
         }
 
         if (regs != null) {
-            requestBuilder.regs(modifyRegs(regs));
+            requestBuilder.regs(regs);
         }
 
         return requestBuilder
@@ -171,49 +162,66 @@ private static Banner modifyBanner(Banner banner) {
     }
 
     private Regs modifyRegs(Regs regs) {
-        final ExtRegs extRegs = resolveExtRegs(regs);
-
-        return Regs.builder().ext(extRegs).build();
-    }
+        final ExtRegs ext = regs.getExt();
+        if (ext == null || !(ext.containsProperty(GPP_PROPERTY) || ext.containsProperty(GPP_SID_PROPERTY))) {
+            return regs;
+        }
 
-    private ExtRegs resolveExtRegs(Regs regs) {
-        final Integer gdpr = resolveGdpr(regs);
-        final String usPrivacy = resolveUsPrivacy(regs);
         final String gpp = regs.getGpp();
+        final String resolvedGpp = gpp == null ? gppToPromote(ext) : gpp;
+
         final List<Integer> gppSid = regs.getGppSid();
+        final List<Integer> resolvedGppSid = CollectionUtils.isEmpty(gppSid) ? gppSidToPromote(ext) : gppSid;
 
-        final String gpc = Optional.ofNullable(regs.getExt())
-                .map(ExtRegs::getGpc)
-                .orElse(null);
-        final ExtRegsDsa dsa = Optional.ofNullable(regs.getExt())
-                .map(ExtRegs::getDsa)
-                .orElse(null);
-        final ExtRegs extRegs = ExtRegs.of(gdpr, usPrivacy, gpc, dsa);
-        extRegs.addProperty("gpp", TextNode.valueOf(gpp));
-        if (!CollectionUtils.isEmpty(gppSid)) {
-            final ArrayNode gppArrayNode = mapper.mapper().createArrayNode();
-            gppSid.forEach(gppArrayNode::add);
-            extRegs.addProperty("gpp_sid", gppArrayNode);
+        final ExtRegs modifiedExt = copy(ext);
+        if (resolvedGpp != null) {
+            modifiedExt.removeProperty(GPP_PROPERTY);
         }
-        if (regs.getCoppa() != null) {
-            extRegs.addProperty("coppa", IntNode.valueOf(regs.getCoppa()));
+        if (CollectionUtils.isNotEmpty(resolvedGppSid)) {
+            modifiedExt.removeProperty(GPP_SID_PROPERTY);
         }
 
-        Optional.ofNullable(regs.getExt())
-                .map(FlexibleExtension::getProperties)
-                .ifPresent(extRegs::addProperties);
+        return regs.toBuilder()
+                .gpp(resolvedGpp)
+                .gppSid(resolvedGppSid)
+                .ext(isExtEmpty(modifiedExt) ? null : modifiedExt)
+                .build();
+    }
+
+    private static String gppToPromote(ExtRegs ext) {
+        final JsonNode node = ext.getProperty(GPP_PROPERTY);
+        return node != null && node.isTextual() ? node.asText() : null;
+    }
+
+    private static List<Integer> gppSidToPromote(ExtRegs ext) {
+        final JsonNode node = ext.getProperty(GPP_SID_PROPERTY);
+        if (node == null || !node.isArray() || node.isEmpty()) {
+            return null;
+        }
+
+        final List<Integer> sids = new ArrayList<>(node.size());
+        for (final JsonNode elem : node) {
+            if (!elem.isIntegralNumber() || !elem.canConvertToInt()) {
+                return null;
+            }
+            sids.add(elem.intValue());
+        }
 
-        return extRegs;
+        return sids;
     }
 
-    private static Integer resolveGdpr(Regs regs) {
-        return regs.getGdpr() != null ? regs.getGdpr()
-                : (regs.getExt() != null ? regs.getExt().getGdpr() : null);
+    private ExtRegs copy(ExtRegs ext) {
+        final ExtRegs result = ExtRegs.of(ext.getGdpr(), ext.getUsPrivacy(), ext.getGpc(), ext.getDsa());
+        mapper.fillExtension(result, ext.getProperties());
+        return result;
     }
 
-    private static String resolveUsPrivacy(Regs regs) {
-        return regs.getUsPrivacy() != null ? regs.getUsPrivacy()
-                : (regs.getExt() != null ? regs.getExt().getUsPrivacy() : null);
+    private static boolean isExtEmpty(ExtRegs ext) {
+        return ext.getGdpr() == null
+                && ext.getUsPrivacy() == null
+                && ext.getGpc() == null
+                && ext.getDsa() == null
+                && ext.getProperties().isEmpty();
     }
 
     private HttpRequest<BidRequest> makeHttpRequest(BidRequest outgoingRequest) {
@@ -228,7 +236,7 @@ private HttpRequest<BidRequest> makeHttpRequest(BidRequest outgoingRequest) {
 
     private static MultiMap makeHeaders(Device device) {
         final MultiMap headers = HttpUtil.headers()
-                .add(HttpUtil.X_OPENRTB_VERSION_HEADER, "2.5");
+                .add(HttpUtil.X_OPENRTB_VERSION_HEADER, OPENRTB_VERSION);
 
         final String deviceUa = device != null ? device.getUa() : null;
         HttpUtil.addHeaderIfValueIsNotEmpty(headers, HttpUtil.USER_AGENT_HEADER, deviceUa);

src/main/java/org/prebid/server/proto/openrtb/ext/FlexibleExtension.java

@@ -42,4 +42,8 @@ public void addProperty(String key, JsonNode value) {
     public void addProperties(Map<String, JsonNode> properties) {
         this.properties.putAll(properties);
     }
+
+    public void removeProperty(String key) {
+        properties.remove(key);
+    }
 }

src/main/java/org/prebid/server/spring/config/bidder/YahooAdsConfiguration.java

@@ -1,6 +1,5 @@
 package org.prebid.server.spring.config.bidder;
 
-import org.prebid.server.auction.versionconverter.BidRequestOrtbVersionConversionManager;
 import org.prebid.server.bidder.BidderDeps;
 import org.prebid.server.bidder.yahooads.YahooAdsBidder;
 import org.prebid.server.json.JacksonMapper;
@@ -26,12 +25,11 @@ BidderConfigurationProperties configurationProperties() {
 
     @Bean
     BidderDeps yahooAdsBidderDeps(BidderConfigurationProperties yahooAdsConfigurationProperties,
-                                  JacksonMapper mapper,
-                                  BidRequestOrtbVersionConversionManager conversionManager) {
+                                  JacksonMapper mapper) {
 
         return BidderDepsAssembler.forBidder(BIDDER_NAME)
                 .withConfig(yahooAdsConfigurationProperties)
-                .bidderCreator(config -> new YahooAdsBidder(config.getEndpoint(), conversionManager, mapper))
+                .bidderCreator(config -> new YahooAdsBidder(config.getEndpoint(), mapper))
                 .assemble();
     }
 }