Core: Add validation by BIDDER.yaml for media types

src/main/java/org/prebid/server/auction/ExchangeService.java

@@ -22,9 +22,12 @@
 import io.vertx.core.logging.Logger;
 import io.vertx.core.logging.LoggerFactory;
 import org.apache.commons.collections4.CollectionUtils;
+import org.apache.commons.collections4.ListUtils;
 import org.apache.commons.lang3.ObjectUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.prebid.server.auction.adjustment.BidAdjustmentFactorResolver;
+import org.prebid.server.auction.mediatypeprocessor.MediaTypeProcessingResult;
+import org.prebid.server.auction.mediatypeprocessor.MediaTypeProcessor;
 import org.prebid.server.auction.model.AuctionContext;
 import org.prebid.server.auction.model.AuctionParticipation;
 import org.prebid.server.auction.model.BidRequestCacheInfo;
@@ -159,6 +162,7 @@ public class ExchangeService {
     private final FpdResolver fpdResolver;
     private final SchainResolver schainResolver;
     private final DebugResolver debugResolver;
+    private final MediaTypeProcessor mediaTypeProcessor;
     private final HttpBidderRequester httpBidderRequester;
     private final ResponseBidValidator responseBidValidator;
     private final CurrencyConversionService currencyService;
@@ -183,6 +187,7 @@ public ExchangeService(long expectedCacheTime,
                            FpdResolver fpdResolver,
                            SchainResolver schainResolver,
                            DebugResolver debugResolver,
+                           MediaTypeProcessor mediaTypeProcessor,
                            HttpBidderRequester httpBidderRequester,
                            ResponseBidValidator responseBidValidator,
                            CurrencyConversionService currencyService,
@@ -210,6 +215,7 @@ public ExchangeService(long expectedCacheTime,
         this.fpdResolver = Objects.requireNonNull(fpdResolver);
         this.schainResolver = Objects.requireNonNull(schainResolver);
         this.debugResolver = Objects.requireNonNull(debugResolver);
+        this.mediaTypeProcessor = Objects.requireNonNull(mediaTypeProcessor);
         this.httpBidderRequester = Objects.requireNonNull(httpBidderRequester);
         this.responseBidValidator = Objects.requireNonNull(responseBidValidator);
         this.currencyService = Objects.requireNonNull(currencyService);
@@ -1244,7 +1250,28 @@ private Future<BidderResponse> requestBids(BidderRequest bidderRequest,
 
         final long startTime = clock.millis();
 
-        return httpBidderRequester.requestBids(bidder, bidderRequest, timeout, requestHeaders, debugEnabledForBidder)
+        final MediaTypeProcessingResult mediaTypeProcessingResult =
+                mediaTypeProcessor.process(bidderRequest.getBidRequest(), resolvedBidderName);
+
+        if (mediaTypeProcessingResult.isRejected()) {
+            final BidderSeatBid bidderSeatBid = BidderSeatBid.of(
+                    Collections.emptyList(),
+                    Collections.emptyList(),
+                    Collections.emptyList(),
+                    mediaTypeProcessingResult.getErrors());
+
+            return Future.succeededFuture(BidderResponse.of(bidderName, bidderSeatBid, 0));
+        }
+
+        final BidderRequest modifiedBidderRequest = bidderRequest.with(mediaTypeProcessingResult.getBidRequest());
+
+        return httpBidderRequester
+                .requestBids(bidder, modifiedBidderRequest, timeout, requestHeaders, debugEnabledForBidder)
+                .map(seatBid -> BidderSeatBid.of(
+                        seatBid.getBids(),
+                        seatBid.getHttpCalls(),
+                        seatBid.getErrors(),
+                        ListUtils.union(mediaTypeProcessingResult.getErrors(), seatBid.getWarnings())))
                 .map(seatBid -> BidderResponse.of(bidderName, seatBid, responseTime(startTime)));
     }
 
@@ -1328,6 +1355,7 @@ private AuctionParticipation validBidderResponse(AuctionParticipation auctionPar
         final BidderResponse bidderResponse = auctionParticipation.getBidderResponse();
         final BidderSeatBid seatBid = bidderResponse.getSeatBid();
         final List<BidderError> errors = new ArrayList<>(seatBid.getErrors());
+        final List<BidderError> warnings = new ArrayList<>(seatBid.getWarnings());
 
         final List<String> requestCurrencies = bidRequest.getCur();
         if (requestCurrencies.size() > 1) {
@@ -1365,7 +1393,7 @@ private AuctionParticipation validBidderResponse(AuctionParticipation auctionPar
 
         final BidderResponse resultBidderResponse = errors.isEmpty()
                 ? bidderResponse
-                : bidderResponse.with(BidderSeatBid.of(validBids, seatBid.getHttpCalls(), errors));
+                : bidderResponse.with(BidderSeatBid.of(validBids, seatBid.getHttpCalls(), errors, warnings));
         return auctionParticipation.with(resultBidderResponse);
     }
 
@@ -1428,8 +1456,8 @@ private AuctionParticipation applyBidPriceChanges(AuctionParticipation auctionPa
             }
         }
 
-        final BidderResponse resultBidderResponse =
-                bidderResponse.with(BidderSeatBid.of(updatedBidderBids, seatBid.getHttpCalls(), errors));
+        final BidderResponse resultBidderResponse = bidderResponse.with(BidderSeatBid.of(
+                updatedBidderBids, seatBid.getHttpCalls(), errors, seatBid.getWarnings()));
         return auctionParticipation.with(resultBidderResponse);
     }
 

src/main/java/org/prebid/server/auction/StoredResponseProcessor.java

@@ -293,9 +293,9 @@ private BidderSeatBid makeBidderSeatBid(BidderSeatBid bidderSeatBid, SeatBid sea
         if (nonNullBidderSeatBid) {
             bidderBids.addAll(bidderSeatBid.getBids());
         }
-        return BidderSeatBid.of(bidderBids,
-                nonNullBidderSeatBid ? bidderSeatBid.getHttpCalls() : Collections.emptyList(),
-                nonNullBidderSeatBid ? bidderSeatBid.getErrors() : Collections.emptyList());
+        return nonNullBidderSeatBid
+                ? bidderSeatBid.with(bidderBids)
+                : BidderSeatBid.of(bidderBids);
     }
 
     private BidderBid makeBidderBid(Bid bid, String bidCurrency, Map<String, BidType> impIdToBidType) {

src/main/java/org/prebid/server/auction/categorymapping/BasicCategoryMappingService.java

@@ -655,14 +655,14 @@ private static List<BidderResponse> removeRejectedBids(List<BidderResponse> bidd
      */
     private static BidderResponse removeRejectedBids(BidderResponse bidderResponse, List<String> rejectedBidIds) {
         final String bidder = bidderResponse.getBidder();
+        final BidderSeatBid bidderSeatBid = bidderResponse.getSeatBid();
 
-        final List<BidderBid> survivedBidderBids = bidderResponse.getSeatBid().getBids().stream()
+        final List<BidderBid> survivedBidderBids = bidderSeatBid.getBids().stream()
                 .filter(bidderBid -> !rejectedBidIds.contains(bidderBid.getBid().getId()))
                 .collect(Collectors.toList());
 
-        final BidderSeatBid bidderSeatBid = bidderResponse.getSeatBid();
         return BidderResponse.of(bidder,
-                BidderSeatBid.of(survivedBidderBids, bidderSeatBid.getHttpCalls(), bidderSeatBid.getErrors()),
+                bidderSeatBid.with(survivedBidderBids),
                 bidderResponse.getResponseTime());
     }
 

src/main/java/org/prebid/server/auction/mediatypeprocessor/BidderMediaTypeProcessor.java

@@ -0,0 +1,134 @@
+package org.prebid.server.auction.mediatypeprocessor;
+
+import com.iab.openrtb.request.BidRequest;
+import com.iab.openrtb.request.Imp;
+import org.apache.commons.collections4.CollectionUtils;
+import org.apache.commons.collections4.SetUtils;
+import org.prebid.server.bidder.BidderCatalog;
+import org.prebid.server.bidder.BidderInfo;
+import org.prebid.server.bidder.model.BidderError;
+import org.prebid.server.spring.config.bidder.model.MediaType;
+import org.prebid.server.util.ObjectUtil;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.EnumSet;
+import java.util.List;
+import java.util.Objects;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+/**
+ * {@link BidderMediaTypeProcessor} is an implementation of {@link MediaTypeProcessor} that
+ * can be used to remove media types from {@link Imp} unsupported by specific bidder.
+ */
+public class BidderMediaTypeProcessor implements MediaTypeProcessor {
+
+    private final BidderCatalog bidderCatalog;
+
+    public BidderMediaTypeProcessor(BidderCatalog bidderCatalog) {
+        this.bidderCatalog = Objects.requireNonNull(bidderCatalog);
+    }
+
+    @Override
+    public MediaTypeProcessingResult process(BidRequest bidRequest, String supportedBidderName) {
+        final Set<MediaType> supportedMediaTypes = extractSupportedMediaTypes(bidRequest, supportedBidderName);
+        if (supportedMediaTypes.isEmpty()) {
+            return MediaTypeProcessingResult.rejected(Collections.singletonList(
+                    BidderError.badInput("Bidder does not support any media types.")));
+        }
+
+        final List<BidderError> errors = new ArrayList<>();
+        final BidRequest modifiedBidRequest = processBidRequest(bidRequest, supportedMediaTypes, errors);
+
+        return modifiedBidRequest != null
+                ? MediaTypeProcessingResult.succeeded(modifiedBidRequest, errors)
+                : MediaTypeProcessingResult.rejected(errors);
+    }
+
+    private Set<MediaType> extractSupportedMediaTypes(BidRequest bidRequest, String supportedBidderName) {
+        final BidderInfo.CapabilitiesInfo capabilitiesInfo = bidderCatalog
+                .bidderInfoByName(supportedBidderName).getCapabilities();
+
+        final List<MediaType> supportedMediaTypes;
+        if (bidRequest.getSite() != null) {
+            supportedMediaTypes = ObjectUtil.getIfNotNull(
+                    capabilitiesInfo.getSite(), BidderInfo.PlatformInfo::getMediaTypes);
+        } else {
+            supportedMediaTypes = ObjectUtil.getIfNotNull(
+                    capabilitiesInfo.getApp(), BidderInfo.PlatformInfo::getMediaTypes);
+        }
+
+        return CollectionUtils.isNotEmpty(supportedMediaTypes)
+                ? EnumSet.copyOf(supportedMediaTypes)
+                : EnumSet.noneOf(MediaType.class);
+    }
+
+    private BidRequest processBidRequest(BidRequest bidRequest,
+                                         Set<MediaType> supportedMediaTypes,
+                                         List<BidderError> errors) {
+
+        final List<Imp> modifiedImps = bidRequest.getImp().stream()
+                .map(imp -> processImp(imp, supportedMediaTypes, errors))
+                .filter(Objects::nonNull)
+                .collect(Collectors.toList());
+
+        if (modifiedImps.isEmpty()) {
+            errors.add(BidderError.badInput("Bid request contains 0 impressions after filtering."));
+            return null;
+        }
+
+        return bidRequest.toBuilder().imp(modifiedImps).build();
+    }
+
+    private static Imp processImp(Imp imp, Set<MediaType> supportedMediaTypes, List<BidderError> errors) {
+        final Set<MediaType> impMediaTypes = getMediaTypes(imp);
+        final Set<MediaType> unsupportedMediaTypes = SetUtils.difference(impMediaTypes, supportedMediaTypes);
+
+        if (unsupportedMediaTypes.isEmpty()) {
+            return imp;
+        }
+
+        if (impMediaTypes.equals(unsupportedMediaTypes)) {
+            errors.add(BidderError.badInput("Imp " + imp.getId() + " does not have a supported media type "
+                    + "and has been removed from the request for this bidder."));
+
+            return null;
+        }
+
+        final Imp.ImpBuilder impBuilder = imp.toBuilder();
+        unsupportedMediaTypes.forEach(unsupportedMediaType -> removeMediaType(impBuilder, unsupportedMediaType));
+
+        return impBuilder.build();
+    }
+
+    private static Set<MediaType> getMediaTypes(Imp imp) {
+        return Stream.of(
+                        imp.getBanner() != null ? MediaType.BANNER : null,
+                        imp.getVideo() != null ? MediaType.VIDEO : null,
+                        imp.getAudio() != null ? MediaType.AUDIO : null,
+                        imp.getXNative() != null ? MediaType.NATIVE : null)
+                .filter(Objects::nonNull)
+                .collect(Collectors.toCollection(() -> EnumSet.noneOf(MediaType.class)));
+    }
+
+    private static void removeMediaType(Imp.ImpBuilder impBuilder, MediaType mediaType) {
+        switch (mediaType) {
+            case BANNER:
+                impBuilder.banner(null);
+                break;
+            case VIDEO:
+                impBuilder.video(null);
+                break;
+            case AUDIO:
+                impBuilder.audio(null);
+                break;
+            case NATIVE:
+                impBuilder.xNative(null);
+                break;
+            default:
+                throw new IllegalArgumentException("Invalid media type");
+        }
+    }
+}

src/main/java/org/prebid/server/auction/mediatypeprocessor/MediaTypeProcessingResult.java

@@ -0,0 +1,25 @@
+package org.prebid.server.auction.mediatypeprocessor;
+
+import com.iab.openrtb.request.BidRequest;
+import lombok.Value;
+import org.prebid.server.bidder.model.BidderError;
+
+import java.util.List;
+
+@Value(staticConstructor = "of")
+public class MediaTypeProcessingResult {
+
+    BidRequest bidRequest;
+
+    List<BidderError> errors;
+
+    boolean rejected;
+
+    public static MediaTypeProcessingResult succeeded(BidRequest bidRequest, List<BidderError> errors) {
+        return MediaTypeProcessingResult.of(bidRequest, errors, false);
+    }
+
+    public static MediaTypeProcessingResult rejected(List<BidderError> errors) {
+        return MediaTypeProcessingResult.of(null, errors, true);
+    }
+}

src/main/java/org/prebid/server/auction/mediatypeprocessor/MediaTypeProcessor.java

@@ -0,0 +1,8 @@
+package org.prebid.server.auction.mediatypeprocessor;
+
+import com.iab.openrtb.request.BidRequest;
+
+public interface MediaTypeProcessor {
+
+    MediaTypeProcessingResult process(BidRequest bidRequest, String supportedBidderName);
+}

src/main/java/org/prebid/server/auction/mediatypeprocessor/NoOpMediaTypeProcessor.java

@@ -0,0 +1,13 @@
+package org.prebid.server.auction.mediatypeprocessor;
+
+import com.iab.openrtb.request.BidRequest;
+
+import java.util.Collections;
+
+public class NoOpMediaTypeProcessor implements MediaTypeProcessor {
+
+    @Override
+    public MediaTypeProcessingResult process(BidRequest bidRequest, String supportedBidderName) {
+        return MediaTypeProcessingResult.succeeded(bidRequest, Collections.emptyList());
+    }
+}

src/main/java/org/prebid/server/bidder/BidderInfo.java

@@ -4,6 +4,7 @@
 import lombok.Value;
 import org.apache.commons.lang3.StringUtils;
 import org.prebid.server.spring.config.bidder.model.CompressionType;
+import org.prebid.server.spring.config.bidder.model.MediaType;
 
 import java.util.List;
 
@@ -37,8 +38,8 @@ public static BidderInfo create(boolean enabled,
                                     String endpoint,
                                     String aliasOf,
                                     String maintainerEmail,
-                                    List<String> appMediaTypes,
-                                    List<String> siteMediaTypes,
+                                    List<MediaType> appMediaTypes,
+                                    List<MediaType> siteMediaTypes,
                                     List<String> supportedVendors,
                                     int vendorId,
                                     boolean ccpaEnforced,
@@ -59,7 +60,7 @@ public static BidderInfo create(boolean enabled,
                 compressionType);
     }
 
-    private static PlatformInfo platformInfo(List<String> mediaTypes) {
+    private static PlatformInfo platformInfo(List<MediaType> mediaTypes) {
         return mediaTypes != null ? new PlatformInfo(mediaTypes) : null;
     }
 
@@ -78,10 +79,10 @@ public static class CapabilitiesInfo {
     }
 
     @Value
-    private static class PlatformInfo {
+    public static class PlatformInfo {
 
         @JsonProperty("mediaTypes")
-        List<String> mediaTypes;
+        List<MediaType> mediaTypes;
     }
 
     @Value

src/main/java/org/prebid/server/bidder/HttpBidderRequester.java

@@ -14,9 +14,9 @@
 import org.prebid.server.auction.ExchangeService;
 import org.prebid.server.auction.model.BidderRequest;
 import org.prebid.server.bidder.model.BidderBid;
+import org.prebid.server.bidder.model.BidderCall;
 import org.prebid.server.bidder.model.BidderCallType;
 import org.prebid.server.bidder.model.BidderError;
-import org.prebid.server.bidder.model.BidderCall;
 import org.prebid.server.bidder.model.BidderSeatBid;
 import org.prebid.server.bidder.model.HttpRequest;
 import org.prebid.server.bidder.model.HttpResponse;
@@ -164,7 +164,9 @@ private Future<BidderSeatBid> emptyBidderSeatBidWithErrors(List<BidderError> bid
                 ? Collections.singletonList(BidderError.failedToRequestBids(
                 "The bidder failed to generate any bid requests, but also failed to generate an error"))
                 : bidderErrors;
-        return Future.succeededFuture(BidderSeatBid.of(Collections.emptyList(), Collections.emptyList(), errors));
+
+        return Future.succeededFuture(BidderSeatBid.of(
+                Collections.emptyList(), Collections.emptyList(), errors, Collections.emptyList()));
     }
 
     /**
@@ -360,7 +362,7 @@ BidderSeatBid toBidderSeatBid(boolean debugEnabled) {
                     : Collections.emptyList();
 
             final List<BidderError> errors = combineErrors(previousErrors, httpCalls, errorsRecorded);
-            return BidderSeatBid.of(bidsRecorded, extHttpCalls, errors);
+            return BidderSeatBid.of(bidsRecorded, extHttpCalls, errors, Collections.emptyList());
         }
 
         /**