diff --git a/src/main/java/org/prebid/server/bidder/nativery/NativeryBidder.java b/src/main/java/org/prebid/server/bidder/nativery/NativeryBidder.java new file mode 100644 index 00000000000..ef333e4d95c --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/nativery/NativeryBidder.java @@ -0,0 +1,246 @@ +package org.prebid.server.bidder.nativery; + +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +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.collections4.ListUtils; +import org.apache.commons.lang3.StringUtils; +import org.prebid.server.auction.model.Endpoint; +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.HttpResponse; +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.request.ExtRequest; +import org.prebid.server.proto.openrtb.ext.request.ExtRequestPrebid; +import org.prebid.server.proto.openrtb.ext.request.ExtRequestPrebidServer; +import org.prebid.server.proto.openrtb.ext.request.nativery.BidExtNativery; +import org.prebid.server.proto.openrtb.ext.request.nativery.ExtImpNativery; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebid; +import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebidMeta; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; + +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 NativeryBidder implements Bidder { + + private static final TypeReference> NATIVERY_EXT_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private static final TypeReference> EXT_PREBID_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private static final String DEFAULT_CURRENCY = "EUR"; + + private final String endpointUrl; + private final JacksonMapper mapper; + + public NativeryBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + final List> httpRequests = new ArrayList<>(); + final List errors = new ArrayList<>(); + + final String requestEndpointName = extractEndpointName(request); + final boolean isAmp = StringUtils.equals(requestEndpointName, Endpoint.openrtb2_amp.value()); + + final List validImps = new ArrayList<>(); + String widgetId = null; + + for (Imp imp : request.getImp()) { + try { + final ExtImpNativery extImp = parseImpExt(imp); + if (widgetId == null && StringUtils.isNotBlank(extImp.getWidgetId())) { + widgetId = extImp.getWidgetId(); + } + validImps.add(imp); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + } + } + + if (validImps.isEmpty()) { + return Result.withErrors(errors); + } + + final ExtRequest updatedExt = buildRequestExtWithNativery(request.getExt(), isAmp, widgetId); + + for (Imp imp : validImps) { + final BidRequest singleImpRequest = request.toBuilder() + .imp(Collections.singletonList(imp)) + .ext(updatedExt) + .build(); + + httpRequests.add(BidderUtil.defaultRequest(singleImpRequest, endpointUrl, mapper)); + } + + return Result.of(httpRequests, errors); + } + + private static String extractEndpointName(BidRequest bidRequest) { + return Optional.ofNullable(bidRequest) + .map(BidRequest::getExt) + .map(ExtRequest::getPrebid) + .map(ExtRequestPrebid::getServer) + .map(ExtRequestPrebidServer::getEndpoint) + .orElse(null); + } + + private ExtImpNativery parseImpExt(Imp imp) { + try { + return mapper.mapper().convertValue(imp.getExt(), NATIVERY_EXT_TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException("Failed to deserialize Nativery extension: " + e.getMessage()); + } + } + + private ExtRequest buildRequestExtWithNativery(ExtRequest originalExt, boolean isAmp, String widgetId) { + final ExtRequest ext = originalExt != null ? originalExt : ExtRequest.empty(); + + final JsonNode existing = ext.getProperty("nativery"); + final ObjectNode nativeryNode = existing != null && existing.isObject() + ? (ObjectNode) existing + : mapper.mapper().createObjectNode(); + + nativeryNode.put("isAmp", isAmp); + if (StringUtils.isNotBlank(widgetId)) { + nativeryNode.put("widgetId", widgetId); + } + + ext.addProperty("nativery", nativeryNode); + return ext; + } + + @Override + public Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + final List errors = new ArrayList<>(); + + final HttpResponse response = httpCall.getResponse(); + + try { + final BidResponse bidResponse = mapper.decodeValue(response.getBody(), BidResponse.class); + final List bidderBids = extractBids(bidResponse, errors); + return Result.of(bidderBids, errors); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private List extractBids(BidResponse bidResponse, List errors) { + if (bidResponse == null || CollectionUtils.isEmpty(bidResponse.getSeatbid())) { + return Collections.emptyList(); + } + + final String currency = StringUtils.defaultIfBlank(bidResponse.getCur(), DEFAULT_CURRENCY); + + return bidResponse.getSeatbid().stream() + .filter(Objects::nonNull) + .map(SeatBid::getBid) + .filter(Objects::nonNull) + .flatMap(Collection::stream) + .filter(Objects::nonNull) + .map(bid -> resolveBidderBid(bid, currency, errors)) + .filter(Objects::nonNull) + .toList(); + } + + private BidderBid resolveBidderBid(Bid bid, String currency, List errors) { + try { + final BidExtNativery nativeryExt = parseNativeryExt(bid.getExt()); + + final BidType bidType = mapMediaType(nativeryExt.getBidAdMediaType()); + final List advDomains = ListUtils.emptyIfNull( + nativeryExt.getBidAdvDomains()); + + final Bid updatedBid = addBidMeta(bid, bidType.getName(), advDomains); + return BidderBid.of(updatedBid, bidType, currency); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + return null; + } + } + + private BidExtNativery parseNativeryExt(ObjectNode bidExt) { + return Optional.ofNullable(bidExt) + .map(ext -> ext.get("nativery")) + .filter(JsonNode::isObject) + .map(this::toBidExtNativery) + .orElseThrow(() -> new PreBidException("missing bid.ext.nativery")); + } + + private BidExtNativery toBidExtNativery(JsonNode node) { + try { + return mapper.mapper().convertValue(node, BidExtNativery.class); + } catch (IllegalArgumentException e) { + throw new PreBidException("invalid bid.ext.nativery: " + e.getMessage()); + } + } + + private static BidType mapMediaType(String mediaType) { + final String mt = StringUtils.defaultString(mediaType).toLowerCase(); + return switch (mt) { + case "native" -> BidType.xNative; + case "display", "banner", "rich_media" -> BidType.banner; + case "video" -> BidType.video; + default -> throw new PreBidException( + "unrecognized bid_ad_media_type in response from nativery: " + mediaType); + }; + } + + private Bid addBidMeta(Bid bid, String mediaType, List advDomains) { + final ExtBidPrebid prebid = parseExtBidPrebid(bid); + + final ExtBidPrebidMeta modifiedMeta = Optional.ofNullable(prebid) + .map(ExtBidPrebid::getMeta) + .map(ExtBidPrebidMeta::toBuilder) + .orElseGet(ExtBidPrebidMeta::builder) + .mediaType(mediaType) + .advertiserDomains(advDomains) + .build(); + + final ExtBidPrebid modifiedPrebid = Optional.ofNullable(prebid) + .map(ExtBidPrebid::toBuilder) + .orElseGet(ExtBidPrebid::builder) + .meta(modifiedMeta) + .build(); + + return bid.toBuilder() + .ext(mapper.mapper().valueToTree(ExtPrebid.of(modifiedPrebid, null))) + .build(); + } + + private ExtBidPrebid parseExtBidPrebid(Bid bid) { + try { + return mapper.mapper() + .convertValue(bid.getExt(), EXT_PREBID_TYPE_REFERENCE) + .getPrebid(); + } catch (IllegalArgumentException e) { + throw new PreBidException("Failed to deserialize Prebid extension: " + e.getMessage()); + } + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/nativery/BidExtNativery.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/nativery/BidExtNativery.java new file mode 100644 index 00000000000..3c7ee391327 --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/nativery/BidExtNativery.java @@ -0,0 +1,13 @@ +package org.prebid.server.proto.openrtb.ext.request.nativery; + +import lombok.Value; + +import java.util.List; + +@Value(staticConstructor = "of") +public class BidExtNativery { + + String bidAdMediaType; + + List bidAdvDomains; +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/nativery/ExtImpNativery.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/nativery/ExtImpNativery.java new file mode 100644 index 00000000000..cd1554111e0 --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/nativery/ExtImpNativery.java @@ -0,0 +1,11 @@ +package org.prebid.server.proto.openrtb.ext.request.nativery; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +@Value(staticConstructor = "of") +public class ExtImpNativery { + + @JsonProperty("widgetId") + String widgetId; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/NativeryBidderConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/NativeryBidderConfiguration.java new file mode 100644 index 00000000000..0dc07f48e94 --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/NativeryBidderConfiguration.java @@ -0,0 +1,41 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.nativery.NativeryBidder; +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.config.bidder.util.UsersyncerCreator; +import org.prebid.server.spring.env.YamlPropertySourceFactory; +import org.springframework.beans.factory.annotation.Value; +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; + +import jakarta.validation.constraints.NotBlank; + +@Configuration +@PropertySource(value = "classpath:/bidder-config/nativery.yaml", factory = YamlPropertySourceFactory.class) +public class NativeryBidderConfiguration { + + private static final String BIDDER_NAME = "nativery"; + + @Bean("nativeryConfigurationProperties") + @ConfigurationProperties("adapters.nativery") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps nativeryBidderDeps(BidderConfigurationProperties nativeryConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(nativeryConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new NativeryBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/nativery.yaml b/src/main/resources/bidder-config/nativery.yaml new file mode 100644 index 00000000000..e37bc8dcd4d --- /dev/null +++ b/src/main/resources/bidder-config/nativery.yaml @@ -0,0 +1,12 @@ +adapters: + nativery: + endpoint: "https://hb.nativery.com/openrtb2/auction" + ortb-version: "2.6" + meta-info: + maintainer-email: "developer@nativery.com" + site-media-types: + - banner + - video + - native + supported-vendors: + vendor-id: 1133 diff --git a/src/main/resources/static/bidder-params/nativery.json b/src/main/resources/static/bidder-params/nativery.json new file mode 100644 index 00000000000..9f8dc02c274 --- /dev/null +++ b/src/main/resources/static/bidder-params/nativery.json @@ -0,0 +1,15 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Nativery Adapter Params", + "description": "A schema which validates params accepted by the Nativery adapter", + + "type": "object", + "properties": { + "widgetId": { + "type": "string", + "description": "An ID which identifies this Nativery widget" + } + }, + + "required": ["widgetId"] +} diff --git a/src/test/java/org/prebid/server/bidder/nativery/NativeryBidderTest.java b/src/test/java/org/prebid/server/bidder/nativery/NativeryBidderTest.java new file mode 100644 index 00000000000..ffc0a8a1d9f --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/nativery/NativeryBidderTest.java @@ -0,0 +1,529 @@ +package org.prebid.server.bidder.nativery; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.TextNode; +import com.iab.openrtb.request.BidRequest; +import com.iab.openrtb.request.Imp; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import org.junit.jupiter.api.Test; +import org.prebid.server.VertxTest; +import org.prebid.server.auction.model.Endpoint; +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.ExtRequest; +import org.prebid.server.proto.openrtb.ext.request.ExtRequestPrebid; +import org.prebid.server.proto.openrtb.ext.request.ExtRequestPrebidServer; +import org.prebid.server.proto.openrtb.ext.request.nativery.ExtImpNativery; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.proto.openrtb.ext.response.ExtBidPrebid; + +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.function.UnaryOperator; + +import static java.util.Arrays.asList; +import static java.util.Collections.singletonList; +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; +import static org.prebid.server.proto.openrtb.ext.response.BidType.audio; +import static org.prebid.server.proto.openrtb.ext.response.BidType.banner; +import static org.prebid.server.util.HttpUtil.ACCEPT_HEADER; +import static org.prebid.server.util.HttpUtil.APPLICATION_JSON_CONTENT_TYPE; +import static org.prebid.server.util.HttpUtil.CONTENT_TYPE_HEADER; +import static org.springframework.util.MimeTypeUtils.APPLICATION_JSON_VALUE; + +public class NativeryBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = "https://test.com/test"; + private static final String DEFAULT_CURRENCY = "EUR"; + + private final NativeryBidder target = new NativeryBidder(ENDPOINT_URL, jacksonMapper); + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException().isThrownBy(() -> new NativeryBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldMakeOneRequestPerImp() { + // given + final BidRequest bidRequest = BidRequest.builder() + .imp(asList( + givenImp(UnaryOperator.identity()), + givenImp(imp -> imp.id("321").ext(mapper.valueToTree(ExtPrebid + .of(null, ExtImpNativery.of("widget2"))))))) + .build(); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(2) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getImp) + .extracting(List::size) + .containsOnly(1); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getId) + .containsExactlyInAnyOrder("123", "321"); + assertThat(result.getValue()).hasSize(2) + .extracting(HttpRequest::getImpIds) + .containsExactly(Set.of("123"), Set.of("321")); + } + + @Test + public void makeHttpRequestsShouldUseCorrectUri() { + // given + final BidRequest bidRequest = givenBidRequest(UnaryOperator.identity()); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getUri) + .containsExactly(ENDPOINT_URL); + } + + @Test + public void makeHttpRequestsShouldSetExtWithWidgetId() { + // given + final BidRequest bidRequest = givenBidRequest(UnaryOperator.identity()); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getExt) + .extracting(ext -> ext.getProperty("nativery").path("widgetId").asText()) + .containsOnly("widget1"); + } + + @Test + public void makeHttpRequestsShouldPreserveOriginalExtFields() { + // given + final ExtRequest extRequest = ExtRequest.empty(); + extRequest.addProperty("accountId", TextNode.valueOf("acc-123")); + final BidRequest bidRequest = givenBidRequest( + requestBuilder -> requestBuilder.ext(extRequest), + UnaryOperator.identity()); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + + final ExtRequest resultingExt = result.getValue().get(0).getPayload().getExt(); + + assertThat(resultingExt.getProperty("accountId").asText()).isEqualTo("acc-123"); + assertThat(resultingExt.getProperty("nativery").path("widgetId").asText()).isEqualTo("widget1"); + } + + @Test + public void makeHttpRequestsShouldSetExtWithAmpTrue() { + // given + final ExtRequestPrebidServer server = ExtRequestPrebidServer.of( + null, null, null, Endpoint.openrtb2_amp.value()); + final ExtRequestPrebid prebid = ExtRequestPrebid.builder() + .server(server) + .build(); + + final ExtRequest extRequest = ExtRequest.of(prebid); + + final BidRequest bidRequest = givenBidRequest( + requestBuilder -> requestBuilder.ext(extRequest), + UnaryOperator.identity()); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getExt) + .extracting(ext -> ext.getProperty("nativery").path("isAmp").asBoolean()) + .containsOnly(true); + } + + @Test + public void makeHttpRequestsShouldReturnErrorIfImpExtCannotBeParsed() { + // given + final BidRequest bidRequest = givenBidRequest(impBuilder -> + impBuilder.ext(mapper.createObjectNode().set("bidder", mapper.createArrayNode()))); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()) + .hasSize(1) + .allSatisfy(error -> { + assertThat(error.getMessage()) + .startsWith("Failed to deserialize Nativery extension:"); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldReturnExpectedHeaders() { + // given + final BidRequest bidRequest = givenBidRequest(UnaryOperator.identity()); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).hasSize(1).first() + .extracting(HttpRequest::getHeaders) + .satisfies(headers -> assertThat(headers.get(CONTENT_TYPE_HEADER)) + .isEqualTo(APPLICATION_JSON_CONTENT_TYPE)) + .satisfies(headers -> assertThat(headers.get(ACCEPT_HEADER)) + .isEqualTo(APPLICATION_JSON_VALUE)); + assertThat(result.getErrors()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnEmptyListIfBidResponseIsNull() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall(mapper.writeValueAsString(null)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnErrorIfResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = givenHttpCall("invalid"); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getMessage()).startsWith("Failed to decode:"); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + }); + } + + @Test + public void makeBidsShouldReturnEmptyListIfBidResponseSeatBidIsNull() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + mapper.writeValueAsString(BidResponse.builder().build())); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeBidsShouldReturnBannerBid() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + givenBidResponse(bidBuilder -> bidBuilder + .impid("123") + .ext(mapper.valueToTree(Map.of( + "nativery", Map.of("bid_ad_media_type", "banner")))))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + + final BidderBid bidderBid = result.getValue().get(0); + assertThat(bidderBid.getType()).isEqualTo(BidType.banner); + assertThat(bidderBid.getBidCurrency()).isEqualTo(DEFAULT_CURRENCY); + + final Bid bid = bidderBid.getBid(); + assertThat(bid.getImpid()).isEqualTo("123"); + + final JsonNode prebidMeta = bid.getExt().path("prebid").path("meta"); + assertThat(prebidMeta.path("mediaType").asText()).isEqualTo("banner"); + assertThat(prebidMeta.path("advertiserDomains").isArray()).isTrue(); + assertThat(prebidMeta.path("advertiserDomains").size()).isEqualTo(0); + } + + @Test + public void makeBidsShouldReturnBannerBidForDisplayType() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + givenBidResponse(bidBuilder -> bidBuilder + .impid("123") + .ext(mapper.valueToTree(Map.of( + "nativery", Map.of("bid_ad_media_type", "display")))))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + + final BidderBid bidderBid = result.getValue().get(0); + assertThat(bidderBid.getType()).isEqualTo(BidType.banner); + assertThat(bidderBid.getBidCurrency()).isEqualTo(DEFAULT_CURRENCY); + + final Bid bid = bidderBid.getBid(); + assertThat(bid.getImpid()).isEqualTo("123"); + + final JsonNode prebidMeta = bid.getExt().path("prebid").path("meta"); + assertThat(prebidMeta.path("mediaType").asText()).isEqualTo("banner"); + assertThat(prebidMeta.path("advertiserDomains").isArray()).isTrue(); + assertThat(prebidMeta.path("advertiserDomains").size()).isEqualTo(0); + } + + @Test + public void makeBidsShouldReturnBannerBidForRichMediaType() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + givenBidResponse(bidBuilder -> bidBuilder + .impid("123") + .ext(mapper.valueToTree(Map.of("nativery", Map.of("bid_ad_media_type", "rich_media")))))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + + final BidderBid bidderBid = result.getValue().get(0); + assertThat(bidderBid.getType()).isEqualTo(banner); + assertThat(bidderBid.getBidCurrency()).isEqualTo(DEFAULT_CURRENCY); + + final Bid bid = bidderBid.getBid(); + assertThat(bid.getImpid()).isEqualTo("123"); + + final JsonNode prebidMeta = bid.getExt().path("prebid").path("meta"); + assertThat(prebidMeta.path("mediaType").asText()).isEqualTo("banner"); + assertThat(prebidMeta.path("advertiserDomains").isArray()).isTrue(); + assertThat(prebidMeta.path("advertiserDomains").size()).isEqualTo(0); + } + + @Test + public void makeBidsShouldReturnVideoBid() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + givenBidResponse(bidBuilder -> bidBuilder + .impid("123") + .ext(mapper.valueToTree(Map.of( + "nativery", Map.of("bid_ad_media_type", "video")))))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + + final BidderBid bidderBid = result.getValue().get(0); + assertThat(bidderBid.getType()).isEqualTo(BidType.video); + assertThat(bidderBid.getBidCurrency()).isEqualTo(DEFAULT_CURRENCY); + + final Bid bid = bidderBid.getBid(); + assertThat(bid.getImpid()).isEqualTo("123"); + + final JsonNode prebidMeta = bid.getExt().path("prebid").path("meta"); + assertThat(prebidMeta.path("mediaType").asText()).isEqualTo("video"); + assertThat(prebidMeta.path("advertiserDomains").isArray()).isTrue(); + assertThat(prebidMeta.path("advertiserDomains").size()).isEqualTo(0); + } + + @Test + public void makeBidsShouldReturnNativeBid() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + givenBidResponse(bidBuilder -> bidBuilder + .impid("123") + .ext(mapper.valueToTree(Map.of( + "nativery", Map.of("bid_ad_media_type", "native")))))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + + final BidderBid bidderBid = result.getValue().get(0); + assertThat(bidderBid.getType()).isEqualTo(BidType.xNative); + assertThat(bidderBid.getBidCurrency()).isEqualTo(DEFAULT_CURRENCY); + + final Bid bid = bidderBid.getBid(); + assertThat(bid.getImpid()).isEqualTo("123"); + + final JsonNode prebidMeta = bid.getExt().path("prebid").path("meta"); + assertThat(prebidMeta.path("mediaType").asText()).isEqualTo("native"); + assertThat(prebidMeta.path("advertiserDomains").isArray()).isTrue(); + assertThat(prebidMeta.path("advertiserDomains").size()).isEqualTo(0); + + assertThat(bid.getExt().has("nativery")).isFalse(); + } + + @Test + public void makeBidsShouldHandleUnsupportedBidType() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + givenBidResponse(b -> b + .ext(mapper.valueToTree(Map.of( + "prebid", ExtBidPrebid.builder().type(audio).build(), + "nativery", Map.of("bid_ad_media_type", "audio") + ))) + .impid("123")) + ); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .hasSize(1) + .allSatisfy(error -> { + assertThat(error.getMessage()) + .isEqualTo("unrecognized bid_ad_media_type in response from nativery: audio"); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + }); + } + + @Test + public void makeBidsShouldAddMetadataFromNativeryExt() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + givenBidResponse(bidBuilder -> bidBuilder + .impid("123") + .ext(mapper.valueToTree(Map.of( + "nativery", Map.of( + "bid_ad_media_type", "native", + "bid_adv_domains", List.of("domain.com"))))))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1); + + final BidderBid bidderBid = result.getValue().get(0); + assertThat(bidderBid.getType()).isEqualTo(BidType.xNative); + assertThat(bidderBid.getBidCurrency()).isEqualTo(DEFAULT_CURRENCY); + + final Bid bid = bidderBid.getBid(); + assertThat(bid.getImpid()).isEqualTo("123"); + + final JsonNode prebidMeta = bid.getExt().path("prebid").path("meta"); + assertThat(prebidMeta.path("mediaType").asText()).isEqualTo("native"); + assertThat(prebidMeta.path("advertiserDomains").isArray()).isTrue(); + assertThat(prebidMeta.path("advertiserDomains").get(0).asText()).isEqualTo("domain.com"); + + assertThat(bid.getExt().has("nativery")).isFalse(); + } + + @Test + public void makeBidsShouldReturnErrorForInvalidMediaType() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + givenBidResponse(bidBuilder -> bidBuilder + .id("123") + .ext(mapper.valueToTree(Map.of("nativery", Map.of("bid_ad_media_type", "invalid")))))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .hasSize(1) + .allSatisfy(error -> { + assertThat(error.getMessage()).startsWith("unrecognized bid_ad_media_type"); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + }); + } + + @Test + public void makeBidsShouldReturnErrorForMissingNativeryExt() throws JsonProcessingException { + // given + final BidderCall httpCall = givenHttpCall( + givenBidResponse(bidBuilder -> bidBuilder.id("123").ext(mapper.createObjectNode()))); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .hasSize(1) + .allSatisfy(error -> { + assertThat(error.getMessage()).isEqualTo("missing bid.ext.nativery"); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + }); + } + + private static BidRequest givenBidRequest( + UnaryOperator requestCustomizer, + UnaryOperator impCustomizer) { + + return requestCustomizer.apply(BidRequest.builder() + .imp(singletonList(givenImp(impCustomizer)))) + .build(); + } + + private static BidRequest givenBidRequest(UnaryOperator impCustomizer) { + return givenBidRequest(UnaryOperator.identity(), impCustomizer); + } + + private static Imp givenImp(UnaryOperator impCustomizer) { + return impCustomizer.apply(Imp.builder() + .id("123") + .ext(mapper.valueToTree(ExtPrebid.of(null, ExtImpNativery.of("widget1"))))) + .build(); + } + + private static String givenBidResponse(UnaryOperator bidCustomizer) throws JsonProcessingException { + final BidResponse bidResponse = BidResponse.builder() + .cur(DEFAULT_CURRENCY) + .seatbid(singletonList(SeatBid.builder().bid(singletonList(bidCustomizer.apply(Bid.builder()).build())) + .build())) + .build(); + return mapper.writeValueAsString(bidResponse); + } + + private static BidderCall givenHttpCall(String body) { + return BidderCall.succeededHttp( + HttpRequest.builder().payload(null).build(), + HttpResponse.of(200, null, body), + null); + } +} + diff --git a/src/test/java/org/prebid/server/it/NativeryTest.java b/src/test/java/org/prebid/server/it/NativeryTest.java new file mode 100644 index 00000000000..b4df3c59702 --- /dev/null +++ b/src/test/java/org/prebid/server/it/NativeryTest.java @@ -0,0 +1,32 @@ +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 NativeryTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromNativery() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/nativery-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/nativery/test-nativery-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/nativery/test-nativery-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/nativery/test-auction-nativery-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/nativery/test-auction-nativery-response.json", response, singletonList("nativery")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-auction-nativery-request.json b/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-auction-nativery-request.json new file mode 100644 index 00000000000..46fa1b2e2e8 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-auction-nativery-request.json @@ -0,0 +1,54 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "nativery": { + "widgetId": "1" + } + } + } + ], + "site": { + "domain": "www.example.com", + "page": "http://www.example.com", + "publisher": { + "domain": "example.com" + }, + "ext": { + "amp": 0 + } + }, + "device": { + "ua": "userAgent", + "ip": "193.168.244.1" + }, + "at": 1, + "tmax": 5000, + "cur": [ + "USD" + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "regs": { + "ext": { + "gdpr": 0 + } + }, + "ext": { + "prebid": { + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "endpoint": "/openrtb2/auction" + } + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-auction-nativery-response.json b/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-auction-nativery-response.json new file mode 100644 index 00000000000..97b4616fe92 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-auction-nativery-response.json @@ -0,0 +1,43 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "exp": 300, + "price": 3.33, + "adm": "
ad
", + "adomain": ["example.com"], + "crid": "creativeId", + "mtype": 1, + "ext": { + "origbidcpm": 3.33, + "origbidcur": "USD", + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "nativery", + "mediaType": "banner", + "advertiserDomains": ["example.com"] + } + } + } + } + ], + "seat": "nativery", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "nativery": "{{ nativery.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-nativery-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-nativery-bid-request.json new file mode 100644 index 00000000000..1a5e555fc90 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-nativery-bid-request.json @@ -0,0 +1,61 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "secure": 1, + "ext": { + "tid": "${json-unit.any-string}", + "bidder": { + "widgetId": "1" + } + } + } + ], + "site": { + "domain": "www.example.com", + "page": "http://www.example.com", + "publisher": { + "domain": "example.com" + }, + "ext": { + "amp": 0 + } + }, + "device": { + "ua": "userAgent", + "ip": "193.168.244.1" + }, + "at": 1, + "tmax": "${json-unit.any-number}", + "cur": [ + "USD" + ], + "source": { + "tid": "${json-unit.any-string}" + }, + "regs": { + "gdpr": 0 + }, + "ext": { + "prebid": { + "channel": { + "name": "web" + }, + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "endpoint": "/openrtb2/auction" + } + }, + "nativery": { + "isAmp": false, + "widgetId": "1" + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-nativery-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-nativery-bid-response.json new file mode 100644 index 00000000000..1b2e894477e --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/nativery/test-nativery-bid-response.json @@ -0,0 +1,29 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 3.33, + "adm": "
ad
", + "adomain": [ + "example.com" + ], + "crid": "creativeId", + "mtype": 1, + "ext": { + "nativery": { + "bid_ad_media_type": "display", + "bid_adv_domains": [ + "example.com" + ] + } + } + } + ] + } + ], + "cur": "USD" +} 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 3d57277ff9d..63e1a41c32a 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -394,6 +394,8 @@ adapters.mobkoi.enabled=true adapters.mobkoi.endpoint=http://localhost:8090/mobkoi-exchange adapters.motorik.enabled=true adapters.motorik.endpoint=http://localhost:8090/motorik-exchange?k={{AccountID}}&name={{SourceId}} +adapters.nativery.enabled=true +adapters.nativery.endpoint=http://localhost:8090/nativery-exchange adapters.nextmillennium.enabled=true adapters.nextmillennium.endpoint=http://localhost:8090/nextmillennium-exchange adapters.nextmillennium.extra-info.nmmFlags=1