From 3b1abb952adafbb44cff777737e15fb490540046 Mon Sep 17 00:00:00 2001 From: pkaczmarek Date: Tue, 30 Sep 2025 17:00:38 +0200 Subject: [PATCH] New Adapter: Nativery --- .../bidder/nativery/NativeryBidder.java | 271 ++++++++++ .../ext/request/nativery/ExtImpNativery.java | 11 + .../bidder/NativeryBidderConfiguration.java | 41 ++ .../resources/bidder-config/nativery.yaml | 12 + .../static/bidder-params/nativery.json | 15 + .../bidder/nativery/NativeryBidderTest.java | 478 ++++++++++++++++++ .../org/prebid/server/it/NativeryTest.java | 32 ++ .../test-auction-nativery-request.json | 54 ++ .../test-auction-nativery-response.json | 43 ++ .../nativery/test-nativery-bid-request.json | 61 +++ .../nativery/test-nativery-bid-response.json | 29 ++ .../server/it/test-application.properties | 2 + 12 files changed, 1049 insertions(+) create mode 100644 src/main/java/org/prebid/server/bidder/nativery/NativeryBidder.java create mode 100644 src/main/java/org/prebid/server/proto/openrtb/ext/request/nativery/ExtImpNativery.java create mode 100644 src/main/java/org/prebid/server/spring/config/bidder/NativeryBidderConfiguration.java create mode 100644 src/main/resources/bidder-config/nativery.yaml create mode 100644 src/main/resources/static/bidder-params/nativery.json create mode 100644 src/test/java/org/prebid/server/bidder/nativery/NativeryBidderTest.java create mode 100644 src/test/java/org/prebid/server/it/NativeryTest.java create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/nativery/test-auction-nativery-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/nativery/test-auction-nativery-response.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/nativery/test-nativery-bid-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/nativery/test-nativery-bid-response.json 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..ca12478be17 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/nativery/NativeryBidder.java @@ -0,0 +1,271 @@ +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 io.vertx.core.MultiMap; +import org.apache.commons.collections4.CollectionUtils; +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.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.ExtSite; +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; + +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 static final String NATIVERY_ERROR_HEADER = "X-Nativery-Error"; + + 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 boolean isAmp = isAmpRequest(request); + + final List validImps = new ArrayList<>(); + String widgetId = null; + + for (Imp imp : request.getImp()) { + try { + final ExtImpNativery extImp = parseImpExt(imp); + if (widgetId == null && extImp != 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.of(Collections.emptyList(), errors); + } + + final ExtRequest updatedExt = buildRequestExtWithNativery(request.getExt(), isAmp, widgetId); + + for (Imp imp : validImps) { + final BidRequest singleImpRequest = request.toBuilder() + .imp(Collections.singletonList(imp)) + .ext(updatedExt) + .cur(Collections.singletonList(DEFAULT_CURRENCY)) + .build(); + + httpRequests.add(BidderUtil.defaultRequest(singleImpRequest, endpointUrl, mapper)); + } + + return Result.of(httpRequests, errors); + } + + private ExtImpNativery parseImpExt(Imp imp) { + try { + final ExtPrebid ext = + mapper.mapper().convertValue(imp.getExt(), NATIVERY_EXT_TYPE_REFERENCE); + return ext != null ? ext.getBidder() : null; + } catch (IllegalArgumentException e) { + throw new PreBidException(e.getMessage()); + } + } + + private ExtRequest buildRequestExtWithNativery(ExtRequest originalExt, boolean isAmp, String widgetId) { + final ObjectNode extNode = mapper.mapper().convertValue(originalExt, ObjectNode.class); + final ObjectNode root = extNode != null ? extNode : mapper.mapper().createObjectNode(); + + final ObjectNode nativeryNode = root.with("nativery"); + nativeryNode.put("isAmp", isAmp); + if (widgetId != null) { + nativeryNode.put("widgetId", widgetId); + } + + return mapper.mapper().convertValue(root, ExtRequest.class); + } + + private boolean isAmpRequest(BidRequest request) { + if (request.getSite() == null || request.getSite().getExt() == null) { + return false; + } + try { + final ExtSite extSite = mapper.mapper().convertValue(request.getSite().getExt(), ExtSite.class); + final Integer amp = extSite != null ? extSite.getAmp() : null; + return amp != null && amp == 1; + } catch (Exception e) { + return false; + } + } + + @Override + public Result> makeBids(BidderCall httpCall, BidRequest bidRequest) { + final List errors = new ArrayList<>(); + + if (httpCall.getResponse() != null && httpCall.getResponse().getStatusCode() == 204) { + final MultiMap headers = httpCall.getResponse().getHeaders(); + final String nativeryErr = headers != null ? headers.get(NATIVERY_ERROR_HEADER) : null; + if (StringUtils.isNotBlank(nativeryErr)) { + return Result.withError(BidderError.badInput("Nativery Error: " + nativeryErr + ".")); + } + return Result.withError(BidderError.badServerResponse("No Content")); + } + + try { + final BidResponse bidResponse = mapper.decodeValue(httpCall.getResponse().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 ObjectNode nativeryExt = extractNativeryExt(bid.getExt()); + final String mediaTypeRaw = getText(nativeryExt, "bid_ad_media_type"); + final BidType bidType = mapMediaType(mediaTypeRaw); + + final List advDomains = readStringArray(nativeryExt, "bid_adv_domains"); + final Bid updatedBid = addBidMeta(bid, mediaTypeString(bidType), advDomains); + + return BidderBid.of(updatedBid, bidType, currency); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + return null; + } + } + + private ObjectNode extractNativeryExt(ObjectNode bidExt) { + if (bidExt == null) { + throw new PreBidException("missing bid.ext"); + } + final JsonNode node = bidExt.get("nativery"); + if (!(node instanceof ObjectNode nativeryNode)) { + throw new PreBidException("missing bid.ext.nativery"); + } + return nativeryNode; + } + + private static String getText(ObjectNode node, String field) { + final JsonNode v = node.get(field); + return v != null && v.isTextual() ? v.asText() : null; + } + + private static List readStringArray(ObjectNode node, String field) { + final JsonNode arr = node.get(field); + if (arr == null || !arr.isArray()) { + return Collections.emptyList(); + } + final List out = new ArrayList<>(); + arr.forEach(e -> { + if (e != null && e.isTextual()) { + out.add(e.asText()); + } + }); + return out; + } + + 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 static String mediaTypeString(BidType type) { + return switch (type) { + case banner -> "banner"; + case video -> "video"; + case xNative -> "native"; + default -> throw new IllegalStateException("Unexpected value: " + type); + }; + } + + private Bid addBidMeta(Bid bid, String mediaType, List advDomains) { + final ExtBidPrebid prebid = parseExtBidPrebid(bid); + + final ExtBidPrebidMeta modifiedMeta = (prebid != null && prebid.getMeta() != null + ? prebid.getMeta().toBuilder() + : ExtBidPrebidMeta.builder()) + .mediaType(mediaType) + .advertiserDomains(advDomains) + .build(); + + final ExtBidPrebid modifiedPrebid = (prebid != null ? prebid.toBuilder() : 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) { + return null; + } + } +} 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..dd21eb4909a --- /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..4c24d560ca5 --- /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: 0 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..815f553db92 --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/nativery/NativeryBidderTest.java @@ -0,0 +1,478 @@ +package org.prebid.server.bidder.nativery; + +import com.fasterxml.jackson.core.JsonProcessingException; +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.request.Site; +import com.iab.openrtb.response.Bid; +import com.iab.openrtb.response.BidResponse; +import com.iab.openrtb.response.SeatBid; +import io.vertx.core.MultiMap; +import org.junit.jupiter.api.Test; +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.ExtSite; +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.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.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 static final String NATIVERY_ERROR_HEADER = "X-Nativery-Error"; + + 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"); + } + + @Test + public void makeHttpRequestsShouldIncludeImpIds() { + // given + final BidRequest bidRequest = givenBidRequest(impBuilder -> impBuilder.id("imp1")); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getId) + .containsExactly("imp1"); + } + + @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 -> mapper.convertValue(ext, ObjectNode.class) + .path("nativery").path("widgetId").asText()) + .containsOnly("widget1"); + } + + @Test + public void makeHttpRequestsShouldSetExtWithAmpTrue() { + // given + final ExtSite extSite = ExtSite.of(1, null); + final BidRequest bidRequest = givenBidRequest( + requestBuilder -> requestBuilder.site(Site.builder().ext(extSite).build()), + 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 -> mapper.convertValue(ext, ObjectNode.class) + .path("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("Cannot deserialize"); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + }); + assertThat(result.getValue()).isEmpty(); + } + + @Test + public void makeHttpRequestsShouldSetDefaultCurrency() { + // 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::getCur) + .extracting(currencies -> currencies.get(0)) + .containsOnly(DEFAULT_CURRENCY); + } + + @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 makeBidsShouldReturnErrorWhenStatusIs204WithErrorHeader() { + // given + final BidderCall httpCall = + givenHttpCallWithHeaders(204, Map.of(NATIVERY_ERROR_HEADER, "test error")); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getMessage()).isEqualTo("Nativery Error: test error."); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + }); + } + + @Test + public void makeBidsShouldReturnErrorWhenStatusIs204WithoutErrorHeader() { + // given + final BidderCall httpCall = givenHttpCallWithHeaders(204, null); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getMessage()).isEqualTo("No Content"); + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + }); + } + + @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()) + .extracting(BidderBid::getType) + .containsExactly(BidType.banner); + } + + @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()) + .extracting(BidderBid::getType) + .containsExactly(BidType.video); + } + + @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()) + .extracting(BidderBid::getType) + .containsExactly(BidType.xNative); + } + + @Test + public void makeBidsShouldHandleUnsupportedBidType() throws JsonProcessingException { + // given + final ObjectNode bidExtNativery = mapper.createObjectNode().put("bid_ad_media_type", "audio"); + final ObjectNode bidExt = mapper.createObjectNode() + .putPOJO("prebid", ExtBidPrebid.builder().type(audio).build()) + .set("nativery", bidExtNativery); + + final BidderCall httpCall = givenHttpCall( + givenBidResponse(bidBuilder -> bidBuilder.ext(bidExt).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()) + .contains("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); + final JsonNode extNode = bidderBid.getBid().getExt(); + final JsonNode metaNode = extNode.path("prebid").path("meta"); + + assertThat(metaNode.path("mediaType").asText()).isEqualTo("native"); + assertThat(metaNode.path("advertiserDomains").isArray()).isTrue(); + assertThat(metaNode.path("advertiserDomains").get(0).asText()).isEqualTo("domain.com"); + } + + @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); + } + + private static BidderCall givenHttpCallWithHeaders(int statusCode, Map headers) { + final MultiMap multiMap = MultiMap.caseInsensitiveMultiMap(); + if (headers != null) { + headers.forEach(multiMap::add); + } + + return BidderCall.succeededHttp( + HttpRequest.builder().payload(null).build(), + HttpResponse.of(statusCode, multiMap, null), + 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..c412a8198ce --- /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": [ + "EUR" + ], + "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