diff --git a/src/main/java/org/prebid/server/bidder/eskimi/EskimiBidder.java b/src/main/java/org/prebid/server/bidder/eskimi/EskimiBidder.java new file mode 100644 index 00000000000..fae4d4a5852 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/eskimi/EskimiBidder.java @@ -0,0 +1,258 @@ +package org.prebid.server.bidder.eskimi; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.node.IntNode; +import com.iab.openrtb.request.App; +import com.iab.openrtb.request.Banner; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Site; +import com.iab.openrtb.request.Video; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.lang3.ObjectUtils; +import org.apache.commons.lang3.StringUtils; +import org.prebid.server.bidder.Bidder; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderCall; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.Price; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.exception.PreBidException; +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.ExtApp; +import org.prebid.server.proto.openrtb.ext.request.ExtSite; +import org.prebid.server.proto.openrtb.ext.request.eskimi.ExtImpEskimi; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; + +import java.math.BigDecimal; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Objects; +import java.util.Optional; + +public class EskimiBidder implements Bidder { + + private static final TypeReference> ESKIMI_EXT_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private final String endpointUrl; + private final JacksonMapper mapper; + + public EskimiBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + final ExtImpEskimi firstExt; + try { + validateRequest(request); + firstExt = parseImpExt(request.getImp().getFirst()); + } catch (PreBidException e) { + return Result.withError(BidderError.badInput(e.getMessage())); + } + + final List validImps = new ArrayList<>(); + final List errors = new ArrayList<>(); + + for (Imp imp : request.getImp()) { + try { + validImps.add(modifyImp(imp)); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + } + } + + final BidRequest outgoingRequest = modifyBidRequest(request, validImps, firstExt); + + return Result.of( + Collections.singletonList(BidderUtil.defaultRequest(outgoingRequest, endpointUrl, mapper)), errors); + } + + private static void validateRequest(BidRequest request) { + if (request.getSite() == null && request.getApp() == null) { + throw new PreBidException("request must contain either site or app"); + } + } + + private ExtImpEskimi parseImpExt(Imp imp) { + try { + return mapper.mapper().convertValue(imp.getExt(), ESKIMI_EXT_TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException("invalid imp.ext for imp %s: %s".formatted(imp.getId(), e.getMessage())); + } + } + + private Imp modifyImp(Imp imp) { + final ExtImpEskimi extImp = parseImpExt(imp); + final List bAttr = extImp.getBattr(); + final Price price = resolvePrice(imp, extImp); + + return imp.toBuilder() + .banner(imp.getBanner() != null ? modifyBanner(imp.getBanner(), bAttr) : null) + .video(imp.getVideo() != null ? modifyVideo(imp.getVideo(), bAttr) : null) + .bidfloor(price.getValue()) + .bidfloorcur(price.getCurrency()) + .secure(ObjectUtils.getIfNull(imp.getSecure(), 1)) + .build(); + } + + private static Banner modifyBanner(Banner banner, List bAttr) { + return CollectionUtils.isNotEmpty(bAttr) && CollectionUtils.isEmpty(banner.getBattr()) + ? banner.toBuilder().battr(bAttr).build() + : banner; + } + + private static Video modifyVideo(Video video, List bAttr) { + return CollectionUtils.isNotEmpty(bAttr) && CollectionUtils.isEmpty(video.getBattr()) + ? video.toBuilder().battr(bAttr).build() + : video; + } + + private static Price resolvePrice(Imp imp, ExtImpEskimi extImp) { + final BigDecimal originalPrice = imp.getBidfloor(); + final String originalCurrency = imp.getBidfloorcur(); + + final BigDecimal newPrice = extImp.getBidFloor(); + + return !BidderUtil.isValidPrice(originalPrice) && BidderUtil.isValidPrice(newPrice) + ? Price.of(StringUtils.defaultIfBlank(extImp.getBidFloorCur(), originalCurrency), newPrice) + : Price.of(originalCurrency, originalPrice); + } + + private static BidRequest modifyBidRequest(BidRequest request, List validImps, ExtImpEskimi ext) { + final Site modifiedSite = request.getSite() != null + ? modifySite(request.getSite(), ext.getPlacementId()) + : null; + final App modifiedApp = modifiedSite == null + ? modifyApp(request.getApp(), ext.getPlacementId()) + : request.getApp(); + + return request.toBuilder() + .imp(validImps) + .site(modifiedSite) + .app(modifiedApp) + .bcat(CollectionUtils.isEmpty(request.getBcat()) ? ext.getBcat() : request.getBcat()) + .badv(CollectionUtils.isEmpty(request.getBadv()) ? ext.getBadv() : request.getBadv()) + .bapp(CollectionUtils.isEmpty(request.getBapp()) ? ext.getBapp() : request.getBapp()) + .build(); + } + + private static Site modifySite(Site site, Integer placementId) { + return site.toBuilder() + .ext(addPlacementId(ObjectUtils.getIfNull(site.getExt(), () -> ExtSite.of(null, null)), placementId)) + .build(); + } + + private static App modifyApp(App app, Integer placementId) { + return app.toBuilder() + .ext(addPlacementId(ObjectUtils.getIfNull(app.getExt(), () -> ExtApp.of(null, null)), placementId)) + .build(); + } + + private static T addPlacementId(T ext, Integer placementId) { + ext.addProperty("placementId", IntNode.valueOf(placementId)); + return ext; + } + + @Override + public Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + try { + final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().getBody(), BidResponse.class); + final List errors = new ArrayList<>(); + return Result.of(extractBids(httpCall.getRequest().getPayload(), bidResponse, errors), errors); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private static List extractBids(BidRequest bidRequest, + BidResponse bidResponse, + List errors) { + + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Collections.emptyList(); + } + + return bidResponse.getSeatbid().stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .filter(Objects::nonNull) + .flatMap(Collection::stream) + .filter(Objects::nonNull) + .map(bid -> createBidderBid(bid, bidRequest.getImp(), bidResponse.getCur(), errors)) + .filter(Objects::nonNull) + .toList(); + } + + private static BidderBid createBidderBid(Bid bid, + List imps, + String currency, + List errors) { + + try { + return BidderBid.of(bid, getBidType(bid, imps), currency); + } catch (PreBidException e) { + errors.add(BidderError.badServerResponse(e.getMessage())); + return null; + } + } + + private static BidType getBidType(Bid bid, List imps) { + return Optional.ofNullable(bidTypeFromMtype(bid)) + .orElseGet(() -> bidTypeFromImp(bid.getImpid(), imps)); + } + + private static BidType bidTypeFromMtype(Bid bid) { + return switch (bid.getMtype()) { + case null -> null; + case 0 -> null; + case 1 -> BidType.banner; + case 2 -> BidType.video; + default -> throw new PreBidException( + "unsupported bid.mtype %d for impression %s (banner and video only)" + .formatted(bid.getMtype(), bid.getImpid())); + }; + } + + private static BidType bidTypeFromImp(String impId, List imps) { + for (Imp imp : imps) { + if (!imp.getId().equals(impId)) { + continue; + } + + final boolean hasBanner = imp.getBanner() != null; + final boolean hasVideo = imp.getVideo() != null; + + if (hasBanner && hasVideo) { + throw new PreBidException( + "bid for multi-format imp %s requires bid.mtype to disambiguate".formatted(impId)); + } + if (hasBanner) { + return BidType.banner; + } + if (hasVideo) { + return BidType.video; + } + + throw new PreBidException( + "unsupported media type for impression %s (banner and video only)".formatted(impId)); + } + + throw new PreBidException( + "unable to resolve media type for impression %s".formatted(impId)); + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/eskimi/ExtImpEskimi.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/eskimi/ExtImpEskimi.java new file mode 100644 index 00000000000..32ac23cd004 --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/eskimi/ExtImpEskimi.java @@ -0,0 +1,28 @@ +package org.prebid.server.proto.openrtb.ext.request.eskimi; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +import java.math.BigDecimal; +import java.util.List; + +@Value(staticConstructor = "of") +public class ExtImpEskimi { + + @JsonProperty("placementId") + Integer placementId; + + @JsonProperty("bidFloor") + BigDecimal bidFloor; + + @JsonProperty("bidFloorCur") + String bidFloorCur; + + List bcat; + + List badv; + + List bapp; + + List battr; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/EskimiConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/EskimiConfiguration.java new file mode 100644 index 00000000000..d484bf70a8d --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/EskimiConfiguration.java @@ -0,0 +1,35 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.eskimi.EskimiBidder; +import org.prebid.server.json.JacksonMapper; +import org.prebid.server.spring.config.bidder.model.BidderConfigurationProperties; +import org.prebid.server.spring.config.bidder.util.BidderDepsAssembler; +import org.prebid.server.spring.env.YamlPropertySourceFactory; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.PropertySource; + +@Configuration +@PropertySource(value = "classpath:/bidder-config/eskimi.yaml", factory = YamlPropertySourceFactory.class) +public class EskimiConfiguration { + + private static final String BIDDER_NAME = "eskimi"; + + @Bean("eskimiConfigurationProperties") + @ConfigurationProperties("adapters.eskimi") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps eskimiBidderDeps(BidderConfigurationProperties eskimiConfigurationProperties, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(eskimiConfigurationProperties) + .bidderCreator(config -> new EskimiBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/eskimi.yaml b/src/main/resources/bidder-config/eskimi.yaml new file mode 100644 index 00000000000..cfdd1d612db --- /dev/null +++ b/src/main/resources/bidder-config/eskimi.yaml @@ -0,0 +1,20 @@ +adapters: + eskimi: + endpoint: https://ittr.eskimi.com/prebidjs + modifying-vast-xml-allowed: false + ortb-version: "2.6" + meta-info: + maintainer-email: prebid@eskimi.com + app-media-types: + - banner + - video + site-media-types: + - banner + - video + supported-vendors: + vendor-id: 814 + usersync: + cookie-family-name: eskimi + redirect: + url: https://ittpx.eskimi.com/sync?sp_id=137&gdpr={gdpr}&gdpr_consent={gdpr_consent}&us_privacy={us_privacy}&gpp={gpp}&gpp_sid={gpp_sid}&dest={redirect_url} + user-macro: '${USER_ID}' diff --git a/src/main/resources/static/bidder-params/eskimi.json b/src/main/resources/static/bidder-params/eskimi.json new file mode 100644 index 00000000000..eabbdbdfc90 --- /dev/null +++ b/src/main/resources/static/bidder-params/eskimi.json @@ -0,0 +1,56 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Eskimi Adapter Params", + "description": "A schema which validates params accepted by the Eskimi adapter", + "type": "object", + "additionalProperties": false, + "properties": { + "placementId": { + "type": "integer", + "minimum": 1, + "description": "The Eskimi placement ID" + }, + "bidFloor": { + "type": "number", + "minimum": 0, + "description": "The minimum bid floor (USD unless bidFloorCur is set)" + }, + "bidFloorCur": { + "type": "string", + "description": "The currency of the bid floor" + }, + "bcat": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Blocked IAB advertiser categories" + }, + "badv": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Blocked advertiser domains" + }, + "bapp": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Blocked app bundles" + }, + "battr": { + "type": "array", + "items": { + "type": "integer", + "minimum": 1, + "maximum": 17 + }, + "description": "Blocked creative attributes (OpenRTB List 5.3)" + } + }, + "required": [ + "placementId" + ] +} diff --git a/src/test/java/org/prebid/server/bidder/eskimi/EskimiBidderTest.java b/src/test/java/org/prebid/server/bidder/eskimi/EskimiBidderTest.java new file mode 100644 index 00000000000..7c006a2db3f --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/eskimi/EskimiBidderTest.java @@ -0,0 +1,646 @@ +package org.prebid.server.bidder.eskimi; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.node.IntNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.App; +import com.iab.openrtb.request.Audio; +import com.iab.openrtb.request.Banner; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.request.Native; +import com.iab.openrtb.request.Site; +import com.iab.openrtb.request.Video; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.junit.jupiter.MockitoExtension; +import org.prebid.server.VertxTest; +import org.prebid.server.bidder.model.BidderBid; +import org.prebid.server.bidder.model.BidderCall; +import org.prebid.server.bidder.model.BidderError; +import org.prebid.server.bidder.model.HttpRequest; +import org.prebid.server.bidder.model.HttpResponse; +import org.prebid.server.bidder.model.Result; +import org.prebid.server.proto.openrtb.ext.ExtPrebid; +import org.prebid.server.proto.openrtb.ext.request.ExtApp; +import org.prebid.server.proto.openrtb.ext.request.ExtSite; +import org.prebid.server.proto.openrtb.ext.request.eskimi.ExtImpEskimi; +import org.prebid.server.proto.openrtb.ext.response.BidType; + +import java.math.BigDecimal; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.function.UnaryOperator; + +import static java.util.Collections.singletonList; +import static java.util.function.UnaryOperator.identity; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; +import static org.assertj.core.api.Assertions.tuple; + +@ExtendWith(MockitoExtension.class) +public class EskimiBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://test.endpoint.com"; + private EskimiBidder target; + + @BeforeEach + public void setUp() { + target = new EskimiBidder(ENDPOINT_URL, jacksonMapper); + } + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException().isThrownBy(() -> new EskimiBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenFirstImpExtIsInvalid() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.ext(mapper.valueToTree(ExtPrebid.of(null, mapper.createArrayNode()))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .extracting(BidderError::getMessage) + .hasSize(1) + .allSatisfy(error -> assertThat(error).startsWith("invalid imp.ext for imp 123")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorWhenSiteAndAppAreMissing() { + // given + final BidRequest bidRequest = givenBidRequest(givenImp(identity())).toBuilder() + .site(null) + .app(null) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .extracting(BidderError::getMessage) + .containsExactly("request must contain either site or app"); + } + + @Test + public void makeHttpRequestsShouldAddErrorsOnInvalidImpsAndProcessValid() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(identity()), + givenImp(imp -> imp.id("456").ext(mapper.valueToTree(ExtPrebid.of(null, mapper.createArrayNode()))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).hasSize(1); + assertThat(result.getErrors()) + .extracting(BidderError::getMessage) + .hasSize(1) + .allSatisfy(error -> assertThat(error).startsWith("invalid imp.ext for imp 456")); + } + + @Test + public void makeHttpRequestsShouldModifyImpSettingBattrForBannerAndVideoWhenEmpty() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp + .banner(Banner.builder().build()) + .video(Video.builder().build()) + .ext(givenImpExt(givenExtImpBattr(List.of(1, 2)))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getBanner, Imp::getVideo) + .containsExactly(tuple( + Banner.builder().battr(List.of(1, 2)).build(), + Video.builder().battr(List.of(1, 2)).build())); + } + + @Test + public void makeHttpRequestsShouldNotOverrideBattrWhenAlreadyPresentInBannerOrVideo() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp + .banner(Banner.builder().battr(List.of(1, 2)).build()) + .video(Video.builder().battr(List.of(3, 4)).build()) + .ext(givenImpExt(givenExtImpBattr(List.of(5, 6)))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getBanner, Imp::getVideo) + .containsExactly(tuple( + Banner.builder().battr(List.of(1, 2)).build(), + Video.builder().battr(List.of(3, 4)).build())); + } + + @Test + public void makeHttpRequestsShouldSetSecureToOneWhenNull() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.secure(null)), + givenImp(imp -> imp.secure(0)), + givenImp(imp -> imp.secure(1))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getSecure) + .containsExactly(1, 0, 1); + } + + @Test + public void makeHttpRequestsShouldUseImpBidfloorAndCurWhenValid() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp + .bidfloor(BigDecimal.TEN) + .bidfloorcur("USD") + .ext(givenImpExt(givenExtImpBidFloor(BigDecimal.ONE, "EUR"))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getBidfloor, Imp::getBidfloorcur) + .containsExactly(tuple(BigDecimal.TEN, "USD")); + } + + @Test + public void makeHttpRequestsShouldFallbackToExtBidfloorAndCurWhenImpInvalid() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp + .bidfloor(BigDecimal.ZERO) + .bidfloorcur(null) + .ext(givenImpExt(givenExtImpBidFloor(BigDecimal.ONE, "EUR"))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getBidfloor, Imp::getBidfloorcur) + .containsExactly(tuple(BigDecimal.ONE, "EUR")); + } + + @Test + public void makeHttpRequestsShouldFallbackToExtBidfloorButKeepImpCurWhenExtCurIsBlank() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp + .bidfloor(null) + .bidfloorcur("USD") + .ext(givenImpExt(givenExtImpBidFloor(BigDecimal.ONE, null))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getBidfloor, Imp::getBidfloorcur) + .containsExactly(tuple(BigDecimal.ONE, "USD")); + } + + @Test + public void makeHttpRequestsShouldApplyRequestParamsFromFirstImpExtWhenMissingInRequest() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.ext(givenImpExt( + givenExtImpBlocked(List.of("cat1"), List.of("adv1"), List.of("app1")))))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getBcat, BidRequest::getBadv, BidRequest::getBapp) + .containsExactly(tuple(List.of("cat1"), List.of("adv1"), List.of("app1"))); + } + + @Test + public void makeHttpRequestsShouldNotOverrideRequestParamsWhenPresentInRequest() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.ext(givenImpExt( + givenExtImpBlocked(List.of("ext_cat1"), List.of("ext_adv1"), List.of("ext_app1")))))) + .toBuilder() + .bcat(List.of("req_cat1")) + .badv(List.of("req_adv1")) + .bapp(List.of("req_app1")) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getBcat, BidRequest::getBadv, BidRequest::getBapp) + .containsExactly(tuple(List.of("req_cat1"), List.of("req_adv1"), List.of("req_app1"))); + } + + @Test + public void makeHttpRequestsShouldSetPlacementIdInSiteExt() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.ext(givenImpExt(givenExtImpEskimi(1))))) + .toBuilder() + .site(Site.builder().build()) + .app(null) + .build(); + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite) + .extracting(Site::getExt) + .extracting(ext -> ext.getProperty("placementId")) + .containsExactly(IntNode.valueOf(1)); + } + + @Test + public void makeHttpRequestsShouldSetPlacementIdInAppExt() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.ext(givenImpExt(givenExtImpEskimi(1))))) + .toBuilder() + .site(null) + .app(App.builder().build()) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getApp) + .extracting(App::getExt) + .extracting(ext -> ext.getProperty("placementId")) + .containsExactly(IntNode.valueOf(1)); + } + + @Test + public void makeHttpRequestsShouldPreserveOriginalSiteExtAndSetPlacementId() { + // given + final ExtSite givenExtSite = ExtSite.of(null, mapper.createObjectNode().put("ANY", "ANY")); + + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.ext(givenImpExt(givenExtImpEskimi(1))))) + .toBuilder() + .site(Site.builder().ext(givenExtSite).build()) + .app(null) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + final ExtSite expectedExtSite = ExtSite.of(null, mapper.createObjectNode().put("ANY", "ANY")); + expectedExtSite.addProperty("placementId", IntNode.valueOf(1)); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite) + .extracting(Site::getExt) + .containsExactly(expectedExtSite); + } + + @Test + public void makeHttpRequestsShouldPreserveOriginalAppExtAndSetPlacementId() { + // given + final ExtApp givenExtApp = ExtApp.of(null, mapper.createObjectNode().put("ANY", "ANY")); + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.ext(givenImpExt(givenExtImpEskimi(1))))) + .toBuilder() + .site(null) + .app(App.builder().ext(givenExtApp).build()) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + final ExtApp expectedExtApp = ExtApp.of(null, mapper.createObjectNode().put("ANY", "ANY")); + expectedExtApp.addProperty("placementId", IntNode.valueOf(1)); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getApp) + .extracting(App::getExt) + .containsExactly(expectedExtApp); + } + + @Test + public void makeBidsShouldReturnErrorWhenResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = givenHttpCall(givenBidRequest(givenImp(identity())), "invalid"); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()) + .singleElement() + .extracting(BidderError::getMessage) + .asString() + .startsWith("Failed to decode: Unrecognized token"); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnEmptyResultWhenResponseHasNoSeatBids() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(givenImp(identity())); + final BidResponse bidResponse = BidResponse.builder() + .seatbid(Collections.emptyList()) + .build(); + + final BidderCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString(bidResponse)); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnBannerBidWhenMtypeIsBanner() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(givenImp(identity())); + final BidderCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123").mtype(1)))); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .singleElement() + .extracting(BidderBid::getType) + .isEqualTo(BidType.banner); + } + + @Test + public void makeBidsShouldReturnVideoBidWhenMtypeIsVideo() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(givenImp(identity())); + final BidderCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123").mtype(2)))); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .singleElement() + .extracting(BidderBid::getType) + .isEqualTo(BidType.video); + } + + @Test + public void makeBidsShouldReturnErrorWhenMtypeIsUnsupported() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(givenImp(identity())); + final BidderCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123").mtype(3)))); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .singleElement() + .extracting(BidderError::getMessage) + .isEqualTo("unsupported bid.mtype 3 for impression 123 (banner and video only)"); + } + + @Test + public void makeBidsShouldResolveBannerBidTypeFromImpWhenMtypeIsMissing() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.banner(Banner.builder().build()).video(null))); + + final BidderCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123").mtype(null)))); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .singleElement() + .extracting(BidderBid::getType) + .isEqualTo(BidType.banner); + } + + @Test + public void makeBidsShouldResolveVideoBidTypeFromImpWhenMtypeIsMissing() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.banner(null).video(Video.builder().build()))); + + final BidderCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123").mtype(null)))); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .singleElement() + .extracting(BidderBid::getType) + .isEqualTo(BidType.video); + } + + @Test + public void makeBidsShouldReturnErrorWhenMtypeIsMissingAndImpHasMultipleFormats() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp.banner(Banner.builder().build()).video(Video.builder().build()))); + + final BidderCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123").mtype(null)))); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .singleElement() + .extracting(BidderError::getMessage) + .isEqualTo("bid for multi-format imp 123 requires bid.mtype to disambiguate"); + } + + @Test + public void makeBidsShouldReturnErrorWhenMtypeMissingAndImpHasNoSupportedFormats() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp(imp -> imp + .banner(null) + .video(null) + .audio(Audio.builder().build()) + .xNative(Native.builder().build()))); + + final BidderCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("123").mtype(null)))); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .singleElement() + .extracting(BidderError::getMessage) + .isEqualTo("unsupported media type for impression 123 (banner and video only)"); + } + + @Test + public void makeBidsShouldReturnErrorWhenMtypeIsMissingAndImpIdNotFound() throws JsonProcessingException { + // given + final BidRequest bidRequest = givenBidRequest(givenImp(identity())); + + final BidderCall httpCall = givenHttpCall( + bidRequest, + mapper.writeValueAsString( + givenBidResponse(bidBuilder -> bidBuilder.impid("404").mtype(null)))); + + // when + final Result> result = target.makeBids(httpCall, bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .singleElement() + .extracting(BidderError::getMessage) + .isEqualTo("unable to resolve media type for impression 404"); + } + + private static BidRequest givenBidRequest(Imp... imps) { + return BidRequest.builder() + .cur(List.of("USD")) + .site(Site.builder().build()) + .imp(Arrays.stream(imps).toList()) + .build(); + } + + private static Imp givenImp(UnaryOperator impCustomizer) { + return impCustomizer.apply(Imp.builder() + .id("123") + .banner(Banner.builder().w(1).h(1).build()) + .ext(givenImpExt(givenExtImpEskimi(1)))) + .build(); + } + + private static ObjectNode givenImpExt(ExtImpEskimi extImpEskimi) { + return mapper.valueToTree(ExtPrebid.of(null, extImpEskimi)); + } + + private static ExtImpEskimi givenExtImpEskimi(Integer placementId) { + return ExtImpEskimi.of(placementId, null, null, null, null, null, null); + } + + private static ExtImpEskimi givenExtImpBattr(List battr) { + return ExtImpEskimi.of(1, null, null, null, null, null, battr); + } + + private static ExtImpEskimi givenExtImpBidFloor(BigDecimal bidFloor, String bidFloorCur) { + return ExtImpEskimi.of(1, bidFloor, bidFloorCur, null, null, null, null); + } + + private static ExtImpEskimi givenExtImpBlocked(List bcat, List badv, List bapp) { + return ExtImpEskimi.of(1, null, null, bcat, badv, bapp, null); + } + + private static BidderCall givenHttpCall(BidRequest bidRequest, String body) { + return BidderCall.succeededHttp( + HttpRequest.builder().payload(bidRequest).build(), + HttpResponse.of(200, null, body), + null); + } + + @SafeVarargs + private BidResponse givenBidResponse(UnaryOperator... bidCustomizers) { + return BidResponse.builder() + .seatbid(singletonList(SeatBid.builder() + .bid(Arrays.stream(bidCustomizers) + .map(bidCustomizer -> bidCustomizer.apply(Bid.builder()).build()) + .toList()) + .build())) + .build(); + } +} diff --git a/src/test/java/org/prebid/server/it/EskimiTest.java b/src/test/java/org/prebid/server/it/EskimiTest.java new file mode 100644 index 00000000000..dbfa588ceec --- /dev/null +++ b/src/test/java/org/prebid/server/it/EskimiTest.java @@ -0,0 +1,33 @@ +package org.prebid.server.it; + +import io.restassured.response.Response; +import org.json.JSONException; +import org.junit.jupiter.api.Test; +import org.prebid.server.model.Endpoint; + +import java.io.IOException; + +import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; +import static com.github.tomakehurst.wiremock.client.WireMock.equalToJson; +import static com.github.tomakehurst.wiremock.client.WireMock.post; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; +import static java.util.Collections.singletonList; + +public class EskimiTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromEskimi() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/eskimi-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/eskimi/test-eskimi-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/eskimi/test-eskimi-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/eskimi/test-auction-eskimi-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/eskimi/test-auction-eskimi-response.json", response, + singletonList("eskimi")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-auction-eskimi-request.json b/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-auction-eskimi-request.json new file mode 100644 index 00000000000..bec343ed7bc --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-auction-eskimi-request.json @@ -0,0 +1,24 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "video": { + "mimes": [ + "video/mp4" + ], + "w": 800, + "h": 600 + }, + "ext": { + "eskimi": { + "placementId": 123 + } + } + } + ], + "tmax": 5000, + "regs": { + "gdpr": 0 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-auction-eskimi-response.json b/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-auction-eskimi-response.json new file mode 100644 index 00000000000..d0d85f706e7 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-auction-eskimi-response.json @@ -0,0 +1,41 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "exp": 1500, + "price": 1.25, + "adm": "adm001", + "crid": "crid", + "w": 800, + "h": 600, + "mtype": 2, + "ext": { + "prebid": { + "type": "video", + "meta": { + "adaptercode": "eskimi" + } + }, + "origbidcpm": 1.25 + } + } + ], + "seat": "eskimi", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "eskimi": "{{ eskimi.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-eskimi-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-eskimi-bid-request.json new file mode 100644 index 00000000000..584712b7332 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-eskimi-bid-request.json @@ -0,0 +1,59 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "secure": 1, + "video": { + "mimes": [ + "video/mp4" + ], + "w": 800, + "h": 600 + }, + "ext": { + "tid" : "${json-unit.any-string}", + "bidder": { + "placementId": 123 + } + } + } + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "site": { + "domain": "www.example.com", + "page": "http://www.example.com", + "publisher": { + "domain": "example.com" + }, + "ext": { + "placementId" : 123, + "amp": 0 + } + }, + "device": { + "ua": "userAgent", + "ip": "193.168.244.1" + }, + "at": 1, + "tmax": "${json-unit.any-number}", + "cur": [ + "USD" + ], + "regs": { + "gdpr": 0 + }, + "ext": { + "prebid": { + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "http_method": "POST", + "endpoint": "/openrtb2/auction" + } + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-eskimi-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-eskimi-bid-response.json new file mode 100644 index 00000000000..b00165a1652 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/eskimi/test-eskimi-bid-response.json @@ -0,0 +1,20 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 1.25, + "crid": "crid", + "adm": "adm001", + "h": 600, + "w": 800, + "mtype": 2 + } + ] + } + ], + "bidid": "bid001" +} diff --git a/src/test/resources/org/prebid/server/it/test-application.properties b/src/test/resources/org/prebid/server/it/test-application.properties index 841d458c749..41a8ecc8636 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -254,6 +254,8 @@ adapters.epsilon.endpoint=http://localhost:8090/epsilon-exchange adapters.epsilon.generate-bid-id=false adapters.escalax.enabled=true adapters.escalax.endpoint=http://localhost:8090/escalax-exchange +adapters.eskimi.enabled=true +adapters.eskimi.endpoint=http://localhost:8090/eskimi-exchange adapters.evolution.enabled=true adapters.evolution.endpoint=http://localhost:8090/evolution-exchange adapters.exco.enabled=true