From ed297b01c602da5e75ac4eebe284f7a7d3c1c464 Mon Sep 17 00:00:00 2001 From: chrishuie Date: Mon, 6 Jul 2026 13:57:04 -0600 Subject: [PATCH] Port RTBStack: New Adapter --- .../bidder/rtbstack/RtbStackBidder.java | 222 +++++++ .../ext/request/rtbstack/ExtImpRtbStack.java | 19 + .../config/bidder/RtbStackConfiguration.java | 41 ++ .../resources/bidder-config/rtbstack.yaml | 19 + .../static/bidder-params/rtbstack.json | 24 + .../bidder/rtbstack/RtbStackBidderTest.java | 563 ++++++++++++++++++ .../org/prebid/server/it/RtbStackTest.java | 32 + .../test-auction-rtbstack-request.json | 24 + .../test-auction-rtbstack-response.json | 44 ++ .../rtbstack/test-rtbstack-bid-request.json | 50 ++ .../rtbstack/test-rtbstack-bid-response.json | 22 + .../server/it/test-application.properties | 2 + 12 files changed, 1062 insertions(+) create mode 100644 src/main/java/org/prebid/server/bidder/rtbstack/RtbStackBidder.java create mode 100644 src/main/java/org/prebid/server/proto/openrtb/ext/request/rtbstack/ExtImpRtbStack.java create mode 100644 src/main/java/org/prebid/server/spring/config/bidder/RtbStackConfiguration.java create mode 100644 src/main/resources/bidder-config/rtbstack.yaml create mode 100644 src/main/resources/static/bidder-params/rtbstack.json create mode 100644 src/test/java/org/prebid/server/bidder/rtbstack/RtbStackBidderTest.java create mode 100644 src/test/java/org/prebid/server/it/RtbStackTest.java create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-auction-rtbstack-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-auction-rtbstack-response.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-rtbstack-bid-request.json create mode 100644 src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-rtbstack-bid-response.json diff --git a/src/main/java/org/prebid/server/bidder/rtbstack/RtbStackBidder.java b/src/main/java/org/prebid/server/bidder/rtbstack/RtbStackBidder.java new file mode 100644 index 00000000000..5413d6cbeb2 --- /dev/null +++ b/src/main/java/org/prebid/server/bidder/rtbstack/RtbStackBidder.java @@ -0,0 +1,222 @@ +package org.prebid.server.bidder.rtbstack; + +import com.fasterxml.jackson.core.type.TypeReference; +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 org.apache.commons.collections4.CollectionUtils; +import org.apache.commons.collections4.MapUtils; +import org.apache.commons.lang3.StringUtils; +import org.apache.http.NameValuePair; +import org.apache.http.client.utils.URIBuilder; +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.rtbstack.ExtImpRtbStack; +import org.prebid.server.proto.openrtb.ext.response.BidType; +import org.prebid.server.util.BidderUtil; +import org.prebid.server.util.HttpUtil; + +import java.net.URISyntaxException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; + +public class RtbStackBidder implements Bidder { + + private static final TypeReference> RTBSTACK_EXT_TYPE_REFERENCE = + new TypeReference<>() { + }; + + private static final String REGION_MACRO = "{{Region}}"; + private static final String SSP_ID_MACRO = "{{SspID}}"; + private static final String ZONE_ID_MACRO = "{{ZoneID}}"; + private static final String PARTNER_ID_MACRO = "{{PartnerId}}"; + private static final String REGION_HOST_SUFFIX = "-adx-admixer"; + private static final Set VALID_REGIONS = Set.of("us", "eu", "sg"); + private static final String CUSTOM_PARAMS_FIELD = "customParams"; + + private final String endpointUrl; + private final JacksonMapper mapper; + + public RtbStackBidder(String endpointUrl, JacksonMapper mapper) { + this.endpointUrl = HttpUtil.validateUrl(Objects.requireNonNull(endpointUrl)); + this.mapper = Objects.requireNonNull(mapper); + } + + @Override + public Result>> makeHttpRequests(BidRequest request) { + final List errors = new ArrayList<>(); + final Map> impsByRoute = new LinkedHashMap<>(); + + for (Imp imp : request.getImp()) { + try { + final ExtImpRtbStack extImp = parseImpExt(imp); + impsByRoute.computeIfAbsent(extImp.getRoute(), route -> new ArrayList<>()) + .add(modifyImp(imp, extImp)); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + } + } + + final Site site = modifySite(request.getSite()); + final List> httpRequests = new ArrayList<>(); + + for (Map.Entry> routeImps : impsByRoute.entrySet()) { + try { + final String endpoint = buildEndpointUrl(routeImps.getKey()); + final BidRequest outgoingRequest = request.toBuilder() + .imp(routeImps.getValue()) + .site(site) + .build(); + httpRequests.add(BidderUtil.defaultRequest(outgoingRequest, endpoint, mapper)); + } catch (PreBidException e) { + errors.add(BidderError.badInput(e.getMessage())); + } + } + + return Result.of(httpRequests, errors); + } + + private ExtImpRtbStack parseImpExt(Imp imp) { + try { + return mapper.mapper().convertValue(imp.getExt(), RTBSTACK_EXT_TYPE_REFERENCE).getBidder(); + } catch (IllegalArgumentException e) { + throw new PreBidException("Wrong RTBStack bidder ext"); + } + } + + private Imp modifyImp(Imp imp, ExtImpRtbStack extImp) { + return imp.toBuilder() + .tagid(extImp.getTagId()) + .ext(makeImpExt(extImp.getCustomParams())) + .build(); + } + + private ObjectNode makeImpExt(Map customParams) { + final ObjectNode impExt = mapper.mapper().createObjectNode(); + if (MapUtils.isNotEmpty(customParams)) { + impExt.set(CUSTOM_PARAMS_FIELD, mapper.mapper().valueToTree(customParams)); + } + return impExt; + } + + private static Site modifySite(Site site) { + return site == null || StringUtils.isNotEmpty(site.getDomain()) + ? site + : site.toBuilder().domain(resolveDomain(site.getPage())).build(); + } + + private static String resolveDomain(String page) { + final String host = HttpUtil.getHostFromUrl(page); + return StringUtils.isNotEmpty(host) ? host : page; + } + + private String buildEndpointUrl(String route) { + final URIBuilder routeUri; + try { + routeUri = new URIBuilder(route); + } catch (URISyntaxException e) { + throw new PreBidException("invalid route URL: " + e.getMessage()); + } + + final String region = extractRegion(routeUri.getHost()); + final List queryParams = routeUri.getQueryParams(); + final String client = firstQueryParam(queryParams, "client"); + final String endpoint = firstQueryParam(queryParams, "endpoint"); + final String ssp = firstQueryParam(queryParams, "ssp"); + + if (StringUtils.isEmpty(client) || StringUtils.isEmpty(endpoint) || StringUtils.isEmpty(ssp)) { + throw new PreBidException("route URL must contain client, endpoint, and ssp query parameters"); + } + + return endpointUrl + .replace(REGION_MACRO, region) + .replace(SSP_ID_MACRO, HttpUtil.encodeUrl(ssp)) + .replace(ZONE_ID_MACRO, HttpUtil.encodeUrl(endpoint)) + .replace(PARTNER_ID_MACRO, HttpUtil.encodeUrl(client)); + } + + private static String extractRegion(String hostname) { + for (String hostPart : StringUtils.defaultString(hostname).split("\\.")) { + if (hostPart.endsWith(REGION_HOST_SUFFIX)) { + final String region = StringUtils.removeEnd(hostPart, REGION_HOST_SUFFIX).toLowerCase(); + if (VALID_REGIONS.contains(region)) { + return region; + } + } + } + throw new PreBidException("unable to extract valid region from route URL hostname"); + } + + private static String firstQueryParam(List queryParams, String name) { + return queryParams.stream() + .filter(param -> name.equals(param.getName())) + .map(NameValuePair::getValue) + .findFirst() + .orElse(null); + } + + @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(bidResponse, errors), errors); + } catch (DecodeException e) { + return Result.withError(BidderError.badServerResponse(e.getMessage())); + } + } + + private static List extractBids(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 -> makeBidderBid(bid, bidResponse.getCur(), errors)) + .filter(Objects::nonNull) + .toList(); + } + + private static BidderBid makeBidderBid(Bid bid, String currency, List errors) { + final BidType bidType = getBidType(bid, errors); + return bidType != null + ? BidderBid.of(bid, bidType, currency) + : null; + } + + private static BidType getBidType(Bid bid, List errors) { + return switch (bid.getMtype()) { + case 1 -> BidType.banner; + case 2 -> BidType.video; + case 3 -> BidType.audio; + case 4 -> BidType.xNative; + case null, default -> { + errors.add(BidderError.badServerResponse( + "unsupported MType " + bid.getMtype() + " for bid " + bid.getImpid())); + yield null; + } + }; + } +} diff --git a/src/main/java/org/prebid/server/proto/openrtb/ext/request/rtbstack/ExtImpRtbStack.java b/src/main/java/org/prebid/server/proto/openrtb/ext/request/rtbstack/ExtImpRtbStack.java new file mode 100644 index 00000000000..4d6e905aba3 --- /dev/null +++ b/src/main/java/org/prebid/server/proto/openrtb/ext/request/rtbstack/ExtImpRtbStack.java @@ -0,0 +1,19 @@ +package org.prebid.server.proto.openrtb.ext.request.rtbstack; + +import com.fasterxml.jackson.annotation.JsonProperty; +import lombok.Value; + +import java.util.Map; + +@Value(staticConstructor = "of") +public class ExtImpRtbStack { + + @JsonProperty("route") + String route; + + @JsonProperty("tagId") + String tagId; + + @JsonProperty("customParams") + Map customParams; +} diff --git a/src/main/java/org/prebid/server/spring/config/bidder/RtbStackConfiguration.java b/src/main/java/org/prebid/server/spring/config/bidder/RtbStackConfiguration.java new file mode 100644 index 00000000000..8c1682141e8 --- /dev/null +++ b/src/main/java/org/prebid/server/spring/config/bidder/RtbStackConfiguration.java @@ -0,0 +1,41 @@ +package org.prebid.server.spring.config.bidder; + +import org.prebid.server.bidder.BidderDeps; +import org.prebid.server.bidder.rtbstack.RtbStackBidder; +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/rtbstack.yaml", factory = YamlPropertySourceFactory.class) +public class RtbStackConfiguration { + + private static final String BIDDER_NAME = "rtbstack"; + + @Bean("rtbstackConfigurationProperties") + @ConfigurationProperties("adapters.rtbstack") + BidderConfigurationProperties configurationProperties() { + return new BidderConfigurationProperties(); + } + + @Bean + BidderDeps rtbstackBidderDeps(BidderConfigurationProperties rtbstackConfigurationProperties, + @NotBlank @Value("${external-url}") String externalUrl, + JacksonMapper mapper) { + + return BidderDepsAssembler.forBidder(BIDDER_NAME) + .withConfig(rtbstackConfigurationProperties) + .usersyncerCreator(UsersyncerCreator.create(externalUrl)) + .bidderCreator(config -> new RtbStackBidder(config.getEndpoint(), mapper)) + .assemble(); + } +} diff --git a/src/main/resources/bidder-config/rtbstack.yaml b/src/main/resources/bidder-config/rtbstack.yaml new file mode 100644 index 00000000000..ee4ce6a0cd8 --- /dev/null +++ b/src/main/resources/bidder-config/rtbstack.yaml @@ -0,0 +1,19 @@ +adapters: + rtbstack: + endpoint: https://{{Region}}-adx-admixer.rtb-stack.com/pbs?ssp={{SspID}}&endpoint={{ZoneID}}&client={{PartnerId}} + ortb-version: "2.6" + modifying-vast-xml-allowed: false + meta-info: + maintainer-email: prebid@admixer.net + app-media-types: + - banner + - video + - native + - audio + site-media-types: + - banner + - video + - native + - audio + supported-vendors: + vendor-id: 511 diff --git a/src/main/resources/static/bidder-params/rtbstack.json b/src/main/resources/static/bidder-params/rtbstack.json new file mode 100644 index 00000000000..b5b90aefd06 --- /dev/null +++ b/src/main/resources/static/bidder-params/rtbstack.json @@ -0,0 +1,24 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "RTBStack Adapter Params", + "description": "A schema which validates params accepted by the RTBStack adapter", + + "type": "object", + "properties": { + "route": { + "type": "string", + "minLength": 1, + "description": "Full route URL used to derive RTBStack endpoint (contains region, client, endpoint, ssp)." + }, + "tagId": { + "type": "string", + "description": "AdUnit tag id." + }, + "customParams": { + "type": "object", + "description": "Custom values for targeting." + } + }, + + "required": ["route", "tagId"] +} \ No newline at end of file diff --git a/src/test/java/org/prebid/server/bidder/rtbstack/RtbStackBidderTest.java b/src/test/java/org/prebid/server/bidder/rtbstack/RtbStackBidderTest.java new file mode 100644 index 00000000000..c68edd7f316 --- /dev/null +++ b/src/test/java/org/prebid/server/bidder/rtbstack/RtbStackBidderTest.java @@ -0,0 +1,563 @@ +package org.prebid.server.bidder.rtbstack; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.node.ObjectNode; +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.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.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.rtbstack.ExtImpRtbStack; +import org.prebid.server.proto.openrtb.ext.response.BidType; + +import java.math.BigDecimal; +import java.util.List; +import java.util.Map; +import java.util.function.UnaryOperator; + +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.assertj.core.api.Assertions.tuple; +import static org.prebid.server.bidder.model.BidderError.badInput; +import static org.prebid.server.bidder.model.BidderError.badServerResponse; + +public class RtbStackBidderTest extends VertxTest { + + private static final String ENDPOINT_URL = + "https://{{Region}}-test.endpoint.com/pbs?ssp={{SspID}}&endpoint={{ZoneID}}&client={{PartnerId}}"; + private static final String ROUTE_US = + "https://testsite.us-adx-admixer.test-route.com/prebid?client=client-1&endpoint=309&ssp=145"; + private static final String RESOLVED_US = "https://us-test.endpoint.com/pbs?ssp=145&endpoint=309&client=client-1"; + + private final RtbStackBidder target = new RtbStackBidder(ENDPOINT_URL, jacksonMapper); + + @Test + public void creationShouldFailOnInvalidEndpointUrl() { + assertThatIllegalArgumentException().isThrownBy(() -> new RtbStackBidder("invalid_url", jacksonMapper)); + } + + @Test + public void makeHttpRequestsShouldResolveEndpointFromRoute() { + // given + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", ROUTE_US, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly(RESOLVED_US); + } + + @Test + public void makeHttpRequestsShouldPromoteTagIdAndReplaceImpExt() { + // given + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", ROUTE_US, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getTagid, Imp::getExt) + .containsExactly(tuple("tag1", mapper.createObjectNode())); + } + + @Test + public void makeHttpRequestsShouldKeepCustomParamsInImpExt() { + // given + final Map customParams = Map.of( + "foo", "bar", + "floor", 0.45, + "enabled", true, + "count", 3, + "placement", Map.of("position", "top", "sticky", true), + "sizes", List.of("970x250", "728x90")); + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", ROUTE_US, "tag1", customParams)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + final ObjectNode expectedExt = mapper.createObjectNode(); + expectedExt.set("customParams", mapper.valueToTree(customParams)); + + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getExt) + .containsExactly(expectedExt); + } + + @Test + public void makeHttpRequestsShouldDropEmptyCustomParamsFromImpExt() { + // given + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", ROUTE_US, "tag1", Map.of())); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getExt) + .containsExactly(mapper.createObjectNode()); + } + + @Test + public void makeHttpRequestsShouldResolveSgRegionEndpoint() { + // given + final String routeSg = "https://mysite.sg-adx-admixer.test-route.com/prebid?client=c&endpoint=7&ssp=9"; + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", routeSg, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly("https://sg-test.endpoint.com/pbs?ssp=9&endpoint=7&client=c"); + } + + @Test + public void makeHttpRequestsShouldEncodeRouteQueryParamValues() { + // given + final String route = "https://s.us-adx-admixer.test-route.com/prebid?client=client%201&endpoint=309&ssp=145"; + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", route, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly("https://us-test.endpoint.com/pbs?ssp=145&endpoint=309&client=client+1"); + } + + @Test + public void makeHttpRequestsShouldGroupImpsByRouteInFirstSeenOrder() { + // given + final String routeEu = "https://site.eu-adx-admixer.test-route.com/prebid?client=abc&endpoint=1&ssp=2"; + final BidRequest bidRequest = givenBidRequest( + givenImp("imp1", ROUTE_US, "tag1", null), + givenImp("imp2", routeEu, "tag2", null), + givenImp("imp3", ROUTE_US, "tag3", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(2) + .extracting(HttpRequest::getUri) + .containsExactly(RESOLVED_US, "https://eu-test.endpoint.com/pbs?ssp=2&endpoint=1&client=abc"); + assertThat(result.getValue()) + .extracting(HttpRequest::getPayload) + .extracting(payload -> payload.getImp().stream().map(Imp::getId).toList()) + .containsExactly(List.of("imp1", "imp3"), List.of("imp2")); + } + + @Test + public void makeHttpRequestsShouldBatchSameRouteImpsIntoSingleRequest() { + // given + final BidRequest bidRequest = givenBidRequest( + givenImp("imp1", ROUTE_US, "tag1", null), + givenImp("imp2", ROUTE_US, "tag2", null), + givenImp("imp3", ROUTE_US, "tag3", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getId) + .containsExactly("imp1", "imp2", "imp3"); + } + + @Test + public void makeHttpRequestsShouldReturnErrorForImpWithInvalidExtAndKeepValidImp() { + // given + final Imp invalidImp = Imp.builder() + .id("imp1") + .ext((ObjectNode) mapper.createObjectNode().set("bidder", mapper.createArrayNode())) + .build(); + final BidRequest bidRequest = givenBidRequest(invalidImp, givenImp("imp2", ROUTE_US, "tag2", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).containsExactly(badInput("Wrong RTBStack bidder ext")); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .flatExtracting(BidRequest::getImp) + .extracting(Imp::getId) + .containsExactly("imp2"); + } + + @Test + public void makeHttpRequestsShouldReturnErrorForRouteWithInvalidRegion() { + // given + final String badRoute = "https://publisher.xx-adx-admixer.test-route.com/prebid?client=c&endpoint=1&ssp=2"; + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", badRoute, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .containsExactly(badInput("unable to extract valid region from route URL hostname")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorForRouteWithMissingQueryParams() { + // given + final String badRoute = "https://publisher.us-adx-admixer.test-route.com/prebid?client=c&endpoint=1"; + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", badRoute, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .containsExactly(badInput("route URL must contain client, endpoint, and ssp query parameters")); + } + + @Test + public void makeHttpRequestsShouldReturnErrorForUnparseableRoute() { + // given + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", "http://[bad-route", "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_input); + assertThat(error.getMessage()).startsWith("invalid route URL:"); + }); + } + + @Test + public void makeHttpRequestsShouldContinueOtherRoutesWhenOneRouteFails() { + // given + final String badRoute = "https://publisher.xx-adx-admixer.test-route.com/prebid?client=c&endpoint=1&ssp=2"; + final BidRequest bidRequest = givenBidRequest( + givenImp("imp1", ROUTE_US, "tag1", null), + givenImp("imp2", badRoute, "tag2", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()) + .containsExactly(badInput("unable to extract valid region from route URL hostname")); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getUri) + .containsExactly(RESOLVED_US); + } + + @Test + public void makeHttpRequestsShouldSynthesizeSiteDomainFromPage() { + // given + final BidRequest bidRequest = givenBidRequest( + request -> request.site(Site.builder().domain("").page("https://example.com/path").build()), + givenImp("imp1", ROUTE_US, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite) + .extracting(Site::getDomain, Site::getPage) + .containsExactly(tuple("example.com", "https://example.com/path")); + } + + @Test + public void makeHttpRequestsShouldFallBackToRawPageWhenPageHasNoHostname() { + // given + final BidRequest bidRequest = givenBidRequest( + request -> request.site(Site.builder().domain("").page("not-a-url").build()), + givenImp("imp1", ROUTE_US, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite) + .extracting(Site::getDomain) + .containsExactly("not-a-url"); + } + + @Test + public void makeHttpRequestsShouldFallBackToRawPageWhenPageIsUnparseable() { + // given + final BidRequest bidRequest = givenBidRequest( + request -> request.site(Site.builder().domain("").page("http://[bad-page").build()), + givenImp("imp1", ROUTE_US, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite) + .extracting(Site::getDomain) + .containsExactly("http://[bad-page"); + } + + @Test + public void makeHttpRequestsShouldKeepSiteUntouchedWhenDomainIsPresent() { + // given + final Site site = Site.builder().domain("example.com").page("https://other.com").build(); + final BidRequest bidRequest = givenBidRequest( + request -> request.site(site), + givenImp("imp1", ROUTE_US, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite) + .containsExactly(site); + } + + @Test + public void makeHttpRequestsShouldTolerateAbsentSite() { + // given + final BidRequest bidRequest = givenBidRequest(givenImp("imp1", ROUTE_US, "tag1", null)); + + // when + final Result>> result = target.makeHttpRequests(bidRequest); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).hasSize(1) + .extracting(HttpRequest::getPayload) + .extracting(BidRequest::getSite) + .containsOnlyNulls(); + } + + @Test + public void makeBidsShouldReturnErrorWhenResponseBodyCouldNotBeParsed() { + // given + final BidderCall httpCall = givenHttpCall("invalid_json"); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()).hasSize(1) + .allSatisfy(error -> { + assertThat(error.getType()).isEqualTo(BidderError.Type.bad_server_response); + assertThat(error.getMessage()).startsWith("Failed to decode: Unrecognized token 'invalid_json'"); + }); + } + + @Test + public void makeBidsShouldReturnEmptyListWhenSeatBidIsNull() throws JsonProcessingException { + // given + final BidderCall httpCall = + givenHttpCall(mapper.writeValueAsString(BidResponse.builder().seatbid(null).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 Bid bannerBid = givenBid(1); + final BidderCall httpCall = givenHttpCall(givenBidResponse("USD", bannerBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsOnly(BidderBid.of(bannerBid, BidType.banner, "USD")); + } + + @Test + public void makeBidsShouldReturnVideoBid() throws JsonProcessingException { + // given + final Bid videoBid = givenBid(2); + final BidderCall httpCall = givenHttpCall(givenBidResponse("USD", videoBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsOnly(BidderBid.of(videoBid, BidType.video, "USD")); + } + + @Test + public void makeBidsShouldReturnAudioBid() throws JsonProcessingException { + // given + final Bid audioBid = givenBid(3); + final BidderCall httpCall = givenHttpCall(givenBidResponse("USD", audioBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsOnly(BidderBid.of(audioBid, BidType.audio, "USD")); + } + + @Test + public void makeBidsShouldReturnNativeBid() throws JsonProcessingException { + // given + final Bid nativeBid = givenBid(4); + final BidderCall httpCall = givenHttpCall(givenBidResponse("USD", nativeBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsOnly(BidderBid.of(nativeBid, BidType.xNative, "USD")); + } + + @Test + public void makeBidsShouldPassResponseCurrencyThrough() throws JsonProcessingException { + // given + final Bid bannerBid = givenBid(1); + final BidderCall httpCall = givenHttpCall(givenBidResponse(null, bannerBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()).isEmpty(); + assertThat(result.getValue()).containsOnly(BidderBid.of(bannerBid, BidType.banner, null)); + } + + @Test + public void makeBidsShouldReturnErrorForUnsupportedMtype() throws JsonProcessingException { + // given + final Bid bidWithUnsupportedMtype = givenBid(0); + final BidderCall httpCall = givenHttpCall(givenBidResponse("USD", bidWithUnsupportedMtype)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .containsExactly(badServerResponse("unsupported MType 0 for bid impId")); + } + + @Test + public void makeBidsShouldReturnErrorForMissingMtype() throws JsonProcessingException { + // given + final Bid bidWithoutMtype = givenBid(null); + final BidderCall httpCall = givenHttpCall(givenBidResponse("USD", bidWithoutMtype)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getValue()).isEmpty(); + assertThat(result.getErrors()) + .containsExactly(badServerResponse("unsupported MType null for bid impId")); + } + + @Test + public void makeBidsShouldSkipInvalidBidAndKeepValidOne() throws JsonProcessingException { + // given + final Bid validBid = givenBid(1); + final Bid invalidBid = givenBid(0); + final BidderCall httpCall = givenHttpCall(givenBidResponse("USD", validBid, invalidBid)); + + // when + final Result> result = target.makeBids(httpCall, null); + + // then + assertThat(result.getErrors()) + .containsExactly(badServerResponse("unsupported MType 0 for bid impId")); + assertThat(result.getValue()).containsOnly(BidderBid.of(validBid, BidType.banner, "USD")); + } + + private static BidRequest givenBidRequest(Imp... imps) { + return givenBidRequest(request -> request, imps); + } + + private static BidRequest givenBidRequest(UnaryOperator requestCustomizer, + Imp... imps) { + + return requestCustomizer.apply(BidRequest.builder().imp(List.of(imps))).build(); + } + + private static Imp givenImp(String impId, String route, String tagId, Map customParams) { + return Imp.builder() + .id(impId) + .banner(Banner.builder().build()) + .ext(mapper.valueToTree(ExtPrebid.of(null, ExtImpRtbStack.of(route, tagId, customParams)))) + .build(); + } + + private static Bid givenBid(Integer mtype) { + return Bid.builder().id("bidId").impid("impId").price(BigDecimal.ONE).mtype(mtype).build(); + } + + private static String givenBidResponse(String currency, Bid... bids) throws JsonProcessingException { + return mapper.writeValueAsString(BidResponse.builder() + .cur(currency) + .seatbid(singletonList(SeatBid.builder().bid(List.of(bids)).build())) + .build()); + } + + private static BidderCall givenHttpCall(String body) { + return BidderCall.succeededHttp( + HttpRequest.builder().build(), + HttpResponse.of(200, null, body), + null); + } +} diff --git a/src/test/java/org/prebid/server/it/RtbStackTest.java b/src/test/java/org/prebid/server/it/RtbStackTest.java new file mode 100644 index 00000000000..11e78d539d0 --- /dev/null +++ b/src/test/java/org/prebid/server/it/RtbStackTest.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 RtbStackTest extends IntegrationTest { + + @Test + public void openrtb2AuctionShouldRespondWithBidsFromRtbStack() throws IOException, JSONException { + // given + WIRE_MOCK_RULE.stubFor(post(urlPathEqualTo("/rtbstack-exchange")) + .withRequestBody(equalToJson(jsonFrom("openrtb2/rtbstack/test-rtbstack-bid-request.json"))) + .willReturn(aResponse().withBody(jsonFrom("openrtb2/rtbstack/test-rtbstack-bid-response.json")))); + + // when + final Response response = responseFor("openrtb2/rtbstack/test-auction-rtbstack-request.json", + Endpoint.openrtb2_auction); + + // then + assertJsonEquals("openrtb2/rtbstack/test-auction-rtbstack-response.json", response, singletonList("rtbstack")); + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-auction-rtbstack-request.json b/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-auction-rtbstack-request.json new file mode 100644 index 00000000000..b7b24fd15cb --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-auction-rtbstack-request.json @@ -0,0 +1,24 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "banner": { + "w": 300, + "h": 250 + }, + "ext": { + "rtbstack": { + "route": "https://testsite.us-adx-admixer.test-route.com/prebid?client=client-1&endpoint=309&ssp=145", + "tagId": "test-tag" + } + } + } + ], + "tmax": 5000, + "regs": { + "ext": { + "gdpr": 0 + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-auction-rtbstack-response.json b/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-auction-rtbstack-response.json new file mode 100644 index 00000000000..8bf2b3e21a0 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-auction-rtbstack-response.json @@ -0,0 +1,44 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "exp": 300, + "price": 3.33, + "adm": "adm001", + "adid": "adid", + "cid": "cid", + "crid": "crid", + "mtype": 1, + "w": 300, + "h": 250, + "ext": { + "prebid": { + "type": "banner", + "meta": { + "adaptercode": "rtbstack" + } + }, + "origbidcpm": 3.33, + "origbidcur": "USD" + } + } + ], + "seat": "rtbstack", + "group": 0 + } + ], + "cur": "USD", + "ext": { + "responsetimemillis": { + "rtbstack": "{{ rtbstack.response_time_ms }}" + }, + "prebid": { + "auctiontimestamp": 0 + }, + "tmaxrequest": 5000 + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-rtbstack-bid-request.json b/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-rtbstack-bid-request.json new file mode 100644 index 00000000000..7097b9d21a0 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-rtbstack-bid-request.json @@ -0,0 +1,50 @@ +{ + "id": "request_id", + "imp": [ + { + "id": "imp_id", + "secure": 1, + "tagid": "test-tag", + "banner": { + "w": 300, + "h": 250 + }, + "ext": {} + } + ], + "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": { + "server": { + "externalurl": "http://localhost:8080", + "gvlid": 1, + "datacenter": "local", + "endpoint": "/openrtb2/auction" + } + } + } +} diff --git a/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-rtbstack-bid-response.json b/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-rtbstack-bid-response.json new file mode 100644 index 00000000000..737d141bd97 --- /dev/null +++ b/src/test/resources/org/prebid/server/it/openrtb2/rtbstack/test-rtbstack-bid-response.json @@ -0,0 +1,22 @@ +{ + "id": "request_id", + "seatbid": [ + { + "bid": [ + { + "id": "bid_id", + "impid": "imp_id", + "price": 3.33, + "adid": "adid", + "crid": "crid", + "cid": "cid", + "adm": "adm001", + "mtype": 1, + "h": 250, + "w": 300 + } + ] + } + ], + "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 1569de649f5..14f0e7a81e0 100644 --- a/src/test/resources/org/prebid/server/it/test-application.properties +++ b/src/test/resources/org/prebid/server/it/test-application.properties @@ -703,6 +703,8 @@ adapters.zmaticoo.enabled=true adapters.zmaticoo.endpoint=http://localhost:8090/zmaticoo-exchange adapters.yearxero.enabled=true adapters.yearxero.endpoint=http://localhost:8090/yearxero-exchange +adapters.rtbstack.enabled=true +adapters.rtbstack.endpoint=http://localhost:8090/rtbstack-exchange http-client.circuit-breaker.enabled=true http-client.circuit-breaker.idle-expire-hours=24 http-client.circuit-breaker.opening-threshold=1000